`googleComputeRegionCommitment` Submodule

Constructs

GoogleComputeRegionCommitment

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment google_compute_region_commitment}.

Initializers

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

new googleComputeRegionCommitment.GoogleComputeRegionCommitment(scope: Construct, id: string, config: GoogleComputeRegionCommitmentConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GoogleComputeRegionCommitmentConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GoogleComputeRegionCommitmentConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putLicenseResource`	No description.
`putResources`	No description.
`putTimeouts`	No description.
`resetAutoRenew`	No description.
`resetCategory`	No description.
`resetDescription`	No description.
`resetExistingReservations`	No description.
`resetId`	No description.
`resetLicenseResource`	No description.
`resetProject`	No description.
`resetRegion`	No description.
`resetResources`	No description.
`resetTimeouts`	No description.
`resetType`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putLicenseResource`

public putLicenseResource(value: GoogleComputeRegionCommitmentLicenseResource): void

`value`^Required

Type: GoogleComputeRegionCommitmentLicenseResource

`putResources`

public putResources(value: IResolvable | GoogleComputeRegionCommitmentResources[]): void

`value`^Required

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentResources[]

`putTimeouts`

public putTimeouts(value: GoogleComputeRegionCommitmentTimeouts): void

`value`^Required

Type: GoogleComputeRegionCommitmentTimeouts

`resetAutoRenew`

public resetAutoRenew(): void

`resetCategory`

public resetCategory(): void

`resetDescription`

public resetDescription(): void

`resetExistingReservations`

public resetExistingReservations(): void

`resetId`

public resetId(): void

`resetLicenseResource`

public resetLicenseResource(): void

`resetProject`

public resetProject(): void

`resetRegion`

public resetRegion(): void

`resetResources`

public resetResources(): void

`resetTimeouts`

public resetTimeouts(): void

`resetType`

public resetType(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a GoogleComputeRegionCommitment resource upon running "cdktf plan ".

`isConstruct`

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

googleComputeRegionCommitment.GoogleComputeRegionCommitment.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

googleComputeRegionCommitment.GoogleComputeRegionCommitment.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

googleComputeRegionCommitment.GoogleComputeRegionCommitment.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

googleComputeRegionCommitment.GoogleComputeRegionCommitment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleComputeRegionCommitment resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the GoogleComputeRegionCommitment to import.

`importFromId`^Required

Type: string

The id of the existing GoogleComputeRegionCommitment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleComputeRegionCommitment to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`commitmentId`	`number`	No description.
`creationTimestamp`	`string`	No description.
`endTimestamp`	`string`	No description.
`licenseResource`	`GoogleComputeRegionCommitmentLicenseResourceOutputReference`	No description.
`resources`	`GoogleComputeRegionCommitmentResourcesList`	No description.
`selfLink`	`string`	No description.
`startTimestamp`	`string`	No description.
`status`	`string`	No description.
`statusMessage`	`string`	No description.
`timeouts`	`GoogleComputeRegionCommitmentTimeoutsOutputReference`	No description.
`autoRenewInput`	`boolean \| cdktf.IResolvable`	No description.
`categoryInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`existingReservationsInput`	`string`	No description.
`idInput`	`string`	No description.
`licenseResourceInput`	`GoogleComputeRegionCommitmentLicenseResource`	No description.
`nameInput`	`string`	No description.
`planInput`	`string`	No description.
`projectInput`	`string`	No description.
`regionInput`	`string`	No description.
`resourcesInput`	`cdktf.IResolvable \| GoogleComputeRegionCommitmentResources[]`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleComputeRegionCommitmentTimeouts`	No description.
`typeInput`	`string`	No description.
`autoRenew`	`boolean \| cdktf.IResolvable`	No description.
`category`	`string`	No description.
`description`	`string`	No description.
`existingReservations`	`string`	No description.
`id`	`string`	No description.
`name`	`string`	No description.
`plan`	`string`	No description.
`project`	`string`	No description.
`region`	`string`	No description.
`type`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`commitmentId`^Required

public readonly commitmentId: number;

Type: number

`creationTimestamp`^Required

public readonly creationTimestamp: string;

Type: string

`endTimestamp`^Required

public readonly endTimestamp: string;

Type: string

`licenseResource`^Required

public readonly licenseResource: GoogleComputeRegionCommitmentLicenseResourceOutputReference;

Type: GoogleComputeRegionCommitmentLicenseResourceOutputReference

`resources`^Required

public readonly resources: GoogleComputeRegionCommitmentResourcesList;

Type: GoogleComputeRegionCommitmentResourcesList

`selfLink`^Required

public readonly selfLink: string;

Type: string

`startTimestamp`^Required

public readonly startTimestamp: string;

Type: string

`status`^Required

public readonly status: string;

Type: string

`statusMessage`^Required

public readonly statusMessage: string;

Type: string

`timeouts`^Required

public readonly timeouts: GoogleComputeRegionCommitmentTimeoutsOutputReference;

Type: GoogleComputeRegionCommitmentTimeoutsOutputReference

`autoRenewInput`^Optional

public readonly autoRenewInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`categoryInput`^Optional

public readonly categoryInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`existingReservationsInput`^Optional

public readonly existingReservationsInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`licenseResourceInput`^Optional

public readonly licenseResourceInput: GoogleComputeRegionCommitmentLicenseResource;

Type: GoogleComputeRegionCommitmentLicenseResource

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`planInput`^Optional

public readonly planInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`regionInput`^Optional

public readonly regionInput: string;

Type: string

`resourcesInput`^Optional

public readonly resourcesInput: IResolvable | GoogleComputeRegionCommitmentResources[];

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentResources[]

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleComputeRegionCommitmentTimeouts;

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentTimeouts

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`autoRenew`^Required

public readonly autoRenew: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`category`^Required

public readonly category: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`existingReservations`^Required

public readonly existingReservations: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`plan`^Required

public readonly plan: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`region`^Required

public readonly region: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleComputeRegionCommitmentConfig

Initializer

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

const googleComputeRegionCommitmentConfig: googleComputeRegionCommitment.GoogleComputeRegionCommitmentConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`name`	`string`	Name of the resource.
`plan`	`string`	The plan for this commitment, which determines duration and discount rate.
`autoRenew`	`boolean \| cdktf.IResolvable`	Specifies whether to enable automatic renewal for the commitment.
`category`	`string`	The category of the commitment.
`description`	`string`	An optional description of this resource.
`existingReservations`	`string`	Specifies the already existing reservations to attach to the Commitment.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#id GoogleComputeRegionCommitment#id}.
`licenseResource`	`GoogleComputeRegionCommitmentLicenseResource`	license_resource block.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#project GoogleComputeRegionCommitment#project}.
`region`	`string`	URL of the region where this commitment may be used.
`resources`	`cdktf.IResolvable \| GoogleComputeRegionCommitmentResources[]`	resources block.
`timeouts`	`GoogleComputeRegionCommitmentTimeouts`	timeouts block.
`type`	`string`	The type of commitment, which affects the discount rate and the eligible resources.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#name GoogleComputeRegionCommitment#name}

`plan`^Required

public readonly plan: string;

Type: 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: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#plan GoogleComputeRegionCommitment#plan}

`autoRenew`^Optional

public readonly autoRenew: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#auto_renew GoogleComputeRegionCommitment#auto_renew}

`category`^Optional

public readonly category: string;

Type: 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: ["LICENSE", "MACHINE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#category GoogleComputeRegionCommitment#category}

`description`^Optional

public readonly description: string;

Type: string

An optional description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#description GoogleComputeRegionCommitment#description}

`existingReservations`^Optional

public readonly existingReservations: string;

Type: string

Specifies the already existing reservations to attach to the Commitment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#existing_reservations GoogleComputeRegionCommitment#existing_reservations}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#id GoogleComputeRegionCommitment#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`licenseResource`^Optional

public readonly licenseResource: GoogleComputeRegionCommitmentLicenseResource;

Type: GoogleComputeRegionCommitmentLicenseResource

license_resource block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#license_resource GoogleComputeRegionCommitment#license_resource}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#project GoogleComputeRegionCommitment#project}.

`region`^Optional

public readonly region: string;

Type: string

URL of the region where this commitment may be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#region GoogleComputeRegionCommitment#region}

`resources`^Optional

public readonly resources: IResolvable | GoogleComputeRegionCommitmentResources[];

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentResources[]

resources block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#resources GoogleComputeRegionCommitment#resources}

`timeouts`^Optional

public readonly timeouts: GoogleComputeRegionCommitmentTimeouts;

Type: GoogleComputeRegionCommitmentTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#timeouts GoogleComputeRegionCommitment#timeouts}

`type`^Optional

public readonly type: string;

Type: 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'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#type GoogleComputeRegionCommitment#type}

GoogleComputeRegionCommitmentLicenseResource

Initializer

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

const googleComputeRegionCommitmentLicenseResource: googleComputeRegionCommitment.GoogleComputeRegionCommitmentLicenseResource = { ... }

Properties

Name	Type	Description
`license`	`string`	Any applicable license URI.
`amount`	`string`	The number of licenses purchased.
`coresPerLicense`	`string`	Specifies the core range of the instance for which this license applies.

`license`^Required

public readonly license: string;

Type: string

Any applicable license URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#license GoogleComputeRegionCommitment#license}

`amount`^Optional

public readonly amount: string;

Type: string

The number of licenses purchased.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#amount GoogleComputeRegionCommitment#amount}

`coresPerLicense`^Optional

public readonly coresPerLicense: string;

Type: string

Specifies the core range of the instance for which this license applies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#cores_per_license GoogleComputeRegionCommitment#cores_per_license}

GoogleComputeRegionCommitmentResources

Initializer

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

const googleComputeRegionCommitmentResources: googleComputeRegionCommitment.GoogleComputeRegionCommitmentResources = { ... }

Properties

Name	Type	Description
`acceleratorType`	`string`	Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
`amount`	`string`	The amount of the resource purchased (in a type-dependent unit, such as bytes).
`type`	`string`	Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.

`acceleratorType`^Optional

public readonly acceleratorType: string;

Type: string

Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#accelerator_type GoogleComputeRegionCommitment#accelerator_type}

`amount`^Optional

public readonly amount: string;

Type: string

The amount of the resource purchased (in a type-dependent unit, such as bytes).

For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#amount GoogleComputeRegionCommitment#amount}

`type`^Optional

public readonly type: string;

Type: string

Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#type GoogleComputeRegionCommitment#type}

GoogleComputeRegionCommitmentTimeouts

Initializer

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

const googleComputeRegionCommitmentTimeouts: googleComputeRegionCommitment.GoogleComputeRegionCommitmentTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#create GoogleComputeRegionCommitment#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#delete GoogleComputeRegionCommitment#delete}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#create GoogleComputeRegionCommitment#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_region_commitment#delete GoogleComputeRegionCommitment#delete}.

Classes

GoogleComputeRegionCommitmentLicenseResourceOutputReference

Initializers

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

new googleComputeRegionCommitment.GoogleComputeRegionCommitmentLicenseResourceOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetAmount`	No description.
`resetCoresPerLicense`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetAmount`

public resetAmount(): void

`resetCoresPerLicense`

public resetCoresPerLicense(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`amountInput`	`string`	No description.
`coresPerLicenseInput`	`string`	No description.
`licenseInput`	`string`	No description.
`amount`	`string`	No description.
`coresPerLicense`	`string`	No description.
`license`	`string`	No description.
`internalValue`	`GoogleComputeRegionCommitmentLicenseResource`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`amountInput`^Optional

public readonly amountInput: string;

Type: string

`coresPerLicenseInput`^Optional

public readonly coresPerLicenseInput: string;

Type: string

`licenseInput`^Optional

public readonly licenseInput: string;

Type: string

`amount`^Required

public readonly amount: string;

Type: string

`coresPerLicense`^Required

public readonly coresPerLicense: string;

Type: string

`license`^Required

public readonly license: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleComputeRegionCommitmentLicenseResource;

Type: GoogleComputeRegionCommitmentLicenseResource

GoogleComputeRegionCommitmentResourcesList

Initializers

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

new googleComputeRegionCommitment.GoogleComputeRegionCommitmentResourcesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): GoogleComputeRegionCommitmentResourcesOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleComputeRegionCommitmentResources[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleComputeRegionCommitmentResources[];

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentResources[]

GoogleComputeRegionCommitmentResourcesOutputReference

Initializers

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

new googleComputeRegionCommitment.GoogleComputeRegionCommitmentResourcesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetAcceleratorType`	No description.
`resetAmount`	No description.
`resetType`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetAcceleratorType`

public resetAcceleratorType(): void

`resetAmount`

public resetAmount(): void

`resetType`

public resetType(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`acceleratorTypeInput`	`string`	No description.
`amountInput`	`string`	No description.
`typeInput`	`string`	No description.
`acceleratorType`	`string`	No description.
`amount`	`string`	No description.
`type`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleComputeRegionCommitmentResources`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`acceleratorTypeInput`^Optional

public readonly acceleratorTypeInput: string;

Type: string

`amountInput`^Optional

public readonly amountInput: string;

Type: string

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`acceleratorType`^Required

public readonly acceleratorType: string;

Type: string

`amount`^Required

public readonly amount: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleComputeRegionCommitmentResources;

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentResources

GoogleComputeRegionCommitmentTimeoutsOutputReference

Initializers

import { googleComputeRegionCommitment } from '@cdktf/provider-google-beta'

new googleComputeRegionCommitment.GoogleComputeRegionCommitmentTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetCreate`	No description.
`resetDelete`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetCreate`

public resetCreate(): void

`resetDelete`

public resetDelete(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`createInput`	`string`	No description.
`deleteInput`	`string`	No description.
`create`	`string`	No description.
`delete`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleComputeRegionCommitmentTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleComputeRegionCommitmentTimeouts;

Type: cdktf.IResolvable | GoogleComputeRegionCommitmentTimeouts

Files

googleComputeRegionCommitment.typescript.md

Latest commit

History

googleComputeRegionCommitment.typescript.md

File metadata and controls

googleComputeRegionCommitment Submodule

Constructs