CatalogTableOptimizer class

Resource for managing an AWS Glue Catalog Table Optimizer.

Example Usage

Compaction Optimizer

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.CatalogTableOptimizer("example", {
    configuration: {
        compactionConfiguration: {
            icebergConfiguration: {
                strategy: "binpack",
                minInputFiles: 5,
                deleteFileThreshold: 1,
            },
        },
        roleArn: "arn:aws:iam::123456789012:role/example-role",
        enabled: true,
    },
    catalogId: "123456789012",
    databaseName: "example_database",
    tableName: "example_table",
    type: "compaction",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.CatalogTableOptimizer("example",
    configuration={
        "compaction_configuration": {
            "iceberg_configuration": {
                "strategy": "binpack",
                "min_input_files": 5,
                "delete_file_threshold": 1,
            },
        },
        "role_arn": "arn:aws:iam::123456789012:role/example-role",
        "enabled": True,
    },
    catalog_id="123456789012",
    database_name="example_database",
    table_name="example_table",
    type="compaction")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.CatalogTableOptimizer("example", new()
    {
        Configuration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationArgs
        {
            CompactionConfiguration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationCompactionConfigurationArgs
            {
                IcebergConfiguration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationCompactionConfigurationIcebergConfigurationArgs
                {
                    Strategy = "binpack",
                    MinInputFiles = 5,
                    DeleteFileThreshold = 1,
                },
            },
            RoleArn = "arn:aws:iam::123456789012:role/example-role",
            Enabled = true,
        },
        CatalogId = "123456789012",
        DatabaseName = "example_database",
        TableName = "example_table",
        Type = "compaction",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewCatalogTableOptimizer(ctx, "example", &glue.CatalogTableOptimizerArgs{
			Configuration: &glue.CatalogTableOptimizerConfigurationArgs{
				CompactionConfiguration: &glue.CatalogTableOptimizerConfigurationCompactionConfigurationArgs{
					IcebergConfiguration: &glue.CatalogTableOptimizerConfigurationCompactionConfigurationIcebergConfigurationArgs{
						Strategy:            pulumi.String("binpack"),
						MinInputFiles:       pulumi.Int(5),
						DeleteFileThreshold: pulumi.Int(1),
					},
				},
				RoleArn: pulumi.String("arn:aws:iam::123456789012:role/example-role"),
				Enabled: pulumi.Bool(true),
			},
			CatalogId:    pulumi.String("123456789012"),
			DatabaseName: pulumi.String("example_database"),
			TableName:    pulumi.String("example_table"),
			Type:         pulumi.String("compaction"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalogtableoptimizer" "example" {
  configuration = {
    compaction_configuration = {
      iceberg_configuration = {
        strategy              = "binpack"
        min_input_files       = 5
        delete_file_threshold = 1
      }
    }
    role_arn = "arn:aws:iam::123456789012:role/example-role"
    enabled  = true
  }
  catalog_id    = "123456789012"
  database_name = "example_database"
  table_name    = "example_table"
  type          = "compaction"
}
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());

    }
}
resources:
  example:
    type: aws:glue:CatalogTableOptimizer
    properties:
      configuration:
        compactionConfiguration:
          icebergConfiguration:
            strategy: binpack
            minInputFiles: 5
            deleteFileThreshold: 1
        roleArn: arn:aws:iam::123456789012:role/example-role
        enabled: true
      catalogId: '123456789012'
      databaseName: example_database
      tableName: example_table
      type: compaction

Snapshot Retention Optimizer

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.CatalogTableOptimizer("example", {
    configuration: {
        retentionConfiguration: {
            icebergConfiguration: {
                snapshotRetentionPeriodInDays: 7,
                numberOfSnapshotsToRetain: 3,
                cleanExpiredFiles: true,
            },
        },
        roleArn: "arn:aws:iam::123456789012:role/example-role",
        enabled: true,
    },
    catalogId: "123456789012",
    databaseName: "example_database",
    tableName: "example_table",
    type: "retention",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.CatalogTableOptimizer("example",
    configuration={
        "retention_configuration": {
            "iceberg_configuration": {
                "snapshot_retention_period_in_days": 7,
                "number_of_snapshots_to_retain": 3,
                "clean_expired_files": True,
            },
        },
        "role_arn": "arn:aws:iam::123456789012:role/example-role",
        "enabled": True,
    },
    catalog_id="123456789012",
    database_name="example_database",
    table_name="example_table",
    type="retention")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.CatalogTableOptimizer("example", new()
    {
        Configuration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationArgs
        {
            RetentionConfiguration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationRetentionConfigurationArgs
            {
                IcebergConfiguration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfigurationArgs
                {
                    SnapshotRetentionPeriodInDays = 7,
                    NumberOfSnapshotsToRetain = 3,
                    CleanExpiredFiles = true,
                },
            },
            RoleArn = "arn:aws:iam::123456789012:role/example-role",
            Enabled = true,
        },
        CatalogId = "123456789012",
        DatabaseName = "example_database",
        TableName = "example_table",
        Type = "retention",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewCatalogTableOptimizer(ctx, "example", &glue.CatalogTableOptimizerArgs{
			Configuration: &glue.CatalogTableOptimizerConfigurationArgs{
				RetentionConfiguration: &glue.CatalogTableOptimizerConfigurationRetentionConfigurationArgs{
					IcebergConfiguration: &glue.CatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfigurationArgs{
						SnapshotRetentionPeriodInDays: pulumi.Int(7),
						NumberOfSnapshotsToRetain:     pulumi.Int(3),
						CleanExpiredFiles:             pulumi.Bool(true),
					},
				},
				RoleArn: pulumi.String("arn:aws:iam::123456789012:role/example-role"),
				Enabled: pulumi.Bool(true),
			},
			CatalogId:    pulumi.String("123456789012"),
			DatabaseName: pulumi.String("example_database"),
			TableName:    pulumi.String("example_table"),
			Type:         pulumi.String("retention"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalogtableoptimizer" "example" {
  configuration = {
    retention_configuration = {
      iceberg_configuration = {
        snapshot_retention_period_in_days = 7
        number_of_snapshots_to_retain     = 3
        clean_expired_files               = true
      }
    }
    role_arn = "arn:aws:iam::123456789012:role/example-role"
    enabled  = true
  }
  catalog_id    = "123456789012"
  database_name = "example_database"
  table_name    = "example_table"
  type          = "retention"
}
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());

    }
}
resources:
  example:
    type: aws:glue:CatalogTableOptimizer
    properties:
      configuration:
        retentionConfiguration:
          icebergConfiguration:
            snapshotRetentionPeriodInDays: 7
            numberOfSnapshotsToRetain: 3
            cleanExpiredFiles: true
        roleArn: arn:aws:iam::123456789012:role/example-role
        enabled: true
      catalogId: '123456789012'
      databaseName: example_database
      tableName: example_table
      type: retention

Orphan File Deletion Optimizer

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.CatalogTableOptimizer("example", {
    configuration: {
        orphanFileDeletionConfiguration: {
            icebergConfiguration: {
                orphanFileRetentionPeriodInDays: 7,
                location: "s3://example-bucket/example_table/",
            },
        },
        roleArn: "arn:aws:iam::123456789012:role/example-role",
        enabled: true,
    },
    catalogId: "123456789012",
    databaseName: "example_database",
    tableName: "example_table",
    type: "orphan_file_deletion",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.CatalogTableOptimizer("example",
    configuration={
        "orphan_file_deletion_configuration": {
            "iceberg_configuration": {
                "orphan_file_retention_period_in_days": 7,
                "location": "s3://example-bucket/example_table/",
            },
        },
        "role_arn": "arn:aws:iam::123456789012:role/example-role",
        "enabled": True,
    },
    catalog_id="123456789012",
    database_name="example_database",
    table_name="example_table",
    type="orphan_file_deletion")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.CatalogTableOptimizer("example", new()
    {
        Configuration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationArgs
        {
            OrphanFileDeletionConfiguration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationArgs
            {
                IcebergConfiguration = new Aws.Glue.Inputs.CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfigurationArgs
                {
                    OrphanFileRetentionPeriodInDays = 7,
                    Location = "s3://example-bucket/example_table/",
                },
            },
            RoleArn = "arn:aws:iam::123456789012:role/example-role",
            Enabled = true,
        },
        CatalogId = "123456789012",
        DatabaseName = "example_database",
        TableName = "example_table",
        Type = "orphan_file_deletion",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewCatalogTableOptimizer(ctx, "example", &glue.CatalogTableOptimizerArgs{
			Configuration: &glue.CatalogTableOptimizerConfigurationArgs{
				OrphanFileDeletionConfiguration: &glue.CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationArgs{
					IcebergConfiguration: &glue.CatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfigurationArgs{
						OrphanFileRetentionPeriodInDays: pulumi.Int(7),
						Location:                        pulumi.String("s3://example-bucket/example_table/"),
					},
				},
				RoleArn: pulumi.String("arn:aws:iam::123456789012:role/example-role"),
				Enabled: pulumi.Bool(true),
			},
			CatalogId:    pulumi.String("123456789012"),
			DatabaseName: pulumi.String("example_database"),
			TableName:    pulumi.String("example_table"),
			Type:         pulumi.String("orphan_file_deletion"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalogtableoptimizer" "example" {
  configuration = {
    orphan_file_deletion_configuration = {
      iceberg_configuration = {
        orphan_file_retention_period_in_days = 7
        location                             = "s3://example-bucket/example_table/"
      }
    }
    role_arn = "arn:aws:iam::123456789012:role/example-role"
    enabled  = true
  }
  catalog_id    = "123456789012"
  database_name = "example_database"
  table_name    = "example_table"
  type          = "orphan_file_deletion"
}
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());

    }
}
resources:
  example:
    type: aws:glue:CatalogTableOptimizer
    properties:
      configuration:
        orphanFileDeletionConfiguration:
          icebergConfiguration:
            orphanFileRetentionPeriodInDays: 7
            location: s3://example-bucket/example_table/
        roleArn: arn:aws:iam::123456789012:role/example-role
        enabled: true
      catalogId: '123456789012'
      databaseName: example_database
      tableName: example_table
      type: orphan_file_deletion

Import

Using pulumi import, import Glue Catalog Table Optimizer using the catalog_id,database_name,table_name,type. For example:

$ pulumi import aws:glue/catalogTableOptimizer:CatalogTableOptimizer example 123456789012,example_database,example_table,compaction

Constructors

CatalogTableOptimizer(String name, {CatalogTableOptimizerArgs? args, CustomResourceOptions? options})
Creates a new CatalogTableOptimizer. name The Pulumi resource name. args Arguments used to configure this CatalogTableOptimizer. The set of arguments for CatalogTableOptimizer. options Resource options controlling this resource's behavior.
CatalogTableOptimizer.reference(String urn)
Creates a typed reference to an existing CatalogTableOptimizer resource.

Properties

catalogId ↔ Output<String>
The Catalog ID of the table.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configuration ↔ Output<CatalogTableOptimizerConfiguration>
A configuration block that defines the table optimizer settings. See Configuration for additional details.
latefinal
databaseName ↔ Output<String>
The name of the database in the catalog in which the table resides.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableName ↔ Output<String>
The name of the table.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
The type of table optimizer. Valid values are compaction, retention, and orphanFileDeletion.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {CatalogTableOptimizerState? state, CustomResourceOptions? options}) → CatalogTableOptimizer
Gets an existing CatalogTableOptimizer resource's state with the given name and id.