CfnTable

class aws_cdk.aws_glue.CfnTable(scope, id, *, catalog_id, database_name, table_input)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Glue::Table.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html

CloudformationResource

AWS::Glue::Table

Create a new AWS::Glue::Table.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • catalog_id (str) – AWS::Glue::Table.CatalogId.

  • database_name (str) – AWS::Glue::Table.DatabaseName.

  • table_input (Union[IResolvable, TableInputProperty]) – AWS::Glue::Table.TableInput.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Glue::Table'
catalog_id

AWS::Glue::Table.CatalogId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

database_name

AWS::Glue::Table.DatabaseName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename

Return type

str

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

table_input

AWS::Glue::Table.TableInput.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput

Return type

Union[IResolvable, TableInputProperty]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ColumnProperty

class CfnTable.ColumnProperty(*, name, comment=None, type=None)

Bases: object

Parameters
  • name (str) – CfnTable.ColumnProperty.Name.

  • comment (Optional[str]) – CfnTable.ColumnProperty.Comment.

  • type (Optional[str]) – CfnTable.ColumnProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html

Attributes

comment

CfnTable.ColumnProperty.Comment.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-comment

Return type

Optional[str]

name

CfnTable.ColumnProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-name

Return type

str

type

CfnTable.ColumnProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-type

Return type

Optional[str]

OrderProperty

class CfnTable.OrderProperty(*, column, sort_order)

Bases: object

Parameters
  • column (str) – CfnTable.OrderProperty.Column.

  • sort_order (Union[int, float]) – CfnTable.OrderProperty.SortOrder.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html

Attributes

column

CfnTable.OrderProperty.Column.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-column

Return type

str

sort_order

CfnTable.OrderProperty.SortOrder.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-sortorder

Return type

Union[int, float]

SerdeInfoProperty

class CfnTable.SerdeInfoProperty(*, name=None, parameters=None, serialization_library=None)

Bases: object

Parameters
  • name (Optional[str]) – CfnTable.SerdeInfoProperty.Name.

  • parameters (Optional[Any]) – CfnTable.SerdeInfoProperty.Parameters.

  • serialization_library (Optional[str]) – CfnTable.SerdeInfoProperty.SerializationLibrary.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html

Attributes

name

CfnTable.SerdeInfoProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-name

Return type

Optional[str]

parameters

CfnTable.SerdeInfoProperty.Parameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-parameters

Return type

Any

serialization_library

CfnTable.SerdeInfoProperty.SerializationLibrary.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-serializationlibrary

Return type

Optional[str]

SkewedInfoProperty

class CfnTable.SkewedInfoProperty(*, skewed_column_names=None, skewed_column_value_location_maps=None, skewed_column_values=None)

Bases: object

Parameters
  • skewed_column_names (Optional[List[str]]) – CfnTable.SkewedInfoProperty.SkewedColumnNames.

  • skewed_column_value_location_maps (Optional[Any]) – CfnTable.SkewedInfoProperty.SkewedColumnValueLocationMaps.

  • skewed_column_values (Optional[List[str]]) – CfnTable.SkewedInfoProperty.SkewedColumnValues.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html

Attributes

skewed_column_names

CfnTable.SkewedInfoProperty.SkewedColumnNames.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnnames

Return type

Optional[List[str]]

skewed_column_value_location_maps

CfnTable.SkewedInfoProperty.SkewedColumnValueLocationMaps.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvaluelocationmaps

Return type

Any

skewed_column_values

CfnTable.SkewedInfoProperty.SkewedColumnValues.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvalues

Return type

Optional[List[str]]

StorageDescriptorProperty

class CfnTable.StorageDescriptorProperty(*, bucket_columns=None, columns=None, compressed=None, input_format=None, location=None, number_of_buckets=None, output_format=None, parameters=None, serde_info=None, skewed_info=None, sort_columns=None, stored_as_sub_directories=None)

Bases: object

Parameters
  • bucket_columns (Optional[List[str]]) – CfnTable.StorageDescriptorProperty.BucketColumns.

  • columns (Union[IResolvable, List[Union[IResolvable, ColumnProperty]], None]) – CfnTable.StorageDescriptorProperty.Columns.

  • compressed (Union[bool, IResolvable, None]) – CfnTable.StorageDescriptorProperty.Compressed.

  • input_format (Optional[str]) – CfnTable.StorageDescriptorProperty.InputFormat.

  • location (Optional[str]) – CfnTable.StorageDescriptorProperty.Location.

  • number_of_buckets (Union[int, float, None]) – CfnTable.StorageDescriptorProperty.NumberOfBuckets.

  • output_format (Optional[str]) – CfnTable.StorageDescriptorProperty.OutputFormat.

  • parameters (Optional[Any]) – CfnTable.StorageDescriptorProperty.Parameters.

  • serde_info (Union[IResolvable, SerdeInfoProperty, None]) – CfnTable.StorageDescriptorProperty.SerdeInfo.

  • skewed_info (Union[IResolvable, SkewedInfoProperty, None]) – CfnTable.StorageDescriptorProperty.SkewedInfo.

  • sort_columns (Union[IResolvable, List[Union[IResolvable, OrderProperty]], None]) – CfnTable.StorageDescriptorProperty.SortColumns.

  • stored_as_sub_directories (Union[bool, IResolvable, None]) – CfnTable.StorageDescriptorProperty.StoredAsSubDirectories.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html

Attributes

bucket_columns

CfnTable.StorageDescriptorProperty.BucketColumns.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-bucketcolumns

Return type

Optional[List[str]]

columns

CfnTable.StorageDescriptorProperty.Columns.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-columns

Return type

Union[IResolvable, List[Union[IResolvable, ColumnProperty]], None]

compressed

CfnTable.StorageDescriptorProperty.Compressed.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-compressed

Return type

Union[bool, IResolvable, None]

input_format

CfnTable.StorageDescriptorProperty.InputFormat.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-inputformat

Return type

Optional[str]

location

CfnTable.StorageDescriptorProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-location

Return type

Optional[str]

number_of_buckets

CfnTable.StorageDescriptorProperty.NumberOfBuckets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-numberofbuckets

Return type

Union[int, float, None]

output_format

CfnTable.StorageDescriptorProperty.OutputFormat.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-outputformat

Return type

Optional[str]

parameters

CfnTable.StorageDescriptorProperty.Parameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-parameters

Return type

Any

serde_info

CfnTable.StorageDescriptorProperty.SerdeInfo.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-serdeinfo

Return type

Union[IResolvable, SerdeInfoProperty, None]

skewed_info

CfnTable.StorageDescriptorProperty.SkewedInfo.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-skewedinfo

Return type

Union[IResolvable, SkewedInfoProperty, None]

sort_columns

CfnTable.StorageDescriptorProperty.SortColumns.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-sortcolumns

Return type

Union[IResolvable, List[Union[IResolvable, OrderProperty]], None]

stored_as_sub_directories

CfnTable.StorageDescriptorProperty.StoredAsSubDirectories.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-storedassubdirectories

Return type

Union[bool, IResolvable, None]

TableInputProperty

class CfnTable.TableInputProperty(*, description=None, name=None, owner=None, parameters=None, partition_keys=None, retention=None, storage_descriptor=None, table_type=None, view_expanded_text=None, view_original_text=None)

Bases: object

Parameters
  • description (Optional[str]) – CfnTable.TableInputProperty.Description.

  • name (Optional[str]) – CfnTable.TableInputProperty.Name.

  • owner (Optional[str]) – CfnTable.TableInputProperty.Owner.

  • parameters (Optional[Any]) – CfnTable.TableInputProperty.Parameters.

  • partition_keys (Union[IResolvable, List[Union[IResolvable, ColumnProperty]], None]) – CfnTable.TableInputProperty.PartitionKeys.

  • retention (Union[int, float, None]) – CfnTable.TableInputProperty.Retention.

  • storage_descriptor (Union[IResolvable, StorageDescriptorProperty, None]) – CfnTable.TableInputProperty.StorageDescriptor.

  • table_type (Optional[str]) – CfnTable.TableInputProperty.TableType.

  • view_expanded_text (Optional[str]) – CfnTable.TableInputProperty.ViewExpandedText.

  • view_original_text (Optional[str]) – CfnTable.TableInputProperty.ViewOriginalText.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html

Attributes

description

CfnTable.TableInputProperty.Description.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description

Return type

Optional[str]

name

CfnTable.TableInputProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-name

Return type

Optional[str]

owner

CfnTable.TableInputProperty.Owner.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner

Return type

Optional[str]

parameters

CfnTable.TableInputProperty.Parameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters

Return type

Any

partition_keys

CfnTable.TableInputProperty.PartitionKeys.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys

Return type

Union[IResolvable, List[Union[IResolvable, ColumnProperty]], None]

retention

CfnTable.TableInputProperty.Retention.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention

Return type

Union[int, float, None]

storage_descriptor

CfnTable.TableInputProperty.StorageDescriptor.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor

Return type

Union[IResolvable, StorageDescriptorProperty, None]

table_type

CfnTable.TableInputProperty.TableType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype

Return type

Optional[str]

view_expanded_text

CfnTable.TableInputProperty.ViewExpandedText.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext

Return type

Optional[str]

view_original_text

CfnTable.TableInputProperty.ViewOriginalText.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext

Return type

Optional[str]