Class CfnUserGroup

For Valkey 7.2 and onwards, or Redis OSS 6.0 and onwards: Creates a user group. For more information, see Using Role Based Access Control (RBAC).

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnUserGroup
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnUserGroup
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html

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(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
CfnUserGroup(Construct, String, ICfnUserGroupProps)

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 values are valkey and redis.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The list of 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(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

CfnUserGroup(Construct, String, ICfnUserGroupProps)

public CfnUserGroup(Construct scope, string id, ICfnUserGroupProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnUserGroupProps

Resource properties.

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 values are valkey and redis.

public virtual string Engine { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

The list of tags.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

UserGroupId

The ID of the user group.

public virtual string UserGroupId { get; set; }
Property Value

System.String

UserIds

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

public virtual string[] UserIds { get; set; }
Property Value

System.String[]

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>

Overrides

Implements