Account

• Implements: IAccount

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::AccountThe , which resource type creates accounts for PolarDB databases.

Initializers

import ros_cdk_polardb
ros_cdk_polardb.Account(
  scope: Construct,
  id: str,
  account_name: typing.Union[str, IResolvable],
  account_password: typing.Union[str, IResolvable],
  db_cluster_id: typing.Union[str, IResolvable],
  account_description: typing.Union[str, IResolvable] = None,
  account_privilege: typing.Union[str, IResolvable] = None,
  account_type: typing.Union[str, IResolvable] = None,
  db_name: typing.Union[str, IResolvable] = None,
  priv_for_all_db: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

account_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountName: The name of the database account.

The name must meet the following requirements:

• It must start with a lowercase letter and end with a letter or a digit.
• It can contain lowercase letters, digits, and underscores (_).
• It must be 1 to 16 characters in length.
• It cannot be a reserved keyword, such as root or admin.

account_password^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountPassword: The password of the database account.

The password must comply with the following rules:

• It must consist of uppercase letters, lowercase letters, digits, and special characters.
• Special characters include exclamation points (!), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).
• It must be 8 to 32 characters in length.

db_cluster_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database account is to be created.

account_description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountDescription: The description of the database account.

The description must comply with the following rules:

• It cannot start with http:// or https://.
• It must be 2 to 256 characters in length.

account_privilege^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountPrivilege: The privilege level to grant on the specified databases.

Valid values:

• ReadWrite: read and write permissions
• ReadOnly: read-only permissions
• DMLOnly: DML permissions only
• DDLOnly: DDL permissions only
• ReadIndex: read-only and index permissions

• This parameter takes effect only when you specify the DBName parameter.
• If you specify multiple databases in DBName, you must specify a corresponding permission for each in AccountPrivilege, separated by commas. The AccountPrivilege string cannot exceed 900 characters. For example, to grant read and write permissions to database DB1 and read-only permissions to database DB2, set DBName to DB1,DB2 and set AccountPrivilege to ReadWrite,ReadOnly.
• This parameter applies only to standard accounts on PolarDB for MySQL clusters.

account_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountType: The type of the database account.

Valid values:

• Normal: standard account
• Super: privileged account Default value: Super. Currently, POLARDB for PostgreSQL and POLARDB compatible with Oracle do not support standard accounts. You can create only one privileged account for an ApsaraDB for POLARDB cluster.

db_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbName: The name of the database that the account can access.

To specify multiple databases, separate the database names with a comma (,).

This parameter applies only to standard accounts on PolarDB for MySQL clusters.

priv_for_all_db^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property privForAllDb: Whether to grant permissions to all libraries in the current cluster and any libraries that will be added in the future.

Valid values:

• 0 (default)): Not authorized.
• 1: Authorization.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_polardb
ros_cdk_polardb.Account.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

props^Required

props: AccountProps

• Type: AccountProps