Class UserGroup

(experimental) An ElastiCache UserGroup.

Inheritance

object

Resource

UserGroupBase

UserGroup

Implements

IUserGroup

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.ElastiCache.Alpha

Assembly: Amazon.CDK.AWS.ElastiCache.Alpha.dll

Syntax (csharp)

public class UserGroup : UserGroupBase, IUserGroup, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class UserGroup Inherits UserGroupBase Implements IUserGroup, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

Resource: AWS::ElastiCache::UserGroup

ExampleMetadata: infused

Examples

var newDefaultUser = new NoPasswordUser(this, "NoPasswordUser", new NoPasswordUserProps {
                 UserId = "default",
                 AccessControl = AccessControl.FromAccessString("on ~* +@all")
             });

             var userGroup = new UserGroup(this, "UserGroup", new UserGroupProps {
                 Users = new [] { newDefaultUser }
             });

Synopsis

Constructors

UserGroup(Construct, string, IUserGroupProps?)

(experimental) An ElastiCache UserGroup.

Properties

Engine	(experimental) The engine type for the user group.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
UserGroupArn	(experimental) The ARN of the user group.
UserGroupName	(experimental) The name of the user group.
UserGroupStatus	(experimental) The status of the user group Can be 'creating', 'active', 'modifying', 'deleting'.
Users	(experimental) Array of users in the user group.

Methods

AddUser(IUser)	(experimental) Add a user to this user group.
FromUserGroupArn(Construct, string, string)	(experimental) Import an existing user group by ARN.
FromUserGroupAttributes(Construct, string, IUserGroupAttributes)	(experimental) Import an existing user group using attributes.
FromUserGroupName(Construct, string, string)	(experimental) Import an existing user group by name.
IsUserGroup(object)	(experimental) Return whether the given object is a `UserGroup`.

Constructors

UserGroup(Construct, string, IUserGroupProps?)

(experimental) An ElastiCache UserGroup.

public UserGroup(Construct scope, string id, IUserGroupProps? props = null)

Parameters

scope Construct
id string
props IUserGroupProps

Remarks

Stability: Experimental

Properties

Engine

(experimental) The engine type for the user group.

public override UserEngine? Engine { get; }

Property Value

UserEngine?

Overrides

UserGroupBase.Engine

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

UserGroupArn

(experimental) The ARN of the user group.

public override string UserGroupArn { get; }

Property Value

string

Overrides

UserGroupBase.UserGroupArn

Remarks

Stability: Experimental

Attribute: true

UserGroupName

(experimental) The name of the user group.

public override string UserGroupName { get; }

Property Value

string

Overrides

UserGroupBase.UserGroupName

Remarks

Stability: Experimental

UserGroupStatus

(experimental) The status of the user group Can be 'creating', 'active', 'modifying', 'deleting'.

public virtual string UserGroupStatus { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Users

(experimental) Array of users in the user group.

public override IUser[]? Users { get; }

Property Value

IUser[]

Overrides

UserGroupBase.Users

Remarks

Do not push directly to this array. Use addUser() instead to ensure proper validation and dependency management.

Stability: Experimental

Methods

AddUser(IUser)

(experimental) Add a user to this user group.

public override void AddUser(IUser user)

Parameters

user IUser: The user to add to the group.

Overrides

UserGroupBase.AddUser(IUser)

Remarks

Stability: Experimental

FromUserGroupArn(Construct, string, string)

(experimental) Import an existing user group by ARN.

public static IUserGroup FromUserGroupArn(Construct scope, string id, string userGroupArn)

Parameters

scope Construct: The parent creating construct (usually this).
id string: The construct's name.
userGroupArn string: The ARN of the existing user group.

Returns

IUserGroup

Remarks

Stability: Experimental

FromUserGroupAttributes(Construct, string, IUserGroupAttributes)

(experimental) Import an existing user group using attributes.

public static IUserGroup FromUserGroupAttributes(Construct scope, string id, IUserGroupAttributes attrs)

Parameters

scope Construct: The parent creating construct (usually this).
id string: The construct's name.
attrs IUserGroupAttributes: A UserGroupAttributes object.

Returns

IUserGroup

Remarks

Stability: Experimental

FromUserGroupName(Construct, string, string)

(experimental) Import an existing user group by name.

public static IUserGroup FromUserGroupName(Construct scope, string id, string userGroupName)

Parameters

scope Construct: The parent creating construct (usually this).
id string: The construct's name.
userGroupName string: The name of the existing user group.

Returns

IUserGroup

Remarks

Stability: Experimental

IsUserGroup(object)

(experimental) Return whether the given object is a UserGroup.

public static bool IsUserGroup(object x)

Parameters

x object

Returns

bool

Remarks

Stability: Experimental

Implements

IUserGroup

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware