software.amazon.awscdk.services.redshift

Class User

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.redshift.User

All Implemented Interfaces:

IDependable, IUser, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-09T19:25:26.086Z")
 @Stability(value=Experimental)
public class User
extends Construct
implements IUser

(experimental) A user in a Redshift cluster.

Example:

 import software.amazon.awscdk.services.kms.*;
 Key encryptionKey = new Key(this, "Key");
 User.Builder.create(this, "User")
         .encryptionKey(encryptionKey)
         .cluster(cluster)
         .databaseName("databaseName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.services.redshift.IUser

IUser.Jsii$Default, IUser.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
String	getUsername() (experimental) The name of the user.
protected void	setDatabaseProps(DatabaseOptions value)

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

User

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

User

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

User

@Stability(value=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 Detail

fromUserAttributes

@Stability(value=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(value=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(value=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(value=Experimental)
 @NotNull
public ICluster getCluster()

(experimental) The cluster where the table is located.

Specified by:

getCluster in interface IUser

getDatabaseName

@Stability(value=Experimental)
 @NotNull
public String getDatabaseName()

(experimental) The name of the database where the table is located.

Specified by:

getDatabaseName in interface IUser

getPassword

@Stability(value=Experimental)
 @NotNull
public SecretValue getPassword()

(experimental) The password of the user.

Specified by:

getPassword in interface IUser

getUsername

@Stability(value=Experimental)
 @NotNull
public String getUsername()

(experimental) The name of the user.

Specified by:

getUsername in interface IUser

getDatabaseProps

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

setDatabaseProps

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