interface UserProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Redshift.Alpha.UserProps`
Go	`github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#UserProps`
Java	`software.amazon.awscdk.services.redshift.alpha.UserProps`
Python	`aws_cdk.aws_redshift_alpha.UserProps`
TypeScript (source)	`@aws-cdk/aws-redshift-alpha` » `UserProps`

Properties for configuring a Redshift user.

Example


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

Properties

Name	Type	Description
cluster🔹	`ICluster`	The cluster containing the database.
databaseName🔹	`string`	The name of the database.
adminUser?🔹	`ISecret`	The secret containing credentials to a Redshift user with administrator privileges.
encryptionKey?🔹	`IKey`	KMS key to encrypt the generated secret.
excludeCharacters?🔹	`string`	Characters to not include in the generated password.
removalPolicy?🔹	`RemovalPolicy`	The policy to apply when this resource is removed from the application.
username?🔹	`string`	The name of the user.

cluster🔹

Type: ICluster

The cluster containing the database.

databaseName🔹

Type: string

The name of the database.

adminUser?🔹

Type: ISecret (optional, default: the admin secret is taken from the cluster)

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

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

encryptionKey?🔹

Type: IKey (optional, default: the default AWS managed key is used)

KMS key to encrypt the generated secret.

excludeCharacters?🔹

Type: string (optional, default: '"@/\\ '')

Characters to not include in the generated password.

removalPolicy?🔹

Type: RemovalPolicy (optional, default: cdk.RemovalPolicy.Destroy)

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

username?🔹

Type: string (optional, default: a name is generated)

The name of the user.

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