Skip to content

Zones

This class encapsulates and extends the ROS resource type DATASOURCE::RDS::Zones, which is used to query the zones that are available to an ApsaraDB RDS instance.

Initializers 

import com.aliyun.ros.cdk.rds.datasource.Zones;
Zones.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .engine(java.lang.String)
    .engine(IResolvable)
//  .category(java.lang.String)
//  .category(IResolvable)
//  .commodityCode(java.lang.String)
//  .commodityCode(IResolvable)
//  .dispenseMode(java.lang.String)
//  .dispenseMode(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(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.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engine: The database engine that is run by the instance.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The RDS edition of the instance.
commodityCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property commodityCode: The commodity code of the instance.
dispenseMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dispenseMode: Specifies whether to return the zones in which the single-zone deployment method is supported.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: The version of the database engine that is run by the instance.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone in which the instance is located.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

engineRequired

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

Property engine: The database engine that is run by the instance.

categoryOptional

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

Property category: The RDS edition of the instance.

Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition Finance: RDS Enterprise Edition

commodityCodeOptional

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

Property commodityCode: The commodity code of the instance.

dispenseModeOptional

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

Property dispenseMode: Specifies whether to return the zones in which the single-zone deployment method is supported.

Valid values: 1: returns the zones. 0: does not return the zones. Default value: 0.

engineVersionOptional

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

Property engineVersion: The version of the database engine that is run by the instance.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

zoneIdOptional

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

Property zoneId: The ID of the zone in which the instance is located.

If the instance spans more than one zone, the value of this parameter contains an MAZ part,such as cn-hangzhou-MAZ6(b,f) and cn-hangzhou-MAZ5(b,e,f)

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.rds.datasource.Zones;
Zones.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.
attrZoneIds com.aliyun.ros.cdk.core.IResolvable Attribute ZoneIds: The list of zone IDs.
attrZones com.aliyun.ros.cdk.core.IResolvable Attribute Zones: The list of The Zones.

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

attrZoneIdsRequired 

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

Attribute ZoneIds: The list of zone IDs.

attrZonesRequired 

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

Attribute Zones: The list of The Zones.

Structs