Skip to content

DrdsInstance

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-drds'
new datasource.DrdsInstance(scope: Construct, id: string, props: DrdsInstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DrdsInstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import { datasource } from '@alicloud/ros-cdk-drds'
datasource.DrdsInstance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrCommodityCode @alicloud/ros-cdk-core.IResolvable Attribute CommodityCode: The commodity code of the service.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The timestamp that indicates when the instance is created.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the instance.
attrDrdsInstanceId @alicloud/ros-cdk-core.IResolvable Attribute DrdsInstanceId: The ID of the Drds instance.
attrExpireDate @alicloud/ros-cdk-core.IResolvable Attribute ExpireDate: The timestamp that indicates when the instance expires.
attrInstanceSeries @alicloud/ros-cdk-core.IResolvable Attribute InstanceSeries: The edition of the instance.
attrInstanceSpec @alicloud/ros-cdk-core.IResolvable Attribute InstanceSpec: The specification of the instance.
attrInstRole @alicloud/ros-cdk-core.IResolvable Attribute InstRole: The role of the instance.
attrLabel @alicloud/ros-cdk-core.IResolvable Attribute Label: The tag of the instance.
attrMachineType @alicloud/ros-cdk-core.IResolvable Attribute MachineType: The machine type of the instance.
attrMasterInstanceId @alicloud/ros-cdk-core.IResolvable Attribute MasterInstanceId: The ID of the primary instance.
attrMysqlVersion @alicloud/ros-cdk-core.IResolvable Attribute MysqlVersion: Engine version.
attrNetworkType @alicloud/ros-cdk-core.IResolvable Attribute NetworkType: The network type of the instance.
attrOrderInstanceId @alicloud/ros-cdk-core.IResolvable Attribute OrderInstanceId: The ID of the purchased instance.
attrReadOnlyDbInstanceIds @alicloud/ros-cdk-core.IResolvable Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrStorageType @alicloud/ros-cdk-core.IResolvable Attribute StorageType: The storage type of the Drds database.
attrType @alicloud/ros-cdk-core.IResolvable Attribute Type: The type of the instance.
attrVersion @alicloud/ros-cdk-core.IResolvable Attribute Version: The version of the instance.
attrVersionAction @alicloud/ros-cdk-core.IResolvable Attribute VersionAction: Indicates whether the version of the instance can be upgraded.
attrVips @alicloud/ros-cdk-core.IResolvable Attribute Vips: The list of returned virtual IP addresses (VIPs).
attrVpcCloudInstanceId @alicloud/ros-cdk-core.IResolvable Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The ID of the zone in which the resource is located.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCommodityCodeRequired 

public readonly attrCommodityCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CommodityCode: The commodity code of the service.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the instance.

attrDrdsInstanceIdRequired 

public readonly attrDrdsInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DrdsInstanceId: The ID of the Drds instance.

attrExpireDateRequired 

public readonly attrExpireDate: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrInstanceSeriesRequired 

public readonly attrInstanceSeries: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceSeries: The edition of the instance.

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

attrInstanceSpecRequired 

public readonly attrInstanceSpec: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceSpec: The specification of the instance.

attrInstRoleRequired 

public readonly attrInstRole: IResolvable;
  • Type: @alicloud/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 readonly attrLabel: IResolvable;
  • Type: @alicloud/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 readonly attrMachineType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MachineType: The machine type of the instance.

Valid value: ecs.

attrMasterInstanceIdRequired 

public readonly attrMasterInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MasterInstanceId: The ID of the primary instance.

attrMysqlVersionRequired 

public readonly attrMysqlVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MysqlVersion: Engine version.

attrNetworkTypeRequired 

public readonly attrNetworkType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkType: The network type of the instance.

Valid values: CLASSIC VPC

attrOrderInstanceIdRequired 

public readonly attrOrderInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OrderInstanceId: The ID of the purchased instance.

attrReadOnlyDbInstanceIdsRequired 

public readonly attrReadOnlyDbInstanceIds: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrStorageTypeRequired 

public readonly attrStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageType: The storage type of the Drds database.

Valid values: RDS PolarDB

attrTypeRequired 

public readonly attrType: IResolvable;
  • Type: @alicloud/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 readonly attrVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Version: The version of the instance.

attrVersionActionRequired 

public readonly attrVersionAction: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrVipsRequired 

public readonly attrVips: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrVpcCloudInstanceIdRequired 

public readonly attrVpcCloudInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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