@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)
74 lines • 3.75 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.GatewayResponse = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The ``AWS::ApiGateway::GatewayResponse`` resource creates a gateway response for your API. When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.
*/
class GatewayResponse extends pulumi.CustomResource {
/**
* Get an existing GatewayResponse 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 GatewayResponse(name, undefined, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of GatewayResponse. 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'] === GatewayResponse.__pulumiType;
}
/**
* Create a GatewayResponse 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?.responseType === undefined && !opts.urn) {
throw new Error("Missing required property 'responseType'");
}
if (args?.restApiId === undefined && !opts.urn) {
throw new Error("Missing required property 'restApiId'");
}
resourceInputs["responseParameters"] = args?.responseParameters;
resourceInputs["responseTemplates"] = args?.responseTemplates;
resourceInputs["responseType"] = args?.responseType;
resourceInputs["restApiId"] = args?.restApiId;
resourceInputs["statusCode"] = args?.statusCode;
resourceInputs["awsId"] = undefined /*out*/;
}
else {
resourceInputs["awsId"] = undefined /*out*/;
resourceInputs["responseParameters"] = undefined /*out*/;
resourceInputs["responseTemplates"] = undefined /*out*/;
resourceInputs["responseType"] = undefined /*out*/;
resourceInputs["restApiId"] = undefined /*out*/;
resourceInputs["statusCode"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const replaceOnChanges = { replaceOnChanges: ["responseType", "restApiId"] };
opts = pulumi.mergeOptions(opts, replaceOnChanges);
super(GatewayResponse.__pulumiType, name, resourceInputs, opts);
}
}
exports.GatewayResponse = GatewayResponse;
/** @internal */
GatewayResponse.__pulumiType = 'aws-native:apigateway:GatewayResponse';
//# sourceMappingURL=gatewayResponse.js.map