CfnDataCatalogProps

class aws_cdk.aws_athena.CfnDataCatalogProps(*, name, type, connection_type=None, description=None, error=None, parameters=None, status=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.
connection_type (Optional[str]) – The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ). For information about individual connectors, see Available data source connectors .
description (Optional[str]) – A description of the data catalog.
error (Optional[str]) – Text of the error that occurred during data catalog creation or deletion.
parameters (Union[Mapping[str, str], IResolvable, None]) – Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. - For the HIVE data catalog type, use 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* - For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both. - If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required. metadata-function= *lambda_arn* , record-function= *lambda_arn* - If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function. 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 AWS Glue Data 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. - The FEDERATED data catalog type uses one of the following parameters, but not both. Use connection-arn for an existing AWS Glue connection. Use connection-type and connection-properties to specify the configuration setting for a new connection. - connection-arn: *<glue_connection_arn_to_reuse>* - lambda-role-arn (optional): The execution role to use for the Lambda function. If not provided, one is created. - connection-type:MYSQL|REDSHIFT|...., connection-properties:" *<json_string>* " For ``<json_string>`` , use escaped JSON text, as in the following example. "{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"}"
status (Optional[str]) – The status of the creation or deletion of the data catalog. - The LAMBDA , GLUE , and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED . - The FEDERATED data catalog type is created asynchronously. Data catalog creation status: - CREATE_IN_PROGRESS : Federated data catalog creation in progress. - CREATE_COMPLETE : Data catalog creation complete. - CREATE_FAILED : Data catalog could not be created. - CREATE_FAILED_CLEANUP_IN_PROGRESS : Federated data catalog creation failed and is being removed. - CREATE_FAILED_CLEANUP_COMPLETE : Federated data catalog creation failed and was removed. - CREATE_FAILED_CLEANUP_FAILED : Federated data catalog creation failed but could not be removed. Data catalog deletion status: - DELETE_IN_PROGRESS : Federated data catalog deletion in progress. - DELETE_COMPLETE : Federated data catalog deleted. - DELETE_FAILED : Federated data catalog could not be deleted.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags (key-value pairs) to associate with this resource.

See:

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.
from aws_cdk import aws_athena as athena

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

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

Attributes

connection_type

The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ).

For information about individual connectors, see Available data source connectors .

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

description

A description of the data catalog.

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

error

Text of the error that occurred during data catalog creation or deletion.

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

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.

See:: 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 creating the data catalog.

This is a mapping whose values depend on the catalog type.

For the HIVE data catalog type, use 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*

For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

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

If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

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 AWS Glue Data 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.
The FEDERATED data catalog type uses one of the following parameters, but not both. Use connection-arn for an existing AWS Glue connection. Use connection-type and connection-properties to specify the configuration setting for a new connection.
connection-arn: *<glue_connection_arn_to_reuse>*
lambda-role-arn (optional): The execution role to use for the Lambda function. If not provided, one is created.
connection-type:MYSQL|REDSHIFT|...., connection-properties:" *<json_string>* "

For ``<json_string>`` , use escaped JSON text, as in the following example.

"{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"}"

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

status

The status of the creation or deletion of the data catalog.

The LAMBDA , GLUE , and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED .
The FEDERATED data catalog type is created asynchronously.

Data catalog creation status:

CREATE_IN_PROGRESS : Federated data catalog creation in progress.
CREATE_COMPLETE : Data catalog creation complete.
CREATE_FAILED : Data catalog could not be created.
CREATE_FAILED_CLEANUP_IN_PROGRESS : Federated data catalog creation failed and is being removed.
CREATE_FAILED_CLEANUP_COMPLETE : Federated data catalog creation failed and was removed.
CREATE_FAILED_CLEANUP_FAILED : Federated data catalog creation failed but could not be removed.

Data catalog deletion status:

DELETE_IN_PROGRESS : Federated data catalog deletion in progress.
DELETE_COMPLETE : Federated data catalog deleted.
DELETE_FAILED : Federated data catalog could not be deleted.

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

tags

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

See:: 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.

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