Package software.amazon.awscdk.services.redshift

Interface UserAttributes

All Superinterfaces:

DatabaseOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.860Z")
@Stability(Experimental)
public interface UserAttributes
extends software.amazon.jsii.JsiiSerializable, DatabaseOptions

(experimental) A full specification of a Redshift user that can be used to import it fluently into the CDK application.

Example:

 String databaseName = "databaseName";
 String username = "myuser";
 String tableName = "mytable";
 IUser user = User.fromUserAttributes(this, "User", UserAttributes.builder()
         .username(username)
         .password(SecretValue.unsafePlainText("NOT_FOR_PRODUCTION"))
         .cluster(cluster)
         .databaseName(databaseName)
         .build());
 ITable table = Table.fromTableAttributes(this, "Table", TableAttributes.builder()
         .tableName(tableName)
         .tableColumns(List.of(Column.builder().name("col1").dataType("varchar(4)").build(), Column.builder().name("col2").dataType("float").build()))
         .cluster(cluster)
         .databaseName("databaseName")
         .build());
 table.grant(user, TableAction.INSERT);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserAttributes.Builder	A builder for UserAttributes
static final class	UserAttributes.Jsii$Proxy	An implementation for UserAttributes

Method Summary

Modifier and Type	Method	Description
static UserAttributes.Builder	builder()
SecretValue	getPassword()	(experimental) The password of the user.
String	getUsername()	(experimental) The name of the user.

Methods inherited from interface software.amazon.awscdk.services.redshift.DatabaseOptions

getAdminUser, getCluster, getDatabaseName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPassword

@Stability(Experimental)
@NotNull
SecretValue getPassword()

(experimental) The password of the user.

Do not put passwords in CDK code directly.

getUsername

@Stability(Experimental)
@NotNull
String getUsername()

(experimental) The name of the user.

builder

@Stability(Experimental)
static UserAttributes.Builder builder()

Returns:

a UserAttributes.Builder of UserAttributes