Skip to content

EC2  >  Operations  >  create_vpn_gateway

create_vpn_gateway

Operation

create_vpn_gateway async

create_vpn_gateway(input: CreateVpnGatewayInput, plugins: list[Plugin] | None = None) -> CreateVpnGatewayOutput

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Parameters:

Name Type Description Default
input CreateVpnGatewayInput

An instance of CreateVpnGatewayInput.

required
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
CreateVpnGatewayOutput

An instance of CreateVpnGatewayOutput.

Input

CreateVpnGatewayInput dataclass

Bases: _SerdeShape

Contains the parameters for CreateVpnGateway.

Attributes

amazon_side_asn class-attribute instance-attribute
amazon_side_asn: int | None = ...

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

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

The Availability Zone for the virtual private gateway.

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.

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

The tags to apply to the virtual private gateway.

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

The type of VPN connection this virtual private gateway supports.

Output

CreateVpnGatewayOutput dataclass

Bases: _SerdeShape

Contains the output of CreateVpnGateway.

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.

vpn_gateway class-attribute instance-attribute
vpn_gateway: VpnGateway | None = ...

Information about the virtual private gateway.