DhcpOptionsSet
- Implements: IDhcpOptionsSet
This class encapsulates and extends the ROS resource type ALIYUN::VPC::DhcpOptionsSet.
Initializers
import com.aliyun.ros.cdk.vpc.DhcpOptionsSet;
DhcpOptionsSet.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
// .dhcpOptionsSetDescription(java.lang.String)
// .dhcpOptionsSetDescription(IResolvable)
// .dhcpOptionsSetName(java.lang.String)
// .dhcpOptionsSetName(IResolvable)
// .domainName(java.lang.String)
// .domainName(IResolvable)
// .domainNameServers(IResolvable)
// .domainNameServers(java.util.List<java.lang.String)
// .domainNameServers(IResolvable>)
// .ipv6LeaseTime(java.lang.String)
// .ipv6LeaseTime(IResolvable)
// .leaseTime(java.lang.String)
// .leaseTime(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(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. |
dhcpOptionsSetDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dhcpOptionsSetDescription: The description of the DHCP options set. |
dhcpOptionsSetName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dhcpOptionsSetName: The name of the DHCP options set. |
domainName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property domainName: The root domain, for example, example.com. After a DHCP options set is associated with a Virtual Private Cloud (VPC) network, the root domain in the DHCP options set is automatically synchronized to the ECS instances in the VPC network. |
domainNameServers | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property domainNameServers: The DNS server IP addresses. |
ipv6LeaseTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipv6LeaseTime: The lease time of the IPv6 addresses for the DHCP options set. |
leaseTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property leaseTime: The lease time of the IPv4 DHCP options set. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group to which the DHCP options set belongs. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
dhcpOptionsSetDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dhcpOptionsSetDescription: The description of the DHCP options set.
The description must be 1 to 256 characters in length. It must start with a letter and cannot start with http:\/\/ or https:\/\/.
dhcpOptionsSetNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dhcpOptionsSetName: The name of the DHCP options set.
The name must be 1 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.
domainNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property domainName: The root domain, for example, example.com. After a DHCP options set is associated with a Virtual Private Cloud (VPC) network, the root domain in the DHCP options set is automatically synchronized to the ECS instances in the VPC network.
domainNameServersOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property domainNameServers: The DNS server IP addresses.
Note Before you specify any DNS server IP address, all ECS instances in the associated VPC network use the IP addresses of the Alibaba Cloud DNS servers, which are 100.100.2.136 and 100.100.2.138.
ipv6LeaseTimeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipv6LeaseTime: The lease time of the IPv6 addresses for the DHCP options set.
- If you use hours as the unit, valid values are 24h to 1176h and 87600h to 175200h. Default value: 87600h.
- If you use days as the unit, valid values are 1d to 49d and 3650d to 7300d. Default value: 3650d.
When you enter a value, you must also specify the unit.
leaseTimeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property leaseTime: The lease time of the IPv4 DHCP options set.
- When setting lease time in hours: unit: h. Valid values: 24h~1176h, 87600h~175200h. Default value: 87600h.
- When setting lease time in days: unit: d. Valid values: 1d~49d, 3650d~7300d. Default value: 3650d.
When specifying parameter values, you must include the unit.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group to which the DHCP options set belongs.
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.vpc.DhcpOptionsSet;
DhcpOptionsSet.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. |
attrDhcpOptionsSetId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DhcpOptionsSetId: The ID of the DHCP options set that is created. |
props | DhcpOptionsSetProps | 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
attrDhcpOptionsSetIdRequired
public java.lang.Object getAttrDhcpOptionsSetId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DhcpOptionsSetId: The ID of the DHCP options set that is created.
propsRequired
public DhcpOptionsSetProps getProps();
- Type: DhcpOptionsSetProps