Skip to content

CustomerGatewayProps

Properties for defining a CustomerGateway.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-customergateway

Initializer

import ros_cdk_vpc
ros_cdk_vpc.CustomerGatewayProps(
  ip_address: typing.Union[str, IResolvable],
  asn: typing.Union[typing.Union[int, float], IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
ip_address typing.Union[str, ros_cdk_core.IResolvable] Property ipAddress: The static IP address of the gateway device in the data center.
asn typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property asn: The autonomous system number (ASN) of the gateway device in your data center.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the customer gateway.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the customer gateway.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the user gateway belongs.

ip_addressRequired

ip_address: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipAddress: The static IP address of the gateway device in the data center.

  • If you want to create a public IPsec-VPN connection, enter a public IP address.
  • If you want to create a private IPsec-VPN connection, enter a private IP address. You cannot use the following IP addresses. Otherwise, a IPsec-VPN connection cannot be established:
  • 100.64.0.0~100.127.255.255
  • 127.0.0.0~127.255.255.255
  • 169.254.0.0~169.254.255.255
  • 224.0.0.0~239.255.255.255
  • 255.0.0.0~255.255.255.255

asnOptional

asn: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property asn: The autonomous system number (ASN) of the gateway device in your data center.

This parameter is required If you want to use Border Gateway Protocol (BGP) for the IPsec-VPN connection. Valid values: 1 to 4294967295. 45104 is not supported. Asn is a 4-byte number. You can enter it in two segments and separate the first 16 bits from the following 16 bits with a period (.). Enter the number in each segment in decimal format. For example, if you enter 123.456, the ASN is 8061384. The ASN is calculated by using the following formula: 123 × 65536 + 456 = 8061384.

  • We recommend that you use a private ASN to establish BGP connections to the cloud platform. For information about the range of private ASNs, see the relevant documentation.
  • 45104 is a unique identifier assigned by IANA to the cloud platform. It is used to identify the cloud platform during route selection and data transmission over the Internet.

descriptionOptional

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the customer gateway.

The description must be 1 to 100 characters in length, and cannot start with http:\/\/ or https:\/\/.


nameOptional

name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the customer gateway.

The name must be 1 to 100 characters in length, and cannot start with http:\/\/ or https:\/\/.


resource_group_idOptional

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group to which the user gateway belongs.

  • You can call the ListResourceGroups interface to query the resource group ID.
  • If you do not specify a resource group, the user gateway will belong to the default resource group after creation.