CfnUserGroupProps

class aws_cdk.aws_elasticache.CfnUserGroupProps(*, engine, user_group_id, user_ids=None)

Bases: object

Properties for defining a CfnUserGroup.

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

  • user_group_id (str) – The ID of the user group.

  • user_ids (Optional[Sequence[str]]) – The list of user IDs that belong to the user group. A user named default must be included.

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_user_group_props = elasticache.CfnUserGroupProps(
    engine="engine",
    user_group_id="userGroupId",

    # the properties below are optional
    user_ids=["userIds"]
)

Attributes

engine

The current supported value is redis.

Link

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

Return type

str

user_group_id

The ID of the user group.

Link

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

Return type

str

user_ids

The list of user IDs that belong to the user group.

A user named default must be included.

Link

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

Return type

Optional[List[str]]