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 com.aliyun.ros.cdk.redis.Account;
Account.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accountName(java.lang.String)
    .accountName(IResolvable)
    .accountPassword(java.lang.String)
    .accountPassword(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .accountDescription(java.lang.String)
//  .accountDescription(IResolvable)
//  .accountPrivilege(java.lang.String)
//  .accountPrivilege(IResolvable)
//  .accountType(java.lang.String)
//  .accountType(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
accountName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountName: The name of the account.
accountPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountPassword: The password of the account.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the instance for which you want to create the account.
accountDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountDescription: The description of the account.
accountPrivilege java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountPrivilege: The permission of the account.
accountType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountType: The type of the account.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

accountNameRequired

  • Type: java.lang.String OR com.aliyun.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.


accountPasswordRequired

  • Type: java.lang.String OR com.aliyun.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 (=).


instanceIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


accountDescriptionOptional

  • Type: java.lang.String OR com.aliyun.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.


accountPrivilegeOptional

  • Type: java.lang.String OR com.aliyun.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.


accountTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accountType: The type of the account.

Set this parameter to Normal.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.redis.Account;
Account.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAccountName com.aliyun.ros.cdk.core.IResolvable Attribute AccountName: The name of the account.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The name of the instance.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAccountNameRequired

public IResolvable getAttrAccountName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AccountName: The name of the account.


attrInstanceIdRequired

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The name of the instance.