Skip to content

Domain

This class encapsulates and extends the ROS resource type ALIYUN::DirectMail::Domain, which is used to create a domain name in Direct Mail.

Initializers

import ros_cdk_directmail
ros_cdk_directmail.Domain(
  scope: Construct,
  id: str,
  domain_name: typing.Union[str, IResolvable],
  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: The name of the domain.
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: The name of the domain.


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.

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

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

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_directmail
ros_cdk_directmail.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.
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_cname_auth_status typing.Union[str, ros_cdk_core.IResolvable] Attribute CnameAuthStatus: Cname auth status.
attr_cname_confirm_status typing.Union[str, ros_cdk_core.IResolvable] Attribute CnameConfirmStatus: Cname confirm status.
attr_cname_record typing.Union[str, ros_cdk_core.IResolvable] Attribute CnameRecord: Cname record.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: The creation time of the domain.
attr_default_domain typing.Union[str, ros_cdk_core.IResolvable] Attribute DefaultDomain: Default domain.
attr_dns_mx typing.Union[str, ros_cdk_core.IResolvable] Attribute DnsMx: DNS MX.
attr_dns_spf typing.Union[str, ros_cdk_core.IResolvable] Attribute DnsSpf: DNS SPF.
attr_dns_txt typing.Union[str, ros_cdk_core.IResolvable] Attribute DnsTxt: DNS txt.
attr_domain_id typing.Union[str, ros_cdk_core.IResolvable] Attribute DomainId: The ID of the domain.
attr_domain_name typing.Union[str, ros_cdk_core.IResolvable] Attribute DomainName: The name of the domain.
attr_domain_type typing.Union[str, ros_cdk_core.IResolvable] Attribute DomainType: The type of the domain.
attr_icp_status typing.Union[str, ros_cdk_core.IResolvable] Attribute IcpStatus: ICP status.
attr_mx_auth_status typing.Union[str, ros_cdk_core.IResolvable] Attribute MxAuthStatus: MX auth status.
attr_mx_record typing.Union[str, ros_cdk_core.IResolvable] Attribute MxRecord: MX Record.
attr_spf_auth_status typing.Union[str, ros_cdk_core.IResolvable] Attribute SpfAuthStatus: SPF auth status.
attr_spf_record typing.Union[str, ros_cdk_core.IResolvable] Attribute SpfRecord: SPF record.
attr_tl_domain_name typing.Union[str, ros_cdk_core.IResolvable] Attribute TlDomainName: TL domain name.
attr_tracef_record typing.Union[str, ros_cdk_core.IResolvable] Attribute TracefRecord: Tracef Record.
props DomainProps 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_cname_auth_statusRequired

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

Attribute CnameAuthStatus: Cname auth status.


attr_cname_confirm_statusRequired

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

Attribute CnameConfirmStatus: Cname confirm status.


attr_cname_recordRequired

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

Attribute CnameRecord: Cname record.


attr_create_timeRequired

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

Attribute CreateTime: The creation time of the domain.


attr_default_domainRequired

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

Attribute DefaultDomain: Default domain.


attr_dns_mxRequired

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

Attribute DnsMx: DNS MX.


attr_dns_spfRequired

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

Attribute DnsSpf: DNS SPF.


attr_dns_txtRequired

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

Attribute DnsTxt: DNS txt.


attr_domain_idRequired

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

Attribute DomainId: The ID of the domain.


attr_domain_nameRequired

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

Attribute DomainName: The name of the domain.


attr_domain_typeRequired

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

Attribute DomainType: The type of the domain.


attr_icp_statusRequired

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

Attribute IcpStatus: ICP status.


attr_mx_auth_statusRequired

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

Attribute MxAuthStatus: MX auth status.


attr_mx_recordRequired

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

Attribute MxRecord: MX Record.


attr_spf_auth_statusRequired

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

Attribute SpfAuthStatus: SPF auth status.


attr_spf_recordRequired

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

Attribute SpfRecord: SPF record.


attr_tl_domain_nameRequired

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

Attribute TlDomainName: TL domain name.


attr_tracef_recordRequired

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

Attribute TracefRecord: Tracef Record.


propsRequired

props: DomainProps