software.amazon.awssdk.services.athena.model

Interface CreateDataCatalogRequest.Builder

All Superinterfaces:

AthenaRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataCatalogRequest.Builder,CreateDataCatalogRequest>, SdkBuilder<CreateDataCatalogRequest.Builder,CreateDataCatalogRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDataCatalogRequest

public static interface CreateDataCatalogRequest.Builder
extends AthenaRequest.Builder, SdkPojo, CopyableBuilder<CreateDataCatalogRequest.Builder,CreateDataCatalogRequest>

Method Summary

Modifier and Type	Method and Description
CreateDataCatalogRequest.Builder	description(String description) A description of the data catalog to be created.
CreateDataCatalogRequest.Builder	name(String name) The name of the data catalog to create.
CreateDataCatalogRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDataCatalogRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateDataCatalogRequest.Builder	parameters(Map<String,String> parameters) Specifies the Lambda function or functions to use for creating the data catalog.
CreateDataCatalogRequest.Builder	tags(Collection<Tag> tags) A list of comma separated tags to add to the data catalog that is created.
CreateDataCatalogRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of comma separated tags to add to the data catalog that is created.
CreateDataCatalogRequest.Builder	tags(Tag... tags) A list of comma separated tags to add to the data catalog that is created.
CreateDataCatalogRequest.Builder	type(DataCatalogType 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.
CreateDataCatalogRequest.Builder	type(String 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.

Methods inherited from interface software.amazon.awssdk.services.athena.model.AthenaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateDataCatalogRequest.Builder name(String name)

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.

Parameters:

name - 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:

Returns a reference to this object so that method calls can be chained together.

type

CreateDataCatalogRequest.Builder type(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataCatalogType, DataCatalogType

type

CreateDataCatalogRequest.Builder type(DataCatalogType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataCatalogType, DataCatalogType

description

CreateDataCatalogRequest.Builder description(String description)

A description of the data catalog to be created.

Parameters:

description - A description of the data catalog to be created.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

CreateDataCatalogRequest.Builder parameters(Map<String,String> parameters)

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.

Parameters:

parameters - 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:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDataCatalogRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDataCatalogRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDataCatalogRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateDataCatalogRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDataCatalogRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder