Account

Provides a PolarDB account resource and used to manage databases.

NOTE: Available in v1.67.0+.

Create a Account Resource

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
def Account(resource_name, opts=None, account_description=None, account_name=None, account_password=None, account_type=None, db_cluster_id=None, kms_encrypted_password=None, kms_encryption_context=None, __props__=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.
opts ResourceOptions
A bag of options that control this 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

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.

AccountPassword string

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

DbClusterId string

The Id of cluster in which account belongs.

AccountDescription string

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

AccountType string

Account type, Valid values are Normal, Super, Default to Normal.

KmsEncryptedPassword string

An KMS encrypts password used to a db 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 db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

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

AccountPassword string

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

DbClusterId string

The Id of cluster in which account belongs.

AccountDescription string

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

AccountType string

Account type, Valid values are Normal, Super, Default to Normal.

KmsEncryptedPassword string

An KMS encrypts password used to a db 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 db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

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

accountPassword string

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

dbClusterId string

The Id of cluster in which account belongs.

accountDescription string

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

accountType string

Account type, Valid values are Normal, Super, Default to Normal.

kmsEncryptedPassword string

An KMS encrypts password used to a db 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 db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

account_name 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 str

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

db_cluster_id str

The Id of cluster in which account belongs.

account_description str

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

account_type str

Account type, Valid values are Normal, Super, Default to Normal.

kms_encrypted_password str

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

kms_encryption_context Dict[str, Any]

An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a db 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.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

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
static get(resource_name, id, opts=None, account_description=None, account_name=None, account_password=None, account_type=None, db_cluster_id=None, kms_encrypted_password=None, kms_encryption_context=None, __props__=None);
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:

AccountDescription string

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

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

AccountPassword string

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

AccountType string

Account type, Valid values are Normal, Super, Default to Normal.

DbClusterId string

The Id of cluster in which account belongs.

KmsEncryptedPassword string

An KMS encrypts password used to a db 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 db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

AccountDescription string

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

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

AccountPassword string

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

AccountType string

Account type, Valid values are Normal, Super, Default to Normal.

DbClusterId string

The Id of cluster in which account belongs.

KmsEncryptedPassword string

An KMS encrypts password used to a db 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 db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

accountDescription string

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

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

accountPassword string

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

accountType string

Account type, Valid values are Normal, Super, Default to Normal.

dbClusterId string

The Id of cluster in which account belongs.

kmsEncryptedPassword string

An KMS encrypts password used to a db 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 db account with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

account_description str

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

account_name 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 str

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

account_type str

Account type, Valid values are Normal, Super, Default to Normal.

db_cluster_id str

The Id of cluster in which account belongs.

kms_encrypted_password str

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

kms_encryption_context Dict[str, Any]

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

Package Details

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