Skip to content

Domain

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

Initializers

import com.aliyun.ros.cdk.cdn.Domain;
Domain.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .cdnType(java.lang.String)
    .cdnType(IResolvable)
    .domainName(java.lang.String)
    .domainName(IResolvable)
//  .checkUrl(java.lang.String)
//  .checkUrl(IResolvable)
//  .originServers(IResolvable)
//  .originServers(java.util.List<IResolvable)
//  .originServers(OriginServersProperty>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .scope(java.lang.String)
//  .scope(IResolvable)
//  .sources(java.lang.String)
//  .sources(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.
cdnType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cdnType: The business type.
domainName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property domainName: The CDN domain name.
checkUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property checkUrl: The validation of the origin.
originServers com.aliyun.ros.cdk.core.IResolvable OR java.util.ListOriginServersProperty> Property originServers: The list of origin URLs.
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.
sources java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sources: The list of origin URLs.
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

cdnTypeRequired

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


domainNameRequired

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

Property domainName: The CDN domain name.

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


checkUrlOptional

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

Property checkUrl: The validation of the origin.


originServersOptional

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

Property originServers: The list of origin URLs.

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


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.


sourcesOptional

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

Property sources: The list of origin URLs.


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

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.cdn.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.
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.
attrCname 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 com.aliyun.ros.cdk.core.IResolvable Attribute DomainName: The CDN domain name.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


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

attrCnameRequired

public IResolvable getAttrCname();
  • Type: 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 IResolvable getAttrDomainName();
  • Type: 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.