Skip to content

Files

Latest commit

4668213 · May 28, 2025

History

History
2819 lines (1734 loc) · 126 KB
·

computeStoragePool.typescript.md

File metadata and controls

2819 lines (1734 loc) · 126 KB
·

computeStoragePool Submodule

Constructs

ComputeStoragePool

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool google_compute_storage_pool}.

Initializers

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

new computeStoragePool.ComputeStoragePool(scope: Construct, id: string, config: ComputeStoragePoolConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ComputeStoragePoolConfig 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".
putTimeouts No description.
resetCapacityProvisioningType No description.
resetDeletionProtection No description.
resetDescription No description.
resetPerformanceProvisioningType No description.
resetPoolProvisionedIops No description.
resetProject 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
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".


putTimeouts
public putTimeouts(value: ComputeStoragePoolTimeouts): void
valueRequired

resetCapacityProvisioningType
public resetCapacityProvisioningType(): void
resetDeletionProtection
public resetDeletionProtection(): void
resetDescription
public resetDescription(): void
resetPerformanceProvisioningType
public resetPerformanceProvisioningType(): void
resetPoolProvisionedIops
public resetPoolProvisionedIops(): void
resetProject
public resetProject(): 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 ComputeStoragePool resource upon running "cdktf plan ".

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

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

computeStoragePool.ComputeStoragePool.isTerraformElement(x: any)
xRequired
  • Type: any

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

computeStoragePool.ComputeStoragePool.isTerraformResource(x: any)
xRequired
  • Type: any

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

computeStoragePool.ComputeStoragePool.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing ComputeStoragePool that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#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 ComputeStoragePool 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.
id string No description.
kind string No description.
labelFingerprint string No description.
resourceStatus ComputeStoragePoolResourceStatusList No description.
status ComputeStoragePoolStatusList No description.
timeouts ComputeStoragePoolTimeoutsOutputReference No description.
capacityProvisioningTypeInput string No description.
deletionProtectionInput boolean | cdktf.IResolvable No description.
descriptionInput string No description.
nameInput string No description.
performanceProvisioningTypeInput string No description.
poolProvisionedCapacityGbInput string No description.
poolProvisionedIopsInput string No description.
poolProvisionedThroughputInput string No description.
projectInput string No description.
storagePoolTypeInput string No description.
timeoutsInput cdktf.IResolvable | ComputeStoragePoolTimeouts No description.
zoneInput string No description.
capacityProvisioningType string No description.
deletionProtection boolean | cdktf.IResolvable No description.
description string No description.
name string No description.
performanceProvisioningType string No description.
poolProvisionedCapacityGb string No description.
poolProvisionedIops string No description.
poolProvisionedThroughput string No description.
project string No description.
storagePoolType string No description.
zone 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[]

creationTimestampRequired
public readonly creationTimestamp: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

kindRequired
public readonly kind: string;
  • Type: string

labelFingerprintRequired
public readonly labelFingerprint: string;
  • Type: string

resourceStatusRequired
public readonly resourceStatus: ComputeStoragePoolResourceStatusList;

statusRequired
public readonly status: ComputeStoragePoolStatusList;

timeoutsRequired
public readonly timeouts: ComputeStoragePoolTimeoutsOutputReference;

capacityProvisioningTypeInputOptional
public readonly capacityProvisioningTypeInput: string;
  • Type: string

deletionProtectionInputOptional
public readonly deletionProtectionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

performanceProvisioningTypeInputOptional
public readonly performanceProvisioningTypeInput: string;
  • Type: string

poolProvisionedCapacityGbInputOptional
public readonly poolProvisionedCapacityGbInput: string;
  • Type: string

poolProvisionedIopsInputOptional
public readonly poolProvisionedIopsInput: string;
  • Type: string

poolProvisionedThroughputInputOptional
public readonly poolProvisionedThroughputInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

storagePoolTypeInputOptional
public readonly storagePoolTypeInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | ComputeStoragePoolTimeouts;

zoneInputOptional
public readonly zoneInput: string;
  • Type: string

capacityProvisioningTypeRequired
public readonly capacityProvisioningType: string;
  • Type: string

deletionProtectionRequired
public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionRequired
public readonly description: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

performanceProvisioningTypeRequired
public readonly performanceProvisioningType: string;
  • Type: string

poolProvisionedCapacityGbRequired
public readonly poolProvisionedCapacityGb: string;
  • Type: string

poolProvisionedIopsRequired
public readonly poolProvisionedIops: string;
  • Type: string

poolProvisionedThroughputRequired
public readonly poolProvisionedThroughput: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

storagePoolTypeRequired
public readonly storagePoolType: string;
  • Type: string

zoneRequired
public readonly zone: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

ComputeStoragePoolConfig

Initializer

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

const computeStoragePoolConfig: computeStoragePool.ComputeStoragePoolConfig = { ... }

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.
poolProvisionedCapacityGb string Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.
poolProvisionedThroughput string Provisioned throughput, in MB/s, of the storage pool. Only relevant if the storage pool type is 'hyperdisk-balanced' or 'hyperdisk-throughput'.
storagePoolType string Type of the storage pool. For example, the following are valid values:.
capacityProvisioningType string Provisioning type of the byte capacity of the pool. Possible values: ["STANDARD", "ADVANCED"].
deletionProtection boolean | cdktf.IResolvable Whether Terraform will be prevented from destroying the StoragePool.
description string A description of this resource. Provide this property when you create the resource.
performanceProvisioningType string Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Possible values: ["STANDARD", "ADVANCED"].
poolProvisionedIops string Provisioned IOPS of the storage pool. Only relevant if the storage pool type is 'hyperdisk-balanced'.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#project ComputeStoragePool#project}.
timeouts ComputeStoragePoolTimeouts timeouts block.
zone string A reference to the zone where the storage pool resides.

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/6.37.0/docs/resources/compute_storage_pool#name ComputeStoragePool#name}


poolProvisionedCapacityGbRequired
public readonly poolProvisionedCapacityGb: string;
  • Type: string

Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#pool_provisioned_capacity_gb ComputeStoragePool#pool_provisioned_capacity_gb}


poolProvisionedThroughputRequired
public readonly poolProvisionedThroughput: string;
  • Type: string

Provisioned throughput, in MB/s, of the storage pool. Only relevant if the storage pool type is 'hyperdisk-balanced' or 'hyperdisk-throughput'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#pool_provisioned_throughput ComputeStoragePool#pool_provisioned_throughput}


storagePoolTypeRequired
public readonly storagePoolType: string;
  • Type: string

Type of the storage pool. For example, the following are valid values:.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#storage_pool_type ComputeStoragePool#storage_pool_type}


capacityProvisioningTypeOptional
public readonly capacityProvisioningType: string;
  • Type: string

Provisioning type of the byte capacity of the pool. Possible values: ["STANDARD", "ADVANCED"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#capacity_provisioning_type ComputeStoragePool#capacity_provisioning_type}


deletionProtectionOptional
public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether Terraform will be prevented from destroying the StoragePool.

When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the StoragePool will fail. When the field is set to false, deleting the StoragePool is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#deletion_protection ComputeStoragePool#deletion_protection}


descriptionOptional
public readonly description: string;
  • Type: string

A description of this resource. Provide this property when you create the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#description ComputeStoragePool#description}


performanceProvisioningTypeOptional
public readonly performanceProvisioningType: string;
  • Type: string

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Possible values: ["STANDARD", "ADVANCED"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#performance_provisioning_type ComputeStoragePool#performance_provisioning_type}


poolProvisionedIopsOptional
public readonly poolProvisionedIops: string;
  • Type: string

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is 'hyperdisk-balanced'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#pool_provisioned_iops ComputeStoragePool#pool_provisioned_iops}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#project ComputeStoragePool#project}.


timeoutsOptional
public readonly timeouts: ComputeStoragePoolTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#timeouts ComputeStoragePool#timeouts}


zoneOptional
public readonly zone: string;
  • Type: string

A reference to the zone where the storage pool resides.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#zone ComputeStoragePool#zone}


ComputeStoragePoolResourceStatus

Initializer

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

const computeStoragePoolResourceStatus: computeStoragePool.ComputeStoragePoolResourceStatus = { ... }

ComputeStoragePoolStatus

Initializer

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

const computeStoragePoolStatus: computeStoragePool.ComputeStoragePoolStatus = { ... }

ComputeStoragePoolTimeouts

Initializer

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

const computeStoragePoolTimeouts: computeStoragePool.ComputeStoragePoolTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#create ComputeStoragePool#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#delete ComputeStoragePool#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_storage_pool#update ComputeStoragePool#update}.


Classes

ComputeStoragePoolResourceStatusList

Initializers

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

new computeStoragePool.ComputeStoragePoolResourceStatusList(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): ComputeStoragePoolResourceStatusOutputReference
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.

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

ComputeStoragePoolResourceStatusOutputReference

Initializers

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

new computeStoragePool.ComputeStoragePoolResourceStatusOutputReference(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.
diskCount string No description.
lastResizeTimestamp string No description.
maxTotalProvisionedDiskCapacityGb string No description.
poolUsedCapacityBytes string No description.
poolUsedIops string No description.
poolUsedThroughput string No description.
poolUserWrittenBytes string No description.
totalProvisionedDiskCapacityGb string No description.
totalProvisionedDiskIops string No description.
totalProvisionedDiskThroughput string No description.
internalValue ComputeStoragePoolResourceStatus 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

diskCountRequired
public readonly diskCount: string;
  • Type: string

lastResizeTimestampRequired
public readonly lastResizeTimestamp: string;
  • Type: string

maxTotalProvisionedDiskCapacityGbRequired
public readonly maxTotalProvisionedDiskCapacityGb: string;
  • Type: string

poolUsedCapacityBytesRequired
public readonly poolUsedCapacityBytes: string;
  • Type: string

poolUsedIopsRequired
public readonly poolUsedIops: string;
  • Type: string

poolUsedThroughputRequired
public readonly poolUsedThroughput: string;
  • Type: string

poolUserWrittenBytesRequired
public readonly poolUserWrittenBytes: string;
  • Type: string

totalProvisionedDiskCapacityGbRequired
public readonly totalProvisionedDiskCapacityGb: string;
  • Type: string

totalProvisionedDiskIopsRequired
public readonly totalProvisionedDiskIops: string;
  • Type: string

totalProvisionedDiskThroughputRequired
public readonly totalProvisionedDiskThroughput: string;
  • Type: string

internalValueOptional
public readonly internalValue: ComputeStoragePoolResourceStatus;

ComputeStoragePoolStatusList

Initializers

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

new computeStoragePool.ComputeStoragePoolStatusList(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): ComputeStoragePoolStatusOutputReference
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.

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

ComputeStoragePoolStatusOutputReference

Initializers

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

new computeStoragePool.ComputeStoragePoolStatusOutputReference(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.
diskCount string No description.
lastResizeTimestamp string No description.
maxTotalProvisionedDiskCapacityGb string No description.
poolUsedCapacityBytes string No description.
poolUsedIops string No description.
poolUsedThroughput string No description.
poolUserWrittenBytes string No description.
totalProvisionedDiskCapacityGb string No description.
totalProvisionedDiskIops string No description.
totalProvisionedDiskThroughput string No description.
internalValue ComputeStoragePoolStatus 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

diskCountRequired
public readonly diskCount: string;
  • Type: string

lastResizeTimestampRequired
public readonly lastResizeTimestamp: string;
  • Type: string

maxTotalProvisionedDiskCapacityGbRequired
public readonly maxTotalProvisionedDiskCapacityGb: string;
  • Type: string

poolUsedCapacityBytesRequired
public readonly poolUsedCapacityBytes: string;
  • Type: string

poolUsedIopsRequired
public readonly poolUsedIops: string;
  • Type: string

poolUsedThroughputRequired
public readonly poolUsedThroughput: string;
  • Type: string

poolUserWrittenBytesRequired
public readonly poolUserWrittenBytes: string;
  • Type: string

totalProvisionedDiskCapacityGbRequired
public readonly totalProvisionedDiskCapacityGb: string;
  • Type: string

totalProvisionedDiskIopsRequired
public readonly totalProvisionedDiskIops: string;
  • Type: string

totalProvisionedDiskThroughputRequired
public readonly totalProvisionedDiskThroughput: string;
  • Type: string

internalValueOptional
public readonly internalValue: ComputeStoragePoolStatus;

ComputeStoragePoolTimeoutsOutputReference

Initializers

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

new computeStoragePool.ComputeStoragePoolTimeoutsOutputReference(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 | ComputeStoragePoolTimeouts 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 | ComputeStoragePoolTimeouts;