Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. kvstore
  5. Instance
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.kvstore.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

    Import

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

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

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args?: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: Optional[InstanceArgs] = None,
             opts: Optional[ResourceOptions] = None)

@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, 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,
             dry_run: Optional[bool] = None,
             effective_time: Optional[str] = None,
             enable_backup_log: Optional[int] = None,
             enable_public: Optional[bool] = None,
             encryption_key: Optional[str] = None,
             encryption_name: 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,
             is_auto_upgrade_open: Optional[str] = None,
             kms_encrypted_password: Optional[str] = None,
             kms_encryption_context: Optional[Mapping[str, str]] = None,
             maintain_end_time: Optional[str] = None,
             maintain_start_time: Optional[str] = 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_port: Optional[str] = None,
             private_connection_prefix: Optional[str] = None,
             private_ip: Optional[str] = None,
             read_only_count: Optional[int] = None,
             resource_group_id: Optional[str] = None,
             restore_time: Optional[str] = None,
             role_arn: Optional[str] = None,
             secondary_zone_id: 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,
             shard_count: Optional[int] = None,
             slave_read_only_count: Optional[int] = None,
             srcdb_instance_id: Optional[str] = None,
             ssl_enable: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             tde_status: Optional[str] = None,
             vpc_auth_mode: Optional[str] = None,
             vswitch_id: Optional[str] = None,
             zone_id: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: alicloud:kvstore:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    name String
    The unique name of the resource.
    args InstanceArgs
    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 exampleinstanceResourceResourceFromKvstoreinstance = new AliCloud.KVStore.Instance("exampleinstanceResourceResourceFromKvstoreinstance", new()
{
    AutoRenew = false,
    AutoRenewPeriod = 0,
    AutoUseCoupon = false,
    BackupId = "string",
    BackupPeriods = new[]
    {
        "string",
    },
    BackupTime = "string",
    BusinessInfo = "string",
    Capacity = 0,
    Config = 
    {
        { "string", "string" },
    },
    CouponNo = "string",
    DbInstanceName = "string",
    DedicatedHostGroupId = "string",
    DryRun = false,
    EffectiveTime = "string",
    EnableBackupLog = 0,
    EncryptionKey = "string",
    EncryptionName = "string",
    EngineVersion = "string",
    ForceUpgrade = false,
    GlobalInstance = false,
    GlobalInstanceId = "string",
    InstanceClass = "string",
    InstanceReleaseProtection = false,
    InstanceType = "string",
    IsAutoUpgradeOpen = "string",
    KmsEncryptedPassword = "string",
    KmsEncryptionContext = 
    {
        { "string", "string" },
    },
    MaintainEndTime = "string",
    MaintainStartTime = "string",
    OrderType = "string",
    Password = "string",
    PaymentType = "string",
    Period = "string",
    Port = 0,
    PrivateConnectionPort = "string",
    PrivateConnectionPrefix = "string",
    PrivateIp = "string",
    ReadOnlyCount = 0,
    ResourceGroupId = "string",
    RestoreTime = "string",
    RoleArn = "string",
    SecondaryZoneId = "string",
    SecurityGroupId = "string",
    SecurityIpGroupAttribute = "string",
    SecurityIpGroupName = "string",
    SecurityIps = new[]
    {
        "string",
    },
    ShardCount = 0,
    SlaveReadOnlyCount = 0,
    SrcdbInstanceId = "string",
    SslEnable = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TdeStatus = "string",
    VpcAuthMode = "string",
    VswitchId = "string",
    ZoneId = "string",
});

    example, err := kvstore.NewInstance(ctx, "exampleinstanceResourceResourceFromKvstoreinstance", &kvstore.InstanceArgs{
	AutoRenew:       pulumi.Bool(false),
	AutoRenewPeriod: pulumi.Int(0),
	AutoUseCoupon:   pulumi.Bool(false),
	BackupId:        pulumi.String("string"),
	BackupPeriods: pulumi.StringArray{
		pulumi.String("string"),
	},
	BackupTime:   pulumi.String("string"),
	BusinessInfo: pulumi.String("string"),
	Capacity:     pulumi.Int(0),
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CouponNo:                  pulumi.String("string"),
	DbInstanceName:            pulumi.String("string"),
	DedicatedHostGroupId:      pulumi.String("string"),
	DryRun:                    pulumi.Bool(false),
	EffectiveTime:             pulumi.String("string"),
	EnableBackupLog:           pulumi.Int(0),
	EncryptionKey:             pulumi.String("string"),
	EncryptionName:            pulumi.String("string"),
	EngineVersion:             pulumi.String("string"),
	ForceUpgrade:              pulumi.Bool(false),
	GlobalInstance:            pulumi.Bool(false),
	GlobalInstanceId:          pulumi.String("string"),
	InstanceClass:             pulumi.String("string"),
	InstanceReleaseProtection: pulumi.Bool(false),
	InstanceType:              pulumi.String("string"),
	IsAutoUpgradeOpen:         pulumi.String("string"),
	KmsEncryptedPassword:      pulumi.String("string"),
	KmsEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	MaintainEndTime:          pulumi.String("string"),
	MaintainStartTime:        pulumi.String("string"),
	OrderType:                pulumi.String("string"),
	Password:                 pulumi.String("string"),
	PaymentType:              pulumi.String("string"),
	Period:                   pulumi.String("string"),
	Port:                     pulumi.Int(0),
	PrivateConnectionPort:    pulumi.String("string"),
	PrivateConnectionPrefix:  pulumi.String("string"),
	PrivateIp:                pulumi.String("string"),
	ReadOnlyCount:            pulumi.Int(0),
	ResourceGroupId:          pulumi.String("string"),
	RestoreTime:              pulumi.String("string"),
	RoleArn:                  pulumi.String("string"),
	SecondaryZoneId:          pulumi.String("string"),
	SecurityGroupId:          pulumi.String("string"),
	SecurityIpGroupAttribute: pulumi.String("string"),
	SecurityIpGroupName:      pulumi.String("string"),
	SecurityIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	ShardCount:         pulumi.Int(0),
	SlaveReadOnlyCount: pulumi.Int(0),
	SrcdbInstanceId:    pulumi.String("string"),
	SslEnable:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TdeStatus:   pulumi.String("string"),
	VpcAuthMode: pulumi.String("string"),
	VswitchId:   pulumi.String("string"),
	ZoneId:      pulumi.String("string"),
})

    var exampleinstanceResourceResourceFromKvstoreinstance = new Instance("exampleinstanceResourceResourceFromKvstoreinstance", InstanceArgs.builder()
    .autoRenew(false)
    .autoRenewPeriod(0)
    .autoUseCoupon(false)
    .backupId("string")
    .backupPeriods("string")
    .backupTime("string")
    .businessInfo("string")
    .capacity(0)
    .config(Map.of("string", "string"))
    .couponNo("string")
    .dbInstanceName("string")
    .dedicatedHostGroupId("string")
    .dryRun(false)
    .effectiveTime("string")
    .enableBackupLog(0)
    .encryptionKey("string")
    .encryptionName("string")
    .engineVersion("string")
    .forceUpgrade(false)
    .globalInstance(false)
    .globalInstanceId("string")
    .instanceClass("string")
    .instanceReleaseProtection(false)
    .instanceType("string")
    .isAutoUpgradeOpen("string")
    .kmsEncryptedPassword("string")
    .kmsEncryptionContext(Map.of("string", "string"))
    .maintainEndTime("string")
    .maintainStartTime("string")
    .orderType("string")
    .password("string")
    .paymentType("string")
    .period("string")
    .port(0)
    .privateConnectionPort("string")
    .privateConnectionPrefix("string")
    .privateIp("string")
    .readOnlyCount(0)
    .resourceGroupId("string")
    .restoreTime("string")
    .roleArn("string")
    .secondaryZoneId("string")
    .securityGroupId("string")
    .securityIpGroupAttribute("string")
    .securityIpGroupName("string")
    .securityIps("string")
    .shardCount(0)
    .slaveReadOnlyCount(0)
    .srcdbInstanceId("string")
    .sslEnable("string")
    .tags(Map.of("string", "string"))
    .tdeStatus("string")
    .vpcAuthMode("string")
    .vswitchId("string")
    .zoneId("string")
    .build());

    exampleinstance_resource_resource_from_kvstoreinstance = alicloud.kvstore.Instance("exampleinstanceResourceResourceFromKvstoreinstance",
    auto_renew=False,
    auto_renew_period=0,
    auto_use_coupon=False,
    backup_id="string",
    backup_periods=["string"],
    backup_time="string",
    business_info="string",
    capacity=0,
    config={
        "string": "string",
    },
    coupon_no="string",
    db_instance_name="string",
    dedicated_host_group_id="string",
    dry_run=False,
    effective_time="string",
    enable_backup_log=0,
    encryption_key="string",
    encryption_name="string",
    engine_version="string",
    force_upgrade=False,
    global_instance=False,
    global_instance_id="string",
    instance_class="string",
    instance_release_protection=False,
    instance_type="string",
    is_auto_upgrade_open="string",
    kms_encrypted_password="string",
    kms_encryption_context={
        "string": "string",
    },
    maintain_end_time="string",
    maintain_start_time="string",
    order_type="string",
    password="string",
    payment_type="string",
    period="string",
    port=0,
    private_connection_port="string",
    private_connection_prefix="string",
    private_ip="string",
    read_only_count=0,
    resource_group_id="string",
    restore_time="string",
    role_arn="string",
    secondary_zone_id="string",
    security_group_id="string",
    security_ip_group_attribute="string",
    security_ip_group_name="string",
    security_ips=["string"],
    shard_count=0,
    slave_read_only_count=0,
    srcdb_instance_id="string",
    ssl_enable="string",
    tags={
        "string": "string",
    },
    tde_status="string",
    vpc_auth_mode="string",
    vswitch_id="string",
    zone_id="string")

    const exampleinstanceResourceResourceFromKvstoreinstance = new alicloud.kvstore.Instance("exampleinstanceResourceResourceFromKvstoreinstance", {
    autoRenew: false,
    autoRenewPeriod: 0,
    autoUseCoupon: false,
    backupId: "string",
    backupPeriods: ["string"],
    backupTime: "string",
    businessInfo: "string",
    capacity: 0,
    config: {
        string: "string",
    },
    couponNo: "string",
    dbInstanceName: "string",
    dedicatedHostGroupId: "string",
    dryRun: false,
    effectiveTime: "string",
    enableBackupLog: 0,
    encryptionKey: "string",
    encryptionName: "string",
    engineVersion: "string",
    forceUpgrade: false,
    globalInstance: false,
    globalInstanceId: "string",
    instanceClass: "string",
    instanceReleaseProtection: false,
    instanceType: "string",
    isAutoUpgradeOpen: "string",
    kmsEncryptedPassword: "string",
    kmsEncryptionContext: {
        string: "string",
    },
    maintainEndTime: "string",
    maintainStartTime: "string",
    orderType: "string",
    password: "string",
    paymentType: "string",
    period: "string",
    port: 0,
    privateConnectionPort: "string",
    privateConnectionPrefix: "string",
    privateIp: "string",
    readOnlyCount: 0,
    resourceGroupId: "string",
    restoreTime: "string",
    roleArn: "string",
    secondaryZoneId: "string",
    securityGroupId: "string",
    securityIpGroupAttribute: "string",
    securityIpGroupName: "string",
    securityIps: ["string"],
    shardCount: 0,
    slaveReadOnlyCount: 0,
    srcdbInstanceId: "string",
    sslEnable: "string",
    tags: {
        string: "string",
    },
    tdeStatus: "string",
    vpcAuthMode: "string",
    vswitchId: "string",
    zoneId: "string",
});

    type: alicloud:kvstore:Instance
properties:
    autoRenew: false
    autoRenewPeriod: 0
    autoUseCoupon: false
    backupId: string
    backupPeriods:
        - string
    backupTime: string
    businessInfo: string
    capacity: 0
    config:
        string: string
    couponNo: string
    dbInstanceName: string
    dedicatedHostGroupId: string
    dryRun: false
    effectiveTime: string
    enableBackupLog: 0
    encryptionKey: string
    encryptionName: string
    engineVersion: string
    forceUpgrade: false
    globalInstance: false
    globalInstanceId: string
    instanceClass: string
    instanceReleaseProtection: false
    instanceType: string
    isAutoUpgradeOpen: string
    kmsEncryptedPassword: string
    kmsEncryptionContext:
        string: string
    maintainEndTime: string
    maintainStartTime: string
    orderType: string
    password: string
    paymentType: string
    period: string
    port: 0
    privateConnectionPort: string
    privateConnectionPrefix: string
    privateIp: string
    readOnlyCount: 0
    resourceGroupId: string
    restoreTime: string
    roleArn: string
    secondaryZoneId: string
    securityGroupId: string
    securityIpGroupAttribute: string
    securityIpGroupName: string
    securityIps:
        - string
    shardCount: 0
    slaveReadOnlyCount: 0
    srcdbInstanceId: string
    sslEnable: string
    tags:
        string: string
    tdeStatus: string
    vpcAuthMode: string
    vswitchId: string
    zoneId: string

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts 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 value: 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 values: [1~12]. Default value: 1.
    AutoUseCoupon bool
    Specifies whether to use a coupon. Default value: 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, string>
    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. 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.
    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.
    DryRun bool
    Specifies whether to precheck the request. Valid values:
    EffectiveTime string
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    EnableBackupLog int
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    EncryptionKey string
    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.
    EncryptionName string
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    EngineVersion string
    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".
    ForceUpgrade bool
    Specifies whether to forcibly change the type. Default value: true.
    GlobalInstance bool
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    IsAutoUpgradeOpen string
    Specifies whether to enable automatic minor version update. Valid values:
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    KmsEncryptionContext Dictionary<string, string>
    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).
    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 value: 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.InstanceParameter>
    It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

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

    Password string
    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: ! @ # $ % ^ & * ( ) _ + - =
    PaymentType string
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    PrivateConnectionPort string
    Private network connection port, used to modify the private network connection port.
    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.
    ReadOnlyCount int
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    ResourceGroupId string
    The ID of resource group which the resource belongs.
    RestoreTime string
    The point in time of a backup file.
    RoleArn string
    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.
    SecondaryZoneId string

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    SecurityGroupId string
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    ShardCount int
    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.
    SlaveReadOnlyCount int

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    SrcdbInstanceId string
    The ID of the source instance.
    SslEnable string
    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).
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TdeStatus string
    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.
    VpcAuthMode string
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    AutoUseCoupon bool
    Specifies whether to use a coupon. Default value: 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]string
    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. 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.
    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.
    DryRun bool
    Specifies whether to precheck the request. Valid values:
    EffectiveTime string
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    EnableBackupLog int
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    EncryptionKey string
    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.
    EncryptionName string
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    EngineVersion string
    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".
    ForceUpgrade bool
    Specifies whether to forcibly change the type. Default value: true.
    GlobalInstance bool
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    IsAutoUpgradeOpen string
    Specifies whether to enable automatic minor version update. Valid values:
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    KmsEncryptionContext map[string]string
    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).
    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 value: 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. See parameters below.

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

    Password string
    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: ! @ # $ % ^ & * ( ) _ + - =
    PaymentType string
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    PrivateConnectionPort string
    Private network connection port, used to modify the private network connection port.
    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.
    ReadOnlyCount int
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    ResourceGroupId string
    The ID of resource group which the resource belongs.
    RestoreTime string
    The point in time of a backup file.
    RoleArn string
    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.
    SecondaryZoneId string

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    SecurityGroupId string
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    ShardCount int
    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.
    SlaveReadOnlyCount int

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    SrcdbInstanceId string
    The ID of the source instance.
    SslEnable string
    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).
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TdeStatus string
    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.
    VpcAuthMode string
    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.
    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 value: false.
    autoRenewPeriod Integer
    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.
    autoUseCoupon Boolean
    Specifies whether to use a coupon. Default value: 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 Integer
    The storage capacity of the KVStore DBInstance. Unit: MB.
    config Map<String,String>
    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. 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.
    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.
    dryRun Boolean
    Specifies whether to precheck the request. Valid values:
    effectiveTime String
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enableBackupLog Integer
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryptionKey String
    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.
    encryptionName String
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    engineVersion String
    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".
    forceUpgrade Boolean
    Specifies whether to forcibly change the type. Default value: true.
    globalInstance Boolean
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    isAutoUpgradeOpen String
    Specifies whether to enable automatic minor version update. Valid values:
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kmsEncryptionContext Map<String,String>
    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).
    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 value: UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
    parameters List<InstanceParameter>
    It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

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

    password String
    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: ! @ # $ % ^ & * ( ) _ + - =
    paymentType String
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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 Integer
    It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
    privateConnectionPort String
    Private network connection port, used to modify the private network connection port.
    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.
    readOnlyCount Integer
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resourceGroupId String
    The ID of resource group which the resource belongs.
    restoreTime String
    The point in time of a backup file.
    roleArn String
    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.
    secondaryZoneId String

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    securityGroupId String
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shardCount Integer
    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.
    slaveReadOnlyCount Integer

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdbInstanceId String
    The ID of the source instance.
    sslEnable String
    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).
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tdeStatus String
    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.
    vpcAuthMode String
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    autoUseCoupon boolean
    Specifies whether to use a coupon. Default value: 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]: string}
    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. 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.
    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.
    dryRun boolean
    Specifies whether to precheck the request. Valid values:
    effectiveTime string
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enableBackupLog number
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryptionKey string
    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.
    encryptionName string
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    engineVersion string
    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".
    forceUpgrade boolean
    Specifies whether to forcibly change the type. Default value: true.
    globalInstance boolean
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    isAutoUpgradeOpen string
    Specifies whether to enable automatic minor version update. Valid values:
    kmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kmsEncryptionContext {[key: string]: string}
    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).
    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 value: 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. See parameters below.

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

    password string
    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: ! @ # $ % ^ & * ( ) _ + - =
    paymentType string
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    privateConnectionPort string
    Private network connection port, used to modify the private network connection port.
    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.
    readOnlyCount number
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resourceGroupId string
    The ID of resource group which the resource belongs.
    restoreTime string
    The point in time of a backup file.
    roleArn string
    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.
    secondaryZoneId string

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    securityGroupId string
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shardCount number
    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.
    slaveReadOnlyCount number

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdbInstanceId string
    The ID of the source instance.
    sslEnable string
    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).
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tdeStatus string
    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.
    vpcAuthMode string
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    auto_use_coupon bool
    Specifies whether to use a coupon. Default value: 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, str]
    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. 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.
    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.
    dry_run bool
    Specifies whether to precheck the request. Valid values:
    effective_time str
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enable_backup_log int
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryption_key str
    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.
    encryption_name str
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    engine_version str
    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".
    force_upgrade bool
    Specifies whether to forcibly change the type. Default value: true.
    global_instance bool
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    is_auto_upgrade_open str
    Specifies whether to enable automatic minor version update. Valid values:
    kms_encrypted_password str
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kms_encryption_context Mapping[str, str]
    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).
    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 value: 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. See parameters below.

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

    password str
    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: ! @ # $ % ^ & * ( ) _ + - =
    payment_type str
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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_port str
    Private network connection port, used to modify the private network connection port.
    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.
    read_only_count int
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resource_group_id str
    The ID of resource group which the resource belongs.
    restore_time str
    The point in time of a backup file.
    role_arn str
    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.
    secondary_zone_id str

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    security_group_id str
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shard_count int
    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.
    slave_read_only_count int

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdb_instance_id str
    The ID of the source instance.
    ssl_enable str
    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).
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tde_status str
    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.
    vpc_auth_mode str
    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.
    vswitch_id str
    The ID of VSwitch.
    zone_id str
    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 value: 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 values: [1~12]. Default value: 1.
    autoUseCoupon Boolean
    Specifies whether to use a coupon. Default value: 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 Number
    The storage capacity of the KVStore DBInstance. Unit: MB.
    config Map<String>
    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. 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.
    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.
    dryRun Boolean
    Specifies whether to precheck the request. Valid values:
    effectiveTime String
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enableBackupLog Number
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryptionKey String
    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.
    encryptionName String
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    engineVersion String
    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".
    forceUpgrade Boolean
    Specifies whether to forcibly change the type. Default value: true.
    globalInstance Boolean
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    isAutoUpgradeOpen String
    Specifies whether to enable automatic minor version update. Valid values:
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kmsEncryptionContext Map<String>
    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).
    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 value: UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
    parameters List<Property Map>
    It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

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

    password String
    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: ! @ # $ % ^ & * ( ) _ + - =
    paymentType String
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    privateConnectionPort String
    Private network connection port, used to modify the private network connection port.
    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.
    readOnlyCount Number
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resourceGroupId String
    The ID of resource group which the resource belongs.
    restoreTime String
    The point in time of a backup file.
    roleArn String
    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.
    secondaryZoneId String

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    securityGroupId String
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shardCount Number
    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.
    slaveReadOnlyCount Number

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdbInstanceId String
    The ID of the source instance.
    sslEnable String
    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).
    tags Map<String>
    A mapping of tags to assign to the resource.
    tdeStatus String
    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.
    vpcAuthMode String
    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.
    vswitchId String
    The ID of VSwitch.
    zoneId String
    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
    Intranet connection address of the KVStore instance.
    ConnectionString string
    Indicates whether the address is a private endpoint.

    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.
    Bandwidth int
    The bandwidth.
    ConnectionDomain string
    Intranet connection address of the KVStore instance.
    ConnectionString string
    Indicates whether the address is a private endpoint.

    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.
    bandwidth Integer
    The bandwidth.
    connectionDomain String
    Intranet connection address of the KVStore instance.
    connectionString String
    Indicates whether the address is a private endpoint.

    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 Integer
    Theoretical maximum QPS value.
    status String
    The status of KVStore DBInstance.
    bandwidth number
    The bandwidth.
    connectionDomain string
    Intranet connection address of the KVStore instance.
    connectionString string
    Indicates whether the address is a private endpoint.

    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.
    bandwidth int
    The bandwidth.
    connection_domain str
    Intranet connection address of the KVStore instance.
    connection_string str
    Indicates whether the address is a private endpoint.

    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.
    bandwidth Number
    The bandwidth.
    connectionDomain String
    Intranet connection address of the KVStore instance.
    connectionString String
    Indicates whether the address is a private endpoint.

    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.

    Look up 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, str]] = 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,
        dry_run: Optional[bool] = None,
        effective_time: Optional[str] = None,
        enable_backup_log: Optional[int] = None,
        enable_public: Optional[bool] = None,
        encryption_key: Optional[str] = None,
        encryption_name: Optional[str] = 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,
        is_auto_upgrade_open: Optional[str] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, str]] = None,
        maintain_end_time: Optional[str] = None,
        maintain_start_time: Optional[str] = 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_port: Optional[str] = None,
        private_connection_prefix: Optional[str] = None,
        private_ip: Optional[str] = None,
        qps: Optional[int] = None,
        read_only_count: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        restore_time: Optional[str] = None,
        role_arn: Optional[str] = None,
        secondary_zone_id: 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,
        shard_count: Optional[int] = None,
        slave_read_only_count: Optional[int] = None,
        srcdb_instance_id: Optional[str] = None,
        ssl_enable: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tde_status: Optional[str] = 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)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    AutoUseCoupon bool
    Specifies whether to use a coupon. Default value: 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, string>
    The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.
    ConnectionDomain string
    Intranet connection address of the KVStore instance.
    ConnectionString string
    Indicates whether the address is a private endpoint.

    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. 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.
    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.
    DryRun bool
    Specifies whether to precheck the request. Valid values:
    EffectiveTime string
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    EnableBackupLog int
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    EncryptionKey string
    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.
    EncryptionName string
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    EndTime string
    The expiration time of the prepaid instance.
    EngineVersion string
    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".
    ForceUpgrade bool
    Specifies whether to forcibly change the type. Default value: true.
    GlobalInstance bool
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    IsAutoUpgradeOpen string
    Specifies whether to enable automatic minor version update. Valid values:
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    KmsEncryptionContext Dictionary<string, string>
    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).
    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 value: 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.InstanceParameter>
    It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

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

    Password string
    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: ! @ # $ % ^ & * ( ) _ + - =
    PaymentType string
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    PrivateConnectionPort string
    Private network connection port, used to modify the private network connection port.
    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.
    ReadOnlyCount int
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    ResourceGroupId string
    The ID of resource group which the resource belongs.
    RestoreTime string
    The point in time of a backup file.
    RoleArn string
    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.
    SecondaryZoneId string

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    SecurityGroupId string
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    ShardCount int
    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.
    SlaveReadOnlyCount int

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    SrcdbInstanceId string
    The ID of the source instance.
    SslEnable string
    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).
    Status string
    The status of KVStore DBInstance.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TdeStatus string
    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.
    VpcAuthMode string
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    AutoUseCoupon bool
    Specifies whether to use a coupon. Default value: 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]string
    The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.
    ConnectionDomain string
    Intranet connection address of the KVStore instance.
    ConnectionString string
    Indicates whether the address is a private endpoint.

    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. 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.
    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.
    DryRun bool
    Specifies whether to precheck the request. Valid values:
    EffectiveTime string
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    EnableBackupLog int
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    EncryptionKey string
    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.
    EncryptionName string
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    EndTime string
    The expiration time of the prepaid instance.
    EngineVersion string
    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".
    ForceUpgrade bool
    Specifies whether to forcibly change the type. Default value: true.
    GlobalInstance bool
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    IsAutoUpgradeOpen string
    Specifies whether to enable automatic minor version update. Valid values:
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    KmsEncryptionContext map[string]string
    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).
    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 value: 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. See parameters below.

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

    Password string
    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: ! @ # $ % ^ & * ( ) _ + - =
    PaymentType string
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    PrivateConnectionPort string
    Private network connection port, used to modify the private network connection port.
    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.
    ReadOnlyCount int
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    ResourceGroupId string
    The ID of resource group which the resource belongs.
    RestoreTime string
    The point in time of a backup file.
    RoleArn string
    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.
    SecondaryZoneId string

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    SecurityGroupId string
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    ShardCount int
    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.
    SlaveReadOnlyCount int

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    SrcdbInstanceId string
    The ID of the source instance.
    SslEnable string
    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).
    Status string
    The status of KVStore DBInstance.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TdeStatus string
    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.
    VpcAuthMode string
    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.
    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 value: false.
    autoRenewPeriod Integer
    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.
    autoUseCoupon Boolean
    Specifies whether to use a coupon. Default value: 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 Integer
    The bandwidth.
    businessInfo String
    The ID of the event or the business information.
    capacity Integer
    The storage capacity of the KVStore DBInstance. Unit: MB.
    config Map<String,String>
    The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.
    connectionDomain String
    Intranet connection address of the KVStore instance.
    connectionString String
    Indicates whether the address is a private endpoint.

    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. 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.
    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.
    dryRun Boolean
    Specifies whether to precheck the request. Valid values:
    effectiveTime String
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enableBackupLog Integer
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryptionKey String
    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.
    encryptionName String
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    endTime String
    The expiration time of the prepaid instance.
    engineVersion String
    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".
    forceUpgrade Boolean
    Specifies whether to forcibly change the type. Default value: true.
    globalInstance Boolean
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    isAutoUpgradeOpen String
    Specifies whether to enable automatic minor version update. Valid values:
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kmsEncryptionContext Map<String,String>
    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).
    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 value: UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
    parameters List<InstanceParameter>
    It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

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

    password String
    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: ! @ # $ % ^ & * ( ) _ + - =
    paymentType String
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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 Integer
    It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.
    privateConnectionPort String
    Private network connection port, used to modify the private network connection port.
    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 Integer
    Theoretical maximum QPS value.
    readOnlyCount Integer
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resourceGroupId String
    The ID of resource group which the resource belongs.
    restoreTime String
    The point in time of a backup file.
    roleArn String
    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.
    secondaryZoneId String

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    securityGroupId String
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shardCount Integer
    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.
    slaveReadOnlyCount Integer

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdbInstanceId String
    The ID of the source instance.
    sslEnable String
    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).
    status String
    The status of KVStore DBInstance.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tdeStatus String
    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.
    vpcAuthMode String
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    autoUseCoupon boolean
    Specifies whether to use a coupon. Default value: 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]: string}
    The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.
    connectionDomain string
    Intranet connection address of the KVStore instance.
    connectionString string
    Indicates whether the address is a private endpoint.

    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. 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.
    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.
    dryRun boolean
    Specifies whether to precheck the request. Valid values:
    effectiveTime string
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enableBackupLog number
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryptionKey string
    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.
    encryptionName string
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    endTime string
    The expiration time of the prepaid instance.
    engineVersion string
    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".
    forceUpgrade boolean
    Specifies whether to forcibly change the type. Default value: true.
    globalInstance boolean
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    isAutoUpgradeOpen string
    Specifies whether to enable automatic minor version update. Valid values:
    kmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kmsEncryptionContext {[key: string]: string}
    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).
    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 value: 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. See parameters below.

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

    password string
    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: ! @ # $ % ^ & * ( ) _ + - =
    paymentType string
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    privateConnectionPort string
    Private network connection port, used to modify the private network connection port.
    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.
    readOnlyCount number
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resourceGroupId string
    The ID of resource group which the resource belongs.
    restoreTime string
    The point in time of a backup file.
    roleArn string
    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.
    secondaryZoneId string

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    securityGroupId string
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shardCount number
    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.
    slaveReadOnlyCount number

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdbInstanceId string
    The ID of the source instance.
    sslEnable string
    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).
    status string
    The status of KVStore DBInstance.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tdeStatus string
    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.
    vpcAuthMode string
    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.
    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 value: 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 values: [1~12]. Default value: 1.
    auto_use_coupon bool
    Specifies whether to use a coupon. Default value: 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, str]
    The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.
    connection_domain str
    Intranet connection address of the KVStore instance.
    connection_string str
    Indicates whether the address is a private endpoint.

    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. 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.
    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.
    dry_run bool
    Specifies whether to precheck the request. Valid values:
    effective_time str
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enable_backup_log int
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryption_key str
    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.
    encryption_name str
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    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", "5.0", "6.0", "7.0"]. Default value: 5.0. NOTE: When instance_type = Memcache, the engine_version only supports "4.0".
    force_upgrade bool
    Specifies whether to forcibly change the type. Default value: true.
    global_instance bool
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    is_auto_upgrade_open str
    Specifies whether to enable automatic minor version update. Valid values:
    kms_encrypted_password str
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kms_encryption_context Mapping[str, str]
    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).
    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 value: 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. See parameters below.

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

    password str
    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: ! @ # $ % ^ & * ( ) _ + - =
    payment_type str
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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_port str
    Private network connection port, used to modify the private network connection port.
    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.
    read_only_count int
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resource_group_id str
    The ID of resource group which the resource belongs.
    restore_time str
    The point in time of a backup file.
    role_arn str
    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.
    secondary_zone_id str

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    security_group_id str
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shard_count int
    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.
    slave_read_only_count int

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdb_instance_id str
    The ID of the source instance.
    ssl_enable str
    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).
    status str
    The status of KVStore DBInstance.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tde_status str
    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.
    vpc_auth_mode str
    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.
    vswitch_id str
    The ID of VSwitch.
    zone_id str
    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 value: 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 values: [1~12]. Default value: 1.
    autoUseCoupon Boolean
    Specifies whether to use a coupon. Default value: 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 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 Map<String>
    The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.
    connectionDomain String
    Intranet connection address of the KVStore instance.
    connectionString String
    Indicates whether the address is a private endpoint.

    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. 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.
    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.
    dryRun Boolean
    Specifies whether to precheck the request. Valid values:
    effectiveTime String
    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:

    • Immediately (Default): The configurations are immediately changed.
    • MaintainTime: The configurations are changed within the maintenance window. You can set maintain_start_time and maintain_end_time to change the maintenance window.
    enableBackupLog Number
    Turn on or off incremental backup. Valid values: 1, 0. Default value: 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.

    encryptionKey String
    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.
    encryptionName String
    The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.
    endTime String
    The expiration time of the prepaid instance.
    engineVersion String
    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".
    forceUpgrade Boolean
    Specifies whether to forcibly change the type. Default value: true.
    globalInstance Boolean
    Whether to create a distributed cache. Default value: 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
    Type of the applied ApsaraDB for Redis instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.
    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. Default value: Redis.
    isAutoUpgradeOpen String
    Specifies whether to enable automatic minor version update. Valid values:
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.
    kmsEncryptionContext Map<String>
    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).
    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 value: UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.
    parameters List<Property Map>
    It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

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

    password String
    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: ! @ # $ % ^ & * ( ) _ + - =
    paymentType String
    The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: 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.
    privateConnectionPort String
    Private network connection port, used to modify the private network connection port.
    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.
    readOnlyCount Number
    The number of read replicas in the primary zone. Valid values: 1 to 9.
    resourceGroupId String
    The ID of resource group which the resource belongs.
    restoreTime String
    The point in time of a backup file.
    roleArn String
    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.
    secondaryZoneId String

    The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.

    NOTE: If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.

    securityGroupId String
    The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.
    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.
    shardCount Number
    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.
    slaveReadOnlyCount Number

    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.

    NOTE: The sum of read_only_count and slave_read_only_count cannot be greater than 9.

    srcdbInstanceId String
    The ID of the source instance.
    sslEnable String
    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).
    status String
    The status of KVStore DBInstance.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tdeStatus String
    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.
    vpcAuthMode String
    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.
    vswitchId String
    The ID of VSwitch.
    zoneId String
    The ID of the zone.

    Supporting Types

    InstanceParameter, InstanceParameterArgs

    Name string
    Field parameters 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.

    Value string
    Field parameters 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.

    Name string
    Field parameters 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.

    Value string
    Field parameters 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.

    name String
    Field parameters 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.

    value String
    Field parameters 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.

    name string
    Field parameters 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.

    value string
    Field parameters 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.

    name str
    Field parameters 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.

    value str
    Field parameters 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.

    name String
    Field parameters 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.

    value String
    Field parameters 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.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-alicloud