Class CfnUserGroup
A CloudFormation AWS::ElastiCache::UserGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.AWS.ElastiCache.dll
Syntax (csharp)
public class CfnUserGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUserGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
CloudformationResource: AWS::ElastiCache::UserGroup
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache;
var cfnUserGroup = new CfnUserGroup(this, "MyCfnUserGroup", new CfnUserGroupProps {
Engine = "engine",
UserGroupId = "userGroupId",
UserIds = new [] { "userIds" },
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnUserGroup(Construct, String, ICfnUserGroupProps) | Create a new |
CfnUserGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the user group. |
AttrStatus | Indicates user group status. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Engine | The current supported value is redis. |
Tags |
|
UserGroupId | The ID of the user group. |
UserIds | The list of user IDs that belong to the user group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserGroup(Construct, String, ICfnUserGroupProps)
Create a new AWS::ElastiCache::UserGroup
.
public CfnUserGroup(Construct scope, string id, ICfnUserGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnUserGroupProps
- resource properties.
CfnUserGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the user group.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrStatus
Indicates user group status.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
Can be "creating", "active", "modifying", "deleting".
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Engine
The current supported value is redis.
public virtual string Engine { get; set; }
Property Value
System.String
Remarks
Tags
AWS::ElastiCache::UserGroup.Tags
.
public virtual TagManager Tags { get; }
Property Value
Remarks
UserGroupId
The ID of the user group.
public virtual string UserGroupId { get; set; }
Property Value
System.String
Remarks
UserIds
The list of user IDs that belong to the user group.
public virtual string[] UserIds { get; set; }
Property Value
System.String[]
Remarks
A user named default
must be included.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>