Show / Hide Table of Contents

Interface ITableProps

(experimental) Properties for configuring a Redshift table.

Inherited Members
IDatabaseOptions.Cluster
IDatabaseOptions.DatabaseName
IDatabaseOptions.AdminUser
Namespace: Amazon.CDK.AWS.Redshift.Alpha
Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll
Syntax (csharp)
public interface ITableProps : IDatabaseOptions
Syntax (vb)
Public Interface ITableProps
    Inherits 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

Properties

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.

Properties

DistStyle

(experimental) The distribution style of the table.

virtual Nullable<TableDistStyle> DistStyle { get; }
Property Value

System.Nullable<TableDistStyle>

Remarks

Default: TableDistStyle.AUTO

Stability: Experimental

RemovalPolicy

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

virtual Nullable<RemovalPolicy> RemovalPolicy { get; }
Property Value

System.Nullable<RemovalPolicy>

Remarks

Default: cdk.RemovalPolicy.Retain

Stability: Experimental

SortStyle

(experimental) The sort style of the table.

virtual Nullable<TableSortStyle> SortStyle { get; }
Property Value

System.Nullable<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.

IColumn[] TableColumns { get; }
Property Value

IColumn[]

Remarks

Stability: Experimental

TableComment

(experimental) A comment to attach to the table.

virtual string TableComment { get; }
Property Value

System.String

Remarks

Default: - no comment

Stability: Experimental

TableName

(experimental) The name of the table.

virtual string TableName { get; }
Property Value

System.String

Remarks

Default: - a name is generated

Stability: Experimental

Timeout

(experimental) Handler timeout duration.

virtual Duration Timeout { get; }
Property Value

Duration

Remarks

Valid values are between 1 second and 15 minutes.

Default: - 1 minute

Stability: Experimental

Back to top Generated by DocFX