Zone
- Implements: IZone
This class encapsulates and extends the ROS resource type ALIYUN::PVTZ::Zone.
Initializers
import com.aliyun.ros.cdk.pvtz.Zone;
Zone.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.zoneName(java.lang.String)
.zoneName(IResolvable)
// .dnsGroup(java.lang.String)
// .dnsGroup(IResolvable)
// .ignoredStackTagKeys(IResolvable)
// .ignoredStackTagKeys(java.util.List<java.lang.String)
// .ignoredStackTagKeys(IResolvable>)
// .proxyPattern(java.lang.String)
// .proxyPattern(IResolvable)
// .remark(java.lang.String)
// .remark(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .tags(java.util.List<TagsProperty>)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
zoneName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property zoneName: Zone name. |
dnsGroup | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dnsGroup: The location of the built-in authoritative zone. |
ignoredStackTagKeys | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property ignoredStackTagKeys: Stack tag keys to ignore. |
proxyPattern | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property proxyPattern: Specifies whether to enable subdomain recursive proxy. |
remark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property remark: 50 characters at most. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: Resource group id. |
tags | java.util.List<TagsProperty> | Property tags: Tags to attach to instance. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
zoneNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property zoneName: Zone name.
dnsGroupOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dnsGroup: The location of the built-in authoritative zone.
Valid values:
- NORMAL_ZONE: Standard zone. DNS responses are cached. If a cache miss occurs, the query is sent to the built-in authoritative standard zone. The time to live (TTL) value affects the time when a DNS record change takes effect. You cannot use custom DNS lines or weighted round-robin.
- FAST_ZONE: Accelerated zone (recommended). DNS queries are directly responded to with the lowest latency. DNS record changes take effect in real time. You can use custom DNS lines and weighted round-robin. Default value: NORMAL_ZONE.
The built-in authoritative accelerated zone is located before the cache module. DNS responses are not cached. This may increase the number of DNS queries and your costs. Starting from April 30, 2025 (UTC+8), when new users activate Cloud DNS PrivateZone, added zones are set as accelerated zones by default.
ignoredStackTagKeysOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property ignoredStackTagKeys: Stack tag keys to ignore.
proxyPatternOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property proxyPattern: Specifies whether to enable subdomain recursive proxy.
Valid values:
- ZONE: Disables the feature. If a DNS query for a subdomain that does not exist under the current domain name is received, an NXDOMAIN error is returned.
- RECORD: Enables the feature. If a DNS query for a subdomain that does not exist under the current domain name is received, the query is processed by the forwarding and recursion modules in sequence. The final result is used to respond to the DNS query. Default value: ZONE.
remarkOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: 50 characters at most.
It can only contain numbers, Chinese, English and special characters: "_-,.,。".
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Resource group id.
tagsOptional
- Type: java.util.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.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.pvtz.Zone;
Zone.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrArn | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Arn: The Alibaba Cloud Resource Name (ARN). |
attrZoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneId: Zone ID. |
attrZoneName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneName: Zone name. |
attrZoneTag | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneTag: Zone label. |
attrZoneType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneType: Zone type. |
props | ZoneProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrArnRequired
public java.lang.Object getAttrArn();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attrZoneIdRequired
public java.lang.Object getAttrZoneId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneId: Zone ID.
attrZoneNameRequired
public java.lang.Object getAttrZoneName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneName: Zone name.
attrZoneTagRequired
public java.lang.Object getAttrZoneTag();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneTag: Zone label.
attrZoneTypeRequired
public java.lang.Object getAttrZoneType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneType: Zone type.
propsRequired
public ZoneProps getProps();
- Type: ZoneProps