pkiSecretBackendIssuer.csharp.md

pkiSecretBackendIssuer Submodule

Constructs

PkiSecretBackendIssuer

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer vault_pki_secret_backend_issuer}.

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new PkiSecretBackendIssuer(Construct Scope, string Id, PkiSecretBackendIssuerConfig Config);

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

---

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".
ResetCrlDistributionPoints	No description.
ResetEnableAiaUrlTemplating	No description.
ResetId	No description.
ResetIssuerName	No description.
ResetIssuingCertificates	No description.
ResetLeafNotAfterBehavior	No description.
ResetManualChain	No description.
ResetNamespace	No description.
ResetOcspServers	No description.
ResetRevocationSignatureAlgorithm	No description.
ResetUsage	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".

---

ResetCrlDistributionPoints

private void ResetCrlDistributionPoints()

ResetEnableAiaUrlTemplating

private void ResetEnableAiaUrlTemplating()

ResetId

private void ResetId()

ResetIssuerName

private void ResetIssuerName()

ResetIssuingCertificates

private void ResetIssuingCertificates()

ResetLeafNotAfterBehavior

private void ResetLeafNotAfterBehavior()

ResetManualChain

private void ResetManualChain()

ResetNamespace

private void ResetNamespace()

ResetOcspServers

private void ResetOcspServers()

ResetRevocationSignatureAlgorithm

private void ResetRevocationSignatureAlgorithm()

ResetUsage

private void ResetUsage()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vault;

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

PkiSecretBackendIssuer.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Vault;

PkiSecretBackendIssuer.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vault;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing PkiSecretBackendIssuer that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#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 PkiSecretBackendIssuer 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.
IssuerId	string	No description.
BackendInput	string	No description.
CrlDistributionPointsInput	string[]	No description.
EnableAiaUrlTemplatingInput	object	No description.
IdInput	string	No description.
IssuerNameInput	string	No description.
IssuerRefInput	string	No description.
IssuingCertificatesInput	string[]	No description.
LeafNotAfterBehaviorInput	string	No description.
ManualChainInput	string[]	No description.
NamespaceInput	string	No description.
OcspServersInput	string[]	No description.
RevocationSignatureAlgorithmInput	string	No description.
UsageInput	string	No description.
Backend	string	No description.
CrlDistributionPoints	string[]	No description.
EnableAiaUrlTemplating	object	No description.
Id	string	No description.
IssuerName	string	No description.
IssuerRef	string	No description.
IssuingCertificates	string[]	No description.
LeafNotAfterBehavior	string	No description.
ManualChain	string[]	No description.
Namespace	string	No description.
OcspServers	string[]	No description.
RevocationSignatureAlgorithm	string	No description.
Usage	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[]

---

IssuerId^Required

public string IssuerId { get; }

• Type: string

---

BackendInput^Optional

public string BackendInput { get; }

• Type: string

---

CrlDistributionPointsInput^Optional

public string[] CrlDistributionPointsInput { get; }

• Type: string[]

---

EnableAiaUrlTemplatingInput^Optional

public object EnableAiaUrlTemplatingInput { get; }

• Type: object

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

IssuerNameInput^Optional

public string IssuerNameInput { get; }

• Type: string

---

IssuerRefInput^Optional

public string IssuerRefInput { get; }

• Type: string

---

IssuingCertificatesInput^Optional

public string[] IssuingCertificatesInput { get; }

• Type: string[]

---

LeafNotAfterBehaviorInput^Optional

public string LeafNotAfterBehaviorInput { get; }

• Type: string

---

ManualChainInput^Optional

public string[] ManualChainInput { get; }

• Type: string[]

---

NamespaceInput^Optional

public string NamespaceInput { get; }

• Type: string

---

OcspServersInput^Optional

public string[] OcspServersInput { get; }

• Type: string[]

---

RevocationSignatureAlgorithmInput^Optional

public string RevocationSignatureAlgorithmInput { get; }

• Type: string

---

UsageInput^Optional

public string UsageInput { get; }

• Type: string

---

Backend^Required

public string Backend { get; }

• Type: string

---

CrlDistributionPoints^Required

public string[] CrlDistributionPoints { get; }

• Type: string[]

---

EnableAiaUrlTemplating^Required

public object EnableAiaUrlTemplating { get; }

• Type: object

---

Id^Required

public string Id { get; }

• Type: string

---

IssuerName^Required

public string IssuerName { get; }

• Type: string

---

IssuerRef^Required

public string IssuerRef { get; }

• Type: string

---

IssuingCertificates^Required

public string[] IssuingCertificates { get; }

• Type: string[]

---

LeafNotAfterBehavior^Required

public string LeafNotAfterBehavior { get; }

• Type: string

---

ManualChain^Required

public string[] ManualChain { get; }

• Type: string[]

---

Namespace^Required

public string Namespace { get; }

• Type: string

---

OcspServers^Required

public string[] OcspServers { get; }

• Type: string[]

---

RevocationSignatureAlgorithm^Required

public string RevocationSignatureAlgorithm { get; }

• Type: string

---

Usage^Required

public string Usage { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

PkiSecretBackendIssuerConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new PkiSecretBackendIssuerConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Backend,
    string IssuerRef,
    string[] CrlDistributionPoints = null,
    object EnableAiaUrlTemplating = null,
    string Id = null,
    string IssuerName = null,
    string[] IssuingCertificates = null,
    string LeafNotAfterBehavior = null,
    string[] ManualChain = null,
    string Namespace = null,
    string[] OcspServers = null,
    string RevocationSignatureAlgorithm = null,
    string Usage = 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	Full path where PKI backend is mounted.
IssuerRef	string	Reference to an existing issuer.
CrlDistributionPoints	string[]	Specifies the URL values for the CRL Distribution Points field.
EnableAiaUrlTemplating	object	Specifies that the AIA URL values should be templated.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#id PkiSecretBackendIssuer#id}.
IssuerName	string	Reference to an existing issuer.
IssuingCertificates	string[]	Specifies the URL values for the Issuing Certificate field.
LeafNotAfterBehavior	string	Behavior of a leaf's 'NotAfter' field during issuance.
ManualChain	string[]	Chain of issuer references to build this issuer's computed CAChain field from, when non-empty.
Namespace	string	Target namespace. (requires Enterprise).
OcspServers	string[]	Specifies the URL values for the OCSP Servers field.
RevocationSignatureAlgorithm	string	Which signature algorithm to use when building CRLs.
Usage	string	Comma-separated list of allowed usages for this issuer.

---

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

Full path where PKI backend is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#backend PkiSecretBackendIssuer#backend}

---

IssuerRef^Required

public string IssuerRef { get; set; }

• Type: string

Reference to an existing issuer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#issuer_ref PkiSecretBackendIssuer#issuer_ref}

---

CrlDistributionPoints^Optional

public string[] CrlDistributionPoints { get; set; }

• Type: string[]

Specifies the URL values for the CRL Distribution Points field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#crl_distribution_points PkiSecretBackendIssuer#crl_distribution_points}

---

EnableAiaUrlTemplating^Optional

public object EnableAiaUrlTemplating { get; set; }

• Type: object

Specifies that the AIA URL values should be templated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#enable_aia_url_templating PkiSecretBackendIssuer#enable_aia_url_templating}

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#id PkiSecretBackendIssuer#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.

---

IssuerName^Optional

public string IssuerName { get; set; }

• Type: string

Reference to an existing issuer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#issuer_name PkiSecretBackendIssuer#issuer_name}

---

IssuingCertificates^Optional

public string[] IssuingCertificates { get; set; }

• Type: string[]

Specifies the URL values for the Issuing Certificate field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#issuing_certificates PkiSecretBackendIssuer#issuing_certificates}

---

LeafNotAfterBehavior^Optional

public string LeafNotAfterBehavior { get; set; }

• Type: string

Behavior of a leaf's 'NotAfter' field during issuance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#leaf_not_after_behavior PkiSecretBackendIssuer#leaf_not_after_behavior}

---

ManualChain^Optional

public string[] ManualChain { get; set; }

• Type: string[]

Chain of issuer references to build this issuer's computed CAChain field from, when non-empty.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#manual_chain PkiSecretBackendIssuer#manual_chain}

---

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.2.0/docs/resources/pki_secret_backend_issuer#namespace PkiSecretBackendIssuer#namespace}

---

OcspServers^Optional

public string[] OcspServers { get; set; }

• Type: string[]

Specifies the URL values for the OCSP Servers field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#ocsp_servers PkiSecretBackendIssuer#ocsp_servers}

---

RevocationSignatureAlgorithm^Optional

public string RevocationSignatureAlgorithm { get; set; }

• Type: string

Which signature algorithm to use when building CRLs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#revocation_signature_algorithm PkiSecretBackendIssuer#revocation_signature_algorithm}

---

Usage^Optional

public string Usage { get; set; }

• Type: string

Comma-separated list of allowed usages for this issuer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_issuer#usage PkiSecretBackendIssuer#usage}

---