Class: Aws::APIGateway::Types::CreateVpcLinkRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass CreateVpcLinkRequest data as a hash:

{
  name: "String", # required
  description: "String",
  target_arns: ["String"], # required
  tags: {
    "String" => "String",
  },
}

Creates a VPC link, under the caller’s account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)


1548
1549
1550
1551
1552
1553
1554
# File 'lib/aws-sdk-apigateway/types.rb', line 1548

class CreateVpcLinkRequest < Struct.new(
  :name,
  :description,
  :target_arns,
  :tags)
  include Aws::Structure
end

#nameString

[Required] The name used to label and identify the VPC link.

Returns:

  • (String)


1548
1549
1550
1551
1552
1553
1554
# File 'lib/aws-sdk-apigateway/types.rb', line 1548

class CreateVpcLinkRequest < Struct.new(
  :name,
  :description,
  :target_arns,
  :tags)
  include Aws::Structure
end

#tagsHash<String,String>

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ‘aws:`. The tag value can be up to 256 characters.

Returns:

  • (Hash<String,String>)


1548
1549
1550
1551
1552
1553
1554
# File 'lib/aws-sdk-apigateway/types.rb', line 1548

class CreateVpcLinkRequest < Struct.new(
  :name,
  :description,
  :target_arns,
  :tags)
  include Aws::Structure
end

#target_arnsArray<String>

[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Returns:

  • (Array<String>)


1548
1549
1550
1551
1552
1553
1554
# File 'lib/aws-sdk-apigateway/types.rb', line 1548

class CreateVpcLinkRequest < Struct.new(
  :name,
  :description,
  :target_arns,
  :tags)
  include Aws::Structure
end