`terraformCloudSecretBackend` Submodule

Constructs

TerraformCloudSecretBackend

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

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new TerraformCloudSecretBackend(Construct Scope, string Id, TerraformCloudSecretBackendConfig Config = null);

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

Type: TerraformCloudSecretBackendConfig

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".
`ResetAddress`	No description.
`ResetBackend`	No description.
`ResetBasePath`	No description.
`ResetDefaultLeaseTtlSeconds`	No description.
`ResetDescription`	No description.
`ResetDisableRemount`	No description.
`ResetId`	No description.
`ResetMaxLeaseTtlSeconds`	No description.
`ResetNamespace`	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".

`ResetAddress`

private void ResetAddress()

`ResetBackend`

private void ResetBackend()

`ResetBasePath`

private void ResetBasePath()

`ResetDefaultLeaseTtlSeconds`

private void ResetDefaultLeaseTtlSeconds()

`ResetDescription`

private void ResetDescription()

`ResetDisableRemount`

private void ResetDisableRemount()

`ResetId`

private void ResetId()

`ResetMaxLeaseTtlSeconds`

private void ResetMaxLeaseTtlSeconds()

`ResetNamespace`

private void ResetNamespace()

`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 TerraformCloudSecretBackend resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Vault;

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

TerraformCloudSecretBackend.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Vault;

TerraformCloudSecretBackend.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Vault;

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

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

`ImportFromId`^Required

Type: string

The id of the existing TerraformCloudSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/terraform_cloud_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 TerraformCloudSecretBackend 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.
`BackendInput`	`string`	No description.
`BasePathInput`	`string`	No description.
`DefaultLeaseTtlSecondsInput`	`double`	No description.
`DescriptionInput`	`string`	No description.
`DisableRemountInput`	`object`	No description.
`IdInput`	`string`	No description.
`MaxLeaseTtlSecondsInput`	`double`	No description.
`NamespaceInput`	`string`	No description.
`TokenInput`	`string`	No description.
`Address`	`string`	No description.
`Backend`	`string`	No description.
`BasePath`	`string`	No description.
`DefaultLeaseTtlSeconds`	`double`	No description.
`Description`	`string`	No description.
`DisableRemount`	`object`	No description.
`Id`	`string`	No description.
`MaxLeaseTtlSeconds`	`double`	No description.
`Namespace`	`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

`BackendInput`^Optional

public string BackendInput { get; }

Type: string

`BasePathInput`^Optional

public string BasePathInput { 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

`MaxLeaseTtlSecondsInput`^Optional

public double MaxLeaseTtlSecondsInput { get; }

Type: double

`NamespaceInput`^Optional

public string NamespaceInput { get; }

Type: string

`TokenInput`^Optional

public string TokenInput { get; }

Type: string

`Address`^Required

public string Address { get; }

Type: string

`Backend`^Required

public string Backend { get; }

Type: string

`BasePath`^Required

public string BasePath { 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

`MaxLeaseTtlSeconds`^Required

public double MaxLeaseTtlSeconds { get; }

Type: double

`Namespace`^Required

public string Namespace { 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

TerraformCloudSecretBackendConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new TerraformCloudSecretBackendConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Address = null,
    string Backend = null,
    string BasePath = null,
    double DefaultLeaseTtlSeconds = null,
    string Description = null,
    object DisableRemount = null,
    string Id = null,
    double MaxLeaseTtlSeconds = null,
    string Namespace = 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 Terraform Cloud instance, provided as "host:port" like "127.0.0.1:8500".
`Backend`	`string`	Unique name of the Vault Terraform Cloud mount to configure.
`BasePath`	`string`	Specifies the base path for the Terraform Cloud or Enterprise API.
`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/terraform_cloud_secret_backend#id TerraformCloudSecretBackend#id}.
`MaxLeaseTtlSeconds`	`double`	Maximum possible lease duration for secrets in seconds.
`Namespace`	`string`	Target namespace. (requires Enterprise).
`Token`	`string`	Specifies the Terraform Cloud access token to use.

`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`^Optional

public string Address { get; set; }

Type: string

Specifies the address of the Terraform Cloud 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/terraform_cloud_secret_backend#address TerraformCloudSecretBackend#address}

`Backend`^Optional

public string Backend { get; set; }

Type: string

Unique name of the Vault Terraform Cloud mount to configure.

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

`BasePath`^Optional

public string BasePath { get; set; }

Type: string

Specifies the base path for the Terraform Cloud or Enterprise API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/terraform_cloud_secret_backend#base_path TerraformCloudSecretBackend#base_path}

`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/terraform_cloud_secret_backend#default_lease_ttl_seconds TerraformCloudSecretBackend#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/terraform_cloud_secret_backend#description TerraformCloudSecretBackend#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/terraform_cloud_secret_backend#disable_remount TerraformCloudSecretBackend#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/terraform_cloud_secret_backend#id TerraformCloudSecretBackend#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.

`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/terraform_cloud_secret_backend#max_lease_ttl_seconds TerraformCloudSecretBackend#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/terraform_cloud_secret_backend#namespace TerraformCloudSecretBackend#namespace}

`Token`^Optional

public string Token { get; set; }

Type: string

Specifies the Terraform Cloud access token to use.

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

Files

terraformCloudSecretBackend.csharp.md

Latest commit

History

terraformCloudSecretBackend.csharp.md

File metadata and controls

terraformCloudSecretBackend Submodule

Constructs