Zone

This class encapsulates and extends the ROS resource type ALIYUN::PVTZ::Zone, which is used to create a private zone.

Initializers

import ros_cdk_pvtz
ros_cdk_pvtz.Zone(
  scope: Construct,
  id: str,
  zone_name: typing.Union[str, IResolvable],
  ignored_stack_tag_keys: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  proxy_pattern: typing.Union[str, IResolvable] = None,
  remark: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  zone_tag: typing.Union[str, IResolvable] = None,
  zone_type: 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.
zone_name	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneName: Zone name.
ignored_stack_tag_keys	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property ignoredStackTagKeys: Stack tag keys to ignore.
proxy_pattern	typing.Union[str, ros_cdk_core.IResolvable]	Property proxyPattern: ZONE: completely hijack the entire zone.
remark	typing.Union[str, ros_cdk_core.IResolvable]	Property remark: 50 characters at most.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group id.
tags	typing.List[TagsProperty]	Property tags: Tags to attach to instance.
zone_tag	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneTag: Zone label.
zone_type	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneType: Zone type.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

zone_name^Required

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

Property zoneName: Zone name.

---

ignored_stack_tag_keys^Optional

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

Property ignoredStackTagKeys: Stack tag keys to ignore.

---

proxy_pattern^Optional

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

Property proxyPattern: ZONE: completely hijack the entire zone.

RECORD: Incomplete hijacking, recursive resolution agent. Default to ZONE.

---

remark^Optional

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

Property remark: 50 characters at most.

It can only contain numbers, Chinese, English and special characters: "_-,.，。".

---

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

---

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

---

zone_tag^Optional

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

Property zoneTag: Zone label.

It will be ignored when ZoneType is AUTH_ZONE.

---

zone_type^Optional

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

Property zoneType: Zone type.

For instance: AUTH_ZONE, CLOUD_PRODUCT_ZONE.

---

enable_resource_property_constraint^Optional

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

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

---

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

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

---

is_construct

import ros_cdk_pvtz
ros_cdk_pvtz.Zone.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_zone_id	ros_cdk_core.IResolvable	Attribute ZoneId: Zone ID.
attr_zone_name	ros_cdk_core.IResolvable	Attribute ZoneName: Zone name.
attr_zone_tag	ros_cdk_core.IResolvable	Attribute ZoneTag: Zone label.
attr_zone_type	ros_cdk_core.IResolvable	Attribute ZoneType: Zone type.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_zone_id^Required

attr_zone_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneId: Zone ID.

---

attr_zone_name^Required

attr_zone_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneName: Zone name.

---

attr_zone_tag^Required

attr_zone_tag: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneTag: Zone label.

---

attr_zone_type^Required

attr_zone_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneType: Zone type.

---