You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Athena::Types::CreateDataCatalogInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDataCatalogInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "CatalogNameString", # required
  type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE
  description: "DescriptionString",
  parameters: {
    "KeyString" => "ParametersMapValue",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the data catalog to be created.

Returns:

  • (String) —

    A description of the data catalog to be created.

#name ⇒ String

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

Returns:

  • (String) —

    The name of the data catalog to create.

#parameters ⇒ Hash<String,String>

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 has no parameters.

Returns:

  • (Hash<String,String>) —

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

#tags ⇒ Array<Types::Tag>

A list of comma separated tags to add to the data catalog that is created.

Returns:

  • (Array<Types::Tag>) —

    A list of comma separated tags to add to the data catalog that is created.

#type ⇒ String

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

Possible values:

  • LAMBDA
  • GLUE
  • HIVE

Returns:

  • (String) —

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