dataVaultTransformEncode.csharp.md

dataVaultTransformEncode Submodule

Constructs

DataVaultTransformEncode

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/transform_encode vault_transform_encode}.

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultTransformEncode(Construct Scope, string Id, DataVaultTransformEncodeConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	DataVaultTransformEncodeConfig	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: DataVaultTransformEncodeConfig

---

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.
ResetEncodedValue	No description.
ResetId	No description.
ResetNamespace	No description.
ResetTransformation	No description.
ResetTweak	No description.
ResetValue	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetBatchInput

private void ResetBatchInput()

ResetBatchResults

private void ResetBatchResults()

ResetEncodedValue

private void ResetEncodedValue()

ResetId

private void ResetId()

ResetNamespace

private void ResetNamespace()

ResetTransformation

private void ResetTransformation()

ResetTweak

private void ResetTweak()

ResetValue

private void ResetValue()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformDataSource	No description.
GenerateConfigForImport	Generates CDKTF code for importing a DataVaultTransformEncode resource upon running "cdktf plan ".

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

DataVaultTransformEncode.IsConstruct(object X);

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: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Vault;

DataVaultTransformEncode.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Vault;

DataVaultTransformEncode.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

DataVaultTransformEncode.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

---

ImportFromId^Required

• Type: string

The id of the existing DataVaultTransformEncode that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
BatchInputInput	object	No description.
BatchResultsInput	object	No description.
EncodedValueInput	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	object	No description.
BatchResults	object	No description.
EncodedValue	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 Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

BatchInputInput^Optional

public object BatchInputInput { get; }

• Type: object

---

BatchResultsInput^Optional

public object BatchResultsInput { get; }

• Type: object

---

EncodedValueInput^Optional

public string EncodedValueInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

PathInput^Optional

public string PathInput { get; }

• Type: string

---

RoleNameInput^Optional

public string RoleNameInput { get; }

• Type: string

---

TransformationInput^Optional

public string TransformationInput { get; }

• Type: string

---

TweakInput^Optional

public string TweakInput { get; }

• Type: string

---

ValueInput^Optional

public string ValueInput { get; }

• Type: string

---

BatchInput^Required

public object BatchInput { get; }

• Type: object

---

BatchResults^Required

public object BatchResults { get; }

• Type: object

---

EncodedValue^Required

public string EncodedValue { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

Path^Required

public string Path { get; }

• Type: string

---

RoleName^Required

public string RoleName { get; }

• Type: string

---

Transformation^Required

public string Transformation { get; }

• Type: string

---

Tweak^Required

public string Tweak { get; }

• Type: string

---

Value^Required

public string Value { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataVaultTransformEncodeConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultTransformEncodeConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Path,
    string RoleName,
    object BatchInput = null,
    object BatchResults = null,
    string EncodedValue = null,
    string Id = null,
    string Namespace = null,
    string Transformation = null,
    string Tweak = null,
    string Value = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Path	string	Path to backend from which to retrieve data.
RoleName	string	The name of the role.
BatchInput	object	Specifies a list of items to be encoded in a single batch.
BatchResults	object	The result of encoding batch_input.
EncodedValue	string	The result of encoding a value.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/transform_encode#id DataVaultTransformEncode#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 encode.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Path^Required

public string Path { get; set; }

• Type: string

Path to backend from which to retrieve data.

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

---

RoleName^Required

public string RoleName { get; set; }

• Type: string

The name of the role.

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

---

BatchInput^Optional

public object BatchInput { get; set; }

• Type: object

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

If this parameter is set, the 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.5.0/docs/data-sources/transform_encode#batch_input DataVaultTransformEncode#batch_input}

---

BatchResults^Optional

public object BatchResults { get; set; }

• Type: object

The result of encoding batch_input.

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

---

EncodedValue^Optional

public string EncodedValue { get; set; }

• Type: string

The result of encoding a value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/transform_encode#encoded_value DataVaultTransformEncode#encoded_value}

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/transform_encode#id DataVaultTransformEncode#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 string Namespace { get; set; }

• Type: string

Target namespace. (requires Enterprise).

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

---

Transformation^Optional

public string Transformation { get; set; }

• 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.5.0/docs/data-sources/transform_encode#transformation DataVaultTransformEncode#transformation}

---

Tweak^Optional

public string Tweak { get; set; }

• 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.5.0/docs/data-sources/transform_encode#tweak DataVaultTransformEncode#tweak}

---

Value^Optional

public string Value { get; set; }

• Type: string

The value in which to encode.

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

---