Skip to content

Catalog

Source code in docs_src/capo_glue/types/catalog.py
class Catalog(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the catalog. To grant access to the default catalog, this field should not be provided.</p>"""
    name: "capo_glue.types.catalog_name_string.CatalogNameString"
    """<p>The name of the catalog. Cannot be the same as the account ID.</p>"""
    resource_arn: NotRequired["capo_glue.types.resource_arn_string.ResourceArnString"]
    """<p>The Amazon Resource Name (ARN) assigned to the catalog resource.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.</p>"""
    parameters: NotRequired["capo_glue.types.parameters_map.ParametersMap"]
    """<p> A map array of key-value pairs that define parameters and properties of the catalog.</p>"""
    create_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The time at which the catalog was created.</p>"""
    update_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The time at which the catalog was last updated.</p>"""
    target_redshift_catalog: NotRequired[
        "capo_glue.types.target_redshift_catalog.TargetRedshiftCatalog"
    ]
    """<p>A <code>TargetRedshiftCatalog</code> object that describes a target catalog for database resource linking.</p>"""
    federated_catalog: NotRequired["capo_glue.types.federated_catalog.FederatedCatalog"]
    """<p>A <code>FederatedCatalog</code> object that points to an entity outside the Glue Data Catalog.</p>"""
    catalog_properties: NotRequired[
        "capo_glue.types.catalog_properties_output.CatalogPropertiesOutput"
    ]
    """<p>A <code>CatalogProperties</code> object that specifies data lake access properties and other custom properties.</p>"""
    create_table_default_permissions: NotRequired[
        "capo_glue.types.principal_permissions_list.PrincipalPermissionsList"
    ]
    """<p>An array of <code>PrincipalPermissions</code> objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.</p>"""
    create_database_default_permissions: NotRequired[
        "capo_glue.types.principal_permissions_list.PrincipalPermissionsList"
    ]
    """<p>An array of <code>PrincipalPermissions</code> objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.</p>"""
    allow_full_table_external_data_access: NotRequired[
        "capo_glue.types.allow_full_table_external_data_access_enum.AllowFullTableExternalDataAccessEnum"
    ]
    """<p> Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation. </p>"""

allow_full_table_external_data_access instance-attribute

allow_full_table_external_data_access: NotRequired[AllowFullTableExternalDataAccessEnum]

Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

The ID of the catalog. To grant access to the default catalog, this field should not be provided.

catalog_properties instance-attribute

catalog_properties: NotRequired[CatalogPropertiesOutput]

A CatalogProperties object that specifies data lake access properties and other custom properties.

create_database_default_permissions instance-attribute

create_database_default_permissions: NotRequired[PrincipalPermissionsList]

An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

create_table_default_permissions instance-attribute

create_table_default_permissions: NotRequired[PrincipalPermissionsList]

An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

create_time instance-attribute

create_time: NotRequired[Timestamp]

The time at which the catalog was created.

description instance-attribute

description: NotRequired[DescriptionString]

Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

federated_catalog instance-attribute

federated_catalog: NotRequired[FederatedCatalog]

A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

name instance-attribute

The name of the catalog. Cannot be the same as the account ID.

parameters instance-attribute

parameters: NotRequired[ParametersMap]

A map array of key-value pairs that define parameters and properties of the catalog.

resource_arn instance-attribute

resource_arn: NotRequired[ResourceArnString]

The Amazon Resource Name (ARN) assigned to the catalog resource.

target_redshift_catalog instance-attribute

target_redshift_catalog: NotRequired[TargetRedshiftCatalog]

A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

update_time instance-attribute

update_time: NotRequired[Timestamp]

The time at which the catalog was last updated.