Package software.amazon.awscdk.services.redshift.alpha

Class UserProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • encryptionKey

      @Stability(Experimental) public UserProps.Builder encryptionKey(IKey encryptionKey)
      Sets the value of UserProps.getEncryptionKey()
      Parameters:
      encryptionKey - KMS key to encrypt the generated secret.
      Returns:
      this

    • excludeCharacters

      @Stability(Experimental) public UserProps.Builder excludeCharacters(String excludeCharacters)
      Sets the value of UserProps.getExcludeCharacters()
      Parameters:
      excludeCharacters - Characters to not include in the generated password.
      Returns:
      this

    • removalPolicy

      @Stability(Experimental) public UserProps.Builder removalPolicy(RemovalPolicy removalPolicy)
      Sets the value of UserProps.getRemovalPolicy()
      Parameters:
      removalPolicy - The policy to apply when this resource is removed from the application.
      Returns:
      this

    • username

      @Stability(Experimental) public UserProps.Builder username(String username)
      Sets the value of UserProps.getUsername()
      Parameters:
      username - The name of the user. For valid values, see: https://docs.aws.amazon.com/redshift/latest/dg/r_names.html
      Returns:
      this

    • cluster

      @Stability(Experimental) public UserProps.Builder cluster(ICluster cluster)
      Sets the value of DatabaseOptions.getCluster()
      Parameters:
      cluster - The cluster containing the database. This parameter is required.
      Returns:
      this

    • databaseName

      @Stability(Experimental) public UserProps.Builder databaseName(String databaseName)
      Sets the value of DatabaseOptions.getDatabaseName()
      Parameters:
      databaseName - The name of the database. This parameter is required.
      Returns:
      this

    • adminUser

      @Stability(Experimental) public UserProps.Builder adminUser(ISecret adminUser)
      Sets the value of DatabaseOptions.getAdminUser()
      Parameters:
      adminUser - The secret containing credentials to a Redshift user with administrator privileges. Secret JSON schema: { username: string; password: string }.
      Returns:
      this

    • build

      @Stability(Experimental) public UserProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<UserProps>
      Returns:
      a new instance of UserProps
      Throws:
      NullPointerException - if any required attribute was not provided