Skip to content

Instance

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
dns_security typing.Union[str, ros_cdk_core.IResolvable] Property dnsSecurity: The DNS security policy.
domain_numbers typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property domainNumbers: The number of domain names.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription duration.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The subscription duration unit.
version typing.Union[str, ros_cdk_core.IResolvable] Property version: The edition of Alibaba Cloud DNS.
domain typing.Union[str, ros_cdk_core.IResolvable] Property domain: The domain name that you want to bind to the instance.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The type of the instance.
renewal_status typing.Union[str, ros_cdk_core.IResolvable] Property renewalStatus: The renewal method.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

dns_securityRequired

  • 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_numbersRequired

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

Property domainNumbers: The number of domain names.

periodRequired

  • 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_unitRequired

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

Property periodUnit: The subscription duration unit.

versionRequired

  • 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.

domainOptional

  • 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_typeOptional

  • 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_statusOptional

  • 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_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_dns
ros_cdk_dns.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: DNS instance id.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: DNS instance id.