Skip to content

Account

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::Account, which is used to create an account that has the specified permissions on an ApsaraDB for Redis instance.

Initializers 

import ros_cdk_redis
ros_cdk_redis.Account(
  scope: Construct,
  id: str,
  account_name: typing.Union[str, IResolvable],
  account_password: typing.Union[str, IResolvable],
  instance_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,
  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 account.
account_password typing.Union[str, ros_cdk_core.IResolvable] Property accountPassword: The password of the account.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the instance for which you want to create the account.
account_description typing.Union[str, ros_cdk_core.IResolvable] Property accountDescription: The description of the account.
account_privilege typing.Union[str, ros_cdk_core.IResolvable] Property accountPrivilege: The permission of the account.
account_type typing.Union[str, ros_cdk_core.IResolvable] Property accountType: The type of the 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 account.

The name must start with a lowercase letter and can contain lowercase letters, digits, and underscores (_). The name can be 1 to 16 characters in length.

account_passwordRequired

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

Property accountPassword: The password of the account.

The password can be 8 to 32 characters in length and must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! at signs (@), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).

instance_idRequired

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

Property instanceId: The ID of the instance for which you want to create the account.

account_descriptionOptional

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

Property accountDescription: The description of the account.

The description must start with a letter, and cannot start with http:// or https://. The description can contain letters, underscores (_), hyphens (-), and digits. It can be 2 to 256 characters in length.

account_privilegeOptional

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

Property accountPrivilege: The permission of the account.

Valid values: RoleReadOnly RoleReadWrite (default value) RoleRepl Note In addition to reading data from and writing data to the ApsaraDB for Redis instance, an account with the RoleRepl permission can run the SYNC and PSYNC commands. The RoleRepl permission can be granted to an account only in an ApsaraDB for Redis instance of the standard edition in Redis 4.0.

account_typeOptional

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

Property accountType: The type of the account.

Set this parameter to Normal.

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_redis
ros_cdk_redis.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: The name of the account.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The name of the instance.

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: The name of the account.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The name of the instance.