Record
- Implements: IRecord
This class encapsulates and extends the ROS resource type ALIYUN::ESA::Record.
Initializers
import { Record } from '@alicloud/ros-cdk-esa'
new Record(scope: Construct, id: string, props: RecordProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | RecordProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: RecordProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { Record } from '@alicloud/ros-cdk-esa'
Record.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrAuthConf | string | @alicloud/ros-cdk-core.IResolvable | Attribute AuthConf: The origin authentication information of the CNAME record. |
attrBizName | string | @alicloud/ros-cdk-core.IResolvable | Attribute BizName: The business scenario of the record for acceleration. |
attrComment | string | @alicloud/ros-cdk-core.IResolvable | Attribute Comment: The comment of the record. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time when the record was created. |
attrData | string | @alicloud/ros-cdk-core.IResolvable | Attribute Data: The DNS record information. |
attrHostPolicy | string | @alicloud/ros-cdk-core.IResolvable | Attribute HostPolicy: The origin host policy. |
attrModifyTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute ModifyTime: The time when the record was updated. |
attrProxied | string | @alicloud/ros-cdk-core.IResolvable | Attribute Proxied: Specifies whether to proxy the record. |
attrRecordCname | string | @alicloud/ros-cdk-core.IResolvable | Attribute RecordCname: The CNAME. |
attrRecordId | string | @alicloud/ros-cdk-core.IResolvable | Attribute RecordId: Record Id. |
attrRecordName | string | @alicloud/ros-cdk-core.IResolvable | Attribute RecordName: The record name. |
attrRecordType | string | @alicloud/ros-cdk-core.IResolvable | Attribute RecordType: The type of the DNS record, such as A/AAAA, CNAME, and TXT. |
attrSiteId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SiteId: The website ID. |
attrSiteName | string | @alicloud/ros-cdk-core.IResolvable | Attribute SiteName: The website name. |
attrSourceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute SourceType: The origin type for the CNAME record. |
attrTtl | string | @alicloud/ros-cdk-core.IResolvable | Attribute Ttl: The TTL of the record. |
props | RecordProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrAuthConfRequired
public readonly attrAuthConf: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AuthConf: The origin authentication information of the CNAME record.
attrBizNameRequired
public readonly attrBizName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute BizName: The business scenario of the record for acceleration.
Leave the parameter empty if your record is not proxied.
attrCommentRequired
public readonly attrComment: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Comment: The comment of the record.
The maximum length is 100 characters.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/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.
attrDataRequired
public readonly attrData: string | IResolvable;
- Type: string | @alicloud/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.
attrHostPolicyRequired
public readonly attrHostPolicy: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute HostPolicy: The origin host policy.
This policy takes effect when the record type is CNAME.
attrModifyTimeRequired
public readonly attrModifyTime: string | IResolvable;
- Type: string | @alicloud/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.
attrProxiedRequired
public readonly attrProxied: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Proxied: Specifies whether to proxy the record.
Only CNAME and A/AAAA records can be proxied.
attrRecordCnameRequired
public readonly attrRecordCname: string | IResolvable;
- Type: string | @alicloud/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.
attrRecordIdRequired
public readonly attrRecordId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RecordId: Record Id.
attrRecordNameRequired
public readonly attrRecordName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RecordName: The record name.
This parameter specifies a filter condition for the query.
attrRecordTypeRequired
public readonly attrRecordType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RecordType: The type of the DNS record, such as A/AAAA, CNAME, and TXT.
attrSiteIdRequired
public readonly attrSiteId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SiteId: The website ID.
attrSiteNameRequired
public readonly attrSiteName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SiteName: The website name.
attrSourceTypeRequired
public readonly attrSourceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SourceType: The origin type for the CNAME record.
This parameter is required when you add a CNAME record.
attrTtlRequired
public readonly attrTtl: string | IResolvable;
- Type: string | @alicloud/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.
propsRequired
public readonly props: RecordProps;
- Type: RecordProps