SnatEntry

• Implements: ISnatEntry

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

Initializers

import com.aliyun.ros.cdk.vpc.SnatEntry;
SnatEntry.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .snatIp(java.lang.String)
    .snatIp(IResolvable)
    .snatTableId(java.lang.String)
    .snatTableId(IResolvable)
//  .eipAffinity(java.lang.Number)
//  .eipAffinity(IResolvable)
//  .networkInterfaceId(java.lang.String)
//  .networkInterfaceId(IResolvable)
//  .snatEntryName(java.lang.String)
//  .snatEntryName(IResolvable)
//  .sourceCidr(java.lang.String)
//  .sourceCidr(IResolvable)
//  .sourceVSwitchIds(IResolvable)
//  .sourceVSwitchIds(java.util.List<java.lang.String)
//  .sourceVSwitchIds(IResolvable>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

snatIp^Required

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

Property snatIp: The public IP address.

Separate multiple EIPs with commas.

snatTableId^Required

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

Property snatTableId: The ID of the SNAT table.

eipAffinity^Optional

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

Property eipAffinity: Specifies whether to enable EIP affinity.

Valid values: 0: no 1: yes If EIP affinity is enabled and the SNAT entry is associated with multiple EIPs, a client uses the same EIP to access the Internet. Otherwise, the client uses an EIP selected from the associated EIPs to access the Internet.

networkInterfaceId^Optional

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

Property networkInterfaceId: The ID of the elastic network interface.

The IPv4 addresses of the elastic network interface will be used as the SNAT IP addresses.

snatEntryName^Optional

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

Property snatEntryName: The name of the SNAT entry.

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

sourceCidr^Optional

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

Property sourceCidr: You can specify the CIDR block of a VPC, a vSwitch, or an ECS instance or enter a custom CIDR block.

You can specify an SNAT entry in the following ways:

• You can specify the CIDR block of the VPC where the NAT gateway is deployed. Then, all ECS instances in the VPC can access the Internet or external networks by using SNAT.
• You can specify the CIDR block of a vSwitch, for example, 192.168.1.0/24. Then, the ECS instances in the vSwitch can access the Internet or external networks by using SNAT.
• You can specify the IP address of an ECS instance, for example, 192.168.1.1/32. Then, the ECS instance can access the Internet or external networks by using SNAT.
• You can specify a custom CIDR block. Then, all ECS instances within the specified CIDR block can access the Internet or external networks by using SNAT. When you add an SNAT entry to an Internet NAT gateway, if SnatIp is set to an EIP, the ECS instance uses the specified EIP to access the Internet. If SnatIp is set to multiple EIPs, the ECS instance randomly selects an EIP specified in the SnatIp parameter to access the Internet. You cannot specify this parameter and SourceVSwtichId at the same time. If SourceVSwitchId is specified, you cannot specify SourceCIDR. If SourceCIDR is specified, you cannot specify SourceVSwitchId.

sourceVSwitchIds^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property sourceVSwitchIds: The ID of the VSwitch to access the Internet.

When updating this list parameter, a new item will lead to a creation of new Snat Entry with latest properties, a removed item will lead to a deletion of the attached SnatEntry

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.SnatEntry;
SnatEntry.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

attrSnatEntryIds^Required

public java.lang.Object getAttrSnatEntryIds();

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

Attribute SnatEntryIds: The IDS of the SNAT entry.

props^Required

public SnatEntryProps getProps();

• Type: SnatEntryProps