You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
}

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)


1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1407

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

#nameString

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

Returns:

  • (String)


1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1407

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


1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1407

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