Instance

Provides an ApsaraDB Redis / Memcache instance resource. A DB instance is an isolated database environment in the cloud. It support be associated with IP whitelists and backup configuration which are separate resource providers. For information about Alicloud KVStore DBInstance more and how to use it, see What is Resource Alicloud KVStore DBInstance.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AliCloud.KVStore.Instance("example", new AliCloud.KVStore.InstanceArgs
        {
            Config = 
            {
                { "appendonly", "yes" },
                { "lazyfree-lazy-eviction", "yes" },
            },
            DbInstanceName = "tf-test-basic",
            EngineVersion = "4.0",
            InstanceClass = "redis.master.large.default",
            InstanceType = "Redis",
            ResourceGroupId = "rg-123456",
            SecurityIps = 
            {
                "10.23.12.24",
            },
            Tags = 
            {
                { "Created", "TF" },
                { "For", "Test" },
            },
            VswitchId = "vsw-123456",
            ZoneId = "cn-beijing-h",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/kvstore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kvstore.NewInstance(ctx, "example", &kvstore.InstanceArgs{
			Config: pulumi.StringMap{
				"appendonly":             pulumi.String("yes"),
				"lazyfree-lazy-eviction": pulumi.String("yes"),
			},
			DbInstanceName:  pulumi.String("tf-test-basic"),
			EngineVersion:   pulumi.String("4.0"),
			InstanceClass:   pulumi.String("redis.master.large.default"),
			InstanceType:    pulumi.String("Redis"),
			ResourceGroupId: pulumi.String("rg-123456"),
			SecurityIps: pulumi.StringArray{
				pulumi.String("10.23.12.24"),
			},
			Tags: pulumi.StringMap{
				"Created": pulumi.String("TF"),
				"For":     pulumi.String("Test"),
			},
			VswitchId: pulumi.String("vsw-123456"),
			ZoneId:    pulumi.String("cn-beijing-h"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.kvstore.Instance("example",
    config={
        "appendonly": "yes",
        "lazyfree-lazy-eviction": "yes",
    },
    db_instance_name="tf-test-basic",
    engine_version="4.0",
    instance_class="redis.master.large.default",
    instance_type="Redis",
    resource_group_id="rg-123456",
    security_ips=["10.23.12.24"],
    tags={
        "Created": "TF",
        "For": "Test",
    },
    vswitch_id="vsw-123456",
    zone_id="cn-beijing-h")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.kvstore.Instance("example", {
    config: {
        appendonly: "yes",
        "lazyfree-lazy-eviction": "yes",
    },
    dbInstanceName: "tf-test-basic",
    engineVersion: "4.0",
    instanceClass: "redis.master.large.default",
    instanceType: "Redis",
    resourceGroupId: "rg-123456",
    securityIps: ["10.23.12.24"],
    tags: {
        Created: "TF",
        For: "Test",
    },
    vswitchId: "vsw-123456",
    zoneId: "cn-beijing-h",
});

Create a Instance Resource

new Instance(name: string, args?: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auto_renew: Optional[bool] = None,
             auto_renew_period: Optional[int] = None,
             auto_use_coupon: Optional[bool] = None,
             availability_zone: Optional[str] = None,
             backup_id: Optional[str] = None,
             backup_periods: Optional[Sequence[str]] = None,
             backup_time: Optional[str] = None,
             business_info: Optional[str] = None,
             capacity: Optional[int] = None,
             config: Optional[Mapping[str, Any]] = None,
             connection_string_prefix: Optional[str] = None,
             coupon_no: Optional[str] = None,
             db_instance_name: Optional[str] = None,
             dedicated_host_group_id: Optional[str] = None,
             enable_backup_log: Optional[int] = None,
             enable_public: Optional[bool] = None,
             engine_version: Optional[str] = None,
             force_upgrade: Optional[bool] = None,
             global_instance: Optional[bool] = None,
             global_instance_id: Optional[str] = None,
             instance_charge_type: Optional[str] = None,
             instance_class: Optional[str] = None,
             instance_name: Optional[str] = None,
             instance_release_protection: Optional[bool] = None,
             instance_type: Optional[str] = None,
             kms_encrypted_password: Optional[str] = None,
             kms_encryption_context: Optional[Mapping[str, Any]] = None,
             maintain_end_time: Optional[str] = None,
             maintain_start_time: Optional[str] = None,
             modify_mode: Optional[int] = None,
             node_type: Optional[str] = None,
             order_type: Optional[str] = None,
             parameters: Optional[Sequence[InstanceParameterArgs]] = None,
             password: Optional[str] = None,
             payment_type: Optional[str] = None,
             period: Optional[str] = None,
             port: Optional[int] = None,
             private_connection_prefix: Optional[str] = None,
             private_ip: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             restore_time: Optional[str] = None,
             security_group_id: Optional[str] = None,
             security_ip_group_attribute: Optional[str] = None,
             security_ip_group_name: Optional[str] = None,
             security_ips: Optional[Sequence[str]] = None,
             srcdb_instance_id: Optional[str] = None,
             ssl_enable: Optional[str] = None,
             tags: Optional[Mapping[str, Any]] = None,
             vpc_auth_mode: Optional[str] = None,
             vswitch_id: Optional[str] = None,
             zone_id: Optional[str] = None)
@overload
def Instance(resource_name: str,
             args: Optional[InstanceArgs] = None,
             opts: Optional[ResourceOptions] = None)
func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Instance resource accepts the following input properties:

AutoRenew bool
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
AutoRenewPeriod int
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
AutoUseCoupon bool
Specifies whether to use a coupon. Default to: false.
AvailabilityZone string
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

BackupId string
The ID of the backup file of the source instance.
BackupPeriods List<string>
Backup period.
BackupTime string
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
BusinessInfo string
The ID of the event or the business information.
Capacity int
The storage capacity of the KVStore DBInstance. Unit: MB.
Config Dictionary<string, object>
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
ConnectionStringPrefix string
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

CouponNo string
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
DbInstanceName string
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
DedicatedHostGroupId string
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
EnableBackupLog int
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
EnablePublic bool
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

EngineVersion string
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
ForceUpgrade bool
Specifies whether to forcibly change the type. Default to: true.
GlobalInstance bool
Whether to create a distributed cache. Default to: false.
GlobalInstanceId string
The ID of distributed cache.
InstanceChargeType string
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

InstanceReleaseProtection bool
Whether to open the release protection.
InstanceType string
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, object>
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.
MaintainEndTime string
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
ModifyMode int
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
NodeType string
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

OrderType string
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
Parameters List<Pulumi.AliCloud.KVStore.Inputs.InstanceParameterArgs>
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

Password string
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
PaymentType string
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
Period string
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.
Port int
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
PrivateConnectionPrefix string
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
PrivateIp string
The internal IP address of the instance.
ResourceGroupId string
The ID of resource group which the resource belongs.
RestoreTime string
The point in time of a backup file.
SecurityGroupId string
The ID of security groups.
SecurityIpGroupAttribute string
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.
SecurityIpGroupName string
The name of the whitelist group.
SecurityIps List<string>
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
SrcdbInstanceId string
The ID of the source instance.
SslEnable string
Modifies the SSL status. Valid values: Disable, Enable and Update.
Tags Dictionary<string, object>
A mapping of tags to assign to the resource.
VpcAuthMode string
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
VswitchId string
The ID of VSwitch.
ZoneId string
The ID of the zone.
AutoRenew bool
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
AutoRenewPeriod int
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
AutoUseCoupon bool
Specifies whether to use a coupon. Default to: false.
AvailabilityZone string
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

BackupId string
The ID of the backup file of the source instance.
BackupPeriods []string
Backup period.
BackupTime string
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
BusinessInfo string
The ID of the event or the business information.
Capacity int
The storage capacity of the KVStore DBInstance. Unit: MB.
Config map[string]interface{}
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
ConnectionStringPrefix string
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

CouponNo string
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
DbInstanceName string
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
DedicatedHostGroupId string
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
EnableBackupLog int
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
EnablePublic bool
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

EngineVersion string
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
ForceUpgrade bool
Specifies whether to forcibly change the type. Default to: true.
GlobalInstance bool
Whether to create a distributed cache. Default to: false.
GlobalInstanceId string
The ID of distributed cache.
InstanceChargeType string
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

InstanceReleaseProtection bool
Whether to open the release protection.
InstanceType string
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
KmsEncryptionContext map[string]interface{}
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.
MaintainEndTime string
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
ModifyMode int
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
NodeType string
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

OrderType string
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
Parameters []InstanceParameter
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

Password string
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
PaymentType string
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
Period string
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.
Port int
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
PrivateConnectionPrefix string
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
PrivateIp string
The internal IP address of the instance.
ResourceGroupId string
The ID of resource group which the resource belongs.
RestoreTime string
The point in time of a backup file.
SecurityGroupId string
The ID of security groups.
SecurityIpGroupAttribute string
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.
SecurityIpGroupName string
The name of the whitelist group.
SecurityIps []string
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
SrcdbInstanceId string
The ID of the source instance.
SslEnable string
Modifies the SSL status. Valid values: Disable, Enable and Update.
Tags map[string]interface{}
A mapping of tags to assign to the resource.
VpcAuthMode string
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
VswitchId string
The ID of VSwitch.
ZoneId string
The ID of the zone.
autoRenew boolean
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
autoRenewPeriod number
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
autoUseCoupon boolean
Specifies whether to use a coupon. Default to: false.
availabilityZone string
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

backupId string
The ID of the backup file of the source instance.
backupPeriods string[]
Backup period.
backupTime string
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
businessInfo string
The ID of the event or the business information.
capacity number
The storage capacity of the KVStore DBInstance. Unit: MB.
config {[key: string]: any}
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
connectionStringPrefix string
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

couponNo string
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
dbInstanceName string
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
dedicatedHostGroupId string
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
enableBackupLog number
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
enablePublic boolean
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

engineVersion string
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
forceUpgrade boolean
Specifies whether to forcibly change the type. Default to: true.
globalInstance boolean
Whether to create a distributed cache. Default to: false.
globalInstanceId string
The ID of distributed cache.
instanceChargeType string
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

instanceReleaseProtection boolean
Whether to open the release protection.
instanceType string
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
kmsEncryptedPassword string
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: any}
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.
maintainEndTime string
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
maintainStartTime string
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
modifyMode number
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
nodeType string
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

orderType string
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
parameters InstanceParameterArgs[]
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

password string
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
paymentType string
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
period string
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.
port number
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
privateConnectionPrefix string
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
privateIp string
The internal IP address of the instance.
resourceGroupId string
The ID of resource group which the resource belongs.
restoreTime string
The point in time of a backup file.
securityGroupId string
The ID of security groups.
securityIpGroupAttribute string
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.
securityIpGroupName string
The name of the whitelist group.
securityIps string[]
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
srcdbInstanceId string
The ID of the source instance.
sslEnable string
Modifies the SSL status. Valid values: Disable, Enable and Update.
tags {[key: string]: any}
A mapping of tags to assign to the resource.
vpcAuthMode string
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
vswitchId string
The ID of VSwitch.
zoneId string
The ID of the zone.
auto_renew bool
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
auto_renew_period int
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
auto_use_coupon bool
Specifies whether to use a coupon. Default to: false.
availability_zone str
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

backup_id str
The ID of the backup file of the source instance.
backup_periods Sequence[str]
Backup period.
backup_time str
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
business_info str
The ID of the event or the business information.
capacity int
The storage capacity of the KVStore DBInstance. Unit: MB.
config Mapping[str, Any]
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
connection_string_prefix str
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

coupon_no str
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
db_instance_name str
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
dedicated_host_group_id str
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
enable_backup_log int
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
enable_public bool
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

engine_version str
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
force_upgrade bool
Specifies whether to forcibly change the type. Default to: true.
global_instance bool
Whether to create a distributed cache. Default to: false.
global_instance_id str
The ID of distributed cache.
instance_charge_type str
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

instance_release_protection bool
Whether to open the release protection.
instance_type str
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
kms_encrypted_password str
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
kms_encryption_context Mapping[str, Any]
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.
maintain_end_time str
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
maintain_start_time str
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
modify_mode int
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
node_type str
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

order_type str
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
parameters Sequence[InstanceParameterArgs]
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

password str
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
payment_type str
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
period str
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.
port int
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
private_connection_prefix str
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
private_ip str
The internal IP address of the instance.
resource_group_id str
The ID of resource group which the resource belongs.
restore_time str
The point in time of a backup file.
security_group_id str
The ID of security groups.
security_ip_group_attribute str
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.
security_ip_group_name str
The name of the whitelist group.
security_ips Sequence[str]
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
srcdb_instance_id str
The ID of the source instance.
ssl_enable str
Modifies the SSL status. Valid values: Disable, Enable and Update.
tags Mapping[str, Any]
A mapping of tags to assign to the resource.
vpc_auth_mode str
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
vswitch_id str
The ID of VSwitch.
zone_id str
The ID of the zone.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

Bandwidth int
The bandwidth.
ConnectionDomain string
ConnectionString string

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

EndTime string
The expiration time of the prepaid instance.
Id string
The provider-assigned unique ID for this managed resource.
Qps int
Theoretical maximum QPS value.
Status string

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
Bandwidth int
The bandwidth.
ConnectionDomain string
ConnectionString string

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

EndTime string
The expiration time of the prepaid instance.
Id string
The provider-assigned unique ID for this managed resource.
Qps int
Theoretical maximum QPS value.
Status string

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
bandwidth number
The bandwidth.
connectionDomain string
connectionString string

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

endTime string
The expiration time of the prepaid instance.
id string
The provider-assigned unique ID for this managed resource.
qps number
Theoretical maximum QPS value.
status string

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
bandwidth int
The bandwidth.
connection_domain str
connection_string str

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

end_time str
The expiration time of the prepaid instance.
id str
The provider-assigned unique ID for this managed resource.
qps int
Theoretical maximum QPS value.
status str

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.

Look up an Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew: Optional[bool] = None,
        auto_renew_period: Optional[int] = None,
        auto_use_coupon: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        backup_id: Optional[str] = None,
        backup_periods: Optional[Sequence[str]] = None,
        backup_time: Optional[str] = None,
        bandwidth: Optional[int] = None,
        business_info: Optional[str] = None,
        capacity: Optional[int] = None,
        config: Optional[Mapping[str, Any]] = None,
        connection_domain: Optional[str] = None,
        connection_string: Optional[str] = None,
        connection_string_prefix: Optional[str] = None,
        coupon_no: Optional[str] = None,
        db_instance_name: Optional[str] = None,
        dedicated_host_group_id: Optional[str] = None,
        enable_backup_log: Optional[int] = None,
        enable_public: Optional[bool] = None,
        end_time: Optional[str] = None,
        engine_version: Optional[str] = None,
        force_upgrade: Optional[bool] = None,
        global_instance: Optional[bool] = None,
        global_instance_id: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        instance_class: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_release_protection: Optional[bool] = None,
        instance_type: Optional[str] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, Any]] = None,
        maintain_end_time: Optional[str] = None,
        maintain_start_time: Optional[str] = None,
        modify_mode: Optional[int] = None,
        node_type: Optional[str] = None,
        order_type: Optional[str] = None,
        parameters: Optional[Sequence[InstanceParameterArgs]] = None,
        password: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        port: Optional[int] = None,
        private_connection_prefix: Optional[str] = None,
        private_ip: Optional[str] = None,
        qps: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        restore_time: Optional[str] = None,
        security_group_id: Optional[str] = None,
        security_ip_group_attribute: Optional[str] = None,
        security_ip_group_name: Optional[str] = None,
        security_ips: Optional[Sequence[str]] = None,
        srcdb_instance_id: Optional[str] = None,
        ssl_enable: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        vpc_auth_mode: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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.

The following state arguments are supported:

AutoRenew bool
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
AutoRenewPeriod int
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
AutoUseCoupon bool
Specifies whether to use a coupon. Default to: false.
AvailabilityZone string
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

BackupId string
The ID of the backup file of the source instance.
BackupPeriods List<string>
Backup period.
BackupTime string
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
Bandwidth int
The bandwidth.
BusinessInfo string
The ID of the event or the business information.
Capacity int
The storage capacity of the KVStore DBInstance. Unit: MB.
Config Dictionary<string, object>
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
ConnectionDomain string
ConnectionString string

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

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

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

CouponNo string
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
DbInstanceName string
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
DedicatedHostGroupId string
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
EnableBackupLog int
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
EnablePublic bool
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

EndTime string
The expiration time of the prepaid instance.
EngineVersion string
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
ForceUpgrade bool
Specifies whether to forcibly change the type. Default to: true.
GlobalInstance bool
Whether to create a distributed cache. Default to: false.
GlobalInstanceId string
The ID of distributed cache.
InstanceChargeType string
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

InstanceReleaseProtection bool
Whether to open the release protection.
InstanceType string
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, object>
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.
MaintainEndTime string
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
ModifyMode int
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
NodeType string
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

OrderType string
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
Parameters List<Pulumi.AliCloud.KVStore.Inputs.InstanceParameterArgs>
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

Password string
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
PaymentType string
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
Period string
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.
Port int
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
PrivateConnectionPrefix string
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
PrivateIp string
The internal IP address of the instance.
Qps int
Theoretical maximum QPS value.
ResourceGroupId string
The ID of resource group which the resource belongs.
RestoreTime string
The point in time of a backup file.
SecurityGroupId string
The ID of security groups.
SecurityIpGroupAttribute string
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.
SecurityIpGroupName string
The name of the whitelist group.
SecurityIps List<string>
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
SrcdbInstanceId string
The ID of the source instance.
SslEnable string
Modifies the SSL status. Valid values: Disable, Enable and Update.
Status string

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
Tags Dictionary<string, object>
A mapping of tags to assign to the resource.
VpcAuthMode string
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
VswitchId string
The ID of VSwitch.
ZoneId string
The ID of the zone.
AutoRenew bool
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
AutoRenewPeriod int
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
AutoUseCoupon bool
Specifies whether to use a coupon. Default to: false.
AvailabilityZone string
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

BackupId string
The ID of the backup file of the source instance.
BackupPeriods []string
Backup period.
BackupTime string
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
Bandwidth int
The bandwidth.
BusinessInfo string
The ID of the event or the business information.
Capacity int
The storage capacity of the KVStore DBInstance. Unit: MB.
Config map[string]interface{}
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
ConnectionDomain string
ConnectionString string

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

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

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

CouponNo string
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
DbInstanceName string
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
DedicatedHostGroupId string
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
EnableBackupLog int
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
EnablePublic bool
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

EndTime string
The expiration time of the prepaid instance.
EngineVersion string
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
ForceUpgrade bool
Specifies whether to forcibly change the type. Default to: true.
GlobalInstance bool
Whether to create a distributed cache. Default to: false.
GlobalInstanceId string
The ID of distributed cache.
InstanceChargeType string
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

InstanceReleaseProtection bool
Whether to open the release protection.
InstanceType string
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
KmsEncryptionContext map[string]interface{}
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.
MaintainEndTime string
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
ModifyMode int
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
NodeType string
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

OrderType string
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
Parameters []InstanceParameter
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

Password string
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
PaymentType string
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
Period string
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.
Port int
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
PrivateConnectionPrefix string
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
PrivateIp string
The internal IP address of the instance.
Qps int
Theoretical maximum QPS value.
ResourceGroupId string
The ID of resource group which the resource belongs.
RestoreTime string
The point in time of a backup file.
SecurityGroupId string
The ID of security groups.
SecurityIpGroupAttribute string
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.
SecurityIpGroupName string
The name of the whitelist group.
SecurityIps []string
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
SrcdbInstanceId string
The ID of the source instance.
SslEnable string
Modifies the SSL status. Valid values: Disable, Enable and Update.
Status string

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
Tags map[string]interface{}
A mapping of tags to assign to the resource.
VpcAuthMode string
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
VswitchId string
The ID of VSwitch.
ZoneId string
The ID of the zone.
autoRenew boolean
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
autoRenewPeriod number
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
autoUseCoupon boolean
Specifies whether to use a coupon. Default to: false.
availabilityZone string
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

backupId string
The ID of the backup file of the source instance.
backupPeriods string[]
Backup period.
backupTime string
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
bandwidth number
The bandwidth.
businessInfo string
The ID of the event or the business information.
capacity number
The storage capacity of the KVStore DBInstance. Unit: MB.
config {[key: string]: any}
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
connectionDomain string
connectionString string

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

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

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

couponNo string
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
dbInstanceName string
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
dedicatedHostGroupId string
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
enableBackupLog number
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
enablePublic boolean
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

endTime string
The expiration time of the prepaid instance.
engineVersion string
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
forceUpgrade boolean
Specifies whether to forcibly change the type. Default to: true.
globalInstance boolean
Whether to create a distributed cache. Default to: false.
globalInstanceId string
The ID of distributed cache.
instanceChargeType string
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

instanceReleaseProtection boolean
Whether to open the release protection.
instanceType string
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
kmsEncryptedPassword string
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: any}
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.
maintainEndTime string
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
maintainStartTime string
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
modifyMode number
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
nodeType string
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

orderType string
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
parameters InstanceParameterArgs[]
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

password string
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
paymentType string
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
period string
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.
port number
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
privateConnectionPrefix string
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
privateIp string
The internal IP address of the instance.
qps number
Theoretical maximum QPS value.
resourceGroupId string
The ID of resource group which the resource belongs.
restoreTime string
The point in time of a backup file.
securityGroupId string
The ID of security groups.
securityIpGroupAttribute string
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.
securityIpGroupName string
The name of the whitelist group.
securityIps string[]
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
srcdbInstanceId string
The ID of the source instance.
sslEnable string
Modifies the SSL status. Valid values: Disable, Enable and Update.
status string

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
tags {[key: string]: any}
A mapping of tags to assign to the resource.
vpcAuthMode string
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
vswitchId string
The ID of VSwitch.
zoneId string
The ID of the zone.
auto_renew bool
Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default to false.
auto_renew_period int
Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid value: [1~12], Default to 1.
auto_use_coupon bool
Specifies whether to use a coupon. Default to: false.
availability_zone str
It has been deprecated from provider version 1.101.0 and zone_id instead.

Deprecated: Field ‘availability_zone’ has been deprecated from version 1.101.0. Use ‘zone_id’ instead.

backup_id str
The ID of the backup file of the source instance.
backup_periods Sequence[str]
Backup period.
backup_time str
Backup time, the format is HH:mmZ-HH:mmZ (UTC time).
bandwidth int
The bandwidth.
business_info str
The ID of the event or the business information.
capacity int
The storage capacity of the KVStore DBInstance. Unit: MB.
config Mapping[str, Any]
The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table .
connection_domain str
connection_string str

Deprecated: Field ‘connection_string’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

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

Deprecated: Field ‘connection_string_prefix’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

coupon_no str
The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.
db_instance_name str
The name of KVStore DBInstance. It is a string of 2 to 256 characters.
dedicated_host_group_id str
The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.
enable_backup_log int
Turn on or off incremental backup. Valid values: 1, 0. Default to 0
enable_public bool
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Deprecated: Field ‘enable_public’ has been deprecated from version 1.101.0. Please use resource ‘alicloud_kvstore_connection’ instead.

end_time str
The expiration time of the prepaid instance.
engine_version str
The engine version of the KVStore DBInstance. Valid values: 2.8, 4.0 and 5.0. Default to 5.0.
force_upgrade bool
Specifies whether to forcibly change the type. Default to: true.
global_instance bool
Whether to create a distributed cache. Default to: false.
global_instance_id str
The ID of distributed cache.
instance_charge_type str
It has been deprecated from provider version 1.101.0 and payment_type instead.

Deprecated: Field ‘instance_charge_type’ has been deprecated from version 1.101.0. Use ‘payment_type’ instead.

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

Deprecated: Field ‘instance_name’ has been deprecated from version 1.101.0. Use ‘db_instance_name’ instead.

instance_release_protection bool
Whether to open the release protection.
instance_type str
The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.
kms_encrypted_password str
An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
kms_encryption_context Mapping[str, Any]
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.
maintain_end_time str
The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
maintain_start_time str
The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).
modify_mode int
The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.
node_type str
“Field ‘node_type’ has been deprecated from version 1.120.1”. This parameter is determined by the instance_class.

Deprecated: Field ‘node_type’ has been deprecated from version 1.120.1

order_type str
Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default to UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
parameters Sequence[InstanceParameterArgs]
It has been deprecated from provider version 1.101.0 and config instead..

Deprecated: Field ‘parameters’ has been deprecated from version 1.101.0. Use ‘config’ instead.

password str
The password of the KVStore DBInstance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
payment_type str
The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default to PostPaid.
period str
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.
port int
It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
private_connection_prefix str
Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.
private_ip str
The internal IP address of the instance.
qps int
Theoretical maximum QPS value.
resource_group_id str
The ID of resource group which the resource belongs.
restore_time str
The point in time of a backup file.
security_group_id str
The ID of security groups.
security_ip_group_attribute str
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.
security_ip_group_name str
The name of the whitelist group.
security_ips Sequence[str]
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.
srcdb_instance_id str
The ID of the source instance.
ssl_enable str
Modifies the SSL status. Valid values: Disable, Enable and Update.
status str

The status of KVStore DBInstance.

  • connection_domain- Intranet connection address of the KVStore instance.
tags Mapping[str, Any]
A mapping of tags to assign to the resource.
vpc_auth_mode str
Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Defaults to Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.
vswitch_id str
The ID of VSwitch.
zone_id str
The ID of the zone.

Supporting Types

InstanceParameter

Name string
Value string
Name string
Value string
name string
value string
name str
value str

Import

KVStore instance can be imported using the id, e.g.

 $ pulumi import alicloud:kvstore/instance:Instance example r-abc12345678

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.