interface CfnDataCatalogProps

Language	Type name
.NET	`Amazon.CDK.AWS.Athena.CfnDataCatalogProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsathena#CfnDataCatalogProps`
Java	`software.amazon.awscdk.services.athena.CfnDataCatalogProps`
Python	`aws_cdk.aws_athena.CfnDataCatalogProps`
TypeScript	`aws-cdk-lib` » `aws_athena` » `CfnDataCatalogProps`

Properties for defining a CfnDataCatalog.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_athena as athena } from 'aws-cdk-lib';
const cfnDataCatalogProps: athena.CfnDataCatalogProps = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  connectionType: 'connectionType',
  description: 'description',
  error: 'error',
  parameters: {
    parametersKey: 'parameters',
  },
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the data catalog.
type	`string`	The type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
connectionType?	`string`	The type of connection for a `FEDERATED` data catalog (for example, `REDSHIFT` , `MYSQL` , or `SQLSERVER` ).
description?	`string`	A description of the data catalog.
error?	`string`	Text of the error that occurred during data catalog creation or deletion.
parameters?	`{ [string]: string } \|` `IResolvable`	Specifies the Lambda function or functions to use for the data catalog.
status?	`string`	The status of the creation or deletion of the data catalog.
tags?	`CfnTag[]`	The tags (key-value pairs) to associate with this resource.

name

Type: string

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

Type: string

The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.

connectionType?

Type: string (optional)

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?

Type: string (optional)

A description of the data catalog.

error?

Type: string (optional)

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

parameters?

Type: { [string]: string } | IResolvable (optional)

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.

status?

Type: string (optional)

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?

Type: CfnTag[] (optional)

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