@spacelift-io/pulumi-spacelift
Version:
A Pulumi package for creating and managing Spacelift resources.
72 lines • 3.45 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.StackDestructor = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* `spacelift.StackDestructor` is used to destroy the resources of a Stack before deleting it. `dependsOn` should be used to make sure that all necessary resources (environment variables, roles, integrations, etc.) are still in place when the destruction run is executed. **Note:** Destroying this resource will delete the resources in the stack. If this resource needs to be deleted and the resources in the stacks are to be preserved, ensure that the `deactivated` attribute is set to `true`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as spacelift from "@spacelift-io/pulumi-spacelift";
*
* const k8s_coreStack = new spacelift.Stack("k8s-coreStack", {});
* // ...
* const credentials = new spacelift.EnvironmentVariable("credentials", {});
* // ...
* const k8s_coreStackDestructor = new spacelift.StackDestructor("k8s-coreStackDestructor", {stackId: k8s_coreStack.id}, {
* dependsOn: [credentials],
* });
* ```
*/
class StackDestructor extends pulumi.CustomResource {
/**
* Get an existing StackDestructor 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 StackDestructor(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of StackDestructor. 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'] === StackDestructor.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["deactivated"] = state ? state.deactivated : undefined;
resourceInputs["stackId"] = state ? state.stackId : undefined;
}
else {
const args = argsOrState;
if ((!args || args.stackId === undefined) && !opts.urn) {
throw new Error("Missing required property 'stackId'");
}
resourceInputs["deactivated"] = args ? args.deactivated : undefined;
resourceInputs["stackId"] = args ? args.stackId : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(StackDestructor.__pulumiType, name, resourceInputs, opts);
}
}
exports.StackDestructor = StackDestructor;
/** @internal */
StackDestructor.__pulumiType = 'spacelift:index/stackDestructor:StackDestructor';
//# sourceMappingURL=stackDestructor.js.map