@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
105 lines • 3.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a new stack within a project in the organization. If the project does not exist, it will be created. A stack is an isolated, independently configurable instance of a Pulumi program, typically representing a deployment environment (e.g., development, staging, production). The stack name must be unique within the project.
*
* The optional `config` object supports:
* - `environment`: reference to an ESC environment for storing stack configuration (must not already exist)
* - `secretsProvider`: the secrets provider for the stack
* - `encryptedKey`: KMS-encrypted ciphertext for the data key (cloud-based secrets providers only)
* - `encryptionSalt`: base64-encoded encryption salt (passphrase-based secrets providers only)
*/
export declare class Stack extends pulumi.CustomResource {
/**
* Get an existing Stack 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: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Stack;
/**
* Returns true if the given object is an instance of Stack. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Stack;
/**
* The active update
*/
readonly activeUpdate: pulumi.Output<string>;
/**
* Optional cloud-persisted stack configuration.
* If set, then the stack's configuration is loaded from the cloud and not a file on disk.
*/
readonly config: pulumi.Output<any | undefined>;
/**
* CurrentOperation provides information about a stack operation in-progress, as applicable.
*/
readonly currentOperation: pulumi.Output<any | undefined>;
/**
* The organization name
*/
readonly orgName: pulumi.Output<string>;
/**
* The project name
*/
readonly projectName: pulumi.Output<string>;
/**
* The stack name
*/
readonly stackName: pulumi.Output<string>;
/**
* Map of tags
*/
readonly tags: pulumi.Output<{
[key: string]: any;
} | undefined>;
/**
* The version number
*/
readonly version: pulumi.Output<number>;
/**
* Create a Stack 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: string, args: StackArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Stack resource.
*/
export interface StackArgs {
/**
* The configuration for the new stack.
*/
config?: any | undefined;
/**
* The organization name
*/
orgName: pulumi.Input<string>;
/**
* The project name
*/
projectName: pulumi.Input<string>;
/**
* The name of the stack being created.
*/
stackName: pulumi.Input<string>;
/**
* An optional state to initialize the stack with.
*/
state?: any | undefined;
/**
* An optional set of tags to apply to the stack.
*/
tags?: pulumi.Input<{
[key: string]: any;
} | undefined>;
/**
* An optional set of teams to assign to the stack.
*/
teams?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=stack.d.ts.map