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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.012Z")
 @Stability(value=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)

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")
         // the properties below are optional
         .userIds(List.of("userIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUserGroup.Builder A fluent builder for CfnUserGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserGroup(software.constructs.Construct scope, String id, CfnUserGroupProps props) Create a new `AWS::ElastiCache::UserGroup`.
protected	CfnUserGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the user group.
String	getAttrStatus() Indicates user group status.
protected Map<String,Object>	getCfnProperties()
String	getEngine() The current supported value is redis.
String	getUserGroupId() The ID of the user group.
List<String>	getUserIds() The list of user IDs that belong to the user group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEngine(String value) The current supported value is redis.
void	setUserGroupId(String value) The ID of the user group.
void	setUserIds(List<String> value) The list of user IDs that belong to the user group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserGroup

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

CfnUserGroup

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

CfnUserGroup

@Stability(value=Stable)
public CfnUserGroup(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnUserGroupProps props)

Create a new `AWS::ElastiCache::UserGroup`.

Parameters:

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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the user group.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

Indicates user group status.

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEngine

@Stability(value=Stable)
 @NotNull
public String getEngine()

The current supported value is redis.

setEngine

@Stability(value=Stable)
public void setEngine(@NotNull
                                               String value)

The current supported value is redis.

getUserGroupId

@Stability(value=Stable)
 @NotNull
public String getUserGroupId()

The ID of the user group.

setUserGroupId

@Stability(value=Stable)
public void setUserGroupId(@NotNull
                                                    String value)

The ID of the user group.

getUserIds

@Stability(value=Stable)
 @Nullable
public List<String> getUserIds()

The list of user IDs that belong to the user group.

A user named default must be included.

setUserIds

@Stability(value=Stable)
public void setUserIds(@Nullable
                                                List<String> value)

The list of user IDs that belong to the user group.

A user named default must be included.