@aws-cdk/aws-redshift-alpha.UserProps

Experimental

@aws-cdk/aws-redshift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

UserProps Struct

Properties for configuring a Redshift user.

UserProps

extends

• DatabaseOptions

Stability

Experimental

Source

lib/user.ts

Example

const user = new User(this, 'User', {
  cluster: cluster,
  databaseName: 'databaseName',
});
cluster.addRotationMultiUser('MultiUserRotation', {
  secret: user.secret,
});

Properties

adminUserISecretadmin_userISecretadminUserISecretAdminUserISecretAdminUserISecret= the admin secret is taken from t…#

The secret containing credentials to a Redshift user with administrator privileges.

Secret JSON schema: { username: string; password: string }.

default

Default: the admin secret is taken from the cluster

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The cluster containing the database.

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#

The name of the database.

encryptionKeyIKeyencryption_keyIKeyencryptionKeyIKeyEncryptionKeyIKeyEncryptionKeyIKey= the default AWS managed key is u…#

KMS key to encrypt the generated secret.

default

Default: the default AWS managed key is used

excludeCharactersstringexclude_charactersstrexcludeCharactersStringExcludeCharactersstringExcludeCharacters*string= '"@/\\\ \''#

Characters to not include in the generated password.

removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= cdk.RemovalPolicy.Destroy#

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

usernamestringusernamestrusernameStringUsernamestringUsername*string= a name is generated#

The name of the user.

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

Used as props by

• User