Class: Aws::Athena::Types::DataCatalog

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-athena/types.rb

Overview

Contains information about a data catalog in an AWS account.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

An optional description of the data catalog.

Returns:

  • (String)

491
492
493
494
495
496
497
498
# File 'lib/aws-sdk-athena/types.rb', line 491

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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.

Returns:

  • (String)

491
492
493
494
495
496
497
498
# File 'lib/aws-sdk-athena/types.rb', line 491

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,String>

Specifies the Lambda function or functions to use for 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 `

Returns:

  • (Hash<String,String>)

491
492
493
494
495
496
497
498
# File 'lib/aws-sdk-athena/types.rb', line 491

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of data catalog: `LAMBDA` for a federated catalog or `HIVE` for an external hive metastore. `GLUE` refers to the `AwsDataCatalog` that already exists in your account, of which you can have only one.

Returns:

  • (String)

491
492
493
494
495
496
497
498
# File 'lib/aws-sdk-athena/types.rb', line 491

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end