Class DatabaseOptions
(experimental) Properties for accessing a Redshift database.
Inheritance
System.Object
DatabaseOptions
Implements
Namespace: Amazon.CDK.AWS.Redshift.Alpha
Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll
Syntax (csharp)
public class DatabaseOptions : Object, IDatabaseOptions
Syntax (vb)
Public Class DatabaseOptions
Inherits Object
Implements IDatabaseOptions
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Redshift.Alpha;
using Amazon.CDK.AWS.SecretsManager;
Cluster cluster;
Secret secret;
var databaseOptions = new DatabaseOptions {
Cluster = cluster,
DatabaseName = "databaseName",
// the properties below are optional
AdminUser = secret
};
Synopsis
Constructors
DatabaseOptions() |
Properties
AdminUser | (experimental) The secret containing credentials to a Redshift user with administrator privileges. |
Cluster | (experimental) The cluster containing the database. |
DatabaseName | (experimental) The name of the database. |
Constructors
DatabaseOptions()
public DatabaseOptions()
Properties
AdminUser
(experimental) The secret containing credentials to a Redshift user with administrator privileges.
public ISecret AdminUser { get; set; }
Property Value
Remarks
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.
public ICluster Cluster { get; set; }
Property Value
Remarks
Stability: Experimental
DatabaseName
(experimental) The name of the database.
public string DatabaseName { get; set; }
Property Value
System.String
Remarks
Stability: Experimental