class UserGroupBase
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ElastiCache.Alpha.UserGroupBase |
 Go | github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2#UserGroupBase |
 Java | software.amazon.awscdk.services.elasticache.alpha.UserGroupBase |
 Python | aws_cdk.aws_elasticache_alpha.UserGroupBase |
 TypeScript (source) | @aws-cdk/aws-elasticache-alpha » UserGroupBase |
Implements
IConstruct, IDependable, IResource, IUser
Extends
Resource
Implemented by
User
Base class for UserGroup constructs.
Initializer
new UserGroupBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct - id
string - props
ResourceProps
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| user | string | The ARN of the user group. |
| user | string | The name of the user group. |
| engine? | User | The engine type for the user group. |
| users? | IUser[] | List of users in the user group. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
userGroupArn
Type:
string
The ARN of the user group.
userGroupName
Type:
string
The name of the user group.
engine?
Type:
User
(optional)
The engine type for the user group.
users?
Type:
IUser[]
(optional)
List of users in the user group.
Methods
| Name | Description |
|---|---|
| add | Add a user to this user group. |
| apply | Apply the given removal policy to this resource. |
| to | Returns a string representation of this construct. |
addUser(_user)
public addUser(_user: IUser): void
Parameters
- _user
IUser— The user to add.
Add a user to this user group.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.