Package software.amazon.awscdk.services.athena

Class CfnDataCatalog

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.athena.CfnDataCatalog
All Implemented Interfaces:
IInspectable, ITaggable, IDataCatalogRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:31.618Z") @Stability(Stable) public class CfnDataCatalog extends CfnResource implements IInspectable, IDataCatalogRef, ITaggable
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
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataCatalog

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

    • CfnDataCatalog

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

    • CfnDataCatalog

      @Stability(Stable) public CfnDataCatalog(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataCatalogProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromDataCatalogName

      @Stability(Stable) @NotNull public static IDataCatalogRef fromDataCatalogName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String dataCatalogName)
      Creates a new IDataCatalogRef from a dataCatalogName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      dataCatalogName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataCatalogRef

      @Stability(Stable) @NotNull public DataCatalogReference getDataCatalogRef()
      A reference to a DataCatalog resource.
      Specified by:
      getDataCatalogRef in interface IDataCatalogRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the data catalog.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the data catalog.

    • getType

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setType(@NotNull String value)
      The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.

    • getConnectionType

      @Stability(Stable) @Nullable public String getConnectionType()
      The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ).

    • setConnectionType

      @Stability(Stable) public void setConnectionType(@Nullable String value)
      The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ).

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the data catalog.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the data catalog.

    • getError

      @Stability(Stable) @Nullable public String getError()
      Text of the error that occurred during data catalog creation or deletion.

    • setError

      @Stability(Stable) public void setError(@Nullable String value)
      Text of the error that occurred during data catalog creation or deletion.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      Specifies the Lambda function or functions to use for creating the data catalog.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable Map<String,String> value)
      Specifies the Lambda function or functions to use for creating the data catalog.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      Specifies the Lambda function or functions to use for creating the data catalog.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of the creation or deletion of the data catalog.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of the creation or deletion of the data catalog.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags (key-value pairs) to associate with this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags (key-value pairs) to associate with this resource.