Interface UserProps

All Superinterfaces:
DatabaseOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
UserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.861Z") @Stability(Experimental) public interface UserProps extends software.amazon.jsii.JsiiSerializable, DatabaseOptions
(experimental) Properties for configuring a Redshift user.

Example:

 User user = User.Builder.create(this, "User")
         .cluster(cluster)
         .databaseName("databaseName")
         .build();
 cluster.addRotationMultiUser("MultiUserRotation", RotationMultiUserOptions.builder()
         .secret(user.getSecret())
         .build());
 
  • Method Details

    • getEncryptionKey

      @Stability(Experimental) @Nullable default IKey getEncryptionKey()
      (experimental) KMS key to encrypt the generated secret.

      Default: - the default AWS managed key is used

    • getRemovalPolicy

      @Stability(Experimental) @Nullable default RemovalPolicy getRemovalPolicy()
      (experimental) The policy to apply when this resource is removed from the application.

      Default: cdk.RemovalPolicy.Destroy

    • getUsername

      @Stability(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(Experimental) static UserProps.Builder builder()
      Returns:
      a UserProps.Builder of UserProps