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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the data catalog to be created.

Returns:

  • (String) 


659
660
661
662
663
664
665
666
667
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 659

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

#name ⇒ String

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 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

Returns:

  • (String) 


659
660
661
662
663
664
665
666
667
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 659

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

#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 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.

    ^

Returns:

  • (Hash<String,String>) 


659
660
661
662
663
664
665
666
667
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 659

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

#tags ⇒ Array<Types::Tag>

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

Returns:



659
660
661
662
663
664
665
666
667
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 659

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

#type ⇒ String

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) 


659
660
661
662
663
664
665
666
667
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 659

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