pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/RegionCommitment

RegionCommitment

class RegionCommitment : KotlinCustomResource

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:

Example Usage

Compute Region Commitment Basic

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",
        },
    ],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
foobar = gcp.compute.RegionCommitment("foobar",
    name="my-region-commitment",
    plan="THIRTY_SIX_MONTH",
    resources=[
        {
            "type": "VCPU",
            "amount": "4",
        },
        {
            "type": "MEMORY",
            "amount": "9",
        },
    ])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var foobar = new Gcp.Compute.RegionCommitment("foobar", new()
    {
        Name = "my-region-commitment",
        Plan = "THIRTY_SIX_MONTH",
        Resources = new[]
        {
            new Gcp.Compute.Inputs.RegionCommitmentResourceArgs
            {
                Type = "VCPU",
                Amount = "4",
            },
            new Gcp.Compute.Inputs.RegionCommitmentResourceArgs
            {
                Type = "MEMORY",
                Amount = "9",
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionCommitment(ctx, "foobar", &compute.RegionCommitmentArgs{
			Name: pulumi.String("my-region-commitment"),
			Plan: pulumi.String("THIRTY_SIX_MONTH"),
			Resources: compute.RegionCommitmentResourceArray{
				&compute.RegionCommitmentResourceArgs{
					Type:   pulumi.String("VCPU"),
					Amount: pulumi.String("4"),
				},
				&compute.RegionCommitmentResourceArgs{
					Type:   pulumi.String("MEMORY"),
					Amount: pulumi.String("9"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionCommitment;
import com.pulumi.gcp.compute.RegionCommitmentArgs;
import com.pulumi.gcp.compute.inputs.RegionCommitmentResourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var foobar = new RegionCommitment("foobar", RegionCommitmentArgs.builder()
            .name("my-region-commitment")
            .plan("THIRTY_SIX_MONTH")
            .resources(
                RegionCommitmentResourceArgs.builder()
                    .type("VCPU")
                    .amount("4")
                    .build(),
                RegionCommitmentResourceArgs.builder()
                    .type("MEMORY")
                    .amount("9")
                    .build())
            .build());
    }
}
Content copied to clipboard
resources:
  foobar:
    type: gcp:compute:RegionCommitment
    properties:
      name: my-region-commitment
      plan: THIRTY_SIX_MONTH
      resources:
        - type: VCPU
          amount: '4'
        - type: MEMORY
          amount: '9'
Content copied to clipboard

Compute Region Commitment Full

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",
        },
    ],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
foobar = gcp.compute.RegionCommitment("foobar",
    name="my-full-commitment",
    description="some description",
    plan="THIRTY_SIX_MONTH",
    type="MEMORY_OPTIMIZED",
    category="MACHINE",
    auto_renew=True,
    resources=[
        {
            "type": "VCPU",
            "amount": "4",
        },
        {
            "type": "MEMORY",
            "amount": "9",
        },
    ])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var foobar = new Gcp.Compute.RegionCommitment("foobar", new()
    {
        Name = "my-full-commitment",
        Description = "some description",
        Plan = "THIRTY_SIX_MONTH",
        Type = "MEMORY_OPTIMIZED",
        Category = "MACHINE",
        AutoRenew = true,
        Resources = new[]
        {
            new Gcp.Compute.Inputs.RegionCommitmentResourceArgs
            {
                Type = "VCPU",
                Amount = "4",
            },
            new Gcp.Compute.Inputs.RegionCommitmentResourceArgs
            {
                Type = "MEMORY",
                Amount = "9",
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionCommitment(ctx, "foobar", &compute.RegionCommitmentArgs{
			Name:        pulumi.String("my-full-commitment"),
			Description: pulumi.String("some description"),
			Plan:        pulumi.String("THIRTY_SIX_MONTH"),
			Type:        pulumi.String("MEMORY_OPTIMIZED"),
			Category:    pulumi.String("MACHINE"),
			AutoRenew:   pulumi.Bool(true),
			Resources: compute.RegionCommitmentResourceArray{
				&compute.RegionCommitmentResourceArgs{
					Type:   pulumi.String("VCPU"),
					Amount: pulumi.String("4"),
				},
				&compute.RegionCommitmentResourceArgs{
					Type:   pulumi.String("MEMORY"),
					Amount: pulumi.String("9"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionCommitment;
import com.pulumi.gcp.compute.RegionCommitmentArgs;
import com.pulumi.gcp.compute.inputs.RegionCommitmentResourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var foobar = new RegionCommitment("foobar", RegionCommitmentArgs.builder()
            .name("my-full-commitment")
            .description("some description")
            .plan("THIRTY_SIX_MONTH")
            .type("MEMORY_OPTIMIZED")
            .category("MACHINE")
            .autoRenew(true)
            .resources(
                RegionCommitmentResourceArgs.builder()
                    .type("VCPU")
                    .amount("4")
                    .build(),
                RegionCommitmentResourceArgs.builder()
                    .type("MEMORY")
                    .amount("9")
                    .build())
            .build());
    }
}
Content copied to clipboard
resources:
  foobar:
    type: gcp:compute:RegionCommitment
    properties:
      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'
Content copied to clipboard

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:

$ pulumi import gcp:compute/regionCommitment:RegionCommitment default projects/{{project}}/regions/{{region}}/commitments/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/regionCommitment:RegionCommitment default {{project}}/{{region}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/regionCommitment:RegionCommitment default {{region}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/regionCommitment:RegionCommitment default {{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val autoRenew: Output<Boolean>

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.

Link copied to clipboard
val category: Output<String>

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.

Link copied to clipboard
val commitmentId: Output<Int>

Unique identifier for the resource.

Link copied to clipboard
val creationTimestamp: Output<String>

Creation timestamp in RFC3339 text format.

Link copied to clipboard
val description: Output<String>?

An optional description of this resource.

Link copied to clipboard
val endTimestamp: Output<String>

Commitment end time in RFC3339 text format.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val licenseResource: Output<RegionCommitmentLicenseResource>?

The license specification required as part of a license commitment. Structure is documented below.

Link copied to clipboard
val name: Output<String>

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.

Link copied to clipboard
val plan: 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.

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val region: Output<String>

URL of the region where this commitment may be used.

Link copied to clipboard
val resources: Output<List<RegionCommitmentResource>>?

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. Structure is documented below.

Link copied to clipboard
val selfLink: Output<String>

The URI of the created resource.

Link copied to clipboard
val startTimestamp: Output<String>

Commitment start time in RFC3339 text format.

Link copied to clipboard
val status: Output<String>

Status of the commitment with regards to eventual expiration (each commitment has an end date defined).

Link copied to clipboard
val statusMessage: Output<String>

A human-readable explanation of the status.

Link copied to clipboard
val type: 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

Link copied to clipboard
val urn: Output<String>