Skip to content

DrdsInstance

  • Implements: com.aliyun.ros.cdk.drds.datasource.IDrdsInstance

This class encapsulates and extends the ROS resource type DATASOURCE::DRDS::DrdsInstance.

Initializers

import com.aliyun.ros.cdk.drds.datasource.DrdsInstance;
DrdsInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .drdsInstanceId(java.lang.String)
    .drdsInstanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
drdsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property drdsInstanceId: The ID of the Drds 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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

drdsInstanceIdRequired

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

Property drdsInstanceId: The ID of the Drds 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.

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.

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

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)

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.datasource.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.
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.
attrCommodityCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CommodityCode: The commodity code of the service.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The timestamp that indicates when the instance is created.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the instance.
attrDrdsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DrdsInstanceId: The ID of the Drds instance.
attrExpireDate java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ExpireDate: The timestamp that indicates when the instance expires.
attrInstanceSeries java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceSeries: The edition of the instance.
attrInstanceSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceSpec: The specification of the instance.
attrInstRole java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstRole: The role of the instance.
attrLabel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Label: The tag of the instance.
attrMachineType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MachineType: The machine type of the instance.
attrMasterInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MasterInstanceId: The ID of the primary instance.
attrMysqlVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MysqlVersion: Engine version.
attrNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NetworkType: The network type of the instance.
attrOrderInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OrderInstanceId: The ID of the purchased instance.
attrReadOnlyDbInstanceIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute StorageType: The storage type of the Drds database.
attrType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Type: The type of the instance.
attrVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Version: The version of the instance.
attrVersionAction java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VersionAction: Indicates whether the version of the instance can be upgraded.
attrVips java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Vips: The list of returned virtual IP addresses (VIPs).
attrVpcCloudInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.
attrZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: The ID of the zone in which the resource is located.
props DrdsInstanceProps 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

attrCommodityCodeRequired

public java.lang.Object getAttrCommodityCode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommodityCode: The commodity code of the service.


attrCreateTimeRequired

public java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The timestamp that indicates when the instance is created.


attrDescriptionRequired

public java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the instance.


attrDrdsInstanceIdRequired

public java.lang.Object getAttrDrdsInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DrdsInstanceId: The ID of the Drds instance.


attrExpireDateRequired

public java.lang.Object getAttrExpireDate();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ExpireDate: The timestamp that indicates when the instance expires.


attrInstanceSeriesRequired

public java.lang.Object getAttrInstanceSeries();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceSeries: The edition of the instance.

Valid values: starter: Starter Edition enterprise: Enterprise Edition standard: Standard Edition


attrInstanceSpecRequired

public java.lang.Object getAttrInstanceSpec();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceSpec: The specification of the instance.


attrInstRoleRequired

public java.lang.Object getAttrInstRole();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstRole: The role of the instance.

Valid values: MASTER: The instance is a primary instance. SLAVE: The instance is a read-only instance to analyze complex queries. SLAVE_FLOW: The instance is a read-only instance for high-concurrency scenarios.


attrLabelRequired

public java.lang.Object getAttrLabel();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Label: The tag of the instance.

Valid values: NORMAL: The instance is a standard instance. HA: The instance is a high-availability (HA) instance. VPC: The instance is a VPC-based instance.


attrMachineTypeRequired

public java.lang.Object getAttrMachineType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MachineType: The machine type of the instance.

Valid value: ecs.


attrMasterInstanceIdRequired

public java.lang.Object getAttrMasterInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MasterInstanceId: The ID of the primary instance.


attrMysqlVersionRequired

public java.lang.Object getAttrMysqlVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MysqlVersion: Engine version.


attrNetworkTypeRequired

public java.lang.Object getAttrNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkType: The network type of the instance.

Valid values: CLASSIC VPC


attrOrderInstanceIdRequired

public java.lang.Object getAttrOrderInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OrderInstanceId: The ID of the purchased instance.


attrReadOnlyDbInstanceIdsRequired

public java.lang.Object getAttrReadOnlyDbInstanceIds();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.


attrStorageTypeRequired

public java.lang.Object getAttrStorageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StorageType: The storage type of the Drds database.

Valid values: RDS PolarDB


attrTypeRequired

public java.lang.Object getAttrType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Type: The type of the instance.

Valid values: PUBLIC: The returned instance is a shared instance. PRIVATE: The returned instance is a dedicated instance.


attrVersionRequired

public java.lang.Object getAttrVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Version: The version of the instance.


attrVersionActionRequired

public java.lang.Object getAttrVersionAction();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VersionAction: Indicates whether the version of the instance can be upgraded.


attrVipsRequired

public java.lang.Object getAttrVips();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Vips: The list of returned virtual IP addresses (VIPs).


attrVpcCloudInstanceIdRequired

public java.lang.Object getAttrVpcCloudInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.


attrZoneIdRequired

public java.lang.Object getAttrZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: The ID of the zone in which the resource is located.


propsRequired

public DrdsInstanceProps getProps();