UserProps

class aws_cdk.aws_redshift.UserProps(*, cluster, database_name, admin_user=None, encryption_key=None, removal_policy=None, username=None)

Bases: aws_cdk.aws_redshift.DatabaseOptions

(experimental) Properties for configuring a Redshift user.

Parameters
  • cluster (ICluster) – (experimental) The cluster containing the database.

  • database_name (str) – (experimental) The name of the database.

  • admin_user (Optional[ISecret]) – (experimental) The secret containing credentials to a Redshift user with administrator privileges. Secret JSON schema: { username: string; password: string }. Default: - the admin secret is taken from the cluster

  • encryption_key (Optional[IKey]) – (experimental) KMS key to encrypt the generated secret. Default: - the default AWS managed key is used

  • removal_policy (Optional[RemovalPolicy]) – (experimental) The policy to apply when this resource is removed from the application. Default: cdk.RemovalPolicy.Destroy

  • username (Optional[str]) – (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

Stability

experimental

Attributes

admin_user

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

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

Default
  • the admin secret is taken from the cluster

Stability

experimental

Return type

Optional[ISecret]

cluster

(experimental) The cluster containing the database.

Stability

experimental

Return type

ICluster

database_name

(experimental) The name of the database.

Stability

experimental

Return type

str

encryption_key

(experimental) KMS key to encrypt the generated secret.

Default
  • the default AWS managed key is used

Stability

experimental

Return type

Optional[IKey]

removal_policy

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

Default

cdk.RemovalPolicy.Destroy

Stability

experimental

Return type

Optional[RemovalPolicy]

username

(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

Stability

experimental

Return type

Optional[str]