1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. glue
  5. Catalog

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.glue.Catalog

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates a catalog in the Glue Data Catalog.

    Create Catalog Resource

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

    Constructor syntax

    new Catalog(name: string, args?: CatalogArgs, opts?: CustomResourceOptions);
    @overload
def Catalog(resource_name: str,
            args: Optional[CatalogArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            allow_full_table_external_data_access: Optional[CatalogAllowFullTableExternalDataAccess] = None,
            catalog_properties: Optional[CatalogPropertiesArgs] = None,
            create_database_default_permissions: Optional[Sequence[CatalogPrincipalPermissionsArgs]] = None,
            create_table_default_permissions: Optional[Sequence[CatalogPrincipalPermissionsArgs]] = None,
            description: Optional[str] = None,
            federated_catalog: Optional[CatalogFederatedCatalogArgs] = None,
            name: Optional[str] = None,
            overwrite_child_resource_permissions_with_default: Optional[CatalogOverwriteChildResourcePermissionsWithDefault] = None,
            parameters: Optional[Mapping[str, str]] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
            target_redshift_catalog: Optional[CatalogTargetRedshiftCatalogArgs] = None)
    func NewCatalog(ctx *Context, name string, args *CatalogArgs, opts ...ResourceOption) (*Catalog, error)
    public Catalog(string name, CatalogArgs? args = null, CustomResourceOptions? opts = null)
    public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)

    type: aws-native:glue:Catalog
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 CatalogArgs
    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 CatalogArgs
    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 CatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Catalog Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Catalog resource accepts the following input properties:

    AllowFullTableExternalDataAccess Pulumi.AwsNative.Glue.CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    CatalogProperties Pulumi.AwsNative.Glue.Inputs.CatalogProperties
    CreateDatabaseDefaultPermissions List<Pulumi.AwsNative.Glue.Inputs.CatalogPrincipalPermissions>
    An array of PrincipalPermissions objects for default database permissions.
    CreateTableDefaultPermissions List<Pulumi.AwsNative.Glue.Inputs.CatalogPrincipalPermissions>
    An array of PrincipalPermissions objects for default table permissions.
    Description string
    A description of the catalog.
    FederatedCatalog Pulumi.AwsNative.Glue.Inputs.CatalogFederatedCatalog
    Name string
    The name of the catalog to create.
    OverwriteChildResourcePermissionsWithDefault Pulumi.AwsNative.Glue.CatalogOverwriteChildResourcePermissionsWithDefault
    Specifies whether to overwrite child resource permissions with the default permissions.
    Parameters Dictionary<string, string>
    A map of key-value pairs that define parameters and properties of the catalog.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    TargetRedshiftCatalog Pulumi.AwsNative.Glue.Inputs.CatalogTargetRedshiftCatalog
    AllowFullTableExternalDataAccess CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    CatalogProperties CatalogPropertiesArgs
    CreateDatabaseDefaultPermissions []CatalogPrincipalPermissionsArgs
    An array of PrincipalPermissions objects for default database permissions.
    CreateTableDefaultPermissions []CatalogPrincipalPermissionsArgs
    An array of PrincipalPermissions objects for default table permissions.
    Description string
    A description of the catalog.
    FederatedCatalog CatalogFederatedCatalogArgs
    Name string
    The name of the catalog to create.
    OverwriteChildResourcePermissionsWithDefault CatalogOverwriteChildResourcePermissionsWithDefault
    Specifies whether to overwrite child resource permissions with the default permissions.
    Parameters map[string]string
    A map of key-value pairs that define parameters and properties of the catalog.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    TargetRedshiftCatalog CatalogTargetRedshiftCatalogArgs
    allowFullTableExternalDataAccess CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogProperties CatalogProperties
    createDatabaseDefaultPermissions List<CatalogPrincipalPermissions>
    An array of PrincipalPermissions objects for default database permissions.
    createTableDefaultPermissions List<CatalogPrincipalPermissions>
    An array of PrincipalPermissions objects for default table permissions.
    description String
    A description of the catalog.
    federatedCatalog CatalogFederatedCatalog
    name String
    The name of the catalog to create.
    overwriteChildResourcePermissionsWithDefault CatalogOverwriteChildResourcePermissionsWithDefault
    Specifies whether to overwrite child resource permissions with the default permissions.
    parameters Map<String,String>
    A map of key-value pairs that define parameters and properties of the catalog.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    targetRedshiftCatalog CatalogTargetRedshiftCatalog
    allowFullTableExternalDataAccess CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogProperties CatalogProperties
    createDatabaseDefaultPermissions CatalogPrincipalPermissions[]
    An array of PrincipalPermissions objects for default database permissions.
    createTableDefaultPermissions CatalogPrincipalPermissions[]
    An array of PrincipalPermissions objects for default table permissions.
    description string
    A description of the catalog.
    federatedCatalog CatalogFederatedCatalog
    name string
    The name of the catalog to create.
    overwriteChildResourcePermissionsWithDefault CatalogOverwriteChildResourcePermissionsWithDefault
    Specifies whether to overwrite child resource permissions with the default permissions.
    parameters {[key: string]: string}
    A map of key-value pairs that define parameters and properties of the catalog.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    targetRedshiftCatalog CatalogTargetRedshiftCatalog
    allow_full_table_external_data_access CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalog_properties CatalogPropertiesArgs
    create_database_default_permissions Sequence[CatalogPrincipalPermissionsArgs]
    An array of PrincipalPermissions objects for default database permissions.
    create_table_default_permissions Sequence[CatalogPrincipalPermissionsArgs]
    An array of PrincipalPermissions objects for default table permissions.
    description str
    A description of the catalog.
    federated_catalog CatalogFederatedCatalogArgs
    name str
    The name of the catalog to create.
    overwrite_child_resource_permissions_with_default CatalogOverwriteChildResourcePermissionsWithDefault
    Specifies whether to overwrite child resource permissions with the default permissions.
    parameters Mapping[str, str]
    A map of key-value pairs that define parameters and properties of the catalog.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    target_redshift_catalog CatalogTargetRedshiftCatalogArgs
    allowFullTableExternalDataAccess "True" | "False"
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogProperties Property Map
    createDatabaseDefaultPermissions List<Property Map>
    An array of PrincipalPermissions objects for default database permissions.
    createTableDefaultPermissions List<Property Map>
    An array of PrincipalPermissions objects for default table permissions.
    description String
    A description of the catalog.
    federatedCatalog Property Map
    name String
    The name of the catalog to create.
    overwriteChildResourcePermissionsWithDefault "Accept" | "Deny"
    Specifies whether to overwrite child resource permissions with the default permissions.
    parameters Map<String>
    A map of key-value pairs that define parameters and properties of the catalog.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    targetRedshiftCatalog Property Map

    Outputs

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

    CatalogId string
    The ID of the catalog.
    CreateTime int
    The time at which the catalog was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    UpdateTime int
    The time at which the catalog was last updated.
    CatalogId string
    The ID of the catalog.
    CreateTime int
    The time at which the catalog was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    UpdateTime int
    The time at which the catalog was last updated.
    catalogId String
    The ID of the catalog.
    createTime Integer
    The time at which the catalog was created.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceArn String
    The Amazon Resource Name (ARN) of the catalog.
    updateTime Integer
    The time at which the catalog was last updated.
    catalogId string
    The ID of the catalog.
    createTime number
    The time at which the catalog was created.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    updateTime number
    The time at which the catalog was last updated.
    catalog_id str
    The ID of the catalog.
    create_time int
    The time at which the catalog was created.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_arn str
    The Amazon Resource Name (ARN) of the catalog.
    update_time int
    The time at which the catalog was last updated.
    catalogId String
    The ID of the catalog.
    createTime Number
    The time at which the catalog was created.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceArn String
    The Amazon Resource Name (ARN) of the catalog.
    updateTime Number
    The time at which the catalog was last updated.

    Supporting Types

    CatalogAllowFullTableExternalDataAccess, CatalogAllowFullTableExternalDataAccessArgs

    True
    True
    False
    False
    CatalogAllowFullTableExternalDataAccessTrue
    True
    CatalogAllowFullTableExternalDataAccessFalse
    False
    True
    True
    False
    False
    True
    True
    False
    False
    TRUE
    True
    FALSE
    False
    "True"
    True
    "False"
    False

    CatalogDataLakeAccessProperties, CatalogDataLakeAccessPropertiesArgs

    Data lake access properties for the catalog.
    AllowFullTableExternalDataAccess Pulumi.AwsNative.Glue.CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    CatalogType string
    Specifies a federated catalog type for the native catalog resource.
    DataLakeAccess bool
    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.
    DataTransferRole string
    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
    KmsKey string
    An encryption key that will be used for the staging bucket that will be created along with the catalog.
    ManagedWorkgroupName string
    The name of the managed workgroup associated with the catalog.
    ManagedWorkgroupStatus string
    The status of the managed workgroup.
    RedshiftDatabaseName string
    The name of the Redshift database.
    AllowFullTableExternalDataAccess CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    CatalogType string
    Specifies a federated catalog type for the native catalog resource.
    DataLakeAccess bool
    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.
    DataTransferRole string
    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
    KmsKey string
    An encryption key that will be used for the staging bucket that will be created along with the catalog.
    ManagedWorkgroupName string
    The name of the managed workgroup associated with the catalog.
    ManagedWorkgroupStatus string
    The status of the managed workgroup.
    RedshiftDatabaseName string
    The name of the Redshift database.
    allowFullTableExternalDataAccess CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogType String
    Specifies a federated catalog type for the native catalog resource.
    dataLakeAccess Boolean
    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.
    dataTransferRole String
    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
    kmsKey String
    An encryption key that will be used for the staging bucket that will be created along with the catalog.
    managedWorkgroupName String
    The name of the managed workgroup associated with the catalog.
    managedWorkgroupStatus String
    The status of the managed workgroup.
    redshiftDatabaseName String
    The name of the Redshift database.
    allowFullTableExternalDataAccess CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogType string
    Specifies a federated catalog type for the native catalog resource.
    dataLakeAccess boolean
    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.
    dataTransferRole string
    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
    kmsKey string
    An encryption key that will be used for the staging bucket that will be created along with the catalog.
    managedWorkgroupName string
    The name of the managed workgroup associated with the catalog.
    managedWorkgroupStatus string
    The status of the managed workgroup.
    redshiftDatabaseName string
    The name of the Redshift database.
    allow_full_table_external_data_access CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalog_type str
    Specifies a federated catalog type for the native catalog resource.
    data_lake_access bool
    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.
    data_transfer_role str
    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
    kms_key str
    An encryption key that will be used for the staging bucket that will be created along with the catalog.
    managed_workgroup_name str
    The name of the managed workgroup associated with the catalog.
    managed_workgroup_status str
    The status of the managed workgroup.
    redshift_database_name str
    The name of the Redshift database.
    allowFullTableExternalDataAccess "True" | "False"
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogType String
    Specifies a federated catalog type for the native catalog resource.
    dataLakeAccess Boolean
    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.
    dataTransferRole String
    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
    kmsKey String
    An encryption key that will be used for the staging bucket that will be created along with the catalog.
    managedWorkgroupName String
    The name of the managed workgroup associated with the catalog.
    managedWorkgroupStatus String
    The status of the managed workgroup.
    redshiftDatabaseName String
    The name of the Redshift database.

    CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccess, CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccessArgs

    True
    True
    False
    False
    CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccessTrue
    True
    CatalogDataLakeAccessPropertiesAllowFullTableExternalDataAccessFalse
    False
    True
    True
    False
    False
    True
    True
    False
    False
    TRUE
    True
    FALSE
    False
    "True"
    True
    "False"
    False

    CatalogDataLakePrincipal, CatalogDataLakePrincipalArgs

    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.
    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.

    CatalogFederatedCatalog, CatalogFederatedCatalogArgs

    A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
    ConnectionName string
    The name of the connection to an external data source.
    Identifier string
    A unique identifier for the federated catalog.
    ConnectionName string
    The name of the connection to an external data source.
    Identifier string
    A unique identifier for the federated catalog.
    connectionName String
    The name of the connection to an external data source.
    identifier String
    A unique identifier for the federated catalog.
    connectionName string
    The name of the connection to an external data source.
    identifier string
    A unique identifier for the federated catalog.
    connection_name str
    The name of the connection to an external data source.
    identifier str
    A unique identifier for the federated catalog.
    connectionName String
    The name of the connection to an external data source.
    identifier String
    A unique identifier for the federated catalog.

    CatalogOverwriteChildResourcePermissionsWithDefault, CatalogOverwriteChildResourcePermissionsWithDefaultArgs

    Accept
    Accept
    Deny
    Deny
    CatalogOverwriteChildResourcePermissionsWithDefaultAccept
    Accept
    CatalogOverwriteChildResourcePermissionsWithDefaultDeny
    Deny
    Accept
    Accept
    Deny
    Deny
    Accept
    Accept
    Deny
    Deny
    ACCEPT
    Accept
    DENY
    Deny
    "Accept"
    Accept
    "Deny"
    Deny

    CatalogPrincipalPermissions, CatalogPrincipalPermissionsArgs

    Permissions granted to a principal.

    CatalogPrincipalPermissionsPermissionsItem, CatalogPrincipalPermissionsPermissionsItemArgs

    All
    ALL
    Select
    SELECT
    Alter
    ALTER
    Drop
    DROP
    Delete
    DELETE
    Insert
    INSERT
    CreateDatabase
    CREATE_DATABASE
    CreateTable
    CREATE_TABLE
    DataLocationAccess
    DATA_LOCATION_ACCESS
    CatalogPrincipalPermissionsPermissionsItemAll
    ALL
    CatalogPrincipalPermissionsPermissionsItemSelect
    SELECT
    CatalogPrincipalPermissionsPermissionsItemAlter
    ALTER
    CatalogPrincipalPermissionsPermissionsItemDrop
    DROP
    CatalogPrincipalPermissionsPermissionsItemDelete
    DELETE
    CatalogPrincipalPermissionsPermissionsItemInsert
    INSERT
    CatalogPrincipalPermissionsPermissionsItemCreateDatabase
    CREATE_DATABASE
    CatalogPrincipalPermissionsPermissionsItemCreateTable
    CREATE_TABLE
    CatalogPrincipalPermissionsPermissionsItemDataLocationAccess
    DATA_LOCATION_ACCESS
    All
    ALL
    Select
    SELECT
    Alter
    ALTER
    Drop
    DROP
    Delete
    DELETE
    Insert
    INSERT
    CreateDatabase
    CREATE_DATABASE
    CreateTable
    CREATE_TABLE
    DataLocationAccess
    DATA_LOCATION_ACCESS
    All
    ALL
    Select
    SELECT
    Alter
    ALTER
    Drop
    DROP
    Delete
    DELETE
    Insert
    INSERT
    CreateDatabase
    CREATE_DATABASE
    CreateTable
    CREATE_TABLE
    DataLocationAccess
    DATA_LOCATION_ACCESS
    ALL
    ALL
    SELECT
    SELECT
    ALTER
    ALTER
    DROP
    DROP
    DELETE
    DELETE
    INSERT
    INSERT
    CREATE_DATABASE
    CREATE_DATABASE
    CREATE_TABLE
    CREATE_TABLE
    DATA_LOCATION_ACCESS
    DATA_LOCATION_ACCESS
    "ALL"
    ALL
    "SELECT"
    SELECT
    "ALTER"
    ALTER
    "DROP"
    DROP
    "DELETE"
    DELETE
    "INSERT"
    INSERT
    "CREATE_DATABASE"
    CREATE_DATABASE
    "CREATE_TABLE"
    CREATE_TABLE
    "DATA_LOCATION_ACCESS"
    DATA_LOCATION_ACCESS

    CatalogProperties, CatalogPropertiesArgs

    A structure that specifies data lake access properties and other custom properties.
    CustomProperties Dictionary<string, string>
    Additional key-value properties for the catalog.
    DataLakeAccessProperties Pulumi.AwsNative.Glue.Inputs.CatalogDataLakeAccessProperties
    CustomProperties map[string]string
    Additional key-value properties for the catalog.
    DataLakeAccessProperties CatalogDataLakeAccessProperties
    customProperties Map<String,String>
    Additional key-value properties for the catalog.
    dataLakeAccessProperties CatalogDataLakeAccessProperties
    customProperties {[key: string]: string}
    Additional key-value properties for the catalog.
    dataLakeAccessProperties CatalogDataLakeAccessProperties
    custom_properties Mapping[str, str]
    Additional key-value properties for the catalog.
    data_lake_access_properties CatalogDataLakeAccessProperties
    customProperties Map<String>
    Additional key-value properties for the catalog.
    dataLakeAccessProperties Property Map

    CatalogTargetRedshiftCatalog, CatalogTargetRedshiftCatalogArgs

    A structure that describes a target catalog for resource linking.
    CatalogArn string
    The Amazon Resource Name (ARN) of the catalog resource.
    CatalogArn string
    The Amazon Resource Name (ARN) of the catalog resource.
    catalogArn String
    The Amazon Resource Name (ARN) of the catalog resource.
    catalogArn string
    The Amazon Resource Name (ARN) of the catalog resource.
    catalog_arn str
    The Amazon Resource Name (ARN) of the catalog resource.
    catalogArn String
    The Amazon Resource Name (ARN) of the catalog resource.

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.58.0
    published on Monday, Mar 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.