Docs Home
alicloud.redis.TairInstance
Explore with Pulumi AI
Import
Tair (Redis OSS-Compatible) And Memcache (KVStore) Tair Instance can be imported using the id, e.g.
$ pulumi import alicloud:redis/tairInstance:TairInstance example <id>
Create TairInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TairInstance(name: string, args: TairInstanceArgs, opts?: CustomResourceOptions);@overload
def TairInstance(resource_name: str,
args: TairInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TairInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_class: Optional[str] = None,
zone_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
vpc_id: Optional[str] = None,
instance_type: Optional[str] = None,
password: Optional[str] = None,
read_only_count: Optional[int] = None,
force_upgrade: Optional[bool] = None,
global_instance_id: Optional[str] = None,
effective_time: Optional[str] = None,
connection_string_prefix: Optional[str] = None,
intranet_bandwidth: Optional[int] = None,
modify_mode: Optional[str] = None,
node_type: Optional[str] = None,
param_no_loose_sentinel_enabled: Optional[str] = None,
param_no_loose_sentinel_password_free_access: Optional[str] = None,
param_no_loose_sentinel_password_free_commands: Optional[str] = None,
param_repl_mode: Optional[str] = None,
param_semisync_repl_timeout: Optional[str] = None,
param_sentinel_compat_enable: Optional[str] = None,
auto_renew: Optional[str] = None,
payment_type: Optional[str] = None,
period: Optional[int] = None,
port: Optional[int] = None,
engine_version: Optional[str] = None,
recover_config_mode: Optional[str] = None,
resource_group_id: Optional[str] = None,
secondary_zone_id: Optional[str] = None,
security_group_id: Optional[str] = None,
security_ip_group_name: Optional[str] = None,
security_ips: Optional[str] = None,
shard_count: Optional[int] = None,
slave_read_only_count: Optional[int] = None,
src_db_instance_id: Optional[str] = None,
ssl_enabled: Optional[str] = None,
storage_performance_level: Optional[str] = None,
storage_size_gb: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
tair_instance_name: Optional[str] = None,
vpc_auth_mode: Optional[str] = None,
cluster_backup_id: Optional[str] = None,
backup_id: Optional[str] = None,
auto_renew_period: Optional[str] = None)func NewTairInstance(ctx *Context, name string, args TairInstanceArgs, opts ...ResourceOption) (*TairInstance, error)public TairInstance(string name, TairInstanceArgs args, CustomResourceOptions? opts = null)public TairInstance(String name, TairInstanceArgs args)
public TairInstance(String name, TairInstanceArgs args, CustomResourceOptions options)
type: alicloud:redis:TairInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. TairInstanceArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. TairInstanceArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. TairInstanceArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. TairInstanceArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. TairInstanceArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var tairInstanceResource = new AliCloud.Redis.TairInstance("tairInstanceResource", new()
{
InstanceClass = "string",
ZoneId = "string",
VswitchId = "string",
VpcId = "string",
InstanceType = "string",
Password = "string",
ReadOnlyCount = 0,
ForceUpgrade = false,
GlobalInstanceId = "string",
EffectiveTime = "string",
ConnectionStringPrefix = "string",
IntranetBandwidth = 0,
ModifyMode = "string",
NodeType = "string",
ParamNoLooseSentinelEnabled = "string",
ParamNoLooseSentinelPasswordFreeAccess = "string",
ParamNoLooseSentinelPasswordFreeCommands = "string",
ParamReplMode = "string",
ParamSemisyncReplTimeout = "string",
ParamSentinelCompatEnable = "string",
AutoRenew = "string",
PaymentType = "string",
Period = 0,
Port = 0,
EngineVersion = "string",
RecoverConfigMode = "string",
ResourceGroupId = "string",
SecondaryZoneId = "string",
SecurityGroupId = "string",
SecurityIpGroupName = "string",
SecurityIps = "string",
ShardCount = 0,
SlaveReadOnlyCount = 0,
SrcDbInstanceId = "string",
SslEnabled = "string",
StoragePerformanceLevel = "string",
StorageSizeGb = 0,
Tags =
{
{ "string", "string" },
},
TairInstanceName = "string",
VpcAuthMode = "string",
ClusterBackupId = "string",
BackupId = "string",
AutoRenewPeriod = "string",
});
example, err := redis.NewTairInstance(ctx, "tairInstanceResource", &redis.TairInstanceArgs{
InstanceClass: pulumi.String("string"),
ZoneId: pulumi.String("string"),
VswitchId: pulumi.String("string"),
VpcId: pulumi.String("string"),
InstanceType: pulumi.String("string"),
Password: pulumi.String("string"),
ReadOnlyCount: pulumi.Int(0),
ForceUpgrade: pulumi.Bool(false),
GlobalInstanceId: pulumi.String("string"),
EffectiveTime: pulumi.String("string"),
ConnectionStringPrefix: pulumi.String("string"),
IntranetBandwidth: pulumi.Int(0),
ModifyMode: pulumi.String("string"),
NodeType: pulumi.String("string"),
ParamNoLooseSentinelEnabled: pulumi.String("string"),
ParamNoLooseSentinelPasswordFreeAccess: pulumi.String("string"),
ParamNoLooseSentinelPasswordFreeCommands: pulumi.String("string"),
ParamReplMode: pulumi.String("string"),
ParamSemisyncReplTimeout: pulumi.String("string"),
ParamSentinelCompatEnable: pulumi.String("string"),
AutoRenew: pulumi.String("string"),
PaymentType: pulumi.String("string"),
Period: pulumi.Int(0),
Port: pulumi.Int(0),
EngineVersion: pulumi.String("string"),
RecoverConfigMode: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
SecondaryZoneId: pulumi.String("string"),
SecurityGroupId: pulumi.String("string"),
SecurityIpGroupName: pulumi.String("string"),
SecurityIps: pulumi.String("string"),
ShardCount: pulumi.Int(0),
SlaveReadOnlyCount: pulumi.Int(0),
SrcDbInstanceId: pulumi.String("string"),
SslEnabled: pulumi.String("string"),
StoragePerformanceLevel: pulumi.String("string"),
StorageSizeGb: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TairInstanceName: pulumi.String("string"),
VpcAuthMode: pulumi.String("string"),
ClusterBackupId: pulumi.String("string"),
BackupId: pulumi.String("string"),
AutoRenewPeriod: pulumi.String("string"),
})
var tairInstanceResource = new TairInstance("tairInstanceResource", TairInstanceArgs.builder()
.instanceClass("string")
.zoneId("string")
.vswitchId("string")
.vpcId("string")
.instanceType("string")
.password("string")
.readOnlyCount(0)
.forceUpgrade(false)
.globalInstanceId("string")
.effectiveTime("string")
.connectionStringPrefix("string")
.intranetBandwidth(0)
.modifyMode("string")
.nodeType("string")
.paramNoLooseSentinelEnabled("string")
.paramNoLooseSentinelPasswordFreeAccess("string")
.paramNoLooseSentinelPasswordFreeCommands("string")
.paramReplMode("string")
.paramSemisyncReplTimeout("string")
.paramSentinelCompatEnable("string")
.autoRenew("string")
.paymentType("string")
.period(0)
.port(0)
.engineVersion("string")
.recoverConfigMode("string")
.resourceGroupId("string")
.secondaryZoneId("string")
.securityGroupId("string")
.securityIpGroupName("string")
.securityIps("string")
.shardCount(0)
.slaveReadOnlyCount(0)
.srcDbInstanceId("string")
.sslEnabled("string")
.storagePerformanceLevel("string")
.storageSizeGb(0)
.tags(Map.of("string", "string"))
.tairInstanceName("string")
.vpcAuthMode("string")
.clusterBackupId("string")
.backupId("string")
.autoRenewPeriod("string")
.build());
tair_instance_resource = alicloud.redis.TairInstance("tairInstanceResource",
instance_class="string",
zone_id="string",
vswitch_id="string",
vpc_id="string",
instance_type="string",
password="string",
read_only_count=0,
force_upgrade=False,
global_instance_id="string",
effective_time="string",
connection_string_prefix="string",
intranet_bandwidth=0,
modify_mode="string",
node_type="string",
param_no_loose_sentinel_enabled="string",
param_no_loose_sentinel_password_free_access="string",
param_no_loose_sentinel_password_free_commands="string",
param_repl_mode="string",
param_semisync_repl_timeout="string",
param_sentinel_compat_enable="string",
auto_renew="string",
payment_type="string",
period=0,
port=0,
engine_version="string",
recover_config_mode="string",
resource_group_id="string",
secondary_zone_id="string",
security_group_id="string",
security_ip_group_name="string",
security_ips="string",
shard_count=0,
slave_read_only_count=0,
src_db_instance_id="string",
ssl_enabled="string",
storage_performance_level="string",
storage_size_gb=0,
tags={
"string": "string",
},
tair_instance_name="string",
vpc_auth_mode="string",
cluster_backup_id="string",
backup_id="string",
auto_renew_period="string")
const tairInstanceResource = new alicloud.redis.TairInstance("tairInstanceResource", {
instanceClass: "string",
zoneId: "string",
vswitchId: "string",
vpcId: "string",
instanceType: "string",
password: "string",
readOnlyCount: 0,
forceUpgrade: false,
globalInstanceId: "string",
effectiveTime: "string",
connectionStringPrefix: "string",
intranetBandwidth: 0,
modifyMode: "string",
nodeType: "string",
paramNoLooseSentinelEnabled: "string",
paramNoLooseSentinelPasswordFreeAccess: "string",
paramNoLooseSentinelPasswordFreeCommands: "string",
paramReplMode: "string",
paramSemisyncReplTimeout: "string",
paramSentinelCompatEnable: "string",
autoRenew: "string",
paymentType: "string",
period: 0,
port: 0,
engineVersion: "string",
recoverConfigMode: "string",
resourceGroupId: "string",
secondaryZoneId: "string",
securityGroupId: "string",
securityIpGroupName: "string",
securityIps: "string",
shardCount: 0,
slaveReadOnlyCount: 0,
srcDbInstanceId: "string",
sslEnabled: "string",
storagePerformanceLevel: "string",
storageSizeGb: 0,
tags: {
string: "string",
},
tairInstanceName: "string",
vpcAuthMode: "string",
clusterBackupId: "string",
backupId: "string",
autoRenewPeriod: "string",
});
type: alicloud:redis:TairInstance
properties:
autoRenew: string
autoRenewPeriod: string
backupId: string
clusterBackupId: string
connectionStringPrefix: string
effectiveTime: string
engineVersion: string
forceUpgrade: false
globalInstanceId: string
instanceClass: string
instanceType: string
intranetBandwidth: 0
modifyMode: string
nodeType: string
paramNoLooseSentinelEnabled: string
paramNoLooseSentinelPasswordFreeAccess: string
paramNoLooseSentinelPasswordFreeCommands: string
paramReplMode: string
paramSemisyncReplTimeout: string
paramSentinelCompatEnable: string
password: string
paymentType: string
period: 0
port: 0
readOnlyCount: 0
recoverConfigMode: string
resourceGroupId: string
secondaryZoneId: string
securityGroupId: string
securityIpGroupName: string
securityIps: string
shardCount: 0
slaveReadOnlyCount: 0
srcDbInstanceId: string
sslEnabled: string
storagePerformanceLevel: string
storageSizeGb: 0
tags:
string: string
tairInstanceName: string
vpcAuthMode: string
vpcId: string
vswitchId: string
zoneId: string
TairInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The TairInstance resource accepts the following input properties:
- Instance
Class This property is required. string - The instance type of the instance. For more information, see Instance types.
- Instance
Type stringThis property is required. 
Changes to this property will trigger replacement. - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- Vpc
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the virtual private cloud (VPC).
- Vswitch
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the vSwitch to which the instance is connected.
- Zone
Id stringThis property is required. Changes to this property will trigger replacement. - Zone ID
- Auto
Renew string - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- Auto
Renew stringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- Backup
Id string You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- Cluster
Backup stringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- Connection
String stringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- Effective
Time string - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- Engine
Version string Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- Force
Upgrade bool - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- Global
Instance stringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- Intranet
Bandwidth int - Instance intranet bandwidth
- Modify
Mode string - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- Node
Type string - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- Param
No stringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- Param
No stringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- Param
No stringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- Param
Repl stringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Semisync stringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Sentinel stringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- Password string
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- Payment
Type string - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- Period int
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- Port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- Read
Only intCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- Recover
Config stringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- Security
Group stringId - Security group id
- Security
Ip stringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- Security
Ips string - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- int
- The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- Slave
Read intOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- Src
Db stringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- Ssl
Enabled string - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- Storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- Storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Dictionary<string, string>
- The tag of the resource
- Tair
Instance stringName - The name of the resource.
- Vpc
Auth stringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- Instance
Class This property is required. string - The instance type of the instance. For more information, see Instance types.
- Instance
Type stringThis property is required. Changes to this property will trigger replacement. - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- Vpc
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the virtual private cloud (VPC).
- Vswitch
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the vSwitch to which the instance is connected.
- Zone
Id stringThis property is required. Changes to this property will trigger replacement. - Zone ID
- Auto
Renew string - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- Auto
Renew stringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- Backup
Id string You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- Cluster
Backup stringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- Connection
String stringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- Effective
Time string - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- Engine
Version string Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- Force
Upgrade bool - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- Global
Instance stringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- Intranet
Bandwidth int - Instance intranet bandwidth
- Modify
Mode string - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- Node
Type string - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- Param
No stringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- Param
No stringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- Param
No stringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- Param
Repl stringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Semisync stringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Sentinel stringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- Password string
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- Payment
Type string - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- Period int
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- Port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- Read
Only intCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- Recover
Config stringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- Security
Group stringId - Security group id
- Security
Ip stringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- Security
Ips string - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- int
- The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- Slave
Read intOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- Src
Db stringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- Ssl
Enabled string - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- Storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- Storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- map[string]string
- The tag of the resource
- Tair
Instance stringName - The name of the resource.
- Vpc
Auth stringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- instance
Class This property is required. String - The instance type of the instance. For more information, see Instance types.
- instance
Type StringThis property is required. Changes to this property will trigger replacement. - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- vpc
Id StringThis property is required. Changes to this property will trigger replacement. - The ID of the virtual private cloud (VPC).
- vswitch
Id StringThis property is required. Changes to this property will trigger replacement. - The ID of the vSwitch to which the instance is connected.
- zone
Id StringThis property is required. Changes to this property will trigger replacement. - Zone ID
- auto
Renew String - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto
Renew StringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup
Id String You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster
Backup StringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection
String StringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- effective
Time String - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine
Version String Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force
Upgrade Boolean - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global
Instance StringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- intranet
Bandwidth Integer - Instance intranet bandwidth
- modify
Mode String - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- node
Type String - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param
No StringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param
No StringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param
No StringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param
Repl StringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Semisync StringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Sentinel StringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password String
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment
Type String - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period Integer
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read
Only IntegerCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover
Config StringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security
Group StringId - Security group id
- security
Ip StringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security
Ips String - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- Integer
- The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave
Read IntegerOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src
Db StringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl
Enabled String - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Map<String,String>
- The tag of the resource
- tair
Instance StringName - The name of the resource.
- vpc
Auth StringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- instance
Class This property is required. string - The instance type of the instance. For more information, see Instance types.
- instance
Type stringThis property is required. Changes to this property will trigger replacement. - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- vpc
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the virtual private cloud (VPC).
- vswitch
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the vSwitch to which the instance is connected.
- zone
Id stringThis property is required. Changes to this property will trigger replacement. - Zone ID
- auto
Renew string - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto
Renew stringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup
Id string You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster
Backup stringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection
String stringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- effective
Time string - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine
Version string Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force
Upgrade boolean - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global
Instance stringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- intranet
Bandwidth number - Instance intranet bandwidth
- modify
Mode string - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- node
Type string - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param
No stringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param
No stringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param
No stringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param
Repl stringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Semisync stringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Sentinel stringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password string
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment
Type string - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period number
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read
Only numberCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover
Config stringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- resource
Group stringId - The ID of the resource group to which the instance belongs.
- secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security
Group stringId - Security group id
- security
Ip stringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security
Ips string - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- number
- The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave
Read numberOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src
Db stringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl
Enabled string - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- {[key: string]: string}
- The tag of the resource
- tair
Instance stringName - The name of the resource.
- vpc
Auth stringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- instance_
class This property is required. str - The instance type of the instance. For more information, see Instance types.
- instance_
type strThis property is required. Changes to this property will trigger replacement. - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- vpc_
id strThis property is required. Changes to this property will trigger replacement. - The ID of the virtual private cloud (VPC).
- vswitch_
id strThis property is required. Changes to this property will trigger replacement. - The ID of the vSwitch to which the instance is connected.
- zone_
id strThis property is required. Changes to this property will trigger replacement. - Zone ID
- auto_
renew str - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto_
renew_ strperiod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup_
id str You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster_
backup_ strid - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection_
string_ strprefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- effective_
time str - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine_
version str Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force_
upgrade bool - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global_
instance_ strid The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- intranet_
bandwidth int - Instance intranet bandwidth
- modify_
mode str - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- node_
type str - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param_
no_ strloose_ sentinel_ enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param_
no_ strloose_ sentinel_ password_ free_ access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param_
no_ strloose_ sentinel_ password_ free_ commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param_
repl_ strmode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param_
semisync_ strrepl_ timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param_
sentinel_ strcompat_ enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password str
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment_
type str - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period int
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read_
only_ intcount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover_
config_ strmode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- resource_
group_ strid - The ID of the resource group to which the instance belongs.
- secondary_
zone_ id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security_
group_ strid - Security group id
- security_
ip_ strgroup_ name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security_
ips str - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- int
- The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave_
read_ intonly_ count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src_
db_ strinstance_ id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl_
enabled str - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- storage_
performance_ level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage_
size_ gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Mapping[str, str]
- The tag of the resource
- tair_
instance_ strname - The name of the resource.
- vpc_
auth_ strmode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- instance
Class This property is required. String - The instance type of the instance. For more information, see Instance types.
- instance
Type StringThis property is required. Changes to this property will trigger replacement. - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- vpc
Id StringThis property is required. Changes to this property will trigger replacement. - The ID of the virtual private cloud (VPC).
- vswitch
Id StringThis property is required. Changes to this property will trigger replacement. - The ID of the vSwitch to which the instance is connected.
- zone
Id StringThis property is required. Changes to this property will trigger replacement. - Zone ID
- auto
Renew String - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto
Renew StringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup
Id String You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster
Backup StringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection
String StringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- effective
Time String - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine
Version String Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force
Upgrade Boolean - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global
Instance StringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- intranet
Bandwidth Number - Instance intranet bandwidth
- modify
Mode String - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- node
Type String - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param
No StringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param
No StringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param
No StringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param
Repl StringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Semisync StringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Sentinel StringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password String
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment
Type String - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period Number
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read
Only NumberCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover
Config StringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security
Group StringId - Security group id
- security
Ip StringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security
Ips String - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- Number
- The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave
Read NumberOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src
Db StringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl
Enabled String - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Map<String>
- The tag of the resource
- tair
Instance StringName - The name of the resource.
- vpc
Auth StringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
Outputs
All input properties are implicitly available as output properties. Additionally, the TairInstance resource produces the following output properties:
- Architecture
Type string - The architecture of the instance. cluster, standard, rwsplit.
- Connection
Domain string - The internal endpoint of the instance.
- Create
Time string - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Id string
- The provider-assigned unique ID for this managed resource.
- Max
Connections int - The maximum number of connections supported by the instance.
- Network
Type string - The network type of the instance. CLASSIC(classic network), VPC.
- Region
Id string - Region Id
- Status string
- The status of the resource
- Tair
Instance stringId - The ID of the resource.
- Architecture
Type string - The architecture of the instance. cluster, standard, rwsplit.
- Connection
Domain string - The internal endpoint of the instance.
- Create
Time string - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Id string
- The provider-assigned unique ID for this managed resource.
- Max
Connections int - The maximum number of connections supported by the instance.
- Network
Type string - The network type of the instance. CLASSIC(classic network), VPC.
- Region
Id string - Region Id
- Status string
- The status of the resource
- Tair
Instance stringId - The ID of the resource.
- architecture
Type String - The architecture of the instance. cluster, standard, rwsplit.
- connection
Domain String - The internal endpoint of the instance.
- create
Time String - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- id String
- The provider-assigned unique ID for this managed resource.
- max
Connections Integer - The maximum number of connections supported by the instance.
- network
Type String - The network type of the instance. CLASSIC(classic network), VPC.
- region
Id String - Region Id
- status String
- The status of the resource
- tair
Instance StringId - The ID of the resource.
- architecture
Type string - The architecture of the instance. cluster, standard, rwsplit.
- connection
Domain string - The internal endpoint of the instance.
- create
Time string - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- id string
- The provider-assigned unique ID for this managed resource.
- max
Connections number - The maximum number of connections supported by the instance.
- network
Type string - The network type of the instance. CLASSIC(classic network), VPC.
- region
Id string - Region Id
- status string
- The status of the resource
- tair
Instance stringId - The ID of the resource.
- architecture_
type str - The architecture of the instance. cluster, standard, rwsplit.
- connection_
domain str - The internal endpoint of the instance.
- create_
time str - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- id str
- The provider-assigned unique ID for this managed resource.
- max_
connections int - The maximum number of connections supported by the instance.
- network_
type str - The network type of the instance. CLASSIC(classic network), VPC.
- region_
id str - Region Id
- status str
- The status of the resource
- tair_
instance_ strid - The ID of the resource.
- architecture
Type String - The architecture of the instance. cluster, standard, rwsplit.
- connection
Domain String - The internal endpoint of the instance.
- create
Time String - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- id String
- The provider-assigned unique ID for this managed resource.
- max
Connections Number - The maximum number of connections supported by the instance.
- network
Type String - The network type of the instance. CLASSIC(classic network), VPC.
- region
Id String - Region Id
- status String
- The status of the resource
- tair
Instance StringId - The ID of the resource.
Look up Existing TairInstance Resource
Get an existing TairInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TairInstanceState, opts?: CustomResourceOptions): TairInstance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
architecture_type: Optional[str] = None,
auto_renew: Optional[str] = None,
auto_renew_period: Optional[str] = None,
backup_id: Optional[str] = None,
cluster_backup_id: Optional[str] = None,
connection_domain: Optional[str] = None,
connection_string_prefix: Optional[str] = None,
create_time: Optional[str] = None,
effective_time: Optional[str] = None,
engine_version: Optional[str] = None,
force_upgrade: Optional[bool] = None,
global_instance_id: Optional[str] = None,
instance_class: Optional[str] = None,
instance_type: Optional[str] = None,
intranet_bandwidth: Optional[int] = None,
max_connections: Optional[int] = None,
modify_mode: Optional[str] = None,
network_type: Optional[str] = None,
node_type: Optional[str] = None,
param_no_loose_sentinel_enabled: Optional[str] = None,
param_no_loose_sentinel_password_free_access: Optional[str] = None,
param_no_loose_sentinel_password_free_commands: Optional[str] = None,
param_repl_mode: Optional[str] = None,
param_semisync_repl_timeout: Optional[str] = None,
param_sentinel_compat_enable: Optional[str] = None,
password: Optional[str] = None,
payment_type: Optional[str] = None,
period: Optional[int] = None,
port: Optional[int] = None,
read_only_count: Optional[int] = None,
recover_config_mode: Optional[str] = None,
region_id: Optional[str] = None,
resource_group_id: Optional[str] = None,
secondary_zone_id: Optional[str] = None,
security_group_id: Optional[str] = None,
security_ip_group_name: Optional[str] = None,
security_ips: Optional[str] = None,
shard_count: Optional[int] = None,
slave_read_only_count: Optional[int] = None,
src_db_instance_id: Optional[str] = None,
ssl_enabled: Optional[str] = None,
status: Optional[str] = None,
storage_performance_level: Optional[str] = None,
storage_size_gb: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
tair_instance_id: Optional[str] = None,
tair_instance_name: Optional[str] = None,
vpc_auth_mode: Optional[str] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
zone_id: Optional[str] = None) -> TairInstancefunc GetTairInstance(ctx *Context, name string, id IDInput, state *TairInstanceState, opts ...ResourceOption) (*TairInstance, error)public static TairInstance Get(string name, Input<string> id, TairInstanceState? state, CustomResourceOptions? opts = null)public static TairInstance get(String name, Output<String> id, TairInstanceState state, CustomResourceOptions options)resources: _: type: alicloud:redis:TairInstance get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Architecture
Type string - The architecture of the instance. cluster, standard, rwsplit.
- Auto
Renew string - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- Auto
Renew stringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- Backup
Id string You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- Cluster
Backup stringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- Connection
Domain string - The internal endpoint of the instance.
- Connection
String stringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- Create
Time string - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Effective
Time string - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- Engine
Version string Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- Force
Upgrade bool - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- Global
Instance stringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- Instance
Class string - The instance type of the instance. For more information, see Instance types.
- Instance
Type - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- Intranet
Bandwidth int - Instance intranet bandwidth
- Max
Connections int - The maximum number of connections supported by the instance.
- Modify
Mode string - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- Network
Type string - The network type of the instance. CLASSIC(classic network), VPC.
- Node
Type string - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- Param
No stringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- Param
No stringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- Param
No stringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- Param
Repl stringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Semisync stringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Sentinel stringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- Password string
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- Payment
Type string - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- Period int
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- Port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- Read
Only intCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- Recover
Config stringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- Region
Id string - Region Id
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- Security
Group stringId - Security group id
- Security
Ip stringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- Security
Ips string - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- Shard
Count int - The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- Slave
Read intOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- Src
Db stringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- Ssl
Enabled string - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- Status string
- The status of the resource
- Storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- Storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Dictionary<string, string>
- The tag of the resource
- Tair
Instance stringId - The ID of the resource.
- Tair
Instance stringName - The name of the resource.
- Vpc
Auth stringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- Vpc
Id - The ID of the virtual private cloud (VPC).
- Vswitch
Id - The ID of the vSwitch to which the instance is connected.
- Zone
Id - Zone ID
- Architecture
Type string - The architecture of the instance. cluster, standard, rwsplit.
- Auto
Renew string - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- Auto
Renew stringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- Backup
Id string You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- Cluster
Backup stringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- Connection
Domain string - The internal endpoint of the instance.
- Connection
String stringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- Create
Time string - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- Effective
Time string - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- Engine
Version string Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- Force
Upgrade bool - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- Global
Instance stringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- Instance
Class string - The instance type of the instance. For more information, see Instance types.
- Instance
Type - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- Intranet
Bandwidth int - Instance intranet bandwidth
- Max
Connections int - The maximum number of connections supported by the instance.
- Modify
Mode string - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- Network
Type string - The network type of the instance. CLASSIC(classic network), VPC.
- Node
Type string - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- Param
No stringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- Param
No stringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- Param
No stringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- Param
Repl stringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Semisync stringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- Param
Sentinel stringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- Password string
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- Payment
Type string - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- Period int
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- Port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- Read
Only intCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- Recover
Config stringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- Region
Id string - Region Id
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- Security
Group stringId - Security group id
- Security
Ip stringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- Security
Ips string - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- Shard
Count int - The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- Slave
Read intOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- Src
Db stringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- Ssl
Enabled string - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- Status string
- The status of the resource
- Storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- Storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- map[string]string
- The tag of the resource
- Tair
Instance stringId - The ID of the resource.
- Tair
Instance stringName - The name of the resource.
- Vpc
Auth stringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- Vpc
Id - The ID of the virtual private cloud (VPC).
- Vswitch
Id - The ID of the vSwitch to which the instance is connected.
- Zone
Id - Zone ID
- architecture
Type String - The architecture of the instance. cluster, standard, rwsplit.
- auto
Renew String - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto
Renew StringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup
Id String You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster
Backup StringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection
Domain String - The internal endpoint of the instance.
- connection
String StringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- create
Time String - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- effective
Time String - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine
Version String Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force
Upgrade Boolean - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global
Instance StringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- instance
Class String - The instance type of the instance. For more information, see Instance types.
- instance
Type - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- intranet
Bandwidth Integer - Instance intranet bandwidth
- max
Connections Integer - The maximum number of connections supported by the instance.
- modify
Mode String - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- network
Type String - The network type of the instance. CLASSIC(classic network), VPC.
- node
Type String - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param
No StringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param
No StringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param
No StringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param
Repl StringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Semisync StringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Sentinel StringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password String
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment
Type String - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period Integer
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read
Only IntegerCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover
Config StringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- region
Id String - Region Id
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security
Group StringId - Security group id
- security
Ip StringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security
Ips String - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- shard
Count Integer - The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave
Read IntegerOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src
Db StringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl
Enabled String - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- status String
- The status of the resource
- storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Map<String,String>
- The tag of the resource
- tair
Instance StringId - The ID of the resource.
- tair
Instance StringName - The name of the resource.
- vpc
Auth StringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- vpc
Id - The ID of the virtual private cloud (VPC).
- vswitch
Id - The ID of the vSwitch to which the instance is connected.
- zone
Id - Zone ID
- architecture
Type string - The architecture of the instance. cluster, standard, rwsplit.
- auto
Renew string - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto
Renew stringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup
Id string You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster
Backup stringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection
Domain string - The internal endpoint of the instance.
- connection
String stringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- create
Time string - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- effective
Time string - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine
Version string Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force
Upgrade boolean - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global
Instance stringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- instance
Class string - The instance type of the instance. For more information, see Instance types.
- instance
Type - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- intranet
Bandwidth number - Instance intranet bandwidth
- max
Connections number - The maximum number of connections supported by the instance.
- modify
Mode string - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- network
Type string - The network type of the instance. CLASSIC(classic network), VPC.
- node
Type string - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param
No stringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param
No stringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param
No stringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param
Repl stringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Semisync stringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Sentinel stringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password string
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment
Type string - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period number
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read
Only numberCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover
Config stringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- region
Id string - Region Id
- resource
Group stringId - The ID of the resource group to which the instance belongs.
- secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security
Group stringId - Security group id
- security
Ip stringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security
Ips string - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- shard
Count number - The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave
Read numberOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src
Db stringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl
Enabled string - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- status string
- The status of the resource
- storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- {[key: string]: string}
- The tag of the resource
- tair
Instance stringId - The ID of the resource.
- tair
Instance stringName - The name of the resource.
- vpc
Auth stringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- vpc
Id - The ID of the virtual private cloud (VPC).
- vswitch
Id - The ID of the vSwitch to which the instance is connected.
- zone
Id - Zone ID
- architecture_
type str - The architecture of the instance. cluster, standard, rwsplit.
- auto_
renew str - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto_
renew_ strperiod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup_
id str You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster_
backup_ strid - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection_
domain str - The internal endpoint of the instance.
- connection_
string_ strprefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- create_
time str - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- effective_
time str - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine_
version str Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force_
upgrade bool - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global_
instance_ strid The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- instance_
class str - The instance type of the instance. For more information, see Instance types.
- instance_
type - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- intranet_
bandwidth int - Instance intranet bandwidth
- max_
connections int - The maximum number of connections supported by the instance.
- modify_
mode str - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- network_
type str - The network type of the instance. CLASSIC(classic network), VPC.
- node_
type str - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param_
no_ strloose_ sentinel_ enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param_
no_ strloose_ sentinel_ password_ free_ access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param_
no_ strloose_ sentinel_ password_ free_ commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param_
repl_ strmode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param_
semisync_ strrepl_ timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param_
sentinel_ strcompat_ enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password str
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment_
type str - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period int
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read_
only_ intcount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover_
config_ strmode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- region_
id str - Region Id
- resource_
group_ strid - The ID of the resource group to which the instance belongs.
- secondary_
zone_ id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security_
group_ strid - Security group id
- security_
ip_ strgroup_ name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security_
ips str - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- shard_
count int - The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave_
read_ intonly_ count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src_
db_ strinstance_ id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl_
enabled str - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- status str
- The status of the resource
- storage_
performance_ level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage_
size_ gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Mapping[str, str]
- The tag of the resource
- tair_
instance_ strid - The ID of the resource.
- tair_
instance_ strname - The name of the resource.
- vpc_
auth_ strmode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- vpc_
id - The ID of the virtual private cloud (VPC).
- vswitch_
id - The ID of the vSwitch to which the instance is connected.
- zone_
id - Zone ID
- architecture
Type String - The architecture of the instance. cluster, standard, rwsplit.
- auto
Renew String - Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true(enables auto-renewal), false(disables auto-renewal).
- auto
Renew StringPeriod - The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required only if the AutoRenew parameter is set to true.
- backup
Id String You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,).
If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.
- cluster
Backup StringId - This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the DescribeClusterBackupList operation. If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter. If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,).
- connection
Domain String - The internal endpoint of the instance.
- connection
String StringPrefix - The prefix of the endpoint the instance, which must consist of lowercase letters and numbers and start with a lowercase letter.
- create
Time String - The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
- effective
Time String - The time when to change the configurations. Default value: Immediately. Valid values: Immediately (The configurations are immediately changed), MaintainTime (The configurations are changed within the maintenance window).
- engine
Version String Database version. Default value: 1.0.
Rules for transferring parameters of different tair product types:
tair_rdb: Compatible with the Redis5.0 and Redis6.0 protocols, and is transmitted to 5.0 or 6.0.
tair_scm: The Tair persistent memory is compatible with the Redis6.0 protocol and is passed 1.0.
tair_essd: The disk (ESSD/SSD) is compatible with the Redis4.0 and Redis6.0 protocols, and is transmitted to 1.0 and 2.0 respectively.
- force
Upgrade Boolean - Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values: false (The system does not forcefully change the configurations), true (The system forcefully changes the configurations).
- global
Instance StringId The ID of a distributed (Global Distributed Cache) instance, which indicates whether to use the newly created instance as a sub-instance of a distributed instance. You can use this method to create a distributed instance.
Enter true if you want the new instance to be the first child instance.
If you want the new instance to be used as the second and third sub-instances, enter the distributed instance ID.
Not as a distributed instance, you do not need to enter any values.
- instance
Class String - The instance type of the instance. For more information, see Instance types.
- instance
Type - The storage medium of the instance. Valid values: tair_rdb, tair_scm, tair_essd.
- intranet
Bandwidth Number - Instance intranet bandwidth
- max
Connections Number - The maximum number of connections supported by the instance.
- modify
Mode String - The modification method when modifying the IP whitelist. The value includes Cover (default): overwrite the original whitelist; Append: Append the whitelist; Delete: Delete the whitelist.
- network
Type String - The network type of the instance. CLASSIC(classic network), VPC.
- node
Type String - The node type. For cloud-native instances, input MASTER_SLAVE (master-replica) or STAND_ALONE (standalone). For classic instances, input double (master-replica) or single (standalone).
- param
No StringLoose Sentinel Enabled - sentinel compatibility mode, applicable to non-cluster instances. For more information about parameters, see yes or no in the https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance, valid values: yes, no. The default value is no.
- param
No StringLoose Sentinel Password Free Access - Whether to allow Sentinel commands to be executed without secrets when Sentinel mode is enabled. Value: yes: enabled. After the command is enabled, you can directly run the Sentinel command in the VPC without enabling the password-free feature. no: the default value, disabled. For parameters, see https://help.aliyun.com/zh/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance
- param
No StringLoose Sentinel Password Free Commands - After sentinel mode and the# no_loose_sentinel-password-free-access parameter are enabled, you can use this parameter to add additional secret-free command lists (empty by default). After setting, you can execute the corresponding command on any connection without secret, please operate carefully. Commands are written in lowercase letters, and multiple commands are separated by commas (,). See https://help.aliyun.com/zh/redis/user-guide/parameter-support for details
- param
Repl StringMode The value is semisync or async. The default value is async.
The default data synchronization mode is asynchronous replication. To modify the data synchronization mode, refer to https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Semisync StringRepl Timeout - The degradation threshold time of the semi-synchronous replication mode. This parameter value is required only when semi-synchronous replication is enabled. The unit is milliseconds, and the range is 10ms to 60000ms. The default value is 500ms. Please refer to: https://www.alibabacloud.com/help/en/redis/user-guide/modify-the-synchronization-mode-of-a-persistent-memory-optimized-instance.
- param
Sentinel StringCompat Enable - sentinel compatibility mode, applicable to instances in the cluster architecture proxy connection mode or read/write splitting architecture. For more information about the parameters, see https://www.alibabacloud.com/help/en/redis/user-guide/use-the-sentinel-compatible-mode-to-connect-to-an-apsaradb-for-redis-instance. The value is 0 or 1. The default value is 0.
- password String
- The password that is used to connect to the instance. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
- payment
Type String - Payment type: Subscription (prepaid), PayAsYouGo (postpaid). Default Subscription.
- period Number
- The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. This parameter is required only if you set the PaymentType parameter to Subscription.
- port
- The Tair service port. The service port of the instance. Valid values: 1024 to 65535. Default value: 6379.
- read
Only NumberCount Number of read-only nodes in the primary zone. Valid values: 0 to 5. This parameter is only applicable to the following conditions:
If the instance is in the cloud disk version standard architecture, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.
If the instance is a cloud disk version read/write splitting architecture instance, you can use this parameter to customize the number of read-only nodes, or set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.
- recover
Config StringMode - Whether to restore the account, kernel parameters, and whitelist (config) information from the original backup set when creating an instance using a specified backup set. The default value is empty, indicating that the account, kernel parameters, and whitelist information are not restored from the original backup set. This parameter is only applicable to Cloud Native instances, and the account, kernel parameters, and whitelist information must have been saved in the original backup set.
- region
Id String - Region Id
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- secondary
Zone Id - The ID of the secondary zone.This parameter is returned only if the instance is deployed in two zones.
- security
Group StringId - Security group id
- security
Ip StringGroup Name - The name of the IP address whitelist. You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.
- security
Ips String - The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.
- shard
Count Number - The number of data nodes in the instance. When 1 is passed, it means that the instance created is a standard architecture with only one data node. You can create an instance in the standard architecture that contains only a single data node. 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm. It is not allowed to modify the number of shards by modifying this parameter after creating a master-slave architecture instance with or without passing 1.
- slave
Read NumberOnly Count Specifies the number of read-only nodes in the secondary zone when creating a multi-zone read/write splitting instance.
Note: To create a multi-zone read/write splitting instance, slaveadonlycount and SecondaryZoneId must be specified at the same time.
- src
Db StringInstance Id - If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance. preceding three parameters. After you specify the SrcDBInstanceId parameter, use the BackupId, ClusterBackupId (recommended for cloud-native cluster instances), or RestoreTime parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.
- ssl
Enabled String - Modifies SSL encryption configurations. Valid values: 1. Disable (The SSL encryption is disabled) 2. Enable (The SSL encryption is enabled) 3. Update (The SSL certificate is updated)
- status String
- The status of the resource
- storage
Performance Level The storage type. Valid values: PL1, PL2, and PL3. This parameter is available only when the value of InstanceType is tair_essd, that is, when an ESSD disk instance is selected.
If the ESSD instance type is 4C, 8C, or 16C, you can specify the storage type as PL1.
If the type of ESSD instance you select is 8C, 16C, 32C, or 52C, you can specify the storage type as PL2.
If the ESSD instance type is 16C, 32C, or 52C, you can specify the storage type as PL3.
- storage
Size Gb - Different specifications have different value ranges. When the instance_type value is tair_essd and the disk type is ESSD, this attribute takes effect and is required. When a Tair disk is an SSD, see-https://help.aliyun.com/zh/redis/product-overview/capacity-storage-type. The capacity field is defined as different fixed values according to different specifications, and does not need to be specified.
- Map<String>
- The tag of the resource
- tair
Instance StringId - The ID of the resource.
- tair
Instance StringName - The name of the resource.
- vpc
Auth StringMode - The VPC authentication mode. Valid values: Open (enables password authentication), Close (disables password authentication and enables password-free access).
- vpc
Id - The ID of the virtual private cloud (VPC).
- vswitch
Id - The ID of the vSwitch to which the instance is connected.
- zone
Id - Zone ID
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.