Skip to content

Account

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Account, which is used to create a database account for a specified PolarDB cluster.

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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
account_name typing.Union[str, ros_cdk_core.IResolvable] Property accountName: The name of the database account.
account_password typing.Union[str, ros_cdk_core.IResolvable] Property accountPassword: The password of the database account.
db_cluster_id 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 typing.Union[str, ros_cdk_core.IResolvable] Property accountDescription: The description of the database account.
account_privilege typing.Union[str, ros_cdk_core.IResolvable] Property accountPrivilege: The permissions of the database account on the database.
account_type typing.Union[str, ros_cdk_core.IResolvable] Property accountType: The type of the database account.
db_name typing.Union[str, ros_cdk_core.IResolvable] Property dbName: The name of the database whose access permissions are to be granted to the database account.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

account_nameRequired

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

Property accountName: The name of the database account.

The name must comply with the following rules:

  • It must start with a lowercase letter and consist of lowercase letters, digits, and underscores (_).
  • It can be up to 16 characters in length.

account_passwordRequired

  • 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_idRequired

  • 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_descriptionOptional

  • 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_privilegeOptional

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

Property accountPrivilege: The permissions of the database account on the database.

Valid values: ReadWrite: has read and write permissions on the database. ReadOnly: has the read-only permission on the database. DMLOnly: runs only data manipulation language (DML) statements. DDLOnly: runs only data definition language (DDL) statements. Default value: ReadWrite. Separate multiple permissions with a comma (,).

account_typeOptional

  • 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_nameOptional

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

Property dbName: The name of the database whose access permissions are to be granted to the database account.

Separate multiple databases with a comma (,).

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource