CfnUserProps

class aws_cdk.aws_elasticache.CfnUserProps(*, engine, user_id, user_name, access_string=None, authentication_mode=None, no_password_required=None, passwords=None, tags=None)

Bases: object

Properties for defining a CfnUser.

Parameters:

  • engine (str) – The current supported value is redis.

  • user_id (str) – The ID of the user.

  • user_name (str) – The username of the user.

  • access_string (Optional[str]) – Access permissions string used for this user.

  • authentication_mode (Any) – Specifies the authentication mode to use. Below is an example of the possible JSON values:. Example:: { Passwords: [”*”, “**”] // If Type is password. }

  • no_password_required (Union[bool, IResolvable, None]) – Indicates a password is not required for this user.

  • passwords (Optional[Sequence[str]]) – Passwords used for this user. You can create up to two passwords for each user.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The list of tags.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticache as elasticache

# authentication_mode: Any

cfn_user_props = elasticache.CfnUserProps(
    engine="engine",
    user_id="userId",
    user_name="userName",

    # the properties below are optional
    access_string="accessString",
    authentication_mode=authentication_mode,
    no_password_required=False,
    passwords=["passwords"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

access_string

Access permissions string used for this user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-accessstring

authentication_mode

.

Example:

{ Passwords: ["*****", "******"] // If Type is password.
}
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-authenticationmode

Type:

Specifies the authentication mode to use. Below is an example of the possible JSON values

engine

The current supported value is redis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-engine

no_password_required

Indicates a password is not required for this user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-nopasswordrequired

passwords

Passwords used for this user.

You can create up to two passwords for each user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-passwords

tags

The list of tags.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-tags

user_id

The ID of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-userid

user_name

The username of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-username