@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.989Z") public class CfnUserGroup extends CfnResource implements IInspectable
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") .userIds(List.of("userIds")) // the properties below are optional .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnUserGroup.Builder
A fluent builder for
CfnUserGroup . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnUserGroup(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the user group.
|
java.lang.String |
getAttrStatus()
Indicates user group status.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getEngine()
The current supported value is redis.
|
TagManager |
getTags()
`AWS::ElastiCache::UserGroup.Tags`.
|
java.lang.String |
getUserGroupId()
The ID of the user group.
|
java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setEngine(java.lang.String value)
The current supported value is redis.
|
void |
setUserGroupId(java.lang.String value)
The ID of the user group.
|
void |
setUserIds(java.util.List<java.lang.String> value)
The list of user IDs that belong to the user group.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUserGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUserGroup(Construct scope, java.lang.String id, CfnUserGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrStatus()
Can be "creating", "active", "modifying", "deleting".
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getEngine()
public void setEngine(java.lang.String value)
public java.lang.String getUserGroupId()
public void setUserGroupId(java.lang.String value)
public java.util.List<java.lang.String> getUserIds()
A user named default
must be included.
public void setUserIds(java.util.List<java.lang.String> value)
A user named default
must be included.