@aws-cdk_aws-redshift-alpha.DatabaseOptions

interface DatabaseOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Redshift.Alpha.DatabaseOptions
Gogithub.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#DatabaseOptions
Javasoftware.amazon.awscdk.services.redshift.alpha.DatabaseOptions
Pythonaws_cdk.aws_redshift_alpha.DatabaseOptions
TypeScript (source)@aws-cdk/aws-redshift-alpha ยป DatabaseOptions

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 * 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

NameTypeDescription
cluster๐Ÿ”นIClusterThe cluster containing the database.
databaseName๐Ÿ”นstringThe name of the database.
adminUser?๐Ÿ”นISecretThe secret containing credentials to a Redshift user with administrator privileges.

cluster๐Ÿ”น

Type: ICluster

The cluster containing the database.


databaseName๐Ÿ”น

Type: string

The name of the database.


adminUser?๐Ÿ”น

Type: ISecret (optional, default: the admin secret is taken from the cluster)

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

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