1. Packages
  2. AWS Classic
  3. API Docs
  4. glue
  5. CatalogDatabase

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.glue.CatalogDatabase

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides a Glue Catalog Database Resource. You can refer to the Glue Developer Guide for a full explanation of the Glue Data Catalog functionality

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.glue.CatalogDatabase("example", {name: "MyCatalogDatabase"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.glue.CatalogDatabase("example", name="MyCatalogDatabase")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := glue.NewCatalogDatabase(ctx, "example", &glue.CatalogDatabaseArgs{
    			Name: pulumi.String("MyCatalogDatabase"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Glue.CatalogDatabase("example", new()
        {
            Name = "MyCatalogDatabase",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.glue.CatalogDatabase;
    import com.pulumi.aws.glue.CatalogDatabaseArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 CatalogDatabase("example", CatalogDatabaseArgs.builder()
                .name("MyCatalogDatabase")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:glue:CatalogDatabase
        properties:
          name: MyCatalogDatabase
    

    Create Table Default Permissions

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.glue.CatalogDatabase("example", {
        name: "MyCatalogDatabase",
        createTableDefaultPermissions: [{
            permissions: ["SELECT"],
            principal: {
                dataLakePrincipalIdentifier: "IAM_ALLOWED_PRINCIPALS",
            },
        }],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.glue.CatalogDatabase("example",
        name="MyCatalogDatabase",
        create_table_default_permissions=[aws.glue.CatalogDatabaseCreateTableDefaultPermissionArgs(
            permissions=["SELECT"],
            principal=aws.glue.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs(
                data_lake_principal_identifier="IAM_ALLOWED_PRINCIPALS",
            ),
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := glue.NewCatalogDatabase(ctx, "example", &glue.CatalogDatabaseArgs{
    			Name: pulumi.String("MyCatalogDatabase"),
    			CreateTableDefaultPermissions: glue.CatalogDatabaseCreateTableDefaultPermissionArray{
    				&glue.CatalogDatabaseCreateTableDefaultPermissionArgs{
    					Permissions: pulumi.StringArray{
    						pulumi.String("SELECT"),
    					},
    					Principal: &glue.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs{
    						DataLakePrincipalIdentifier: pulumi.String("IAM_ALLOWED_PRINCIPALS"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Glue.CatalogDatabase("example", new()
        {
            Name = "MyCatalogDatabase",
            CreateTableDefaultPermissions = new[]
            {
                new Aws.Glue.Inputs.CatalogDatabaseCreateTableDefaultPermissionArgs
                {
                    Permissions = new[]
                    {
                        "SELECT",
                    },
                    Principal = new Aws.Glue.Inputs.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs
                    {
                        DataLakePrincipalIdentifier = "IAM_ALLOWED_PRINCIPALS",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.glue.CatalogDatabase;
    import com.pulumi.aws.glue.CatalogDatabaseArgs;
    import com.pulumi.aws.glue.inputs.CatalogDatabaseCreateTableDefaultPermissionArgs;
    import com.pulumi.aws.glue.inputs.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 CatalogDatabase("example", CatalogDatabaseArgs.builder()
                .name("MyCatalogDatabase")
                .createTableDefaultPermissions(CatalogDatabaseCreateTableDefaultPermissionArgs.builder()
                    .permissions("SELECT")
                    .principal(CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs.builder()
                        .dataLakePrincipalIdentifier("IAM_ALLOWED_PRINCIPALS")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:glue:CatalogDatabase
        properties:
          name: MyCatalogDatabase
          createTableDefaultPermissions:
            - permissions:
                - SELECT
              principal:
                dataLakePrincipalIdentifier: IAM_ALLOWED_PRINCIPALS
    

    Create CatalogDatabase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CatalogDatabase(name: string, args?: CatalogDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def CatalogDatabase(resource_name: str,
                        args: Optional[CatalogDatabaseArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def CatalogDatabase(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        catalog_id: Optional[str] = None,
                        create_table_default_permissions: Optional[Sequence[CatalogDatabaseCreateTableDefaultPermissionArgs]] = None,
                        description: Optional[str] = None,
                        federated_database: Optional[CatalogDatabaseFederatedDatabaseArgs] = None,
                        location_uri: Optional[str] = None,
                        name: Optional[str] = None,
                        parameters: Optional[Mapping[str, str]] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        target_database: Optional[CatalogDatabaseTargetDatabaseArgs] = None)
    func NewCatalogDatabase(ctx *Context, name string, args *CatalogDatabaseArgs, opts ...ResourceOption) (*CatalogDatabase, error)
    public CatalogDatabase(string name, CatalogDatabaseArgs? args = null, CustomResourceOptions? opts = null)
    public CatalogDatabase(String name, CatalogDatabaseArgs args)
    public CatalogDatabase(String name, CatalogDatabaseArgs args, CustomResourceOptions options)
    
    type: aws:glue:CatalogDatabase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CatalogDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CatalogDatabaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CatalogDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogDatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var catalogDatabaseResource = new Aws.Glue.CatalogDatabase("catalogDatabaseResource", new()
    {
        CatalogId = "string",
        CreateTableDefaultPermissions = new[]
        {
            new Aws.Glue.Inputs.CatalogDatabaseCreateTableDefaultPermissionArgs
            {
                Permissions = new[]
                {
                    "string",
                },
                Principal = new Aws.Glue.Inputs.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs
                {
                    DataLakePrincipalIdentifier = "string",
                },
            },
        },
        Description = "string",
        FederatedDatabase = new Aws.Glue.Inputs.CatalogDatabaseFederatedDatabaseArgs
        {
            ConnectionName = "string",
            Identifier = "string",
        },
        LocationUri = "string",
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        Tags = 
        {
            { "string", "string" },
        },
        TargetDatabase = new Aws.Glue.Inputs.CatalogDatabaseTargetDatabaseArgs
        {
            CatalogId = "string",
            DatabaseName = "string",
            Region = "string",
        },
    });
    
    example, err := glue.NewCatalogDatabase(ctx, "catalogDatabaseResource", &glue.CatalogDatabaseArgs{
    	CatalogId: pulumi.String("string"),
    	CreateTableDefaultPermissions: glue.CatalogDatabaseCreateTableDefaultPermissionArray{
    		&glue.CatalogDatabaseCreateTableDefaultPermissionArgs{
    			Permissions: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Principal: &glue.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs{
    				DataLakePrincipalIdentifier: pulumi.String("string"),
    			},
    		},
    	},
    	Description: pulumi.String("string"),
    	FederatedDatabase: &glue.CatalogDatabaseFederatedDatabaseArgs{
    		ConnectionName: pulumi.String("string"),
    		Identifier:     pulumi.String("string"),
    	},
    	LocationUri: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TargetDatabase: &glue.CatalogDatabaseTargetDatabaseArgs{
    		CatalogId:    pulumi.String("string"),
    		DatabaseName: pulumi.String("string"),
    		Region:       pulumi.String("string"),
    	},
    })
    
    var catalogDatabaseResource = new CatalogDatabase("catalogDatabaseResource", CatalogDatabaseArgs.builder()
        .catalogId("string")
        .createTableDefaultPermissions(CatalogDatabaseCreateTableDefaultPermissionArgs.builder()
            .permissions("string")
            .principal(CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs.builder()
                .dataLakePrincipalIdentifier("string")
                .build())
            .build())
        .description("string")
        .federatedDatabase(CatalogDatabaseFederatedDatabaseArgs.builder()
            .connectionName("string")
            .identifier("string")
            .build())
        .locationUri("string")
        .name("string")
        .parameters(Map.of("string", "string"))
        .tags(Map.of("string", "string"))
        .targetDatabase(CatalogDatabaseTargetDatabaseArgs.builder()
            .catalogId("string")
            .databaseName("string")
            .region("string")
            .build())
        .build());
    
    catalog_database_resource = aws.glue.CatalogDatabase("catalogDatabaseResource",
        catalog_id="string",
        create_table_default_permissions=[aws.glue.CatalogDatabaseCreateTableDefaultPermissionArgs(
            permissions=["string"],
            principal=aws.glue.CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs(
                data_lake_principal_identifier="string",
            ),
        )],
        description="string",
        federated_database=aws.glue.CatalogDatabaseFederatedDatabaseArgs(
            connection_name="string",
            identifier="string",
        ),
        location_uri="string",
        name="string",
        parameters={
            "string": "string",
        },
        tags={
            "string": "string",
        },
        target_database=aws.glue.CatalogDatabaseTargetDatabaseArgs(
            catalog_id="string",
            database_name="string",
            region="string",
        ))
    
    const catalogDatabaseResource = new aws.glue.CatalogDatabase("catalogDatabaseResource", {
        catalogId: "string",
        createTableDefaultPermissions: [{
            permissions: ["string"],
            principal: {
                dataLakePrincipalIdentifier: "string",
            },
        }],
        description: "string",
        federatedDatabase: {
            connectionName: "string",
            identifier: "string",
        },
        locationUri: "string",
        name: "string",
        parameters: {
            string: "string",
        },
        tags: {
            string: "string",
        },
        targetDatabase: {
            catalogId: "string",
            databaseName: "string",
            region: "string",
        },
    });
    
    type: aws:glue:CatalogDatabase
    properties:
        catalogId: string
        createTableDefaultPermissions:
            - permissions:
                - string
              principal:
                dataLakePrincipalIdentifier: string
        description: string
        federatedDatabase:
            connectionName: string
            identifier: string
        locationUri: string
        name: string
        parameters:
            string: string
        tags:
            string: string
        targetDatabase:
            catalogId: string
            databaseName: string
            region: string
    

    CatalogDatabase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CatalogDatabase resource accepts the following input properties:

    CatalogId string
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    CreateTableDefaultPermissions List<CatalogDatabaseCreateTableDefaultPermission>
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    Description string
    Description of the database.
    FederatedDatabase CatalogDatabaseFederatedDatabase
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    LocationUri string
    Location of the database (for example, an HDFS path).
    Name string
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    Parameters Dictionary<string, string>
    List of key-value pairs that define parameters and properties of the database.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TargetDatabase CatalogDatabaseTargetDatabase
    Configuration block for a target database for resource linking. See target_database below.
    CatalogId string
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    CreateTableDefaultPermissions []CatalogDatabaseCreateTableDefaultPermissionArgs
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    Description string
    Description of the database.
    FederatedDatabase CatalogDatabaseFederatedDatabaseArgs
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    LocationUri string
    Location of the database (for example, an HDFS path).
    Name string
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    Parameters map[string]string
    List of key-value pairs that define parameters and properties of the database.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TargetDatabase CatalogDatabaseTargetDatabaseArgs
    Configuration block for a target database for resource linking. See target_database below.
    catalogId String
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    createTableDefaultPermissions List<CatalogDatabaseCreateTableDefaultPermission>
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description String
    Description of the database.
    federatedDatabase CatalogDatabaseFederatedDatabase
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    locationUri String
    Location of the database (for example, an HDFS path).
    name String
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters Map<String,String>
    List of key-value pairs that define parameters and properties of the database.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    targetDatabase CatalogDatabaseTargetDatabase
    Configuration block for a target database for resource linking. See target_database below.
    catalogId string
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    createTableDefaultPermissions CatalogDatabaseCreateTableDefaultPermission[]
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description string
    Description of the database.
    federatedDatabase CatalogDatabaseFederatedDatabase
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    locationUri string
    Location of the database (for example, an HDFS path).
    name string
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters {[key: string]: string}
    List of key-value pairs that define parameters and properties of the database.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    targetDatabase CatalogDatabaseTargetDatabase
    Configuration block for a target database for resource linking. See target_database below.
    catalog_id str
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    create_table_default_permissions Sequence[CatalogDatabaseCreateTableDefaultPermissionArgs]
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description str
    Description of the database.
    federated_database CatalogDatabaseFederatedDatabaseArgs
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    location_uri str
    Location of the database (for example, an HDFS path).
    name str
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters Mapping[str, str]
    List of key-value pairs that define parameters and properties of the database.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    target_database CatalogDatabaseTargetDatabaseArgs
    Configuration block for a target database for resource linking. See target_database below.
    catalogId String
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    createTableDefaultPermissions List<Property Map>
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description String
    Description of the database.
    federatedDatabase Property Map
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    locationUri String
    Location of the database (for example, an HDFS path).
    name String
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters Map<String>
    List of key-value pairs that define parameters and properties of the database.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    targetDatabase Property Map
    Configuration block for a target database for resource linking. See target_database below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CatalogDatabase resource produces the following output properties:

    Arn string
    ARN of the Glue Catalog Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Glue Catalog Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Glue Catalog Database.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Glue Catalog Database.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Glue Catalog Database.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Glue Catalog Database.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing CatalogDatabase Resource

    Get an existing CatalogDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CatalogDatabaseState, opts?: CustomResourceOptions): CatalogDatabase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            catalog_id: Optional[str] = None,
            create_table_default_permissions: Optional[Sequence[CatalogDatabaseCreateTableDefaultPermissionArgs]] = None,
            description: Optional[str] = None,
            federated_database: Optional[CatalogDatabaseFederatedDatabaseArgs] = None,
            location_uri: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            target_database: Optional[CatalogDatabaseTargetDatabaseArgs] = None) -> CatalogDatabase
    func GetCatalogDatabase(ctx *Context, name string, id IDInput, state *CatalogDatabaseState, opts ...ResourceOption) (*CatalogDatabase, error)
    public static CatalogDatabase Get(string name, Input<string> id, CatalogDatabaseState? state, CustomResourceOptions? opts = null)
    public static CatalogDatabase get(String name, Output<String> id, CatalogDatabaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Glue Catalog Database.
    CatalogId string
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    CreateTableDefaultPermissions List<CatalogDatabaseCreateTableDefaultPermission>
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    Description string
    Description of the database.
    FederatedDatabase CatalogDatabaseFederatedDatabase
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    LocationUri string
    Location of the database (for example, an HDFS path).
    Name string
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    Parameters Dictionary<string, string>
    List of key-value pairs that define parameters and properties of the database.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetDatabase CatalogDatabaseTargetDatabase
    Configuration block for a target database for resource linking. See target_database below.
    Arn string
    ARN of the Glue Catalog Database.
    CatalogId string
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    CreateTableDefaultPermissions []CatalogDatabaseCreateTableDefaultPermissionArgs
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    Description string
    Description of the database.
    FederatedDatabase CatalogDatabaseFederatedDatabaseArgs
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    LocationUri string
    Location of the database (for example, an HDFS path).
    Name string
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    Parameters map[string]string
    List of key-value pairs that define parameters and properties of the database.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetDatabase CatalogDatabaseTargetDatabaseArgs
    Configuration block for a target database for resource linking. See target_database below.
    arn String
    ARN of the Glue Catalog Database.
    catalogId String
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    createTableDefaultPermissions List<CatalogDatabaseCreateTableDefaultPermission>
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description String
    Description of the database.
    federatedDatabase CatalogDatabaseFederatedDatabase
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    locationUri String
    Location of the database (for example, an HDFS path).
    name String
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters Map<String,String>
    List of key-value pairs that define parameters and properties of the database.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetDatabase CatalogDatabaseTargetDatabase
    Configuration block for a target database for resource linking. See target_database below.
    arn string
    ARN of the Glue Catalog Database.
    catalogId string
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    createTableDefaultPermissions CatalogDatabaseCreateTableDefaultPermission[]
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description string
    Description of the database.
    federatedDatabase CatalogDatabaseFederatedDatabase
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    locationUri string
    Location of the database (for example, an HDFS path).
    name string
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters {[key: string]: string}
    List of key-value pairs that define parameters and properties of the database.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetDatabase CatalogDatabaseTargetDatabase
    Configuration block for a target database for resource linking. See target_database below.
    arn str
    ARN of the Glue Catalog Database.
    catalog_id str
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    create_table_default_permissions Sequence[CatalogDatabaseCreateTableDefaultPermissionArgs]
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description str
    Description of the database.
    federated_database CatalogDatabaseFederatedDatabaseArgs
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    location_uri str
    Location of the database (for example, an HDFS path).
    name str
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters Mapping[str, str]
    List of key-value pairs that define parameters and properties of the database.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_database CatalogDatabaseTargetDatabaseArgs
    Configuration block for a target database for resource linking. See target_database below.
    arn String
    ARN of the Glue Catalog Database.
    catalogId String
    ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.
    createTableDefaultPermissions List<Property Map>
    Creates a set of default permissions on the table for principals. See create_table_default_permission below.
    description String
    Description of the database.
    federatedDatabase Property Map
    Configuration block that references an entity outside the AWS Glue Data Catalog. See federated_database below.
    locationUri String
    Location of the database (for example, an HDFS path).
    name String
    Name of the database. The acceptable characters are lowercase letters, numbers, and the underscore character.
    parameters Map<String>
    List of key-value pairs that define parameters and properties of the database.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetDatabase Property Map
    Configuration block for a target database for resource linking. See target_database below.

    Supporting Types

    CatalogDatabaseCreateTableDefaultPermission, CatalogDatabaseCreateTableDefaultPermissionArgs

    Permissions List<string>
    The permissions that are granted to the principal.
    Principal CatalogDatabaseCreateTableDefaultPermissionPrincipal
    The principal who is granted permissions.. See principal below.
    Permissions []string
    The permissions that are granted to the principal.
    Principal CatalogDatabaseCreateTableDefaultPermissionPrincipal
    The principal who is granted permissions.. See principal below.
    permissions List<String>
    The permissions that are granted to the principal.
    principal CatalogDatabaseCreateTableDefaultPermissionPrincipal
    The principal who is granted permissions.. See principal below.
    permissions string[]
    The permissions that are granted to the principal.
    principal CatalogDatabaseCreateTableDefaultPermissionPrincipal
    The principal who is granted permissions.. See principal below.
    permissions Sequence[str]
    The permissions that are granted to the principal.
    principal CatalogDatabaseCreateTableDefaultPermissionPrincipal
    The principal who is granted permissions.. See principal below.
    permissions List<String>
    The permissions that are granted to the principal.
    principal Property Map
    The principal who is granted permissions.. See principal below.

    CatalogDatabaseCreateTableDefaultPermissionPrincipal, CatalogDatabaseCreateTableDefaultPermissionPrincipalArgs

    DataLakePrincipalIdentifier string
    An identifier for the Lake Formation principal.
    DataLakePrincipalIdentifier string
    An identifier for the Lake Formation principal.
    dataLakePrincipalIdentifier String
    An identifier for the Lake Formation principal.
    dataLakePrincipalIdentifier string
    An identifier for the Lake Formation principal.
    data_lake_principal_identifier str
    An identifier for the Lake Formation principal.
    dataLakePrincipalIdentifier String
    An identifier for the Lake Formation principal.

    CatalogDatabaseFederatedDatabase, CatalogDatabaseFederatedDatabaseArgs

    ConnectionName string
    Name of the connection to the external metastore.
    Identifier string
    Unique identifier for the federated database.
    ConnectionName string
    Name of the connection to the external metastore.
    Identifier string
    Unique identifier for the federated database.
    connectionName String
    Name of the connection to the external metastore.
    identifier String
    Unique identifier for the federated database.
    connectionName string
    Name of the connection to the external metastore.
    identifier string
    Unique identifier for the federated database.
    connection_name str
    Name of the connection to the external metastore.
    identifier str
    Unique identifier for the federated database.
    connectionName String
    Name of the connection to the external metastore.
    identifier String
    Unique identifier for the federated database.

    CatalogDatabaseTargetDatabase, CatalogDatabaseTargetDatabaseArgs

    CatalogId string
    ID of the Data Catalog in which the database resides.
    DatabaseName string
    Name of the catalog database.
    Region string
    Region of the target database.
    CatalogId string
    ID of the Data Catalog in which the database resides.
    DatabaseName string
    Name of the catalog database.
    Region string
    Region of the target database.
    catalogId String
    ID of the Data Catalog in which the database resides.
    databaseName String
    Name of the catalog database.
    region String
    Region of the target database.
    catalogId string
    ID of the Data Catalog in which the database resides.
    databaseName string
    Name of the catalog database.
    region string
    Region of the target database.
    catalog_id str
    ID of the Data Catalog in which the database resides.
    database_name str
    Name of the catalog database.
    region str
    Region of the target database.
    catalogId String
    ID of the Data Catalog in which the database resides.
    databaseName String
    Name of the catalog database.
    region String
    Region of the target database.

    Import

    Using pulumi import, import Glue Catalog Databases using the catalog_id:name. If you have not set a Catalog ID specify the AWS Account ID that the database is in. For example:

    $ pulumi import aws:glue/catalogDatabase:CatalogDatabase database 123456789012:my_database
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi