mfatotp

README

vault_mfa_totp

Refer to the Terraform Registory for docs: vault_mfa_totp.

Documentation

Index

• func MfaTotp_IsConstruct(x interface{}) *bool
• func MfaTotp_IsTerraformElement(x interface{}) *bool
• func MfaTotp_IsTerraformResource(x interface{}) *bool
• func MfaTotp_TfResourceType() *string
• func NewMfaTotp_Override(m MfaTotp, scope constructs.Construct, id *string, config *MfaTotpConfig)
• type MfaTotp
  • func NewMfaTotp(scope constructs.Construct, id *string, config *MfaTotpConfig) MfaTotp
• type MfaTotpConfig

Functions

func MfaTotp_IsConstruct

func MfaTotp_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func MfaTotp_IsTerraformElement

func MfaTotp_IsTerraformElement(x interface{}) *bool

Experimental.

func MfaTotp_IsTerraformResource

func MfaTotp_IsTerraformResource(x interface{}) *bool

Experimental.

func MfaTotp_TfResourceType

func MfaTotp_TfResourceType() *string

func NewMfaTotp_Override

func NewMfaTotp_Override(m MfaTotp, scope constructs.Construct, id *string, config *MfaTotpConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp vault_mfa_totp} Resource.

Types

type MfaTotp

type MfaTotp interface {
	cdktf.TerraformResource
	Algorithm() *string
	SetAlgorithm(val *string)
	AlgorithmInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Digits() *float64
	SetDigits(val *float64)
	DigitsInput() *float64
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	Issuer() *string
	SetIssuer(val *string)
	IssuerInput() *string
	KeySize() *float64
	SetKeySize(val *float64)
	KeySizeInput() *float64
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	Period() *float64
	SetPeriod(val *float64)
	PeriodInput() *float64
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	QrSize() *float64
	SetQrSize(val *float64)
	QrSizeInput() *float64
	// Experimental.
	RawOverrides() interface{}
	Skew() *float64
	SetSkew(val *float64)
	SkewInput() *float64
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlgorithm()
	ResetDigits()
	ResetId()
	ResetKeySize()
	ResetNamespace()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPeriod()
	ResetQrSize()
	ResetSkew()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp vault_mfa_totp}.

func NewMfaTotp

func NewMfaTotp(scope constructs.Construct, id *string, config *MfaTotpConfig) MfaTotp

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp vault_mfa_totp} Resource.

type MfaTotpConfig

type MfaTotpConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The name of the key's issuing organization.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#issuer MfaTotp#issuer}
	Issuer *string `field:"required" json:"issuer" yaml:"issuer"`
	// Name of the MFA method.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#name MfaTotp#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// Specifies the hashing algorithm used to generate the TOTP code. Options include 'SHA1', 'SHA256' and 'SHA512'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#algorithm MfaTotp#algorithm}
	Algorithm *string `field:"optional" json:"algorithm" yaml:"algorithm"`
	// 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/3.16.0/docs/resources/mfa_totp#digits MfaTotp#digits}
	Digits *float64 `field:"optional" json:"digits" yaml:"digits"`
	// ID computed by Vault.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#id MfaTotp#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Specifies the size in bytes of the generated key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#key_size MfaTotp#key_size}
	KeySize *float64 `field:"optional" json:"keySize" yaml:"keySize"`
	// Target namespace. (requires Enterprise).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#namespace MfaTotp#namespace}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// The length of time used to generate a counter for the TOTP token calculation.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#period MfaTotp#period}
	Period *float64 `field:"optional" json:"period" yaml:"period"`
	// The pixel size of the generated square QR code.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.16.0/docs/resources/mfa_totp#qr_size MfaTotp#qr_size}
	QrSize *float64 `field:"optional" json:"qrSize" yaml:"qrSize"`
	// 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/3.16.0/docs/resources/mfa_totp#skew MfaTotp#skew}
	Skew *float64 `field:"optional" json:"skew" yaml:"skew"`
}