Skip to content

DrdsInstance

This class encapsulates and extends the ROS resource type ALIYUN::DRDS::DrdsInstance, which is used to create a Distributed Relational Database Service (DRDS) instance of specific specifications.

Initializers 

import com.aliyun.ros.cdk.drds.DrdsInstance;
DrdsInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .description(java.lang.String)
    .description(IResolvable)
    .instanceSeries(java.lang.String)
    .instanceSeries(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .specification(java.lang.String)
    .specification(IResolvable)
    .type(java.lang.String)
    .type(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .isAutoRenew(java.lang.Boolean)
//  .isAutoRenew(IResolvable)
//  .mySqlVersion(java.lang.String)
//  .mySqlVersion(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vswitchId(java.lang.String)
//  .vswitchId(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.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the DRDS instance, 2-128 characters.
instanceSeries java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceSeries: drds.sn1.4c8g Starter Edition; drds.sn1.8c16g Standard Edition; drds.sn1.16c32g Business Edition; drds.sn1.32c64g Ultimate Edition.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: For the type of payment, see "Payment Type Parameter Table".
specification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property specification: The example specification, for example, drds.sn1.4c8g.8C16G, consists of the DRDS instance series (drds.sn1.4c8g) plus a specific example specification (8C16G). For the DRDS instance specification value range, see: Distributed Relational Database Service Specifications and Pricing.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: Instance type, instance type 0 - shared instance 1 - exclusive instance, in addition, this parameter can also pass PRIVATE and PUBLIC to represent exclusive instance and shared instance respectively.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: Availability zone, an available zone belongs to a certain zone, such as Hangzhou Availability Zone A (cn-hangzhou-a) belongs to the region Hangzhou (cn-hangzhou).
duration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property duration: The number of cycles ordered.
isAutoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isAutoRenew: Whether to renew the fee automatically, if it is purchased on a monthly basis, it will automatically renew for one month, and if it is purchased on an annual basis, it will automatically renew for one year.
mySqlVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property mySqlVersion: The MySQL protocol version supported by DRDS.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pricingCycle: The unit of the order period, year: year, month: month.
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.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: Virtual private network ID, must be specified when creating a DRDS for VPC network type.
vswitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vswitchId: Virtual switch ID, must be specified when creating a DRDS for VPC network type.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

descriptionRequired

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

Property description: Description of the DRDS instance, 2-128 characters.

instanceSeriesRequired

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

Property instanceSeries: drds.sn1.4c8g Starter Edition; drds.sn1.8c16g Standard Edition; drds.sn1.16c32g Business Edition; drds.sn1.32c64g Ultimate Edition.

payTypeRequired

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

Property payType: For the type of payment, see "Payment Type Parameter Table".

specificationRequired

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

Property specification: The example specification, for example, drds.sn1.4c8g.8C16G, consists of the DRDS instance series (drds.sn1.4c8g) plus a specific example specification (8C16G). For the DRDS instance specification value range, see: Distributed Relational Database Service Specifications and Pricing.

typeRequired

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

Property type: Instance type, instance type 0 - shared instance 1 - exclusive instance, in addition, this parameter can also pass PRIVATE and PUBLIC to represent exclusive instance and shared instance respectively.

zoneIdRequired

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

Property zoneId: Availability zone, an available zone belongs to a certain zone, such as Hangzhou Availability Zone A (cn-hangzhou-a) belongs to the region Hangzhou (cn-hangzhou).

durationOptional

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

Property duration: The number of cycles ordered.

When PricingCycle=year, the value is 1-3; when PricingCycle=month, the value is 1-9. The parameter takes effect when the payment type is drdsPre.

isAutoRenewOptional

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

Property isAutoRenew: Whether to renew the fee automatically, if it is purchased on a monthly basis, it will automatically renew for one month, and if it is purchased on an annual basis, it will automatically renew for one year.

The parameter takes effect when the payment type is drdsPre.

mySqlVersionOptional

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

Property mySqlVersion: The MySQL protocol version supported by DRDS.

Valid values: 5 and 8. Default value: 5. This parameter is valid only when the primary instance is created. The read-only instance is the same as the primary instance by default.

pricingCycleOptional

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

Property pricingCycle: The unit of the order period, year: year, month: month.

The parameter takes effect when the payment type is drdsPre.

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.

vpcIdOptional

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

Property vpcId: Virtual private network ID, must be specified when creating a DRDS for VPC network type.

vswitchIdOptional

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

Property vswitchId: Virtual switch ID, must be specified when creating a DRDS for VPC network type.

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.drds.DrdsInstance;
DrdsInstance.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.
attrDrdsInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DrdsInstanceId: instance id.
attrInternetEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute InternetEndpoint: Public endpoint.
attrIntranetEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute IntranetEndpoint: VPC endpoint.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: order number.

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

attrDrdsInstanceIdRequired 

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

Attribute DrdsInstanceId: instance id.

attrInternetEndpointRequired 

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

Attribute InternetEndpoint: Public endpoint.

attrIntranetEndpointRequired 

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

Attribute IntranetEndpoint: VPC endpoint.

attrOrderIdRequired 

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

Attribute OrderId: order number.