Skip to content

Account

This class encapsulates and extends the ROS resource type ALIYUN::RDS::Account, which is used to create a database account for an ApsaraDB for RDS instance.

Initializers

import ros_cdk_rds
ros_cdk_rds.Account(
  scope: Construct,
  id: str,
  account_name: typing.Union[str, IResolvable],
  account_password: typing.Union[str, IResolvable],
  db_instance_id: typing.Union[str, IResolvable],
  account_description: typing.Union[str, IResolvable] = None,
  account_type: 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: Account name, which must be unique and meet the following requirements: Start with a letter;
account_password typing.Union[str, ros_cdk_core.IResolvable] Property accountPassword: The account password for the database instance.
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: RDS instance ID.
account_description typing.Union[str, ros_cdk_core.IResolvable] Property accountDescription: Account remarks.
account_type typing.Union[str, ros_cdk_core.IResolvable] Property accountType: Privilege type of 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: Account name, which must be unique and meet the following requirements: Start with a letter;

Consist of lower-case letters, digits, and underscores (_); Length: MySQL 8.0 and 5.7: 2-32 characters. MySQL 5.6态MariaDB and PostgreSQL Local version: 2-16 characters. SQL Server: 2-64 characters. PostgreSQL Cloud version: 2-63 characters.


account_passwordRequired

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

Property accountPassword: The account password for the database instance.

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


db_instance_idRequired

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

Property dbInstanceId: RDS instance ID.


account_descriptionOptional

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

Property accountDescription: Account remarks.

It cannot begin with http:// or https://. It must start with a Chinese character or English letter. It can include Chinese and English characters/letters, underscores (_), hyphens (-), and digits. The length may be 2-256 characters.


account_typeOptional

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

Property accountType: Privilege type of account.

Normal: Common privilege. Super: High privilege. And the default value is Normal. Sysadmin: Super privileges (SA) (only supported by SQL Server) This parameter is valid for MySQL 5.5/5.6 only. MySQL 5.7, SQL Server 2012/2016, PostgreSQL, and PPAS each can have only one initial account. Other accounts are created by the initial account that has logged on to the database.


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_rds
ros_cdk_rds.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.
attr_account_name ros_cdk_core.IResolvable Attribute AccountName: Account name.

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

attr_account_nameRequired

attr_account_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountName: Account name.