Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::REDIS::Instance, which is used to query the information about a Tair (Redis OSS-compatible) instance.

Initializers 

import com.aliyun.ros.cdk.redis.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: Database instance id.
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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbInstanceIdRequired

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

Property dbInstanceId: Database instance id.

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.

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.Instance;
Instance.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.
attrArchitectureType com.aliyun.ros.cdk.core.IResolvable Attribute ArchitectureType: Architecture type.
attrBandwidth com.aliyun.ros.cdk.core.IResolvable Attribute Bandwidth: Bandwidth.
attrCapacity com.aliyun.ros.cdk.core.IResolvable Attribute Capacity: Capacity.
attrCloudType com.aliyun.ros.cdk.core.IResolvable Attribute CloudType: Cloud category.
attrConfig com.aliyun.ros.cdk.core.IResolvable Attribute Config: Config.
attrConnectionDomain com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionDomain: Connection domain.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Create time.
attrDbInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceId: Database instance id.
attrDbInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceName: Instance name.
attrEndTime com.aliyun.ros.cdk.core.IResolvable Attribute EndTime: End time.
attrEngineVersion com.aliyun.ros.cdk.core.IResolvable Attribute EngineVersion: Engine version.
attrHasRenewChangeOrder com.aliyun.ros.cdk.core.IResolvable Attribute HasRenewChangeOrder: Has renew change order.
attrInstanceClass com.aliyun.ros.cdk.core.IResolvable Attribute InstanceClass: Instance class.
attrInstanceReleaseProtection com.aliyun.ros.cdk.core.IResolvable Attribute InstanceReleaseProtection: Instance release protection.
attrInstanceType com.aliyun.ros.cdk.core.IResolvable Attribute InstanceType: Instance type.
attrIsRds com.aliyun.ros.cdk.core.IResolvable Attribute IsRds: is RDS.
attrMaintainEndTime com.aliyun.ros.cdk.core.IResolvable Attribute MaintainEndTime: Maintain end time.
attrMaintainStartTime com.aliyun.ros.cdk.core.IResolvable Attribute MaintainStartTime: Maintain start time.
attrNetworkType com.aliyun.ros.cdk.core.IResolvable Attribute NetworkType: Network type.
attrPackageType com.aliyun.ros.cdk.core.IResolvable Attribute PackageType: Package type.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: Payment type.
attrPort com.aliyun.ros.cdk.core.IResolvable Attribute Port: Port.
attrPrivateIp com.aliyun.ros.cdk.core.IResolvable Attribute PrivateIp: Private IP.
attrQps com.aliyun.ros.cdk.core.IResolvable Attribute Qps: QPS.
attrReadOnlyCount com.aliyun.ros.cdk.core.IResolvable Attribute ReadOnlyCount: The number of read-only nodes.
attrReplacateId com.aliyun.ros.cdk.core.IResolvable Attribute ReplacateId: Replacate id.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: Resource group id.
attrSecondaryZoneId com.aliyun.ros.cdk.core.IResolvable Attribute SecondaryZoneId: The ID of the standby zone.
attrSecurityGroupId com.aliyun.ros.cdk.core.IResolvable Attribute SecurityGroupId: Security group id.
attrSecurityIpGroupAttribute com.aliyun.ros.cdk.core.IResolvable Attribute SecurityIpGroupAttribute: Security IP group attribute.
attrSecurityIpGroupName com.aliyun.ros.cdk.core.IResolvable Attribute SecurityIpGroupName: Security IP group name.
attrSecurityIps com.aliyun.ros.cdk.core.IResolvable Attribute SecurityIps: Security IPs.
attrShardCount com.aliyun.ros.cdk.core.IResolvable Attribute ShardCount: The number of slices.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: Tags.
attrVpcAuthMode com.aliyun.ros.cdk.core.IResolvable Attribute VpcAuthMode: Vpc auth mode.
attrVpcCloudInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute VpcCloudInstanceId: Vpc cloud instance id.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: Vpc id.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: Vswitch id.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: Zone id.

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

attrArchitectureTypeRequired 

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

Attribute ArchitectureType: Architecture type.

attrBandwidthRequired 

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

Attribute Bandwidth: Bandwidth.

attrCapacityRequired 

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

Attribute Capacity: Capacity.

attrCloudTypeRequired 

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

Attribute CloudType: Cloud category.

attrConfigRequired 

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

Attribute Config: Config.

attrConnectionDomainRequired 

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

Attribute ConnectionDomain: Connection domain.

attrCreateTimeRequired 

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

Attribute CreateTime: Create time.

attrDbInstanceIdRequired 

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

Attribute DBInstanceId: Database instance id.

attrDbInstanceNameRequired 

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

Attribute DBInstanceName: Instance name.

attrEndTimeRequired 

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

Attribute EndTime: End time.

attrEngineVersionRequired 

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

Attribute EngineVersion: Engine version.

attrHasRenewChangeOrderRequired 

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

Attribute HasRenewChangeOrder: Has renew change order.

attrInstanceClassRequired 

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

Attribute InstanceClass: Instance class.

attrInstanceReleaseProtectionRequired 

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

Attribute InstanceReleaseProtection: Instance release protection.

attrInstanceTypeRequired 

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

Attribute InstanceType: Instance type.

attrIsRdsRequired 

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

Attribute IsRds: is RDS.

attrMaintainEndTimeRequired 

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

Attribute MaintainEndTime: Maintain end time.

attrMaintainStartTimeRequired 

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

Attribute MaintainStartTime: Maintain start time.

attrNetworkTypeRequired 

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

Attribute NetworkType: Network type.

attrPackageTypeRequired 

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

Attribute PackageType: Package type.

attrPaymentTypeRequired 

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

Attribute PaymentType: Payment type.

attrPortRequired 

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

Attribute Port: Port.

attrPrivateIpRequired 

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

Attribute PrivateIp: Private IP.

attrQpsRequired 

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

Attribute Qps: QPS.

attrReadOnlyCountRequired 

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

Attribute ReadOnlyCount: The number of read-only nodes.

This parameter is only applicable to the creation of read-write splitting instances in the cloud disk version. You can use this parameter to customize the number of read-only nodes. Valid values: 1 to 5.

attrReplacateIdRequired 

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

Attribute ReplacateId: Replacate id.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: Resource group id.

attrSecondaryZoneIdRequired 

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

Attribute SecondaryZoneId: The ID of the standby zone.

attrSecurityGroupIdRequired 

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

Attribute SecurityGroupId: Security group id.

attrSecurityIpGroupAttributeRequired 

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

Attribute SecurityIpGroupAttribute: Security IP group attribute.

attrSecurityIpGroupNameRequired 

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

Attribute SecurityIpGroupName: Security IP group name.

attrSecurityIpsRequired 

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

Attribute SecurityIps: Security IPs.

attrShardCountRequired 

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

Attribute ShardCount: The number of slices.

This parameter is only applicable to creating a cloud disk cluster architecture instance. You can use this parameter to customize the number of slices.

attrTagsRequired 

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

Attribute Tags: Tags.

attrVpcAuthModeRequired 

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

Attribute VpcAuthMode: Vpc auth mode.

attrVpcCloudInstanceIdRequired 

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

Attribute VpcCloudInstanceId: Vpc cloud instance id.

attrVpcIdRequired 

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

Attribute VpcId: Vpc id.

attrVSwitchIdRequired 

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

Attribute VSwitchId: Vswitch id.

attrZoneIdRequired 

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

Attribute ZoneId: Zone id.