UserGroup

class aws_cdk.aws_elasticache_alpha.UserGroup(scope, id, *, engine=None, user_group_name=None, users=None)

Bases: UserGroupBase

(experimental) An ElastiCache UserGroup.

Stability:: experimental
Resource:: AWS::ElastiCache::UserGroup
ExampleMetadata:: infused

Example:

new_default_user = elasticache.NoPasswordUser(self, "NoPasswordUser",
    user_id="default",
    access_control=elasticache.AccessControl.from_access_string("on ~* +@all")
)

user_group = elasticache.UserGroup(self, "UserGroup",
    users=[new_default_user]
)

Parameters:

scope (Construct)
id (str)
engine (Optional[UserEngine]) – (experimental) The engine type for the user group Enum options: UserEngine.VALKEY, UserEngine.REDIS. Default: UserEngine.VALKEY
user_group_name (Optional[str]) – (experimental) Enforces a particular physical user group name. Default:
users (Optional[Sequence[IUser]]) – (experimental) List of users inside the user group. Default: - no users

Stability:

experimental

Methods

add_user(user)

(experimental) Add a user to this user group.

Parameters:: user (IUser) – The user to add to the group.
Stability:: experimental
Return type:: None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-elasticache.UserGroup'

engine

(experimental) The engine type for the user group.

Stability:: experimental

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

user_group_arn

(experimental) The ARN of the user group.

Stability:: experimental
Attribute:: true

user_group_name

(experimental) The name of the user group.

Stability:: experimental

user_group_status

(experimental) The status of the user group Can be ‘creating’, ‘active’, ‘modifying’, ‘deleting’.

Stability:: experimental
Attribute:: true

users

(experimental) Array of users in the user group.

Do not push directly to this array. Use addUser() instead to ensure proper validation and dependency management.

Stability:: experimental

Static Methods

classmethod from_user_group_arn(scope, id, user_group_arn)

(experimental) Import an existing user group by ARN.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
user_group_arn (str) – The ARN of the existing user group.

Stability:

experimental

Return type:

IUserGroup

classmethod from_user_group_attributes(scope, id, *, engine=None, user_group_arn=None, user_group_name=None, users=None)

(experimental) Import an existing user group using attributes.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
engine (Optional[UserEngine]) – (experimental) The engine type for the user group. Default: - engine type is unknown
user_group_arn (Optional[str]) – (experimental) The ARN of the user group. One of userGroupName or userGroupArn is required. Default: - derived from userGroupName
user_group_name (Optional[str]) – (experimental) The name of the user group. One of userGroupName or userGroupArn is required. Default: - derived from userGroupArn
users (Optional[Sequence[IUser]]) – (experimental) List of users in the user group. Default: - users are unknown

Stability:

experimental

Return type:

IUserGroup

classmethod from_user_group_name(scope, id, user_group_name)

(experimental) Import an existing user group by name.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
user_group_name (str) – The name of the existing user group.

Stability:

experimental

Return type:

IUserGroup

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_user_group(x)

(experimental) Return whether the given object is a UserGroup.

Parameters:: x (Any)
Stability:: experimental
Return type:: bool