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

object

CfnElement

CfnRefElement

CfnResource

CfnUserGroup

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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

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).

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	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).
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>)	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).

Constructors

CfnUserGroup(Construct, string, ICfnUserGroupProps)

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).

public CfnUserGroup(Construct scope, string id, ICfnUserGroupProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnUserGroupProps: Resource properties.

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrStatus

Indicates user group status.

public virtual string AttrStatus { get; }

Property Value

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

string

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

CfnProperties

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).

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

Engine

The current supported values are valkey and redis.

public virtual string Engine { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

TagsRaw

The list of tags.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

UserGroupId

The ID of the user group.

public virtual string UserGroupId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

UserIds

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

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

Property Value

string[]

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

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.

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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).

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::ElastiCache::UserGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable