Class TableProps

(experimental) Properties for configuring a Redshift table.

Inheritance
object
TableProps
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift.Alpha
Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll
Syntax (csharp)
public class TableProps : ITableProps, IDatabaseOptions
Syntax (vb)
Public Class TableProps Implements ITableProps, IDatabaseOptions
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

TableProps()

(experimental) Properties for configuring a Redshift table.

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.
DistStyle

(experimental) The distribution style of the table.
RemovalPolicy

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

(experimental) The sort style of the table.
TableColumns

(experimental) The columns of the table.
TableComment

(experimental) A comment to attach to the table.
TableName

(experimental) The name of the table.
Timeout

(experimental) Handler timeout duration.

Constructors

TableProps()

(experimental) Properties for configuring a Redshift table.

public TableProps()
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
             });

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

DistStyle

(experimental) The distribution style of the table.

public TableDistStyle? DistStyle { get; set; }
Property Value

TableDistStyle?

Remarks

Default: TableDistStyle.AUTO

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.Retain

Stability: Experimental

SortStyle

(experimental) The sort style of the table.

public TableSortStyle? SortStyle { get; set; }
Property Value

TableSortStyle?

Remarks

Default: TableSortStyle.AUTO if no sort key is specified, TableSortStyle.COMPOUND if a sort key is specified

Stability: Experimental

TableColumns

(experimental) The columns of the table.

public IColumn[] TableColumns { get; set; }
Property Value

IColumn[]

Remarks

Stability: Experimental

TableComment

(experimental) A comment to attach to the table.

public string? TableComment { get; set; }
Property Value

string

Remarks

Default: - no comment

Stability: Experimental

TableName

(experimental) The name of the table.

public string? TableName { get; set; }
Property Value

string

Remarks

Default: - a name is generated

Stability: Experimental

Timeout

(experimental) Handler timeout duration.

public Duration? Timeout { get; set; }
Property Value

Duration

Remarks

Valid values are between 1 second and 15 minutes.

Default: - 1 minute

Stability: Experimental

Implements