Class User
(experimental) A user in a Redshift cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.AWS.Redshift.dll
Syntax (csharp)
public class User : Construct, IUser, IConstruct, IDependable
Syntax (vb)
Public Class User
Inherits Construct
Implements IUser, IConstruct, IDependable
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
User(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
User(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
User(Construct, String, IUserProps) |
Properties
Cluster | (experimental) The cluster where the table is located. |
DatabaseName | (experimental) The name of the database where the table is located. |
DatabaseProps | |
Password | (experimental) The password of the user. |
Secret | (experimental) The Secrets Manager secret of the user. |
Username | (experimental) The name of the user. |
Methods
AddTablePrivileges(ITable, TableAction[]) | (experimental) Grant this user privilege to access a table. |
ApplyRemovalPolicy(RemovalPolicy) | (experimental) Apply the given removal policy to this resource. |
FromUserAttributes(Construct, String, IUserAttributes) | (experimental) Specify a Redshift user using credentials that already exist. |
Constructors
User(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected User(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
User(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected User(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
User(Construct, String, IUserProps)
public User(Construct scope, string id, IUserProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IUserProps
Remarks
Stability: Experimental
Properties
Cluster
(experimental) The cluster where the table is located.
public virtual ICluster Cluster { get; }
Property Value
Remarks
Stability: Experimental
DatabaseName
(experimental) The name of the database where the table is located.
public virtual string DatabaseName { get; }
Property Value
System.String
Remarks
Stability: Experimental
DatabaseProps
protected virtual IDatabaseOptions DatabaseProps { get; set; }
Property Value
Remarks
Stability: Experimental
Password
(experimental) The password of the user.
public virtual SecretValue Password { get; }
Property Value
Remarks
Stability: Experimental
Secret
(experimental) The Secrets Manager secret of the user.
public virtual ISecret Secret { get; }
Property Value
Remarks
Stability: Experimental
Attribute: true
Username
(experimental) The name of the user.
public virtual string Username { get; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
AddTablePrivileges(ITable, TableAction[])
(experimental) Grant this user privilege to access a table.
public virtual void AddTablePrivileges(ITable table, params TableAction[] actions)
Parameters
- table ITable
- actions TableAction[]
Remarks
Stability: Experimental
ApplyRemovalPolicy(RemovalPolicy)
(experimental) Apply the given removal policy to this resource.
public virtual void ApplyRemovalPolicy(RemovalPolicy policy)
Parameters
- policy RemovalPolicy
Remarks
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be destroyed (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
This resource is destroyed by default.
Stability: Experimental
FromUserAttributes(Construct, String, IUserAttributes)
(experimental) Specify a Redshift user using credentials that already exist.
public static IUser FromUserAttributes(Construct scope, string id, IUserAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs IUserAttributes
Returns
Remarks
Stability: Experimental