CfnVpcLinkProps

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

Bases: object

Properties for defining a CfnVpcLink.

Parameters:

  • name (str) – The name used to label and identify the VPC link.

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

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

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

See:

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.
from aws_cdk import 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

The description of the VPC link.

See:

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

name

The name used to label and identify the VPC link.

See:

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

tags

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

See:

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

target_arns

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.

See:

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