Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-redis-instance

Initializer 

import com.aliyun.ros.cdk.redis.InstanceProps;
InstanceProps.builder()
//  .autoRenewDuration(java.lang.Number)
//  .autoRenewDuration(IResolvable)
//  .backupPolicy(IResolvable)
//  .backupPolicy(BackupPolicyProperty)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .connections(IResolvable)
//  .connections(ConnectionsProperty)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .evictionPolicy(java.lang.String)
//  .evictionPolicy(IResolvable)
//  .instanceClass(java.lang.String)
//  .instanceClass(IResolvable)
//  .instanceMaintainTime(IResolvable)
//  .instanceMaintainTime(InstanceMaintainTimeProperty)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .nodeType(java.lang.String)
//  .nodeType(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .productType(java.lang.String)
//  .productType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .secondaryZoneId(java.lang.String)
//  .secondaryZoneId(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .shardCount(java.lang.Number)
//  .shardCount(IResolvable)
//  .sslEnabled(java.lang.String)
//  .sslEnabled(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tairConfig(IResolvable)
//  .tairConfig(TairConfigProperty)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vpcPasswordFree(java.lang.Boolean)
//  .vpcPasswordFree(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
autoRenewDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewDuration: The auto-renewal period.
backupPolicy com.aliyun.ros.cdk.core.IResolvable OR BackupPolicyProperty Property backupPolicy: Backup policy.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The billing method of the ApsaraDB for Redis instance.
connections com.aliyun.ros.cdk.core.IResolvable OR ConnectionsProperty Property connections: Connection address.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Whether destroy instance when it is in recycle.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: Engine version.
evictionPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property evictionPolicy: The eviction policy of cache data storage.
instanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceClass: Redis instance type.
instanceMaintainTime com.aliyun.ros.cdk.core.IResolvable OR InstanceMaintainTimeProperty Property instanceMaintainTime: Instance maintain time.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
nodeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nodeType: The type of node.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The password of redis instance.length 8 to 30 characters, need to contain both uppercase and lowercase letters and numbers.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The period of order, when choose Prepaid required.optional value 1-9, 12, 24, 36, 60 Unit in month.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The unit of the subscription duration.
productType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property productType: Product type.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
secondaryZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondaryZoneId: The secondary zone ID of the instance.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: The IDs of security groups.
shardCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property shardCount: The number of data nodes in the instance.
sslEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sslEnabled: Modifies the SSL status.
tags java.util.List<TagsProperty> Property tags: Tags to attach to redis.
tairConfig com.aliyun.ros.cdk.core.IResolvable OR TairConfigProperty Property tairConfig: Tair config.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC id to create ecs instance.
vpcPasswordFree java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch Id to create ecs instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone id of input region.

autoRenewDurationOptional 

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

Property autoRenewDuration: The auto-renewal period.

Valid values: 1 to 12. When the instance is about to expire, the instance is automatically renewed based on the number of months specified by this parameter. Note This parameter is valid only when ChargeType is set to PrePaid.

backupPolicyOptional 

public java.lang.Object getBackupPolicy();

Property backupPolicy: Backup policy.

chargeTypeOptional 

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

Property chargeType: The billing method of the ApsaraDB for Redis instance.

connectionsOptional 

public java.lang.Object getConnections();

Property connections: Connection address.

deletionForceOptional 

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

Property deletionForce: Whether destroy instance when it is in recycle.

Default is false

engineVersionOptional 

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

Property engineVersion: Engine version.

Supported values: 2.8, 4.0, 5.0, 6.0 and 7.0

evictionPolicyOptional 

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

Property evictionPolicy: The eviction policy of cache data storage.

instanceClassOptional 

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

Property instanceClass: Redis instance type.

Refer the Redis instance type reference, such as 'redis.master.small.default', 'redis.master.4xlarge.default', 'redis.sharding.mid.default' etc

instanceMaintainTimeOptional 

public java.lang.Object getInstanceMaintainTime();

Property instanceMaintainTime: Instance maintain time.

instanceNameOptional 

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

Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.

nodeTypeOptional 

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

Property nodeType: The type of node.

Valid value:

  • STAND_ALONE
  • MASTER_SLAVE
  • double
  • single

passwordOptional 

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

Property password: The password of redis instance.length 8 to 30 characters, need to contain both uppercase and lowercase letters and numbers.

periodOptional 

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

Property period: The period of order, when choose Prepaid required.optional value 1-9, 12, 24, 36, 60 Unit in month.

periodUnitOptional 

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

productTypeOptional 

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

Property productType: Product type.

Valid values:Local: Community Edition(Local) or Enhanced Edition(Local)Tair_rdb: Performance Enhanced(Cloud Disk)Tair_scm: Persistent Memory(Cloud Disk)Tair_essd: Capacity Storage(Cloud Disk)OnECS: Community Edition(Cloud Disk)

resourceGroupIdOptional 

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

Property resourceGroupId: Resource group id.

secondaryZoneIdOptional 

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

Property secondaryZoneId: The secondary zone ID of the instance.

securityGroupIdOptional 

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

Property securityGroupId: The IDs of security groups.

Separate multiple security group IDs with commas (,) and up to 10 can be set.

shardCountOptional 

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

Property shardCount: The number of data nodes in the instance.

Default value: 1. Valid values: 1: You can create an instance in the standard architecture that contains only a single data node. For more information about the standard architecture, see Cluster master-replica instances. 2 to 32: You can create an instance in the cluster architecturethat contains the specified number of data nodes. For more information about the cluster architecture, see Cluster master-replica instances.

sslEnabledOptional 

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

Property sslEnabled: Modifies the SSL status.

Valid values: Disable: disables SSL encryption. Enable: enables SSL encryption. Update: updates the SSL certificate.

tagsOptional 

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to redis.

Max support 20 tags to add during create redis. Each tag with two properties Key and Value, and Key is required.

tairConfigOptional 

public java.lang.Object getTairConfig();

Property tairConfig: Tair config.

This parameter is available only if the InstanceClass parameter is start with tair.

vpcIdOptional 

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

Property vpcId: The VPC id to create ecs instance.

vpcPasswordFreeOptional 

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

Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.

If set to:

  • true: enables password free.
  • false: disables password free.

vSwitchIdOptional 

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

Property vSwitchId: The vSwitch Id to create ecs instance.

zoneIdOptional 

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

Property zoneId: The zone id of input region.