/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Athena { namespace Model { /** *

Contains information about a data catalog in an Amazon Web Services * account.

In the Athena console, data catalogs are listed as "data * sources" on the Data sources page under the Data source name * column.

See Also:

AWS * API Reference

*/ class DataCatalog { public: AWS_ATHENA_API DataCatalog(); AWS_ATHENA_API DataCatalog(Aws::Utils::Json::JsonView jsonValue); AWS_ATHENA_API DataCatalog& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_ATHENA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the data catalog. 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.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the data catalog. 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.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the data catalog. 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.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the data catalog. 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.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the data catalog. 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.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the data catalog. 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.

*/ inline DataCatalog& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the data catalog. 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.

*/ inline DataCatalog& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the data catalog. 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.

*/ inline DataCatalog& WithName(const char* value) { SetName(value); return *this;} /** *

An optional description of the data catalog.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

An optional description of the data catalog.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

An optional description of the data catalog.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

An optional description of the data catalog.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

An optional description of the data catalog.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

An optional description of the data catalog.

*/ inline DataCatalog& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

An optional description of the data catalog.

*/ inline DataCatalog& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

An optional description of the data catalog.

*/ inline DataCatalog& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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.

*/ inline const DataCatalogType& GetType() const{ return m_type; } /** *

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.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

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.

*/ inline void SetType(const DataCatalogType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

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.

*/ inline void SetType(DataCatalogType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

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.

*/ inline DataCatalog& WithType(const DataCatalogType& value) { SetType(value); return *this;} /** *

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.

*/ inline DataCatalog& WithType(DataCatalogType&& value) { SetType(std::move(value)); return *this;} /** *

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

    • *
  • 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 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.

*/ inline const Aws::Map& GetParameters() const{ return m_parameters; } /** *

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

    • *
  • 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 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.

*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *

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

    • *
  • 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 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.

*/ inline void SetParameters(const Aws::Map& value) { m_parametersHasBeenSet = true; m_parameters = value; } /** *

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

    • *
  • 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 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.

*/ inline void SetParameters(Aws::Map&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& WithParameters(const Aws::Map& value) { SetParameters(value); return *this;} /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& WithParameters(Aws::Map&& value) { SetParameters(std::move(value)); return *this;} /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(const Aws::String& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(Aws::String&& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(const Aws::String& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(Aws::String&& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(const char* key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(Aws::String&& key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

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

    • *
  • 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 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.

*/ inline DataCatalog& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; DataCatalogType m_type; bool m_typeHasBeenSet = false; Aws::Map m_parameters; bool m_parametersHasBeenSet = false; }; } // namespace Model } // namespace Athena } // namespace Aws