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

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

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.

    Using getCatalog

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCatalog(args: GetCatalogArgs, opts?: InvokeOptions): Promise<GetCatalogResult>
function getCatalogOutput(args: GetCatalogOutputArgs, opts?: InvokeOptions): Output<GetCatalogResult>
    def get_catalog(resource_arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCatalogResult
def get_catalog_output(resource_arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCatalogResult]
    func LookupCatalog(ctx *Context, args *LookupCatalogArgs, opts ...InvokeOption) (*LookupCatalogResult, error)
func LookupCatalogOutput(ctx *Context, args *LookupCatalogOutputArgs, opts ...InvokeOption) LookupCatalogResultOutput

    > Note: This function is named LookupCatalog in the Go SDK.

    public static class GetCatalog 
{
    public static Task<GetCatalogResult> InvokeAsync(GetCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogResult> Invoke(GetCatalogInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)
public static Output<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:glue:getCatalog
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    ResourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    resourceArn String
    The Amazon Resource Name (ARN) of the catalog.
    resourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    resource_arn str
    The Amazon Resource Name (ARN) of the catalog.
    resourceArn String
    The Amazon Resource Name (ARN) of the catalog.

    getCatalog Result

    The following output properties are available:

    AllowFullTableExternalDataAccess Pulumi.AwsNative.Glue.CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    CatalogId string
    The ID of the catalog.
    CatalogProperties Pulumi.AwsNative.Glue.Outputs.CatalogProperties
    CreateDatabaseDefaultPermissions List<Pulumi.AwsNative.Glue.Outputs.CatalogPrincipalPermissions>
    An array of PrincipalPermissions objects for default database permissions.
    CreateTableDefaultPermissions List<Pulumi.AwsNative.Glue.Outputs.CatalogPrincipalPermissions>
    An array of PrincipalPermissions objects for default table permissions.
    CreateTime int
    The time at which the catalog was created.
    Description string
    A description of the catalog.
    FederatedCatalog Pulumi.AwsNative.Glue.Outputs.CatalogFederatedCatalog
    Parameters Dictionary<string, string>
    A map of key-value pairs that define parameters and properties of the catalog.
    ResourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    TargetRedshiftCatalog Pulumi.AwsNative.Glue.Outputs.CatalogTargetRedshiftCatalog
    UpdateTime int
    The time at which the catalog was last updated.
    AllowFullTableExternalDataAccess CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    CatalogId string
    The ID of the catalog.
    CatalogProperties CatalogProperties
    CreateDatabaseDefaultPermissions []CatalogPrincipalPermissions
    An array of PrincipalPermissions objects for default database permissions.
    CreateTableDefaultPermissions []CatalogPrincipalPermissions
    An array of PrincipalPermissions objects for default table permissions.
    CreateTime int
    The time at which the catalog was created.
    Description string
    A description of the catalog.
    FederatedCatalog CatalogFederatedCatalog
    Parameters map[string]string
    A map of key-value pairs that define parameters and properties of the catalog.
    ResourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    TargetRedshiftCatalog CatalogTargetRedshiftCatalog
    UpdateTime int
    The time at which the catalog was last updated.
    allowFullTableExternalDataAccess CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogId String
    The ID of the catalog.
    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.
    createTime Integer
    The time at which the catalog was created.
    description String
    A description of the catalog.
    federatedCatalog CatalogFederatedCatalog
    parameters Map<String,String>
    A map of key-value pairs that define parameters and properties of the catalog.
    resourceArn String
    The Amazon Resource Name (ARN) of the catalog.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    targetRedshiftCatalog CatalogTargetRedshiftCatalog
    updateTime Integer
    The time at which the catalog was last updated.
    allowFullTableExternalDataAccess CatalogAllowFullTableExternalDataAccess
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogId string
    The ID of the catalog.
    catalogProperties CatalogProperties
    createDatabaseDefaultPermissions CatalogPrincipalPermissions[]
    An array of PrincipalPermissions objects for default database permissions.
    createTableDefaultPermissions CatalogPrincipalPermissions[]
    An array of PrincipalPermissions objects for default table permissions.
    createTime number
    The time at which the catalog was created.
    description string
    A description of the catalog.
    federatedCatalog CatalogFederatedCatalog
    parameters {[key: string]: string}
    A map of key-value pairs that define parameters and properties of the catalog.
    resourceArn string
    The Amazon Resource Name (ARN) of the catalog.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    targetRedshiftCatalog CatalogTargetRedshiftCatalog
    updateTime number
    The time at which the catalog was last updated.
    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_id str
    The ID of the catalog.
    catalog_properties CatalogProperties
    create_database_default_permissions Sequence[CatalogPrincipalPermissions]
    An array of PrincipalPermissions objects for default database permissions.
    create_table_default_permissions Sequence[CatalogPrincipalPermissions]
    An array of PrincipalPermissions objects for default table permissions.
    create_time int
    The time at which the catalog was created.
    description str
    A description of the catalog.
    federated_catalog CatalogFederatedCatalog
    parameters Mapping[str, str]
    A map of key-value pairs that define parameters and properties of the catalog.
    resource_arn str
    The Amazon Resource Name (ARN) of the catalog.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    target_redshift_catalog CatalogTargetRedshiftCatalog
    update_time int
    The time at which the catalog was last updated.
    allowFullTableExternalDataAccess "True" | "False"
    Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
    catalogId String
    The ID of the catalog.
    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.
    createTime Number
    The time at which the catalog was created.
    description String
    A description of the catalog.
    federatedCatalog Property Map
    parameters Map<String>
    A map of key-value pairs that define parameters and properties of the catalog.
    resourceArn String
    The Amazon Resource Name (ARN) of the catalog.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    targetRedshiftCatalog Property Map
    updateTime Number
    The time at which the catalog was last updated.

    Supporting Types

    CatalogAllowFullTableExternalDataAccess

    CatalogDataLakeAccessProperties

    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

    CatalogDataLakePrincipal

    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

    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.

    CatalogPrincipalPermissions

    CatalogPrincipalPermissionsPermissionsItem

    CatalogProperties

    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

    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

    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.