@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
334 lines • 12.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A Global VM Extension Policy.
*
* ## Example Usage
*
* ### Compute Global Vm Extension Policy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const opsAgentPolicy = new gcp.compute.GlobalVmExtensionPolicy("ops_agent_policy", {
* name: "global-ops-agent-vme-policy-_88722",
* description: "A basic global VM extension policy",
* priority: 10,
* extensionPolicies: [{
* extensionName: "ops-agent",
* pinnedVersion: "2.66.0",
* }],
* instanceSelectors: [{
* labelSelector: {
* inclusionLabels: {
* env: "test",
* },
* },
* }],
* rolloutOperation: {
* rolloutInput: {
* predefinedRolloutPlan: "FAST_ROLLOUT",
* },
* },
* });
* ```
* ### Compute Global Vm Extension Policy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const opsAgentPolicy = new gcp.compute.GlobalVmExtensionPolicy("ops_agent_policy", {
* name: "global-ops-agent-vme-policy-_39249",
* description: "A basic global VM extension policy",
* priority: 10,
* extensionPolicies: [{
* extensionName: "ops-agent",
* pinnedVersion: "2.66.0",
* }],
* instanceSelectors: [{
* labelSelector: {
* inclusionLabels: {
* env: "test",
* },
* },
* }],
* rolloutOperation: {
* rolloutInput: {
* predefinedRolloutPlan: "FAST_ROLLOUT",
* },
* },
* });
* ```
* ### Compute Global Vm Extension Policy Custom Rollout
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const customRollout = new gcp.compute.RolloutPlan("custom_rollout", {
* name: "custom-rollout-plan-_16511",
* locationScope: "ZONAL",
* waves: [{
* displayName: "wave-1",
* selectors: [{
* locationSelector: {
* includedLocations: [
* "us-central1-a",
* "us-west1-a",
* ],
* },
* }],
* validation: {
* type: "time",
* timeBasedValidationMetadata: {
* waitDuration: "0s",
* },
* },
* orchestrationOptions: {
* maxConcurrentResourcesPerLocation: 10,
* maxConcurrentLocations: 10,
* },
* }],
* });
* const opsAgentPolicy = new gcp.compute.GlobalVmExtensionPolicy("ops_agent_policy", {
* name: "global-ops-agent-vme-policy-_74391",
* description: "A global VM extension policy with a custom rollout plan",
* priority: 10,
* extensionPolicies: [{
* extensionName: "ops-agent",
* pinnedVersion: "2.66.0",
* }],
* instanceSelectors: [{
* labelSelector: {
* inclusionLabels: {
* env: "test",
* },
* },
* }],
* rolloutOperation: {
* rolloutInput: {
* name: pulumi.all([project, customRollout.name]).apply(([project, name]) => `projects/${project.number}/locations/global/rolloutPlans/${name}`),
* },
* },
* });
* ```
*
* ## Import
*
* GlobalVmExtensionPolicy can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/vmExtensionPolicies/{{name}}`
* * `{{project}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, GlobalVmExtensionPolicy can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/globalVmExtensionPolicy:GlobalVmExtensionPolicy default projects/{{project}}/global/vmExtensionPolicies/{{name}}
* $ pulumi import gcp:compute/globalVmExtensionPolicy:GlobalVmExtensionPolicy default {{project}}/{{name}}
* $ pulumi import gcp:compute/globalVmExtensionPolicy:GlobalVmExtensionPolicy default {{name}}
* ```
*/
export declare class GlobalVmExtensionPolicy extends pulumi.CustomResource {
/**
* Get an existing GlobalVmExtensionPolicy 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: string, id: pulumi.Input<pulumi.ID>, state?: GlobalVmExtensionPolicyState, opts?: pulumi.CustomResourceOptions): GlobalVmExtensionPolicy;
/**
* Returns true if the given object is an instance of GlobalVmExtensionPolicy. 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 GlobalVmExtensionPolicy;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Map from extension (eg: "cloudops") to its policy configuration.
* Structure is documented below.
*/
readonly extensionPolicies: pulumi.Output<outputs.compute.GlobalVmExtensionPolicyExtensionPolicy[]>;
/**
* Selector to target VMs for a policy.
* Structure is documented below.
*/
readonly instanceSelectors: pulumi.Output<outputs.compute.GlobalVmExtensionPolicyInstanceSelector[] | undefined>;
/**
* Type of the resource.
*/
readonly kind: pulumi.Output<string>;
/**
* Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and match the regular expression '^a-z?$' to comply with RFC1035.
*/
readonly name: pulumi.Output<string>;
/**
* Used to resolve conflicts when multiple policies are active. Defaults to 0.
*/
readonly priority: pulumi.Output<number>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Represents the rollout operation.
* Structure is documented below.
*/
readonly rolloutOperation: pulumi.Output<outputs.compute.GlobalVmExtensionPolicyRolloutOperation>;
/**
* The scoped resource status.
*/
readonly scopedResourceStatus: pulumi.Output<string>;
/**
* Server-defined fully-qualified URL for this resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Update timestamp in RFC3339 text format.
*/
readonly updateTimestamp: pulumi.Output<string>;
/**
* Create a GlobalVmExtensionPolicy 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: GlobalVmExtensionPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GlobalVmExtensionPolicy resources.
*/
export interface GlobalVmExtensionPolicyState {
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* Map from extension (eg: "cloudops") to its policy configuration.
* Structure is documented below.
*/
extensionPolicies?: pulumi.Input<pulumi.Input<inputs.compute.GlobalVmExtensionPolicyExtensionPolicy>[] | undefined>;
/**
* Selector to target VMs for a policy.
* Structure is documented below.
*/
instanceSelectors?: pulumi.Input<pulumi.Input<inputs.compute.GlobalVmExtensionPolicyInstanceSelector>[] | undefined>;
/**
* Type of the resource.
*/
kind?: pulumi.Input<string | undefined>;
/**
* Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and match the regular expression '^a-z?$' to comply with RFC1035.
*/
name?: pulumi.Input<string | undefined>;
/**
* Used to resolve conflicts when multiple policies are active. Defaults to 0.
*/
priority?: pulumi.Input<number | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Represents the rollout operation.
* Structure is documented below.
*/
rolloutOperation?: pulumi.Input<inputs.compute.GlobalVmExtensionPolicyRolloutOperation | undefined>;
/**
* The scoped resource status.
*/
scopedResourceStatus?: pulumi.Input<string | undefined>;
/**
* Server-defined fully-qualified URL for this resource.
*/
selfLink?: pulumi.Input<string | undefined>;
/**
* Update timestamp in RFC3339 text format.
*/
updateTimestamp?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a GlobalVmExtensionPolicy resource.
*/
export interface GlobalVmExtensionPolicyArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* Map from extension (eg: "cloudops") to its policy configuration.
* Structure is documented below.
*/
extensionPolicies: pulumi.Input<pulumi.Input<inputs.compute.GlobalVmExtensionPolicyExtensionPolicy>[]>;
/**
* Selector to target VMs for a policy.
* Structure is documented below.
*/
instanceSelectors?: pulumi.Input<pulumi.Input<inputs.compute.GlobalVmExtensionPolicyInstanceSelector>[] | undefined>;
/**
* Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and match the regular expression '^a-z?$' to comply with RFC1035.
*/
name?: pulumi.Input<string | undefined>;
/**
* Used to resolve conflicts when multiple policies are active. Defaults to 0.
*/
priority?: pulumi.Input<number | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Represents the rollout operation.
* Structure is documented below.
*/
rolloutOperation: pulumi.Input<inputs.compute.GlobalVmExtensionPolicyRolloutOperation>;
}
//# sourceMappingURL=globalVmExtensionPolicy.d.ts.map