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

Jsii$Proxy(CfnDataCatalogProps.Builder builder)

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

$jsii$toJson()

final boolean

equals(Object o)

final String

getConnectionType()

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

final String

getDescription()

A description of the data catalog.

final String

getError()

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

final String

getName()

The name of the data catalog.

final Object

getParameters()

Specifies the Lambda function or functions to use for creating the data catalog.

final String

getStatus()

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

final List<CfnTag>

getTags()

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

final String

getType()

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

final int

hashCode()

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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-name
- 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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-type
- getConnectionType
  
  public final String getConnectionType()
  
  Description copied from interface: CfnDataCatalogProps
  
  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 .
  Specified by:
  
  getConnectionType in interface CfnDataCatalogProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-connectiontype
- getDescription
  
  public final String getDescription()
  
  Description copied from interface: CfnDataCatalogProps
  
  A description of the data catalog.
  Specified by:
  
  getDescription in interface CfnDataCatalogProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-description
- getError
  
  public final String getError()
  
  Description copied from interface: CfnDataCatalogProps
  
  Text of the error that occurred during data catalog creation or deletion.
  Specified by:
  
  getError in interface CfnDataCatalogProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-error
- getParameters
  
  public final Object getParameters()
  
  Description copied from interface: CfnDataCatalogProps
  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\"}"
  Specified by:
  
  getParameters in interface CfnDataCatalogProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-parameters
- getStatus
  
  public final String getStatus()
  
  Description copied from interface: CfnDataCatalogProps
  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.
  Specified by:
  
  getStatus in interface CfnDataCatalogProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-status
- 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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-tags
- $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

Class CfnDataCatalogProps.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getName

getType

getConnectionType

getDescription

getError

getParameters

getStatus

getTags

$jsii$toJson

equals

hashCode