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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1478

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

#nameString

The name used to label and identify the VPC link.

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1478

class CreateVpcLinkRequest < Struct.new(
  :name,
  :description,
  :target_arns,
  :tags)
  SENSITIVE = []
  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>)


1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1478

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

#target_arnsArray<String>

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

Returns:

  • (Array<String>)


1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1478

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