Interface IUserGroup.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct,software.constructs.IConstruct.Jsii$Default,software.constructs.IDependable,software.constructs.IDependable.Jsii$Default,IEnvironmentAware,IEnvironmentAware.Jsii$Default,IResource,IResource.Jsii$Default,IUserGroup,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IUserGroup.Jsii$Proxy
- Enclosing interface:
IUserGroup
IUserGroup.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticache.alpha.IUserGroup
IUserGroup.Jsii$Default, IUserGroup.Jsii$Proxy -
Method Summary
Modifier and TypeMethodDescriptiondefault void(experimental) Add a user to this user group.default voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.default UserEngine(experimental) The engine type for the user group.default ResourceEnvironmentgetEnv()The environment this resource belongs to.default software.constructs.NodegetNode()The tree node.default StackgetStack()The stack in which this resource is defined.default String(experimental) The ARN of the user group.default String(experimental) The name of the user group.getUsers()(experimental) List of users in the user group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNodein interfacesoftware.constructs.IConstruct- Specified by:
getNodein interfacesoftware.constructs.IConstruct.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed in a Stack (those created by creating new class instances like
new Role(),new Bucket(), etc.), this is always the same as the environment of the stack they belong to.For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(),Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.- Specified by:
getEnvin interfaceIEnvironmentAware- Specified by:
getEnvin interfaceIEnvironmentAware.Jsii$Default- Specified by:
getEnvin interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default
-
getUserGroupArn
(experimental) The ARN of the user group.- Specified by:
getUserGroupArnin interfaceIUserGroup
-
getUserGroupName
(experimental) The name of the user group.- Specified by:
getUserGroupNamein interfaceIUserGroup
-
getEngine
(experimental) The engine type for the user group.- Specified by:
getEnginein interfaceIUserGroup
-
getUsers
(experimental) List of users in the user group.- Specified by:
getUsersin interfaceIUserGroup
-
applyRemovalPolicy
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).- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Parameters:
policy- This parameter is required.
-
addUser
(experimental) Add a user to this user group.- Specified by:
addUserin interfaceIUserGroup- Parameters:
user- The user to add. This parameter is required.
-