Instance

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

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.kvstore.Instance;
import com.pulumi.alicloud.kvstore.InstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Instance("example", InstanceArgs.builder()
.config(Map.ofEntries(
Map.entry("appendonly", "yes"),
Map.entry("lazyfree-lazy-eviction", "yes")
))
.dbInstanceName("tf-test-basic")
.engineVersion("4.0")
.instanceClass("redis.master.large.default")
.instanceType("Redis")
.resourceGroupId("rg-123456")
.securityIps("10.23.12.24")
.tags(Map.ofEntries(
Map.entry("Created", "TF"),
Map.entry("For", "Test")
))
.vswitchId("vsw-123456")
.zoneId("cn-beijing-h")
.build());
}
}

Import

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

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

Properties

Link copied to clipboard
val autoRenew: Output<Boolean>?

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

Link copied to clipboard
val autoRenewPeriod: Output<Int>?

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

Link copied to clipboard
val autoUseCoupon: Output<Boolean>?

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

Link copied to clipboard

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

Link copied to clipboard
val backupId: Output<String>?

The ID of the backup file of the source instance.

Link copied to clipboard
val backupPeriods: Output<List<String>>

Backup period.

Link copied to clipboard
val backupTime: Output<String>

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

Link copied to clipboard
val bandwidth: Output<Int>

The bandwidth.

Link copied to clipboard
val businessInfo: Output<String>?

The ID of the event or the business information.

Link copied to clipboard
val capacity: Output<Int>

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

Link copied to clipboard
val config: Output<Map<String, Any>>

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

Link copied to clipboard

Intranet connection address of the KVStore instance.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
val couponNo: Output<String>?

The coupon code. Default to: youhuiquan_promotion_option_id_for_blank.

Link copied to clipboard
val dbInstanceName: Output<String>

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

Link copied to clipboard

The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster.

Link copied to clipboard
val dryRun: Output<Boolean>?

Specifies whether to precheck the request. Valid values:

Link copied to clipboard
val enableBackupLog: Output<Int>?

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

Link copied to clipboard
val enablePublic: Output<Boolean>

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

Link copied to clipboard
val endTime: Output<String>

The expiration time of the prepaid instance.

Link copied to clipboard
val engineVersion: Output<String>

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

Link copied to clipboard
val forceUpgrade: Output<Boolean>?

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

Link copied to clipboard
val globalInstance: Output<Boolean>?

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

Link copied to clipboard
val globalInstanceId: Output<String>?

The ID of distributed cache.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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

Link copied to clipboard
val instanceClass: Output<String>?
Link copied to clipboard
val instanceName: Output<String>

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

Link copied to clipboard

Whether to open the release protection.

Link copied to clipboard
val instanceType: Output<String>?

The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Defaults to Redis.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val maintainEndTime: Output<String>

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

Link copied to clipboard

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

Link copied to clipboard
val modifyMode: Output<Int>?

The method of modifying the whitelist. Valid values: 0, 1 and 2. Default to 0. 0 means overwrites the original whitelist. 1 means adds the IP addresses to the whitelist. 2 means deletes the IP addresses from the whitelist.

Link copied to clipboard
val nodeType: Output<String>

"Field 'node_type' has been deprecated from version 1.120.1". This parameter is determined by the instance_class.

Link copied to clipboard
val orderType: Output<String>?

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

Link copied to clipboard

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

Link copied to clipboard
val password: Output<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: ! @ # $ % ^ & * ( ) _ + - =

Link copied to clipboard
val paymentType: Output<String>

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

Link copied to clipboard
val period: Output<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.

Link copied to clipboard
val port: Output<Int>?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val privateIp: Output<String>

The internal IP address of the instance.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val qps: Output<Int>

Theoretical maximum QPS value.

Link copied to clipboard
val resourceGroupId: Output<String>

The ID of resource group which the resource belongs.

Link copied to clipboard
val restoreTime: Output<String>?

The point in time of a backup file.

Link copied to clipboard
val secondaryZoneId: Output<String>?

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

Link copied to clipboard
val securityGroupId: Output<String>?

The ID of security groups.

Link copied to clipboard

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.

Link copied to clipboard

The name of the whitelist group.

Link copied to clipboard
val securityIps: Output<List<String>>

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

Link copied to clipboard
val srcdbInstanceId: Output<String>?

The ID of the source instance.

Link copied to clipboard
val sslEnable: Output<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)

Link copied to clipboard
val status: Output<String>

The status of KVStore DBInstance.

Link copied to clipboard
val tags: Output<Map<String, Any>>?

A mapping of tags to assign to the resource.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val vpcAuthMode: Output<String>?

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

Link copied to clipboard
val vswitchId: Output<String>?

The ID of VSwitch.

Link copied to clipboard
val zoneId: Output<String>

The ID of the zone.