Skip to content

DBInstances

This class encapsulates and extends the ROS resource type DATASOURCE::RDS::DBInstances, which is used to query ApsaraDB RDS instances.

Initializers 

import com.aliyun.ros.cdk.rds.datasource.DBInstances;
DBInstances.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .connectionMode(java.lang.String)
//  .connectionMode(IResolvable)
//  .connectionString(java.lang.String)
//  .connectionString(IResolvable)
//  .dbInstanceClass(java.lang.String)
//  .dbInstanceClass(IResolvable)
//  .dbInstanceId(java.lang.String)
//  .dbInstanceId(IResolvable)
//  .dbInstanceStatus(java.lang.String)
//  .dbInstanceStatus(IResolvable)
//  .dbInstanceType(java.lang.String)
//  .dbInstanceType(IResolvable)
//  .dedicatedHostGroupId(java.lang.String)
//  .dedicatedHostGroupId(IResolvable)
//  .dedicatedHostId(java.lang.String)
//  .dedicatedHostId(IResolvable)
//  .engine(java.lang.String)
//  .engine(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .expired(java.lang.String)
//  .expired(IResolvable)
//  .instanceLevel(java.lang.Number)
//  .instanceLevel(IResolvable)
//  .instanceNetworkType(java.lang.String)
//  .instanceNetworkType(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .proxyId(java.lang.String)
//  .proxyId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .searchKey(java.lang.String)
//  .searchKey(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(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.
connectionMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionMode: The connection mode of the instance.
connectionString java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionString: The endpoint of the instance.
dbInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceClass: The instance type of the instances.
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: The ID of the instance.
dbInstanceStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStatus: The status of the instances.
dbInstanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceType: The role of the instances.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostGroupId: The ID of the dedicated cluster to which the instances belong.
dedicatedHostId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostId: The ID of the host to which the instances belong in the specified dedicated cluster.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engine: The database engine that is run by the instances.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: The version of the database engine that is run by the instances.
expired java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property expired: Specifies whether the instances have expired.
instanceLevel java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property instanceLevel: Specifies whether to return the RDS editions of the instances by using the Category parameter.
instanceNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceNetworkType: The network type of the instances.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the instances.
proxyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property proxyId: The ID of the proxy mode.
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.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the instances belong.
searchKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property searchKey: The keywords that are contained in the IDs or descriptions of the instances.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC) to which the instances belong.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the vSwitch that is associated with the specified VPC.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone to which the instances belong.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

connectionModeOptional

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

Property connectionMode: The connection mode of the instance.

connectionStringOptional

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

Property connectionString: The endpoint of the instance.

dbInstanceClassOptional

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

Property dbInstanceClass: The instance type of the instances.

dbInstanceIdOptional

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

Property dbInstanceId: The ID of the instance.

dbInstanceStatusOptional

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

Property dbInstanceStatus: The status of the instances.

dbInstanceTypeOptional

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

Property dbInstanceType: The role of the instances.

dedicatedHostGroupIdOptional

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

Property dedicatedHostGroupId: The ID of the dedicated cluster to which the instances belong.

dedicatedHostIdOptional

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

Property dedicatedHostId: The ID of the host to which the instances belong in the specified dedicated cluster.

engineOptional

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

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

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

expiredOptional

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

Property expired: Specifies whether the instances have expired.

instanceLevelOptional

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

Property instanceLevel: Specifies whether to return the RDS editions of the instances by using the Category parameter.

instanceNetworkTypeOptional

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

Property instanceNetworkType: The network type of the instances.

payTypeOptional

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

Property payType: The billing method of the instances.

proxyIdOptional

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

Property proxyId: The ID of the proxy mode.

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.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group to which the instances belong.

searchKeyOptional

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

Property searchKey: The keywords that are contained in the IDs or descriptions of the instances.

vpcIdOptional

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

Property vpcId: The ID of the virtual private cloud (VPC) to which the instances belong.

vSwitchIdOptional

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

Property vSwitchId: The ID of the vSwitch that is associated with the specified VPC.

zoneIdOptional

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

Property zoneId: The ID of the zone to which the instances belong.

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.DBInstances;
DBInstances.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.
attrDbInstanceIds com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceIds: The list of The RDS Database instance Ids.
attrDbInstances com.aliyun.ros.cdk.core.IResolvable Attribute DBInstances: The list of The RDS Database instances.

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

attrDbInstanceIdsRequired 

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

Attribute DBInstanceIds: The list of The RDS Database instance Ids.

attrDbInstancesRequired 

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

Attribute DBInstances: The list of The RDS Database instances.