Skip to content

Zone

This class encapsulates and extends the ROS resource type ALIYUN::PVTZ::Zone, which is used to create a private 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)
//  .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>)
//  .zoneTag(java.lang.String)
//  .zoneTag(IResolvable)
//  .zoneType(java.lang.String)
//  .zoneType(IResolvable)
    .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.
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: ZONE: completely hijack the entire zone.
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.
zoneTag java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneTag: Zone label.
zoneType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneType: Zone type.

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.

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: ZONE: completely hijack the entire zone.

RECORD: Incomplete hijacking, recursive resolution agent. Default to 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

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.

zoneTagOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneTag: Zone label.

It will be ignored when ZoneType is AUTH_ZONE.

zoneTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneType: Zone type.

For instance: AUTH_ZONE, CLOUD_PRODUCT_ZONE.

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

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
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.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: Zone ID.
attrZoneName com.aliyun.ros.cdk.core.IResolvable Attribute ZoneName: Zone name.
attrZoneTag com.aliyun.ros.cdk.core.IResolvable Attribute ZoneTag: Zone label.
attrZoneType com.aliyun.ros.cdk.core.IResolvable Attribute ZoneType: Zone type.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrZoneIdRequired 

public IResolvable getAttrZoneId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: Zone ID.

attrZoneNameRequired 

public IResolvable getAttrZoneName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneName: Zone name.

attrZoneTagRequired 

public IResolvable getAttrZoneTag();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneTag: Zone label.

attrZoneTypeRequired 

public IResolvable getAttrZoneType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneType: Zone type.