Class CfnDataCatalog
A CloudFormation AWS::Athena::DataCatalog
.
Inherited Members
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.AWS.Athena.dll
Syntax (csharp)
public class CfnDataCatalog : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDataCatalog
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::Athena::DataCatalog
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Athena;
var cfnDataCatalog = new CfnDataCatalog(this, "MyCfnDataCatalog", new CfnDataCatalogProps {
Name = "name",
Type = "type",
// the properties below are optional
Description = "description",
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDataCatalog(Construct, String, ICfnDataCatalogProps) | Create a new |
CfnDataCatalog(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataCatalog(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the data catalog. |
Name | The name of the data catalog. |
Parameters | Specifies the Lambda function or functions to use for the data catalog. |
Tags | The tags (key-value pairs) to associate with this resource. |
Type | The type of data catalog: |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataCatalog(Construct, String, ICfnDataCatalogProps)
Create a new AWS::Athena::DataCatalog
.
public CfnDataCatalog(Construct scope, string id, ICfnDataCatalogProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDataCatalogProps
- resource properties.
CfnDataCatalog(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataCatalog(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataCatalog(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataCatalog(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the data catalog.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the data catalog.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
Parameters
Specifies the Lambda function or functions to use for the data catalog.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
The mapping used depends on the catalog type.
metadata-function= lambda_arn , sdk-version= version_number
metadata-function= lambda_arn , record-function= lambda_arn
function= lambda_arn
catalog-id= catalog_id
Tags
The tags (key-value pairs) to associate with this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Type
The type of data catalog: LAMBDA
for a federated catalog, GLUE
for AWS Glue Catalog, or HIVE
for an external hive metastore.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>