@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
95 lines • 3.82 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.DocumentationVersion = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides a resource to manage an API Gateway Documentation Version.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const exampleRestApi = new aws.apigateway.RestApi("example", {name: "example_api"});
* const exampleDocumentationPart = new aws.apigateway.DocumentationPart("example", {
* location: {
* type: "API",
* },
* properties: "{\"description\":\"Example\"}",
* restApiId: exampleRestApi.id,
* });
* const example = new aws.apigateway.DocumentationVersion("example", {
* version: "example_version",
* restApiId: exampleRestApi.id,
* description: "Example description",
* }, {
* dependsOn: [exampleDocumentationPart],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import API Gateway documentation versions using `REST-API-ID/VERSION`. For example:
*
* ```sh
* $ pulumi import aws:apigateway/documentationVersion:DocumentationVersion example 5i4e1ko720/example-version
* ```
*/
class DocumentationVersion extends pulumi.CustomResource {
/**
* Get an existing DocumentationVersion 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 DocumentationVersion(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DocumentationVersion. 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'] === DocumentationVersion.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["description"] = state?.description;
resourceInputs["region"] = state?.region;
resourceInputs["restApiId"] = state?.restApiId;
resourceInputs["version"] = state?.version;
}
else {
const args = argsOrState;
if (args?.restApiId === undefined && !opts.urn) {
throw new Error("Missing required property 'restApiId'");
}
if (args?.version === undefined && !opts.urn) {
throw new Error("Missing required property 'version'");
}
resourceInputs["description"] = args?.description;
resourceInputs["region"] = args?.region;
resourceInputs["restApiId"] = args?.restApiId;
resourceInputs["version"] = args?.version;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DocumentationVersion.__pulumiType, name, resourceInputs, opts);
}
}
exports.DocumentationVersion = DocumentationVersion;
/** @internal */
DocumentationVersion.__pulumiType = 'aws:apigateway/documentationVersion:DocumentationVersion';
//# sourceMappingURL=documentationVersion.js.map