@aws-cdk/aws-redshift-alpha.DatabaseOptions

Experimental

@aws-cdk/aws-redshift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

DatabaseOptions Struct

Properties for accessing a Redshift database.

Stability

Experimental

Source

lib/database-options.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';

declare const cluster: redshift_alpha.Cluster;
declare const secret: secretsmanager.Secret;
const databaseOptions: redshift_alpha.DatabaseOptions = {
  cluster: cluster,
  databaseName: 'databaseName',

  // the properties below are optional
  adminUser: secret,
};

Properties

adminUser?optionalISecretadmin_user?optionalISecretadminUser?optionalISecretAdminUser?optionalISecretAdminUser?optionalISecret#

The secret containing credentials to a Redshift user with administrator privileges.

Default: the admin secret is taken from the cluster

Secret JSON schema: { username: string; password: string }.

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The cluster containing the database.

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#

The name of the database.