Package software.amazon.awscdk.services.elasticache

Class CfnUserGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.elasticache.CfnUserGroup
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IUserGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:05.749Z") @Stability(Stable) public class CfnUserGroup extends CfnResource implements IInspectable, IUserGroupRef, ITaggable
For Valkey 7.2 and onwards, or Redis OSS 6.0 and onwards: Creates a user group. For more information, see Using Role Based Access Control (RBAC).

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.*;
 CfnUserGroup cfnUserGroup = CfnUserGroup.Builder.create(this, "MyCfnUserGroup")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserGroup

      protected CfnUserGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserGroup

      protected CfnUserGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserGroup

      @Stability(Stable) public CfnUserGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromUserGroupArn

      @Stability(Stable) @NotNull public static IUserGroupRef fromUserGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IUserGroupRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromUserGroupId

      @Stability(Stable) @NotNull public static IUserGroupRef fromUserGroupId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String userGroupId)
      Creates a new IUserGroupRef from a userGroupId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      userGroupId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the user group.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Indicates user group status.

      Can be "creating", "active", "modifying", "deleting".

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getUserGroupRef

      @Stability(Stable) @NotNull public UserGroupReference getUserGroupRef()
      A reference to a UserGroup resource.
      Specified by:
      getUserGroupRef in interface IUserGroupRef

    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The current supported values are valkey and redis.

    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The current supported values are valkey and redis.

    • getUserGroupId

      @Stability(Stable) @NotNull public String getUserGroupId()
      The ID of the user group.

    • setUserGroupId

      @Stability(Stable) public void setUserGroupId(@NotNull String value)
      The ID of the user group.

    • getUserIds

      @Stability(Stable) @NotNull public List<String> getUserIds()
      The list of user IDs that belong to the user group.

    • setUserIds

      @Stability(Stable) public void setUserIds(@NotNull List<String> value)
      The list of user IDs that belong to the user group.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of tags.