Skip to content

EC2  >  Operations  >  create_transit_gateway_connect_peer

create_transit_gateway_connect_peer

Operation

create_transit_gateway_connect_peer async

create_transit_gateway_connect_peer(request: CreateTransitGatewayConnectPeerInput | CreateTransitGatewayConnectPeerInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateTransitGatewayConnectPeerOutput
create_transit_gateway_connect_peer(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateTransitGatewayConnectPeerInputDict]) -> CreateTransitGatewayConnectPeerOutput

Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

For more information, see Connect peers in the Amazon Web Services Transit Gateways Guide.

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
CreateTransitGatewayConnectPeerOutput

An instance of CreateTransitGatewayConnectPeerOutput.

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

CreateTransitGatewayConnectPeerInput dataclass

Bases: _SerdeShape

Dataclass for CreateTransitGatewayConnectPeerInput structure.

Attributes
bgp_options class-attribute instance-attribute
bgp_options: TransitGatewayConnectRequestBgpOptions | None = ...

The BGP options for the Connect peer.

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.

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

The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

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

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

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

The tags to apply to the Connect peer.

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

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

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

The ID of the Connect attachment.

Dictionaries

CreateTransitGatewayConnectPeerInputDict

Bases: TypedDict

Dictionary form of CreateTransitGatewayConnectPeerInput.

Attributes
bgp_options instance-attribute

The BGP options for the Connect peer.

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.

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

The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

peer_address instance-attribute
peer_address: Required[str]

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

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

The tags to apply to the Connect peer.

transit_gateway_address instance-attribute
transit_gateway_address: str | None

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

transit_gateway_attachment_id instance-attribute
transit_gateway_attachment_id: Required[str]

The ID of the Connect attachment.

Output

CreateTransitGatewayConnectPeerOutput dataclass

Bases: _SerdeShape

Dataclass for CreateTransitGatewayConnectPeerOutput 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_connect_peer class-attribute instance-attribute
transit_gateway_connect_peer: TransitGatewayConnectPeer | None = ...

Information about the Connect peer.