`approleAuthBackendRoleSecretId` Submodule

Constructs

ApproleAuthBackendRoleSecretId

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

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new ApproleAuthBackendRoleSecretId(Construct Scope, string Id, ApproleAuthBackendRoleSecretIdConfig Config);

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

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".
`ResetBackend`	No description.
`ResetCidrList`	No description.
`ResetId`	No description.
`ResetMetadata`	No description.
`ResetNamespace`	No description.
`ResetNumUses`	No description.
`ResetSecretId`	No description.
`ResetTtl`	No description.
`ResetWithWrappedAccessor`	No description.
`ResetWrappingTtl`	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".

`ResetBackend`

private void ResetBackend()

`ResetCidrList`

private void ResetCidrList()

`ResetId`

private void ResetId()

`ResetMetadata`

private void ResetMetadata()

`ResetNamespace`

private void ResetNamespace()

`ResetNumUses`

private void ResetNumUses()

`ResetSecretId`

private void ResetSecretId()

`ResetTtl`

private void ResetTtl()

`ResetWithWrappedAccessor`

private void ResetWithWrappedAccessor()

`ResetWrappingTtl`

private void ResetWrappingTtl()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Vault;

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

ApproleAuthBackendRoleSecretId.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Vault;

ApproleAuthBackendRoleSecretId.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Vault;

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

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

`ImportFromId`^Required

Type: string

The id of the existing ApproleAuthBackendRoleSecretId that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#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 ApproleAuthBackendRoleSecretId 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.
`Accessor`	`string`	No description.
`WrappingAccessor`	`string`	No description.
`WrappingToken`	`string`	No description.
`BackendInput`	`string`	No description.
`CidrListInput`	`string[]`	No description.
`IdInput`	`string`	No description.
`MetadataInput`	`string`	No description.
`NamespaceInput`	`string`	No description.
`NumUsesInput`	`double`	No description.
`RoleNameInput`	`string`	No description.
`SecretIdInput`	`string`	No description.
`TtlInput`	`double`	No description.
`WithWrappedAccessorInput`	`object`	No description.
`WrappingTtlInput`	`string`	No description.
`Backend`	`string`	No description.
`CidrList`	`string[]`	No description.
`Id`	`string`	No description.
`Metadata`	`string`	No description.
`Namespace`	`string`	No description.
`NumUses`	`double`	No description.
`RoleName`	`string`	No description.
`SecretId`	`string`	No description.
`Ttl`	`double`	No description.
`WithWrappedAccessor`	`object`	No description.
`WrappingTtl`	`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[]

`Accessor`^Required

public string Accessor { get; }

Type: string

`WrappingAccessor`^Required

public string WrappingAccessor { get; }

Type: string

`WrappingToken`^Required

public string WrappingToken { get; }

Type: string

`BackendInput`^Optional

public string BackendInput { get; }

Type: string

`CidrListInput`^Optional

public string[] CidrListInput { get; }

Type: string[]

`IdInput`^Optional

public string IdInput { get; }

Type: string

`MetadataInput`^Optional

public string MetadataInput { get; }

Type: string

`NamespaceInput`^Optional

public string NamespaceInput { get; }

Type: string

`NumUsesInput`^Optional

public double NumUsesInput { get; }

Type: double

`RoleNameInput`^Optional

public string RoleNameInput { get; }

Type: string

`SecretIdInput`^Optional

public string SecretIdInput { get; }

Type: string

`TtlInput`^Optional

public double TtlInput { get; }

Type: double

`WithWrappedAccessorInput`^Optional

public object WithWrappedAccessorInput { get; }

Type: object

`WrappingTtlInput`^Optional

public string WrappingTtlInput { get; }

Type: string

`Backend`^Required

public string Backend { get; }

Type: string

`CidrList`^Required

public string[] CidrList { get; }

Type: string[]

`Id`^Required

public string Id { get; }

Type: string

`Metadata`^Required

public string Metadata { get; }

Type: string

`Namespace`^Required

public string Namespace { get; }

Type: string

`NumUses`^Required

public double NumUses { get; }

Type: double

`RoleName`^Required

public string RoleName { get; }

Type: string

`SecretId`^Required

public string SecretId { get; }

Type: string

`Ttl`^Required

public double Ttl { get; }

Type: double

`WithWrappedAccessor`^Required

public object WithWrappedAccessor { get; }

Type: object

`WrappingTtl`^Required

public string WrappingTtl { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

ApproleAuthBackendRoleSecretIdConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new ApproleAuthBackendRoleSecretIdConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string RoleName,
    string Backend = null,
    string[] CidrList = null,
    string Id = null,
    string Metadata = null,
    string Namespace = null,
    double NumUses = null,
    string SecretId = null,
    double Ttl = null,
    object WithWrappedAccessor = null,
    string WrappingTtl = 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.
`RoleName`	`string`	Name of the role.
`Backend`	`string`	Unique name of the auth backend to configure.
`CidrList`	`string[]`	List of CIDR blocks that can log in using the SecretID.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#id ApproleAuthBackendRoleSecretId#id}.
`Metadata`	`string`	JSON-encoded secret data to write.
`Namespace`	`string`	Target namespace. (requires Enterprise).
`NumUses`	`double`	The number of uses for the secret-id.
`SecretId`	`string`	The SecretID to be managed. If not specified, Vault auto-generates one.
`Ttl`	`double`	The TTL duration of the SecretID.
`WithWrappedAccessor`	`object`	Use the wrapped secret-id accessor as the id of this resource.
`WrappingTtl`	`string`	The TTL duration of the wrapped SecretID.

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

`RoleName`^Required

public string RoleName { get; set; }

Type: string

Name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#role_name ApproleAuthBackendRoleSecretId#role_name}

`Backend`^Optional

public string Backend { get; set; }

Type: string

Unique name of the auth backend to configure.

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

`CidrList`^Optional

public string[] CidrList { get; set; }

Type: string[]

List of CIDR blocks that can log in using the SecretID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#cidr_list ApproleAuthBackendRoleSecretId#cidr_list}

`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/approle_auth_backend_role_secret_id#id ApproleAuthBackendRoleSecretId#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.

`Metadata`^Optional

public string Metadata { get; set; }

Type: string

JSON-encoded secret data to write.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#metadata ApproleAuthBackendRoleSecretId#metadata}

`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/approle_auth_backend_role_secret_id#namespace ApproleAuthBackendRoleSecretId#namespace}

`NumUses`^Optional

public double NumUses { get; set; }

Type: double

The number of uses for the secret-id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#num_uses ApproleAuthBackendRoleSecretId#num_uses}

`SecretId`^Optional

public string SecretId { get; set; }

Type: string

The SecretID to be managed. If not specified, Vault auto-generates one.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#secret_id ApproleAuthBackendRoleSecretId#secret_id}

`Ttl`^Optional

public double Ttl { get; set; }

Type: double

The TTL duration of the SecretID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#ttl ApproleAuthBackendRoleSecretId#ttl}

`WithWrappedAccessor`^Optional

public object WithWrappedAccessor { get; set; }

Type: object

Use the wrapped secret-id accessor as the id of this resource.

If false, a fresh secret-id will be regenerated whenever the wrapping token is expired or invalidated through unwrapping.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#with_wrapped_accessor ApproleAuthBackendRoleSecretId#with_wrapped_accessor}

`WrappingTtl`^Optional

public string WrappingTtl { get; set; }

Type: string

The TTL duration of the wrapped SecretID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/approle_auth_backend_role_secret_id#wrapping_ttl ApproleAuthBackendRoleSecretId#wrapping_ttl}

Files

approleAuthBackendRoleSecretId.csharp.md

Latest commit

History

approleAuthBackendRoleSecretId.csharp.md

File metadata and controls

approleAuthBackendRoleSecretId Submodule

Constructs