Package software.amazon.awscdk.services.elasticache

Interface CfnUserGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-03-14T22:21:55.221Z")
@Stability(Stable)
public interface CfnUserGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnUserGroupProps cfnUserGroupProps = CfnUserGroupProps.builder()
         .engine("engine")
         .userGroupId("userGroupId")
         .userIds(List.of("userIds"))
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserGroupProps.Builder	A builder for CfnUserGroupProps
static final class	CfnUserGroupProps.Jsii$Proxy	An implementation for CfnUserGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnUserGroupProps.Builder	builder()
String	getEngine()	The current supported value is redis.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this user.
String	getUserGroupId()	The ID of the user group.
List<String>	getUserIds()	The list of user IDs that belong to the user group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngine

@Stability(Stable)
@NotNull
String getEngine()

The current supported value is redis.

See Also:

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

getUserGroupId

@Stability(Stable)
@NotNull
String getUserGroupId()

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

getUserIds

@Stability(Stable)
@NotNull
List<String> getUserIds()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnUserGroupProps.Builder builder()

Returns:

a CfnUserGroupProps.Builder of CfnUserGroupProps