CfnCatalogProps

class aws_cdk.aws_glue.CfnCatalogProps(*, name, allow_full_table_external_data_access=None, catalog_properties=None, create_database_default_permissions=None, create_table_default_permissions=None, description=None, federated_catalog=None, overwrite_child_resource_permissions_with_default=None, parameters=None, tags=None, target_redshift_catalog=None)

Bases: object

Properties for defining a CfnCatalog.

Parameters:

name (str) – The name of the catalog to create.
allow_full_table_external_data_access (Optional[str]) – Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
catalog_properties (Union[IResolvable, CatalogPropertiesProperty, Dict[str, Any], None]) – A structure that specifies data lake access properties and other custom properties.
create_database_default_permissions (Union[IResolvable, Sequence[Union[IResolvable, PrincipalPermissionsProperty, Dict[str, Any]]], None]) – An array of PrincipalPermissions objects for default database permissions.
create_table_default_permissions (Union[IResolvable, Sequence[Union[IResolvable, PrincipalPermissionsProperty, Dict[str, Any]]], None]) – An array of PrincipalPermissions objects for default table permissions.
description (Optional[str]) – A description of the catalog.
federated_catalog (Union[IResolvable, FederatedCatalogProperty, Dict[str, Any], None]) – A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
overwrite_child_resource_permissions_with_default (Optional[str]) – Specifies whether to overwrite child resource permissions with the default permissions.
parameters (Union[Mapping[str, str], IResolvable, None]) – A map of key-value pairs that define parameters and properties of the catalog.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.
target_redshift_catalog (Union[IResolvable, TargetRedshiftCatalogProperty, Dict[str, Any], None]) – A structure that describes a target catalog for resource linking.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

cfn_catalog_props = glue.CfnCatalogProps(
    name="name",

    # the properties below are optional
    allow_full_table_external_data_access="allowFullTableExternalDataAccess",
    catalog_properties=glue.CfnCatalog.CatalogPropertiesProperty(
        custom_properties={
            "custom_properties_key": "customProperties"
        },
        data_lake_access_properties=glue.CfnCatalog.DataLakeAccessPropertiesProperty(
            allow_full_table_external_data_access="allowFullTableExternalDataAccess",
            catalog_type="catalogType",
            data_lake_access=False,
            data_transfer_role="dataTransferRole",
            kms_key="kmsKey",
            managed_workgroup_name="managedWorkgroupName",
            managed_workgroup_status="managedWorkgroupStatus",
            redshift_database_name="redshiftDatabaseName"
        )
    ),
    create_database_default_permissions=[glue.CfnCatalog.PrincipalPermissionsProperty(
        permissions=["permissions"],
        principal=glue.CfnCatalog.DataLakePrincipalProperty(
            data_lake_principal_identifier="dataLakePrincipalIdentifier"
        )
    )],
    create_table_default_permissions=[glue.CfnCatalog.PrincipalPermissionsProperty(
        permissions=["permissions"],
        principal=glue.CfnCatalog.DataLakePrincipalProperty(
            data_lake_principal_identifier="dataLakePrincipalIdentifier"
        )
    )],
    description="description",
    federated_catalog=glue.CfnCatalog.FederatedCatalogProperty(
        connection_name="connectionName",
        identifier="identifier"
    ),
    overwrite_child_resource_permissions_with_default="overwriteChildResourcePermissionsWithDefault",
    parameters={
        "parameters_key": "parameters"
    },
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_redshift_catalog=glue.CfnCatalog.TargetRedshiftCatalogProperty(
        catalog_arn="catalogArn"
    )
)