Package software.amazon.awscdk.services.athena

Interface CfnDataCatalogProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataCatalogProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.542Z")
@Stability(Stable)
public interface CfnDataCatalogProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataCatalog.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 CfnDataCatalogProps cfnDataCatalogProps = CfnDataCatalogProps.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .description("description")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataCatalogProps.Builder	A builder for CfnDataCatalogProps
static final class	CfnDataCatalogProps.Jsii$Proxy	An implementation for CfnDataCatalogProps

Method Summary

Modifier and Type	Method	Description
static CfnDataCatalogProps.Builder	builder()
default String	getDescription()	A description of the data catalog.
String	getName()	The name of the data catalog.
default Object	getParameters()	Specifies the Lambda function or functions to use for the data catalog.
default List<CfnTag>	getTags()	The tags (key-value pairs) to associate with this resource.
String	getType()	The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the data catalog.

The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-name

getType

@Stability(Stable)
@NotNull
String getType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-type

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the data catalog.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-description

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-tags

builder

@Stability(Stable)
static CfnDataCatalogProps.Builder builder()

Returns:

a CfnDataCatalogProps.Builder of CfnDataCatalogProps