Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::DNS::Instance, which is used to create an Alibaba Cloud DNS instance.

Initializers

import ros_cdk_dns
ros_cdk_dns.Instance(
  scope: Construct,
  id: str,
  dns_security: typing.Union[str, IResolvable],
  domain_numbers: typing.Union[typing.Union[int, float], IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  period_unit: typing.Union[str, IResolvable],
  version: typing.Union[str, IResolvable],
  domain: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  renewal_status: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

dns_security^Required

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

Property dnsSecurity: The DNS security policy.

Valid values:

• no: No protection against DNS attacks is provided.
• basic: Basic protection against DNS attacks is provided.
• advanced: Advanced protection against DNS attacks is provided.

domain_numbers^Required

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

Property domainNumbers: The number of domain names.

period^Required

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

Property period: The subscription duration.

Valid values:

• If unit is month: 1, 2, 3, 6
• If unit is year: 1, 2

period_unit^Required

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

Property periodUnit: The subscription duration unit.

version^Required

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

Property version: The edition of Alibaba Cloud DNS.

Valid values: If create hosted public zone:

• version_personal: Personal Edition.
• version_enterprise_basic: Enterprise Standard Edition.
• version_enterprise_advanced: Enterprise Ultimate Edition. If create cached public zone:
• version_cached_basicNote: Only upgrade operations are supported after instance creation.

domain^Optional

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

Property domain: The domain name that you want to bind to the instance.

If you want to bind multiple domain names to the instance, separate these domain names with commas (,).

instance_type^Optional

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

Property instanceType: The type of the instance.

Valid values:

• HostedPublicZone: Hosted Public Zone
• CachedPublicZone: Cached Public Zone.

renewal_status^Optional

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

Property renewalStatus: The renewal method.

Valid values:

• AutoRenewal: The instance is automatically renewed.
• ManualRenewal: The instance is manually renewed. Default value: ManualRenewal.

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_dns
ros_cdk_dns.Instance.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_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: DNS instance id.

props^Required

props: InstanceProps

• Type: InstanceProps