Skip to content

Latest commit

 

History

History
1816 lines (1127 loc) · 77.3 KB

netappStoragePool.typescript.md

File metadata and controls

1816 lines (1127 loc) · 77.3 KB

netappStoragePool Submodule

Constructs

NetappStoragePool

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool google_netapp_storage_pool}.

Initializers

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

new netappStoragePool.NetappStoragePool(scope: Construct, id: string, config: NetappStoragePoolConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config NetappStoragePoolConfig 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.
resetActiveDirectory No description.
resetAllowAutoTiering No description.
resetDescription No description.
resetId No description.
resetKmsConfig No description.
resetLabels No description.
resetLdapEnabled No description.
resetProject No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

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

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

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

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

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

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

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

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

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

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

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

providerOptional
  • Type: cdktf.TerraformProvider

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

moveFromId
public moveFromId(id: string): void

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

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

idRequired
  • Type: string

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


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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putTimeouts
public putTimeouts(value: NetappStoragePoolTimeouts): void
valueRequired

resetActiveDirectory
public resetActiveDirectory(): void
resetAllowAutoTiering
public resetAllowAutoTiering(): void
resetDescription
public resetDescription(): void
resetId
public resetId(): void
resetKmsConfig
public resetKmsConfig(): void
resetLabels
public resetLabels(): void
resetLdapEnabled
public resetLdapEnabled(): void
resetProject
public resetProject(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

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

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

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

netappStoragePool.NetappStoragePool.isTerraformElement(x: any)
xRequired
  • Type: any

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

netappStoragePool.NetappStoragePool.isTerraformResource(x: any)
xRequired
  • Type: any

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

netappStoragePool.NetappStoragePool.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing NetappStoragePool that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_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 NetappStoragePool 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.
effectiveLabels cdktf.StringMap No description.
encryptionType string No description.
terraformLabels cdktf.StringMap No description.
timeouts NetappStoragePoolTimeoutsOutputReference No description.
volumeCapacityGib string No description.
volumeCount number No description.
activeDirectoryInput string No description.
allowAutoTieringInput boolean | cdktf.IResolvable No description.
capacityGibInput string No description.
descriptionInput string No description.
idInput string No description.
kmsConfigInput string No description.
labelsInput {[ key: string ]: string} No description.
ldapEnabledInput boolean | cdktf.IResolvable No description.
locationInput string No description.
nameInput string No description.
networkInput string No description.
projectInput string No description.
serviceLevelInput string No description.
timeoutsInput cdktf.IResolvable | NetappStoragePoolTimeouts No description.
activeDirectory string No description.
allowAutoTiering boolean | cdktf.IResolvable No description.
capacityGib string No description.
description string No description.
id string No description.
kmsConfig string No description.
labels {[ key: string ]: string} No description.
ldapEnabled boolean | cdktf.IResolvable No description.
location string No description.
name string No description.
network string No description.
project string No description.
serviceLevel 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[]

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

encryptionTypeRequired
public readonly encryptionType: string;
  • Type: string

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

timeoutsRequired
public readonly timeouts: NetappStoragePoolTimeoutsOutputReference;

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 | cdktf.IResolvable

capacityGibInputOptional
public readonly capacityGibInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: 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 | cdktf.IResolvable

locationInputOptional
public readonly locationInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

networkInputOptional
public readonly networkInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

serviceLevelInputOptional
public readonly serviceLevelInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | NetappStoragePoolTimeouts;

activeDirectoryRequired
public readonly activeDirectory: string;
  • Type: string

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

capacityGibRequired
public readonly capacityGib: string;
  • Type: string

descriptionRequired
public readonly description: 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 | cdktf.IResolvable

locationRequired
public readonly location: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

networkRequired
public readonly network: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

serviceLevelRequired
public readonly serviceLevel: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

NetappStoragePoolConfig

Initializer

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

const netappStoragePoolConfig: netappStoragePool.NetappStoragePoolConfig = { ... }

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.
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 | cdktf.IResolvable Optional.
description string An optional description of this resource.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#id NetappStoragePool#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 | cdktf.IResolvable When enabled, the volumes uses Active Directory as LDAP name service for UID/GID lookups.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#project NetappStoragePool#project}.
timeouts NetappStoragePoolTimeouts timeouts block.

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

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

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

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

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

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

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

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/6.7.0/docs/resources/netapp_storage_pool#capacity_gib NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#location NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#name NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#network NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#service_level NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#active_directory NetappStoragePool#active_directory}


allowAutoTieringOptional
public readonly allowAutoTiering: boolean | IResolvable;
  • Type: boolean | cdktf.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/6.7.0/docs/resources/netapp_storage_pool#allow_auto_tiering NetappStoragePool#allow_auto_tiering}


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/6.7.0/docs/resources/netapp_storage_pool#description NetappStoragePool#description}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#id NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#kms_config NetappStoragePool#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/6.7.0/docs/resources/netapp_storage_pool#labels NetappStoragePool#labels}


ldapEnabledOptional
public readonly ldapEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.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/6.7.0/docs/resources/netapp_storage_pool#ldap_enabled NetappStoragePool#ldap_enabled}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#project NetappStoragePool#project}.


timeoutsOptional
public readonly timeouts: NetappStoragePoolTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#timeouts NetappStoragePool#timeouts}


NetappStoragePoolTimeouts

Initializer

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

const netappStoragePoolTimeouts: netappStoragePool.NetappStoragePoolTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#create NetappStoragePool#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#delete NetappStoragePool#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.7.0/docs/resources/netapp_storage_pool#update NetappStoragePool#update}.


Classes

NetappStoragePoolTimeoutsOutputReference

Initializers

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

new netappStoragePool.NetappStoragePoolTimeoutsOutputReference(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 | NetappStoragePoolTimeouts 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 | NetappStoragePoolTimeouts;