Skip to content
v2.277.0

Experimental

@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

UserGroupProps Struct ​

Properties for defining an ElastiCache UserGroup.

Example ​

ts
const newDefaultUser = new elasticache.NoPasswordUser(this, 'NoPasswordUser', {
  userId: 'default',
  accessControl: elasticache.AccessControl.fromAccessString("on ~* +@all"),
})

const userGroup = new elasticache.UserGroup(this, 'UserGroup', {
  users: [newDefaultUser],
});
python
new_default_user = elasticache.NoPasswordUser(self, "NoPasswordUser",
    user_id="default",
    access_control=elasticache.AccessControl.from_access_string("on ~* +@all")
)

user_group = elasticache.UserGroup(self, "UserGroup",
    users=[new_default_user]
)
java
NoPasswordUser newDefaultUser = NoPasswordUser.Builder.create(this, "NoPasswordUser")
        .userId("default")
        .accessControl(AccessControl.fromAccessString("on ~* +@all"))
        .build();

UserGroup userGroup = UserGroup.Builder.create(this, "UserGroup")
        .users(List.of(newDefaultUser))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ElastiCache.Alpha
var newDefaultUser = new NoPasswordUser(this, "NoPasswordUser", new NoPasswordUserProps {
    UserId = "default",
    AccessControl = AccessControl.FromAccessString("on ~* +@all")
});

var userGroup = new UserGroup(this, "UserGroup", new UserGroupProps {
    Users = new [] { newDefaultUser }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2
newDefaultUser := elasticache.NewNoPasswordUser(this, jsii.String("NoPasswordUser"), &NoPasswordUserProps{
	UserId: jsii.String("default"),
	AccessControl: elasticache.AccessControl_FromAccessString(jsii.String("on ~* +@all")),
})

userGroup := elasticache.NewUserGroup(this, jsii.String("UserGroup"), &UserGroupProps{
	Users: []IUser{
		newDefaultUser,
	},
})

Properties ​

engineoptionalUserEngineengineoptionalUserEngineengineoptionalUserEngineEngineoptionalUserEngineEngineoptionalUserEngine = UserEngine.VALKEY #
The engine type for the user group Enum options: UserEngine.VALKEY, UserEngine.REDIS.
userGroupNameoptionalstringuser_group_nameoptionalstruserGroupNameoptionalStringUserGroupNameoptionalstringUserGroupNameoptional*string = <generated> #
Enforces a particular physical user group name.
usersoptionalIUser[]usersoptionaltyping.List[IUser]usersoptionalList<IUser>UsersoptionalIUser[]Usersoptional*[]IUser #
List of users inside the user group.

Default: no users