Skip to content

Latest commit

 

History

History
2926 lines (1833 loc) · 135 KB

jwtAuthBackend.java.md

File metadata and controls

2926 lines (1833 loc) · 135 KB

jwtAuthBackend Submodule

Constructs

JwtAuthBackend

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

Initializers 

import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackend;

JwtAuthBackend.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
//  .boundIssuer(java.lang.String)
//  .defaultRole(java.lang.String)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .jwksCaPem(java.lang.String)
//  .jwksUrl(java.lang.String)
//  .jwtSupportedAlgs(java.util.List<java.lang.String>)
//  .jwtValidationPubkeys(java.util.List<java.lang.String>)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .namespace(java.lang.String)
//  .namespaceInState(java.lang.Boolean)
//  .namespaceInState(IResolvable)
//  .oidcClientId(java.lang.String)
//  .oidcClientSecret(java.lang.String)
//  .oidcDiscoveryCaPem(java.lang.String)
//  .oidcDiscoveryUrl(java.lang.String)
//  .oidcResponseMode(java.lang.String)
//  .oidcResponseTypes(java.util.List<java.lang.String>)
//  .path(java.lang.String)
//  .providerConfig(java.util.Map<java.lang.String, java.lang.String>)
//  .tune(IResolvable)
//  .tune(java.util.List<JwtAuthBackendTune>)
//  .type(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
boundIssuer java.lang.String The value against which to match the iss claim in a JWT.
defaultRole java.lang.String The default role to use if none is provided during login.
description java.lang.String The description of the auth backend.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, opts out of mount migration on path updates.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#id JwtAuthBackend#id}.
jwksCaPem java.lang.String The CA certificate or chain of certificates, in PEM format, to use to validate connections to the JWKS URL.
jwksUrl java.lang.String JWKS URL to use to authenticate signatures. Cannot be used with 'oidc_discovery_url' or 'jwt_validation_pubkeys'.
jwtSupportedAlgs java.util.List<java.lang.String> A list of supported signing algorithms. Defaults to [RS256].
jwtValidationPubkeys java.util.List<java.lang.String> A list of PEM-encoded public keys to use to authenticate signatures locally.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the auth method is local only.
namespace java.lang.String Target namespace. (requires Enterprise).
namespaceInState java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Pass namespace in the OIDC state parameter instead of as a separate query parameter.
oidcClientId java.lang.String Client ID used for OIDC.
oidcClientSecret java.lang.String Client Secret used for OIDC.
oidcDiscoveryCaPem java.lang.String The CA certificate or chain of certificates, in PEM format, to use to validate connections to the OIDC Discovery URL.
oidcDiscoveryUrl java.lang.String The OIDC Discovery URL, without any .well-known component (base path). Cannot be used with 'jwks_url' or 'jwt_validation_pubkeys'.
oidcResponseMode java.lang.String The response mode to be used in the OAuth2 request.
oidcResponseTypes java.util.List<java.lang.String> The response types to request.
path java.lang.String path to mount the backend.
providerConfig java.util.Map<java.lang.String, java.lang.String> Provider specific handling configuration.
tune com.hashicorp.cdktf.IResolvable OR java.util.List<JwtAuthBackendTune> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#tune JwtAuthBackend#tune}.
type java.lang.String Type of backend. Can be either 'jwt' or 'oidc'.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
boundIssuerOptional
  • Type: java.lang.String

The value against which to match the iss claim in a JWT.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#bound_issuer JwtAuthBackend#bound_issuer}

defaultRoleOptional
  • Type: java.lang.String

The default role to use if none is provided during login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#default_role JwtAuthBackend#default_role}

descriptionOptional
  • Type: java.lang.String

The description of the auth backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#description JwtAuthBackend#description}

disableRemountOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#disable_remount JwtAuthBackend#disable_remount}

idOptional
  • Type: java.lang.String

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

jwksCaPemOptional
  • Type: java.lang.String

The CA certificate or chain of certificates, in PEM format, to use to validate connections to the JWKS URL.

If not set, system certificates are used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwks_ca_pem JwtAuthBackend#jwks_ca_pem}

jwksUrlOptional
  • Type: java.lang.String

JWKS URL to use to authenticate signatures. Cannot be used with 'oidc_discovery_url' or 'jwt_validation_pubkeys'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwks_url JwtAuthBackend#jwks_url}

jwtSupportedAlgsOptional
  • Type: java.util.List<java.lang.String>

A list of supported signing algorithms. Defaults to [RS256].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwt_supported_algs JwtAuthBackend#jwt_supported_algs}

jwtValidationPubkeysOptional
  • Type: java.util.List<java.lang.String>

A list of PEM-encoded public keys to use to authenticate signatures locally.

Cannot be used with 'jwks_url' or 'oidc_discovery_url'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwt_validation_pubkeys JwtAuthBackend#jwt_validation_pubkeys}

localOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Specifies if the auth method is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#local JwtAuthBackend#local}

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#namespace JwtAuthBackend#namespace}

namespaceInStateOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Pass namespace in the OIDC state parameter instead of as a separate query parameter.

With this setting, the allowed redirect URL(s) in Vault and on the provider side should not contain a namespace query parameter. This means only one redirect URL entry needs to be maintained on the OIDC provider side for all vault namespaces that will be authenticating against it. Defaults to true for new configs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#namespace_in_state JwtAuthBackend#namespace_in_state}

oidcClientIdOptional
  • Type: java.lang.String

Client ID used for OIDC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_client_id JwtAuthBackend#oidc_client_id}

oidcClientSecretOptional
  • Type: java.lang.String

Client Secret used for OIDC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_client_secret JwtAuthBackend#oidc_client_secret}

oidcDiscoveryCaPemOptional
  • Type: java.lang.String

The CA certificate or chain of certificates, in PEM format, to use to validate connections to the OIDC Discovery URL.

If not set, system certificates are used

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_discovery_ca_pem JwtAuthBackend#oidc_discovery_ca_pem}

oidcDiscoveryUrlOptional
  • Type: java.lang.String

The OIDC Discovery URL, without any .well-known component (base path). Cannot be used with 'jwks_url' or 'jwt_validation_pubkeys'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_discovery_url JwtAuthBackend#oidc_discovery_url}

oidcResponseModeOptional
  • Type: java.lang.String

The response mode to be used in the OAuth2 request.

Allowed values are 'query' and 'form_post'. Defaults to 'query'. If using Vault namespaces, and oidc_response_mode is 'form_post', then 'namespace_in_state' should be set to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_response_mode JwtAuthBackend#oidc_response_mode}

oidcResponseTypesOptional
  • Type: java.util.List<java.lang.String>

The response types to request.

Allowed values are 'code' and 'id_token'. Defaults to 'code'. Note: 'id_token' may only be used if 'oidc_response_mode' is set to 'form_post'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_response_types JwtAuthBackend#oidc_response_types}

pathOptional
  • Type: java.lang.String

path to mount the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#path JwtAuthBackend#path}

providerConfigOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Provider specific handling configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#provider_config JwtAuthBackend#provider_config}

tuneOptional

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#tune JwtAuthBackend#tune}.

typeOptional
  • Type: java.lang.String

Type of backend. Can be either 'jwt' or 'oidc'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#type JwtAuthBackend#type}

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".
putTune No description.
resetBoundIssuer No description.
resetDefaultRole No description.
resetDescription No description.
resetDisableRemount No description.
resetId No description.
resetJwksCaPem No description.
resetJwksUrl No description.
resetJwtSupportedAlgs No description.
resetJwtValidationPubkeys No description.
resetLocal No description.
resetNamespace No description.
resetNamespaceInState No description.
resetOidcClientId No description.
resetOidcClientSecret No description.
resetOidcDiscoveryCaPem No description.
resetOidcDiscoveryUrl No description.
resetOidcResponseMode No description.
resetOidcResponseTypes No description.
resetPath No description.
resetProviderConfig No description.
resetTune No description.
resetType No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.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.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putTune 
public void putTune(IResolvable OR java.util.List<JwtAuthBackendTune> value)
valueRequired
resetBoundIssuer 
public void resetBoundIssuer()
resetDefaultRole 
public void resetDefaultRole()
resetDescription 
public void resetDescription()
resetDisableRemount 
public void resetDisableRemount()
resetId 
public void resetId()
resetJwksCaPem 
public void resetJwksCaPem()
resetJwksUrl 
public void resetJwksUrl()
resetJwtSupportedAlgs 
public void resetJwtSupportedAlgs()
resetJwtValidationPubkeys 
public void resetJwtValidationPubkeys()
resetLocal 
public void resetLocal()
resetNamespace 
public void resetNamespace()
resetNamespaceInState 
public void resetNamespaceInState()
resetOidcClientId 
public void resetOidcClientId()
resetOidcClientSecret 
public void resetOidcClientSecret()
resetOidcDiscoveryCaPem 
public void resetOidcDiscoveryCaPem()
resetOidcDiscoveryUrl 
public void resetOidcDiscoveryUrl()
resetOidcResponseMode 
public void resetOidcResponseMode()
resetOidcResponseTypes 
public void resetOidcResponseTypes()
resetPath 
public void resetPath()
resetProviderConfig 
public void resetProviderConfig()
resetTune 
public void resetTune()
resetType 
public void resetType()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a JwtAuthBackend resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackend;

JwtAuthBackend.isConstruct(java.lang.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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackend;

JwtAuthBackend.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackend;

JwtAuthBackend.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackend;

JwtAuthBackend.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),JwtAuthBackend.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing JwtAuthBackend that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
accessor java.lang.String No description.
tune JwtAuthBackendTuneList No description.
boundIssuerInput java.lang.String No description.
defaultRoleInput java.lang.String No description.
descriptionInput java.lang.String No description.
disableRemountInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
jwksCaPemInput java.lang.String No description.
jwksUrlInput java.lang.String No description.
jwtSupportedAlgsInput java.util.List<java.lang.String> No description.
jwtValidationPubkeysInput java.util.List<java.lang.String> No description.
localInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
namespaceInput java.lang.String No description.
namespaceInStateInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
oidcClientIdInput java.lang.String No description.
oidcClientSecretInput java.lang.String No description.
oidcDiscoveryCaPemInput java.lang.String No description.
oidcDiscoveryUrlInput java.lang.String No description.
oidcResponseModeInput java.lang.String No description.
oidcResponseTypesInput java.util.List<java.lang.String> No description.
pathInput java.lang.String No description.
providerConfigInput java.util.Map<java.lang.String, java.lang.String> No description.
tuneInput com.hashicorp.cdktf.IResolvable OR java.util.List<JwtAuthBackendTune> No description.
typeInput java.lang.String No description.
boundIssuer java.lang.String No description.
defaultRole java.lang.String No description.
description java.lang.String No description.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
jwksCaPem java.lang.String No description.
jwksUrl java.lang.String No description.
jwtSupportedAlgs java.util.List<java.lang.String> No description.
jwtValidationPubkeys java.util.List<java.lang.String> No description.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
namespace java.lang.String No description.
namespaceInState java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
oidcClientId java.lang.String No description.
oidcClientSecret java.lang.String No description.
oidcDiscoveryCaPem java.lang.String No description.
oidcDiscoveryUrl java.lang.String No description.
oidcResponseMode java.lang.String No description.
oidcResponseTypes java.util.List<java.lang.String> No description.
path java.lang.String No description.
providerConfig java.util.Map<java.lang.String, java.lang.String> No description.
type java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
accessorRequired 
public java.lang.String getAccessor();
  • Type: java.lang.String
tuneRequired 
public JwtAuthBackendTuneList getTune();
boundIssuerInputOptional 
public java.lang.String getBoundIssuerInput();
  • Type: java.lang.String
defaultRoleInputOptional 
public java.lang.String getDefaultRoleInput();
  • Type: java.lang.String
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
disableRemountInputOptional 
public java.lang.Object getDisableRemountInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
jwksCaPemInputOptional 
public java.lang.String getJwksCaPemInput();
  • Type: java.lang.String
jwksUrlInputOptional 
public java.lang.String getJwksUrlInput();
  • Type: java.lang.String
jwtSupportedAlgsInputOptional 
public java.util.List<java.lang.String> getJwtSupportedAlgsInput();
  • Type: java.util.List<java.lang.String>
jwtValidationPubkeysInputOptional 
public java.util.List<java.lang.String> getJwtValidationPubkeysInput();
  • Type: java.util.List<java.lang.String>
localInputOptional 
public java.lang.Object getLocalInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
namespaceInStateInputOptional 
public java.lang.Object getNamespaceInStateInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
oidcClientIdInputOptional 
public java.lang.String getOidcClientIdInput();
  • Type: java.lang.String
oidcClientSecretInputOptional 
public java.lang.String getOidcClientSecretInput();
  • Type: java.lang.String
oidcDiscoveryCaPemInputOptional 
public java.lang.String getOidcDiscoveryCaPemInput();
  • Type: java.lang.String
oidcDiscoveryUrlInputOptional 
public java.lang.String getOidcDiscoveryUrlInput();
  • Type: java.lang.String
oidcResponseModeInputOptional 
public java.lang.String getOidcResponseModeInput();
  • Type: java.lang.String
oidcResponseTypesInputOptional 
public java.util.List<java.lang.String> getOidcResponseTypesInput();
  • Type: java.util.List<java.lang.String>
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
providerConfigInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getProviderConfigInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tuneInputOptional 
public java.lang.Object getTuneInput();
typeInputOptional 
public java.lang.String getTypeInput();
  • Type: java.lang.String
boundIssuerRequired 
public java.lang.String getBoundIssuer();
  • Type: java.lang.String
defaultRoleRequired 
public java.lang.String getDefaultRole();
  • Type: java.lang.String
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
disableRemountRequired 
public java.lang.Object getDisableRemount();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
jwksCaPemRequired 
public java.lang.String getJwksCaPem();
  • Type: java.lang.String
jwksUrlRequired 
public java.lang.String getJwksUrl();
  • Type: java.lang.String
jwtSupportedAlgsRequired 
public java.util.List<java.lang.String> getJwtSupportedAlgs();
  • Type: java.util.List<java.lang.String>
jwtValidationPubkeysRequired 
public java.util.List<java.lang.String> getJwtValidationPubkeys();
  • Type: java.util.List<java.lang.String>
localRequired 
public java.lang.Object getLocal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
namespaceInStateRequired 
public java.lang.Object getNamespaceInState();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
oidcClientIdRequired 
public java.lang.String getOidcClientId();
  • Type: java.lang.String
oidcClientSecretRequired 
public java.lang.String getOidcClientSecret();
  • Type: java.lang.String
oidcDiscoveryCaPemRequired 
public java.lang.String getOidcDiscoveryCaPem();
  • Type: java.lang.String
oidcDiscoveryUrlRequired 
public java.lang.String getOidcDiscoveryUrl();
  • Type: java.lang.String
oidcResponseModeRequired 
public java.lang.String getOidcResponseMode();
  • Type: java.lang.String
oidcResponseTypesRequired 
public java.util.List<java.lang.String> getOidcResponseTypes();
  • Type: java.util.List<java.lang.String>
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
providerConfigRequired 
public java.util.Map<java.lang.String, java.lang.String> getProviderConfig();
  • Type: java.util.Map<java.lang.String, java.lang.String>
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

JwtAuthBackendConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackendConfig;

JwtAuthBackendConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
//  .boundIssuer(java.lang.String)
//  .defaultRole(java.lang.String)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .jwksCaPem(java.lang.String)
//  .jwksUrl(java.lang.String)
//  .jwtSupportedAlgs(java.util.List<java.lang.String>)
//  .jwtValidationPubkeys(java.util.List<java.lang.String>)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .namespace(java.lang.String)
//  .namespaceInState(java.lang.Boolean)
//  .namespaceInState(IResolvable)
//  .oidcClientId(java.lang.String)
//  .oidcClientSecret(java.lang.String)
//  .oidcDiscoveryCaPem(java.lang.String)
//  .oidcDiscoveryUrl(java.lang.String)
//  .oidcResponseMode(java.lang.String)
//  .oidcResponseTypes(java.util.List<java.lang.String>)
//  .path(java.lang.String)
//  .providerConfig(java.util.Map<java.lang.String, java.lang.String>)
//  .tune(IResolvable)
//  .tune(java.util.List<JwtAuthBackendTune>)
//  .type(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
boundIssuer java.lang.String The value against which to match the iss claim in a JWT.
defaultRole java.lang.String The default role to use if none is provided during login.
description java.lang.String The description of the auth backend.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, opts out of mount migration on path updates.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#id JwtAuthBackend#id}.
jwksCaPem java.lang.String The CA certificate or chain of certificates, in PEM format, to use to validate connections to the JWKS URL.
jwksUrl java.lang.String JWKS URL to use to authenticate signatures. Cannot be used with 'oidc_discovery_url' or 'jwt_validation_pubkeys'.
jwtSupportedAlgs java.util.List<java.lang.String> A list of supported signing algorithms. Defaults to [RS256].
jwtValidationPubkeys java.util.List<java.lang.String> A list of PEM-encoded public keys to use to authenticate signatures locally.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the auth method is local only.
namespace java.lang.String Target namespace. (requires Enterprise).
namespaceInState java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Pass namespace in the OIDC state parameter instead of as a separate query parameter.
oidcClientId java.lang.String Client ID used for OIDC.
oidcClientSecret java.lang.String Client Secret used for OIDC.
oidcDiscoveryCaPem java.lang.String The CA certificate or chain of certificates, in PEM format, to use to validate connections to the OIDC Discovery URL.
oidcDiscoveryUrl java.lang.String The OIDC Discovery URL, without any .well-known component (base path). Cannot be used with 'jwks_url' or 'jwt_validation_pubkeys'.
oidcResponseMode java.lang.String The response mode to be used in the OAuth2 request.
oidcResponseTypes java.util.List<java.lang.String> The response types to request.
path java.lang.String path to mount the backend.
providerConfig java.util.Map<java.lang.String, java.lang.String> Provider specific handling configuration.
tune com.hashicorp.cdktf.IResolvable OR java.util.List<JwtAuthBackendTune> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#tune JwtAuthBackend#tune}.
type java.lang.String Type of backend. Can be either 'jwt' or 'oidc'.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
boundIssuerOptional 
public java.lang.String getBoundIssuer();
  • Type: java.lang.String

The value against which to match the iss claim in a JWT.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#bound_issuer JwtAuthBackend#bound_issuer}

defaultRoleOptional 
public java.lang.String getDefaultRole();
  • Type: java.lang.String

The default role to use if none is provided during login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#default_role JwtAuthBackend#default_role}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

The description of the auth backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#description JwtAuthBackend#description}

disableRemountOptional 
public java.lang.Object getDisableRemount();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#disable_remount JwtAuthBackend#disable_remount}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

jwksCaPemOptional 
public java.lang.String getJwksCaPem();
  • Type: java.lang.String

The CA certificate or chain of certificates, in PEM format, to use to validate connections to the JWKS URL.

If not set, system certificates are used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwks_ca_pem JwtAuthBackend#jwks_ca_pem}

jwksUrlOptional 
public java.lang.String getJwksUrl();
  • Type: java.lang.String

JWKS URL to use to authenticate signatures. Cannot be used with 'oidc_discovery_url' or 'jwt_validation_pubkeys'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwks_url JwtAuthBackend#jwks_url}

jwtSupportedAlgsOptional 
public java.util.List<java.lang.String> getJwtSupportedAlgs();
  • Type: java.util.List<java.lang.String>

A list of supported signing algorithms. Defaults to [RS256].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwt_supported_algs JwtAuthBackend#jwt_supported_algs}

jwtValidationPubkeysOptional 
public java.util.List<java.lang.String> getJwtValidationPubkeys();
  • Type: java.util.List<java.lang.String>

A list of PEM-encoded public keys to use to authenticate signatures locally.

Cannot be used with 'jwks_url' or 'oidc_discovery_url'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#jwt_validation_pubkeys JwtAuthBackend#jwt_validation_pubkeys}

localOptional 
public java.lang.Object getLocal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Specifies if the auth method is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#local JwtAuthBackend#local}

namespaceOptional 
public java.lang.String getNamespace();
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#namespace JwtAuthBackend#namespace}

namespaceInStateOptional 
public java.lang.Object getNamespaceInState();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Pass namespace in the OIDC state parameter instead of as a separate query parameter.

With this setting, the allowed redirect URL(s) in Vault and on the provider side should not contain a namespace query parameter. This means only one redirect URL entry needs to be maintained on the OIDC provider side for all vault namespaces that will be authenticating against it. Defaults to true for new configs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#namespace_in_state JwtAuthBackend#namespace_in_state}

oidcClientIdOptional 
public java.lang.String getOidcClientId();
  • Type: java.lang.String

Client ID used for OIDC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_client_id JwtAuthBackend#oidc_client_id}

oidcClientSecretOptional 
public java.lang.String getOidcClientSecret();
  • Type: java.lang.String

Client Secret used for OIDC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_client_secret JwtAuthBackend#oidc_client_secret}

oidcDiscoveryCaPemOptional 
public java.lang.String getOidcDiscoveryCaPem();
  • Type: java.lang.String

The CA certificate or chain of certificates, in PEM format, to use to validate connections to the OIDC Discovery URL.

If not set, system certificates are used

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_discovery_ca_pem JwtAuthBackend#oidc_discovery_ca_pem}

oidcDiscoveryUrlOptional 
public java.lang.String getOidcDiscoveryUrl();
  • Type: java.lang.String

The OIDC Discovery URL, without any .well-known component (base path). Cannot be used with 'jwks_url' or 'jwt_validation_pubkeys'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_discovery_url JwtAuthBackend#oidc_discovery_url}

oidcResponseModeOptional 
public java.lang.String getOidcResponseMode();
  • Type: java.lang.String

The response mode to be used in the OAuth2 request.

Allowed values are 'query' and 'form_post'. Defaults to 'query'. If using Vault namespaces, and oidc_response_mode is 'form_post', then 'namespace_in_state' should be set to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_response_mode JwtAuthBackend#oidc_response_mode}

oidcResponseTypesOptional 
public java.util.List<java.lang.String> getOidcResponseTypes();
  • Type: java.util.List<java.lang.String>

The response types to request.

Allowed values are 'code' and 'id_token'. Defaults to 'code'. Note: 'id_token' may only be used if 'oidc_response_mode' is set to 'form_post'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#oidc_response_types JwtAuthBackend#oidc_response_types}

pathOptional 
public java.lang.String getPath();
  • Type: java.lang.String

path to mount the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#path JwtAuthBackend#path}

providerConfigOptional 
public java.util.Map<java.lang.String, java.lang.String> getProviderConfig();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Provider specific handling configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#provider_config JwtAuthBackend#provider_config}

tuneOptional 
public java.lang.Object getTune();

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#tune JwtAuthBackend#tune}.

typeOptional 
public java.lang.String getType();
  • Type: java.lang.String

Type of backend. Can be either 'jwt' or 'oidc'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#type JwtAuthBackend#type}

JwtAuthBackendTune

Initializer 

import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackendTune;

JwtAuthBackendTune.builder()
//  .allowedResponseHeaders(java.util.List<java.lang.String>)
//  .auditNonHmacRequestKeys(java.util.List<java.lang.String>)
//  .auditNonHmacResponseKeys(java.util.List<java.lang.String>)
//  .defaultLeaseTtl(java.lang.String)
//  .listingVisibility(java.lang.String)
//  .maxLeaseTtl(java.lang.String)
//  .passthroughRequestHeaders(java.util.List<java.lang.String>)
//  .tokenType(java.lang.String)
    .build();

Properties

Name Type Description
allowedResponseHeaders java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#allowed_response_headers JwtAuthBackend#allowed_response_headers}.
auditNonHmacRequestKeys java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#audit_non_hmac_request_keys JwtAuthBackend#audit_non_hmac_request_keys}.
auditNonHmacResponseKeys java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#audit_non_hmac_response_keys JwtAuthBackend#audit_non_hmac_response_keys}.
defaultLeaseTtl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#default_lease_ttl JwtAuthBackend#default_lease_ttl}.
listingVisibility java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#listing_visibility JwtAuthBackend#listing_visibility}.
maxLeaseTtl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#max_lease_ttl JwtAuthBackend#max_lease_ttl}.
passthroughRequestHeaders java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#passthrough_request_headers JwtAuthBackend#passthrough_request_headers}.
tokenType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#token_type JwtAuthBackend#token_type}.
allowedResponseHeadersOptional 
public java.util.List<java.lang.String> getAllowedResponseHeaders();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#allowed_response_headers JwtAuthBackend#allowed_response_headers}.

auditNonHmacRequestKeysOptional 
public java.util.List<java.lang.String> getAuditNonHmacRequestKeys();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#audit_non_hmac_request_keys JwtAuthBackend#audit_non_hmac_request_keys}.

auditNonHmacResponseKeysOptional 
public java.util.List<java.lang.String> getAuditNonHmacResponseKeys();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#audit_non_hmac_response_keys JwtAuthBackend#audit_non_hmac_response_keys}.

defaultLeaseTtlOptional 
public java.lang.String getDefaultLeaseTtl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#default_lease_ttl JwtAuthBackend#default_lease_ttl}.

listingVisibilityOptional 
public java.lang.String getListingVisibility();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#listing_visibility JwtAuthBackend#listing_visibility}.

maxLeaseTtlOptional 
public java.lang.String getMaxLeaseTtl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#max_lease_ttl JwtAuthBackend#max_lease_ttl}.

passthroughRequestHeadersOptional 
public java.util.List<java.lang.String> getPassthroughRequestHeaders();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#passthrough_request_headers JwtAuthBackend#passthrough_request_headers}.

tokenTypeOptional 
public java.lang.String getTokenType();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/jwt_auth_backend#token_type JwtAuthBackend#token_type}.

Classes

JwtAuthBackendTuneList

Initializers 

import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackendTuneList;

new JwtAuthBackendTuneList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public JwtAuthBackendTuneOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<JwtAuthBackendTune> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

JwtAuthBackendTuneOutputReference

Initializers 

import com.hashicorp.cdktf.providers.vault.jwt_auth_backend.JwtAuthBackendTuneOutputReference;

new JwtAuthBackendTuneOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetAllowedResponseHeaders No description.
resetAuditNonHmacRequestKeys No description.
resetAuditNonHmacResponseKeys No description.
resetDefaultLeaseTtl No description.
resetListingVisibility No description.
resetMaxLeaseTtl No description.
resetPassthroughRequestHeaders No description.
resetTokenType No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAllowedResponseHeaders 
public void resetAllowedResponseHeaders()
resetAuditNonHmacRequestKeys 
public void resetAuditNonHmacRequestKeys()
resetAuditNonHmacResponseKeys 
public void resetAuditNonHmacResponseKeys()
resetDefaultLeaseTtl 
public void resetDefaultLeaseTtl()
resetListingVisibility 
public void resetListingVisibility()
resetMaxLeaseTtl 
public void resetMaxLeaseTtl()
resetPassthroughRequestHeaders 
public void resetPassthroughRequestHeaders()
resetTokenType 
public void resetTokenType()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
allowedResponseHeadersInput java.util.List<java.lang.String> No description.
auditNonHmacRequestKeysInput java.util.List<java.lang.String> No description.
auditNonHmacResponseKeysInput java.util.List<java.lang.String> No description.
defaultLeaseTtlInput java.lang.String No description.
listingVisibilityInput java.lang.String No description.
maxLeaseTtlInput java.lang.String No description.
passthroughRequestHeadersInput java.util.List<java.lang.String> No description.
tokenTypeInput java.lang.String No description.
allowedResponseHeaders java.util.List<java.lang.String> No description.
auditNonHmacRequestKeys java.util.List<java.lang.String> No description.
auditNonHmacResponseKeys java.util.List<java.lang.String> No description.
defaultLeaseTtl java.lang.String No description.
listingVisibility java.lang.String No description.
maxLeaseTtl java.lang.String No description.
passthroughRequestHeaders java.util.List<java.lang.String> No description.
tokenType java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR JwtAuthBackendTune No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
allowedResponseHeadersInputOptional 
public java.util.List<java.lang.String> getAllowedResponseHeadersInput();
  • Type: java.util.List<java.lang.String>
auditNonHmacRequestKeysInputOptional 
public java.util.List<java.lang.String> getAuditNonHmacRequestKeysInput();
  • Type: java.util.List<java.lang.String>
auditNonHmacResponseKeysInputOptional 
public java.util.List<java.lang.String> getAuditNonHmacResponseKeysInput();
  • Type: java.util.List<java.lang.String>
defaultLeaseTtlInputOptional 
public java.lang.String getDefaultLeaseTtlInput();
  • Type: java.lang.String
listingVisibilityInputOptional 
public java.lang.String getListingVisibilityInput();
  • Type: java.lang.String
maxLeaseTtlInputOptional 
public java.lang.String getMaxLeaseTtlInput();
  • Type: java.lang.String
passthroughRequestHeadersInputOptional 
public java.util.List<java.lang.String> getPassthroughRequestHeadersInput();
  • Type: java.util.List<java.lang.String>
tokenTypeInputOptional 
public java.lang.String getTokenTypeInput();
  • Type: java.lang.String
allowedResponseHeadersRequired 
public java.util.List<java.lang.String> getAllowedResponseHeaders();
  • Type: java.util.List<java.lang.String>
auditNonHmacRequestKeysRequired 
public java.util.List<java.lang.String> getAuditNonHmacRequestKeys();
  • Type: java.util.List<java.lang.String>
auditNonHmacResponseKeysRequired 
public java.util.List<java.lang.String> getAuditNonHmacResponseKeys();
  • Type: java.util.List<java.lang.String>
defaultLeaseTtlRequired 
public java.lang.String getDefaultLeaseTtl();
  • Type: java.lang.String
listingVisibilityRequired 
public java.lang.String getListingVisibility();
  • Type: java.lang.String
maxLeaseTtlRequired 
public java.lang.String getMaxLeaseTtl();
  • Type: java.lang.String
passthroughRequestHeadersRequired 
public java.util.List<java.lang.String> getPassthroughRequestHeaders();
  • Type: java.util.List<java.lang.String>
tokenTypeRequired 
public java.lang.String getTokenType();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();