Skip to content

Latest commit

 

History

History
2864 lines (1772 loc) · 136 KB

netappVolumeReplication.typescript.md

File metadata and controls

2864 lines (1772 loc) · 136 KB

netappVolumeReplication Submodule

Constructs

NetappVolumeReplication

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication google_netapp_volume_replication}.

Initializers

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

new netappVolumeReplication.NetappVolumeReplication(scope: Construct, id: string, config: NetappVolumeReplicationConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config NetappVolumeReplicationConfig 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".
putDestinationVolumeParameters No description.
putTimeouts No description.
resetDeleteDestinationVolume No description.
resetDescription No description.
resetDestinationVolumeParameters No description.
resetForceStopping No description.
resetId No description.
resetLabels No description.
resetProject No description.
resetReplicationEnabled No description.
resetTimeouts No description.
resetWaitForMirror 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".


putDestinationVolumeParameters
public putDestinationVolumeParameters(value: NetappVolumeReplicationDestinationVolumeParameters): void
valueRequired

putTimeouts
public putTimeouts(value: NetappVolumeReplicationTimeouts): void
valueRequired

resetDeleteDestinationVolume
public resetDeleteDestinationVolume(): void
resetDescription
public resetDescription(): void
resetDestinationVolumeParameters
public resetDestinationVolumeParameters(): void
resetForceStopping
public resetForceStopping(): void
resetId
public resetId(): void
resetLabels
public resetLabels(): void
resetProject
public resetProject(): void
resetReplicationEnabled
public resetReplicationEnabled(): void
resetTimeouts
public resetTimeouts(): void
resetWaitForMirror
public resetWaitForMirror(): 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 NetappVolumeReplication resource upon running "cdktf plan ".

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

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

netappVolumeReplication.NetappVolumeReplication.isTerraformElement(x: any)
xRequired
  • Type: any

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

netappVolumeReplication.NetappVolumeReplication.isTerraformResource(x: any)
xRequired
  • Type: any

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

netappVolumeReplication.NetappVolumeReplication.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing NetappVolumeReplication that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#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 NetappVolumeReplication 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.
createTime string No description.
destinationVolume string No description.
destinationVolumeParameters NetappVolumeReplicationDestinationVolumeParametersOutputReference No description.
effectiveLabels cdktf.StringMap No description.
healthy cdktf.IResolvable No description.
mirrorState string No description.
role string No description.
sourceVolume string No description.
state string No description.
stateDetails string No description.
terraformLabels cdktf.StringMap No description.
timeouts NetappVolumeReplicationTimeoutsOutputReference No description.
transferStats NetappVolumeReplicationTransferStatsList No description.
deleteDestinationVolumeInput boolean | cdktf.IResolvable No description.
descriptionInput string No description.
destinationVolumeParametersInput NetappVolumeReplicationDestinationVolumeParameters No description.
forceStoppingInput boolean | cdktf.IResolvable No description.
idInput string No description.
labelsInput {[ key: string ]: string} No description.
locationInput string No description.
nameInput string No description.
projectInput string No description.
replicationEnabledInput boolean | cdktf.IResolvable No description.
replicationScheduleInput string No description.
timeoutsInput cdktf.IResolvable | NetappVolumeReplicationTimeouts No description.
volumeNameInput string No description.
waitForMirrorInput boolean | cdktf.IResolvable No description.
deleteDestinationVolume boolean | cdktf.IResolvable No description.
description string No description.
forceStopping boolean | cdktf.IResolvable No description.
id string No description.
labels {[ key: string ]: string} No description.
location string No description.
name string No description.
project string No description.
replicationEnabled boolean | cdktf.IResolvable No description.
replicationSchedule string No description.
volumeName string No description.
waitForMirror boolean | cdktf.IResolvable 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[]

createTimeRequired
public readonly createTime: string;
  • Type: string

destinationVolumeRequired
public readonly destinationVolume: string;
  • Type: string

destinationVolumeParametersRequired
public readonly destinationVolumeParameters: NetappVolumeReplicationDestinationVolumeParametersOutputReference;

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

healthyRequired
public readonly healthy: IResolvable;
  • Type: cdktf.IResolvable

mirrorStateRequired
public readonly mirrorState: string;
  • Type: string

roleRequired
public readonly role: string;
  • Type: string

sourceVolumeRequired
public readonly sourceVolume: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

stateDetailsRequired
public readonly stateDetails: string;
  • Type: string

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

timeoutsRequired
public readonly timeouts: NetappVolumeReplicationTimeoutsOutputReference;

transferStatsRequired
public readonly transferStats: NetappVolumeReplicationTransferStatsList;

deleteDestinationVolumeInputOptional
public readonly deleteDestinationVolumeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

destinationVolumeParametersInputOptional
public readonly destinationVolumeParametersInput: NetappVolumeReplicationDestinationVolumeParameters;

forceStoppingInputOptional
public readonly forceStoppingInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

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

locationInputOptional
public readonly locationInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

replicationEnabledInputOptional
public readonly replicationEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

replicationScheduleInputOptional
public readonly replicationScheduleInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | NetappVolumeReplicationTimeouts;

volumeNameInputOptional
public readonly volumeNameInput: string;
  • Type: string

waitForMirrorInputOptional
public readonly waitForMirrorInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

deleteDestinationVolumeRequired
public readonly deleteDestinationVolume: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionRequired
public readonly description: string;
  • Type: string

forceStoppingRequired
public readonly forceStopping: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

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

locationRequired
public readonly location: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

replicationEnabledRequired
public readonly replicationEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

replicationScheduleRequired
public readonly replicationSchedule: string;
  • Type: string

volumeNameRequired
public readonly volumeName: string;
  • Type: string

waitForMirrorRequired
public readonly waitForMirror: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

NetappVolumeReplicationConfig

Initializer

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

const netappVolumeReplicationConfig: netappVolumeReplication.NetappVolumeReplicationConfig = { ... }

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.
location string Name of region for this resource. The resource needs to be created in the region of the destination volume.
name string The name of the replication. Needs to be unique per location.
replicationSchedule string Specifies the replication interval. Possible values: ["EVERY_10_MINUTES", "HOURLY", "DAILY"].
volumeName string The name of the existing source volume.
deleteDestinationVolume boolean | cdktf.IResolvable A destination volume is created as part of replication creation.
description string An description of this resource.
destinationVolumeParameters NetappVolumeReplicationDestinationVolumeParameters destination_volume_parameters block.
forceStopping boolean | cdktf.IResolvable Only replications with mirror_state=MIRRORED can be stopped.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#id NetappVolumeReplication#id}.
labels {[ key: string ]: string} Labels as key value pairs. Example: '{ "owner": "Bob", "department": "finance", "purpose": "testing" }'.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#project NetappVolumeReplication#project}.
replicationEnabled boolean | cdktf.IResolvable Set to false to stop/break the mirror.
timeouts NetappVolumeReplicationTimeouts timeouts block.
waitForMirror boolean | cdktf.IResolvable Replication resource state is independent of mirror_state.

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[]

locationRequired
public readonly location: string;
  • Type: string

Name of region for this resource. The resource needs to be created in the region of the destination volume.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#location NetappVolumeReplication#location}


nameRequired
public readonly name: string;
  • Type: string

The name of the replication. Needs to be unique per location.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#name NetappVolumeReplication#name}


replicationScheduleRequired
public readonly replicationSchedule: string;
  • Type: string

Specifies the replication interval. Possible values: ["EVERY_10_MINUTES", "HOURLY", "DAILY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#replication_schedule NetappVolumeReplication#replication_schedule}


volumeNameRequired
public readonly volumeName: string;
  • Type: string

The name of the existing source volume.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#volume_name NetappVolumeReplication#volume_name}


deleteDestinationVolumeOptional
public readonly deleteDestinationVolume: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

A destination volume is created as part of replication creation.

The destination volume will not became under Terraform management unless you import it manually. If you delete the replication, this volume will remain. Setting this parameter to true will delete the current destination volume when destroying the replication. If you reversed the replication direction, this will be your former source volume! For production use, it is recommended to keep this parameter false to avoid accidental volume deletion. Handle with care. Default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#delete_destination_volume NetappVolumeReplication#delete_destination_volume}


descriptionOptional
public readonly description: string;
  • Type: string

An description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#description NetappVolumeReplication#description}


destinationVolumeParametersOptional
public readonly destinationVolumeParameters: NetappVolumeReplicationDestinationVolumeParameters;

destination_volume_parameters block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#destination_volume_parameters NetappVolumeReplication#destination_volume_parameters}


forceStoppingOptional
public readonly forceStopping: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Only replications with mirror_state=MIRRORED can be stopped.

A replication in mirror_state=TRANSFERRING currently receives an update and stopping the update might be undesirable. Set this parameter to true to stop anyway. All data transferred to the destination will be discarded and content of destination volume will remain at the state of the last successful update. Default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#force_stopping NetappVolumeReplication#force_stopping}


idOptional
public readonly id: string;
  • Type: string

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


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.17.0/docs/resources/netapp_volume_replication#labels NetappVolumeReplication#labels}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#project NetappVolumeReplication#project}.


replicationEnabledOptional
public readonly replicationEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Set to false to stop/break the mirror.

Stopping the mirror makes the destination volume read-write and act independently from the source volume. Set to true to enable/resume the mirror. WARNING: Resuming a mirror overwrites any changes done to the destination volume with the content of the source volume.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#replication_enabled NetappVolumeReplication#replication_enabled}


timeoutsOptional
public readonly timeouts: NetappVolumeReplicationTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#timeouts NetappVolumeReplication#timeouts}


waitForMirrorOptional
public readonly waitForMirror: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Replication resource state is independent of mirror_state.

With enough data, it can take many hours for mirror_state to reach MIRRORED. If you want Terraform to wait for the mirror to finish on create/stop/resume operations, set this parameter to true. Default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#wait_for_mirror NetappVolumeReplication#wait_for_mirror}


NetappVolumeReplicationDestinationVolumeParameters

Initializer

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

const netappVolumeReplicationDestinationVolumeParameters: netappVolumeReplication.NetappVolumeReplicationDestinationVolumeParameters = { ... }

Properties

Name Type Description
storagePool string Name of an existing storage pool for the destination volume with format: 'projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}'.
description string Description for the destination volume.
shareName string Share name for destination volume. If not specified, name of source volume's share name will be used.
volumeId string Name for the destination volume to be created.

storagePoolRequired
public readonly storagePool: string;
  • Type: string

Name of an existing storage pool for the destination volume with format: 'projects/{{project}}/locations/{{location}}/storagePools/{{poolId}}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#storage_pool NetappVolumeReplication#storage_pool}


descriptionOptional
public readonly description: string;
  • Type: string

Description for the destination volume.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#description NetappVolumeReplication#description}


shareNameOptional
public readonly shareName: string;
  • Type: string

Share name for destination volume. If not specified, name of source volume's share name will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#share_name NetappVolumeReplication#share_name}


volumeIdOptional
public readonly volumeId: string;
  • Type: string

Name for the destination volume to be created.

If not specified, the name of the source volume will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#volume_id NetappVolumeReplication#volume_id}


NetappVolumeReplicationTimeouts

Initializer

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

const netappVolumeReplicationTimeouts: netappVolumeReplication.NetappVolumeReplicationTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#create NetappVolumeReplication#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#delete NetappVolumeReplication#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/netapp_volume_replication#update NetappVolumeReplication#update}.


NetappVolumeReplicationTransferStats

Initializer

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

const netappVolumeReplicationTransferStats: netappVolumeReplication.NetappVolumeReplicationTransferStats = { ... }

Classes

NetappVolumeReplicationDestinationVolumeParametersOutputReference

Initializers

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

new netappVolumeReplication.NetappVolumeReplicationDestinationVolumeParametersOutputReference(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.
resetDescription No description.
resetShareName No description.
resetVolumeId 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.

resetDescription
public resetDescription(): void
resetShareName
public resetShareName(): void
resetVolumeId
public resetVolumeId(): 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.
descriptionInput string No description.
shareNameInput string No description.
storagePoolInput string No description.
volumeIdInput string No description.
description string No description.
shareName string No description.
storagePool string No description.
volumeId string No description.
internalValue NetappVolumeReplicationDestinationVolumeParameters 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

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

shareNameInputOptional
public readonly shareNameInput: string;
  • Type: string

storagePoolInputOptional
public readonly storagePoolInput: string;
  • Type: string

volumeIdInputOptional
public readonly volumeIdInput: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

shareNameRequired
public readonly shareName: string;
  • Type: string

storagePoolRequired
public readonly storagePool: string;
  • Type: string

volumeIdRequired
public readonly volumeId: string;
  • Type: string

internalValueOptional
public readonly internalValue: NetappVolumeReplicationDestinationVolumeParameters;

NetappVolumeReplicationTimeoutsOutputReference

Initializers

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

new netappVolumeReplication.NetappVolumeReplicationTimeoutsOutputReference(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 | NetappVolumeReplicationTimeouts 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 | NetappVolumeReplicationTimeouts;

NetappVolumeReplicationTransferStatsList

Initializers

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

new netappVolumeReplication.NetappVolumeReplicationTransferStatsList(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): NetappVolumeReplicationTransferStatsOutputReference
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

NetappVolumeReplicationTransferStatsOutputReference

Initializers

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

new netappVolumeReplication.NetappVolumeReplicationTransferStatsOutputReference(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.
lagDuration string No description.
lastTransferBytes string No description.
lastTransferDuration string No description.
lastTransferEndTime string No description.
lastTransferError string No description.
totalTransferDuration string No description.
transferBytes string No description.
updateTime string No description.
internalValue NetappVolumeReplicationTransferStats 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

lagDurationRequired
public readonly lagDuration: string;
  • Type: string

lastTransferBytesRequired
public readonly lastTransferBytes: string;
  • Type: string

lastTransferDurationRequired
public readonly lastTransferDuration: string;
  • Type: string

lastTransferEndTimeRequired
public readonly lastTransferEndTime: string;
  • Type: string

lastTransferErrorRequired
public readonly lastTransferError: string;
  • Type: string

totalTransferDurationRequired
public readonly totalTransferDuration: string;
  • Type: string

transferBytesRequired
public readonly transferBytes: string;
  • Type: string

updateTimeRequired
public readonly updateTime: string;
  • Type: string

internalValueOptional
public readonly internalValue: NetappVolumeReplicationTransferStats;