Skip to content

Latest commit

 

History

History
1915 lines (1201 loc) · 84.5 KB

certAuthBackendRole.typescript.md

File metadata and controls

1915 lines (1201 loc) · 84.5 KB

certAuthBackendRole Submodule

Constructs

CertAuthBackendRole

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

Initializers

import { certAuthBackendRole } from '@cdktf/provider-vault'

new certAuthBackendRole.CertAuthBackendRole(scope: Construct, id: string, config: CertAuthBackendRoleConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config CertAuthBackendRoleConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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".
resetAllowedCommonNames No description.
resetAllowedDnsSans No description.
resetAllowedEmailSans No description.
resetAllowedNames No description.
resetAllowedOrganizationalUnits No description.
resetAllowedUriSans No description.
resetBackend No description.
resetDisplayName No description.
resetId No description.
resetNamespace No description.
resetOcspCaCertificates No description.
resetOcspEnabled No description.
resetOcspFailOpen No description.
resetOcspQueryAllServers No description.
resetOcspServersOverride No description.
resetRequiredExtensions 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
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

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.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


resetAllowedCommonNames
public resetAllowedCommonNames(): void
resetAllowedDnsSans
public resetAllowedDnsSans(): void
resetAllowedEmailSans
public resetAllowedEmailSans(): void
resetAllowedNames
public resetAllowedNames(): void
resetAllowedOrganizationalUnits
public resetAllowedOrganizationalUnits(): void
resetAllowedUriSans
public resetAllowedUriSans(): void
resetBackend
public resetBackend(): void
resetDisplayName
public resetDisplayName(): void
resetId
public resetId(): void
resetNamespace
public resetNamespace(): void
resetOcspCaCertificates
public resetOcspCaCertificates(): void
resetOcspEnabled
public resetOcspEnabled(): void
resetOcspFailOpen
public resetOcspFailOpen(): void
resetOcspQueryAllServers
public resetOcspQueryAllServers(): void
resetOcspServersOverride
public resetOcspServersOverride(): void
resetRequiredExtensions
public resetRequiredExtensions(): void
resetTokenBoundCidrs
public resetTokenBoundCidrs(): void
resetTokenExplicitMaxTtl
public resetTokenExplicitMaxTtl(): void
resetTokenMaxTtl
public resetTokenMaxTtl(): void
resetTokenNoDefaultPolicy
public resetTokenNoDefaultPolicy(): void
resetTokenNumUses
public resetTokenNumUses(): void
resetTokenPeriod
public resetTokenPeriod(): void
resetTokenPolicies
public resetTokenPolicies(): void
resetTokenTtl
public resetTokenTtl(): void
resetTokenType
public resetTokenType(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a CertAuthBackendRole resource upon running "cdktf plan ".

isConstruct
import { certAuthBackendRole } from '@cdktf/provider-vault'

certAuthBackendRole.CertAuthBackendRole.isConstruct(x: any)

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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { certAuthBackendRole } from '@cdktf/provider-vault'

certAuthBackendRole.CertAuthBackendRole.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { certAuthBackendRole } from '@cdktf/provider-vault'

certAuthBackendRole.CertAuthBackendRole.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { certAuthBackendRole } from '@cdktf/provider-vault'

certAuthBackendRole.CertAuthBackendRole.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a CertAuthBackendRole resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

The construct id used in the generated config for the CertAuthBackendRole to import.


importFromIdRequired
  • Type: string

The id of the existing CertAuthBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the CertAuthBackendRole to import is found.


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
allowedCommonNamesInput string[] No description.
allowedDnsSansInput string[] No description.
allowedEmailSansInput string[] No description.
allowedNamesInput string[] No description.
allowedOrganizationalUnitsInput string[] No description.
allowedUriSansInput string[] No description.
backendInput string No description.
certificateInput string No description.
displayNameInput string No description.
idInput string No description.
nameInput string No description.
namespaceInput string No description.
ocspCaCertificatesInput string No description.
ocspEnabledInput boolean | cdktf.IResolvable No description.
ocspFailOpenInput boolean | cdktf.IResolvable No description.
ocspQueryAllServersInput boolean | cdktf.IResolvable No description.
ocspServersOverrideInput string[] No description.
requiredExtensionsInput string[] No description.
tokenBoundCidrsInput string[] No description.
tokenExplicitMaxTtlInput number No description.
tokenMaxTtlInput number No description.
tokenNoDefaultPolicyInput boolean | cdktf.IResolvable No description.
tokenNumUsesInput number No description.
tokenPeriodInput number No description.
tokenPoliciesInput string[] No description.
tokenTtlInput number No description.
tokenTypeInput string No description.
allowedCommonNames string[] No description.
allowedDnsSans string[] No description.
allowedEmailSans string[] No description.
allowedNames string[] No description.
allowedOrganizationalUnits string[] No description.
allowedUriSans string[] No description.
backend string No description.
certificate string No description.
displayName string No description.
id string No description.
name string No description.
namespace string No description.
ocspCaCertificates string No description.
ocspEnabled boolean | cdktf.IResolvable No description.
ocspFailOpen boolean | cdktf.IResolvable No description.
ocspQueryAllServers boolean | cdktf.IResolvable No description.
ocspServersOverride string[] No description.
requiredExtensions string[] No description.
tokenBoundCidrs string[] No description.
tokenExplicitMaxTtl number No description.
tokenMaxTtl number No description.
tokenNoDefaultPolicy boolean | cdktf.IResolvable No description.
tokenNumUses number No description.
tokenPeriod number No description.
tokenPolicies string[] No description.
tokenTtl number No description.
tokenType string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

allowedCommonNamesInputOptional
public readonly allowedCommonNamesInput: string[];
  • Type: string[]

allowedDnsSansInputOptional
public readonly allowedDnsSansInput: string[];
  • Type: string[]

allowedEmailSansInputOptional
public readonly allowedEmailSansInput: string[];
  • Type: string[]

allowedNamesInputOptional
public readonly allowedNamesInput: string[];
  • Type: string[]

allowedOrganizationalUnitsInputOptional
public readonly allowedOrganizationalUnitsInput: string[];
  • Type: string[]

allowedUriSansInputOptional
public readonly allowedUriSansInput: string[];
  • Type: string[]

backendInputOptional
public readonly backendInput: string;
  • Type: string

certificateInputOptional
public readonly certificateInput: string;
  • Type: string

displayNameInputOptional
public readonly displayNameInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

namespaceInputOptional
public readonly namespaceInput: string;
  • Type: string

ocspCaCertificatesInputOptional
public readonly ocspCaCertificatesInput: string;
  • Type: string

ocspEnabledInputOptional
public readonly ocspEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ocspFailOpenInputOptional
public readonly ocspFailOpenInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ocspQueryAllServersInputOptional
public readonly ocspQueryAllServersInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ocspServersOverrideInputOptional
public readonly ocspServersOverrideInput: string[];
  • Type: string[]

requiredExtensionsInputOptional
public readonly requiredExtensionsInput: string[];
  • Type: string[]

tokenBoundCidrsInputOptional
public readonly tokenBoundCidrsInput: string[];
  • Type: string[]

tokenExplicitMaxTtlInputOptional
public readonly tokenExplicitMaxTtlInput: number;
  • Type: number

tokenMaxTtlInputOptional
public readonly tokenMaxTtlInput: number;
  • Type: number

tokenNoDefaultPolicyInputOptional
public readonly tokenNoDefaultPolicyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

tokenNumUsesInputOptional
public readonly tokenNumUsesInput: number;
  • Type: number

tokenPeriodInputOptional
public readonly tokenPeriodInput: number;
  • Type: number

tokenPoliciesInputOptional
public readonly tokenPoliciesInput: string[];
  • Type: string[]

tokenTtlInputOptional
public readonly tokenTtlInput: number;
  • Type: number

tokenTypeInputOptional
public readonly tokenTypeInput: string;
  • Type: string

allowedCommonNamesRequired
public readonly allowedCommonNames: string[];
  • Type: string[]

allowedDnsSansRequired
public readonly allowedDnsSans: string[];
  • Type: string[]

allowedEmailSansRequired
public readonly allowedEmailSans: string[];
  • Type: string[]

allowedNamesRequired
public readonly allowedNames: string[];
  • Type: string[]

allowedOrganizationalUnitsRequired
public readonly allowedOrganizationalUnits: string[];
  • Type: string[]

allowedUriSansRequired
public readonly allowedUriSans: string[];
  • Type: string[]

backendRequired
public readonly backend: string;
  • Type: string

certificateRequired
public readonly certificate: string;
  • Type: string

displayNameRequired
public readonly displayName: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

namespaceRequired
public readonly namespace: string;
  • Type: string

ocspCaCertificatesRequired
public readonly ocspCaCertificates: string;
  • Type: string

ocspEnabledRequired
public readonly ocspEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ocspFailOpenRequired
public readonly ocspFailOpen: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ocspQueryAllServersRequired
public readonly ocspQueryAllServers: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ocspServersOverrideRequired
public readonly ocspServersOverride: string[];
  • Type: string[]

requiredExtensionsRequired
public readonly requiredExtensions: string[];
  • Type: string[]

tokenBoundCidrsRequired
public readonly tokenBoundCidrs: string[];
  • Type: string[]

tokenExplicitMaxTtlRequired
public readonly tokenExplicitMaxTtl: number;
  • Type: number

tokenMaxTtlRequired
public readonly tokenMaxTtl: number;
  • Type: number

tokenNoDefaultPolicyRequired
public readonly tokenNoDefaultPolicy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

tokenNumUsesRequired
public readonly tokenNumUses: number;
  • Type: number

tokenPeriodRequired
public readonly tokenPeriod: number;
  • Type: number

tokenPoliciesRequired
public readonly tokenPolicies: string[];
  • Type: string[]

tokenTtlRequired
public readonly tokenTtl: number;
  • Type: number

tokenTypeRequired
public readonly tokenType: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

CertAuthBackendRoleConfig

Initializer

import { certAuthBackendRole } from '@cdktf/provider-vault'

const certAuthBackendRoleConfig: certAuthBackendRole.CertAuthBackendRoleConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
certificate string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#certificate CertAuthBackendRole#certificate}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#name CertAuthBackendRole#name}.
allowedCommonNames string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_common_names CertAuthBackendRole#allowed_common_names}.
allowedDnsSans string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_dns_sans CertAuthBackendRole#allowed_dns_sans}.
allowedEmailSans string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_email_sans CertAuthBackendRole#allowed_email_sans}.
allowedNames string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_names CertAuthBackendRole#allowed_names}.
allowedOrganizationalUnits string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_organizational_units CertAuthBackendRole#allowed_organizational_units}.
allowedUriSans string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_uri_sans CertAuthBackendRole#allowed_uri_sans}.
backend string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#backend CertAuthBackendRole#backend}.
displayName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#display_name CertAuthBackendRole#display_name}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#id CertAuthBackendRole#id}.
namespace string Target namespace. (requires Enterprise).
ocspCaCertificates string Any additional CA certificates needed to verify OCSP responses. Provided as base64 encoded PEM data.
ocspEnabled boolean | cdktf.IResolvable If enabled, validate certificates' revocation status using OCSP.
ocspFailOpen boolean | cdktf.IResolvable If true and an OCSP response cannot be fetched or is of an unknown status, the login will proceed as if the certificate has not been revoked.
ocspQueryAllServers boolean | cdktf.IResolvable If set to true, rather than accepting the first successful OCSP response, query all servers and consider the certificate valid only if all servers agree.
ocspServersOverride string[] A comma-separated list of OCSP server addresses.
requiredExtensions string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#required_extensions CertAuthBackendRole#required_extensions}.
tokenBoundCidrs string[] Specifies the blocks of IP addresses which are allowed to use the generated token.
tokenExplicitMaxTtl number Generated Token's Explicit Maximum TTL in seconds.
tokenMaxTtl number The maximum lifetime of the generated token.
tokenNoDefaultPolicy boolean | cdktf.IResolvable If true, the 'default' policy will not automatically be added to generated tokens.
tokenNumUses number The maximum number of times a token may be used, a value of zero means unlimited.
tokenPeriod number Generated Token's Period.
tokenPolicies string[] Generated Token's Policies.
tokenTtl number The initial ttl of the token to generate in seconds.
tokenType string The type of token to generate, service or batch.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

certificateRequired
public readonly certificate: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#certificate CertAuthBackendRole#certificate}.


nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#name CertAuthBackendRole#name}.


allowedCommonNamesOptional
public readonly allowedCommonNames: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_common_names CertAuthBackendRole#allowed_common_names}.


allowedDnsSansOptional
public readonly allowedDnsSans: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_dns_sans CertAuthBackendRole#allowed_dns_sans}.


allowedEmailSansOptional
public readonly allowedEmailSans: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_email_sans CertAuthBackendRole#allowed_email_sans}.


allowedNamesOptional
public readonly allowedNames: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_names CertAuthBackendRole#allowed_names}.


allowedOrganizationalUnitsOptional
public readonly allowedOrganizationalUnits: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_organizational_units CertAuthBackendRole#allowed_organizational_units}.


allowedUriSansOptional
public readonly allowedUriSans: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#allowed_uri_sans CertAuthBackendRole#allowed_uri_sans}.


backendOptional
public readonly backend: string;
  • Type: string

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


displayNameOptional
public readonly displayName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#display_name CertAuthBackendRole#display_name}.


idOptional
public readonly id: string;
  • Type: string

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


namespaceOptional
public readonly namespace: string;
  • Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#namespace CertAuthBackendRole#namespace}


ocspCaCertificatesOptional
public readonly ocspCaCertificates: string;
  • Type: string

Any additional CA certificates needed to verify OCSP responses. Provided as base64 encoded PEM data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#ocsp_ca_certificates CertAuthBackendRole#ocsp_ca_certificates}


ocspEnabledOptional
public readonly ocspEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If enabled, validate certificates' revocation status using OCSP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#ocsp_enabled CertAuthBackendRole#ocsp_enabled}


ocspFailOpenOptional
public readonly ocspFailOpen: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true and an OCSP response cannot be fetched or is of an unknown status, the login will proceed as if the certificate has not been revoked.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#ocsp_fail_open CertAuthBackendRole#ocsp_fail_open}


ocspQueryAllServersOptional
public readonly ocspQueryAllServers: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If set to true, rather than accepting the first successful OCSP response, query all servers and consider the certificate valid only if all servers agree.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#ocsp_query_all_servers CertAuthBackendRole#ocsp_query_all_servers}


ocspServersOverrideOptional
public readonly ocspServersOverride: string[];
  • Type: string[]

A comma-separated list of OCSP server addresses.

If unset, the OCSP server is determined from the AuthorityInformationAccess extension on the certificate being inspected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#ocsp_servers_override CertAuthBackendRole#ocsp_servers_override}


requiredExtensionsOptional
public readonly requiredExtensions: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#required_extensions CertAuthBackendRole#required_extensions}.


tokenBoundCidrsOptional
public readonly tokenBoundCidrs: string[];
  • 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.2.0/docs/resources/cert_auth_backend_role#token_bound_cidrs CertAuthBackendRole#token_bound_cidrs}


tokenExplicitMaxTtlOptional
public readonly tokenExplicitMaxTtl: number;
  • Type: number

Generated Token's Explicit Maximum TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#token_explicit_max_ttl CertAuthBackendRole#token_explicit_max_ttl}


tokenMaxTtlOptional
public readonly tokenMaxTtl: number;
  • Type: number

The maximum lifetime of the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#token_max_ttl CertAuthBackendRole#token_max_ttl}


tokenNoDefaultPolicyOptional
public readonly tokenNoDefaultPolicy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.2.0/docs/resources/cert_auth_backend_role#token_no_default_policy CertAuthBackendRole#token_no_default_policy}


tokenNumUsesOptional
public readonly tokenNumUses: number;
  • Type: number

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.2.0/docs/resources/cert_auth_backend_role#token_num_uses CertAuthBackendRole#token_num_uses}


tokenPeriodOptional
public readonly tokenPeriod: number;
  • Type: number

Generated Token's Period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#token_period CertAuthBackendRole#token_period}


tokenPoliciesOptional
public readonly tokenPolicies: string[];
  • Type: string[]

Generated Token's Policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#token_policies CertAuthBackendRole#token_policies}


tokenTtlOptional
public readonly tokenTtl: number;
  • Type: number

The initial ttl of the token to generate in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#token_ttl CertAuthBackendRole#token_ttl}


tokenTypeOptional
public readonly tokenType: string;
  • Type: string

The type of token to generate, service or batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/cert_auth_backend_role#token_type CertAuthBackendRole#token_type}