UserBaseAttributes

class aws_cdk.aws_elasticache_alpha.UserBaseAttributes(*, engine=None, user_arn=None, user_id=None, user_name=None)

Bases: object

(experimental) Attributes for importing an existing ElastiCache user.

Parameters:
  • 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

ExampleMetadata:

infused

Example:

# use the original `default` user by using import method
default_user = elasticache.NoPasswordUser.from_user_attributes(self, "DefaultUser",
    # userId and userName must be 'default'
    user_id="default"
)

# create a new default user
new_default_user = elasticache.NoPasswordUser(self, "NewDefaultUser",
    # new default user id must not be 'default'
    user_id="new-default",
    # new default username must be 'default'
    user_name="default",
    # set access string
    access_control=elasticache.AccessControl.from_access_string("on ~* +@all")
)

Attributes

engine

(experimental) The engine type for the user.

Default:
  • engine type is unknown.

Stability:

experimental

user_arn

(experimental) The ARN of the user.

One of userId or userArn is required.

Default:
  • derived from userId.

Stability:

experimental

user_id

(experimental) The ID of the user.

One of userId or userArn is required.

Default:
  • derived from userArn.

Stability:

experimental

user_name

(experimental) The user’s name.

Default:
  • name is unknown.

Stability:

experimental