Package software.amazon.awscdk.services.glue

Class CfnTableOptimizer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnTableOptimizer
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITableOptimizerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:42.559Z") @Stability(Stable) public class CfnTableOptimizer extends CfnResource implements IInspectable, ITableOptimizerRef
An AWS Glue resource for enabling table optimizers to improve read performance for open table formats.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 CfnTableOptimizer cfnTableOptimizer = CfnTableOptimizer.Builder.create(this, "MyCfnTableOptimizer")
         .catalogId("catalogId")
         .databaseName("databaseName")
         .tableName("tableName")
         .tableOptimizerConfiguration(TableOptimizerConfigurationProperty.builder()
                 .enabled(false)
                 .roleArn("roleArn")
                 // the properties below are optional
                 .orphanFileDeletionConfiguration(OrphanFileDeletionConfigurationProperty.builder()
                         .icebergConfiguration(IcebergConfigurationProperty.builder()
                                 .location("location")
                                 .orphanFileRetentionPeriodInDays(123)
                                 .build())
                         .build())
                 .retentionConfiguration(RetentionConfigurationProperty.builder()
                         .icebergConfiguration(IcebergRetentionConfigurationProperty.builder()
                                 .cleanExpiredFiles(false)
                                 .numberOfSnapshotsToRetain(123)
                                 .snapshotRetentionPeriodInDays(123)
                                 .build())
                         .build())
                 .vpcConfiguration(VpcConfigurationProperty.builder()
                         .glueConnectionName("glueConnectionName")
                         .build())
                 .build())
         .type("type")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTableOptimizer

      protected CfnTableOptimizer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTableOptimizer

      protected CfnTableOptimizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTableOptimizer

      @Stability(Stable) public CfnTableOptimizer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTableOptimizerProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTableOptimizerRef

      @Stability(Stable) @NotNull public TableOptimizerReference getTableOptimizerRef()
      A reference to a TableOptimizer resource.
      Specified by:
      getTableOptimizerRef in interface ITableOptimizerRef

    • getCatalogId

      @Stability(Stable) @NotNull public String getCatalogId()
      The catalog ID of the table.

    • setCatalogId

      @Stability(Stable) public void setCatalogId(@NotNull String value)
      The catalog ID of the table.

    • getDatabaseName

      @Stability(Stable) @NotNull public String getDatabaseName()
      The name of the database.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@NotNull String value)
      The name of the database.

    • getTableName

      @Stability(Stable) @NotNull public String getTableName()
      The table name.

    • setTableName

      @Stability(Stable) public void setTableName(@NotNull String value)
      The table name.

    • getTableOptimizerConfiguration

      @Stability(Stable) @NotNull public Object getTableOptimizerConfiguration()
      Specifies configuration details of a table optimizer.

      Returns union: either IResolvable or CfnTableOptimizer.TableOptimizerConfigurationProperty

    • setTableOptimizerConfiguration

      @Stability(Stable) public void setTableOptimizerConfiguration(@NotNull IResolvable value)
      Specifies configuration details of a table optimizer.

    • setTableOptimizerConfiguration

      @Stability(Stable) public void setTableOptimizerConfiguration(@NotNull CfnTableOptimizer.TableOptimizerConfigurationProperty value)
      Specifies configuration details of a table optimizer.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of table optimizer.

      The valid values are:.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of table optimizer.

      The valid values are:.