CfnVpcLinkProps

class aws_cdk.aws_apigateway.CfnVpcLinkProps(*, name, target_arns, description=None, tags=None)

Bases: object

Properties for defining a CfnVpcLink.

Parameters
  • name (str) – A name for the VPC link.

  • target_arns (Sequence[str]) – The ARN of 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.

  • description (Optional[str]) – A description of the VPC link.

  • tags (Optional[Sequence[CfnTag]]) – An array of arbitrary tags (key-value pairs) to associate with the VPC link.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

cfn_vpc_link_props = apigateway.CfnVpcLinkProps(
    name="name",
    target_arns=["targetArns"],

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the VPC link.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description

Return type

Optional[str]

name

A name for the VPC link.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name

Return type

str

tags

An array of arbitrary tags (key-value pairs) to associate with the VPC link.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags

Return type

Optional[List[CfnTag]]

target_arns

The ARN of 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns

Return type

List[str]