interface CfnCustomerGatewayProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.EC2.CfnCustomerGatewayProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnCustomerGatewayProps |
Java | software.amazon.awscdk.services.ec2.CfnCustomerGatewayProps |
Python | aws_cdk.aws_ec2.CfnCustomerGatewayProps |
TypeScript | aws-cdk-lib » aws_ec2 » CfnCustomerGatewayProps |
Properties for defining a CfnCustomerGateway
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnCustomerGatewayProps: ec2.CfnCustomerGatewayProps = {
ipAddress: 'ipAddress',
type: 'type',
// the properties below are optional
bgpAsn: 123,
bgpAsnExtended: 123,
certificateArn: 'certificateArn',
deviceName: 'deviceName',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
ip | string | IPv4 address for the customer gateway device's outside interface. |
type | string | The type of VPN connection that this customer gateway supports ( ipsec.1 ). |
bgp | number | For customer gateway devices that support BGP, specify the device's ASN. |
bgp | number | For customer gateway devices that support BGP, specify the device's ASN. |
certificate | string | The Amazon Resource Name (ARN) for the customer gateway certificate. |
device | string | The name of customer gateway device. |
tags? | Cfn [] | One or more tags for the customer gateway. |
ipAddress
Type:
string
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
Type:
string
The type of VPN connection that this customer gateway supports ( ipsec.1
).
bgpAsn?
Type:
number
(optional, default: 65000)
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
bgpAsnExtended?
Type:
number
(optional)
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
certificateArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) for the customer gateway certificate.
deviceName?
Type:
string
(optional)
The name of customer gateway device.
tags?
Type:
Cfn
[]
(optional)
One or more tags for the customer gateway.