`dataVaultTransitEncrypt` Submodule

Constructs

DataVaultTransitEncrypt

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

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultTransitEncrypt(Construct Scope, string Id, DataVaultTransitEncryptConfig Config);

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

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.
`ResetContext`	No description.
`ResetId`	No description.
`ResetKeyVersion`	No description.
`ResetNamespace`	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

`ResetContext`

private void ResetContext()

`ResetId`

private void ResetId()

`ResetKeyVersion`

private void ResetKeyVersion()

`ResetNamespace`

private void ResetNamespace()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Vault;

DataVaultTransitEncrypt.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;

DataVaultTransitEncrypt.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformDataSource`

using HashiCorp.Cdktf.Providers.Vault;

DataVaultTransitEncrypt.IsTerraformDataSource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Vault;

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

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

`ImportFromId`^Required

Type: string

The id of the existing DataVaultTransitEncrypt that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#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 DataVaultTransitEncrypt 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.
`Ciphertext`	`string`	No description.
`BackendInput`	`string`	No description.
`ContextInput`	`string`	No description.
`IdInput`	`string`	No description.
`KeyInput`	`string`	No description.
`KeyVersionInput`	`double`	No description.
`NamespaceInput`	`string`	No description.
`PlaintextInput`	`string`	No description.
`Backend`	`string`	No description.
`Context`	`string`	No description.
`Id`	`string`	No description.
`Key`	`string`	No description.
`KeyVersion`	`double`	No description.
`Namespace`	`string`	No description.
`Plaintext`	`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

`Ciphertext`^Required

public string Ciphertext { get; }

Type: string

`BackendInput`^Optional

public string BackendInput { get; }

Type: string

`ContextInput`^Optional

public string ContextInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`KeyInput`^Optional

public string KeyInput { get; }

Type: string

`KeyVersionInput`^Optional

public double KeyVersionInput { get; }

Type: double

`NamespaceInput`^Optional

public string NamespaceInput { get; }

Type: string

`PlaintextInput`^Optional

public string PlaintextInput { get; }

Type: string

`Backend`^Required

public string Backend { get; }

Type: string

`Context`^Required

public string Context { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`Key`^Required

public string Key { get; }

Type: string

`KeyVersion`^Required

public double KeyVersion { get; }

Type: double

`Namespace`^Required

public string Namespace { get; }

Type: string

`Plaintext`^Required

public string Plaintext { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

DataVaultTransitEncryptConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultTransitEncryptConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Backend,
    string Key,
    string Plaintext,
    string Context = null,
    string Id = null,
    double KeyVersion = null,
    string Namespace = 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.
`Backend`	`string`	The Transit secret backend the key belongs to.
`Key`	`string`	Name of the encryption key to use.
`Plaintext`	`string`	Map of strings read from Vault.
`Context`	`string`	Specifies the context for key derivation.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#id DataVaultTransitEncrypt#id}.
`KeyVersion`	`double`	The version of the key to use for encryption.
`Namespace`	`string`	Target namespace. (requires Enterprise).

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

`Backend`^Required

public string Backend { get; set; }

Type: string

The Transit secret backend the key belongs to.

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

`Key`^Required

public string Key { get; set; }

Type: string

Name of the encryption key to use.

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

`Plaintext`^Required

public string Plaintext { get; set; }

Type: string

Map of strings read from Vault.

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

`Context`^Optional

public string Context { get; set; }

Type: string

Specifies the context for key derivation.

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

`Id`^Optional

public string Id { get; set; }

Type: string

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

`KeyVersion`^Optional

public double KeyVersion { get; set; }

Type: double

The version of the key to use for encryption.

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

`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.2.0/docs/data-sources/transit_encrypt#namespace DataVaultTransitEncrypt#namespace}

Files

dataVaultTransitEncrypt.csharp.md

Latest commit

History

dataVaultTransitEncrypt.csharp.md

File metadata and controls

dataVaultTransitEncrypt Submodule

Constructs