Skip to content

Latest commit

 

History

History
2471 lines (1546 loc) · 115 KB

File metadata and controls

2471 lines (1546 loc) · 115 KB

googleNetappStoragePool Submodule

Constructs

GoogleNetappStoragePool

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

Initializers

import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

new googleNetappStoragePool.GoogleNetappStoragePool(scope: Construct, id: string, config: GoogleNetappStoragePoolConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleNetappStoragePoolConfig 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.
with Applies one or more mixins to 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.
resetActiveDirectory No description.
resetAllowAutoTiering No description.
resetCustomPerformanceEnabled No description.
resetDeletionPolicy No description.
resetDescription No description.
resetEnableHotTierAutoResize No description.
resetHotTierSizeGib No description.
resetId No description.
resetKmsConfig No description.
resetLabels No description.
resetLdapEnabled No description.
resetMode No description.
resetProject No description.
resetQosType No description.
resetReplicaZone No description.
resetScaleTier No description.
resetScaleType No description.
resetTimeouts No description.
resetTotalIops No description.
resetTotalThroughputMibps No description.
resetType No description.
resetZone No description.

toString
public toString(): string

Returns a string representation of this construct.

with
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.


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: cdktn.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: GoogleNetappStoragePoolTimeouts): void
valueRequired

resetActiveDirectory
public resetActiveDirectory(): void
resetAllowAutoTiering
public resetAllowAutoTiering(): void
resetCustomPerformanceEnabled
public resetCustomPerformanceEnabled(): void
resetDeletionPolicy
public resetDeletionPolicy(): void
resetDescription
public resetDescription(): void
resetEnableHotTierAutoResize
public resetEnableHotTierAutoResize(): void
resetHotTierSizeGib
public resetHotTierSizeGib(): void
resetId
public resetId(): void
resetKmsConfig
public resetKmsConfig(): void
resetLabels
public resetLabels(): void
resetLdapEnabled
public resetLdapEnabled(): void
resetMode
public resetMode(): void
resetProject
public resetProject(): void
resetQosType
public resetQosType(): void
resetReplicaZone
public resetReplicaZone(): void
resetScaleTier
public resetScaleTier(): void
resetScaleType
public resetScaleType(): void
resetTimeouts
public resetTimeouts(): void
resetTotalIops
public resetTotalIops(): void
resetTotalThroughputMibps
public resetTotalThroughputMibps(): void
resetType
public resetType(): void
resetZone
public resetZone(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a GoogleNetappStoragePool resource upon running "cdktn plan ".

isConstruct
import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

googleNetappStoragePool.GoogleNetappStoragePool.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 { googleNetappStoragePool } from '@cdktn/provider-google-beta'

googleNetappStoragePool.GoogleNetappStoragePool.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

googleNetappStoragePool.GoogleNetappStoragePool.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

googleNetappStoragePool.GoogleNetappStoragePool.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a GoogleNetappStoragePool resource upon running "cdktn 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 GoogleNetappStoragePool to import.


importFromIdRequired
  • Type: string

The id of the existing GoogleNetappStoragePool that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktn.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn string[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
availableThroughputMibps number No description.
coldTierSizeUsedGib string No description.
effectiveLabels cdktn.StringMap No description.
encryptionType string No description.
hotTierSizeUsedGib string No description.
terraformLabels cdktn.StringMap No description.
timeouts GoogleNetappStoragePoolTimeoutsOutputReference No description.
volumeCapacityGib string No description.
volumeCount number No description.
activeDirectoryInput string No description.
allowAutoTieringInput boolean | cdktn.IResolvable No description.
capacityGibInput string No description.
customPerformanceEnabledInput boolean | cdktn.IResolvable No description.
deletionPolicyInput string No description.
descriptionInput string No description.
enableHotTierAutoResizeInput boolean | cdktn.IResolvable No description.
hotTierSizeGibInput string No description.
idInput string No description.
kmsConfigInput string No description.
labelsInput {[ key: string ]: string} No description.
ldapEnabledInput boolean | cdktn.IResolvable No description.
locationInput string No description.
modeInput string No description.
nameInput string No description.
networkInput string No description.
projectInput string No description.
qosTypeInput string No description.
replicaZoneInput string No description.
scaleTierInput string No description.
scaleTypeInput string No description.
serviceLevelInput string No description.
timeoutsInput cdktn.IResolvable | GoogleNetappStoragePoolTimeouts No description.
totalIopsInput string No description.
totalThroughputMibpsInput string No description.
typeInput string No description.
zoneInput string No description.
activeDirectory string No description.
allowAutoTiering boolean | cdktn.IResolvable No description.
capacityGib string No description.
customPerformanceEnabled boolean | cdktn.IResolvable No description.
deletionPolicy string No description.
description string No description.
enableHotTierAutoResize boolean | cdktn.IResolvable No description.
hotTierSizeGib string No description.
id string No description.
kmsConfig string No description.
labels {[ key: string ]: string} No description.
ldapEnabled boolean | cdktn.IResolvable No description.
location string No description.
mode string No description.
name string No description.
network string No description.
project string No description.
qosType string No description.
replicaZone string No description.
scaleTier string No description.
scaleType string No description.
serviceLevel string No description.
totalIops string No description.
totalThroughputMibps string No description.
type string No description.
zone string No description.

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

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

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

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

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

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

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

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

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

availableThroughputMibpsRequired
public readonly availableThroughputMibps: number;
  • Type: number

coldTierSizeUsedGibRequired
public readonly coldTierSizeUsedGib: string;
  • Type: string

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

encryptionTypeRequired
public readonly encryptionType: string;
  • Type: string

hotTierSizeUsedGibRequired
public readonly hotTierSizeUsedGib: string;
  • Type: string

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

timeoutsRequired
public readonly timeouts: GoogleNetappStoragePoolTimeoutsOutputReference;

volumeCapacityGibRequired
public readonly volumeCapacityGib: string;
  • Type: string

volumeCountRequired
public readonly volumeCount: number;
  • Type: number

activeDirectoryInputOptional
public readonly activeDirectoryInput: string;
  • Type: string

allowAutoTieringInputOptional
public readonly allowAutoTieringInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

capacityGibInputOptional
public readonly capacityGibInput: string;
  • Type: string

customPerformanceEnabledInputOptional
public readonly customPerformanceEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

deletionPolicyInputOptional
public readonly deletionPolicyInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

enableHotTierAutoResizeInputOptional
public readonly enableHotTierAutoResizeInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

hotTierSizeGibInputOptional
public readonly hotTierSizeGibInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

kmsConfigInputOptional
public readonly kmsConfigInput: string;
  • Type: string

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

ldapEnabledInputOptional
public readonly ldapEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

locationInputOptional
public readonly locationInput: string;
  • Type: string

modeInputOptional
public readonly modeInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

networkInputOptional
public readonly networkInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

qosTypeInputOptional
public readonly qosTypeInput: string;
  • Type: string

replicaZoneInputOptional
public readonly replicaZoneInput: string;
  • Type: string

scaleTierInputOptional
public readonly scaleTierInput: string;
  • Type: string

scaleTypeInputOptional
public readonly scaleTypeInput: string;
  • Type: string

serviceLevelInputOptional
public readonly serviceLevelInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleNetappStoragePoolTimeouts;

totalIopsInputOptional
public readonly totalIopsInput: string;
  • Type: string

totalThroughputMibpsInputOptional
public readonly totalThroughputMibpsInput: string;
  • Type: string

typeInputOptional
public readonly typeInput: string;
  • Type: string

zoneInputOptional
public readonly zoneInput: string;
  • Type: string

activeDirectoryRequired
public readonly activeDirectory: string;
  • Type: string

allowAutoTieringRequired
public readonly allowAutoTiering: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

capacityGibRequired
public readonly capacityGib: string;
  • Type: string

customPerformanceEnabledRequired
public readonly customPerformanceEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

deletionPolicyRequired
public readonly deletionPolicy: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

enableHotTierAutoResizeRequired
public readonly enableHotTierAutoResize: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

hotTierSizeGibRequired
public readonly hotTierSizeGib: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

kmsConfigRequired
public readonly kmsConfig: string;
  • Type: string

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

ldapEnabledRequired
public readonly ldapEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

locationRequired
public readonly location: string;
  • Type: string

modeRequired
public readonly mode: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

networkRequired
public readonly network: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

qosTypeRequired
public readonly qosType: string;
  • Type: string

replicaZoneRequired
public readonly replicaZone: string;
  • Type: string

scaleTierRequired
public readonly scaleTier: string;
  • Type: string

scaleTypeRequired
public readonly scaleType: string;
  • Type: string

serviceLevelRequired
public readonly serviceLevel: string;
  • Type: string

totalIopsRequired
public readonly totalIops: string;
  • Type: string

totalThroughputMibpsRequired
public readonly totalThroughputMibps: string;
  • Type: string

typeRequired
public readonly type: 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

GoogleNetappStoragePoolConfig

Initializer

import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

const googleNetappStoragePoolConfig: googleNetappStoragePool.GoogleNetappStoragePoolConfig = { ... }

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn cdktn.ITerraformDependable[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
capacityGib string Capacity of the storage pool (in GiB).
location string Name of the location. For zonal Flex pools specify a zone name, in all other cases a region name.
name string The resource name of the storage pool. Needs to be unique per location/region.
network string VPC network name with format: 'projects/{{project}}/global/networks/{{network}}'.
serviceLevel string Service level of the storage pool. Possible values: ["PREMIUM", "EXTREME", "STANDARD", "FLEX"].
activeDirectory string Specifies the Active Directory policy to be used.
allowAutoTiering boolean | cdktn.IResolvable Optional.
customPerformanceEnabled boolean | cdktn.IResolvable Optional. True if using Independent Scaling of capacity and performance (Hyperdisk). Default is false.
deletionPolicy string Whether Terraform will be prevented from destroying the instance.
description string An optional description of this resource.
enableHotTierAutoResize boolean | cdktn.IResolvable Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%.
hotTierSizeGib string Total hot tier capacity for the Storage Pool.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#id GoogleNetappStoragePool#id}.
kmsConfig string Specifies the CMEK policy to be used for volume encryption.
labels {[ key: string ]: string} Labels as key value pairs. Example: '{ "owner": "Bob", "department": "finance", "purpose": "testing" }'.
ldapEnabled boolean | cdktn.IResolvable When enabled, the volumes uses Active Directory as LDAP name service for UID/GID lookups.
mode string Mode of the storage pool.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#project GoogleNetappStoragePool#project}.
qosType string QoS (Quality of Service) type of the storage pool. Possible values are: AUTO, MANUAL. Possible values: ["QOS_TYPE_UNSPECIFIED", "AUTO", "MANUAL"].
replicaZone string Specifies the replica zone for regional Flex pools. 'zone' and 'replica_zone' values can be swapped to initiate a zone switch.
scaleTier string The effective scale tier of the storage pool.
scaleType string The scale type of the storage pool. Defaults to 'SCALE_TYPE_DEFAULT' if not specified. Possible values: ["SCALE_TYPE_UNSPECIFIED", "SCALE_TYPE_DEFAULT", "SCALE_TYPE_SCALEOUT"].
timeouts GoogleNetappStoragePoolTimeouts timeouts block.
totalIops string Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the totalThroughputMibps.
totalThroughputMibps string Optional. Custom Performance Total Throughput of the pool (in MiB/s).
type string Type of the storage pool.
zone string Specifies the active zone for regional Flex pools.

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

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

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

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

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

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

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

capacityGibRequired
public readonly capacityGib: string;
  • Type: string

Capacity of the storage pool (in GiB).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#capacity_gib GoogleNetappStoragePool#capacity_gib}


locationRequired
public readonly location: string;
  • Type: string

Name of the location. For zonal Flex pools specify a zone name, in all other cases a region name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#location GoogleNetappStoragePool#location}


nameRequired
public readonly name: string;
  • Type: string

The resource name of the storage pool. Needs to be unique per location/region.

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


networkRequired
public readonly network: string;
  • Type: string

VPC network name with format: 'projects/{{project}}/global/networks/{{network}}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#network GoogleNetappStoragePool#network}


serviceLevelRequired
public readonly serviceLevel: string;
  • Type: string

Service level of the storage pool. Possible values: ["PREMIUM", "EXTREME", "STANDARD", "FLEX"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#service_level GoogleNetappStoragePool#service_level}


activeDirectoryOptional
public readonly activeDirectory: string;
  • Type: string

Specifies the Active Directory policy to be used.

Format: 'projects/{{project}}/locations/{{location}}/activeDirectories/{{name}}'. The policy needs to be in the same location as the storage pool.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#active_directory GoogleNetappStoragePool#active_directory}


allowAutoTieringOptional
public readonly allowAutoTiering: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Optional.

True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#allow_auto_tiering GoogleNetappStoragePool#allow_auto_tiering}


customPerformanceEnabledOptional
public readonly customPerformanceEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Optional. True if using Independent Scaling of capacity and performance (Hyperdisk). Default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#custom_performance_enabled GoogleNetappStoragePool#custom_performance_enabled}


deletionPolicyOptional
public readonly deletionPolicy: string;
  • Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#deletion_policy GoogleNetappStoragePool#deletion_policy}


descriptionOptional
public readonly description: string;
  • Type: string

An optional description of this resource.

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


enableHotTierAutoResizeOptional
public readonly enableHotTierAutoResize: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%.

Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#enable_hot_tier_auto_resize GoogleNetappStoragePool#enable_hot_tier_auto_resize}


hotTierSizeGibOptional
public readonly hotTierSizeGib: string;
  • Type: string

Total hot tier capacity for the Storage Pool.

It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#hot_tier_size_gib GoogleNetappStoragePool#hot_tier_size_gib}


idOptional
public readonly id: string;
  • Type: string

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


kmsConfigOptional
public readonly kmsConfig: string;
  • Type: string

Specifies the CMEK policy to be used for volume encryption.

Format: 'projects/{{project}}/locations/{{location}}/kmsConfigs/{{name}}'. The policy needs to be in the same location as the storage pool.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#kms_config GoogleNetappStoragePool#kms_config}


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

Labels as key value pairs. Example: '{ "owner": "Bob", "department": "finance", "purpose": "testing" }'.

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/7.36.0/docs/resources/google_netapp_storage_pool#labels GoogleNetappStoragePool#labels}


ldapEnabledOptional
public readonly ldapEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

When enabled, the volumes uses Active Directory as LDAP name service for UID/GID lookups.

Required to enable extended group support for NFSv3, using security identifiers for NFSv4.1 or principal names for kerberized NFSv4.1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#ldap_enabled GoogleNetappStoragePool#ldap_enabled}


modeOptional
public readonly mode: string;
  • Type: string

Mode of the storage pool.

The operational mode of the storage pool. ONTAP mode enables operations via ONTAP Mode APIs, while DEFAULT mode enables operations via NetApp Volumes APIs. If not specified during creation, the mode defaults to DEFAULT. Possible values: ["MODE_UNSPECIFIED", "DEFAULT", "ONTAP"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#mode GoogleNetappStoragePool#mode}


projectOptional
public readonly project: string;
  • Type: string

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


qosTypeOptional
public readonly qosType: string;
  • Type: string

QoS (Quality of Service) type of the storage pool. Possible values are: AUTO, MANUAL. Possible values: ["QOS_TYPE_UNSPECIFIED", "AUTO", "MANUAL"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#qos_type GoogleNetappStoragePool#qos_type}


replicaZoneOptional
public readonly replicaZone: string;
  • Type: string

Specifies the replica zone for regional Flex pools. 'zone' and 'replica_zone' values can be swapped to initiate a zone switch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#replica_zone GoogleNetappStoragePool#replica_zone}


scaleTierOptional
public readonly scaleTier: string;
  • Type: string

The effective scale tier of the storage pool.

If 'scale_tier' is not specified during creation, this defaults to 'SCALE_TIER_STANDARD'. Possible values: ["SCALE_TIER_UNSPECIFIED", "SCALE_TIER_STANDARD", "SCALE_TIER_ENTERPRISE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#scale_tier GoogleNetappStoragePool#scale_tier}


scaleTypeOptional
public readonly scaleType: string;
  • Type: string

The scale type of the storage pool. Defaults to 'SCALE_TYPE_DEFAULT' if not specified. Possible values: ["SCALE_TYPE_UNSPECIFIED", "SCALE_TYPE_DEFAULT", "SCALE_TYPE_SCALEOUT"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#scale_type GoogleNetappStoragePool#scale_type}


timeoutsOptional
public readonly timeouts: GoogleNetappStoragePoolTimeouts;

timeouts block.

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


totalIopsOptional
public readonly totalIops: string;
  • Type: string

Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the totalThroughputMibps.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#total_iops GoogleNetappStoragePool#total_iops}


totalThroughputMibpsOptional
public readonly totalThroughputMibps: string;
  • Type: string

Optional. Custom Performance Total Throughput of the pool (in MiB/s).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#total_throughput_mibps GoogleNetappStoragePool#total_throughput_mibps}


typeOptional
public readonly type: string;
  • Type: string

Type of the storage pool.

This field is used to control whether the pool supports FILE based volumes only or UNIFIED (both FILE and BLOCK) volumes. If not specified during creation, it defaults to FILE. Possible values: ["STORAGE_POOL_TYPE_UNSPECIFIED", "FILE", "UNIFIED"]

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


zoneOptional
public readonly zone: string;
  • Type: string

Specifies the active zone for regional Flex pools.

'zone' and 'replica_zone' values can be swapped to initiate a zone switch. If you want to create a zonal Flex pool, specify a zone name for 'location' and omit 'zone'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_netapp_storage_pool#zone GoogleNetappStoragePool#zone}


GoogleNetappStoragePoolTimeouts

Initializer

import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

const googleNetappStoragePoolTimeouts: googleNetappStoragePool.GoogleNetappStoragePoolTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

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


deleteOptional
public readonly delete: string;
  • Type: string

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


updateOptional
public readonly update: string;
  • Type: string

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


Classes

GoogleNetappStoragePoolTimeoutsOutputReference

Initializers

import { googleNetappStoragePool } from '@cdktn/provider-google-beta'

new googleNetappStoragePool.GoogleNetappStoragePoolTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktn.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktn.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: cdktn.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 cdktn.IResolvable | GoogleNetappStoragePoolTimeouts 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 | GoogleNetappStoragePoolTimeouts;