CfnCustomerGatewayProps

class aws_cdk.aws_ec2.CfnCustomerGatewayProps(*, ip_address, type, bgp_asn=None, bgp_asn_extended=None, certificate_arn=None, device_name=None, tags=None)

Bases: object

Properties for defining a CfnCustomerGateway.

Parameters:

  • ip_address (str) – IPv4 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.

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

  • bgp_asn (Union[int, float, 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 Default: - 65000

  • bgp_asn_extended (Union[int, float, 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 (Optional[str]) – The Amazon Resource Name (ARN) for the customer gateway certificate.

  • device_name (Optional[str]) – The name of customer gateway device.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – One or more tags for the customer gateway.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_customer_gateway_props = ec2.CfnCustomerGatewayProps(
    ip_address="ipAddress",
    type="type",

    # the properties below are optional
    bgp_asn=123,
    bgp_asn_extended=123,
    certificate_arn="certificateArn",
    device_name="deviceName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

bgp_asn

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

Default:

  • 65000

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn

bgp_asn_extended

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasnextended

certificate_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-certificatearn

device_name

The name of customer gateway device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename

ip_address

IPv4 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress

tags

One or more tags for the customer gateway.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-tags

type

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type