Package software.amazon.awscdk.services.redshift

Class User.Builder

java.lang.Object
software.amazon.awscdk.services.redshift.User.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<User>
Enclosing class:
User
@Stability(Experimental) public static final class User.Builder extends Object implements software.amazon.jsii.Builder<User>
(experimental) A fluent builder for User.

  • Method Details

    • create

      @Stability(Experimental) public static User.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of User.Builder.

    • cluster

      @Stability(Experimental) public User.Builder cluster(ICluster cluster)
      (experimental) The cluster containing the database.

      Parameters:
      cluster - The cluster containing the database. This parameter is required.
      Returns:
      this

    • databaseName

      @Stability(Experimental) public User.Builder databaseName(String databaseName)
      (experimental) The name of the database.

      Parameters:
      databaseName - The name of the database. This parameter is required.
      Returns:
      this

    • adminUser

      @Stability(Experimental) public User.Builder adminUser(ISecret adminUser)
      (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

      Parameters:
      adminUser - The secret containing credentials to a Redshift user with administrator privileges. This parameter is required.
      Returns:
      this

    • encryptionKey

      @Stability(Experimental) public User.Builder encryptionKey(IKey encryptionKey)
      (experimental) KMS key to encrypt the generated secret.

      Default: - the default AWS managed key is used

      Parameters:
      encryptionKey - KMS key to encrypt the generated secret. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Experimental) public User.Builder removalPolicy(RemovalPolicy removalPolicy)
      (experimental) The policy to apply when this resource is removed from the application.

      Default: cdk.RemovalPolicy.Destroy

      Parameters:
      removalPolicy - The policy to apply when this resource is removed from the application. This parameter is required.
      Returns:
      this

    • username

      @Stability(Experimental) public User.Builder username(String 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

      Parameters:
      username - The name of the user. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public User build()
      Specified by:
      build in interface software.amazon.jsii.Builder<User>
      Returns:
      a newly built instance of User.