Class Table
(experimental) A table in a Redshift cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.AWS.Redshift.dll
Syntax (csharp)
public class Table : Construct, ITable, IConstruct, IDependable
Syntax (vb)
Public Class Table
Inherits Construct
Implements ITable, IConstruct, IDependable
Remarks
Stability: Experimental
ExampleMetadata: fixture=cluster infused
Examples
new Table(this, "Table", new TableProps {
TableColumns = new [] { new Column { Name = "col1", DataType = "varchar(4)", DistKey = true }, new Column { Name = "col2", DataType = "float" } },
Cluster = cluster,
DatabaseName = "databaseName",
DistStyle = TableDistStyle.KEY
});
Synopsis
Constructors
Table(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Table(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Table(Construct, String, ITableProps) |
Properties
Cluster | (experimental) The cluster where the table is located. |
DatabaseName | (experimental) The name of the database where the table is located. |
TableColumns | (experimental) The columns of the table. |
TableName | (experimental) Name of the table. |
Methods
ApplyRemovalPolicy(RemovalPolicy) | (experimental) Apply the given removal policy to this resource. |
FromTableAttributes(Construct, String, ITableAttributes) | (experimental) Specify a Redshift table using a table name and schema that already exists. |
Grant(IUser, TableAction[]) | (experimental) Grant a user privilege to access this table. |
Constructors
Table(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Table(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Table(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Table(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Table(Construct, String, ITableProps)
public Table(Construct scope, string id, ITableProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props ITableProps
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
TableColumns
(experimental) The columns of the table.
public virtual IColumn[] TableColumns { get; }
Property Value
IColumn[]
Remarks
Stability: Experimental
TableName
(experimental) Name of the table.
public virtual string TableName { get; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
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 retained by default.
Stability: Experimental
FromTableAttributes(Construct, String, ITableAttributes)
(experimental) Specify a Redshift table using a table name and schema that already exists.
public static ITable FromTableAttributes(Construct scope, string id, ITableAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs ITableAttributes
Returns
Remarks
Stability: Experimental
Grant(IUser, TableAction[])
(experimental) Grant a user privilege to access this table.
public virtual void Grant(IUser user, params TableAction[] actions)
Parameters
- user IUser
- actions TableAction[]
Remarks
Stability: Experimental