CfnDataCatalogProps

class aws_cdk.aws_athena.CfnDataCatalogProps(*, name, type, description=None, parameters=None, tags=None)

Bases: object

Properties for defining a CfnDataCatalog.

Parameters:

name (str) – The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
type (str) – The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
description (Optional[str]) – A description of the data catalog.
parameters (Union[Mapping[str, str], IResolvable, None]) – Specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type. - The HIVE data catalog type uses the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version. metadata-function= *lambda_arn* , sdk-version= *version_number* - The LAMBDA data catalog type uses one of the following sets of required parameters, but not both. - When one Lambda function processes metadata and another Lambda function reads data, the following syntax is used. Both parameters are required. metadata-function= *lambda_arn* , record-function= *lambda_arn* - A composite Lambda function that processes both metadata and data uses the following syntax. function= *lambda_arn* - The GLUE type takes a catalog ID parameter and is required. The *catalog_id* is the account ID of the AWS account to which the Glue catalog belongs. catalog-id= *catalog_id* - The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a GLUE data catalog other than the default AwsDataCatalog must be run on Athena engine version 2. - In Regions where Athena engine version 2 is not available, creating new GLUE data catalogs results in an INVALID_INPUT error.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags (key-value pairs) to associate with this resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_athena as athena

cfn_data_catalog_props = athena.CfnDataCatalogProps(
    name="name",
    type="type",

    # the properties below are optional
    description="description",
    parameters={
        "parameters_key": "parameters"
    },
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the data catalog.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-description

name

The name of the data catalog.

The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-name

parameters

Specifies the Lambda function or functions to use for the data catalog.

The mapping used depends on the catalog type.

The HIVE data catalog type uses the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

metadata-function= *lambda_arn* , sdk-version= *version_number*

The LAMBDA data catalog type uses one of the following sets of required parameters, but not both.
When one Lambda function processes metadata and another Lambda function reads data, the following syntax is used. Both parameters are required.

metadata-function= *lambda_arn* , record-function= *lambda_arn*

A composite Lambda function that processes both metadata and data uses the following syntax.

function= *lambda_arn*

The GLUE type takes a catalog ID parameter and is required. The *catalog_id* is the account ID of the AWS account to which the Glue catalog belongs.

catalog-id= *catalog_id*

The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.
Queries that specify a GLUE data catalog other than the default AwsDataCatalog must be run on Athena engine version 2.
In Regions where Athena engine version 2 is not available, creating new GLUE data catalogs results in an INVALID_INPUT error.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-parameters

tags

The tags (key-value pairs) to associate with this resource.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-tags

type

LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-type
Type:: The type of data catalog