software.amazon.awscdk.services.athena

Class CfnDataCatalogProps.Builder

java.lang.Object

software.amazon.awscdk.services.athena.CfnDataCatalogProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataCatalogProps>

Enclosing interface:

CfnDataCatalogProps

@Stability(value=Stable)
public static final class CfnDataCatalogProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataCatalogProps>

A builder for CfnDataCatalogProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDataCatalogProps	build() Builds the configured instance.
CfnDataCatalogProps.Builder	description(String description) Sets the value of CfnDataCatalogProps.getDescription()
CfnDataCatalogProps.Builder	name(String name) Sets the value of CfnDataCatalogProps.getName()
CfnDataCatalogProps.Builder	parameters(IResolvable parameters) Sets the value of CfnDataCatalogProps.getParameters()
CfnDataCatalogProps.Builder	parameters(Map<String,String> parameters) Sets the value of CfnDataCatalogProps.getParameters()
CfnDataCatalogProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnDataCatalogProps.getTags()
CfnDataCatalogProps.Builder	type(String type) Sets the value of CfnDataCatalogProps.getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

@Stability(value=Stable)
public CfnDataCatalogProps.Builder name(String name)

Sets the value of CfnDataCatalogProps.getName()

Parameters:

name - The name of the data catalog. This parameter is required. 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:

this

type

@Stability(value=Stable)
public CfnDataCatalogProps.Builder type(String type)

Sets the value of CfnDataCatalogProps.getType()

Parameters:

type - The type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnDataCatalogProps.Builder description(String description)

Sets the value of CfnDataCatalogProps.getDescription()

Parameters:

description - A description of the data catalog.

Returns:

this

parameters

@Stability(value=Stable)
public CfnDataCatalogProps.Builder parameters(IResolvable parameters)

Sets the value of CfnDataCatalogProps.getParameters()

Parameters:

parameters - Specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type.

• The HIVE data catalog type uses 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*

• The LAMBDA data catalog type uses one of the following sets of required parameters, but not both.
• When one Lambda function processes metadata and another Lambda function reads data, the following syntax is used. Both parameters are required.

metadata-function= *lambda_arn* , record-function= *lambda_arn*

• A composite Lambda function that processes both metadata and data uses the following syntax.

function= *lambda_arn*

• The GLUE type takes a catalog ID parameter and is required. The *catalog_id* is the account ID of the AWS 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.
• In Regions where Athena engine version 2 is not available, creating new GLUE data catalogs results in an INVALID_INPUT error.

Returns:

this

parameters

@Stability(value=Stable)
public CfnDataCatalogProps.Builder parameters(Map<String,String> parameters)

Sets the value of CfnDataCatalogProps.getParameters()

Parameters:

parameters - Specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type.

• The HIVE data catalog type uses 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*

• The LAMBDA data catalog type uses one of the following sets of required parameters, but not both.
• When one Lambda function processes metadata and another Lambda function reads data, the following syntax is used. Both parameters are required.

metadata-function= *lambda_arn* , record-function= *lambda_arn*

• A composite Lambda function that processes both metadata and data uses the following syntax.

function= *lambda_arn*

• The GLUE type takes a catalog ID parameter and is required. The *catalog_id* is the account ID of the AWS 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.
• In Regions where Athena engine version 2 is not available, creating new GLUE data catalogs results in an INVALID_INPUT error.

Returns:

this

tags

@Stability(value=Stable)
public CfnDataCatalogProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDataCatalogProps.getTags()

Parameters:

tags - The tags (key-value pairs) to associate with this resource.

Returns:

this

build

@Stability(value=Stable)
public CfnDataCatalogProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataCatalogProps>

Returns:

a new instance of CfnDataCatalogProps

Throws:

NullPointerException - if any required attribute was not provided