dataVaultGcpAuthBackendRole.csharp.md

dataVaultGcpAuthBackendRole Submodule

Constructs

DataVaultGcpAuthBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role vault_gcp_auth_backend_role}.

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultGcpAuthBackendRole(Construct Scope, string Id, DataVaultGcpAuthBackendRoleConfig Config);

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

---

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	Adds this resource to the terraform JSON output.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
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.
InterpolationForAttribute	No description.
ResetBackend	No description.
ResetId	No description.
ResetNamespace	No description.
ResetTokenBoundCidrs	No description.
ResetTokenExplicitMaxTtl	No description.
ResetTokenMaxTtl	No description.
ResetTokenNoDefaultPolicy	No description.
ResetTokenNumUses	No description.
ResetTokenPeriod	No description.
ResetTokenPolicies	No description.
ResetTokenTtl	No description.
ResetTokenType	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()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

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

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetBackend

private void ResetBackend()

ResetId

private void ResetId()

ResetNamespace

private void ResetNamespace()

ResetTokenBoundCidrs

private void ResetTokenBoundCidrs()

ResetTokenExplicitMaxTtl

private void ResetTokenExplicitMaxTtl()

ResetTokenMaxTtl

private void ResetTokenMaxTtl()

ResetTokenNoDefaultPolicy

private void ResetTokenNoDefaultPolicy()

ResetTokenNumUses

private void ResetTokenNumUses()

ResetTokenPeriod

private void ResetTokenPeriod()

ResetTokenPolicies

private void ResetTokenPolicies()

ResetTokenTtl

private void ResetTokenTtl()

ResetTokenType

private void ResetTokenType()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

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

DataVaultGcpAuthBackendRole.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Vault;

DataVaultGcpAuthBackendRole.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing DataVaultGcpAuthBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#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 DataVaultGcpAuthBackendRole 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.
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.
BoundInstanceGroups	string[]	No description.
BoundLabels	string[]	No description.
BoundProjects	string[]	No description.
BoundRegions	string[]	No description.
BoundServiceAccounts	string[]	No description.
BoundZones	string[]	No description.
RoleId	string	No description.
Type	string	No description.
BackendInput	string	No description.
IdInput	string	No description.
NamespaceInput	string	No description.
RoleNameInput	string	No description.
TokenBoundCidrsInput	string[]	No description.
TokenExplicitMaxTtlInput	double	No description.
TokenMaxTtlInput	double	No description.
TokenNoDefaultPolicyInput	object	No description.
TokenNumUsesInput	double	No description.
TokenPeriodInput	double	No description.
TokenPoliciesInput	string[]	No description.
TokenTtlInput	double	No description.
TokenTypeInput	string	No description.
Backend	string	No description.
Id	string	No description.
Namespace	string	No description.
RoleName	string	No description.
TokenBoundCidrs	string[]	No description.
TokenExplicitMaxTtl	double	No description.
TokenMaxTtl	double	No description.
TokenNoDefaultPolicy	object	No description.
TokenNumUses	double	No description.
TokenPeriod	double	No description.
TokenPolicies	string[]	No description.
TokenTtl	double	No description.
TokenType	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

---

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

---

BoundInstanceGroups^Required

public string[] BoundInstanceGroups { get; }

• Type: string[]

---

BoundLabels^Required

public string[] BoundLabels { get; }

• Type: string[]

---

BoundProjects^Required

public string[] BoundProjects { get; }

• Type: string[]

---

BoundRegions^Required

public string[] BoundRegions { get; }

• Type: string[]

---

BoundServiceAccounts^Required

public string[] BoundServiceAccounts { get; }

• Type: string[]

---

BoundZones^Required

public string[] BoundZones { get; }

• Type: string[]

---

RoleId^Required

public string RoleId { get; }

• Type: string

---

Type^Required

public string Type { get; }

• Type: string

---

BackendInput^Optional

public string BackendInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

RoleNameInput^Optional

public string RoleNameInput { get; }

• Type: string

---

TokenBoundCidrsInput^Optional

public string[] TokenBoundCidrsInput { get; }

• Type: string[]

---

TokenExplicitMaxTtlInput^Optional

public double TokenExplicitMaxTtlInput { get; }

• Type: double

---

TokenMaxTtlInput^Optional

public double TokenMaxTtlInput { get; }

• Type: double

---

TokenNoDefaultPolicyInput^Optional

public object TokenNoDefaultPolicyInput { get; }

• Type: object

---

TokenNumUsesInput^Optional

public double TokenNumUsesInput { get; }

• Type: double

---

TokenPeriodInput^Optional

public double TokenPeriodInput { get; }

• Type: double

---

TokenPoliciesInput^Optional

public string[] TokenPoliciesInput { get; }

• Type: string[]

---

TokenTtlInput^Optional

public double TokenTtlInput { get; }

• Type: double

---

TokenTypeInput^Optional

public string TokenTypeInput { get; }

• Type: string

---

Backend^Required

public string Backend { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

RoleName^Required

public string RoleName { get; }

• Type: string

---

TokenBoundCidrs^Required

public string[] TokenBoundCidrs { get; }

• Type: string[]

---

TokenExplicitMaxTtl^Required

public double TokenExplicitMaxTtl { get; }

• Type: double

---

TokenMaxTtl^Required

public double TokenMaxTtl { get; }

• Type: double

---

TokenNoDefaultPolicy^Required

public object TokenNoDefaultPolicy { get; }

• Type: object

---

TokenNumUses^Required

public double TokenNumUses { get; }

• Type: double

---

TokenPeriod^Required

public double TokenPeriod { get; }

• Type: double

---

TokenPolicies^Required

public string[] TokenPolicies { get; }

• Type: string[]

---

TokenTtl^Required

public double TokenTtl { get; }

• Type: double

---

TokenType^Required

public string TokenType { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataVaultGcpAuthBackendRoleConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultGcpAuthBackendRoleConfig {
    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 Id = null,
    string Namespace = null,
    string[] TokenBoundCidrs = null,
    double TokenExplicitMaxTtl = null,
    double TokenMaxTtl = null,
    object TokenNoDefaultPolicy = null,
    double TokenNumUses = null,
    double TokenPeriod = null,
    string[] TokenPolicies = null,
    double TokenTtl = null,
    string TokenType = 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.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#id DataVaultGcpAuthBackendRole#id}.
Namespace	string	Target namespace. (requires Enterprise).
TokenBoundCidrs	string[]	Specifies the blocks of IP addresses which are allowed to use the generated token.
TokenExplicitMaxTtl	double	Generated Token's Explicit Maximum TTL in seconds.
TokenMaxTtl	double	The maximum lifetime of the generated token.
TokenNoDefaultPolicy	object	If true, the 'default' policy will not automatically be added to generated tokens.
TokenNumUses	double	The maximum number of times a token may be used, a value of zero means unlimited.
TokenPeriod	double	Generated Token's Period.
TokenPolicies	string[]	Generated Token's Policies.
TokenTtl	double	The initial ttl of the token to generate in seconds.
TokenType	string	The type of token to generate, service or batch.

---

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/data-sources/gcp_auth_backend_role#role_name DataVaultGcpAuthBackendRole#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/data-sources/gcp_auth_backend_role#backend DataVaultGcpAuthBackendRole#backend}

---

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/data-sources/gcp_auth_backend_role#id DataVaultGcpAuthBackendRole#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.

---

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/data-sources/gcp_auth_backend_role#namespace DataVaultGcpAuthBackendRole#namespace}

---

TokenBoundCidrs^Optional

public string[] TokenBoundCidrs { get; set; }

• Type: string[]

Specifies the blocks of IP addresses which are allowed to use the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_bound_cidrs DataVaultGcpAuthBackendRole#token_bound_cidrs}

---

TokenExplicitMaxTtl^Optional

public double TokenExplicitMaxTtl { get; set; }

• Type: double

Generated Token's Explicit Maximum TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_explicit_max_ttl DataVaultGcpAuthBackendRole#token_explicit_max_ttl}

---

TokenMaxTtl^Optional

public double TokenMaxTtl { get; set; }

• Type: double

The maximum lifetime of the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_max_ttl DataVaultGcpAuthBackendRole#token_max_ttl}

---

TokenNoDefaultPolicy^Optional

public object TokenNoDefaultPolicy { get; set; }

• Type: object

If true, the 'default' policy will not automatically be added to generated tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_no_default_policy DataVaultGcpAuthBackendRole#token_no_default_policy}

---

TokenNumUses^Optional

public double TokenNumUses { get; set; }

• Type: double

The maximum number of times a token may be used, a value of zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_num_uses DataVaultGcpAuthBackendRole#token_num_uses}

---

TokenPeriod^Optional

public double TokenPeriod { get; set; }

• Type: double

Generated Token's Period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_period DataVaultGcpAuthBackendRole#token_period}

---

TokenPolicies^Optional

public string[] TokenPolicies { get; set; }

• Type: string[]

Generated Token's Policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_policies DataVaultGcpAuthBackendRole#token_policies}

---

TokenTtl^Optional

public double TokenTtl { get; set; }

• Type: double

The initial ttl of the token to generate in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_ttl DataVaultGcpAuthBackendRole#token_ttl}

---

TokenType^Optional

public string TokenType { get; set; }

• Type: string

The type of token to generate, service or batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/gcp_auth_backend_role#token_type DataVaultGcpAuthBackendRole#token_type}

---