@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
54 lines • 2.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Updates settings for a Pulumi ESC environment using a partial update (patch) approach. Currently supports toggling deletion protection via the deletionProtected field. When deletionProtected is set to true, the environment cannot be deleted until the setting is explicitly disabled. Only the fields included in the request body are modified; omitted fields retain their current values.
*/
export declare class EnvironmentSettings extends pulumi.CustomResource {
/**
* Get an existing EnvironmentSettings 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): EnvironmentSettings;
/**
* Returns true if the given object is an instance of EnvironmentSettings. 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 EnvironmentSettings;
/**
* Whether the environment is protected from deletion.
*/
readonly deletionProtected: pulumi.Output<boolean>;
/**
* Create a EnvironmentSettings 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: EnvironmentSettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a EnvironmentSettings resource.
*/
export interface EnvironmentSettingsArgs {
/**
* DeletionProtected indicates whether deletion protection should be enabled for this environment. Null means no change.
*/
deletionProtected?: pulumi.Input<boolean | undefined>;
/**
* The environment name
*/
envName: pulumi.Input<string>;
/**
* The organization name
*/
orgName: pulumi.Input<string>;
/**
* The project name
*/
projectName: pulumi.Input<string>;
}
//# sourceMappingURL=environmentSettings.d.ts.map