Skip to content

EC2  >  Operations  >  create_transit_gateway_vpc_attachment

create_transit_gateway_vpc_attachment

Operation

create_transit_gateway_vpc_attachment async

create_transit_gateway_vpc_attachment(request: CreateTransitGatewayVpcAttachmentInput | CreateTransitGatewayVpcAttachmentInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateTransitGatewayVpcAttachmentOutput
create_transit_gateway_vpc_attachment(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateTransitGatewayVpcAttachmentInputDict]) -> CreateTransitGatewayVpcAttachmentOutput

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateTransitGatewayVpcAttachmentOutput

An instance of CreateTransitGatewayVpcAttachmentOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateTransitGatewayVpcAttachmentInput dataclass

Bases: _SerdeShape

Dataclass for CreateTransitGatewayVpcAttachmentInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

options class-attribute instance-attribute

The VPC attachment options.

subnet_ids class-attribute instance-attribute
subnet_ids: list[str] | None = ...

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the VPC attachment.

transit_gateway_id class-attribute instance-attribute
transit_gateway_id: str | None = ...

The ID of the transit gateway.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

The ID of the VPC.

Dictionaries

CreateTransitGatewayVpcAttachmentInputDict

Bases: TypedDict

Dictionary form of CreateTransitGatewayVpcAttachmentInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

options instance-attribute

The VPC attachment options.

subnet_ids instance-attribute
subnet_ids: Required[Sequence[str]]

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to apply to the VPC attachment.

transit_gateway_id instance-attribute
transit_gateway_id: Required[str]

The ID of the transit gateway.

vpc_id instance-attribute
vpc_id: Required[str]

The ID of the VPC.

Output

CreateTransitGatewayVpcAttachmentOutput dataclass

Bases: _SerdeShape

Dataclass for CreateTransitGatewayVpcAttachmentOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

transit_gateway_vpc_attachment class-attribute instance-attribute
transit_gateway_vpc_attachment: TransitGatewayVpcAttachment | None = ...

Information about the VPC attachment.