NatIp

• Implements: INatIp

This class encapsulates and extends the ROS resource type ALIYUN::VPC::NatIp.

Initializers

import com.aliyun.ros.cdk.vpc.NatIp;
NatIp.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .natGatewayId(java.lang.String)
    .natGatewayId(IResolvable)
    .natIpCidr(java.lang.String)
    .natIpCidr(IResolvable)
    .natIpDescription(java.lang.String)
    .natIpDescription(IResolvable)
    .natIpName(java.lang.String)
    .natIpName(IResolvable)
//  .ipv4Prefix(java.lang.String)
//  .ipv4Prefix(IResolvable)
//  .ipv4PrefixCount(java.lang.Number)
//  .ipv4PrefixCount(IResolvable)
//  .natIp(java.lang.String)
//  .natIp(IResolvable)
//  .natIpCidrId(java.lang.String)
//  .natIpCidrId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

natGatewayId^Required

• Type: java.lang.String OR com.aliyun.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^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

natIpDescription^Required

• Type: java.lang.String OR com.aliyun.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://.

natIpName^Required

• Type: java.lang.String OR com.aliyun.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://.

ipv4Prefix^Optional

• Type: java.lang.String OR com.aliyun.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.

ipv4PrefixCount^Optional

• Type: java.lang.Number OR com.aliyun.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.

natIp^Optional

• Type: java.lang.String OR com.aliyun.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.

natIpCidrId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.vpc.NatIp;
NatIp.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrNatIp^Required

public java.lang.Object getAttrNatIp();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NatIp: NAT IP address.

attrNatIpId^Required

public java.lang.Object getAttrNatIpId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NatIpId: The ID of the NAT IP address.

props^Required

public NatIpProps getProps();

• Type: NatIpProps