dataVaultTransformDecode.typescript.md

dataVaultTransformDecode Submodule

Constructs

DataVaultTransformDecode

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode vault_transform_decode}.

Initializers

import { dataVaultTransformDecode } from '@cdktf/provider-vault'

new dataVaultTransformDecode.DataVaultTransformDecode(scope: Construct, id: string, config: DataVaultTransformDecodeConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataVaultTransformDecodeConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataVaultTransformDecodeConfig

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
resetBatchInput	No description.
resetBatchResults	No description.
resetDecodedValue	No description.
resetId	No description.
resetNamespace	No description.
resetTransformation	No description.
resetTweak	No description.
resetValue	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetBatchInput

public resetBatchInput(): void

resetBatchResults

public resetBatchResults(): void

resetDecodedValue

public resetDecodedValue(): void

resetId

public resetId(): void

resetNamespace

public resetNamespace(): void

resetTransformation

public resetTransformation(): void

resetTweak

public resetTweak(): void

resetValue

public resetValue(): void

Static Functions

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

---

isConstruct

import { dataVaultTransformDecode } from '@cdktf/provider-vault'

dataVaultTransformDecode.DataVaultTransformDecode.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { dataVaultTransformDecode } from '@cdktf/provider-vault'

dataVaultTransformDecode.DataVaultTransformDecode.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataVaultTransformDecode } from '@cdktf/provider-vault'

dataVaultTransformDecode.DataVaultTransformDecode.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataVaultTransformDecode } from '@cdktf/provider-vault'

dataVaultTransformDecode.DataVaultTransformDecode.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataVaultTransformDecode resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the DataVaultTransformDecode to import.

---

importFromId^Required

• Type: string

The id of the existing DataVaultTransformDecode that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataVaultTransformDecode 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.
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.
batchInputInput	cdktf.IResolvable | {[ key: string ]: string}[]	No description.
batchResultsInput	cdktf.IResolvable | {[ key: string ]: string}[]	No description.
decodedValueInput	string	No description.
idInput	string	No description.
namespaceInput	string	No description.
pathInput	string	No description.
roleNameInput	string	No description.
transformationInput	string	No description.
tweakInput	string	No description.
valueInput	string	No description.
batchInput	cdktf.IResolvable | {[ key: string ]: string}[]	No description.
batchResults	cdktf.IResolvable | {[ key: string ]: string}[]	No description.
decodedValue	string	No description.
id	string	No description.
namespace	string	No description.
path	string	No description.
roleName	string	No description.
transformation	string	No description.
tweak	string	No description.
value	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

batchInputInput^Optional

public readonly batchInputInput: IResolvable | {[ key: string ]: string}[];

• Type: cdktf.IResolvable | {[ key: string ]: string}[]

---

batchResultsInput^Optional

public readonly batchResultsInput: IResolvable | {[ key: string ]: string}[];

• Type: cdktf.IResolvable | {[ key: string ]: string}[]

---

decodedValueInput^Optional

public readonly decodedValueInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

roleNameInput^Optional

public readonly roleNameInput: string;

• Type: string

---

transformationInput^Optional

public readonly transformationInput: string;

• Type: string

---

tweakInput^Optional

public readonly tweakInput: string;

• Type: string

---

valueInput^Optional

public readonly valueInput: string;

• Type: string

---

batchInput^Required

public readonly batchInput: IResolvable | {[ key: string ]: string}[];

• Type: cdktf.IResolvable | {[ key: string ]: string}[]

---

batchResults^Required

public readonly batchResults: IResolvable | {[ key: string ]: string}[];

• Type: cdktf.IResolvable | {[ key: string ]: string}[]

---

decodedValue^Required

public readonly decodedValue: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

roleName^Required

public readonly roleName: string;

• Type: string

---

transformation^Required

public readonly transformation: string;

• Type: string

---

tweak^Required

public readonly tweak: string;

• Type: string

---

value^Required

public readonly value: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataVaultTransformDecodeConfig

Initializer

import { dataVaultTransformDecode } from '@cdktf/provider-vault'

const dataVaultTransformDecodeConfig: dataVaultTransformDecode.DataVaultTransformDecodeConfig = { ... }

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.
path	string	Path to backend from which to retrieve data.
roleName	string	The name of the role.
batchInput	cdktf.IResolvable | {[ key: string ]: string}[]	Specifies a list of items to be decoded in a single batch.
batchResults	cdktf.IResolvable | {[ key: string ]: string}[]	The result of decoding batch_input.
decodedValue	string	The result of decoding a value.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#id DataVaultTransformDecode#id}.
namespace	string	Target namespace. (requires Enterprise).
transformation	string	The transformation to perform.
tweak	string	The tweak value to use. Only applicable for FPE transformations.
value	string	The value in which to decode.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

path^Required

public readonly path: string;

• Type: string

Path to backend from which to retrieve data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#path DataVaultTransformDecode#path}

---

roleName^Required

public readonly roleName: string;

• Type: string

The name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#role_name DataVaultTransformDecode#role_name}

---

batchInput^Optional

public readonly batchInput: IResolvable | {[ key: string ]: string}[];

• Type: cdktf.IResolvable | {[ key: string ]: string}[]

Specifies a list of items to be decoded in a single batch.

If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#batch_input DataVaultTransformDecode#batch_input}

---

batchResults^Optional

public readonly batchResults: IResolvable | {[ key: string ]: string}[];

• Type: cdktf.IResolvable | {[ key: string ]: string}[]

The result of decoding batch_input.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#batch_results DataVaultTransformDecode#batch_results}

---

decodedValue^Optional

public readonly decodedValue: string;

• Type: string

The result of decoding a value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#decoded_value DataVaultTransformDecode#decoded_value}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#id DataVaultTransformDecode#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.

---

namespace^Optional

public readonly namespace: string;

• Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#namespace DataVaultTransformDecode#namespace}

---

transformation^Optional

public readonly transformation: string;

• Type: string

The transformation to perform.

If no value is provided and the role contains a single transformation, this value will be inferred from the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#transformation DataVaultTransformDecode#transformation}

---

tweak^Optional

public readonly tweak: string;

• Type: string

The tweak value to use. Only applicable for FPE transformations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#tweak DataVaultTransformDecode#tweak}

---

value^Optional

public readonly value: string;

• Type: string

The value in which to decode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#value DataVaultTransformDecode#value}

---