dataVaultAzureAccessCredentials.csharp.md

dataVaultAzureAccessCredentials Submodule

Constructs

DataVaultAzureAccessCredentials

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

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultAzureAccessCredentials(Construct Scope, string Id, DataVaultAzureAccessCredentialsConfig Config);

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

---

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.
ResetEnvironment	No description.
ResetId	No description.
ResetMaxCredValidationSeconds	No description.
ResetNamespace	No description.
ResetNumSecondsBetweenTests	No description.
ResetNumSequentialSuccesses	No description.
ResetSubscriptionId	No description.
ResetTenantId	No description.
ResetValidateCreds	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

---

ResetEnvironment

private void ResetEnvironment()

ResetId

private void ResetId()

ResetMaxCredValidationSeconds

private void ResetMaxCredValidationSeconds()

ResetNamespace

private void ResetNamespace()

ResetNumSecondsBetweenTests

private void ResetNumSecondsBetweenTests()

ResetNumSequentialSuccesses

private void ResetNumSequentialSuccesses()

ResetSubscriptionId

private void ResetSubscriptionId()

ResetTenantId

private void ResetTenantId()

ResetValidateCreds

private void ResetValidateCreds()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

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

DataVaultAzureAccessCredentials.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Vault;

DataVaultAzureAccessCredentials.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing DataVaultAzureAccessCredentials that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/azure_access_credentials#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 DataVaultAzureAccessCredentials 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.
ClientId	string	No description.
ClientSecret	string	No description.
LeaseDuration	double	No description.
LeaseId	string	No description.
LeaseRenewable	HashiCorp.Cdktf.IResolvable	No description.
LeaseStartTime	string	No description.
BackendInput	string	No description.
EnvironmentInput	string	No description.
IdInput	string	No description.
MaxCredValidationSecondsInput	double	No description.
NamespaceInput	string	No description.
NumSecondsBetweenTestsInput	double	No description.
NumSequentialSuccessesInput	double	No description.
RoleInput	string	No description.
SubscriptionIdInput	string	No description.
TenantIdInput	string	No description.
ValidateCredsInput	object	No description.
Backend	string	No description.
Environment	string	No description.
Id	string	No description.
MaxCredValidationSeconds	double	No description.
Namespace	string	No description.
NumSecondsBetweenTests	double	No description.
NumSequentialSuccesses	double	No description.
Role	string	No description.
SubscriptionId	string	No description.
TenantId	string	No description.
ValidateCreds	object	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

---

ClientId^Required

public string ClientId { get; }

• Type: string

---

ClientSecret^Required

public string ClientSecret { get; }

• Type: string

---

LeaseDuration^Required

public double LeaseDuration { get; }

• Type: double

---

LeaseId^Required

public string LeaseId { get; }

• Type: string

---

LeaseRenewable^Required

public IResolvable LeaseRenewable { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

LeaseStartTime^Required

public string LeaseStartTime { get; }

• Type: string

---

BackendInput^Optional

public string BackendInput { get; }

• Type: string

---

EnvironmentInput^Optional

public string EnvironmentInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

MaxCredValidationSecondsInput^Optional

public double MaxCredValidationSecondsInput { get; }

• Type: double

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

NumSecondsBetweenTestsInput^Optional

public double NumSecondsBetweenTestsInput { get; }

• Type: double

---

NumSequentialSuccessesInput^Optional

public double NumSequentialSuccessesInput { get; }

• Type: double

---

RoleInput^Optional

public string RoleInput { get; }

• Type: string

---

SubscriptionIdInput^Optional

public string SubscriptionIdInput { get; }

• Type: string

---

TenantIdInput^Optional

public string TenantIdInput { get; }

• Type: string

---

ValidateCredsInput^Optional

public object ValidateCredsInput { get; }

• Type: object

---

Backend^Required

public string Backend { get; }

• Type: string

---

Environment^Required

public string Environment { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

MaxCredValidationSeconds^Required

public double MaxCredValidationSeconds { get; }

• Type: double

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

NumSecondsBetweenTests^Required

public double NumSecondsBetweenTests { get; }

• Type: double

---

NumSequentialSuccesses^Required

public double NumSequentialSuccesses { get; }

• Type: double

---

Role^Required

public string Role { get; }

• Type: string

---

SubscriptionId^Required

public string SubscriptionId { get; }

• Type: string

---

TenantId^Required

public string TenantId { get; }

• Type: string

---

ValidateCreds^Required

public object ValidateCreds { get; }

• Type: object

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataVaultAzureAccessCredentialsConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new DataVaultAzureAccessCredentialsConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Backend,
    string Role,
    string Environment = null,
    string Id = null,
    double MaxCredValidationSeconds = null,
    string Namespace = null,
    double NumSecondsBetweenTests = null,
    double NumSequentialSuccesses = null,
    string SubscriptionId = null,
    string TenantId = null,
    object ValidateCreds = 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.
Backend	string	Azure Secret Backend to read credentials from.
Role	string	Azure Secret Role to read credentials from.
Environment	string	The Azure environment to use during credential validation. Defaults to the Azure Public Cloud. Some possible values: AzurePublicCloud, AzureUSGovernmentCloud.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/azure_access_credentials#id DataVaultAzureAccessCredentials#id}.
MaxCredValidationSeconds	double	If 'validate_creds' is true, the number of seconds after which to give up validating credentials.
Namespace	string	Target namespace. (requires Enterprise).
NumSecondsBetweenTests	double	If 'validate_creds' is true, the number of seconds to wait between each test of generated credentials.
NumSequentialSuccesses	double	If 'validate_creds' is true, the number of sequential successes required to validate generated credentials.
SubscriptionId	string	The subscription ID to use during credential validation. Defaults to the subscription ID configured in the Vault backend.
TenantId	string	The tenant ID to use during credential validation. Defaults to the tenant ID configured in the Vault backend.
ValidateCreds	object	Whether generated credentials should be validated before being returned.

---

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

---

Backend^Required

public string Backend { get; set; }

• Type: string

Azure Secret Backend to read credentials from.

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

---

Role^Required

public string Role { get; set; }

• Type: string

Azure Secret Role to read credentials from.

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

---

Environment^Optional

public string Environment { get; set; }

• Type: string

The Azure environment to use during credential validation. Defaults to the Azure Public Cloud. Some possible values: AzurePublicCloud, AzureUSGovernmentCloud.

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

---

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/azure_access_credentials#id DataVaultAzureAccessCredentials#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.

---

MaxCredValidationSeconds^Optional

public double MaxCredValidationSeconds { get; set; }

• Type: double

If 'validate_creds' is true, the number of seconds after which to give up validating credentials.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/data-sources/azure_access_credentials#max_cred_validation_seconds DataVaultAzureAccessCredentials#max_cred_validation_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/data-sources/azure_access_credentials#namespace DataVaultAzureAccessCredentials#namespace}

---

NumSecondsBetweenTests^Optional

public double NumSecondsBetweenTests { get; set; }

• Type: double

If 'validate_creds' is true, the number of seconds to wait between each test of generated credentials.

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

---

NumSequentialSuccesses^Optional

public double NumSequentialSuccesses { get; set; }

• Type: double

If 'validate_creds' is true, the number of sequential successes required to validate generated credentials.

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

---

SubscriptionId^Optional

public string SubscriptionId { get; set; }

• Type: string

The subscription ID to use during credential validation. Defaults to the subscription ID configured in the Vault backend.

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

---

TenantId^Optional

public string TenantId { get; set; }

• Type: string

The tenant ID to use during credential validation. Defaults to the tenant ID configured in the Vault backend.

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

---

ValidateCreds^Optional

public object ValidateCreds { get; set; }

• Type: object

Whether generated credentials should be validated before being returned.

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

---