Domain

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

Initializers

import ros_cdk_cdn
ros_cdk_cdn.Domain(
  scope: Construct,
  id: str,
  cdn_type: typing.Union[str, IResolvable],
  domain_name: typing.Union[str, IResolvable],
  check_url: typing.Union[str, IResolvable] = None,
  origin_servers: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, OriginServersProperty]]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scope: typing.Union[str, IResolvable] = None,
  sources: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  top_level_domain: 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.
cdn_type	typing.Union[str, ros_cdk_core.IResolvable]	Property cdnType: The business type.
domain_name	typing.Union[str, ros_cdk_core.IResolvable]	Property domainName: The CDN domain name.
check_url	typing.Union[str, ros_cdk_core.IResolvable]	Property checkUrl: The validation of the origin.
origin_servers	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, OriginServersProperty]]]	Property originServers: The list of origin URLs.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the resource group.
scope	typing.Union[str, ros_cdk_core.IResolvable]	Property scope: Valid values: domestic, overseas, and global.
sources	typing.Union[str, ros_cdk_core.IResolvable]	Property sources: The list of origin URLs.
tags	typing.List[TagsProperty]	Property tags: Tags to attach to instance.
top_level_domain	typing.Union[str, ros_cdk_core.IResolvable]	Property topLevelDomain: The top-level domain, which can only be configured by users on the whitelist.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

cdn_type^Required

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

Property cdnType: The business type.

Valid values: web, download, video, livestream, and httpsdelivery. web: acceleration of images and small files download. download: acceleration of large file downloads. video: live streaming acceleration. httpsdelivery: SSL acceleration for HTTPS.

---

domain_name^Required

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

Property domainName: The CDN domain name.

Wildcard domain names that start with periods (.) are supported. For example, .a.com.

---

check_url^Optional

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

Property checkUrl: The validation of the origin.

---

origin_servers^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, OriginServersProperty]]]

Property originServers: The list of origin URLs.

It has the same function as Sources, but has a higher priority than it.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

If this is left blank, the system automatically fills in the ID of the default resource group.

---

scope^Optional

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

Property scope: Valid values: domestic, overseas, and global.

Default value: domestic. The setting is supported for users outside mainland China, users in mainland China of level 3 or above.

---

sources^Optional

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

Property sources: The list of origin URLs.

---

tags^Optional

• Type: typing.List[TagsProperty]

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.

---

top_level_domain^Optional

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

Property topLevelDomain: The top-level domain, which can only be configured by users on the whitelist.

---

enable_resource_property_constraint^Optional

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• 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_cname	ros_cdk_core.IResolvable	Attribute Cname: The CNAME generated for the CDN domain.You must add a CNAME record with your DNS provider to map the CDN domain name to the CNAME.
attr_domain_name	ros_cdk_core.IResolvable	Attribute DomainName: The CDN domain name.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_cname^Required

attr_cname: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Cname: The CNAME generated for the CDN domain.You must add a CNAME record with your DNS provider to map the CDN domain name to the CNAME.

---

attr_domain_name^Required

attr_domain_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DomainName: The CDN domain name.

Wildcard domain names that start with periods (.) are supported. For example, .a.com.

---