IamUser

class aws_cdk.aws_elasticache_alpha.IamUser(scope, id, *, user_name=None, access_control, user_id, engine=None)

Bases: UserBase

(experimental) Define an ElastiCache user with IAM authentication.

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

Example:

user = elasticache.IamUser(self, "User",
    # set user engine
    engine=elasticache.UserEngine.REDIS,

    # set user id
    user_id="my-user",

    # set username
    user_name="my-user",

    # set access string
    access_control=elasticache.AccessControl.from_access_string("on ~* +@all")
)

Parameters:

scope (Construct)
id (str)
user_name (Optional[str]) – (experimental) The name of the user. Default: - Same as userId.
access_control (AccessControl) – (experimental) Access control configuration for the user.
user_id (str) – (experimental) The ID of the user.
engine (Optional[UserEngine]) – (experimental) The engine type for the user. Enum options: UserEngine.VALKEY, UserEngine.REDIS. Default: UserEngine.VALKEY.

Stability:

experimental

Methods

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

grant(grantee, *actions)

(experimental) Grant the given identity custom permissions.

Parameters:

grantee (IGrantable) – The IAM identity to grant permissions to.
actions (str) – The actions to grant.

Stability:

experimental

Return type:

Grant

grant_connect(grantee)

(experimental) Grant connect permissions to the given IAM identity.

Parameters:: grantee (IGrantable) – The IAM identity to grant permissions to.
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

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

access_string

(experimental) The access string that defines the user’s permissions.

Stability:: experimental

engine

(experimental) The engine for the user.

Stability:: experimental

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The tree node.

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

user_arn

(experimental) The user’s ARN.

Stability:: experimental
Attribute:: true

user_id

(experimental) The user’s ID.

Stability:: experimental
Attribute:: true

user_name

(experimental) The user’s name.

For IAM authentication userName must be equal to userId.

Stability:: experimental
Attribute:: true

user_status

(experimental) The user’s status.

Can be ‘active’, ‘modifying’, ‘deleting’.

Stability:: experimental
Attribute:: true

Static Methods

classmethod from_user_arn(scope, id, user_arn)

(experimental) Import an existing user by ARN.

Parameters:

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

Stability:

experimental

Return type:

IUser

classmethod from_user_attributes(scope, id, *, engine=None, user_arn=None, user_id=None, user_name=None)

(experimental) Import an existing user 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. Default: - engine type is unknown.
user_arn (Optional[str]) – (experimental) The ARN of the user. One of userId or userArn is required. Default: - derived from userId.
user_id (Optional[str]) – (experimental) The ID of the user. One of userId or userArn is required. Default: - derived from userArn.
user_name (Optional[str]) – (experimental) The user’s name. Default: - name is unknown.

Stability:

experimental

Return type:

IUser

classmethod from_user_id(scope, id, user_id)

(experimental) Import an existing user by ID.

Parameters:

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

Stability:

experimental

Return type:

IUser

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_iam_user(x)

(experimental) Return whether the given object is an IamUser.

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

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