Skip to content

EC2  >  Structures  >  CustomerGateway

CustomerGateway

Structure Class

CustomerGateway dataclass

Bases: _SerdeShape

Describes a customer gateway.

Attributes

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

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

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

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

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 class-attribute instance-attribute
certificate_arn: str | None = ...

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

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

The ID of the customer gateway.

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

The name of customer gateway device.

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

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

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

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

Any tags assigned to the customer gateway.

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

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