Instances

This class encapsulates and extends the ROS resource type DATASOURCE::MONGODB::Instances, which is used to query the information about ApsaraDB for MongoDB instances.

Initializers

import com.aliyun.ros.cdk.mongodb.datasource.Instances;
Instances.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .connectionDomain(java.lang.String)
//  .connectionDomain(IResolvable)
//  .dbInstanceClass(java.lang.String)
//  .dbInstanceClass(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceId(java.lang.String)
//  .dbInstanceId(IResolvable)
//  .dbInstanceStatus(java.lang.String)
//  .dbInstanceStatus(IResolvable)
//  .dbInstanceType(java.lang.String)
//  .dbInstanceType(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .expired(java.lang.Boolean)
//  .expired(IResolvable)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .replicationFactor(java.lang.String)
//  .replicationFactor(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .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.
`chargeType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property chargeType: The billing method of the instance.
`connectionDomain`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property connectionDomain: The endpoint of the node.
`dbInstanceClass`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dbInstanceClass: The instance type.
`dbInstanceDescription`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dbInstanceDescription: The description of the instance.
`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 state of the instance.
`dbInstanceType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dbInstanceType: The category of the instance.
`engineVersion`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property engineVersion: The database engine version of the instance.
`expired`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property expired: Specifies whether the instance expires.
`networkType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property networkType: The network type of 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.
`replicationFactor`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property replicationFactor: The number of nodes in a replica set instance.
`resourceGroupId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property resourceGroupId: The ID of the resource group.
`tags`	`java.util.List`	Property tags: Tags of instance.
`vpcId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vpcId: The VPC ID of the instance.
`vSwitchId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vSwitchId: The vSwitch ID of the instance.
`zoneId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property zoneId: The zone ID of the instance.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`chargeType`^Optional

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

Property chargeType: The billing method of the instance.

Valid values: PostPaid: pay-as-you-go PrePaid: subscription

`connectionDomain`^Optional

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

Property connectionDomain: The endpoint of the node.

You can call the DescribeDBInstanceAttribute operation to query the endpoint of the node.

`dbInstanceClass`^Optional

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

Property dbInstanceClass: The instance type.

For more information about valid values, see Instance types.

`dbInstanceDescription`^Optional

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

Property dbInstanceDescription: The description of the instance.

`dbInstanceId`^Optional

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

Property dbInstanceId: The ID of the instance.

`dbInstanceStatus`^Optional

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

Property dbInstanceStatus: The state of the instance.

For more information about valid values, see Instance states.

`dbInstanceType`^Optional

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

Property dbInstanceType: The category of the instance.

Default value: replicate. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance Note To query the list of sharded cluster instances, you must set the parameter to sharding. This operation displays the list of replica set and standalone instances when the parameter uses the default value replicate.

`engineVersion`^Optional

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

Property engineVersion: The database engine version of the instance.

Valid values: 5.0 4.4 4.2 4.0 3.4

`expired`^Optional

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

Property expired: Specifies whether the instance expires.

Valid values: true: The instance expires. false: The instance does not expire.

`networkType`^Optional

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

Property networkType: The network type of the instance.

Valid values: Classic Vpc

`refreshOptions`^Optional

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.

`replicationFactor`^Optional

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

Property replicationFactor: The number of nodes in a replica set instance.

Valid values: 3, 5, and 7.

`resourceGroupId`^Optional

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

Property resourceGroupId: The ID of the resource group.

`tags`^Optional

Type: java.util.List

Property tags: Tags of instance.

`vpcId`^Optional

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

Property vpcId: The VPC ID of the instance.

`vSwitchId`^Optional

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

Property vSwitchId: The vSwitch ID of the instance.

`zoneId`^Optional

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

Property zoneId: The zone ID of the instance.

You can call the DescribeRegions operation to query the most recent zone list.

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.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

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

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

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

`isConstruct`

import com.aliyun.ros.cdk.mongodb.datasource.Instances;
Instances.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

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.
`attrInstanceIds`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute InstanceIds: The list of The instance Ids.
`attrInstances`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Instances: The list of The instances.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrInstanceIds`^Required

public IResolvable getAttrInstanceIds();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceIds: The list of The instance Ids.

`attrInstances`^Required

public IResolvable getAttrInstances();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Instances: The list of The instances.

Instances

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

chargeTypeOptional

connectionDomainOptional

dbInstanceClassOptional

dbInstanceDescriptionOptional

dbInstanceIdOptional

dbInstanceStatusOptional

dbInstanceTypeOptional

engineVersionOptional

expiredOptional

networkTypeOptional

refreshOptionsOptional

replicationFactorOptional

resourceGroupIdOptional

tagsOptional

vpcIdOptional

vSwitchIdOptional

zoneIdOptional