consulSecretBackend.csharp.md

consulSecretBackend Submodule

Constructs

ConsulSecretBackend

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

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new ConsulSecretBackend(Construct Scope, string Id, ConsulSecretBackendConfig Config);

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

---

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".
ResetBootstrap	No description.
ResetCaCert	No description.
ResetClientCert	No description.
ResetClientKey	No description.
ResetDefaultLeaseTtlSeconds	No description.
ResetDescription	No description.
ResetDisableRemount	No description.
ResetId	No description.
ResetLocal	No description.
ResetMaxLeaseTtlSeconds	No description.
ResetNamespace	No description.
ResetPath	No description.
ResetScheme	No description.
ResetToken	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".

---

ResetBootstrap

private void ResetBootstrap()

ResetCaCert

private void ResetCaCert()

ResetClientCert

private void ResetClientCert()

ResetClientKey

private void ResetClientKey()

ResetDefaultLeaseTtlSeconds

private void ResetDefaultLeaseTtlSeconds()

ResetDescription

private void ResetDescription()

ResetDisableRemount

private void ResetDisableRemount()

ResetId

private void ResetId()

ResetLocal

private void ResetLocal()

ResetMaxLeaseTtlSeconds

private void ResetMaxLeaseTtlSeconds()

ResetNamespace

private void ResetNamespace()

ResetPath

private void ResetPath()

ResetScheme

private void ResetScheme()

ResetToken

private void ResetToken()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

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

ConsulSecretBackend.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Vault;

ConsulSecretBackend.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing ConsulSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#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 ConsulSecretBackend 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.
AddressInput	string	No description.
BootstrapInput	object	No description.
CaCertInput	string	No description.
ClientCertInput	string	No description.
ClientKeyInput	string	No description.
DefaultLeaseTtlSecondsInput	double	No description.
DescriptionInput	string	No description.
DisableRemountInput	object	No description.
IdInput	string	No description.
LocalInput	object	No description.
MaxLeaseTtlSecondsInput	double	No description.
NamespaceInput	string	No description.
PathInput	string	No description.
SchemeInput	string	No description.
TokenInput	string	No description.
Address	string	No description.
Bootstrap	object	No description.
CaCert	string	No description.
ClientCert	string	No description.
ClientKey	string	No description.
DefaultLeaseTtlSeconds	double	No description.
Description	string	No description.
DisableRemount	object	No description.
Id	string	No description.
Local	object	No description.
MaxLeaseTtlSeconds	double	No description.
Namespace	string	No description.
Path	string	No description.
Scheme	string	No description.
Token	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[]

---

AddressInput^Optional

public string AddressInput { get; }

• Type: string

---

BootstrapInput^Optional

public object BootstrapInput { get; }

• Type: object

---

CaCertInput^Optional

public string CaCertInput { get; }

• Type: string

---

ClientCertInput^Optional

public string ClientCertInput { get; }

• Type: string

---

ClientKeyInput^Optional

public string ClientKeyInput { get; }

• Type: string

---

DefaultLeaseTtlSecondsInput^Optional

public double DefaultLeaseTtlSecondsInput { get; }

• Type: double

---

DescriptionInput^Optional

public string DescriptionInput { get; }

• Type: string

---

DisableRemountInput^Optional

public object DisableRemountInput { get; }

• Type: object

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

LocalInput^Optional

public object LocalInput { get; }

• Type: object

---

MaxLeaseTtlSecondsInput^Optional

public double MaxLeaseTtlSecondsInput { get; }

• Type: double

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

PathInput^Optional

public string PathInput { get; }

• Type: string

---

SchemeInput^Optional

public string SchemeInput { get; }

• Type: string

---

TokenInput^Optional

public string TokenInput { get; }

• Type: string

---

Address^Required

public string Address { get; }

• Type: string

---

Bootstrap^Required

public object Bootstrap { get; }

• Type: object

---

CaCert^Required

public string CaCert { get; }

• Type: string

---

ClientCert^Required

public string ClientCert { get; }

• Type: string

---

ClientKey^Required

public string ClientKey { get; }

• Type: string

---

DefaultLeaseTtlSeconds^Required

public double DefaultLeaseTtlSeconds { get; }

• Type: double

---

Description^Required

public string Description { get; }

• Type: string

---

DisableRemount^Required

public object DisableRemount { get; }

• Type: object

---

Id^Required

public string Id { get; }

• Type: string

---

Local^Required

public object Local { get; }

• Type: object

---

MaxLeaseTtlSeconds^Required

public double MaxLeaseTtlSeconds { get; }

• Type: double

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

Path^Required

public string Path { get; }

• Type: string

---

Scheme^Required

public string Scheme { get; }

• Type: string

---

Token^Required

public string Token { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

ConsulSecretBackendConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new ConsulSecretBackendConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Address,
    object Bootstrap = null,
    string CaCert = null,
    string ClientCert = null,
    string ClientKey = null,
    double DefaultLeaseTtlSeconds = null,
    string Description = null,
    object DisableRemount = null,
    string Id = null,
    object Local = null,
    double MaxLeaseTtlSeconds = null,
    string Namespace = null,
    string Path = null,
    string Scheme = null,
    string Token = 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.
Address	string	Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
Bootstrap	object	Denotes a backend resource that is used to bootstrap the Consul ACL system.
CaCert	string	CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert	string	Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey	string	Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds	double	Default lease duration for secrets in seconds.
Description	string	Human-friendly description of the mount for the backend.
DisableRemount	object	If set, opts out of mount migration on path updates.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#id ConsulSecretBackend#id}.
Local	object	Specifies if the secret backend is local only.
MaxLeaseTtlSeconds	double	Maximum possible lease duration for secrets in seconds.
Namespace	string	Target namespace. (requires Enterprise).
Path	string	Unique name of the Vault Consul mount to configure.
Scheme	string	Specifies the URL scheme to use. Defaults to "http".
Token	string	Specifies the Consul token to use when managing or issuing new tokens.

---

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

---

Address^Required

public string Address { get; set; }

• Type: string

Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#address ConsulSecretBackend#address}

---

Bootstrap^Optional

public object Bootstrap { get; set; }

• Type: object

Denotes a backend resource that is used to bootstrap the Consul ACL system.

Only one resource may be used to bootstrap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#bootstrap ConsulSecretBackend#bootstrap}

---

CaCert^Optional

public string CaCert { get; set; }

• Type: string

CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#ca_cert ConsulSecretBackend#ca_cert}

---

ClientCert^Optional

public string ClientCert { get; set; }

• Type: string

Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#client_cert ConsulSecretBackend#client_cert}

---

ClientKey^Optional

public string ClientKey { get; set; }

• Type: string

Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#client_key ConsulSecretBackend#client_key}

---

DefaultLeaseTtlSeconds^Optional

public double DefaultLeaseTtlSeconds { get; set; }

• Type: double

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#default_lease_ttl_seconds ConsulSecretBackend#default_lease_ttl_seconds}

---

Description^Optional

public string Description { get; set; }

• Type: string

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#description ConsulSecretBackend#description}

---

DisableRemount^Optional

public object DisableRemount { get; set; }

• Type: object

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#disable_remount ConsulSecretBackend#disable_remount}

---

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/consul_secret_backend#id ConsulSecretBackend#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.

---

Local^Optional

public object Local { get; set; }

• Type: object

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#local ConsulSecretBackend#local}

---

MaxLeaseTtlSeconds^Optional

public double MaxLeaseTtlSeconds { get; set; }

• Type: double

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#max_lease_ttl_seconds ConsulSecretBackend#max_lease_ttl_seconds}

---

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/consul_secret_backend#namespace ConsulSecretBackend#namespace}

---

Path^Optional

public string Path { get; set; }

• Type: string

Unique name of the Vault Consul mount to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#path ConsulSecretBackend#path}

---

Scheme^Optional

public string Scheme { get; set; }

• Type: string

Specifies the URL scheme to use. Defaults to "http".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#scheme ConsulSecretBackend#scheme}

---

Token^Optional

public string Token { get; set; }

• Type: string

Specifies the Consul token to use when managing or issuing new tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/consul_secret_backend#token ConsulSecretBackend#token}

---