Skip to content

Domain

This class encapsulates and extends the ROS resource type ALIYUN::DCDN::Domain, which is used to add a Dynamic Route for CDN (DCDN) domain name.

Initializers

import com.aliyun.ros.cdk.dcdn.Domain;
Domain.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .domainName(java.lang.String)
    .domainName(IResolvable)
    .sources(IResolvable)
    .sources(java.util.List<IResolvable)
    .sources(SourcesProperty>)
//  .checkUrl(java.lang.String)
//  .checkUrl(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .scope(java.lang.String)
//  .scope(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .topLevelDomain(java.lang.String)
//  .topLevelDomain(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.
domainName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property domainName: The DCDN domain name.
sources com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSourcesProperty> Property sources: The list of origin URLs.
checkUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property checkUrl: The health check URL.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
scope java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scope: Valid values: domestic, overseas, and global.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
topLevelDomain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topLevelDomain: The top-level domain, which can only be configured by users on the whitelist.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

domainNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property domainName: The DCDN domain name.

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


sourcesRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSourcesProperty>

Property sources: The list of origin URLs.


checkUrlOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property checkUrl: The health check URL.


resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.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.


scopeOptional

  • Type: java.lang.String OR com.aliyun.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.


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.


topLevelDomainOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.dcdn.Domain;
Domain.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attrCname java.lang.String OR com.aliyun.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.
attrDomainName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DomainName: The CDN domain name.
props DomainProps 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

attrArnRequired

public java.lang.Object getAttrArn();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).


attrCnameRequired

public java.lang.Object getAttrCname();
  • Type: java.lang.String OR com.aliyun.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.


attrDomainNameRequired

public java.lang.Object getAttrDomainName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DomainName: The CDN domain name.

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


propsRequired

public DomainProps getProps();