Class CfnDataCatalog

The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDataCatalog

Implements

IInspectable

IDataCatalogRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Athena

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataCatalog : CfnResource, IInspectable, IDataCatalogRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDataCatalog Inherits CfnResource Implements IInspectable, IDataCatalogRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

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
                 ConnectionType = "connectionType",
                 Description = "description",
                 Error = "error",
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDataCatalog(Construct, string, ICfnDataCatalogProps)

Create a new AWS::Athena::DataCatalog.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.
CfnPropertyNames	The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.
ConnectionType	The type of connection for a FEDERATED data catalog (for example, REDSHIFT , MYSQL , or SQLSERVER ).
DataCatalogRef	A reference to a DataCatalog resource.
Description	A description of the data catalog.
Error	Text of the error that occurred during data catalog creation or deletion.
Name	The name of the data catalog.
Parameters	Specifies the Lambda function or functions to use for creating the data catalog.
Status	The status of the creation or deletion of the data catalog.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The tags (key-value pairs) to associate with this resource.
Type	The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.

Methods

ArnForDataCatalog(IDataCatalogRef)	The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.
FromDataCatalogName(Construct, string, string)	Creates a new IDataCatalogRef from a dataCatalogName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDataCatalog(object)	Checks whether the given object is a CfnDataCatalog.
RenderProperties(IDictionary<string, object>)	The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnDataCatalogProps

Resource properties.

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

ConnectionType

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

public virtual string? ConnectionType { get; set; }

Property Value

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

DataCatalogRef

A reference to a DataCatalog resource.

public virtual IDataCatalogReference DataCatalogRef { get; }

Property Value

IDataCatalogReference

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Description

A description of the data catalog.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Error

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

public virtual string? Error { get; set; }

Property Value

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Name

The name of the data catalog.

public virtual string Name { get; set; }

Property Value

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Parameters

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

public virtual object? Parameters { get; set; }

Property Value

object

Remarks

Type union: either Dictionary<string, string> or IResolvable

Status

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

public virtual string? Status { get; set; }

Property Value

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

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

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Methods

ArnForDataCatalog(IDataCatalogRef)

The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.

public static string ArnForDataCatalog(IDataCatalogRef resource)

Parameters

resource IDataCatalogRef

Returns

string

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

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
                 ConnectionType = "connectionType",
                 Description = "description",
                 Error = "error",
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromDataCatalogName(Construct, string, string)

Creates a new IDataCatalogRef from a dataCatalogName.

public static IDataCatalogRef FromDataCatalogName(Construct scope, string id, string dataCatalogName)

Parameters

scope Construct

id string

dataCatalogName string

Returns

IDataCatalogRef

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

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.

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

IsCfnDataCatalog(object)

Checks whether the given object is a CfnDataCatalog.

public static bool IsCfnDataCatalog(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see DataCatalog in the Amazon Athena API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html

CloudformationResource: AWS::Athena::DataCatalog

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDataCatalogRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable