Skip to content

Instances

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

Initializers 

import com.aliyun.ros.cdk.redis.datasource.Instances;
Instances.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .architectureType(java.lang.String)
//  .architectureType(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .editionType(java.lang.String)
//  .editionType(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .expired(java.lang.String)
//  .expired(IResolvable)
//  .globalInstance(java.lang.String)
//  .globalInstance(IResolvable)
//  .instanceClass(java.lang.String)
//  .instanceClass(IResolvable)
//  .instanceIds(java.lang.String)
//  .instanceIds(IResolvable)
//  .instanceStatus(java.lang.String)
//  .instanceStatus(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .privateIp(java.lang.String)
//  .privateIp(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.
architectureType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property architectureType: The architecture of the instance.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The billing method of the instance.
editionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property editionType: The edition 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.String OR com.aliyun.ros.cdk.core.IResolvable Property expired: Specifies whether the instance has expired.
globalInstance java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property globalInstance: Specifies whether to return the child instances of distributed instances.
instanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceClass: The instance type.
instanceIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceIds: The IDs of instances.
instanceStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceStatus: The state of the instance.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The category of the instance.
networkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property networkType: The network type of the instance.
privateIp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property privateIp: The private IP address 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.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the instance belongs.
searchKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property searchKey: The keyword used for fuzzy search.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the VSwitch.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

architectureTypeOptional

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

Property architectureType: The architecture of the instance.

Valid values: cluster: The instance is a cluster instance. standard: The instance is a standard instance. rwsplit: The instance is a read/write splitting instance.

chargeTypeOptional

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

Property chargeType: The billing method of the instance.

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

editionTypeOptional

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

Property editionType: The edition of the instance.

Valid values: Community: Community Edition Enterprise: Enhance Edition (Tair)

engineVersionOptional

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

Property engineVersion: The database engine version of the instance.

Valid values: 2.8, 4.0, and 5.0.

expiredOptional

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

Property expired: Specifies whether the instance has expired.

Valid values: true: The instance has expired. false: The instance has not expired.

globalInstanceOptional

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

Property globalInstance: Specifies whether to return the child instances of distributed instances.

Valid values: true: Only child instances are returned. false: Child instances are not returned.

instanceClassOptional

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

Property instanceClass: The instance type.

instanceIdsOptional

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

Property instanceIds: The IDs of instances.

If you specify multiple instance IDs, separate the instance IDs with commas (,).

instanceStatusOptional

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

Property instanceStatus: The state of the instance.

Valid values: Normal: The instance is normal. Creating: The instance is being created. Changing: The configurations of the instance are being changed. Inactive: The instance is disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The instance is being transformed. Unavailable: The instance is suspended. Error: The instance cannot be created. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: The minor version of the instance is being updated. NetworkModifying: The network type of the instance is being changed. SSLModifying: The SSL certificate of the instance is being changed. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains available during the upgrade.

instanceTypeOptional

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

Property instanceType: The category of the instance.

Valid values: Tair Redis Memcache

networkTypeOptional

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

Property networkType: The network type of the instance.

Valid values: CLASSIC: classic network VPC: Virtual Private Cloud (VPC)

privateIpOptional

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

Property privateIp: The private IP address of the 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.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group to which the instance belongs.

searchKeyOptional

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

Property searchKey: The keyword used for fuzzy search.

The keyword can be based on an instance name or an instance ID.

vpcIdOptional

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

Property vpcId: The ID of the VPC.

vSwitchIdOptional

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

Property vSwitchId: The ID of the VSwitch.

zoneIdOptional

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

Property zoneId: The zone ID of the instance.

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

attrInstanceIdsRequired 

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

Attribute InstanceIds: The list of The Redis instance Ids.

attrInstancesRequired 

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

Attribute Instances: The list of The Redis instances.