@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:49.763Z") public class CfnDataCatalog extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDataCatalog.Builder
A fluent builder for
CfnDataCatalog . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDataCatalog(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataCatalog(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDataCatalog(Construct scope, java.lang.String id, CfnDataCatalogProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getName()
The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
public void setName(java.lang.String value)
The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
public java.lang.String getType()
public void setType(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getParameters()
The mapping used depends on the catalog type.
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*
LAMBDA
data catalog type uses one of the following sets of required parameters, but not both.
metadata-function= *lambda_arn* , record-function= *lambda_arn*
function= *lambda_arn*
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*
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.AwsDataCatalog
must be run on Athena engine version 2.INVALID_INPUT
error.public void setParameters(IResolvable value)
The mapping used depends on the catalog type.
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*
LAMBDA
data catalog type uses one of the following sets of required parameters, but not both.
metadata-function= *lambda_arn* , record-function= *lambda_arn*
function= *lambda_arn*
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*
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.AwsDataCatalog
must be run on Athena engine version 2.INVALID_INPUT
error.public void setParameters(java.util.Map<java.lang.String,java.lang.String> value)
The mapping used depends on the catalog type.
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*
LAMBDA
data catalog type uses one of the following sets of required parameters, but not both.
metadata-function= *lambda_arn* , record-function= *lambda_arn*
function= *lambda_arn*
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*
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.AwsDataCatalog
must be run on Athena engine version 2.INVALID_INPUT
error.