transitSecretBackendKey.csharp.md

transitSecretBackendKey Submodule

Constructs

TransitSecretBackendKey

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key vault_transit_secret_backend_key}.

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new TransitSecretBackendKey(Construct Scope, string Id, TransitSecretBackendKeyConfig Config);

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

---

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".
ResetAllowPlaintextBackup	No description.
ResetAutoRotatePeriod	No description.
ResetConvergentEncryption	No description.
ResetDeletionAllowed	No description.
ResetDerived	No description.
ResetExportable	No description.
ResetId	No description.
ResetKeySize	No description.
ResetMinDecryptionVersion	No description.
ResetMinEncryptionVersion	No description.
ResetNamespace	No description.
ResetType	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()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

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

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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.

Id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

MoveTo

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

Index^Optional

• Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

MoveToId

private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

Id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

ResetAllowPlaintextBackup

private void ResetAllowPlaintextBackup()

ResetAutoRotatePeriod

private void ResetAutoRotatePeriod()

ResetConvergentEncryption

private void ResetConvergentEncryption()

ResetDeletionAllowed

private void ResetDeletionAllowed()

ResetDerived

private void ResetDerived()

ResetExportable

private void ResetExportable()

ResetId

private void ResetId()

ResetKeySize

private void ResetKeySize()

ResetMinDecryptionVersion

private void ResetMinDecryptionVersion()

ResetMinEncryptionVersion

private void ResetMinEncryptionVersion()

ResetNamespace

private void ResetNamespace()

ResetType

private void ResetType()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

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

TransitSecretBackendKey.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Vault;

TransitSecretBackendKey.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing TransitSecretBackendKey that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#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 TransitSecretBackendKey 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.
Connection	object	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.
Provisioners	object[]	No description.
Keys	HashiCorp.Cdktf.StringMapList	No description.
LatestVersion	double	No description.
MinAvailableVersion	double	No description.
SupportsDecryption	HashiCorp.Cdktf.IResolvable	No description.
SupportsDerivation	HashiCorp.Cdktf.IResolvable	No description.
SupportsEncryption	HashiCorp.Cdktf.IResolvable	No description.
SupportsSigning	HashiCorp.Cdktf.IResolvable	No description.
AllowPlaintextBackupInput	object	No description.
AutoRotatePeriodInput	double	No description.
BackendInput	string	No description.
ConvergentEncryptionInput	object	No description.
DeletionAllowedInput	object	No description.
DerivedInput	object	No description.
ExportableInput	object	No description.
IdInput	string	No description.
KeySizeInput	double	No description.
MinDecryptionVersionInput	double	No description.
MinEncryptionVersionInput	double	No description.
NameInput	string	No description.
NamespaceInput	string	No description.
TypeInput	string	No description.
AllowPlaintextBackup	object	No description.
AutoRotatePeriod	double	No description.
Backend	string	No description.
ConvergentEncryption	object	No description.
DeletionAllowed	object	No description.
Derived	object	No description.
Exportable	object	No description.
Id	string	No description.
KeySize	double	No description.
MinDecryptionVersion	double	No description.
MinEncryptionVersion	double	No description.
Name	string	No description.
Namespace	string	No description.
Type	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

---

Connection^Optional

public object Connection { get; }

• Type: object

---

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

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

Keys^Required

public StringMapList Keys { get; }

• Type: HashiCorp.Cdktf.StringMapList

---

LatestVersion^Required

public double LatestVersion { get; }

• Type: double

---

MinAvailableVersion^Required

public double MinAvailableVersion { get; }

• Type: double

---

SupportsDecryption^Required

public IResolvable SupportsDecryption { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

SupportsDerivation^Required

public IResolvable SupportsDerivation { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

SupportsEncryption^Required

public IResolvable SupportsEncryption { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

SupportsSigning^Required

public IResolvable SupportsSigning { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

AllowPlaintextBackupInput^Optional

public object AllowPlaintextBackupInput { get; }

• Type: object

---

AutoRotatePeriodInput^Optional

public double AutoRotatePeriodInput { get; }

• Type: double

---

BackendInput^Optional

public string BackendInput { get; }

• Type: string

---

ConvergentEncryptionInput^Optional

public object ConvergentEncryptionInput { get; }

• Type: object

---

DeletionAllowedInput^Optional

public object DeletionAllowedInput { get; }

• Type: object

---

DerivedInput^Optional

public object DerivedInput { get; }

• Type: object

---

ExportableInput^Optional

public object ExportableInput { get; }

• Type: object

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

KeySizeInput^Optional

public double KeySizeInput { get; }

• Type: double

---

MinDecryptionVersionInput^Optional

public double MinDecryptionVersionInput { get; }

• Type: double

---

MinEncryptionVersionInput^Optional

public double MinEncryptionVersionInput { get; }

• Type: double

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

TypeInput^Optional

public string TypeInput { get; }

• Type: string

---

AllowPlaintextBackup^Required

public object AllowPlaintextBackup { get; }

• Type: object

---

AutoRotatePeriod^Required

public double AutoRotatePeriod { get; }

• Type: double

---

Backend^Required

public string Backend { get; }

• Type: string

---

ConvergentEncryption^Required

public object ConvergentEncryption { get; }

• Type: object

---

DeletionAllowed^Required

public object DeletionAllowed { get; }

• Type: object

---

Derived^Required

public object Derived { get; }

• Type: object

---

Exportable^Required

public object Exportable { get; }

• Type: object

---

Id^Required

public string Id { get; }

• Type: string

---

KeySize^Required

public double KeySize { get; }

• Type: double

---

MinDecryptionVersion^Required

public double MinDecryptionVersion { get; }

• Type: double

---

MinEncryptionVersion^Required

public double MinEncryptionVersion { get; }

• Type: double

---

Name^Required

public string Name { get; }

• Type: string

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

Type^Required

public string Type { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

TransitSecretBackendKeyConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new TransitSecretBackendKeyConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Backend,
    string Name,
    object AllowPlaintextBackup = null,
    double AutoRotatePeriod = null,
    object ConvergentEncryption = null,
    object DeletionAllowed = null,
    object Derived = null,
    object Exportable = null,
    string Id = null,
    double KeySize = null,
    double MinDecryptionVersion = null,
    double MinEncryptionVersion = null,
    string Namespace = null,
    string Type = 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 resource belongs to.
Name	string	Name of the encryption key to create.
AllowPlaintextBackup	object	If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.
AutoRotatePeriod	double	Amount of seconds the key should live before being automatically rotated.
ConvergentEncryption	object	Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext.
DeletionAllowed	object	Specifies if the key is allowed to be deleted.
Derived	object	Specifies if key derivation is to be used.
Exportable	object	Enables keys to be exportable.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#id TransitSecretBackendKey#id}.
KeySize	double	The key size in bytes for algorithms that allow variable key sizes.
MinDecryptionVersion	double	Minimum key version to use for decryption.
MinEncryptionVersion	double	Minimum key version to use for encryption.
Namespace	string	Target namespace. (requires Enterprise).
Type	string	Specifies the type of key to create.

---

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 resource belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#backend TransitSecretBackendKey#backend}

---

Name^Required

public string Name { get; set; }

• Type: string

Name of the encryption key to create.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#name TransitSecretBackendKey#name}

---

AllowPlaintextBackup^Optional

public object AllowPlaintextBackup { get; set; }

• Type: object

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#allow_plaintext_backup TransitSecretBackendKey#allow_plaintext_backup}

---

AutoRotatePeriod^Optional

public double AutoRotatePeriod { get; set; }

• Type: double

Amount of seconds the key should live before being automatically rotated.

A value of 0 disables automatic rotation for the key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#auto_rotate_period TransitSecretBackendKey#auto_rotate_period}

---

ConvergentEncryption^Optional

public object ConvergentEncryption { get; set; }

• Type: object

Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext.

This requires derived to be set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#convergent_encryption TransitSecretBackendKey#convergent_encryption}

---

DeletionAllowed^Optional

public object DeletionAllowed { get; set; }

• Type: object

Specifies if the key is allowed to be deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#deletion_allowed TransitSecretBackendKey#deletion_allowed}

---

Derived^Optional

public object Derived { get; set; }

• Type: object

Specifies if key derivation is to be used.

If enabled, all encrypt/decrypt requests to this key must provide a context which is used for key derivation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#derived TransitSecretBackendKey#derived}

---

Exportable^Optional

public object Exportable { get; set; }

• Type: object

Enables keys to be exportable.

This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#exportable TransitSecretBackendKey#exportable}

---

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/resources/transit_secret_backend_key#id TransitSecretBackendKey#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.

---

KeySize^Optional

public double KeySize { get; set; }

• Type: double

The key size in bytes for algorithms that allow variable key sizes.

Currently only applicable to HMAC; this value must be between 32 and 512.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#key_size TransitSecretBackendKey#key_size}

---

MinDecryptionVersion^Optional

public double MinDecryptionVersion { get; set; }

• Type: double

Minimum key version to use for decryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#min_decryption_version TransitSecretBackendKey#min_decryption_version}

---

MinEncryptionVersion^Optional

public double MinEncryptionVersion { get; set; }

• Type: double

Minimum key version to use for encryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#min_encryption_version TransitSecretBackendKey#min_encryption_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.5.0/docs/resources/transit_secret_backend_key#namespace TransitSecretBackendKey#namespace}

---

Type^Optional

public string Type { get; set; }

• Type: string

Specifies the type of key to create.

The currently-supported types are: aes128-gcm96, aes256-gcm96, chacha20-poly1305, ed25519, ecdsa-p256, ecdsa-p384, ecdsa-p521, hmac, rsa-2048, rsa-3072, rsa-4096

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#type TransitSecretBackendKey#type}

---