Module kvstore

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

Resource Account

class Account extends CustomResource

Provides a kvstore account resource and used to manage databases.

NOTE: Available in 1.66.0+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "KVStore";
const name = config.get("name") || "kvstoreinstancevpc";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.kvstore.Instance("default", {
    engineVersion: "4.0",
    instanceClass: "redis.master.small.default",
    instanceName: name,
    instanceType: "Redis",
    privateIp: "172.16.0.10",
    securityIps: ["10.0.0.1"],
    vswitchId: defaultSwitch.id,
});
const account = new alicloud.kvstore.Account("account", {
    accountName: "tftestnormal",
    accountPassword: "Test12345",
    instanceId: defaultInstance.id,
});

constructor

new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Account

Returns true if the given object is an instance of Account. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountName

public accountName: pulumi.Output<string>;

Operation account requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 16 characters.

property accountPassword

public accountPassword: pulumi.Output<string | undefined>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of accountPassword and kmsEncryptedPassword fields.

property accountPrivilege

public accountPrivilege: pulumi.Output<string | undefined>;

The privilege of account access database. Valid values: - RoleReadOnly: This value is only for Redis and Memcache - RoleReadWrite: This value is only for Redis and Memcache - RoleRepl: This value supports instance to read, write, and open SYNC / PSYNC commands. Only for Redis which engine version is 4.0 and architecture type is standard

property accountType

public accountType: pulumi.Output<string | undefined>;

Privilege type of account. - Normal: Common privilege. Default to Normal.

property description

public description: pulumi.Output<string | undefined>;

Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance in which account belongs. (The engine version of instance must be 4.0 or 4.0+)

property kmsEncryptedPassword

public kmsEncryptedPassword: pulumi.Output<string | undefined>;

An KMS encrypts password used to a KVStore account. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating a KVStore account with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource BackupPolicy

class BackupPolicy extends CustomResource

Provides a backup policy for ApsaraDB Redis / Memcache instance resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "KVStore";
const multiAz = config.get("multiAz") || "false";
const name = config.get("name") || "kvstorebackuppolicyvpc";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.kvstore.Instance("default", {
    engineVersion: "2.8",
    instanceClass: "Memcache",
    instanceName: name,
    instanceType: "memcache.master.small.default",
    privateIp: "172.16.0.10",
    securityIps: ["10.0.0.1"],
    vswitchId: defaultSwitch.id,
});
const defaultBackupPolicy = new alicloud.kvstore.BackupPolicy("default", {
    backupPeriods: [
        "Tuesday",
        "Wednesday",
    ],
    backupTime: "10:00Z-11:00Z",
    instanceId: defaultInstance.id,
});

constructor

new BackupPolicy(name: string, args: BackupPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a BackupPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BackupPolicyState, opts?: pulumi.CustomResourceOptions): BackupPolicy

Get an existing BackupPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BackupPolicy

Returns true if the given object is an instance of BackupPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backupPeriods

public backupPeriods: pulumi.Output<string[]>;

Backup Cycle. Allowed values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

property backupTime

public backupTime: pulumi.Output<string | undefined>;

Backup time, in the format of HH:mmZ- HH:mm Z

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The id of ApsaraDB for Redis or Memcache intance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Instance

class Instance extends CustomResource

Provides an ApsaraDB Redis / Memcache instance resource. A DB instance is an isolated database environment in the cloud. It can be associated with IP whitelists and backup configuration which are separate resource providers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "KVStore";
const name = config.get("name") || "kvstoreinstancevpc";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.kvstore.Instance("default", {
    engineVersion: "4.0",
    instanceClass: "redis.master.small.default",
    instanceName: name,
    instanceType: "Redis",
    privateIp: "172.16.0.10",
    securityIps: ["10.0.0.1"],
    vswitchId: defaultSwitch.id,
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property autoRenew

public autoRenew: pulumi.Output<boolean | undefined>;

Whether to renewal a DB instance automatically or not. It is valid when instanceChargeType is PrePaid. Default to false.

property autoRenewPeriod

public autoRenewPeriod: pulumi.Output<number | undefined>;

Auto-renewal period of an instance, in the unit of the month. It is valid when instanceChargeType is PrePaid. Valid value:[1~12], Default to 1.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The Zone to launch the DB instance.

property backupId

public backupId: pulumi.Output<string | undefined>;

If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.

property connectionDomain

public connectionDomain: pulumi.Output<string>;

Instance connection domain (only Intranet access supported).

property engineVersion

public engineVersion: pulumi.Output<string | undefined>;

Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceChargeType

public instanceChargeType: pulumi.Output<string | undefined>;

Valid values are PrePaid, PostPaid, Default to PostPaid.

property instanceClass

public instanceClass: pulumi.Output<string>;

property instanceName

public instanceName: pulumi.Output<string | undefined>;

The name of DB instance. It a string of 2 to 256 characters.

property instanceType

public instanceType: pulumi.Output<string | undefined>;

The engine to use: Redis or Memcache. Defaults to Redis.

property kmsEncryptedPassword

public kmsEncryptedPassword: pulumi.Output<string | undefined>;

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

property kmsEncryptionContext

public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;

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

property maintainEndTime

public maintainEndTime: pulumi.Output<string>;

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

property maintainStartTime

public maintainStartTime: pulumi.Output<string>;

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

property parameters

public parameters: pulumi.Output<InstanceParameter[]>;

Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .

property password

public password: pulumi.Output<string | undefined>;

The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.

property period

public period: pulumi.Output<number | undefined>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

property privateIp

public privateIp: pulumi.Output<string>;

Set the instance’s private IP.

property resourceGroupId

public resourceGroupId: pulumi.Output<string | undefined>;

The ID of resource group which the resource belongs.

property securityGroupId

public securityGroupId: pulumi.Output<string>;

The Security Group ID of ECS.

property securityIps

public securityIps: pulumi.Output<string[]>;

Set the instance’s IP whitelist of the default security group.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcAuthMode

public vpcAuthMode: pulumi.Output<string>;

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

property vswitchId

public vswitchId: pulumi.Output<string | undefined>;

The ID of VSwitch.

Functions

Function getInstanceClasses

getInstanceClasses(args: GetInstanceClassesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceClassesResult>

This data source provides the KVStore instance classes resource available info of Alibaba Cloud.

NOTE: Available in v1.49.0+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const resourcesZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "KVStore",
}, { async: true }));
const resourcesInstanceClasses = resourcesZones.apply(resourcesZones => alicloud.kvstore.getInstanceClasses({
    engine: "Redis",
    engineVersion: "5.0",
    instanceChargeType: "PrePaid",
    outputFile: "./classes.txt",
    zoneId: resourcesZones.zones[0].id,
}, { async: true }));

export const firstKvstoreInstanceClass = resourcesInstanceClasses.instanceClasses;

Function getInstanceEngines

getInstanceEngines(args: GetInstanceEnginesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceEnginesResult>

This data source provides the KVStore instance engines resource available info of Alibaba Cloud.

NOTE: Available in v1.51.0+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const resourcesZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "KVStore",
}, { async: true }));
const resourcesInstanceEngines = resourcesZones.apply(resourcesZones => alicloud.kvstore.getInstanceEngines({
    engine: "Redis",
    engineVersion: "5.0",
    instanceChargeType: "PrePaid",
    outputFile: "./engines.txt",
    zoneId: resourcesZones.zones[0].id,
}, { async: true }));

export const firstKvstoreInstanceClass = resourcesInstanceEngines.instanceEngines[0].engine;

Function getInstances

getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>

The alicloud.kvstore.getInstances data source provides a collection of kvstore instances available in Alicloud account. Filters support regular expression for the instance name, searches by tags, and other filters which are listed below.

Function getZones

getZones(args?: GetZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetZonesResult>

This data source provides availability zones for KVStore that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.73.0+.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const zonesIds = alicloud.kvstore.getZones({});
// Create an KVStore instance with the first matched zone
const kvstore = new alicloud.kvstore.Instance("kvstore", {availabilityZone: zonesIds.then(zonesIds => zonesIds.zones[0].id)});
// Other properties...

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property accountName

accountName: pulumi.Input<string>;

Operation account requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 16 characters.

property accountPassword

accountPassword?: pulumi.Input<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of accountPassword and kmsEncryptedPassword fields.

property accountPrivilege

accountPrivilege?: pulumi.Input<string>;

property accountType

accountType?: pulumi.Input<string>;

Privilege type of account. - Normal: Common privilege. Default to Normal.

property description

description?: pulumi.Input<string>;

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance in which account belongs. (The engine version of instance must be 4.0 or 4.0+)

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a KVStore account. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

interface AccountState

interface AccountState

Input properties used for looking up and filtering Account resources.

property accountName

accountName?: pulumi.Input<string>;

Operation account requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 16 characters.

property accountPassword

accountPassword?: pulumi.Input<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of accountPassword and kmsEncryptedPassword fields.

property accountPrivilege

accountPrivilege?: pulumi.Input<string>;

property accountType

accountType?: pulumi.Input<string>;

Privilege type of account. - Normal: Common privilege. Default to Normal.

property description

description?: pulumi.Input<string>;

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance in which account belongs. (The engine version of instance must be 4.0 or 4.0+)

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a KVStore account. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

interface BackupPolicyArgs

interface BackupPolicyArgs

The set of arguments for constructing a BackupPolicy resource.

property backupPeriods

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

Backup Cycle. Allowed values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

property backupTime

backupTime?: pulumi.Input<string>;

Backup time, in the format of HH:mmZ- HH:mm Z

property instanceId

instanceId: pulumi.Input<string>;

The id of ApsaraDB for Redis or Memcache intance.

interface BackupPolicyState

interface BackupPolicyState

Input properties used for looking up and filtering BackupPolicy resources.

property backupPeriods

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

Backup Cycle. Allowed values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

property backupTime

backupTime?: pulumi.Input<string>;

Backup time, in the format of HH:mmZ- HH:mm Z

property instanceId

instanceId?: pulumi.Input<string>;

The id of ApsaraDB for Redis or Memcache intance.

interface GetInstanceClassesArgs

interface GetInstanceClassesArgs

A collection of arguments for invoking getInstanceClasses.

property architecture

architecture?: undefined | string;

The KVStore instance system architecture required by the user. Valid values: standard, cluster and rwsplit.

property editionType

editionType?: undefined | string;

The KVStore instance edition type required by the user. Valid values: Community and Enterprise.

property engine

engine?: undefined | string;

Database type. Options are Redis, Memcache. Default to Redis.

property engineVersion

engineVersion?: undefined | string;

Database version required by the user. Value options of Redis can refer to the latest docs detail info EngineVersion. Value of Memcache should be empty.

property instanceChargeType

instanceChargeType?: undefined | string;

Filter the results by charge type. Valid values: PrePaid and PostPaid. Default to PrePaid.

property nodeType

nodeType?: undefined | string;

The KVStore instance node type required by the user. Valid values: double, single, readone, readthree and readfive.

property outputFile

outputFile?: undefined | string;

property packageType

DEPRECATED The parameter 'package_type' has been deprecated from 1.68.0.

packageType?: undefined | string;

It has been deprecated from 1.68.0.

property performanceType

DEPRECATED The parameter 'performance_type' has been deprecated from 1.68.0.

performanceType?: undefined | string;

It has been deprecated from 1.68.0.

property seriesType

seriesType?: undefined | string;

The KVStore instance series type required by the user. Valid values: enhancedPerformanceType and hybridStorage.

property shardNumber

shardNumber?: undefined | number;

The number of shard.Valid values: 1, 2, 4, 8, 16, 32, 64, 128, 256.

property sortedBy

sortedBy?: undefined | string;

property storageType

DEPRECATED The parameter 'storage_type' has been deprecated from 1.68.0.

storageType?: undefined | string;

It has been deprecated from 1.68.0.

property zoneId

zoneId: string;

The Zone to launch the KVStore instance.

interface GetInstanceClassesResult

interface GetInstanceClassesResult

A collection of values returned by getInstanceClasses.

property architecture

architecture?: undefined | string;

property classes

classes: GetInstanceClassesClass[];

A list of KVStore available instance classes when the sortedBy is “Price”. include:

property editionType

editionType?: undefined | string;

property engine

engine?: undefined | string;

property engineVersion

engineVersion?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property instanceChargeType

instanceChargeType?: undefined | string;

property instanceClasses

instanceClasses: string[];

A list of KVStore available instance classes.

property nodeType

nodeType?: undefined | string;

property outputFile

outputFile?: undefined | string;

property packageType

packageType?: undefined | string;

property performanceType

performanceType?: undefined | string;

property seriesType

seriesType?: undefined | string;

property shardNumber

shardNumber?: undefined | number;

property sortedBy

sortedBy?: undefined | string;

property storageType

storageType?: undefined | string;

property zoneId

zoneId: string;

interface GetInstanceEnginesArgs

interface GetInstanceEnginesArgs

A collection of arguments for invoking getInstanceEngines.

property engine

engine?: undefined | string;

Database type. Options are Redis, Memcache. Default to Redis.

property engineVersion

engineVersion?: undefined | string;

Database version required by the user. Value options of Redis can refer to the latest docs detail info EngineVersion. Value of Memcache should be empty.

property instanceChargeType

instanceChargeType?: undefined | string;

Filter the results by charge type. Valid values: PrePaid and PostPaid. Default to PrePaid.

property outputFile

outputFile?: undefined | string;

property zoneId

zoneId: string;

The Zone to launch the KVStore instance.

interface GetInstanceEnginesResult

interface GetInstanceEnginesResult

A collection of values returned by getInstanceEngines.

property engine

engine?: undefined | string;

Database type.

property engineVersion

engineVersion?: undefined | string;

KVStore Instance version.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property instanceChargeType

instanceChargeType?: undefined | string;

property instanceEngines

instanceEngines: GetInstanceEnginesInstanceEngine[];

A list of KVStore available instance engines. Each element contains the following attributes:

property outputFile

outputFile?: undefined | string;

property zoneId

zoneId: string;

The Zone to launch the KVStore instance.

interface GetInstancesArgs

interface GetInstancesArgs

A collection of arguments for invoking getInstances.

property ids

ids?: string[];

A list of RKV instance IDs.

property instanceClass

instanceClass?: undefined | string;

Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.

property instanceType

instanceType?: undefined | string;

Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.

property nameRegex

nameRegex?: undefined | string;

A regex string to apply to the instance name.

property outputFile

outputFile?: undefined | string;

property status

status?: undefined | string;

Status of the instance.

property tags

tags?: undefined | {[key: string]: any};

Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.

property vpcId

vpcId?: undefined | string;

Used to retrieve instances belong to specified VPC.

property vswitchId

vswitchId?: undefined | string;

Used to retrieve instances belong to specified vswitch resources.

interface GetInstancesResult

interface GetInstancesResult

A collection of values returned by getInstances.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of RKV instance IDs.

property instanceClass

instanceClass?: undefined | string;

property instanceType

instanceType?: undefined | string;

(Optional) Database type. Options are Memcache, and Redis. If no value is specified, all types are returned. * instanceClass- (Optional) Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.

property instances

instances: GetInstancesInstance[];

A list of RKV instances. Its every element contains the following attributes:

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

property outputFile

outputFile?: undefined | string;

property status

status?: undefined | string;

Status of the instance.

property tags

tags?: undefined | {[key: string]: any};

property vpcId

vpcId?: undefined | string;

VPC ID the instance belongs to.

property vswitchId

vswitchId?: undefined | string;

VSwitch ID the instance belongs to.

interface GetZonesArgs

interface GetZonesArgs

A collection of arguments for invoking getZones.

property instanceChargeType

instanceChargeType?: undefined | string;

Filter the results by a specific instance charge type. Valid values: PrePaid and PostPaid. Default to PostPaid.

property multi

multi?: undefined | false | true;

Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch KVStore instances.

property outputFile

outputFile?: undefined | string;

interface GetZonesResult

interface GetZonesResult

A collection of values returned by getZones.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of zone IDs.

property instanceChargeType

instanceChargeType?: undefined | string;

property multi

multi?: undefined | false | true;

property outputFile

outputFile?: undefined | string;

property zones

zones: GetZonesZone[];

A list of availability zones. Each element contains the following attributes:

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property autoRenew

autoRenew?: pulumi.Input<boolean>;

Whether to renewal a DB instance automatically or not. It is valid when instanceChargeType is PrePaid. Default to false.

property autoRenewPeriod

autoRenewPeriod?: pulumi.Input<number>;

Auto-renewal period of an instance, in the unit of the month. It is valid when instanceChargeType is PrePaid. Valid value:[1~12], Default to 1.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The Zone to launch the DB instance.

property backupId

backupId?: pulumi.Input<string>;

If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.

property engineVersion

engineVersion?: pulumi.Input<string>;

Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid, Default to PostPaid.

property instanceClass

instanceClass: pulumi.Input<string>;

property instanceName

instanceName?: pulumi.Input<string>;

The name of DB instance. It a string of 2 to 256 characters.

property instanceType

instanceType?: pulumi.Input<string>;

The engine to use: Redis or Memcache. Defaults to Redis.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

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

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

property maintainEndTime

maintainEndTime?: pulumi.Input<string>;

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

property maintainStartTime

maintainStartTime?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<InstanceParameter>[]>;

Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .

property password

password?: pulumi.Input<string>;

The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

property privateIp

privateIp?: pulumi.Input<string>;

Set the instance’s private IP.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The ID of resource group which the resource belongs.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The Security Group ID of ECS.

property securityIps

securityIps?: pulumi.Input<pulumi.Input<string>[]>;

Set the instance’s IP whitelist of the default security group.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vpcAuthMode

vpcAuthMode?: pulumi.Input<string>;

property vswitchId

vswitchId?: pulumi.Input<string>;

The ID of VSwitch.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property autoRenew

autoRenew?: pulumi.Input<boolean>;

Whether to renewal a DB instance automatically or not. It is valid when instanceChargeType is PrePaid. Default to false.

property autoRenewPeriod

autoRenewPeriod?: pulumi.Input<number>;

Auto-renewal period of an instance, in the unit of the month. It is valid when instanceChargeType is PrePaid. Valid value:[1~12], Default to 1.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The Zone to launch the DB instance.

property backupId

backupId?: pulumi.Input<string>;

If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.

property connectionDomain

connectionDomain?: pulumi.Input<string>;

Instance connection domain (only Intranet access supported).

property engineVersion

engineVersion?: pulumi.Input<string>;

Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid, Default to PostPaid.

property instanceClass

instanceClass?: pulumi.Input<string>;

property instanceName

instanceName?: pulumi.Input<string>;

The name of DB instance. It a string of 2 to 256 characters.

property instanceType

instanceType?: pulumi.Input<string>;

The engine to use: Redis or Memcache. Defaults to Redis.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

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

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

property maintainEndTime

maintainEndTime?: pulumi.Input<string>;

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

property maintainStartTime

maintainStartTime?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<InstanceParameter>[]>;

Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .

property password

password?: pulumi.Input<string>;

The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

property privateIp

privateIp?: pulumi.Input<string>;

Set the instance’s private IP.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The ID of resource group which the resource belongs.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The Security Group ID of ECS.

property securityIps

securityIps?: pulumi.Input<pulumi.Input<string>[]>;

Set the instance’s IP whitelist of the default security group.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vpcAuthMode

vpcAuthMode?: pulumi.Input<string>;

property vswitchId

vswitchId?: pulumi.Input<string>;

The ID of VSwitch.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module kvstore

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Example Usage

Others