DhcpOptionsSet
- Implements: IDhcpOptionsSet
This class encapsulates and extends the ROS resource type ALIYUN::VPC::DhcpOptionsSet.
Initializers
import ros_cdk_vpc
ros_cdk_vpc.DhcpOptionsSet(
scope: Construct,
id: str,
dhcp_options_set_description: typing.Union[str, IResolvable] = None,
dhcp_options_set_name: typing.Union[str, IResolvable] = None,
domain_name: typing.Union[str, IResolvable] = None,
domain_name_servers: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
ipv6_lease_time: typing.Union[str, IResolvable] = None,
lease_time: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
dhcp_options_set_description | typing.Union[str, ros_cdk_core.IResolvable] | Property dhcpOptionsSetDescription: The description of the DHCP options set. |
dhcp_options_set_name | typing.Union[str, ros_cdk_core.IResolvable] | Property dhcpOptionsSetName: The name of the DHCP options set. |
domain_name | typing.Union[str, 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. |
domain_name_servers | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property domainNameServers: The DNS server IP addresses. |
ipv6_lease_time | typing.Union[str, ros_cdk_core.IResolvable] | Property ipv6LeaseTime: The lease time of the IPv6 DHCP options set. |
lease_time | typing.Union[str, ros_cdk_core.IResolvable] | Property leaseTime: The lease time of the IPv4 DHCP options set. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group to which the DHCP options set belongs. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
dhcp_options_set_descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dhcpOptionsSetDescription: The description of the DHCP options set.
The description must be 2 to 256 characters in length and cannot start with http:// or https://.
dhcp_options_set_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dhcpOptionsSetName: The name of the DHCP options set.
The name must be 2 to 128 characters in length and can contain letters, Chinese characters, digits, underscores (_), and hyphens (-). It must start with a letter or a Chinese character.
domain_nameOptional
- Type: typing.Union[str, 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.
domain_name_serversOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
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.
ipv6_lease_timeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipv6LeaseTime: The lease time of the IPv6 DHCP options set.
- When setting lease time in hours: unit: h. Valid values: 24h~1176h, 87600h~175200h. Default value: 24h.
- When setting lease time in days: unit: d. Valid values: 1d~49d, 3650d~7300d. Default value: 1d.
When specifying parameter values, you must include the unit.
lease_timeOptional
- Type: typing.Union[str, 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.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group to which the DHCP options set belongs.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
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: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_vpc
ros_cdk_vpc.DhcpOptionsSet.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_dhcp_options_set_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DhcpOptionsSetId: The ID of the DHCP options set that is created. |
props | DhcpOptionsSetProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: 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
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_dhcp_options_set_idRequired
attr_dhcp_options_set_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DhcpOptionsSetId: The ID of the DHCP options set that is created.
propsRequired
props: DhcpOptionsSetProps
- Type: DhcpOptionsSetProps