TableProps

class aws_cdk.aws_redshift.TableProps(*, cluster, database_name, admin_user=None, table_columns, removal_policy=None, table_name=None)

Bases: aws_cdk.aws_redshift.DatabaseOptions

(experimental) Properties for configuring a Redshift table.

Parameters
  • cluster (ICluster) – (experimental) The cluster containing the database.

  • database_name (str) – (experimental) The name of the database.

  • admin_user (Optional[ISecret]) – (experimental) The secret containing credentials to a Redshift user with administrator privileges. Secret JSON schema: { username: string; password: string }. Default: - the admin secret is taken from the cluster

  • table_columns (Sequence[Column]) – (experimental) The columns of the table.

  • removal_policy (Optional[RemovalPolicy]) – (experimental) The policy to apply when this resource is removed from the application. Default: cdk.RemovalPolicy.Retain

  • table_name (Optional[str]) – (experimental) The name of the table. Default: - a name is generated

Stability

experimental

Attributes

admin_user

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

Secret JSON schema: { username: string; password: string }.

Default
  • the admin secret is taken from the cluster

Stability

experimental

Return type

Optional[ISecret]

cluster

(experimental) The cluster containing the database.

Stability

experimental

Return type

ICluster

database_name

(experimental) The name of the database.

Stability

experimental

Return type

str

removal_policy

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

Default

cdk.RemovalPolicy.Retain

Stability

experimental

Return type

Optional[RemovalPolicy]

table_columns

(experimental) The columns of the table.

Stability

experimental

Return type

List[Column]

table_name

(experimental) The name of the table.

Default
  • a name is generated

Stability

experimental

Return type

Optional[str]