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:
- Account
Name 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.
- Account
Password string Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
- Db
Cluster stringId The Id of cluster in which account belongs.
- Account
Description 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.
- Account
Type string Account type, Valid values are
Normal,Super, Default toNormal.- Kms
Encrypted stringPassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.
- Account
Name 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.
- Account
Password string Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
- Db
Cluster stringId The Id of cluster in which account belongs.
- Account
Description 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.
- Account
Type string Account type, Valid values are
Normal,Super, Default toNormal.- Kms
Encrypted stringPassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.
- account
Name 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.
- account
Password string Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
- db
Cluster stringId The Id of cluster in which account belongs.
- account
Description 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.
- account
Type string Account type, Valid values are
Normal,Super, Default toNormal.- kms
Encrypted stringPassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis 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_ strid 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 toNormal.- kms_
encrypted_ strpassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- kms_
encryption_ Dict[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.
Outputs
All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:
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): Accountstatic 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:
- Account
Description 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.
- Account
Name 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.
- Account
Password string Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
- Account
Type string Account type, Valid values are
Normal,Super, Default toNormal.- Db
Cluster stringId The Id of cluster in which account belongs.
- Kms
Encrypted stringPassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.
- Account
Description 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.
- Account
Name 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.
- Account
Password string Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
- Account
Type string Account type, Valid values are
Normal,Super, Default toNormal.- Db
Cluster stringId The Id of cluster in which account belongs.
- Kms
Encrypted stringPassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.
- account
Description 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.
- account
Name 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.
- account
Password string Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
- account
Type string Account type, Valid values are
Normal,Super, Default toNormal.- db
Cluster stringId The Id of cluster in which account belongs.
- kms
Encrypted stringPassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis 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 toNormal.- db_
cluster_ strid The Id of cluster in which account belongs.
- kms_
encrypted_ strpassword An KMS encrypts password used to a db account. If the
account_passwordis filled in, this field will be ignored.- kms_
encryption_ Dict[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating a db account withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.
Package Details
- Repository
- https://github.com/pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.