Skip to content

RecordProps

Properties for defining a Record.

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

Initializer

import ros_cdk_esa
ros_cdk_esa.RecordProps(
  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
)

Properties

Name Type Description
data typing.Union[ros_cdk_core.IResolvable, DataProperty] Property data: The DNS record information.
record_name typing.Union[str, ros_cdk_core.IResolvable] Property recordName: The record name.
record_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 typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property siteId: The website ID.
auth_conf typing.Union[ros_cdk_core.IResolvable, AuthConfProperty] Property authConf: The origin authentication information of the CNAME record.
biz_name typing.Union[str, ros_cdk_core.IResolvable] Property bizName: The business scenario of the record for acceleration.
comment typing.Union[str, ros_cdk_core.IResolvable] Property comment: The comment of the record.
host_policy typing.Union[str, ros_cdk_core.IResolvable] Property hostPolicy: The origin host policy.
proxied typing.Union[bool, ros_cdk_core.IResolvable] Property proxied: Specifies whether to proxy the record.
source_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceType: The origin type for the CNAME record.
ttl typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ttl: The TTL of the record.

dataRequired

data: typing.Union[IResolvable, DataProperty]
  • 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_nameRequired

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

Property recordName: The record name.

This parameter specifies a filter condition for the query.


record_typeRequired

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

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


site_idRequired

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

Property siteId: The website ID.


auth_confOptional

auth_conf: typing.Union[IResolvable, AuthConfProperty]

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


biz_nameOptional

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


commentOptional

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

Property comment: The comment of the record.

The maximum length is 100 characters.


host_policyOptional

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


proxiedOptional

proxied: typing.Union[bool, IResolvable]
  • 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_typeOptional

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


ttlOptional

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