@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
155 lines • 5.77 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DataCatalog = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an Athena data catalog.
*
* More information about Athena and Athena data catalogs can be found in the [Athena User Guide](https://docs.aws.amazon.com/athena/latest/ug/what-is.html).
*
* > **Tip:** for a more detailed explanation on the usage of `parameters`, see the [DataCatalog API documentation](https://docs.aws.amazon.com/athena/latest/APIReference/API_DataCatalog.html)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.athena.DataCatalog("example", {
* name: "athena-data-catalog",
* description: "Example Athena data catalog",
* type: "LAMBDA",
* parameters: {
* "function": "arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function",
* },
* tags: {
* Name: "example-athena-data-catalog",
* },
* });
* ```
*
* ### Hive based Data Catalog
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.athena.DataCatalog("example", {
* name: "hive-data-catalog",
* description: "Hive based Data Catalog",
* type: "HIVE",
* parameters: {
* "metadata-function": "arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function",
* },
* });
* ```
*
* ### Glue based Data Catalog
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.athena.DataCatalog("example", {
* name: "glue-data-catalog",
* description: "Glue based Data Catalog",
* type: "GLUE",
* parameters: {
* "catalog-id": "123456789012",
* },
* });
* ```
*
* ### Lambda based Data Catalog
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.athena.DataCatalog("example", {
* name: "lambda-data-catalog",
* description: "Lambda based Data Catalog",
* type: "LAMBDA",
* parameters: {
* "metadata-function": "arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function-1",
* "record-function": "arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function-2",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import data catalogs using their `name`. For example:
*
* ```sh
* $ pulumi import aws:athena/dataCatalog:DataCatalog example example-data-catalog
* ```
*/
class DataCatalog extends pulumi.CustomResource {
/**
* Get an existing DataCatalog resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new DataCatalog(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DataCatalog. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === DataCatalog.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["description"] = state?.description;
resourceInputs["name"] = state?.name;
resourceInputs["parameters"] = state?.parameters;
resourceInputs["region"] = state?.region;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
resourceInputs["type"] = state?.type;
}
else {
const args = argsOrState;
if (args?.description === undefined && !opts.urn) {
throw new Error("Missing required property 'description'");
}
if (args?.parameters === undefined && !opts.urn) {
throw new Error("Missing required property 'parameters'");
}
if (args?.type === undefined && !opts.urn) {
throw new Error("Missing required property 'type'");
}
resourceInputs["description"] = args?.description;
resourceInputs["name"] = args?.name;
resourceInputs["parameters"] = args?.parameters;
resourceInputs["region"] = args?.region;
resourceInputs["tags"] = args?.tags;
resourceInputs["type"] = args?.type;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DataCatalog.__pulumiType, name, resourceInputs, opts);
}
}
exports.DataCatalog = DataCatalog;
/** @internal */
DataCatalog.__pulumiType = 'aws:athena/dataCatalog:DataCatalog';
//# sourceMappingURL=dataCatalog.js.map