Instance

Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default value: false.

Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid values: 1~12. Default value: 1.

Specifies whether to use a coupon. Default value: false.

It has been deprecated from provider version 1.101.0 and zone_id instead.

The ID of the backup file of the source instance.

Backup period.

Backup time, the format is HH:mmZ-HH:mmZ (UTC time).

The total bandwidth of the instance. NOTE: From version 1.232.0, bandwidth can be set. If the instance is a cluster instance, bandwidth must be divisible by the number of shard_count in the instance, and if the instance is a read/write splitting instance, bandwidth cannot be set.

The ID of the event or the business information.

The storage capacity of the KVStore DBInstance. Unit: MB.

The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.

Intranet connection address of the KVStore instance.

Indicates whether the address is a private endpoint.

It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

The coupon code. NOTE: The default value youhuiquan_promotion_option_id_for_blank removed since v1.216.0, this can cause your status file to change even if it has not been modified, so please review your change plan before apply change plan.

The name of KVStore DBInstance. It is a string of 2 to 256 characters.

The ID of the dedicated cluster. This parameter is required when you create a Tair (Redis OSS-Compatible) And Memcache (KVStore) Classic Instance in a dedicated cluster.

Specifies whether to precheck the request. Valid values:

The time when the database is switched after the instance is migrated, or when the major version is upgraded, or when the instance class is upgraded. Valid values:

Turn on or off incremental backup. Valid values: 1, 0. Default value: 0

It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

The Custom key ID, which you can get by calling DescribeEncryptionKeyList.If this parameter is not passed, the key is automatically generated by the key management service. To create a custom key, you can call the CreateKey interface of the key management service.

The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.

The expiration time of the prepaid instance.

The engine version of the KVStore DBInstance. Valid values: "2.8", "4.0", "5.0", "6.0", "7.0". Default value: 5.0. NOTE: When instance_type = Memcache, the engine_version only supports "4.0".

Specifies whether to forcibly change the type. Default value: true.

Whether to create a distributed cache. Default value: false.

The ID of distributed cache.

It has been deprecated from provider version 1.101.0 and payment_type instead.

Type of the applied Tair (Redis OSS-Compatible) And Memcache (KVStore) Classic Instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.

It has been deprecated from provider version 1.101.0 and db_instance_name instead.

Whether to open the release protection.

The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Default value: Redis.

Specifies whether to enable automatic minor version update. Valid values:

An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.

An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).

The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).

Node type, valid values:

Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default value: UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.

It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

The password of the KVStore DBInstance. The password that is used to connect to the instance. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, special characters, and digits. Special characters include: ! @ # $ % ^ & * ( ) _ + - =

The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: PostPaid.

The duration that you will buy KVStore DBInstance (in month). It is valid when payment_type is PrePaid. Valid values: [1~9], 12, 24, 36.

It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Private network connection port, used to modify the private network connection port.

Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.

The internal IP address of the instance.

Theoretical maximum QPS value.

The number of read replicas in the primary zone. Valid values: 1 to 9.

The ID of resource group which the resource belongs.

The point in time of a backup file.

The Specify the global resource descriptor ARN (Alibaba Cloud Resource Name) information of the role to be authorized, and use the related key management services after the authorization is completed, in the format: acs:ram::$accountID:role/$roleName.

The ID of the secondary zone to which you want to migrate the Tair (Redis OSS-Compatible) And Memcache (KVStore) Classic Instance.

The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.

The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.

The name of the whitelist group.

The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.

The number of data shards. This parameter is available only if you create a cluster instance that uses cloud disks. You can use this parameter to specify a custom number of data shards. NOTE: From version 1.216.0, shard_count can be modified.

The number of read replicas in the secondary zone. NOTE:: When you create a multi-zone read/write splitting instance, you must specify both secondary_zone_id and slave_read_only_count.

The ID of the source instance.

Modifies the SSL status. Valid values: Disable, Enable and Update. NOTE: This functionality is supported by Cluster mode (Redis 2.8, 4.0, 5.0) and Standard mode( Redis 2.8 only).

The status of KVStore DBInstance.

A mapping of tags to assign to the resource.

Specifies whether to enable TDE. Valid values: Enabled. NOTE:: TDE cannot be disabled after it is enabled. Before you enable it, evaluate whether this feature affects. your business. For more information, see Enable TDE.

Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Default value: Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.

The ID of VSwitch.

The ID of the zone.