Skip to content

NatIpProps

Properties for defining a NatIp.

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

Initializer

import { NatIpProps } from '@alicloud/ros-cdk-vpc'
const natIpProps: NatIpProps = { ... }

Properties

Name Type Description
natGatewayId string | @alicloud/ros-cdk-core.IResolvable Property natGatewayId: The ID of the Virtual Private Cloud (VPC) NAT gateway for which you want to create the NAT IP address.
natIpCidr string | @alicloud/ros-cdk-core.IResolvable Property natIpCidr: The CIDR block to which the NAT IP address belongs.
natIpDescription string | @alicloud/ros-cdk-core.IResolvable Property natIpDescription: The description of the NAT IP address.
natIpName string | @alicloud/ros-cdk-core.IResolvable Property natIpName: The name of the NAT IP address.
ipv4Prefix string | @alicloud/ros-cdk-core.IResolvable Property ipv4Prefix: The IPv4 prefix of the IP address range to be created.
ipv4PrefixCount number | @alicloud/ros-cdk-core.IResolvable Property ipv4PrefixCount: The number of IPv4 prefixes to automatically allocate.
natIp string | @alicloud/ros-cdk-core.IResolvable Property natIp: The NAT IP address that you want to create.
natIpCidrId string | @alicloud/ros-cdk-core.IResolvable Property natIpCidrId: The ID of the CIDR block to which the NAT IP address belongs.

natGatewayIdRequired

public readonly natGatewayId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natGatewayId: The ID of the Virtual Private Cloud (VPC) NAT gateway for which you want to create the NAT IP address.


natIpCidrRequired

public readonly natIpCidr: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natIpCidr: The CIDR block to which the NAT IP address belongs.


natIpDescriptionRequired

public readonly natIpDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natIpDescription: The description of the NAT IP address.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:\/\/ or https:\/\/.


natIpNameRequired

public readonly natIpName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natIpName: The name of the NAT IP address.

The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. It cannot start with http:\/\/ or https:\/\/.


ipv4PrefixOptional

public readonly ipv4Prefix: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ipv4Prefix: The IPv4 prefix of the IP address range to be created.

The IPv4 prefix must be within the reserved CIDR block of the switch where the NAT gateway is deployed, and the reserved CIDR block must not be occupied. The prefix length must be \/28.


ipv4PrefixCountOptional

public readonly ipv4PrefixCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property ipv4PrefixCount: The number of IPv4 prefixes to automatically allocate.

Randomly allocated from the unassigned reserved CIDR blocks of the switch where the NAT gateway is deployed. Valid values: 1 to 10.


natIpOptional

public readonly natIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natIp: The NAT IP address that you want to create.

If you do not specify an IP address, the system selects a random IP address from the specified CIDR block.


natIpCidrIdOptional

public readonly natIpCidrId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property natIpCidrId: The ID of the CIDR block to which the NAT IP address belongs.