`computeSnapshot` Submodule

Constructs

ComputeSnapshot

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot google_compute_snapshot}.

Initializers

import { computeSnapshot } from '@cdktf/provider-google'

new computeSnapshot.ComputeSnapshot(scope: Construct, id: string, config: ComputeSnapshotConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`ComputeSnapshotConfig`	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: ComputeSnapshotConfig

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".
`putSnapshotEncryptionKey`	No description.
`putSourceDiskEncryptionKey`	No description.
`putTimeouts`	No description.
`resetChainName`	No description.
`resetDescription`	No description.
`resetId`	No description.
`resetLabels`	No description.
`resetProject`	No description.
`resetSnapshotEncryptionKey`	No description.
`resetSourceDiskEncryptionKey`	No description.
`resetStorageLocations`	No description.
`resetTimeouts`	No description.
`resetZone`	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".

`putSnapshotEncryptionKey`

public putSnapshotEncryptionKey(value: ComputeSnapshotSnapshotEncryptionKey): void

`value`^Required

Type: ComputeSnapshotSnapshotEncryptionKey

`putSourceDiskEncryptionKey`

public putSourceDiskEncryptionKey(value: ComputeSnapshotSourceDiskEncryptionKey): void

`value`^Required

Type: ComputeSnapshotSourceDiskEncryptionKey

`putTimeouts`

public putTimeouts(value: ComputeSnapshotTimeouts): void

`value`^Required

Type: ComputeSnapshotTimeouts

`resetChainName`

public resetChainName(): void

`resetDescription`

public resetDescription(): void

`resetId`

public resetId(): void

`resetLabels`

public resetLabels(): void

`resetProject`

public resetProject(): void

`resetSnapshotEncryptionKey`

public resetSnapshotEncryptionKey(): void

`resetSourceDiskEncryptionKey`

public resetSourceDiskEncryptionKey(): void

`resetStorageLocations`

public resetStorageLocations(): void

`resetTimeouts`

public resetTimeouts(): void

`resetZone`

public resetZone(): 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 ComputeSnapshot resource upon running "cdktf plan ".

`isConstruct`

import { computeSnapshot } from '@cdktf/provider-google'

computeSnapshot.ComputeSnapshot.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 { computeSnapshot } from '@cdktf/provider-google'

computeSnapshot.ComputeSnapshot.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { computeSnapshot } from '@cdktf/provider-google'

computeSnapshot.ComputeSnapshot.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { computeSnapshot } from '@cdktf/provider-google'

computeSnapshot.ComputeSnapshot.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ComputeSnapshot 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 ComputeSnapshot to import.

`importFromId`^Required

Type: string

The id of the existing ComputeSnapshot that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#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 ComputeSnapshot 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.
`creationTimestamp`	`string`	No description.
`diskSizeGb`	`number`	No description.
`effectiveLabels`	`cdktf.StringMap`	No description.
`labelFingerprint`	`string`	No description.
`licenses`	`string[]`	No description.
`selfLink`	`string`	No description.
`snapshotEncryptionKey`	`ComputeSnapshotSnapshotEncryptionKeyOutputReference`	No description.
`snapshotId`	`number`	No description.
`sourceDiskEncryptionKey`	`ComputeSnapshotSourceDiskEncryptionKeyOutputReference`	No description.
`storageBytes`	`number`	No description.
`terraformLabels`	`cdktf.StringMap`	No description.
`timeouts`	`ComputeSnapshotTimeoutsOutputReference`	No description.
`chainNameInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`idInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`nameInput`	`string`	No description.
`projectInput`	`string`	No description.
`snapshotEncryptionKeyInput`	`ComputeSnapshotSnapshotEncryptionKey`	No description.
`sourceDiskEncryptionKeyInput`	`ComputeSnapshotSourceDiskEncryptionKey`	No description.
`sourceDiskInput`	`string`	No description.
`storageLocationsInput`	`string[]`	No description.
`timeoutsInput`	`cdktf.IResolvable \| ComputeSnapshotTimeouts`	No description.
`zoneInput`	`string`	No description.
`chainName`	`string`	No description.
`description`	`string`	No description.
`id`	`string`	No description.
`labels`	`{[ key: string ]: string}`	No description.
`name`	`string`	No description.
`project`	`string`	No description.
`sourceDisk`	`string`	No description.
`storageLocations`	`string[]`	No description.
`zone`	`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[]

`creationTimestamp`^Required

public readonly creationTimestamp: string;

Type: string

`diskSizeGb`^Required

public readonly diskSizeGb: number;

Type: number

`effectiveLabels`^Required

public readonly effectiveLabels: StringMap;

Type: cdktf.StringMap

`labelFingerprint`^Required

public readonly labelFingerprint: string;

Type: string

`licenses`^Required

public readonly licenses: string[];

Type: string[]

`selfLink`^Required

public readonly selfLink: string;

Type: string

`snapshotEncryptionKey`^Required

public readonly snapshotEncryptionKey: ComputeSnapshotSnapshotEncryptionKeyOutputReference;

Type: ComputeSnapshotSnapshotEncryptionKeyOutputReference

`snapshotId`^Required

public readonly snapshotId: number;

Type: number

`sourceDiskEncryptionKey`^Required

public readonly sourceDiskEncryptionKey: ComputeSnapshotSourceDiskEncryptionKeyOutputReference;

Type: ComputeSnapshotSourceDiskEncryptionKeyOutputReference

`storageBytes`^Required

public readonly storageBytes: number;

Type: number

`terraformLabels`^Required

public readonly terraformLabels: StringMap;

Type: cdktf.StringMap

`timeouts`^Required

public readonly timeouts: ComputeSnapshotTimeoutsOutputReference;

Type: ComputeSnapshotTimeoutsOutputReference

`chainNameInput`^Optional

public readonly chainNameInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`labelsInput`^Optional

public readonly labelsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`snapshotEncryptionKeyInput`^Optional

public readonly snapshotEncryptionKeyInput: ComputeSnapshotSnapshotEncryptionKey;

Type: ComputeSnapshotSnapshotEncryptionKey

`sourceDiskEncryptionKeyInput`^Optional

public readonly sourceDiskEncryptionKeyInput: ComputeSnapshotSourceDiskEncryptionKey;

Type: ComputeSnapshotSourceDiskEncryptionKey

`sourceDiskInput`^Optional

public readonly sourceDiskInput: string;

Type: string

`storageLocationsInput`^Optional

public readonly storageLocationsInput: string[];

Type: string[]

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | ComputeSnapshotTimeouts;

Type: cdktf.IResolvable | ComputeSnapshotTimeouts

`zoneInput`^Optional

public readonly zoneInput: string;

Type: string

`chainName`^Required

public readonly chainName: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`labels`^Required

public readonly labels: {[ key: string ]: string};

Type: {[ key: string ]: string}

`name`^Required

public readonly name: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`sourceDisk`^Required

public readonly sourceDisk: string;

Type: string

`storageLocations`^Required

public readonly storageLocations: string[];

Type: string[]

`zone`^Required

public readonly zone: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ComputeSnapshotConfig

Initializer

import { computeSnapshot } from '@cdktf/provider-google'

const computeSnapshotConfig: computeSnapshot.ComputeSnapshotConfig = { ... }

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;
`sourceDisk`	`string`	A reference to the disk used to create this snapshot.
`chainName`	`string`	Creates the new snapshot in the snapshot chain labeled with the specified name.
`description`	`string`	An optional description of this resource.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#id ComputeSnapshot#id}.
`labels`	`{[ key: string ]: string}`	Labels to apply to this Snapshot.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#project ComputeSnapshot#project}.
`snapshotEncryptionKey`	`ComputeSnapshotSnapshotEncryptionKey`	snapshot_encryption_key block.
`sourceDiskEncryptionKey`	`ComputeSnapshotSourceDiskEncryptionKey`	source_disk_encryption_key block.
`storageLocations`	`string[]`	Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`timeouts`	`ComputeSnapshotTimeouts`	timeouts block.
`zone`	`string`	A reference to the zone where the disk is hosted.

`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;

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/6.33.0/docs/resources/compute_snapshot#name ComputeSnapshot#name}

`sourceDisk`^Required

public readonly sourceDisk: string;

Type: string

A reference to the disk used to create this snapshot.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#source_disk ComputeSnapshot#source_disk}

`chainName`^Optional

public readonly chainName: string;

Type: string

Creates the new snapshot in the snapshot chain labeled with the specified name.

The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#chain_name ComputeSnapshot#chain_name}

`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/6.33.0/docs/resources/compute_snapshot#description ComputeSnapshot#description}

`id`^Optional

public readonly id: string;

Type: string

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

`labels`^Optional

public readonly labels: {[ key: string ]: string};

Type: {[ key: string ]: string}

Labels to apply to this Snapshot.

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/6.33.0/docs/resources/compute_snapshot#labels ComputeSnapshot#labels}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#project ComputeSnapshot#project}.

`snapshotEncryptionKey`^Optional

public readonly snapshotEncryptionKey: ComputeSnapshotSnapshotEncryptionKey;

Type: ComputeSnapshotSnapshotEncryptionKey

snapshot_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#snapshot_encryption_key ComputeSnapshot#snapshot_encryption_key}

`sourceDiskEncryptionKey`^Optional

public readonly sourceDiskEncryptionKey: ComputeSnapshotSourceDiskEncryptionKey;

Type: ComputeSnapshotSourceDiskEncryptionKey

source_disk_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#source_disk_encryption_key ComputeSnapshot#source_disk_encryption_key}

`storageLocations`^Optional

public readonly storageLocations: string[];

Type: string[]

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#storage_locations ComputeSnapshot#storage_locations}

`timeouts`^Optional

public readonly timeouts: ComputeSnapshotTimeouts;

Type: ComputeSnapshotTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#timeouts ComputeSnapshot#timeouts}

`zone`^Optional

public readonly zone: string;

Type: string

A reference to the zone where the disk is hosted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#zone ComputeSnapshot#zone}

ComputeSnapshotSnapshotEncryptionKey

Initializer

import { computeSnapshot } from '@cdktf/provider-google'

const computeSnapshotSnapshotEncryptionKey: computeSnapshot.ComputeSnapshotSnapshotEncryptionKey = { ... }

Properties

Name	Type	Description
`kmsKeySelfLink`	`string`	The name of the encryption key that is stored in Google Cloud KMS.
`kmsKeyServiceAccount`	`string`	The service account used for the encryption request for the given KMS key.
`rawKey`	`string`	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`rsaEncryptedKey`	`string`	Specifies an encryption key stored in Google Cloud KMS, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

`kmsKeySelfLink`^Optional

public readonly kmsKeySelfLink: string;

Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#kms_key_self_link ComputeSnapshot#kms_key_self_link}

`kmsKeyServiceAccount`^Optional

public readonly kmsKeyServiceAccount: string;

Type: string

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

If absent, the Compute Engine Service Agent service account is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#kms_key_service_account ComputeSnapshot#kms_key_service_account}

`rawKey`^Optional

public readonly rawKey: string;

Type: string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#raw_key ComputeSnapshot#raw_key}

`rsaEncryptedKey`^Optional

public readonly rsaEncryptedKey: string;

Type: string

Specifies an encryption key stored in Google Cloud KMS, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#rsa_encrypted_key ComputeSnapshot#rsa_encrypted_key}

ComputeSnapshotSourceDiskEncryptionKey

Initializer

import { computeSnapshot } from '@cdktf/provider-google'

const computeSnapshotSourceDiskEncryptionKey: computeSnapshot.ComputeSnapshotSourceDiskEncryptionKey = { ... }

Properties

Name	Type	Description
`kmsKeySelfLink`	`string`	The name of the encryption key that is stored in Google Cloud KMS.
`kmsKeyServiceAccount`	`string`	The service account used for the encryption request for the given KMS key.
`rawKey`	`string`	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`rsaEncryptedKey`	`string`	Specifies an encryption key stored in Google Cloud KMS, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

`kmsKeySelfLink`^Optional

public readonly kmsKeySelfLink: string;

Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#kms_key_self_link ComputeSnapshot#kms_key_self_link}

`kmsKeyServiceAccount`^Optional

public readonly kmsKeyServiceAccount: string;

Type: string

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

If absent, the Compute Engine Service Agent service account is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#kms_key_service_account ComputeSnapshot#kms_key_service_account}

`rawKey`^Optional

public readonly rawKey: string;

Type: string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#raw_key ComputeSnapshot#raw_key}

`rsaEncryptedKey`^Optional

public readonly rsaEncryptedKey: string;

Type: string

Specifies an encryption key stored in Google Cloud KMS, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#rsa_encrypted_key ComputeSnapshot#rsa_encrypted_key}

ComputeSnapshotTimeouts

Initializer

import { computeSnapshot } from '@cdktf/provider-google'

const computeSnapshotTimeouts: computeSnapshot.ComputeSnapshotTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#create ComputeSnapshot#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#delete ComputeSnapshot#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#update ComputeSnapshot#update}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#create ComputeSnapshot#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#delete ComputeSnapshot#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_snapshot#update ComputeSnapshot#update}.

Classes

ComputeSnapshotSnapshotEncryptionKeyOutputReference

Initializers

import { computeSnapshot } from '@cdktf/provider-google'

new computeSnapshot.ComputeSnapshotSnapshotEncryptionKeyOutputReference(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.
`resetKmsKeySelfLink`	No description.
`resetKmsKeyServiceAccount`	No description.
`resetRawKey`	No description.
`resetRsaEncryptedKey`	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.

`resetKmsKeySelfLink`

public resetKmsKeySelfLink(): void

`resetKmsKeyServiceAccount`

public resetKmsKeyServiceAccount(): void

`resetRawKey`

public resetRawKey(): void

`resetRsaEncryptedKey`

public resetRsaEncryptedKey(): 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.
`sha256`	`string`	No description.
`kmsKeySelfLinkInput`	`string`	No description.
`kmsKeyServiceAccountInput`	`string`	No description.
`rawKeyInput`	`string`	No description.
`rsaEncryptedKeyInput`	`string`	No description.
`kmsKeySelfLink`	`string`	No description.
`kmsKeyServiceAccount`	`string`	No description.
`rawKey`	`string`	No description.
`rsaEncryptedKey`	`string`	No description.
`internalValue`	`ComputeSnapshotSnapshotEncryptionKey`	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

`sha256`^Required

public readonly sha256: string;

Type: string

`kmsKeySelfLinkInput`^Optional

public readonly kmsKeySelfLinkInput: string;

Type: string

`kmsKeyServiceAccountInput`^Optional

public readonly kmsKeyServiceAccountInput: string;

Type: string

`rawKeyInput`^Optional

public readonly rawKeyInput: string;

Type: string

`rsaEncryptedKeyInput`^Optional

public readonly rsaEncryptedKeyInput: string;

Type: string

`kmsKeySelfLink`^Required

public readonly kmsKeySelfLink: string;

Type: string

`kmsKeyServiceAccount`^Required

public readonly kmsKeyServiceAccount: string;

Type: string

`rawKey`^Required

public readonly rawKey: string;

Type: string

`rsaEncryptedKey`^Required

public readonly rsaEncryptedKey: string;

Type: string

`internalValue`^Optional

public readonly internalValue: ComputeSnapshotSnapshotEncryptionKey;

Type: ComputeSnapshotSnapshotEncryptionKey

ComputeSnapshotSourceDiskEncryptionKeyOutputReference

Initializers

import { computeSnapshot } from '@cdktf/provider-google'

new computeSnapshot.ComputeSnapshotSourceDiskEncryptionKeyOutputReference(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.
`resetKmsKeySelfLink`	No description.
`resetKmsKeyServiceAccount`	No description.
`resetRawKey`	No description.
`resetRsaEncryptedKey`	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.

`resetKmsKeySelfLink`

public resetKmsKeySelfLink(): void

`resetKmsKeyServiceAccount`

public resetKmsKeyServiceAccount(): void

`resetRawKey`

public resetRawKey(): void

`resetRsaEncryptedKey`

public resetRsaEncryptedKey(): 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.
`rawKeyInput`	`string`	No description.
`rsaEncryptedKeyInput`	`string`	No description.
`kmsKeySelfLink`	`string`	No description.
`kmsKeyServiceAccount`	`string`	No description.
`rawKey`	`string`	No description.
`rsaEncryptedKey`	`string`	No description.
`internalValue`	`ComputeSnapshotSourceDiskEncryptionKey`	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

`kmsKeySelfLinkInput`^Optional

public readonly kmsKeySelfLinkInput: string;

Type: string

`kmsKeyServiceAccountInput`^Optional

public readonly kmsKeyServiceAccountInput: string;

Type: string

`rawKeyInput`^Optional

public readonly rawKeyInput: string;

Type: string

`rsaEncryptedKeyInput`^Optional

public readonly rsaEncryptedKeyInput: string;

Type: string

`kmsKeySelfLink`^Required

public readonly kmsKeySelfLink: string;

Type: string

`kmsKeyServiceAccount`^Required

public readonly kmsKeyServiceAccount: string;

Type: string

`rawKey`^Required

public readonly rawKey: string;

Type: string

`rsaEncryptedKey`^Required

public readonly rsaEncryptedKey: string;

Type: string

`internalValue`^Optional

public readonly internalValue: ComputeSnapshotSourceDiskEncryptionKey;

Type: ComputeSnapshotSourceDiskEncryptionKey

ComputeSnapshotTimeoutsOutputReference

Initializers

import { computeSnapshot } from '@cdktf/provider-google'

new computeSnapshot.ComputeSnapshotTimeoutsOutputReference(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.
`resetUpdate`	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

`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 \| ComputeSnapshotTimeouts`	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

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | ComputeSnapshotTimeouts;

Type: cdktf.IResolvable | ComputeSnapshotTimeouts

Files

computeSnapshot.typescript.md

Latest commit

History

computeSnapshot.typescript.md

File metadata and controls

computeSnapshot Submodule

Constructs