Class UserProps

(experimental) Properties for configuring a Redshift user.

Inheritance

object

UserProps

Implements

IUserProps

IDatabaseOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Redshift.Alpha

Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll

Syntax (csharp)

public class UserProps : IUserProps, IDatabaseOptions

Syntax (vb)

Public Class UserProps Implements IUserProps, IDatabaseOptions

Remarks

Stability: Experimental

ExampleMetadata: fixture=cluster infused

Examples

var user = new User(this, "User", new UserProps {
                 Cluster = cluster,
                 DatabaseName = "databaseName"
             });
             cluster.AddRotationMultiUser("MultiUserRotation", new RotationMultiUserOptions {
                 Secret = user.Secret
             });

Synopsis

Constructors

UserProps()

(experimental) Properties for configuring a Redshift user.

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.
EncryptionKey	(experimental) KMS key to encrypt the generated secret.
ExcludeCharacters	(experimental) Characters to not include in the generated password.
RemovalPolicy	(experimental) The policy to apply when this resource is removed from the application.
Username	(experimental) The name of the user.

Constructors

UserProps()

(experimental) Properties for configuring a Redshift user.

public UserProps()

Remarks

Stability: Experimental

ExampleMetadata: fixture=cluster infused

Examples

var user = new User(this, "User", new UserProps {
                 Cluster = cluster,
                 DatabaseName = "databaseName"
             });
             cluster.AddRotationMultiUser("MultiUserRotation", new RotationMultiUserOptions {
                 Secret = user.Secret
             });

Properties

AdminUser

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

public ISecret? AdminUser { get; set; }

Property Value

ISecret

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

ICluster

Remarks

Stability: Experimental

DatabaseName

(experimental) The name of the database.

public string DatabaseName { get; set; }

Property Value

string

Remarks

Stability: Experimental

EncryptionKey

(experimental) KMS key to encrypt the generated secret.

public IKey? EncryptionKey { get; set; }

Property Value

IKey

Remarks

Default: - the default AWS managed key is used

Stability: Experimental

ExcludeCharacters

(experimental) Characters to not include in the generated password.

public string? ExcludeCharacters { get; set; }

Property Value

string

Remarks

Default: '"@/\\ ''

Stability: Experimental

RemovalPolicy

(experimental) The policy to apply when this resource is removed from the application.

public RemovalPolicy? RemovalPolicy { get; set; }

Property Value

RemovalPolicy?

Remarks

Default: cdk.RemovalPolicy.Destroy

Stability: Experimental

Username

(experimental) The name of the user.

public string? Username { get; set; }

Property Value

string

Remarks

For valid values, see: https://docs.aws.amazon.com/redshift/latest/dg/r_names.html

Default: - a name is generated

Stability: Experimental

Implements

IUserProps

IDatabaseOptions