interface CfnUserGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.ElastiCache.CfnUserGroupProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticache#CfnUserGroupProps
Java	software.amazon.awscdk.services.elasticache.CfnUserGroupProps
Python	aws_cdk.aws_elasticache.CfnUserGroupProps
TypeScript	aws-cdk-lib » aws_elasticache » CfnUserGroupProps

Properties for defining a CfnUserGroup.

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

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

Name	Type	Description
engine	string	The current supported values are valkey and redis.
userGroupId	string	The ID of the user group.
userIds	string[]	The list of user IDs that belong to the user group.
tags?	CfnTag[]	The list of tags.

---

engine

Type: string

The current supported values are valkey and redis.

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

---

userGroupId

Type: string

The ID of the user group.

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

---

userIds

Type: string[]

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

A user named default must be included.

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

---

tags?

Type: CfnTag[] (optional)

The list of tags.

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