software.amazon.awscdk.services.redshift

Interface UserProps

All Superinterfaces:

DatabaseOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.39.0 (build 8af72c2)",
           date="2021-10-14T05:49:11.600Z")
 @Stability(value=Experimental)
public interface UserProps
extends software.amazon.jsii.JsiiSerializable, DatabaseOptions

(experimental) Properties for configuring a Redshift user.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UserProps.Builder	builder()
default IKey	getEncryptionKey() (experimental) KMS key to encrypt the generated secret.
default RemovalPolicy	getRemovalPolicy() (experimental) The policy to apply when this resource is removed from the application.
default 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 Detail

getEncryptionKey

@Stability(value=Experimental)
 @Nullable
default IKey getEncryptionKey()

(experimental) KMS key to encrypt the generated secret.

Default: - the default AWS managed key is used

getRemovalPolicy

@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) The policy to apply when this resource is removed from the application.

Default: cdk.RemovalPolicy.Destroy

getUsername

@Stability(value=Experimental)
 @Nullable
default String getUsername()

(experimental) The name of the user.

For valid values, see: https://docs.aws.amazon.com/redshift/latest/dg/r_names.html

Default: - a name is generated

builder

@Stability(value=Experimental)
static UserProps.Builder builder()

Specified by:

builder in interface DatabaseOptions

Returns:

a UserProps.Builder of UserProps