Zone
- Implements: IZone
This class encapsulates and extends the ROS resource type ALIYUN::PVTZ::Zone.
Initializers
import ros_cdk_pvtz
ros_cdk_pvtz.Zone(
scope: Construct,
id: str,
zone_name: typing.Union[str, IResolvable],
dns_group: typing.Union[str, IResolvable] = None,
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,
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. |
dns_group | typing.Union[str, ros_cdk_core.IResolvable] | Property dnsGroup: Built-in authority location area. |
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. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
zone_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property zoneName: Zone name.
dns_groupOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dnsGroup: Built-in authority location area.
Valid values:
- NORMAL_ZONE: Default. normal zone (The parsing response result will be cached, and only back to the built-in authority normal zone if the cache is missed, the effect of parsing changes is affected by TTL time; Cannot use custom line analysis, weight analysis function.
- FAST_ZONE: Fast zone (Recommended: directly reply to the parsing request, the parsing delay is the lowest, and the record changes take effect in real time; Support custom line analysis, weight analysis.
ignored_stack_tag_keysOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property ignoredStackTagKeys: Stack tag keys to ignore.
proxy_patternOptional
- 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.
remarkOptional
- 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_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: Resource group id.
tagsOptional
- 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.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- 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.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_arn | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Arn: The Alibaba Cloud Resource Name (ARN). |
attr_zone_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ZoneId: Zone ID. |
attr_zone_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ZoneName: Zone name. |
attr_zone_tag | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ZoneTag: Zone label. |
attr_zone_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ZoneType: Zone type. |
props | ZoneProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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_arnRequired
attr_arn: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attr_zone_idRequired
attr_zone_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ZoneId: Zone ID.
attr_zone_nameRequired
attr_zone_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ZoneName: Zone name.
attr_zone_tagRequired
attr_zone_tag: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ZoneTag: Zone label.
attr_zone_typeRequired
attr_zone_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ZoneType: Zone type.
propsRequired
props: ZoneProps
- Type: ZoneProps