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

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

Overview

Note:

When making an API call, you may pass CreateDataCatalogInput data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the data catalog to be created.

Returns:

  • (String)


256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 256

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

#nameString

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

Returns:

  • (String)


256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 256

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

#parametersHash<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 takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data 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.

Returns:

  • (Hash<String,String>)


256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 256

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

#tagsArray<Types::Tag>

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

Returns:



256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 256

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

#typeString

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

Returns:

  • (String)


256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 256

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