aws-cdk-lib.aws_elasticache.CfnUserGroupProps

CfnUserGroupProps Struct

Properties for defining a CfnUserGroup.

CfnUserGroupProps

used as props by

• CfnUserGroup

Source

Generated code

Type last changed

v2.234.0 · 8 Jan 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnUserGroupProps: elasticache.CfnUserGroupProps = {
  engine: 'engine',
  userGroupId: 'userGroupId',
  userIds: ['userIds'],

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

enginestringenginestrengineStringEnginestringEngine*stringrequired#

The current supported values are valkey and redis.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

The list of tags.

userGroupIdstringuser_group_idstruserGroupIdStringUserGroupIdstringUserGroupId*stringrequired#

The ID of the user group.

userIdsstring[]user_idstyping.List[str]userIdsList<String>UserIdsstring[]UserIds*[]*stringrequired#

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

A user named default must be included.