@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Represents a regional Commitment resource. * * Creating a commitment resource means that you are purchasing a committed * use contract with an explicit start and end time. You can create commitments * based on vCPUs and memory usage and receive discounted rates. * * To get more information about RegionCommitment, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionCommitments) * * How-to Guides * * [Committed use discounts for Compute Engine](https://cloud.google.com/compute/docs/instances/committed-use-discounts-overview) * * ## Example Usage * * ### Compute Region Commitment Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const foobar = new gcp.compute.RegionCommitment("foobar", { * name: "my-region-commitment", * plan: "THIRTY_SIX_MONTH", * resources: [ * { * type: "VCPU", * amount: "4", * }, * { * type: "MEMORY", * amount: "9", * }, * ], * }); * ``` * ### Compute Region Commitment Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const foobar = new gcp.compute.RegionCommitment("foobar", { * name: "my-full-commitment", * description: "some description", * plan: "THIRTY_SIX_MONTH", * type: "MEMORY_OPTIMIZED", * category: "MACHINE", * autoRenew: true, * resources: [ * { * type: "VCPU", * amount: "4", * }, * { * type: "MEMORY", * amount: "9", * }, * ], * }); * ``` * * ## Import * * RegionCommitment can be imported using any of these accepted formats: * * * `projects/{{project}}/regions/{{region}}/commitments/{{name}}` * * * `{{project}}/{{region}}/{{name}}` * * * `{{region}}/{{name}}` * * * `{{name}}` * * When using the `pulumi import` command, RegionCommitment can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/regionCommitment:RegionCommitment default projects/{{project}}/regions/{{region}}/commitments/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionCommitment:RegionCommitment default {{project}}/{{region}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionCommitment:RegionCommitment default {{region}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionCommitment:RegionCommitment default {{name}} * ``` */ export declare class RegionCommitment extends pulumi.CustomResource { /** * Get an existing RegionCommitment 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?: RegionCommitmentState, opts?: pulumi.CustomResourceOptions): RegionCommitment; /** * Returns true if the given object is an instance of RegionCommitment. 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 RegionCommitment; /** * Specifies whether to enable automatic renewal for the commitment. * The default value is false if not specified. * If the field is set to true, the commitment will be automatically renewed for either * one or three years according to the terms of the existing commitment. */ readonly autoRenew: pulumi.Output<boolean>; /** * The category of the commitment. Category MACHINE specifies commitments composed of * machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE * specifies commitments composed of software licenses, listed in licenseResources. * Note that only MACHINE commitments should have a Type specified. * Possible values are: `LICENSE`, `MACHINE`. */ readonly category: pulumi.Output<string>; /** * Unique identifier for the resource. */ readonly commitmentId: pulumi.Output<number>; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output<string>; /** * An optional description of this resource. */ readonly description: pulumi.Output<string | undefined>; /** * Commitment end time in RFC3339 text format. */ readonly endTimestamp: pulumi.Output<string>; /** * Specifies the already existing reservations to attach to the Commitment. */ readonly existingReservations: pulumi.Output<string>; /** * The license specification required as part of a license commitment. * Structure is documented below. */ readonly licenseResource: pulumi.Output<outputs.compute.RegionCommitmentLicenseResource | undefined>; /** * Name of the resource. The name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ readonly name: pulumi.Output<string>; /** * The plan for this commitment, which determines duration and discount rate. * The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). * Possible values are: `TWELVE_MONTH`, `THIRTY_SIX_MONTH`. */ readonly plan: pulumi.Output<string>; /** * 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>; /** * URL of the region where this commitment may be used. */ readonly region: pulumi.Output<string>; /** * A list of commitment amounts for particular resources. * Note that VCPU and MEMORY resource commitments must occur together. * Structure is documented below. */ readonly resources: pulumi.Output<outputs.compute.RegionCommitmentResource[] | undefined>; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output<string>; /** * Commitment start time in RFC3339 text format. */ readonly startTimestamp: pulumi.Output<string>; /** * Status of the commitment with regards to eventual expiration * (each commitment has an end date defined). */ readonly status: pulumi.Output<string>; /** * A human-readable explanation of the status. */ readonly statusMessage: pulumi.Output<string>; /** * The type of commitment, which affects the discount rate and the eligible resources. * The type could be one of the following value: `MEMORY_OPTIMIZED`, `ACCELERATOR_OPTIMIZED`, * `GENERAL_PURPOSE_N1`, `GENERAL_PURPOSE_N2`, `GENERAL_PURPOSE_N2D`, `GENERAL_PURPOSE_E2`, * `GENERAL_PURPOSE_T2D`, `GENERAL_PURPOSE_C3`, `COMPUTE_OPTIMIZED_C2`, `COMPUTE_OPTIMIZED_C2D` and * `GRAPHICS_OPTIMIZED_G2` */ readonly type: pulumi.Output<string>; /** * Create a RegionCommitment 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: RegionCommitmentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RegionCommitment resources. */ export interface RegionCommitmentState { /** * Specifies whether to enable automatic renewal for the commitment. * The default value is false if not specified. * If the field is set to true, the commitment will be automatically renewed for either * one or three years according to the terms of the existing commitment. */ autoRenew?: pulumi.Input<boolean>; /** * The category of the commitment. Category MACHINE specifies commitments composed of * machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE * specifies commitments composed of software licenses, listed in licenseResources. * Note that only MACHINE commitments should have a Type specified. * Possible values are: `LICENSE`, `MACHINE`. */ category?: pulumi.Input<string>; /** * Unique identifier for the resource. */ commitmentId?: pulumi.Input<number>; /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input<string>; /** * An optional description of this resource. */ description?: pulumi.Input<string>; /** * Commitment end time in RFC3339 text format. */ endTimestamp?: pulumi.Input<string>; /** * Specifies the already existing reservations to attach to the Commitment. */ existingReservations?: pulumi.Input<string>; /** * The license specification required as part of a license commitment. * Structure is documented below. */ licenseResource?: pulumi.Input<inputs.compute.RegionCommitmentLicenseResource>; /** * Name of the resource. The name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input<string>; /** * The plan for this commitment, which determines duration and discount rate. * The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). * Possible values are: `TWELVE_MONTH`, `THIRTY_SIX_MONTH`. */ plan?: pulumi.Input<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * URL of the region where this commitment may be used. */ region?: pulumi.Input<string>; /** * A list of commitment amounts for particular resources. * Note that VCPU and MEMORY resource commitments must occur together. * Structure is documented below. */ resources?: pulumi.Input<pulumi.Input<inputs.compute.RegionCommitmentResource>[]>; /** * The URI of the created resource. */ selfLink?: pulumi.Input<string>; /** * Commitment start time in RFC3339 text format. */ startTimestamp?: pulumi.Input<string>; /** * Status of the commitment with regards to eventual expiration * (each commitment has an end date defined). */ status?: pulumi.Input<string>; /** * A human-readable explanation of the status. */ statusMessage?: pulumi.Input<string>; /** * The type of commitment, which affects the discount rate and the eligible resources. * The type could be one of the following value: `MEMORY_OPTIMIZED`, `ACCELERATOR_OPTIMIZED`, * `GENERAL_PURPOSE_N1`, `GENERAL_PURPOSE_N2`, `GENERAL_PURPOSE_N2D`, `GENERAL_PURPOSE_E2`, * `GENERAL_PURPOSE_T2D`, `GENERAL_PURPOSE_C3`, `COMPUTE_OPTIMIZED_C2`, `COMPUTE_OPTIMIZED_C2D` and * `GRAPHICS_OPTIMIZED_G2` */ type?: pulumi.Input<string>; } /** * The set of arguments for constructing a RegionCommitment resource. */ export interface RegionCommitmentArgs { /** * Specifies whether to enable automatic renewal for the commitment. * The default value is false if not specified. * If the field is set to true, the commitment will be automatically renewed for either * one or three years according to the terms of the existing commitment. */ autoRenew?: pulumi.Input<boolean>; /** * The category of the commitment. Category MACHINE specifies commitments composed of * machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE * specifies commitments composed of software licenses, listed in licenseResources. * Note that only MACHINE commitments should have a Type specified. * Possible values are: `LICENSE`, `MACHINE`. */ category?: pulumi.Input<string>; /** * An optional description of this resource. */ description?: pulumi.Input<string>; /** * Specifies the already existing reservations to attach to the Commitment. */ existingReservations?: pulumi.Input<string>; /** * The license specification required as part of a license commitment. * Structure is documented below. */ licenseResource?: pulumi.Input<inputs.compute.RegionCommitmentLicenseResource>; /** * Name of the resource. The name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input<string>; /** * The plan for this commitment, which determines duration and discount rate. * The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). * Possible values are: `TWELVE_MONTH`, `THIRTY_SIX_MONTH`. */ plan: pulumi.Input<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * URL of the region where this commitment may be used. */ region?: pulumi.Input<string>; /** * A list of commitment amounts for particular resources. * Note that VCPU and MEMORY resource commitments must occur together. * Structure is documented below. */ resources?: pulumi.Input<pulumi.Input<inputs.compute.RegionCommitmentResource>[]>; /** * The type of commitment, which affects the discount rate and the eligible resources. * The type could be one of the following value: `MEMORY_OPTIMIZED`, `ACCELERATOR_OPTIMIZED`, * `GENERAL_PURPOSE_N1`, `GENERAL_PURPOSE_N2`, `GENERAL_PURPOSE_N2D`, `GENERAL_PURPOSE_E2`, * `GENERAL_PURPOSE_T2D`, `GENERAL_PURPOSE_C3`, `COMPUTE_OPTIMIZED_C2`, `COMPUTE_OPTIMIZED_C2D` and * `GRAPHICS_OPTIMIZED_G2` */ type?: pulumi.Input<string>; }