interface DatabaseOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Redshift.Alpha.DatabaseOptions |
 Go | github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#DatabaseOptions |
 Java | software.amazon.awscdk.services.redshift.alpha.DatabaseOptions |
 Python | aws_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
| Name | Type | Description |
|---|---|---|
| cluster | ICluster | The cluster containing the database. |
| database | string | The name of the database. |
| admin | ISecret | The 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 }.