Account

Provides a KVStore Account resource.

For information about KVStore Account and how to use it, see What is Account.

NOTE: Available in 1.66.0+

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var creation = config.Get("creation") ?? "KVStore";
        var name = config.Get("name") ?? "kvstoreinstancevpc";
        var defaultZones = Output.Create(AliCloud.GetZones.InvokeAsync(new AliCloud.GetZonesArgs
        {
            AvailableResourceCreation = creation,
        }));
        var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new AliCloud.Vpc.NetworkArgs
        {
            CidrBlock = "172.16.0.0/16",
        });
        var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new AliCloud.Vpc.SwitchArgs
        {
            VpcId = defaultNetwork.Id,
            CidrBlock = "172.16.0.0/24",
            AvailabilityZone = defaultZones.Apply(defaultZones => defaultZones.Zones[0].Id),
            VswitchName = name,
        });
        var defaultInstance = new AliCloud.KVStore.Instance("defaultInstance", new AliCloud.KVStore.InstanceArgs
        {
            InstanceClass = "redis.master.small.default",
            InstanceName = name,
            VswitchId = defaultSwitch.Id,
            PrivateIp = "172.16.0.10",
            SecurityIps = 
            {
                "10.0.0.1",
            },
            InstanceType = "Redis",
            EngineVersion = "4.0",
        });
        var example = new AliCloud.KVStore.Account("example", new AliCloud.KVStore.AccountArgs
        {
            AccountName = "tftestnormal",
            AccountPassword = "YourPassword_123",
            InstanceId = defaultInstance.Id,
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		creation := "KVStore"
		if param := cfg.Get("creation"); param != "" {
			creation = param
		}
		name := "kvstoreinstancevpc"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		opt0 := creation
		defaultZones, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
			VpcId:            defaultNetwork.ID(),
			CidrBlock:        pulumi.String("172.16.0.0/24"),
			AvailabilityZone: pulumi.String(defaultZones.Zones[0].Id),
			VswitchName:      pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultInstance, err := kvstore.NewInstance(ctx, "defaultInstance", &kvstore.InstanceArgs{
			InstanceClass: pulumi.String("redis.master.small.default"),
			InstanceName:  pulumi.String(name),
			VswitchId:     defaultSwitch.ID(),
			PrivateIp:     pulumi.String("172.16.0.10"),
			SecurityIps: pulumi.StringArray{
				pulumi.String("10.0.0.1"),
			},
			InstanceType:  pulumi.String("Redis"),
			EngineVersion: pulumi.String("4.0"),
		})
		if err != nil {
			return err
		}
		_, err = kvstore.NewAccount(ctx, "example", &kvstore.AccountArgs{
			AccountName:     pulumi.String("tftestnormal"),
			AccountPassword: pulumi.String("YourPassword_123"),
			InstanceId:      defaultInstance.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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",
    vpc_id=default_network.id,
    cidr_block="172.16.0.0/24",
    availability_zone=default_zones.zones[0].id,
    vswitch_name=name)
default_instance = alicloud.kvstore.Instance("defaultInstance",
    instance_class="redis.master.small.default",
    instance_name=name,
    vswitch_id=default_switch.id,
    private_ip="172.16.0.10",
    security_ips=["10.0.0.1"],
    instance_type="Redis",
    engine_version="4.0")
example = alicloud.kvstore.Account("example",
    account_name="tftestnormal",
    account_password="YourPassword_123",
    instance_id=default_instance.id)
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 = alicloud.getZones({
    availableResourceCreation: creation,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {cidrBlock: "172.16.0.0/16"});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
    vpcId: defaultNetwork.id,
    cidrBlock: "172.16.0.0/24",
    availabilityZone: defaultZones.then(defaultZones => defaultZones.zones[0].id),
    vswitchName: name,
});
const defaultInstance = new alicloud.kvstore.Instance("defaultInstance", {
    instanceClass: "redis.master.small.default",
    instanceName: name,
    vswitchId: defaultSwitch.id,
    privateIp: "172.16.0.10",
    securityIps: ["10.0.0.1"],
    instanceType: "Redis",
    engineVersion: "4.0",
});
const example = new alicloud.kvstore.Account("example", {
    accountName: "tftestnormal",
    accountPassword: "YourPassword_123",
    instanceId: defaultInstance.id,
});

Create a Account Resource

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            account_password: Optional[str] = None,
            account_privilege: Optional[str] = None,
            account_type: Optional[str] = None,
            description: Optional[str] = None,
            instance_id: Optional[str] = None,
            kms_encrypted_password: Optional[str] = None,
            kms_encryption_context: Optional[Mapping[str, Any]] = None)
@overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)
func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AccountArgs
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 AccountArgs
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 AccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Account Resource Properties

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

Inputs

The Account resource accepts the following input properties:

AccountName string
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
InstanceId string
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
AccountPassword 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 account_password and kms_encrypted_password fields.
AccountPrivilege string

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
AccountType string

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
Description string
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.
KmsEncryptedPassword string
An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, object>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
AccountName string
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
InstanceId string
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
AccountPassword 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 account_password and kms_encrypted_password fields.
AccountPrivilege string

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
AccountType string

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
Description string
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.
KmsEncryptedPassword string
An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]interface{}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
accountName string
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
instanceId string
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
accountPassword 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 account_password and kms_encrypted_password fields.
accountPrivilege string

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
accountType string

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
description string
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.
kmsEncryptedPassword string
An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: any}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
account_name str
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
instance_id str
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
account_password 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 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
account_type str

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
description 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.
kms_encrypted_password 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 Mapping[str, Any]
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.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of KVStore Account.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of KVStore Account.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of KVStore Account.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of KVStore Account.

Look up an Existing Account Resource

Get an existing Account 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?: AccountState, opts?: CustomResourceOptions): Account
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        account_password: Optional[str] = None,
        account_privilege: Optional[str] = None,
        account_type: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, Any]] = None,
        status: Optional[str] = None) -> Account
func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountName string
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
AccountPassword 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 account_password and kms_encrypted_password fields.
AccountPrivilege string

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
AccountType string

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
Description string
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.
InstanceId string
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
KmsEncryptedPassword string
An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, object>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
Status string
The status of KVStore Account.
AccountName string
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
AccountPassword 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 account_password and kms_encrypted_password fields.
AccountPrivilege string

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
AccountType string

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
Description string
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.
InstanceId string
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
KmsEncryptedPassword string
An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]interface{}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
Status string
The status of KVStore Account.
accountName string
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
accountPassword 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 account_password and kms_encrypted_password fields.
accountPrivilege string

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
accountType string

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
description string
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.
instanceId string
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
kmsEncryptedPassword string
An KMS encrypts password used to a KVStore account. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: any}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a KVStore account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
status string
The status of KVStore Account.
account_name str
The name of the account. The name must be 1 to 16 characters in length and contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
account_password 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 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
account_type str

Privilege type of account.

  • Normal: Common privilege. Default to Normal.
description 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 str
The Id of instance in which account belongs (The engine version of instance must be 4.0 or 4.0+).
kms_encrypted_password 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 Mapping[str, Any]
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.
status str
The status of KVStore Account.

Import

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

 $ pulumi import alicloud:kvstore/account:Account example <instance_id>:<account_name>

Package Details

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