Class CfnUserGroup

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.511Z") @Stability(Stable) public class CfnUserGroup extends CfnResource implements IInspectable
A CloudFormation AWS::ElastiCache::UserGroup.

For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnUserGroup cfnUserGroup = CfnUserGroup.Builder.create(this, "MyCfnUserGroup")
         // the properties below are optional
  • Field Details


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

    • CfnUserGroup

      protected CfnUserGroup( objRef)
    • CfnUserGroup

      protected CfnUserGroup( initializationMode)
    • CfnUserGroup

      @Stability(Stable) public CfnUserGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserGroupProps props)
      Create a new AWS::ElastiCache::UserGroup.

      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.
  • Method Details

    • inspect

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

      Specified by:
      inspect in interface IInspectable
      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)
      renderProperties in class CfnResource
      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()
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The current supported value is redis.
    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The current supported value is 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.

      A user named default must be included.

    • setUserIds

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

      A user named default must be included.