@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
73 lines • 3.57 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.DocumentationPart = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
*/
class DocumentationPart extends pulumi.CustomResource {
/**
* Get an existing DocumentationPart 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, opts) {
return new DocumentationPart(name, undefined, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DocumentationPart. 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'] === DocumentationPart.__pulumiType;
}
/**
* Create a DocumentationPart resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name, args, opts) {
let resourceInputs = {};
opts = opts || {};
if (!opts.id) {
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.properties === undefined && !opts.urn) {
throw new Error("Missing required property 'properties'");
}
if (args?.restApiId === undefined && !opts.urn) {
throw new Error("Missing required property 'restApiId'");
}
resourceInputs["location"] = args?.location;
resourceInputs["properties"] = args?.properties;
resourceInputs["restApiId"] = args?.restApiId;
resourceInputs["documentationPartId"] = undefined /*out*/;
}
else {
resourceInputs["documentationPartId"] = undefined /*out*/;
resourceInputs["location"] = undefined /*out*/;
resourceInputs["properties"] = undefined /*out*/;
resourceInputs["restApiId"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const replaceOnChanges = { replaceOnChanges: ["location", "restApiId"] };
opts = pulumi.mergeOptions(opts, replaceOnChanges);
super(DocumentationPart.__pulumiType, name, resourceInputs, opts);
}
}
exports.DocumentationPart = DocumentationPart;
/** @internal */
DocumentationPart.__pulumiType = 'aws-native:apigateway:DocumentationPart';
//# sourceMappingURL=documentationPart.js.map