Skip to content

CatalogInput

Source code in docs_src/capo_glue/types/catalog_input.py
class CatalogInput(TypedDict, closed=True):
    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>"""
    federated_catalog: NotRequired["capo_glue.types.federated_catalog.FederatedCatalog"]
    """<p>A <code>FederatedCatalog</code> object. A <code>FederatedCatalog</code> structure that references an entity outside the Glue Data Catalog, for example a Redshift database.</p>"""
    parameters: NotRequired["capo_glue.types.parameters_map.ParametersMap"]
    """<p>A map array of key-value pairs that define the parameters and properties of the catalog.</p>"""
    target_redshift_catalog: NotRequired[
        "capo_glue.types.target_redshift_catalog.TargetRedshiftCatalog"
    ]
    """<p>A <code>TargetRedshiftCatalog</code> object that describes a target catalog for resource linking.</p>"""
    catalog_properties: NotRequired[
        "capo_glue.types.catalog_properties.CatalogProperties"
    ]
    """<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. Typically should be explicitly set as an empty list.</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. Typically should be explicitly set as an empty list.</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>"""
    overwrite_child_resource_permissions_with_default: NotRequired[
        "capo_glue.types.overwrite_child_resource_permissions_with_default_enum.OverwriteChildResourcePermissionsWithDefaultEnum"
    ]
    """<p> Overwrites existing Amazon Web Services Lake Formation permissions with <code>CatalogInput$CreateTableDefaultPermissions</code> and <code>CatalogInput$CreateDatabaseDefaultPermissions</code> for all child resources. </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_properties instance-attribute

catalog_properties: NotRequired[CatalogProperties]

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. Typically should be explicitly set as an empty list.

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. Typically should be explicitly set as an empty list.

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. A FederatedCatalog structure that references an entity outside the Glue Data Catalog, for example a Redshift database.

overwrite_child_resource_permissions_with_default instance-attribute

overwrite_child_resource_permissions_with_default: NotRequired[
    OverwriteChildResourcePermissionsWithDefaultEnum
]

Overwrites existing Amazon Web Services Lake Formation permissions with CatalogInput$CreateTableDefaultPermissions and CatalogInput$CreateDatabaseDefaultPermissions for all child resources.

parameters instance-attribute

parameters: NotRequired[ParametersMap]

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

target_redshift_catalog instance-attribute

target_redshift_catalog: NotRequired[TargetRedshiftCatalog]

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