CustomerGateway

• Implements: ICustomerGateway

This class encapsulates and extends the ROS resource type ALIYUN::VPC::CustomerGateway, which is used to create a customer gateway.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.CustomerGateway(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

ip_address^Required

• 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

asn^Optional

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

description^Optional

• 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:\/\/.

name^Optional

• 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_id^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_vpc
ros_cdk_vpc.CustomerGateway.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_customer_gateway_id^Required

attr_customer_gateway_id: typing.Union[str, IResolvable]

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

Attribute CustomerGatewayId: The ID of the user gateway.

props^Required

props: CustomerGatewayProps

• Type: CustomerGatewayProps