CfnUserGroupProps

class aws_cdk.aws_elasticache.CfnUserGroupProps(*, engine, user_group_id, user_ids, tags=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 (Sequence[str]) – The list of user IDs that belong to the user group. A user named default must be included.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this user.

See:

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.
from aws_cdk import aws_elasticache as elasticache

cfn_user_group_props = elasticache.CfnUserGroupProps(
    engine="engine",
    user_group_id="userGroupId",
    user_ids=["userIds"],

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

engine

The current supported value is redis.

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

tags

An array of key-value pairs to apply to this user.

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

user_group_id

The ID of the user group.

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

user_ids

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

A user named default must be included.

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