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

Interface DatabaseOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

TableProps, UserAttributes, UserProps

All Known Implementing Classes:

DatabaseOptions.Jsii$Proxy, TableProps.Jsii$Proxy, UserAttributes.Jsii$Proxy, UserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.819Z")
@Stability(Experimental)
public interface DatabaseOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for accessing a Redshift database.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.alpha.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 Cluster cluster;
 Secret secret;
 DatabaseOptions databaseOptions = DatabaseOptions.builder()
         .cluster(cluster)
         .databaseName("databaseName")
         // the properties below are optional
         .adminUser(secret)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatabaseOptions.Builder	A builder for DatabaseOptions
static final class	DatabaseOptions.Jsii$Proxy	An implementation for DatabaseOptions

Method Summary

Modifier and Type	Method	Description
static DatabaseOptions.Builder	builder()
default ISecret	getAdminUser()	(experimental) The secret containing credentials to a Redshift user with administrator privileges.
ICluster	getCluster()	(experimental) The cluster containing the database.
String	getDatabaseName()	(experimental) The name of the database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCluster

@Stability(Experimental)
@NotNull
ICluster getCluster()

(experimental) The cluster containing the database.

getDatabaseName

@Stability(Experimental)
@NotNull
String getDatabaseName()

(experimental) The name of the database.

getAdminUser

@Stability(Experimental)
@Nullable
default ISecret getAdminUser()

(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

builder

@Stability(Experimental)
static DatabaseOptions.Builder builder()

Returns:

a DatabaseOptions.Builder of DatabaseOptions