Record

• Implements: IRecord

This class encapsulates and extends the ROS resource type ALIYUN::ESA::Record.

Initializers

import com.aliyun.ros.cdk.esa.Record;
Record.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .data(IResolvable)
    .data(DataProperty)
    .recordName(java.lang.String)
    .recordName(IResolvable)
    .recordType(java.lang.String)
    .recordType(IResolvable)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .authConf(IResolvable)
//  .authConf(AuthConfProperty)
//  .bizName(java.lang.String)
//  .bizName(IResolvable)
//  .comment(java.lang.String)
//  .comment(IResolvable)
//  .hostPolicy(java.lang.String)
//  .hostPolicy(IResolvable)
//  .proxied(java.lang.Boolean)
//  .proxied(IResolvable)
//  .sourceType(java.lang.String)
//  .sourceType(IResolvable)
//  .ttl(java.lang.Number)
//  .ttl(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

data^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR DataProperty

Property data: The DNS record information.

The format of this field varies based on the record type. For more information, see [References] https://www.alibabacloud.com/help/doc-detail/2708761.html?spm=openapi-amp.newDocPublishment.0.0.6a0f281feoeVWr.

recordName^Required

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

Property recordName: The record name.

This parameter specifies a filter condition for the query.

recordType^Required

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

Property recordType: The type of the DNS record, such as A\/AAAA, CNAME, and TXT.

siteId^Required

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

Property siteId: The website ID.

authConf^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR AuthConfProperty

Property authConf: The origin authentication information of the CNAME record.

bizName^Optional

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

Property bizName: The business scenario of the record for acceleration.

Leave the parameter empty if your record is not proxied. Valid values: image_video: video and image. api: API. web: web page.

comment^Optional

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

Property comment: The comment of the record.

The maximum length is 100 characters.

hostPolicy^Optional

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

Property hostPolicy: The origin host policy.

This policy takes effect when the record type is CNAME. You can set the policy in two modes: follow_hostname: Follow the host record. follow_origin_domain: match the origin's domain name.

proxied^Optional

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

Property proxied: Specifies whether to proxy the record.

Only CNAME and A/AAAA records can be proxied. Valid values: true false.

sourceType^Optional

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

Property sourceType: The origin type for the CNAME record.

This parameter is required when you add a CNAME record. Valid values: OSS: OSS bucket. S3: S3 bucket. LB: load balancer. OP: origin pool. Domain: domain name. If you do not pass this parameter or if you leave its value empty, Domain is used by default.

ttl^Optional

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

Property ttl: The TTL of the record.

Unit: seconds. If the value is 1, the TTL of the record is determined by the system.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.esa.Record;
Record.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrAuthConf^Required

public java.lang.Object getAttrAuthConf();

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

Attribute AuthConf: The origin authentication information of the CNAME record.

attrBizName^Required

public java.lang.Object getAttrBizName();

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

Attribute BizName: The business scenario of the record for acceleration.

Leave the parameter empty if your record is not proxied.

attrComment^Required

public java.lang.Object getAttrComment();

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

Attribute Comment: The comment of the record.

The maximum length is 100 characters.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The time when the record was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attrData^Required

public java.lang.Object getAttrData();

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

Attribute Data: The DNS record information.

The format of this field varies based on the record type. For more information, see [References]https://www.alibabacloud.com/help/doc-detail/2708761.html?spm=openapi-amp.newDocPublishment.0.0.6a0f281feoeVWr.

attrHostPolicy^Required

public java.lang.Object getAttrHostPolicy();

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

Attribute HostPolicy: The origin host policy.

This policy takes effect when the record type is CNAME.

attrModifyTime^Required

public java.lang.Object getAttrModifyTime();

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

Attribute ModifyTime: The time when the record was updated.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attrProxied^Required

public java.lang.Object getAttrProxied();

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

Attribute Proxied: Specifies whether to proxy the record.

Only CNAME and A/AAAA records can be proxied.

attrRecordCname^Required

public java.lang.Object getAttrRecordCname();

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

Attribute RecordCname: The CNAME.

If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.

attrRecordId^Required

public java.lang.Object getAttrRecordId();

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

Attribute RecordId: Record Id.

attrRecordName^Required

public java.lang.Object getAttrRecordName();

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

Attribute RecordName: The record name.

This parameter specifies a filter condition for the query.

attrRecordType^Required

public java.lang.Object getAttrRecordType();

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

Attribute RecordType: The type of the DNS record, such as A/AAAA, CNAME, and TXT.

attrSiteId^Required

public java.lang.Object getAttrSiteId();

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

Attribute SiteId: The website ID.

attrSiteName^Required

public java.lang.Object getAttrSiteName();

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

Attribute SiteName: The website name.

attrSourceType^Required

public java.lang.Object getAttrSourceType();

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

Attribute SourceType: The origin type for the CNAME record.

This parameter is required when you add a CNAME record.

attrTtl^Required

public java.lang.Object getAttrTtl();

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

Attribute Ttl: The TTL of the record.

Unit: seconds. If the value is 1, the TTL of the record is determined by the system.

props^Required

public RecordProps getProps();

• Type: RecordProps