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.113.0 (build fc68b25)",
           date="2025-09-02T11:25:26.598Z")
@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
         .connectionType("connectionType")
         .description("description")
         .error("error")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .status("status")
         .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	getConnectionType()	The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ).
default String	getDescription()	A description of the data catalog.
default String	getError()	Text of the error that occurred during data catalog creation or deletion.
String	getName()	The name of the data catalog.
default Object	getParameters()	Specifies the Lambda function or functions to use for creating the data catalog.
default String	getStatus()	The status of the creation or deletion of 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

getConnectionType

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

The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ).

For information about individual connectors, see Available data source connectors .

See Also:

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

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

getError

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

Text of the error that occurred during data catalog creation or deletion.

See Also:

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

getParameters

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

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 AWS account to which the AWS 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.
• The FEDERATED data catalog type uses one of the following parameters, but not both. Use connection-arn for an existing AWS Glue connection. Use connection-type and connection-properties to specify the configuration setting for a new connection.
• connection-arn: *<glue_connection_arn_to_reuse>*
• lambda-role-arn (optional): The execution role to use for the Lambda function. If not provided, one is created.
• connection-type:MYSQL|REDSHIFT|...., connection-properties:" *<json_string>* "

For <json_string> , use escaped JSON text, as in the following example.

"{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"}"

See Also:

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

getStatus

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

The status of the creation or deletion of the data catalog.

• The LAMBDA , GLUE , and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED .
• The FEDERATED data catalog type is created asynchronously.

Data catalog creation status:

• CREATE_IN_PROGRESS : Federated data catalog creation in progress.
• CREATE_COMPLETE : Data catalog creation complete.
• CREATE_FAILED : Data catalog could not be created.
• CREATE_FAILED_CLEANUP_IN_PROGRESS : Federated data catalog creation failed and is being removed.
• CREATE_FAILED_CLEANUP_COMPLETE : Federated data catalog creation failed and was removed.
• CREATE_FAILED_CLEANUP_FAILED : Federated data catalog creation failed but could not be removed.

Data catalog deletion status:

• DELETE_IN_PROGRESS : Federated data catalog deletion in progress.
• DELETE_COMPLETE : Federated data catalog deleted.
• DELETE_FAILED : Federated data catalog could not be deleted.

See Also:

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

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