Skip to content

Domain

This class encapsulates and extends the ROS resource type ALIYUN::DNS::Domain, which is used to add a domain name.

Initializers

import ros_cdk_dns
ros_cdk_dns.Domain(
  scope: Construct,
  id: str,
  domain_name: typing.Union[str, IResolvable],
  group_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
domain_name typing.Union[str, ros_cdk_core.IResolvable] Property domainName: Domain name.
group_id typing.Union[str, ros_cdk_core.IResolvable] Property groupId: Domain name grouping, the default is the "default grouping" GroupId.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

domain_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property domainName: Domain name.


group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property groupId: Domain name grouping, the default is the "default grouping" GroupId.


resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: Resource group id.


tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_dns
ros_cdk_dns.Domain.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
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_dns_servers ros_cdk_core.IResolvable Attribute DnsServers: The DNS list for the domain name under resolution.
attr_domain_id ros_cdk_core.IResolvable Attribute DomainId: Domain ID.
attr_domain_name ros_cdk_core.IResolvable Attribute DomainName: Domain name.
attr_group_id ros_cdk_core.IResolvable Attribute GroupId: Domain name group ID.
attr_group_name ros_cdk_core.IResolvable Attribute GroupName: The name of the domain name group.
attr_puny_code ros_cdk_core.IResolvable Attribute PunyCode: punycode returned only for a Chinese domain name.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


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_dns_serversRequired

attr_dns_servers: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DnsServers: The DNS list for the domain name under resolution.


attr_domain_idRequired

attr_domain_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DomainId: Domain ID.


attr_domain_nameRequired

attr_domain_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DomainName: Domain name.


attr_group_idRequired

attr_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GroupId: Domain name group ID.


attr_group_nameRequired

attr_group_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GroupName: The name of the domain name group.


attr_puny_codeRequired

attr_puny_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PunyCode: punycode returned only for a Chinese domain name.