Skip to content

CreateCustomerGatewayRequest

Source code in docs_src/capo_ec2/types/create_customer_gateway_request.py
class CreateCustomerGatewayRequest(TypedDict, closed=True):
    bgp_asn: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>For customer gateway devices that support BGP, specify the device's ASN. You must specify either <code>BgpAsn</code> or <code>BgpAsnExtended</code> when creating the customer gateway. If the ASN is larger than <code>2,147,483,647</code>, you must use <code>BgpAsnExtended</code>.</p> <p>Default: 65000</p> <p>Valid values: <code>1</code> to <code>2,147,483,647</code> </p>"""
    public_ip: NotRequired["capo_ec2.types.string.String"]
    """<p> <i>This member has been deprecated.</i> The Internet-routable IP address for the customer gateway's outside interface. The address must be static.</p>"""
    certificate_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the customer gateway certificate.</p>"""
    type: NotRequired["capo_ec2.types.gateway_type.GatewayType"]
    """<p>The type of VPN connection that this customer gateway supports (<code>ipsec.1</code>).</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to apply to the customer gateway.</p>"""
    device_name: NotRequired["capo_ec2.types.string.String"]
    """<p>A name for the customer gateway device.</p> <p>Length Constraints: Up to 255 characters.</p>"""
    ip_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The IP address for the customer gateway device's outside interface. The address must be static. If <code>OutsideIpAddressType</code> in your VPN connection options is set to <code>PrivateIpv4</code>, you can use an RFC6598 or RFC1918 private IPv4 address. If <code>OutsideIpAddressType</code> is set to <code>Ipv6</code>, you can use an IPv6 address. </p>"""
    bgp_asn_extended: NotRequired["capo_ec2.types.long.Long"]
    """<p>For customer gateway devices that support BGP, specify the device's ASN. You must specify either <code>BgpAsn</code> or <code>BgpAsnExtended</code> when creating the customer gateway. If the ASN is larger than <code>2,147,483,647</code>, you must use <code>BgpAsnExtended</code>.</p> <p>Valid values: <code>2,147,483,648</code> to <code>4,294,967,295</code> </p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""

bgp_asn instance-attribute

bgp_asn: NotRequired[Integer]

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: NotRequired[Long]

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: NotRequired[String]

The Amazon Resource Name (ARN) for the customer gateway certificate.

device_name instance-attribute

device_name: NotRequired[String]

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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: NotRequired[String]

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: NotRequired[String]

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: NotRequired[TagSpecificationList]

The tags to apply to the customer gateway.

type instance-attribute

type: NotRequired[GatewayType]

The type of VPN connection that this customer gateway supports (ipsec.1).