Class CfnDataCatalogProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.athena.CfnDataCatalogProps.Jsii$Proxy
All Implemented Interfaces:
CfnDataCatalogProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnDataCatalogProps

@Stability(Stable) @Internal public static final class CfnDataCatalogProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnDataCatalogProps
An implementation for CfnDataCatalogProps
  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.athena.CfnDataCatalogProps

    CfnDataCatalogProps.Builder, CfnDataCatalogProps.Jsii$Proxy
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Constructor that initializes the object based on literal property values passed by the CfnDataCatalogProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
     
    final boolean
     
    final String
    A description of the data catalog.
    final String
    The name of the data catalog.
    final Object
    Specifies the Lambda function or functions to use for the data catalog.
    final List<CfnTag>
    The tags (key-value pairs) to associate with this resource.
    final String
    The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    final int
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.
    • Jsii$Proxy

      protected Jsii$Proxy(CfnDataCatalogProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnDataCatalogProps.Builder.
  • Method Details

    • getName

      public final String getName()
      Description copied from interface: CfnDataCatalogProps
      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.

      Specified by:
      getName in interface CfnDataCatalogProps
    • getType

      public final String getType()
      Description copied from interface: CfnDataCatalogProps
      The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
      Specified by:
      getType in interface CfnDataCatalogProps
    • getDescription

      public final String getDescription()
      Description copied from interface: CfnDataCatalogProps
      A description of the data catalog.
      Specified by:
      getDescription in interface CfnDataCatalogProps
    • getParameters

      public final Object getParameters()
      Description copied from interface: CfnDataCatalogProps
      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.
      Specified by:
      getParameters in interface CfnDataCatalogProps
    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnDataCatalogProps
      The tags (key-value pairs) to associate with this resource.
      Specified by:
      getTags in interface CfnDataCatalogProps
    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object