software.amazon.awscdk.services.athena

Class CfnDataCatalog

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.athena.CfnDataCatalog

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-10-06T13:24:56.245Z")
public class CfnDataCatalog
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Athena::DataCatalog`.

The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags. For more information, see DataCatalog in the Amazon Athena API Reference .

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.*;
 CfnDataCatalog cfnDataCatalog = CfnDataCatalog.Builder.create(this, "MyCfnDataCatalog")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDataCatalog.Builder A fluent builder for CfnDataCatalog.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataCatalog(Construct scope, java.lang.String id, CfnDataCatalogProps props) Create a new `AWS::Athena::DataCatalog`.
protected	CfnDataCatalog(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataCatalog(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the data catalog.
java.lang.String	getName() The name of the data catalog.
java.lang.Object	getParameters() Specifies the Lambda function or functions to use for the data catalog.
TagManager	getTags() The tags (key-value pairs) to associate with this resource.
java.lang.String	getType() The type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description of the data catalog.
void	setName(java.lang.String value) The name of the data catalog.
void	setParameters(IResolvable value) Specifies the Lambda function or functions to use for the data catalog.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> value) Specifies the Lambda function or functions to use for the data catalog.
void	setType(java.lang.String value) 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 class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataCatalog

protected CfnDataCatalog(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataCatalog

protected CfnDataCatalog(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataCatalog

public CfnDataCatalog(Construct scope,
                      java.lang.String id,
                      CfnDataCatalogProps props)

Create a new `AWS::Athena::DataCatalog`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getName

public java.lang.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.

setName

public void setName(java.lang.String value)

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.

getType

public java.lang.String getType()

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

setType

public void setType(java.lang.String value)

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

getDescription

public java.lang.String getDescription()

A description of the data catalog.

setDescription

public void setDescription(java.lang.String value)

A description of the data catalog.

getParameters

public java.lang.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.
• 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.

setParameters

public void setParameters(IResolvable value)

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.

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> value)

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.