Skip to content

RecordProps

Properties for defining a Record.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-record

Initializer

import { RecordProps } from '@alicloud/ros-cdk-esa'
const recordProps: RecordProps = { ... }

Properties

Name Type Description
data @alicloud/ros-cdk-core.IResolvable | DataProperty Property data: The DNS record information.
recordName string | @alicloud/ros-cdk-core.IResolvable Property recordName: The record name.
recordType string | @alicloud/ros-cdk-core.IResolvable Property recordType: The type of the DNS record, such as A\/AAAA, CNAME, and TXT.
siteId number | @alicloud/ros-cdk-core.IResolvable Property siteId: The website ID.
authConf @alicloud/ros-cdk-core.IResolvable | AuthConfProperty Property authConf: The origin authentication information of the CNAME record.
bizName string | @alicloud/ros-cdk-core.IResolvable Property bizName: The business scenario of the record for acceleration.
comment string | @alicloud/ros-cdk-core.IResolvable Property comment: The comment of the record.
hostPolicy string | @alicloud/ros-cdk-core.IResolvable Property hostPolicy: The origin host policy.
proxied boolean | @alicloud/ros-cdk-core.IResolvable Property proxied: Specifies whether to proxy the record.
sourceType string | @alicloud/ros-cdk-core.IResolvable Property sourceType: The origin type for the CNAME record.
ttl number | @alicloud/ros-cdk-core.IResolvable Property ttl: The TTL of the record.

dataRequired

public readonly data: IResolvable | 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.


recordNameRequired

public readonly recordName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property recordName: The record name.

This parameter specifies a filter condition for the query.


recordTypeRequired

public readonly recordType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


siteIdRequired

public readonly siteId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property siteId: The website ID.


authConfOptional

public readonly authConf: IResolvable | AuthConfProperty;

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


bizNameOptional

public readonly bizName: string | IResolvable;
  • Type: string | @alicloud/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.


commentOptional

public readonly comment: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property comment: The comment of the record.

The maximum length is 100 characters.


hostPolicyOptional

public readonly hostPolicy: string | IResolvable;
  • Type: string | @alicloud/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.


proxiedOptional

public readonly proxied: boolean | IResolvable;
  • Type: boolean | @alicloud/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.


sourceTypeOptional

public readonly sourceType: string | IResolvable;
  • Type: string | @alicloud/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.


ttlOptional

public readonly ttl: number | IResolvable;
  • Type: number | @alicloud/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.