Instances

• Implements: com.aliyun.ros.cdk.redis.datasource.IInstances

This class encapsulates and extends the ROS resource type DATASOURCE::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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

architectureType^Optional

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

chargeType^Optional

• 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

editionType^Optional

• 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)

engineVersion^Optional

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

expired^Optional

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

globalInstance^Optional

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

instanceClass^Optional

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

Property instanceClass: The instance type.

instanceIds^Optional

• 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 (,).

instanceStatus^Optional

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

instanceType^Optional

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

Property instanceType: The category of the instance.

Valid values: Tair Redis Memcache

networkType^Optional

• 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)

privateIp^Optional

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

Property privateIp: The private IP address of the instance.

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.

resourceGroupId^Optional

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

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

searchKey^Optional

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

vpcId^Optional

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

Property vpcId: The ID of the VPC.

vSwitchId^Optional

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

Property vSwitchId: The ID of the VSwitch.

zoneId^Optional

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

Property zoneId: The zone ID of the instance.

Methods

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

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)

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

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

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 java.lang.Object getAttrInstanceIds();

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

Attribute InstanceIds: The list of The Redis instance Ids.

attrInstances^Required

public java.lang.Object getAttrInstances();

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

Attribute Instances: The list of The Redis instances.

props^Required

public InstancesProps getProps();

• Type: InstancesProps