Skip to content

Instance

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

This class encapsulates and extends the ROS resource type DATASOURCE::REDIS::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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


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 java.lang.Object getAttrArchitectureType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ArchitectureType: Architecture type.


attrBandwidthRequired

public java.lang.Object getAttrBandwidth();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Bandwidth: Bandwidth.


attrCapacityRequired

public java.lang.Object getAttrCapacity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Capacity: Capacity.


attrCloudTypeRequired

public java.lang.Object getAttrCloudType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CloudType: Cloud category.


attrConfigRequired

public java.lang.Object getAttrConfig();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Config: Config.


attrConnectionDomainRequired

public java.lang.Object getAttrConnectionDomain();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionDomain: Connection domain.


attrCreateTimeRequired

public java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: Create time.


attrDbInstanceIdRequired

public java.lang.Object getAttrDbInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceId: Database instance id.


attrDbInstanceNameRequired

public java.lang.Object getAttrDbInstanceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceName: Instance name.


attrEndTimeRequired

public java.lang.Object getAttrEndTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EndTime: End time.


attrEngineVersionRequired

public java.lang.Object getAttrEngineVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EngineVersion: Engine version.


attrHasRenewChangeOrderRequired

public java.lang.Object getAttrHasRenewChangeOrder();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HasRenewChangeOrder: Has renew change order.


attrInstanceClassRequired

public java.lang.Object getAttrInstanceClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceClass: Instance class.


attrInstanceReleaseProtectionRequired

public java.lang.Object getAttrInstanceReleaseProtection();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceReleaseProtection: Instance release protection.


attrInstanceTypeRequired

public java.lang.Object getAttrInstanceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceType: Instance type.


attrIsRdsRequired

public java.lang.Object getAttrIsRds();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IsRds: is RDS.


attrMaintainEndTimeRequired

public java.lang.Object getAttrMaintainEndTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MaintainEndTime: Maintain end time.


attrMaintainStartTimeRequired

public java.lang.Object getAttrMaintainStartTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MaintainStartTime: Maintain start time.


attrNetworkTypeRequired

public java.lang.Object getAttrNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkType: Network type.


attrPackageTypeRequired

public java.lang.Object getAttrPackageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PackageType: Package type.


attrPaymentTypeRequired

public java.lang.Object getAttrPaymentType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: Payment type.


attrPortRequired

public java.lang.Object getAttrPort();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Port: Port.


attrPrivateIpRequired

public java.lang.Object getAttrPrivateIp();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrivateIp: Private IP.


attrQpsRequired

public java.lang.Object getAttrQps();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Qps: QPS.


attrReadOnlyCountRequired

public java.lang.Object getAttrReadOnlyCount();
  • Type: java.lang.String OR 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 java.lang.Object getAttrReplacateId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReplacateId: Replacate id.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: Resource group id.


attrSecondaryZoneIdRequired

public java.lang.Object getAttrSecondaryZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecondaryZoneId: The ID of the standby zone.


attrSecurityGroupIdRequired

public java.lang.Object getAttrSecurityGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityGroupId: Security group id.


attrSecurityIpGroupAttributeRequired

public java.lang.Object getAttrSecurityIpGroupAttribute();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityIpGroupAttribute: Security IP group attribute.


attrSecurityIpGroupNameRequired

public java.lang.Object getAttrSecurityIpGroupName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityIpGroupName: Security IP group name.


attrSecurityIpsRequired

public java.lang.Object getAttrSecurityIps();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityIps: Security IPs.


attrShardCountRequired

public java.lang.Object getAttrShardCount();
  • Type: java.lang.String OR 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 java.lang.Object getAttrTags();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: Tags.


attrVpcAuthModeRequired

public java.lang.Object getAttrVpcAuthMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcAuthMode: Vpc auth mode.


attrVpcCloudInstanceIdRequired

public java.lang.Object getAttrVpcCloudInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcCloudInstanceId: Vpc cloud instance id.


attrVpcIdRequired

public java.lang.Object getAttrVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: Vpc id.


attrVSwitchIdRequired

public java.lang.Object getAttrVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: Vswitch id.


attrZoneIdRequired

public java.lang.Object getAttrZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: Zone id.


propsRequired

public InstanceProps getProps();