Record

• Implements: IRecord

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

Initializers

import ros_cdk_esa
ros_cdk_esa.Record(
  scope: Construct,
  id: str,
  data: typing.Union[IResolvable, DataProperty],
  record_name: typing.Union[str, IResolvable],
  record_type: typing.Union[str, IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  auth_conf: typing.Union[IResolvable, AuthConfProperty] = None,
  biz_name: typing.Union[str, IResolvable] = None,
  comment: typing.Union[str, IResolvable] = None,
  host_policy: typing.Union[str, IResolvable] = None,
  proxied: typing.Union[bool, IResolvable] = None,
  source_type: typing.Union[str, IResolvable] = None,
  ttl: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

data^Required

• Type: typing.Union[ros_cdk_core.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.

record_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property recordName: The record name.

This parameter specifies a filter condition for the query.

record_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

site_id^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property siteId: The website ID.

auth_conf^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, AuthConfProperty]

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

biz_name^Optional

• Type: typing.Union[str, 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: typing.Union[str, ros_cdk_core.IResolvable]

Property comment: The comment of the record.

The maximum length is 100 characters.

host_policy^Optional

• Type: typing.Union[str, 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: typing.Union[bool, 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.

source_type^Optional

• Type: typing.Union[str, 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: typing.Union[typing.Union[int, float], 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_esa
ros_cdk_esa.Record.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_auth_conf^Required

attr_auth_conf: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_biz_name^Required

attr_biz_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Leave the parameter empty if your record is not proxied.

attr_comment^Required

attr_comment: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Comment: The comment of the record.

The maximum length is 100 characters.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_data^Required

attr_data: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_host_policy^Required

attr_host_policy: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HostPolicy: The origin host policy.

This policy takes effect when the record type is CNAME.

attr_modify_time^Required

attr_modify_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_proxied^Required

attr_proxied: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Proxied: Specifies whether to proxy the record.

Only CNAME and A/AAAA records can be proxied.

attr_record_cname^Required

attr_record_cname: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_record_id^Required

attr_record_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RecordId: Record Id.

attr_record_name^Required

attr_record_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RecordName: The record name.

This parameter specifies a filter condition for the query.

attr_record_type^Required

attr_record_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_site_id^Required

attr_site_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SiteId: The website ID.

attr_site_name^Required

attr_site_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SiteName: The website name.

attr_source_type^Required

attr_source_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SourceType: The origin type for the CNAME record.

This parameter is required when you add a CNAME record.

attr_ttl^Required

attr_ttl: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

props: RecordProps

• Type: RecordProps