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.

kvstore¶

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.

class pulumi_alicloud.kvstore.Account(resource_name, opts=None, account_name=None, account_password=None, account_privilege=None, account_type=None, description=None, instance_id=None, kms_encrypted_password=None, kms_encryption_context=None, __props__=None, __name__=None, __opts__=None)¶

Provides a kvstore account resource and used to manage databases.

NOTE: Available in 1.66.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
creation = config.get("creation")
if creation is None:
    creation = "KVStore"
name = config.get("name")
if name is None:
    name = "kvstoreinstancevpc"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.kvstore.Instance("defaultInstance",
    engine_version="4.0",
    instance_class="redis.master.small.default",
    instance_name=name,
    instance_type="Redis",
    private_ip="172.16.0.10",
    security_ips=["10.0.0.1"],
    vswitch_id=default_switch.id)
account = alicloud.kvstore.Account("account",
    account_name="tftestnormal",
    account_password="Test12345",
    instance_id=default_instance.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – 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.
account_password (pulumi.Input[str]) – Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of account_password and kms_encrypted_password fields.
account_privilege (pulumi.Input[str]) – 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

Parameters: account_type (pulumi.Input[str]) – Privilege type of account.

- Normal: Common privilege.
Default to Normal.

Parameters

description (pulumi.Input[str]) – 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.
instance_id (pulumi.Input[str]) – The Id of instance in which account belongs. (The engine version of instance must be 4.0 or 4.0+)
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) – An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

account_name: pulumi.Output[str] = None¶: 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.

account_password: pulumi.Output[str] = None¶: Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of account_password and kms_encrypted_password fields.

account_privilege: pulumi.Output[str] = None¶

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

account_type: pulumi.Output[str] = None¶

Privilege type of account.

Normal: Common privilege. Default to Normal.

description: pulumi.Output[str] = None¶: 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.

instance_id: pulumi.Output[str] = None¶: The Id of instance in which account belongs. (The engine version of instance must be 4.0 or 4.0+)

kms_encrypted_password: pulumi.Output[str] = None¶: An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.

kms_encryption_context: pulumi.Output[dict] = None¶: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

static get(resource_name, id, opts=None, account_name=None, account_password=None, account_privilege=None, account_type=None, description=None, instance_id=None, kms_encrypted_password=None, kms_encryption_context=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_name (pulumi.Input[str]) – 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.
account_password (pulumi.Input[str]) – Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of account_password and kms_encrypted_password fields.
account_privilege (pulumi.Input[str]) – 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

Parameters: account_type (pulumi.Input[str]) – Privilege type of account.

- Normal: Common privilege.
Default to Normal.

Parameters

description (pulumi.Input[str]) – 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.
instance_id (pulumi.Input[str]) – The Id of instance in which account belongs. (The engine version of instance must be 4.0 or 4.0+)
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) –
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.kvstore.AwaitableGetInstanceClassesResult(architecture=None, classes=None, edition_type=None, engine=None, engine_version=None, id=None, instance_charge_type=None, instance_classes=None, node_type=None, output_file=None, package_type=None, performance_type=None, series_type=None, shard_number=None, sorted_by=None, storage_type=None, zone_id=None)¶

class pulumi_alicloud.kvstore.AwaitableGetInstanceEnginesResult(engine=None, engine_version=None, id=None, instance_charge_type=None, instance_engines=None, output_file=None, zone_id=None)¶

class pulumi_alicloud.kvstore.AwaitableGetInstancesResult(id=None, ids=None, instance_class=None, instance_type=None, instances=None, name_regex=None, names=None, output_file=None, status=None, tags=None, vpc_id=None, vswitch_id=None)¶

class pulumi_alicloud.kvstore.AwaitableGetZonesResult(id=None, ids=None, instance_charge_type=None, multi=None, output_file=None, zones=None)¶

class pulumi_alicloud.kvstore.BackupPolicy(resource_name, opts=None, backup_periods=None, backup_time=None, instance_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
creation = config.get("creation")
if creation is None:
    creation = "KVStore"
multi_az = config.get("multiAz")
if multi_az is None:
    multi_az = "false"
name = config.get("name")
if name is None:
    name = "kvstorebackuppolicyvpc"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.kvstore.Instance("defaultInstance",
    engine_version="2.8",
    instance_class="Memcache",
    instance_name=name,
    instance_type="memcache.master.small.default",
    private_ip="172.16.0.10",
    security_ips=["10.0.0.1"],
    vswitch_id=default_switch.id)
default_backup_policy = alicloud.kvstore.BackupPolicy("defaultBackupPolicy",
    backup_periods=[
        "Tuesday",
        "Wednesday",
    ],
    backup_time="10:00Z-11:00Z",
    instance_id=default_instance.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backup_periods (pulumi.Input[list]) – Backup Cycle. Allowed values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
backup_time (pulumi.Input[str]) – Backup time, in the format of HH:mmZ- HH:mm Z
instance_id (pulumi.Input[str]) – The id of ApsaraDB for Redis or Memcache intance.

backup_periods: pulumi.Output[list] = None¶: Backup Cycle. Allowed values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

backup_time: pulumi.Output[str] = None¶: Backup time, in the format of HH:mmZ- HH:mm Z

instance_id: pulumi.Output[str] = None¶: The id of ApsaraDB for Redis or Memcache intance.

static get(resource_name, id, opts=None, backup_periods=None, backup_time=None, instance_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backup_periods (pulumi.Input[list]) – Backup Cycle. Allowed values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
backup_time (pulumi.Input[str]) – Backup time, in the format of HH:mmZ- HH:mm Z
instance_id (pulumi.Input[str]) – The id of ApsaraDB for Redis or Memcache intance.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.kvstore.GetInstanceClassesResult(architecture=None, classes=None, edition_type=None, engine=None, engine_version=None, id=None, instance_charge_type=None, instance_classes=None, node_type=None, output_file=None, package_type=None, performance_type=None, series_type=None, shard_number=None, sorted_by=None, storage_type=None, zone_id=None)¶

A collection of values returned by getInstanceClasses.

classes = None¶: A list of KVStore available instance classes when the sorted_by is “Price”. include:

id = None¶: The provider-assigned unique ID for this managed resource.

instance_classes = None¶: A list of KVStore available instance classes.

class pulumi_alicloud.kvstore.GetInstanceEnginesResult(engine=None, engine_version=None, id=None, instance_charge_type=None, instance_engines=None, output_file=None, zone_id=None)¶

A collection of values returned by getInstanceEngines.

engine = None¶: Database type.

engine_version = None¶: KVStore Instance version.

id = None¶: The provider-assigned unique ID for this managed resource.

instance_engines = None¶: A list of KVStore available instance engines. Each element contains the following attributes:

zone_id = None¶: The Zone to launch the KVStore instance.

class pulumi_alicloud.kvstore.GetInstancesResult(id=None, ids=None, instance_class=None, instance_type=None, instances=None, name_regex=None, names=None, output_file=None, status=None, tags=None, vpc_id=None, vswitch_id=None)¶

A collection of values returned by getInstances.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of RKV instance IDs.

instance_type = None¶

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

instance_class- (Optional) Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.

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

status = None¶: Status of the instance.

vpc_id = None¶: VPC ID the instance belongs to.

vswitch_id = None¶: VSwitch ID the instance belongs to.

class pulumi_alicloud.kvstore.GetZonesResult(id=None, ids=None, instance_charge_type=None, multi=None, output_file=None, zones=None)¶

A collection of values returned by getZones.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of zone IDs.

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

class pulumi_alicloud.kvstore.Instance(resource_name, opts=None, auto_renew=None, auto_renew_period=None, availability_zone=None, backup_id=None, engine_version=None, instance_charge_type=None, instance_class=None, instance_name=None, instance_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, parameters=None, password=None, period=None, private_ip=None, resource_group_id=None, security_group_id=None, security_ips=None, tags=None, vpc_auth_mode=None, vswitch_id=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
creation = config.get("creation")
if creation is None:
    creation = "KVStore"
name = config.get("name")
if name is None:
    name = "kvstoreinstancevpc"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.kvstore.Instance("defaultInstance",
    engine_version="4.0",
    instance_class="redis.master.small.default",
    instance_name=name,
    instance_type="Redis",
    private_ip="172.16.0.10",
    security_ips=["10.0.0.1"],
    vswitch_id=default_switch.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_renew (pulumi.Input[bool]) – Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to false.
auto_renew_period (pulumi.Input[float]) – Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is PrePaid. Valid value:[1~12], Default to 1.
availability_zone (pulumi.Input[str]) – The Zone to launch the DB instance.
backup_id (pulumi.Input[str]) – 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.
engine_version (pulumi.Input[str]) – Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid, Default to PostPaid.
instance_name (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
instance_type (pulumi.Input[str]) – The engine to use: Redis or Memcache. Defaults to Redis.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) –
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 (pulumi.Input[str]) – The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start_time (pulumi.Input[str]) – The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
parameters (pulumi.Input[list]) – Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
password (pulumi.Input[str]) – 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.
period (pulumi.Input[float]) – The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.
private_ip (pulumi.Input[str]) – Set the instance’s private IP.
resource_group_id (pulumi.Input[str]) – The ID of resource group which the resource belongs.
security_group_id (pulumi.Input[str]) – The Security Group ID of ECS.
security_ips (pulumi.Input[list]) – Set the instance’s IP whitelist of the default security group.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vpc_auth_mode (pulumi.Input[str]) – Only meaningful if instance_type 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.
vswitch_id (pulumi.Input[str]) – The ID of VSwitch.

The parameters object supports the following:

name (pulumi.Input[str])
value (pulumi.Input[str])

auto_renew: pulumi.Output[bool] = None¶: Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to false.

auto_renew_period: pulumi.Output[float] = None¶: Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is PrePaid. Valid value:[1~12], Default to 1.

availability_zone: pulumi.Output[str] = None¶: The Zone to launch the DB instance.

backup_id: pulumi.Output[str] = None¶: 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.

connection_domain: pulumi.Output[str] = None¶: Instance connection domain (only Intranet access supported).

engine_version: pulumi.Output[str] = None¶: Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.

instance_charge_type: pulumi.Output[str] = None¶: Valid values are PrePaid, PostPaid, Default to PostPaid.

instance_name: pulumi.Output[str] = None¶: The name of DB instance. It a string of 2 to 256 characters.

instance_type: pulumi.Output[str] = None¶: The engine to use: Redis or Memcache. Defaults to Redis.

kms_encrypted_password: pulumi.Output[str] = None¶: An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.

kms_encryption_context: pulumi.Output[dict] = None¶: 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: pulumi.Output[str] = None¶: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

maintain_start_time: pulumi.Output[str] = None¶: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

parameters: pulumi.Output[list] = None¶

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

name (str)
value (str)

password: pulumi.Output[str] = None¶: 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.

period: pulumi.Output[float] = None¶: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

private_ip: pulumi.Output[str] = None¶: Set the instance’s private IP.

resource_group_id: pulumi.Output[str] = None¶: The ID of resource group which the resource belongs.

security_group_id: pulumi.Output[str] = None¶: The Security Group ID of ECS.

security_ips: pulumi.Output[list] = None¶: Set the instance’s IP whitelist of the default security group.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

vpc_auth_mode: pulumi.Output[str] = None¶: Only meaningful if instance_type 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.

vswitch_id: pulumi.Output[str] = None¶: The ID of VSwitch.

static get(resource_name, id, opts=None, auto_renew=None, auto_renew_period=None, availability_zone=None, backup_id=None, connection_domain=None, engine_version=None, instance_charge_type=None, instance_class=None, instance_name=None, instance_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, parameters=None, password=None, period=None, private_ip=None, resource_group_id=None, security_group_id=None, security_ips=None, tags=None, vpc_auth_mode=None, vswitch_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_renew (pulumi.Input[bool]) – Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to false.
auto_renew_period (pulumi.Input[float]) – Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is PrePaid. Valid value:[1~12], Default to 1.
availability_zone (pulumi.Input[str]) – The Zone to launch the DB instance.
backup_id (pulumi.Input[str]) – 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.
connection_domain (pulumi.Input[str]) – Instance connection domain (only Intranet access supported).
engine_version (pulumi.Input[str]) – Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid, Default to PostPaid.
instance_name (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
instance_type (pulumi.Input[str]) – The engine to use: Redis or Memcache. Defaults to Redis.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a instance. If the password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) –
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 (pulumi.Input[str]) – The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start_time (pulumi.Input[str]) – The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
parameters (pulumi.Input[list]) –
Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
password (pulumi.Input[str]) – 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.
period (pulumi.Input[float]) – The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.
private_ip (pulumi.Input[str]) – Set the instance’s private IP.
resource_group_id (pulumi.Input[str]) – The ID of resource group which the resource belongs.
security_group_id (pulumi.Input[str]) – The Security Group ID of ECS.
security_ips (pulumi.Input[list]) – Set the instance’s IP whitelist of the default security group.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vpc_auth_mode (pulumi.Input[str]) – Only meaningful if instance_type 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.
vswitch_id (pulumi.Input[str]) – The ID of VSwitch.

The parameters object supports the following:

name (pulumi.Input[str])
value (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.kvstore.get_instance_classes(architecture=None, edition_type=None, engine=None, engine_version=None, instance_charge_type=None, node_type=None, output_file=None, package_type=None, performance_type=None, series_type=None, shard_number=None, sorted_by=None, storage_type=None, zone_id=None, opts=None)¶

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

NOTE: Available in v1.49.0+

import pulumi
import pulumi_alicloud as alicloud

resources_zones = alicloud.get_zones(available_resource_creation="KVStore")
resources_instance_classes = alicloud.kvstore.get_instance_classes(engine="Redis",
    engine_version="5.0",
    instance_charge_type="PrePaid",
    output_file="./classes.txt",
    zone_id=resources_zones.zones[0]["id"])
pulumi.export("firstKvstoreInstanceClass", resources_instance_classes.instance_classes)

Parameters

architecture (str) – The KVStore instance system architecture required by the user. Valid values: standard, cluster and rwsplit.
edition_type (str) – The KVStore instance edition type required by the user. Valid values: Community and Enterprise.
engine (str) – Database type. Options are Redis, Memcache. Default to Redis.
engine_version (str) – 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.
instance_charge_type (str) – Filter the results by charge type. Valid values: PrePaid and PostPaid. Default to PrePaid.
node_type (str) – The KVStore instance node type required by the user. Valid values: double, single, readone, readthree and readfive.
package_type (str) – It has been deprecated from 1.68.0.
performance_type (str) – It has been deprecated from 1.68.0.
series_type (str) – The KVStore instance series type required by the user. Valid values: enhanced_performance_type and hybrid_storage.
shard_number (float) – The number of shard.Valid values: 1, 2, 4, 8, 16, 32, 64, 128, 256.
storage_type (str) – It has been deprecated from 1.68.0.
zone_id (str) – The Zone to launch the KVStore instance.

pulumi_alicloud.kvstore.get_instance_engines(engine=None, engine_version=None, instance_charge_type=None, output_file=None, zone_id=None, opts=None)¶

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

NOTE: Available in v1.51.0+

import pulumi
import pulumi_alicloud as alicloud

resources_zones = alicloud.get_zones(available_resource_creation="KVStore")
resources_instance_engines = alicloud.kvstore.get_instance_engines(engine="Redis",
    engine_version="5.0",
    instance_charge_type="PrePaid",
    output_file="./engines.txt",
    zone_id=resources_zones.zones[0]["id"])
pulumi.export("firstKvstoreInstanceClass", resources_instance_engines.instance_engines[0]["engine"])

Parameters

engine (str) – Database type. Options are Redis, Memcache. Default to Redis.
engine_version (str) –
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.
instance_charge_type (str) – Filter the results by charge type. Valid values: PrePaid and PostPaid. Default to PrePaid.
zone_id (str) – The Zone to launch the KVStore instance.

pulumi_alicloud.kvstore.get_instances(ids=None, instance_class=None, instance_type=None, name_regex=None, output_file=None, status=None, tags=None, vpc_id=None, vswitch_id=None, opts=None)¶

The 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.

Parameters

ids (list) – A list of RKV instance IDs.
instance_class (str) –
Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
instance_type (str) – Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
name_regex (str) – A regex string to apply to the instance name.
status (str) – Status of the instance.
tags (dict) – 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"}.
vpc_id (str) – Used to retrieve instances belong to specified VPC.
vswitch_id (str) – Used to retrieve instances belong to specified vswitch resources.

pulumi_alicloud.kvstore.get_zones(instance_charge_type=None, multi=None, output_file=None, opts=None)¶

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+.

import pulumi
import pulumi_alicloud as alicloud

zones_ids = alicloud.kvstore.get_zones()
# Create an KVStore instance with the first matched zone
kvstore = alicloud.kvstore.Instance("kvstore", availability_zone=zones_ids.zones[0]["id"])
# Other properties...

Parameters

instance_charge_type (str) – Filter the results by a specific instance charge type. Valid values: PrePaid and PostPaid. Default to PostPaid.
multi (bool) – Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch KVStore instances.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

kvstore¶

On This Page