AssignPrivateIpAddresses
- Implements: IAssignPrivateIpAddresses
This class encapsulates and extends the ROS resource type ALIYUN::ECS::AssignPrivateIpAddresses.
Initializers
import com.aliyun.ros.cdk.ecs.AssignPrivateIpAddresses;
AssignPrivateIpAddresses.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.networkInterfaceId(java.lang.String)
.networkInterfaceId(IResolvable)
// .ipv4PrefixCount(java.lang.Number)
// .ipv4PrefixCount(IResolvable)
// .ipv4Prefixes(java.util.List<java.lang.Object>)
// .ipv4Prefixes(IResolvable)
// .privateIpAddresses(java.util.List<java.lang.Object>)
// .privateIpAddresses(IResolvable)
// .secondaryPrivateIpAddressCount(java.lang.Number)
// .secondaryPrivateIpAddressCount(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
networkInterfaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property networkInterfaceId: The ID of the ENI. |
ipv4PrefixCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property ipv4PrefixCount: The number of IPv4 prefixes to be randomly generated for the ENI. |
ipv4Prefixes | java.util.List | Property ipv4Prefixes: One or multiple IPv4 prefixes to be assigned to the ENI. |
privateIpAddresses | java.util.List | Property privateIpAddresses: One or multiple secondary private IP addresses selected from the CIDR block of the VSwitch that hosts the ENI. |
secondaryPrivateIpAddressCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property secondaryPrivateIpAddressCount: The number of private IP addresses to be automatically assigned from the CIDR block of the vSwitch that is connected to the ENI. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
networkInterfaceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property networkInterfaceId: The ID of the ENI.
ipv4PrefixCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property ipv4PrefixCount: The number of IPv4 prefixes to be randomly generated for the ENI.
Valid values: 1 to 10.
To assign IPv4 prefixes to the ENI, you must specify the Ipv4Prefix.N or Ipv4PrefixCount parameter, but not both.
ipv4PrefixesOptional
- Type: java.util.List
OR com.aliyun.ros.cdk.core.IResolvable
Property ipv4Prefixes: One or multiple IPv4 prefixes to be assigned to the ENI.
privateIpAddressesOptional
- Type: java.util.List
OR com.aliyun.ros.cdk.core.IResolvable
Property privateIpAddresses: One or multiple secondary private IP addresses selected from the CIDR block of the VSwitch that hosts the ENI.
Valid values of number of private ip addresses: When the ENI is in the Available state: 1 to 10. When the ENI is in the InUse state: limited by the instance type. For more information, see Instance type families. You must specify either the PrivateIpAddresses parameter or the SecondaryPrivateIpAddressCount parameter to assign secondary private IP addresses.
secondaryPrivateIpAddressCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property secondaryPrivateIpAddressCount: The number of private IP addresses to be automatically assigned from the CIDR block of the vSwitch that is connected to the ENI.
To assign secondary private IP addresses to the ENI, you must specify PrivateIpAddress.N or SecondaryPrivateIpAddressCount but not both.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.ecs.AssignPrivateIpAddresses;
AssignPrivateIpAddresses.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrNetworkInterfaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute NetworkInterfaceId: The ID of the ENI. |
attrPrivateIpAddresses | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PrivateIpAddresses: Assigned private ip addresses. |
props | AssignPrivateIpAddressesProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrNetworkInterfaceIdRequired
public java.lang.Object getAttrNetworkInterfaceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute NetworkInterfaceId: The ID of the ENI.
attrPrivateIpAddressesRequired
public java.lang.Object getAttrPrivateIpAddresses();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PrivateIpAddresses: Assigned private ip addresses.
propsRequired
public AssignPrivateIpAddressesProps getProps();