create_customer_gateway¶
Operation¶
create_customer_gateway
async
¶
create_customer_gateway(request: CreateCustomerGatewayInput | CreateCustomerGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateCustomerGatewayOutput
create_customer_gateway(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCustomerGatewayInputDict]) -> CreateCustomerGatewayOutput
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.
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 |
|---|---|
CreateCustomerGatewayOutput
|
An instance of |
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¶
CreateCustomerGatewayInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for CreateCustomerGateway.
Attributes¶
bgp_asn
class-attribute
instance-attribute
¶
bgp_asn: int | None = ...
For customer gateway devices that support BGP, specify the device's
ASN. You must specify either BgpAsn or BgpAsnExtended when creating
the customer gateway. If the ASN is larger than 2,147,483,647, you
must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
bgp_asn_extended
class-attribute
instance-attribute
¶
bgp_asn_extended: int | None = ...
For customer gateway devices that support BGP, specify the device's
ASN. You must specify either BgpAsn or BgpAsnExtended when creating
the customer gateway. If the ASN is larger than 2,147,483,647, you
must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
certificate_arn
class-attribute
instance-attribute
¶
certificate_arn: str | None = ...
The Amazon Resource Name (ARN) for the customer gateway certificate.
device_name
class-attribute
instance-attribute
¶
device_name: str | None = ...
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
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.
ip_address
class-attribute
instance-attribute
¶
ip_address: str | None = ...
The IP address for the customer gateway device's outside interface. The
address must be static. If OutsideIpAddressType in your VPN connection
options is set to PrivateIpv4, you can use an RFC6598 or RFC1918
private IPv4 address. If OutsideIpAddressType is set to Ipv6, you
can use an IPv6 address.
public_ip
class-attribute
instance-attribute
¶
public_ip: str | None = ...
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the customer gateway.
Dictionaries¶
CreateCustomerGatewayInputDict
¶
Bases: TypedDict
Dictionary form of CreateCustomerGatewayInput.
Attributes¶
bgp_asn
instance-attribute
¶
bgp_asn: int | None
For customer gateway devices that support BGP, specify the device's
ASN. You must specify either BgpAsn or BgpAsnExtended when creating
the customer gateway. If the ASN is larger than 2,147,483,647, you
must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
bgp_asn_extended
instance-attribute
¶
bgp_asn_extended: int | None
For customer gateway devices that support BGP, specify the device's
ASN. You must specify either BgpAsn or BgpAsnExtended when creating
the customer gateway. If the ASN is larger than 2,147,483,647, you
must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
certificate_arn
instance-attribute
¶
certificate_arn: str | None
The Amazon Resource Name (ARN) for the customer gateway certificate.
device_name
instance-attribute
¶
device_name: str | None
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
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.
ip_address
instance-attribute
¶
ip_address: str | None
The IP address for the customer gateway device's outside interface. The
address must be static. If OutsideIpAddressType in your VPN connection
options is set to PrivateIpv4, you can use an RFC6598 or RFC1918
private IPv4 address. If OutsideIpAddressType is set to Ipv6, you
can use an IPv6 address.
public_ip
instance-attribute
¶
public_ip: str | None
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the customer gateway.
Output¶
CreateCustomerGatewayOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of CreateCustomerGateway.
Attributes¶
customer_gateway
class-attribute
instance-attribute
¶
customer_gateway: CustomerGateway | None = ...
Information about the customer gateway.
response_metadata
class-attribute
instance-attribute
¶
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.