Package software.amazon.awscdk.services.glue

Interface CfnTableOptimizer.TableOptimizerConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTableOptimizer.TableOptimizerConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTableOptimizer

@Stability(Stable)
public static interface CfnTableOptimizer.TableOptimizerConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies configuration details of a table optimizer.

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.*;
 TableOptimizerConfigurationProperty tableOptimizerConfigurationProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTableOptimizer.TableOptimizerConfigurationProperty.Builder	A builder for CfnTableOptimizer.TableOptimizerConfigurationProperty
static final class	CfnTableOptimizer.TableOptimizerConfigurationProperty.Jsii$Proxy	An implementation for CfnTableOptimizer.TableOptimizerConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTableOptimizer.TableOptimizerConfigurationProperty.Builder	builder()
Object	getEnabled()	Whether the table optimization is enabled.
default Object	getOrphanFileDeletionConfiguration()	OrphanFileDeletionConfiguration is a property that can be included within the TableOptimizer resource.
default Object	getRetentionConfiguration()	The configuration for a snapshot retention optimizer for Apache Iceberg tables.
String	getRoleArn()	A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
default Object	getVpcConfiguration()	An object that describes the VPC configuration for a table optimizer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

Whether the table optimization is enabled.

Returns union: either Boolean or IResolvable

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.

See Also:

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

getOrphanFileDeletionConfiguration

@Stability(Stable)
@Nullable
default Object getOrphanFileDeletionConfiguration()

OrphanFileDeletionConfiguration is a property that can be included within the TableOptimizer resource.

It controls the automatic deletion of orphaned files - files that are not tracked by the table metadata, and older than the configured age limit.

Returns union: either IResolvable or CfnTableOptimizer.OrphanFileDeletionConfigurationProperty

See Also:

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

getRetentionConfiguration

@Stability(Stable)
@Nullable
default Object getRetentionConfiguration()

The configuration for a snapshot retention optimizer for Apache Iceberg tables.

Returns union: either IResolvable or CfnTableOptimizer.RetentionConfigurationProperty

See Also:

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

getVpcConfiguration

@Stability(Stable)
@Nullable
default Object getVpcConfiguration()

An object that describes the VPC configuration for a table optimizer.

This configuration is necessary to perform optimization on tables that are in a customer VPC.

Returns union: either IResolvable or CfnTableOptimizer.VpcConfigurationProperty

See Also:

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

builder

@Stability(Stable)
static CfnTableOptimizer.TableOptimizerConfigurationProperty.Builder builder()

Returns:

a CfnTableOptimizer.TableOptimizerConfigurationProperty.Builder of CfnTableOptimizer.TableOptimizerConfigurationProperty