Class CatalogTableOptimizer


  • public class CatalogTableOptimizer
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Glue Catalog Table Optimizer. ## Example Usage ### Compaction Optimizer
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.glue.CatalogTableOptimizer;
     import com.pulumi.aws.glue.CatalogTableOptimizerArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationCompactionConfigurationArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationCompactionConfigurationIcebergConfigurationArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new CatalogTableOptimizer("example", CatalogTableOptimizerArgs.builder()
                 .configuration(CatalogTableOptimizerConfigurationArgs.builder()
                     .compactionConfiguration(CatalogTableOptimizerConfigurationCompactionConfigurationArgs.builder()
                         .icebergConfiguration(CatalogTableOptimizerConfigurationCompactionConfigurationIcebergConfigurationArgs.builder()
                             .strategy("binpack")
                             .minInputFiles(5)
                             .deleteFileThreshold(1)
                             .build())
                         .build())
                     .roleArn("arn:aws:iam::123456789012:role/example-role")
                     .enabled(true)
                     .build())
                 .catalogId("123456789012")
                 .databaseName("example_database")
                 .tableName("example_table")
                 .type("compaction")
                 .build());
     
         }
     }
     
     
    ### Snapshot Retention Optimizer
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.glue.CatalogTableOptimizer;
     import com.pulumi.aws.glue.CatalogTableOptimizerArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationRetentionConfigurationArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfigurationArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new CatalogTableOptimizer("example", CatalogTableOptimizerArgs.builder()
                 .configuration(CatalogTableOptimizerConfigurationArgs.builder()
                     .retentionConfiguration(CatalogTableOptimizerConfigurationRetentionConfigurationArgs.builder()
                         .icebergConfiguration(CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfigurationArgs.builder()
                             .snapshotRetentionPeriodInDays(7)
                             .numberOfSnapshotsToRetain(3)
                             .cleanExpiredFiles(true)
                             .build())
                         .build())
                     .roleArn("arn:aws:iam::123456789012:role/example-role")
                     .enabled(true)
                     .build())
                 .catalogId("123456789012")
                 .databaseName("example_database")
                 .tableName("example_table")
                 .type("retention")
                 .build());
     
         }
     }
     
     
    ### Orphan File Deletion Optimizer
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.glue.CatalogTableOptimizer;
     import com.pulumi.aws.glue.CatalogTableOptimizerArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationArgs;
     import com.pulumi.aws.glue.inputs.CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfigurationArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new CatalogTableOptimizer("example", CatalogTableOptimizerArgs.builder()
                 .configuration(CatalogTableOptimizerConfigurationArgs.builder()
                     .orphanFileDeletionConfiguration(CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationArgs.builder()
                         .icebergConfiguration(CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfigurationArgs.builder()
                             .orphanFileRetentionPeriodInDays(7)
                             .location("s3://example-bucket/example_table/")
                             .build())
                         .build())
                     .roleArn("arn:aws:iam::123456789012:role/example-role")
                     .enabled(true)
                     .build())
                 .catalogId("123456789012")
                 .databaseName("example_database")
                 .tableName("example_table")
                 .type("orphan_file_deletion")
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import Glue Catalog Table Optimizer using the `catalog_id,database_name,table_name,type`. For example: ```sh $ pulumi import aws:glue/catalogTableOptimizer:CatalogTableOptimizer example 123456789012,example_database,example_table,compaction ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> catalogId()  
      com.pulumi.core.Output<CatalogTableOptimizerConfiguration> configuration()  
      com.pulumi.core.Output<java.lang.String> databaseName()  
      static CatalogTableOptimizer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CatalogTableOptimizerState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> tableName()  
      com.pulumi.core.Output<java.lang.String> type()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CatalogTableOptimizer

        public CatalogTableOptimizer​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • CatalogTableOptimizer

        public CatalogTableOptimizer​(java.lang.String name,
                                     CatalogTableOptimizerArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • CatalogTableOptimizer

        public CatalogTableOptimizer​(java.lang.String name,
                                     CatalogTableOptimizerArgs args,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • catalogId

        public com.pulumi.core.Output<java.lang.String> catalogId()
        Returns:
        Catalog ID of the table.
      • configuration

        public com.pulumi.core.Output<CatalogTableOptimizerConfiguration> configuration()
        Returns:
        Configuration block that defines the table optimizer settings. See `configuration` Block for additional details.
      • databaseName

        public com.pulumi.core.Output<java.lang.String> databaseName()
        Returns:
        Name of the database in the catalog in which the table resides.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • tableName

        public com.pulumi.core.Output<java.lang.String> tableName()
        Returns:
        Name of the table.
      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of table optimizer. Valid values are `compaction`, `retention`, and `orphanFileDeletion`.
      • get

        public static CatalogTableOptimizer get​(java.lang.String name,
                                                com.pulumi.core.Output<java.lang.String> id,
                                                @Nullable
                                                CatalogTableOptimizerState state,
                                                @Nullable
                                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.