DatabaseOptions

class aws_cdk.aws_redshift.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 as redshift
import aws_cdk.aws_secretsmanager as secretsmanager

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

database_options = redshift.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

Return type

Optional[ISecret]

cluster

(experimental) The cluster containing the database.

Stability

experimental

Return type

ICluster

database_name

(experimental) The name of the database.

Stability

experimental

Return type

str