Skip to content

Latest commit

 

History

History
1457 lines (900 loc) · 68.1 KB

sdrsReplicationPairV1.typescript.md

File metadata and controls

1457 lines (900 loc) · 68.1 KB

sdrsReplicationPairV1 Submodule

Constructs

SdrsReplicationPairV1

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1 opentelekomcloud_sdrs_replication_pair_v1}.

Initializers

import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

new sdrsReplicationPairV1.SdrsReplicationPairV1(scope: Construct, id: string, config: SdrsReplicationPairV1Config)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config SdrsReplicationPairV1Config 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.
resetDeleteTargetVolume No description.
resetDescription No description.
resetId 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: SdrsReplicationPairV1Timeouts): void
valueRequired

resetDeleteTargetVolume
public resetDeleteTargetVolume(): void
resetDescription
public resetDescription(): void
resetId
public resetId(): 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 SdrsReplicationPairV1 resource upon running "cdktf plan ".

isConstruct
import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

sdrsReplicationPairV1.SdrsReplicationPairV1.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 { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

sdrsReplicationPairV1.SdrsReplicationPairV1.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

sdrsReplicationPairV1.SdrsReplicationPairV1.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

sdrsReplicationPairV1.SdrsReplicationPairV1.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing SdrsReplicationPairV1 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#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 SdrsReplicationPairV1 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.
faultLevel string No description.
region string No description.
replicationModel string No description.
status string No description.
targetVolumeId string No description.
timeouts SdrsReplicationPairV1TimeoutsOutputReference No description.
deleteTargetVolumeInput boolean | cdktf.IResolvable No description.
descriptionInput string No description.
groupIdInput string No description.
idInput string No description.
nameInput string No description.
timeoutsInput cdktf.IResolvable | SdrsReplicationPairV1Timeouts No description.
volumeIdInput string No description.
deleteTargetVolume boolean | cdktf.IResolvable No description.
description string No description.
groupId string No description.
id string No description.
name string No description.
volumeId 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[]

faultLevelRequired
public readonly faultLevel: string;
  • Type: string

regionRequired
public readonly region: string;
  • Type: string

replicationModelRequired
public readonly replicationModel: string;
  • Type: string

statusRequired
public readonly status: string;
  • Type: string

targetVolumeIdRequired
public readonly targetVolumeId: string;
  • Type: string

timeoutsRequired
public readonly timeouts: SdrsReplicationPairV1TimeoutsOutputReference;

deleteTargetVolumeInputOptional
public readonly deleteTargetVolumeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

groupIdInputOptional
public readonly groupIdInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | SdrsReplicationPairV1Timeouts;

volumeIdInputOptional
public readonly volumeIdInput: string;
  • Type: string

deleteTargetVolumeRequired
public readonly deleteTargetVolume: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionRequired
public readonly description: string;
  • Type: string

groupIdRequired
public readonly groupId: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

volumeIdRequired
public readonly volumeId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

SdrsReplicationPairV1Config

Initializer

import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

const sdrsReplicationPairV1Config: sdrsReplicationPairV1.SdrsReplicationPairV1Config = { ... }

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.
groupId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#group_id SdrsReplicationPairV1#group_id}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#name SdrsReplicationPairV1#name}.
volumeId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#volume_id SdrsReplicationPairV1#volume_id}.
deleteTargetVolume boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#delete_target_volume SdrsReplicationPairV1#delete_target_volume}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#description SdrsReplicationPairV1#description}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#id SdrsReplicationPairV1#id}.
timeouts SdrsReplicationPairV1Timeouts 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[]

groupIdRequired
public readonly groupId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#group_id SdrsReplicationPairV1#group_id}.


nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#name SdrsReplicationPairV1#name}.


volumeIdRequired
public readonly volumeId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#volume_id SdrsReplicationPairV1#volume_id}.


deleteTargetVolumeOptional
public readonly deleteTargetVolume: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#delete_target_volume SdrsReplicationPairV1#delete_target_volume}.


descriptionOptional
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#description SdrsReplicationPairV1#description}.


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#id SdrsReplicationPairV1#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.


timeoutsOptional
public readonly timeouts: SdrsReplicationPairV1Timeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#timeouts SdrsReplicationPairV1#timeouts}


SdrsReplicationPairV1Timeouts

Initializer

import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

const sdrsReplicationPairV1Timeouts: sdrsReplicationPairV1.SdrsReplicationPairV1Timeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#create SdrsReplicationPairV1#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#delete SdrsReplicationPairV1#delete}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#create SdrsReplicationPairV1#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/sdrs_replication_pair_v1#delete SdrsReplicationPairV1#delete}.


Classes

SdrsReplicationPairV1TimeoutsOutputReference

Initializers

import { sdrsReplicationPairV1 } from '@cdktf/provider-opentelekomcloud'

new sdrsReplicationPairV1.SdrsReplicationPairV1TimeoutsOutputReference(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.

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

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.
create string No description.
delete string No description.
internalValue cdktf.IResolvable | SdrsReplicationPairV1Timeouts 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

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | SdrsReplicationPairV1Timeouts;