AWS::Athena::DataCatalog - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Athena::DataCatalog

AWS::Athena::DataCatalog 资源指定 Amazon Athena 数据目录,其中包含名称、描述、类型、参数和标签。有关更多信息,请参阅 Amazon Athena API 参数 中的 DataCatalog

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::Athena::DataCatalog", "Properties" : { "Description" : String, "Name" : String, "Parameters" : {Key : Value, ...}, "Tags" : Tags, "Type" : String } }

YAML

Type: AWS::Athena::DataCatalog Properties: Description: String Name: String Parameters: Key : Value Tags: Tags Type: String

属性

Description

数据目录的说明。

必需:否

类型:字符串

Update requires: No interruption

Name

数据目录的名称。目录名称对于 AWS 账户必须是唯一的,最多可以使用 128 个字母数字、下划线、符号或连字符。

必需:是

类型:字符串

Update requires: No interruption

Parameters

指定要用于数据目录的一个或多个 Lambda 函数。使用的映射取决于目录类型。

  • HIVE 数据目录类型使用以下语法。metadata-function 参数是必需的。The sdk-version 参数是可选的,默认为当前支持的版本。

    metadata-function=lambda_arn, sdk-version=version_number

  • LAMBDA 数据目录类型使用以下所需参数集之一,但不能同时使用这两个参数集。

    • 当一个 Lambda 函数处理元数据而另一个 Lambda 函数读取数据时,将使用以下语法。两个参数都是必需的。

      metadata-function=lambda_arn, record-function=lambda_arn

    • 同时处理元数据和数据的复合 Lambda 函数使用以下语法。

      function=lambda_arn

  • GLUE 类型没有参数。

必需:否

类型:字符串的映射

Update requires: No interruption

Tags

作为数据目录的自定义属性的逗号分隔标签(键值对)的可选列表。

必需:否

类型: 标签

Update requires: No interruption

Type

数据目录的类型:LAMBDA(对于联合目录)、GLUE(对于 AWS Glue 目录)或 HIVE(对于外部配置单元元存储)。

必需:是

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回数据目录的名称。

For more information about using the Ref function, see Ref.

示例

创建 Athena 数据目录

以下示例模板在 Athena 中创建自定义 Hive 数据目录。

JSON

{ "Resources":{ "MyAthenaDataCatalog":{ "Type":"AWS::Athena::DataCatalog", "Properties":{ "Name":"MyCustomDataCatalog", "Type":"HIVE", "Description":"Custom Hive Catalog Description", "Tags":[ { "Key":"key1", "Value":"value1" }, { "Key":"key2", "Value":"value2" } ], "Parameters":{ "metadata-function":"arn:aws:lambda:us-west-2:111122223333:function:lambdaname" } } } } }

YAML

Resources: MyAthenaDataCatalog: Type: AWS::Athena::DataCatalog Properties: Name: MyCustomDataCatalog Type: HIVE Description: Custom Hive Catalog Description Tags: - Key: "key1" Value: "value1" - Key: "key2" Value: "value2" Parameters: metadata-function: "arn:aws:lambda:us-west-2:111122223333:function:lambdaname"