@aws-cdk_aws-redshift-alpha.UserProps

interface UserProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Redshift.Alpha.UserProps
Gogithub.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#UserProps
Javasoftware.amazon.awscdk.services.redshift.alpha.UserProps
Pythonaws_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

NameTypeDescription
cluster๐Ÿ”นIClusterThe cluster containing the database.
databaseName๐Ÿ”นstringThe name of the database.
adminUser?๐Ÿ”นISecretThe secret containing credentials to a Redshift user with administrator privileges.
encryptionKey?๐Ÿ”นIKeyKMS key to encrypt the generated secret.
removalPolicy?๐Ÿ”นRemovalPolicyThe policy to apply when this resource is removed from the application.
username?๐Ÿ”นstringThe 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.


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