Skip to content

Latest commit

 

History

History
3240 lines (2005 loc) · 150 KB

googleComputeImage.typescript.md

File metadata and controls

3240 lines (2005 loc) · 150 KB

googleComputeImage Submodule

Constructs

GoogleComputeImage

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

Initializers

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

new googleComputeImage.GoogleComputeImage(scope: Construct, id: string, config: GoogleComputeImageConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleComputeImageConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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".
putGuestOsFeatures No description.
putImageEncryptionKey No description.
putRawDisk No description.
putTimeouts No description.
resetDescription No description.
resetDiskSizeGb No description.
resetFamily No description.
resetGuestOsFeatures No description.
resetId No description.
resetImageEncryptionKey No description.
resetLabels No description.
resetLicenses No description.
resetProject No description.
resetRawDisk No description.
resetSourceDisk No description.
resetSourceImage No description.
resetSourceSnapshot No description.
resetStorageLocations No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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


indexOptional
  • 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".

idRequired
  • Type: string

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


putGuestOsFeatures
public putGuestOsFeatures(value: IResolvable | GoogleComputeImageGuestOsFeatures[]): void
valueRequired

putImageEncryptionKey
public putImageEncryptionKey(value: GoogleComputeImageImageEncryptionKey): void
valueRequired

putRawDisk
public putRawDisk(value: GoogleComputeImageRawDisk): void
valueRequired

putTimeouts
public putTimeouts(value: GoogleComputeImageTimeouts): void
valueRequired

resetDescription
public resetDescription(): void
resetDiskSizeGb
public resetDiskSizeGb(): void
resetFamily
public resetFamily(): void
resetGuestOsFeatures
public resetGuestOsFeatures(): void
resetId
public resetId(): void
resetImageEncryptionKey
public resetImageEncryptionKey(): void
resetLabels
public resetLabels(): void
resetLicenses
public resetLicenses(): void
resetProject
public resetProject(): void
resetRawDisk
public resetRawDisk(): void
resetSourceDisk
public resetSourceDisk(): void
resetSourceImage
public resetSourceImage(): void
resetSourceSnapshot
public resetSourceSnapshot(): void
resetStorageLocations
public resetStorageLocations(): void
resetTimeouts
public resetTimeouts(): 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 GoogleComputeImage resource upon running "cdktf plan ".

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

googleComputeImage.GoogleComputeImage.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.

xRequired
  • Type: any

Any object.


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

googleComputeImage.GoogleComputeImage.isTerraformElement(x: any)
xRequired
  • Type: any

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

googleComputeImage.GoogleComputeImage.isTerraformResource(x: any)
xRequired
  • Type: any

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

googleComputeImage.GoogleComputeImage.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing GoogleComputeImage that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleComputeImage 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.
archiveSizeBytes number No description.
creationTimestamp string No description.
effectiveLabels cdktf.StringMap No description.
guestOsFeatures GoogleComputeImageGuestOsFeaturesList No description.
imageEncryptionKey GoogleComputeImageImageEncryptionKeyOutputReference No description.
labelFingerprint string No description.
rawDisk GoogleComputeImageRawDiskOutputReference No description.
selfLink string No description.
terraformLabels cdktf.StringMap No description.
timeouts GoogleComputeImageTimeoutsOutputReference No description.
descriptionInput string No description.
diskSizeGbInput number No description.
familyInput string No description.
guestOsFeaturesInput cdktf.IResolvable | GoogleComputeImageGuestOsFeatures[] No description.
idInput string No description.
imageEncryptionKeyInput GoogleComputeImageImageEncryptionKey No description.
labelsInput {[ key: string ]: string} No description.
licensesInput string[] No description.
nameInput string No description.
projectInput string No description.
rawDiskInput GoogleComputeImageRawDisk No description.
sourceDiskInput string No description.
sourceImageInput string No description.
sourceSnapshotInput string No description.
storageLocationsInput string[] No description.
timeoutsInput cdktf.IResolvable | GoogleComputeImageTimeouts No description.
description string No description.
diskSizeGb number No description.
family string No description.
id string No description.
labels {[ key: string ]: string} No description.
licenses string[] No description.
name string No description.
project string No description.
sourceDisk string No description.
sourceImage string No description.
sourceSnapshot string No description.
storageLocations string[] No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

archiveSizeBytesRequired
public readonly archiveSizeBytes: number;
  • Type: number

creationTimestampRequired
public readonly creationTimestamp: string;
  • Type: string

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktf.StringMap

guestOsFeaturesRequired
public readonly guestOsFeatures: GoogleComputeImageGuestOsFeaturesList;

imageEncryptionKeyRequired
public readonly imageEncryptionKey: GoogleComputeImageImageEncryptionKeyOutputReference;

labelFingerprintRequired
public readonly labelFingerprint: string;
  • Type: string

rawDiskRequired
public readonly rawDisk: GoogleComputeImageRawDiskOutputReference;

selfLinkRequired
public readonly selfLink: string;
  • Type: string

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktf.StringMap

timeoutsRequired
public readonly timeouts: GoogleComputeImageTimeoutsOutputReference;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

diskSizeGbInputOptional
public readonly diskSizeGbInput: number;
  • Type: number

familyInputOptional
public readonly familyInput: string;
  • Type: string

guestOsFeaturesInputOptional
public readonly guestOsFeaturesInput: IResolvable | GoogleComputeImageGuestOsFeatures[];

idInputOptional
public readonly idInput: string;
  • Type: string

imageEncryptionKeyInputOptional
public readonly imageEncryptionKeyInput: GoogleComputeImageImageEncryptionKey;

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

licensesInputOptional
public readonly licensesInput: string[];
  • Type: string[]

nameInputOptional
public readonly nameInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

rawDiskInputOptional
public readonly rawDiskInput: GoogleComputeImageRawDisk;

sourceDiskInputOptional
public readonly sourceDiskInput: string;
  • Type: string

sourceImageInputOptional
public readonly sourceImageInput: string;
  • Type: string

sourceSnapshotInputOptional
public readonly sourceSnapshotInput: string;
  • Type: string

storageLocationsInputOptional
public readonly storageLocationsInput: string[];
  • Type: string[]

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleComputeImageTimeouts;

descriptionRequired
public readonly description: string;
  • Type: string

diskSizeGbRequired
public readonly diskSizeGb: number;
  • Type: number

familyRequired
public readonly family: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

licensesRequired
public readonly licenses: string[];
  • Type: string[]

nameRequired
public readonly name: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

sourceDiskRequired
public readonly sourceDisk: string;
  • Type: string

sourceImageRequired
public readonly sourceImage: string;
  • Type: string

sourceSnapshotRequired
public readonly sourceSnapshot: string;
  • Type: string

storageLocationsRequired
public readonly storageLocations: string[];
  • Type: string[]

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleComputeImageConfig

Initializer

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

const googleComputeImageConfig: googleComputeImage.GoogleComputeImageConfig = { ... }

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;
description string An optional description of this resource. Provide this property when you create the resource.
diskSizeGb number Size of the image when restored onto a persistent disk (in GB).
family string The name of the image family to which this image belongs.
guestOsFeatures cdktf.IResolvable | GoogleComputeImageGuestOsFeatures[] guest_os_features block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#id GoogleComputeImage#id}.
imageEncryptionKey GoogleComputeImageImageEncryptionKey image_encryption_key block.
labels {[ key: string ]: string} Labels to apply to this Image.
licenses string[] Any applicable license URI.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#project GoogleComputeImage#project}.
rawDisk GoogleComputeImageRawDisk raw_disk block.
sourceDisk string The source disk to create this image based on.
sourceImage string URL of the source image used to create this image.
sourceSnapshot string URL of the source snapshot used to create this image.
storageLocations string[] Cloud Storage bucket storage location of the image (regional or multi-regional). Reference link: https://cloud.google.com/compute/docs/reference/rest/v1/images.
timeouts GoogleComputeImageTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

nameRequired
public readonly name: string;
  • Type: string

Name of the resource;

provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, 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.17.0/docs/resources/google_compute_image#name GoogleComputeImage#name}


descriptionOptional
public readonly description: string;
  • Type: string

An optional description of this resource. Provide this property when you create the resource.

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


diskSizeGbOptional
public readonly diskSizeGb: number;
  • Type: number

Size of the image when restored onto a persistent disk (in GB).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#disk_size_gb GoogleComputeImage#disk_size_gb}


familyOptional
public readonly family: string;
  • Type: string

The name of the image family to which this image belongs.

You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#family GoogleComputeImage#family}


guestOsFeaturesOptional
public readonly guestOsFeatures: IResolvable | GoogleComputeImageGuestOsFeatures[];

guest_os_features block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#guest_os_features GoogleComputeImage#guest_os_features}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#id GoogleComputeImage#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.


imageEncryptionKeyOptional
public readonly imageEncryptionKey: GoogleComputeImageImageEncryptionKey;

image_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#image_encryption_key GoogleComputeImage#image_encryption_key}


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Labels to apply to this Image.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#labels GoogleComputeImage#labels}


licensesOptional
public readonly licenses: string[];
  • Type: string[]

Any applicable license URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#licenses GoogleComputeImage#licenses}


projectOptional
public readonly project: string;
  • Type: string

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


rawDiskOptional
public readonly rawDisk: GoogleComputeImageRawDisk;

raw_disk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#raw_disk GoogleComputeImage#raw_disk}


sourceDiskOptional
public readonly sourceDisk: string;
  • Type: string

The source disk to create this image based on.

You must provide either this property or the rawDisk.source property but not both to create an image.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#source_disk GoogleComputeImage#source_disk}


sourceImageOptional
public readonly sourceImage: string;
  • Type: string

URL of the source image used to create this image.

In order to create an image, you must provide the full or partial URL of one of the following:

  • The selfLink URL
  • This property
  • The rawDisk.source URL
  • The sourceDisk URL

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#source_image GoogleComputeImage#source_image}


sourceSnapshotOptional
public readonly sourceSnapshot: string;
  • Type: string

URL of the source snapshot used to create this image.

In order to create an image, you must provide the full or partial URL of one of the following:

  • The selfLink URL
  • This property
  • The sourceImage URL
  • The rawDisk.source URL
  • The sourceDisk URL

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#source_snapshot GoogleComputeImage#source_snapshot}


storageLocationsOptional
public readonly storageLocations: string[];
  • Type: string[]

Cloud Storage bucket storage location of the image (regional or multi-regional). Reference link: https://cloud.google.com/compute/docs/reference/rest/v1/images.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#storage_locations GoogleComputeImage#storage_locations}


timeoutsOptional
public readonly timeouts: GoogleComputeImageTimeouts;

timeouts block.

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


GoogleComputeImageGuestOsFeatures

Initializer

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

const googleComputeImageGuestOsFeatures: googleComputeImage.GoogleComputeImageGuestOsFeatures = { ... }

Properties

Name Type Description
type string The type of supported feature.

typeRequired
public readonly type: string;
  • Type: string

The type of supported feature.

Read Enabling guest operating system features to see a list of available options. Possible values: ["MULTI_IP_SUBNET", "SECURE_BOOT", "SEV_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", "WINDOWS", "GVNIC", "IDPF", "SEV_LIVE_MIGRATABLE", "SEV_SNP_CAPABLE", "SUSPEND_RESUME_COMPATIBLE", "TDX_CAPABLE", "SEV_LIVE_MIGRATABLE_V2"]

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


GoogleComputeImageImageEncryptionKey

Initializer

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

const googleComputeImageImageEncryptionKey: googleComputeImage.GoogleComputeImageImageEncryptionKey = { ... }

Properties

Name Type Description
kmsKeySelfLink string The self link of the encryption key that is stored in Google Cloud KMS.
kmsKeyServiceAccount string The service account being used for the encryption request for the given KMS key.

kmsKeySelfLinkOptional
public readonly kmsKeySelfLink: string;
  • Type: string

The self link of the encryption key that is stored in Google Cloud KMS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#kms_key_self_link GoogleComputeImage#kms_key_self_link}


kmsKeyServiceAccountOptional
public readonly kmsKeyServiceAccount: string;
  • Type: string

The service account being used for the encryption request for the given KMS key.

If absent, the Compute Engine default service account is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#kms_key_service_account GoogleComputeImage#kms_key_service_account}


GoogleComputeImageRawDisk

Initializer

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

const googleComputeImageRawDisk: googleComputeImage.GoogleComputeImageRawDisk = { ... }

Properties

Name Type Description
source string The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.
containerType string The format used to encode and transmit the block device, which should be TAR.
sha1 string An optional SHA1 checksum of the disk image before unpackaging.

sourceRequired
public readonly source: string;
  • Type: string

The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#source GoogleComputeImage#source}


containerTypeOptional
public readonly containerType: string;
  • Type: string

The format used to encode and transmit the block device, which should be TAR.

This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. Default value: "TAR" Possible values: ["TAR"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#container_type GoogleComputeImage#container_type}


sha1Optional
public readonly sha1: string;
  • Type: string

An optional SHA1 checksum of the disk image before unpackaging.

This is provided by the client when the disk image is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#sha1 GoogleComputeImage#sha1}


GoogleComputeImageTimeouts

Initializer

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

const googleComputeImageTimeouts: googleComputeImage.GoogleComputeImageTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#create GoogleComputeImage#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#delete GoogleComputeImage#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#update GoogleComputeImage#update}.

createOptional
public readonly create: string;
  • Type: string

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


deleteOptional
public readonly delete: string;
  • Type: string

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


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_compute_image#update GoogleComputeImage#update}.


Classes

GoogleComputeImageGuestOsFeaturesList

Initializers

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

new googleComputeImage.GoogleComputeImageGuestOsFeaturesList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): GoogleComputeImageGuestOsFeaturesOutputReference
indexRequired
  • 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 | GoogleComputeImageGuestOsFeatures[] No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GoogleComputeImageGuestOsFeatures[];

GoogleComputeImageGuestOsFeaturesOutputReference

Initializers

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

new googleComputeImage.GoogleComputeImageGuestOsFeaturesOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
typeInput string No description.
type string No description.
internalValue cdktf.IResolvable | GoogleComputeImageGuestOsFeatures No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

typeInputOptional
public readonly typeInput: string;
  • Type: string

typeRequired
public readonly type: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GoogleComputeImageGuestOsFeatures;

GoogleComputeImageImageEncryptionKeyOutputReference

Initializers

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

new googleComputeImage.GoogleComputeImageImageEncryptionKeyOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetKmsKeySelfLink No description.
resetKmsKeyServiceAccount No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetKmsKeySelfLink
public resetKmsKeySelfLink(): void
resetKmsKeyServiceAccount
public resetKmsKeyServiceAccount(): 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.
kmsKeySelfLinkInput string No description.
kmsKeyServiceAccountInput string No description.
kmsKeySelfLink string No description.
kmsKeyServiceAccount string No description.
internalValue GoogleComputeImageImageEncryptionKey No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

kmsKeySelfLinkInputOptional
public readonly kmsKeySelfLinkInput: string;
  • Type: string

kmsKeyServiceAccountInputOptional
public readonly kmsKeyServiceAccountInput: string;
  • Type: string

kmsKeySelfLinkRequired
public readonly kmsKeySelfLink: string;
  • Type: string

kmsKeyServiceAccountRequired
public readonly kmsKeyServiceAccount: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleComputeImageImageEncryptionKey;

GoogleComputeImageRawDiskOutputReference

Initializers

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

new googleComputeImage.GoogleComputeImageRawDiskOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetContainerType No description.
resetSha1 No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetContainerType
public resetContainerType(): void
resetSha1
public resetSha1(): 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.
containerTypeInput string No description.
sha1Input string No description.
sourceInput string No description.
containerType string No description.
sha1 string No description.
source string No description.
internalValue GoogleComputeImageRawDisk No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

containerTypeInputOptional
public readonly containerTypeInput: string;
  • Type: string

sha1InputOptional
public readonly sha1Input: string;
  • Type: string

sourceInputOptional
public readonly sourceInput: string;
  • Type: string

containerTypeRequired
public readonly containerType: string;
  • Type: string

sha1Required
public readonly sha1: string;
  • Type: string

sourceRequired
public readonly source: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleComputeImageRawDisk;

GoogleComputeImageTimeoutsOutputReference

Initializers

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

new googleComputeImage.GoogleComputeImageTimeoutsOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetUpdate No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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
resetUpdate
public resetUpdate(): 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.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | GoogleComputeImageTimeouts No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GoogleComputeImageTimeouts;