Package software.amazon.awscdk.services.redshift.alpha

Class User

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.redshift.alpha.User
All Implemented Interfaces:
IUser, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:50.384Z") @Stability(Experimental) public class User extends software.constructs.Construct implements IUser
(experimental) A user in a Redshift cluster.

Example: 

 User user = User.Builder.create(this, "User")
         .cluster(cluster)
         .databaseName("databaseName")
         .build();
 cluster.addRotationMultiUser("MultiUserRotation", RotationMultiUserOptions.builder()
         .secret(user.getSecret())
         .build());

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    User.Builder
    (experimental) A fluent builder for User.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.redshift.alpha.IUser

    IUser.Jsii$Default, IUser.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    User(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    User(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    User(software.constructs.Construct scope, String id, UserProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTablePrivileges(ITable table, TableAction... actions)
    (experimental) Grant this user privilege to access a table.
    void
    applyRemovalPolicy(RemovalPolicy policy)
    (experimental) Apply the given removal policy to this resource.
    static IUser
    fromUserAttributes(software.constructs.Construct scope, String id, UserAttributes attrs)
    (experimental) Specify a Redshift user using credentials that already exist.
    ICluster
    getCluster()
    (experimental) The cluster where the table is located.
    String
    getDatabaseName()
    (experimental) The name of the database where the table is located.
    protected DatabaseOptions
    getDatabaseProps()
     
    SecretValue
    getPassword()
    (experimental) The password of the user.
    ISecret
    getSecret()
    (experimental) The Secrets Manager secret of the user.
    String
    getUsername()
    (experimental) The name of the user.
    protected void
    setDatabaseProps(DatabaseOptions value)
     

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • User

      protected User(software.amazon.jsii.JsiiObjectRef objRef)

    • User

      protected User(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • User

      @Stability(Experimental) public User(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull UserProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromUserAttributes

      @Stability(Experimental) @NotNull public static IUser fromUserAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull UserAttributes attrs)
      (experimental) Specify a Redshift user using credentials that already exist.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • addTablePrivileges

      @Stability(Experimental) public void addTablePrivileges(@NotNull ITable table, @NotNull TableAction... actions)
      (experimental) Grant this user privilege to access a table.

      Specified by:
      addTablePrivileges in interface IUser
      Parameters:
      table - This parameter is required.
      actions - This parameter is required.

    • applyRemovalPolicy

      @Stability(Experimental) public void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      (experimental) 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 destroyed (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      This resource is destroyed by default.

      Parameters:
      policy - This parameter is required.

    • getCluster

      @Stability(Experimental) @NotNull public ICluster getCluster()
      (experimental) The cluster where the table is located.
      Specified by:
      getCluster in interface IUser

    • getDatabaseName

      @Stability(Experimental) @NotNull public String getDatabaseName()
      (experimental) The name of the database where the table is located.
      Specified by:
      getDatabaseName in interface IUser

    • getPassword

      @Stability(Experimental) @NotNull public SecretValue getPassword()
      (experimental) The password of the user.
      Specified by:
      getPassword in interface IUser

    • getSecret

      @Stability(Experimental) @NotNull public ISecret getSecret()
      (experimental) The Secrets Manager secret of the user.

    • getUsername

      @Stability(Experimental) @NotNull public String getUsername()
      (experimental) The name of the user.
      Specified by:
      getUsername in interface IUser

    • getDatabaseProps

      @Stability(Experimental) @NotNull protected DatabaseOptions getDatabaseProps()

    • setDatabaseProps

      @Stability(Experimental) protected void setDatabaseProps(@NotNull DatabaseOptions value)