DatabaseOptions

class aws_cdk.aws_redshift_alpha.DatabaseOptions(*, cluster, database_name, admin_user=None)

Bases: object

(experimental) Properties for accessing a Redshift database.

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

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift_alpha as redshift_alpha
from aws_cdk import aws_secretsmanager as secretsmanager

# cluster: redshift_alpha.Cluster
# secret: secretsmanager.Secret

database_options = redshift_alpha.DatabaseOptions(
    cluster=cluster,
    database_name="databaseName",

    # the properties below are optional
    admin_user=secret
)

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

cluster

(experimental) The cluster containing the database.

Stability:

experimental

database_name

(experimental) The name of the database.

Stability:

experimental