1.204.0

interface CfnDataCatalogProps

LanguageType name
.NETAmazon.CDK.AWS.Athena.CfnDataCatalogProps
Javasoftware.amazon.awscdk.services.athena.CfnDataCatalogProps
Pythonaws_cdk.aws_athena.CfnDataCatalogProps
TypeScript @aws-cdk/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 * as athena from '@aws-cdk/aws-athena';
const cfnDataCatalogProps: athena.CfnDataCatalogProps = {
  name: 'name',
  type: 'type',

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

Properties

NameTypeDescription
namestringThe name of the data catalog.
typestringThe type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
description?stringA description of the data catalog.
parameters?{ [string]: string } | IResolvableSpecifies the Lambda function or functions to use for 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.

description?

Type: string (optional)

A description of the data catalog.

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.
  • 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?

Type: CfnTag[] (optional)

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

← PreviousNext →