Catalog class

Manages an AWS Glue Catalog.

Example Usage

Basic Usage

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

const example = new aws.glue.Catalog("example", {
    name: "example",
    description: "Example Glue Catalog",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.Catalog("example",
    name="example",
    description="Example Glue Catalog")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.Catalog("example", new()
    {
        Name = "example",
        Description = "Example Glue Catalog",
    });

});
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.NewCatalog(ctx, "example", &glue.CatalogArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("Example Glue Catalog"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalog" "example" {
  name        = "example"
  description = "Example Glue Catalog"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Catalog;
import com.pulumi.aws.glue.CatalogArgs;
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 Catalog("example", CatalogArgs.builder()
            .name("example")
            .description("Example Glue Catalog")
            .build());

    }
}
resources:
  example:
    type: aws:glue:Catalog
    properties:
      name: example
      description: Example Glue Catalog

With Parameters

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

const example = new aws.glue.Catalog("example", {
    name: "example",
    description: "Example Glue Catalog",
    parameters: {
        key1: "value1",
        key2: "value2",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.glue.Catalog("example",
    name="example",
    description="Example Glue Catalog",
    parameters={
        "key1": "value1",
        "key2": "value2",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.Catalog("example", new()
    {
        Name = "example",
        Description = "Example Glue Catalog",
        Parameters =
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
    });

});
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.NewCatalog(ctx, "example", &glue.CatalogArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("Example Glue Catalog"),
			Parameters: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalog" "example" {
  name        = "example"
  description = "Example Glue Catalog"
  parameters = {
    "key1" = "value1"
    "key2" = "value2"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Catalog;
import com.pulumi.aws.glue.CatalogArgs;
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 Catalog("example", CatalogArgs.builder()
            .name("example")
            .description("Example Glue Catalog")
            .parameters(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key2", "value2")
            ))
            .build());

    }
}
resources:
  example:
    type: aws:glue:Catalog
    properties:
      name: example
      description: Example Glue Catalog
      parameters:
        key1: value1
        key2: value2

With Catalog Properties

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

const example = new aws.glue.Catalog("example", {
    catalogProperties: {
        dataLakeAccessProperties: {
            dataLakeAccess: true,
            catalogType: "aws:glue:datacatalog",
        },
        customProperties: {
            property1: "value1",
        },
    },
    name: "example",
    description: "Example Glue Catalog with data lake access",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.Catalog("example",
    catalog_properties={
        "data_lake_access_properties": {
            "data_lake_access": True,
            "catalog_type": "aws:glue:datacatalog",
        },
        "custom_properties": {
            "property1": "value1",
        },
    },
    name="example",
    description="Example Glue Catalog with data lake access")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.Catalog("example", new()
    {
        CatalogProperties = new Aws.Glue.Inputs.CatalogCatalogPropertiesArgs
        {
            DataLakeAccessProperties = new Aws.Glue.Inputs.CatalogCatalogPropertiesDataLakeAccessPropertiesArgs
            {
                DataLakeAccess = true,
                CatalogType = "aws:glue:datacatalog",
            },
            CustomProperties =
            {
                { "property1", "value1" },
            },
        },
        Name = "example",
        Description = "Example Glue Catalog with data lake access",
    });

});
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.NewCatalog(ctx, "example", &glue.CatalogArgs{
			CatalogProperties: &glue.CatalogCatalogPropertiesArgs{
				DataLakeAccessProperties: &glue.CatalogCatalogPropertiesDataLakeAccessPropertiesArgs{
					DataLakeAccess: pulumi.Bool(true),
					CatalogType:    pulumi.String("aws:glue:datacatalog"),
				},
				CustomProperties: pulumi.StringMap{
					"property1": pulumi.String("value1"),
				},
			},
			Name:        pulumi.String("example"),
			Description: pulumi.String("Example Glue Catalog with data lake access"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalog" "example" {
  catalog_properties = {
    data_lake_access_properties = {
      data_lake_access = true
      catalog_type     = "aws:glue:datacatalog"
    }
    custom_properties = {
      "property1" = "value1"
    }
  }
  name        = "example"
  description = "Example Glue Catalog with data lake access"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Catalog;
import com.pulumi.aws.glue.CatalogArgs;
import com.pulumi.aws.glue.inputs.CatalogCatalogPropertiesArgs;
import com.pulumi.aws.glue.inputs.CatalogCatalogPropertiesDataLakeAccessPropertiesArgs;
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 Catalog("example", CatalogArgs.builder()
            .catalogProperties(CatalogCatalogPropertiesArgs.builder()
                .dataLakeAccessProperties(CatalogCatalogPropertiesDataLakeAccessPropertiesArgs.builder()
                    .dataLakeAccess(true)
                    .catalogType("aws:glue:datacatalog")
                    .build())
                .customProperties(Map.of("property1", "value1"))
                .build())
            .name("example")
            .description("Example Glue Catalog with data lake access")
            .build());

    }
}
resources:
  example:
    type: aws:glue:Catalog
    properties:
      catalogProperties:
        dataLakeAccessProperties:
          dataLakeAccess: true
          catalogType: aws:glue:datacatalog
        customProperties:
          property1: value1
      name: example
      description: Example Glue Catalog with data lake access

With Federated Catalog

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

const example = new aws.glue.Catalog("example", {
    federatedCatalog: {
        connectionName: exampleAwsGlueConnection.name,
        identifier: "arn:aws:glue:us-east-1:123456789012:catalog",
    },
    name: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.Catalog("example",
    federated_catalog={
        "connection_name": example_aws_glue_connection["name"],
        "identifier": "arn:aws:glue:us-east-1:123456789012:catalog",
    },
    name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.Catalog("example", new()
    {
        FederatedCatalog = new Aws.Glue.Inputs.CatalogFederatedCatalogArgs
        {
            ConnectionName = exampleAwsGlueConnection.Name,
            Identifier = "arn:aws:glue:us-east-1:123456789012:catalog",
        },
        Name = "example",
    });

});
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.NewCatalog(ctx, "example", &glue.CatalogArgs{
			FederatedCatalog: &glue.CatalogFederatedCatalogArgs{
				ConnectionName: pulumi.Any(exampleAwsGlueConnection.Name),
				Identifier:     pulumi.String("arn:aws:glue:us-east-1:123456789012:catalog"),
			},
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalog" "example" {
  federated_catalog = {
    connection_name = exampleAwsGlueConnection.name
    identifier      = "arn:aws:glue:us-east-1:123456789012:catalog"
  }
  name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Catalog;
import com.pulumi.aws.glue.CatalogArgs;
import com.pulumi.aws.glue.inputs.CatalogFederatedCatalogArgs;
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 Catalog("example", CatalogArgs.builder()
            .federatedCatalog(CatalogFederatedCatalogArgs.builder()
                .connectionName(exampleAwsGlueConnection.name())
                .identifier("arn:aws:glue:us-east-1:123456789012:catalog")
                .build())
            .name("example")
            .build());

    }
}
resources:
  example:
    type: aws:glue:Catalog
    properties:
      federatedCatalog:
        connectionName: ${exampleAwsGlueConnection.name}
        identifier: arn:aws:glue:us-east-1:123456789012:catalog
      name: example

With Default Permissions

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

const example = new aws.glue.Catalog("example", {
    createDatabaseDefaultPermissions: [{
        principal: {
            dataLakePrincipalIdentifier: "IAM_ALLOWED_PRINCIPALS",
        },
        permissions: ["ALL"],
    }],
    createTableDefaultPermissions: [{
        principal: {
            dataLakePrincipalIdentifier: "IAM_ALLOWED_PRINCIPALS",
        },
        permissions: ["ALL"],
    }],
    name: "example",
    description: "Example Glue Catalog",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.Catalog("example",
    create_database_default_permissions=[{
        "principal": {
            "data_lake_principal_identifier": "IAM_ALLOWED_PRINCIPALS",
        },
        "permissions": ["ALL"],
    }],
    create_table_default_permissions=[{
        "principal": {
            "data_lake_principal_identifier": "IAM_ALLOWED_PRINCIPALS",
        },
        "permissions": ["ALL"],
    }],
    name="example",
    description="Example Glue Catalog")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.Catalog("example", new()
    {
        CreateDatabaseDefaultPermissions = new[]
        {
            new Aws.Glue.Inputs.CatalogCreateDatabaseDefaultPermissionArgs
            {
                Principal = new Aws.Glue.Inputs.CatalogCreateDatabaseDefaultPermissionPrincipalArgs
                {
                    DataLakePrincipalIdentifier = "IAM_ALLOWED_PRINCIPALS",
                },
                Permissions = new[]
                {
                    "ALL",
                },
            },
        },
        CreateTableDefaultPermissions = new[]
        {
            new Aws.Glue.Inputs.CatalogCreateTableDefaultPermissionArgs
            {
                Principal = new Aws.Glue.Inputs.CatalogCreateTableDefaultPermissionPrincipalArgs
                {
                    DataLakePrincipalIdentifier = "IAM_ALLOWED_PRINCIPALS",
                },
                Permissions = new[]
                {
                    "ALL",
                },
            },
        },
        Name = "example",
        Description = "Example Glue Catalog",
    });

});
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.NewCatalog(ctx, "example", &glue.CatalogArgs{
			CreateDatabaseDefaultPermissions: glue.CatalogCreateDatabaseDefaultPermissionArray{
				&glue.CatalogCreateDatabaseDefaultPermissionArgs{
					Principal: &glue.CatalogCreateDatabaseDefaultPermissionPrincipalArgs{
						DataLakePrincipalIdentifier: pulumi.String("IAM_ALLOWED_PRINCIPALS"),
					},
					Permissions: pulumi.StringArray{
						pulumi.String("ALL"),
					},
				},
			},
			CreateTableDefaultPermissions: glue.CatalogCreateTableDefaultPermissionArray{
				&glue.CatalogCreateTableDefaultPermissionArgs{
					Principal: &glue.CatalogCreateTableDefaultPermissionPrincipalArgs{
						DataLakePrincipalIdentifier: pulumi.String("IAM_ALLOWED_PRINCIPALS"),
					},
					Permissions: pulumi.StringArray{
						pulumi.String("ALL"),
					},
				},
			},
			Name:        pulumi.String("example"),
			Description: pulumi.String("Example Glue Catalog"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_catalog" "example" {
  create_database_default_permissions {
    principal = {
      data_lake_principal_identifier = "IAM_ALLOWED_PRINCIPALS"
    }
    permissions = ["ALL"]
  }
  create_table_default_permissions {
    principal = {
      data_lake_principal_identifier = "IAM_ALLOWED_PRINCIPALS"
    }
    permissions = ["ALL"]
  }
  name        = "example"
  description = "Example Glue Catalog"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Catalog;
import com.pulumi.aws.glue.CatalogArgs;
import com.pulumi.aws.glue.inputs.CatalogCreateDatabaseDefaultPermissionArgs;
import com.pulumi.aws.glue.inputs.CatalogCreateDatabaseDefaultPermissionPrincipalArgs;
import com.pulumi.aws.glue.inputs.CatalogCreateTableDefaultPermissionArgs;
import com.pulumi.aws.glue.inputs.CatalogCreateTableDefaultPermissionPrincipalArgs;
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 Catalog("example", CatalogArgs.builder()
            .createDatabaseDefaultPermissions(CatalogCreateDatabaseDefaultPermissionArgs.builder()
                .principal(CatalogCreateDatabaseDefaultPermissionPrincipalArgs.builder()
                    .dataLakePrincipalIdentifier("IAM_ALLOWED_PRINCIPALS")
                    .build())
                .permissions("ALL")
                .build())
            .createTableDefaultPermissions(CatalogCreateTableDefaultPermissionArgs.builder()
                .principal(CatalogCreateTableDefaultPermissionPrincipalArgs.builder()
                    .dataLakePrincipalIdentifier("IAM_ALLOWED_PRINCIPALS")
                    .build())
                .permissions("ALL")
                .build())
            .name("example")
            .description("Example Glue Catalog")
            .build());

    }
}
resources:
  example:
    type: aws:glue:Catalog
    properties:
      createDatabaseDefaultPermissions:
        - principal:
            dataLakePrincipalIdentifier: IAM_ALLOWED_PRINCIPALS
          permissions:
            - ALL
      createTableDefaultPermissions:
        - principal:
            dataLakePrincipalIdentifier: IAM_ALLOWED_PRINCIPALS
          permissions:
            - ALL
      name: example
      description: Example Glue Catalog

Import

Identity Schema

Required

  • name (String) Name of the Glue Catalog.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Glue Catalog using the catalog name. For example:

$ pulumi import aws:glue/catalog:Catalog example example

Constructors

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

Properties

allowFullTableExternalDataAccess ↔ Output<String>
Whether third-party engines can access data in Amazon S3 locations that are registered with Lake Formation. Valid values are True and False.
latefinal
arn ↔ Output<String>
ARN of the Glue Catalog.
latefinal
catalogId ↔ Output<String>
ID of the parent catalog.
latefinal
catalogProperties ↔ Output<CatalogCatalogProperties?>
Configuration block of properties for the catalog. See catalogProperties below.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createDatabaseDefaultPermissions ↔ Output<List<CatalogCreateDatabaseDefaultPermission>?>
List of default permissions on databases for principals. See createDatabaseDefaultPermissions below.
latefinal
createTableDefaultPermissions ↔ Output<List<CatalogCreateTableDefaultPermission>?>
List of default permissions on tables for principals. See createTableDefaultPermissions below.
latefinal
createTime ↔ Output<String>
Time at which the catalog was created.
latefinal
description ↔ Output<String?>
Description of the catalog.
latefinal
federatedCatalog ↔ Output<CatalogFederatedCatalog?>
Configuration block for a federated catalog. See federatedCatalog below.
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
name ↔ Output<String>
Name of the catalog.
latefinal
overwriteChildResourcePermissionsWithDefault ↔ Output<String?>
Whether to overwrite existing Lake Formation permissions on child resources with the default permissions. Valid values are Accept and Deny.
latefinal
parameters ↔ Output<Map<String, String>?>
Map of key-value pairs that define parameters and properties of the catalog.
latefinal
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
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
targetRedshiftCatalog ↔ Output<CatalogTargetRedshiftCatalog?>
Configuration block for a target Redshift catalog. See targetRedshiftCatalog below.
latefinal
timeouts ↔ Output<CatalogTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>
Time at which the catalog was last updated.
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, {CatalogState? state, CustomResourceOptions? options}) → Catalog
Gets an existing Catalog resource's state with the given name and id.