Skip to content

CustomerGateway

Source code in docs_src/capo_ec2/types/customer_gateway.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CustomerGateway(TypedDict, closed=True):
    certificate_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the customer gateway certificate.</p>"""
    device_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of customer gateway device.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>Any tags assigned to the customer gateway.</p>"""
    bgp_asn_extended: NotRequired["capo_ec2.types.string.String"]
    """<p>The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</p> <p>Valid values: <code>2,147,483,648</code> to <code>4,294,967,295</code> </p>"""
    customer_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the customer gateway.</p>"""
    state: NotRequired["capo_ec2.types.string.String"]
    """<p>The current state of the customer gateway (<code>pending | available | deleting | deleted</code>).</p>"""
    type: NotRequired["capo_ec2.types.string.String"]
    """<p>The type of VPN connection the customer gateway supports (<code>ipsec.1</code>).</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>PublicIpv4</code>, you can use a public IPv4 address. If <code>OutsideIpAddressType</code> is set to <code>Ipv6</code>, you can use a public IPv6 address. </p>"""
    bgp_asn: NotRequired["capo_ec2.types.string.String"]
    """<p>The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</p> <p>Valid values: <code>1</code> to <code>2,147,483,647</code> </p>"""

bgp_asn instance-attribute 

bgp_asn: NotRequired[String]

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Valid values: 1 to 2,147,483,647

bgp_asn_extended instance-attribute 

bgp_asn_extended: NotRequired[String]

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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.

customer_gateway_id instance-attribute 

customer_gateway_id: NotRequired[String]

The ID of the customer gateway.

device_name instance-attribute 

device_name: NotRequired[String]

The name of customer gateway device.

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 PublicIpv4, you can use a public IPv4 address. If OutsideIpAddressType is set to Ipv6, you can use a public IPv6 address.

state instance-attribute 

state: NotRequired[String]

The current state of the customer gateway (pending | available | deleting | deleted).

tags instance-attribute 

tags: NotRequired[TagList]

Any tags assigned to the customer gateway.

type instance-attribute 

type: NotRequired[String]

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