TransitGatewayVpcAttachment

class aws_cdk.aws_ec2_alpha.TransitGatewayVpcAttachment(scope, id, *, subnets, transit_gateway, vpc, transit_gateway_attachment_name=None, vpc_attachment_options=None)

Bases: Resource

(experimental) Creates a Transit Gateway VPC Attachment.

Stability:: experimental
Resource:: AWS::EC2::TransitGatewayAttachment
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_ec2_alpha as ec2_alpha
from aws_cdk import aws_ec2 as ec2

# subnet: ec2.Subnet
# transit_gateway: ec2_alpha.TransitGateway
# transit_gateway_vpc_attachment_options: ec2_alpha.ITransitGatewayVpcAttachmentOptions
# vpc: ec2.Vpc

transit_gateway_vpc_attachment = ec2_alpha.TransitGatewayVpcAttachment(self, "MyTransitGatewayVpcAttachment",
    subnets=[subnet],
    transit_gateway=transit_gateway,
    vpc=vpc,

    # the properties below are optional
    transit_gateway_attachment_name="transitGatewayAttachmentName",
    vpc_attachment_options=transit_gateway_vpc_attachment_options
)

Parameters:

scope (Construct)
id (str)
subnets (Sequence[ISubnet]) – (experimental) A list of one or more subnets to place the attachment in. It is recommended to specify more subnets for better availability.
transit_gateway (ITransitGateway) – (experimental) The transit gateway this attachment gets assigned to.
vpc (IVpc) – (experimental) A VPC attachment(s) will get assigned to.
transit_gateway_attachment_name (Optional[str]) – (experimental) Physical name of this Transit Gateway VPC Attachment. Default: - Assigned by CloudFormation.
vpc_attachment_options (Optional[ITransitGatewayVpcAttachmentOptions]) – (experimental) The VPC attachment options. Default: - All options are disabled.

Stability:

experimental

Methods

add_subnets(subnets)

(experimental) Add additional subnets to this attachment.

Parameters:: subnets (Sequence[ISubnet])
Stability:: experimental
Return type:: None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

remove_subnets(subnets)

(experimental) Remove additional subnets to this attachment.

Parameters:: subnets (Sequence[ISubnet])
Stability:: experimental
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-ec2-alpha.TransitGatewayVpcAttachment'

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

transit_gateway_attachment_id

(experimental) The ID of the transit gateway attachment.

Stability:: experimental

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool