software.amazon.awscdk.services.elasticache

Class CfnUserGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.elasticache.CfnUserGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.989Z")
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")
         .userIds(List.of("userIds"))
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnUserGroup(Construct scope,
                    java.lang.String id,
                    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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrStatus

public java.lang.String getAttrStatus()

Indicates user group status.

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

`AWS::ElastiCache::UserGroup.Tags`.

getEngine

public java.lang.String getEngine()

The current supported value is redis.

setEngine

public void setEngine(java.lang.String value)

The current supported value is redis.

getUserGroupId

public java.lang.String getUserGroupId()

The ID of the user group.

setUserGroupId

public void setUserGroupId(java.lang.String value)

The ID of the user group.

getUserIds

public java.util.List<java.lang.String> getUserIds()

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

A user named default must be included.

setUserIds

public void setUserIds(java.util.List<java.lang.String> value)

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

A user named default must be included.