CfnTableOptimizerProps

class aws_cdk.aws_glue.CfnTableOptimizerProps(*, catalog_id, database_name, table_name, table_optimizer_configuration, type)

Bases: object

Properties for defining a CfnTableOptimizer.

Parameters:

  • catalog_id (str) – The catalog ID of the table.

  • database_name (str) – The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

  • table_name (str) – The table name. For Hive compatibility, this must be entirely lowercase.

  • table_optimizer_configuration (Union[IResolvable, TableOptimizerConfigurationProperty, Dict[str, Any]]) – Specifies configuration details of a table optimizer.

  • type (str) – The type of table optimizer. The valid values are:. - compaction - for managing compaction with a table optimizer. - retention - for managing the retention of snapshot with a table optimizer. - orphan_file_deletion - for managing the deletion of orphan files with a table optimizer.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

cfn_table_optimizer_props = glue.CfnTableOptimizerProps(
    catalog_id="catalogId",
    database_name="databaseName",
    table_name="tableName",
    table_optimizer_configuration=glue.CfnTableOptimizer.TableOptimizerConfigurationProperty(
        enabled=False,
        role_arn="roleArn",

        # the properties below are optional
        orphan_file_deletion_configuration=glue.CfnTableOptimizer.OrphanFileDeletionConfigurationProperty(
            iceberg_configuration=glue.CfnTableOptimizer.IcebergConfigurationProperty(
                location="location",
                orphan_file_retention_period_in_days=123
            )
        ),
        retention_configuration=glue.CfnTableOptimizer.RetentionConfigurationProperty(
            iceberg_configuration=glue.CfnTableOptimizer.IcebergRetentionConfigurationProperty(
                clean_expired_files=False,
                number_of_snapshots_to_retain=123,
                snapshot_retention_period_in_days=123
            )
        ),
        vpc_configuration=glue.CfnTableOptimizer.VpcConfigurationProperty(
            glue_connection_name="glueConnectionName"
        )
    ),
    type="type"
)

Attributes

catalog_id

The catalog ID of the table.

See:

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

database_name

The name of the database.

For Hive compatibility, this is folded to lowercase when it is stored.

See:

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

table_name

The table name.

For Hive compatibility, this must be entirely lowercase.

See:

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

table_optimizer_configuration

Specifies configuration details of a table optimizer.

See:

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

type

.

  • compaction - for managing compaction with a table optimizer.

  • retention - for managing the retention of snapshot with a table optimizer.

  • orphan_file_deletion - for managing the deletion of orphan files with a table optimizer.

See:

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

Type:

The type of table optimizer. The valid values are