Skip to content
v2.276.0

Experimental

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

UserGroupAttributes Struct ​

Attributes that can be specified when importing a UserGroup.

Example ​

ts
const stack = new Stack();

const importedIamUser = elasticache.IamUser.fromUserId(this, 'ImportedIamUser', 'my-iam-user-id');

const importedPasswordUser = elasticache.PasswordUser.fromUserAttributes(stack, 'ImportedPasswordUser', {
  userId: 'my-password-user-id',
});

const importedNoPasswordUser = elasticache.NoPasswordUser.fromUserAttributes(stack, 'ImportedNoPasswordUser', {
  userId: 'my-no-password-user-id',
});

const importedUserGroup = elasticache.UserGroup.fromUserGroupAttributes(this, 'ImportedUserGroup', {
  userGroupName: 'my-user-group-name'
});
python
stack = Stack()

imported_iam_user = elasticache.IamUser.from_user_id(self, "ImportedIamUser", "my-iam-user-id")

imported_password_user = elasticache.PasswordUser.from_user_attributes(stack, "ImportedPasswordUser",
    user_id="my-password-user-id"
)

imported_no_password_user = elasticache.NoPasswordUser.from_user_attributes(stack, "ImportedNoPasswordUser",
    user_id="my-no-password-user-id"
)

imported_user_group = elasticache.UserGroup.from_user_group_attributes(self, "ImportedUserGroup",
    user_group_name="my-user-group-name"
)
java
Stack stack = new Stack();

IUser importedIamUser = IamUser.fromUserId(this, "ImportedIamUser", "my-iam-user-id");

IUser importedPasswordUser = PasswordUser.fromUserAttributes(stack, "ImportedPasswordUser", UserBaseAttributes.builder()
        .userId("my-password-user-id")
        .build());

IUser importedNoPasswordUser = NoPasswordUser.fromUserAttributes(stack, "ImportedNoPasswordUser", UserBaseAttributes.builder()
        .userId("my-no-password-user-id")
        .build());

IUserGroup importedUserGroup = UserGroup.fromUserGroupAttributes(this, "ImportedUserGroup", UserGroupAttributes.builder()
        .userGroupName("my-user-group-name")
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.ElastiCache.Alpha
var stack = new Stack();

var importedIamUser = IamUser.FromUserId(this, "ImportedIamUser", "my-iam-user-id");

var importedPasswordUser = PasswordUser.FromUserAttributes(stack, "ImportedPasswordUser", new UserBaseAttributes {
    UserId = "my-password-user-id"
});

var importedNoPasswordUser = NoPasswordUser.FromUserAttributes(stack, "ImportedNoPasswordUser", new UserBaseAttributes {
    UserId = "my-no-password-user-id"
});

var importedUserGroup = UserGroup.FromUserGroupAttributes(this, "ImportedUserGroup", new UserGroupAttributes {
    UserGroupName = "my-user-group-name"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2
stack := awscdk.Newstack()

importedIamUser := elasticache.IamUser_FromUserId(this, jsii.String("ImportedIamUser"), jsii.String("my-iam-user-id"))

importedPasswordUser := elasticache.PasswordUser_FromUserAttributes(stack, jsii.String("ImportedPasswordUser"), &UserBaseAttributes{
	UserId: jsii.String("my-password-user-id"),
})

importedNoPasswordUser := elasticache.NoPasswordUser_FromUserAttributes(stack, jsii.String("ImportedNoPasswordUser"), &UserBaseAttributes{
	UserId: jsii.String("my-no-password-user-id"),
})

importedUserGroup := elasticache.UserGroup_FromUserGroupAttributes(this, jsii.String("ImportedUserGroup"), &UserGroupAttributes{
	UserGroupName: jsii.String("my-user-group-name"),
})

Properties ​

engineoptionalUserEngineengineoptionalUserEngineengineoptionalUserEngineEngineoptionalUserEngineEngineoptionalUserEngine#
The engine type for the user group.

Default: engine type is unknown

userGroupArnoptionalstringuser_group_arnoptionalstruserGroupArnoptionalStringUserGroupArnoptionalstringUserGroupArnoptional*string#
The ARN of the user group.

Default: derived from userGroupName

One of userGroupName or userGroupArn is required.

userGroupNameoptionalstringuser_group_nameoptionalstruserGroupNameoptionalStringUserGroupNameoptionalstringUserGroupNameoptional*string#
The name of the user group.

Default: derived from userGroupArn

One of userGroupName or userGroupArn is required.

usersoptionalIUser[]usersoptionaltyping.List[IUser]usersoptionalList<IUser>UsersoptionalIUser[]Usersoptional*[]IUser#
List of users in the user group.

Default: users are unknown