identityMfaTotp.csharp.md

identityMfaTotp Submodule

Constructs

IdentityMfaTotp

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

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new IdentityMfaTotp(Construct Scope, string Id, IdentityMfaTotpConfig Config);

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

---

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".
ResetAlgorithm	No description.
ResetDigits	No description.
ResetId	No description.
ResetKeySize	No description.
ResetMaxValidationAttempts	No description.
ResetNamespace	No description.
ResetPeriod	No description.
ResetQrSize	No description.
ResetSkew	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".

---

ResetAlgorithm

private void ResetAlgorithm()

ResetDigits

private void ResetDigits()

ResetId

private void ResetId()

ResetKeySize

private void ResetKeySize()

ResetMaxValidationAttempts

private void ResetMaxValidationAttempts()

ResetNamespace

private void ResetNamespace()

ResetPeriod

private void ResetPeriod()

ResetQrSize

private void ResetQrSize()

ResetSkew

private void ResetSkew()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

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

IdentityMfaTotp.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Vault;

IdentityMfaTotp.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing IdentityMfaTotp that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#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 IdentityMfaTotp 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.
MethodId	string	No description.
MountAccessor	string	No description.
Name	string	No description.
NamespaceId	string	No description.
NamespacePath	string	No description.
Type	string	No description.
Uuid	string	No description.
AlgorithmInput	string	No description.
DigitsInput	double	No description.
IdInput	string	No description.
IssuerInput	string	No description.
KeySizeInput	double	No description.
MaxValidationAttemptsInput	double	No description.
NamespaceInput	string	No description.
PeriodInput	double	No description.
QrSizeInput	double	No description.
SkewInput	double	No description.
Algorithm	string	No description.
Digits	double	No description.
Id	string	No description.
Issuer	string	No description.
KeySize	double	No description.
MaxValidationAttempts	double	No description.
Namespace	string	No description.
Period	double	No description.
QrSize	double	No description.
Skew	double	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[]

---

MethodId^Required

public string MethodId { get; }

• Type: string

---

MountAccessor^Required

public string MountAccessor { get; }

• Type: string

---

Name^Required

public string Name { get; }

• Type: string

---

NamespaceId^Required

public string NamespaceId { get; }

• Type: string

---

NamespacePath^Required

public string NamespacePath { get; }

• Type: string

---

Type^Required

public string Type { get; }

• Type: string

---

Uuid^Required

public string Uuid { get; }

• Type: string

---

AlgorithmInput^Optional

public string AlgorithmInput { get; }

• Type: string

---

DigitsInput^Optional

public double DigitsInput { get; }

• Type: double

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

IssuerInput^Optional

public string IssuerInput { get; }

• Type: string

---

KeySizeInput^Optional

public double KeySizeInput { get; }

• Type: double

---

MaxValidationAttemptsInput^Optional

public double MaxValidationAttemptsInput { get; }

• Type: double

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

PeriodInput^Optional

public double PeriodInput { get; }

• Type: double

---

QrSizeInput^Optional

public double QrSizeInput { get; }

• Type: double

---

SkewInput^Optional

public double SkewInput { get; }

• Type: double

---

Algorithm^Required

public string Algorithm { get; }

• Type: string

---

Digits^Required

public double Digits { get; }

• Type: double

---

Id^Required

public string Id { get; }

• Type: string

---

Issuer^Required

public string Issuer { get; }

• Type: string

---

KeySize^Required

public double KeySize { get; }

• Type: double

---

MaxValidationAttempts^Required

public double MaxValidationAttempts { get; }

• Type: double

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

Period^Required

public double Period { get; }

• Type: double

---

QrSize^Required

public double QrSize { get; }

• Type: double

---

Skew^Required

public double Skew { get; }

• Type: double

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

IdentityMfaTotpConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new IdentityMfaTotpConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Issuer,
    string Algorithm = null,
    double Digits = null,
    string Id = null,
    double KeySize = null,
    double MaxValidationAttempts = null,
    string Namespace = null,
    double Period = null,
    double QrSize = null,
    double Skew = 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.
Issuer	string	The name of the key's issuing organization.
Algorithm	string	Specifies the hashing algorithm used to generate the TOTP code. Options include SHA1, SHA256, SHA512.
Digits	double	The number of digits in the generated TOTP token. This value can either be 6 or 8.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#id IdentityMfaTotp#id}.
KeySize	double	Specifies the size in bytes of the generated key.
MaxValidationAttempts	double	The maximum number of consecutive failed validation attempts allowed.
Namespace	string	Target namespace. (requires Enterprise).
Period	double	The length of time in seconds used to generate a counter for the TOTP token calculation.
QrSize	double	The pixel size of the generated square QR code.
Skew	double	The number of delay periods that are allowed when validating a TOTP token.

---

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

---

Issuer^Required

public string Issuer { get; set; }

• Type: string

The name of the key's issuing organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#issuer IdentityMfaTotp#issuer}

---

Algorithm^Optional

public string Algorithm { get; set; }

• Type: string

Specifies the hashing algorithm used to generate the TOTP code. Options include SHA1, SHA256, SHA512.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#algorithm IdentityMfaTotp#algorithm}

---

Digits^Optional

public double Digits { get; set; }

• Type: double

The number of digits in the generated TOTP token. This value can either be 6 or 8.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#digits IdentityMfaTotp#digits}

---

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/identity_mfa_totp#id IdentityMfaTotp#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

Specifies the size in bytes of the generated key.

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

---

MaxValidationAttempts^Optional

public double MaxValidationAttempts { get; set; }

• Type: double

The maximum number of consecutive failed validation attempts allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#max_validation_attempts IdentityMfaTotp#max_validation_attempts}

---

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/identity_mfa_totp#namespace IdentityMfaTotp#namespace}

---

Period^Optional

public double Period { get; set; }

• Type: double

The length of time in seconds used to generate a counter for the TOTP token calculation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#period IdentityMfaTotp#period}

---

QrSize^Optional

public double QrSize { get; set; }

• Type: double

The pixel size of the generated square QR code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#qr_size IdentityMfaTotp#qr_size}

---

Skew^Optional

public double Skew { get; set; }

• Type: double

The number of delay periods that are allowed when validating a TOTP token.

This value can either be 0 or 1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/identity_mfa_totp#skew IdentityMfaTotp#skew}

---