Skip to content

Latest commit

 

History

History
2669 lines (1672 loc) · 125 KB

githubAuthBackend.java.md

File metadata and controls

2669 lines (1672 loc) · 125 KB
Raw

githubAuthBackend Submodule

Constructs

GithubAuthBackend

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

Initializers 

import com.hashicorp.cdktf.providers.vault.github_auth_backend.GithubAuthBackend;

GithubAuthBackend.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>)
    .organization(java.lang.String)
//  .baseUrl(java.lang.String)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .namespace(java.lang.String)
//  .organizationId(java.lang.Number)
//  .path(java.lang.String)
//  .tokenBoundCidrs(java.util.List<java.lang.String>)
//  .tokenExplicitMaxTtl(java.lang.Number)
//  .tokenMaxTtl(java.lang.Number)
//  .tokenNoDefaultPolicy(java.lang.Boolean)
//  .tokenNoDefaultPolicy(IResolvable)
//  .tokenNumUses(java.lang.Number)
//  .tokenPeriod(java.lang.Number)
//  .tokenPolicies(java.util.List<java.lang.String>)
//  .tokenTtl(java.lang.Number)
//  .tokenType(java.lang.String)
//  .tune(IResolvable)
//  .tune(java.util.List<GithubAuthBackendTune>)
    .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.
organization java.lang.String The organization users must be part of.
baseUrl java.lang.String The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
description java.lang.String Specifies the description of the mount. This overrides the current stored value, if any.
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.2.0/docs/resources/github_auth_backend#id GithubAuthBackend#id}.
namespace java.lang.String Target namespace. (requires Enterprise).
organizationId java.lang.Number The ID of the organization users must be part of.
path java.lang.String Path where the auth backend is mounted.
tokenBoundCidrs java.util.List<java.lang.String> Specifies the blocks of IP addresses which are allowed to use the generated token.
tokenExplicitMaxTtl java.lang.Number Generated Token's Explicit Maximum TTL in seconds.
tokenMaxTtl java.lang.Number The maximum lifetime of the generated token.
tokenNoDefaultPolicy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, the 'default' policy will not automatically be added to generated tokens.
tokenNumUses java.lang.Number The maximum number of times a token may be used, a value of zero means unlimited.
tokenPeriod java.lang.Number Generated Token's Period.
tokenPolicies java.util.List<java.lang.String> Generated Token's Policies.
tokenTtl java.lang.Number The initial ttl of the token to generate in seconds.
tokenType java.lang.String The type of token to generate, service or batch.
tune com.hashicorp.cdktf.IResolvable OR java.util.List<GithubAuthBackendTune> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#tune GithubAuthBackend#tune}.
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>
organizationRequired
  • Type: java.lang.String

The organization users must be part of.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#organization GithubAuthBackend#organization}

baseUrlOptional
  • Type: java.lang.String

The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#base_url GithubAuthBackend#base_url}

descriptionOptional
  • Type: java.lang.String

Specifies the description of the mount. This overrides the current stored value, if any.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#description GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#disable_remount GithubAuthBackend#disable_remount}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#id GithubAuthBackend#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
  • Type: java.lang.String

Target namespace. (requires Enterprise).

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

organizationIdOptional
  • Type: java.lang.Number

The ID of the organization users must be part of.

Vault will attempt to fetch and set this value if it is not provided (vault-1.10+)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#organization_id GithubAuthBackend#organization_id}

pathOptional
  • Type: java.lang.String

Path where the auth backend is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#path GithubAuthBackend#path}

tokenBoundCidrsOptional
  • Type: java.util.List<java.lang.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/github_auth_backend#token_bound_cidrs GithubAuthBackend#token_bound_cidrs}

tokenExplicitMaxTtlOptional
  • Type: java.lang.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/github_auth_backend#token_explicit_max_ttl GithubAuthBackend#token_explicit_max_ttl}

tokenMaxTtlOptional
  • Type: java.lang.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/github_auth_backend#token_max_ttl GithubAuthBackend#token_max_ttl}

tokenNoDefaultPolicyOptional
  • Type: java.lang.Boolean OR com.hashicorp.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/github_auth_backend#token_no_default_policy GithubAuthBackend#token_no_default_policy}

tokenNumUsesOptional
  • Type: java.lang.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/github_auth_backend#token_num_uses GithubAuthBackend#token_num_uses}

tokenPeriodOptional
  • Type: java.lang.Number

Generated Token's Period.

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

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

Generated Token's Policies.

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

tokenTtlOptional
  • Type: java.lang.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/github_auth_backend#token_ttl GithubAuthBackend#token_ttl}

tokenTypeOptional
  • Type: java.lang.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/github_auth_backend#token_type GithubAuthBackend#token_type}

tuneOptional

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#tune GithubAuthBackend#tune}.

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.
resetBaseUrl No description.
resetDescription No description.
resetDisableRemount No description.
resetId No description.
resetNamespace No description.
resetOrganizationId No description.
resetPath 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.
resetTune 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<GithubAuthBackendTune> value)
valueRequired
resetBaseUrl 
public void resetBaseUrl()
resetDescription 
public void resetDescription()
resetDisableRemount 
public void resetDisableRemount()
resetId 
public void resetId()
resetNamespace 
public void resetNamespace()
resetOrganizationId 
public void resetOrganizationId()
resetPath 
public void resetPath()
resetTokenBoundCidrs 
public void resetTokenBoundCidrs()
resetTokenExplicitMaxTtl 
public void resetTokenExplicitMaxTtl()
resetTokenMaxTtl 
public void resetTokenMaxTtl()
resetTokenNoDefaultPolicy 
public void resetTokenNoDefaultPolicy()
resetTokenNumUses 
public void resetTokenNumUses()
resetTokenPeriod 
public void resetTokenPeriod()
resetTokenPolicies 
public void resetTokenPolicies()
resetTokenTtl 
public void resetTokenTtl()
resetTokenType 
public void resetTokenType()
resetTune 
public void resetTune()

Static Functions

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

GithubAuthBackend.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.github_auth_backend.GithubAuthBackend;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing GithubAuthBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_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 GithubAuthBackend 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 GithubAuthBackendTuneList No description.
baseUrlInput 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.
namespaceInput java.lang.String No description.
organizationIdInput java.lang.Number No description.
organizationInput java.lang.String No description.
pathInput java.lang.String No description.
tokenBoundCidrsInput java.util.List<java.lang.String> No description.
tokenExplicitMaxTtlInput java.lang.Number No description.
tokenMaxTtlInput java.lang.Number No description.
tokenNoDefaultPolicyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tokenNumUsesInput java.lang.Number No description.
tokenPeriodInput java.lang.Number No description.
tokenPoliciesInput java.util.List<java.lang.String> No description.
tokenTtlInput java.lang.Number No description.
tokenTypeInput java.lang.String No description.
tuneInput com.hashicorp.cdktf.IResolvable OR java.util.List<GithubAuthBackendTune> No description.
baseUrl 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.
namespace java.lang.String No description.
organization java.lang.String No description.
organizationId java.lang.Number No description.
path java.lang.String No description.
tokenBoundCidrs java.util.List<java.lang.String> No description.
tokenExplicitMaxTtl java.lang.Number No description.
tokenMaxTtl java.lang.Number No description.
tokenNoDefaultPolicy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tokenNumUses java.lang.Number No description.
tokenPeriod java.lang.Number No description.
tokenPolicies java.util.List<java.lang.String> No description.
tokenTtl java.lang.Number No description.
tokenType 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 GithubAuthBackendTuneList getTune();
baseUrlInputOptional 
public java.lang.String getBaseUrlInput();
  • 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
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
organizationIdInputOptional 
public java.lang.Number getOrganizationIdInput();
  • Type: java.lang.Number
organizationInputOptional 
public java.lang.String getOrganizationInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
tokenBoundCidrsInputOptional 
public java.util.List<java.lang.String> getTokenBoundCidrsInput();
  • Type: java.util.List<java.lang.String>
tokenExplicitMaxTtlInputOptional 
public java.lang.Number getTokenExplicitMaxTtlInput();
  • Type: java.lang.Number
tokenMaxTtlInputOptional 
public java.lang.Number getTokenMaxTtlInput();
  • Type: java.lang.Number
tokenNoDefaultPolicyInputOptional 
public java.lang.Object getTokenNoDefaultPolicyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tokenNumUsesInputOptional 
public java.lang.Number getTokenNumUsesInput();
  • Type: java.lang.Number
tokenPeriodInputOptional 
public java.lang.Number getTokenPeriodInput();
  • Type: java.lang.Number
tokenPoliciesInputOptional 
public java.util.List<java.lang.String> getTokenPoliciesInput();
  • Type: java.util.List<java.lang.String>
tokenTtlInputOptional 
public java.lang.Number getTokenTtlInput();
  • Type: java.lang.Number
tokenTypeInputOptional 
public java.lang.String getTokenTypeInput();
  • Type: java.lang.String
tuneInputOptional 
public java.lang.Object getTuneInput();
baseUrlRequired 
public java.lang.String getBaseUrl();
  • 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
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
organizationRequired 
public java.lang.String getOrganization();
  • Type: java.lang.String
organizationIdRequired 
public java.lang.Number getOrganizationId();
  • Type: java.lang.Number
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
tokenBoundCidrsRequired 
public java.util.List<java.lang.String> getTokenBoundCidrs();
  • Type: java.util.List<java.lang.String>
tokenExplicitMaxTtlRequired 
public java.lang.Number getTokenExplicitMaxTtl();
  • Type: java.lang.Number
tokenMaxTtlRequired 
public java.lang.Number getTokenMaxTtl();
  • Type: java.lang.Number
tokenNoDefaultPolicyRequired 
public java.lang.Object getTokenNoDefaultPolicy();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tokenNumUsesRequired 
public java.lang.Number getTokenNumUses();
  • Type: java.lang.Number
tokenPeriodRequired 
public java.lang.Number getTokenPeriod();
  • Type: java.lang.Number
tokenPoliciesRequired 
public java.util.List<java.lang.String> getTokenPolicies();
  • Type: java.util.List<java.lang.String>
tokenTtlRequired 
public java.lang.Number getTokenTtl();
  • Type: java.lang.Number
tokenTypeRequired 
public java.lang.String getTokenType();
  • 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

GithubAuthBackendConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.github_auth_backend.GithubAuthBackendConfig;

GithubAuthBackendConfig.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>)
    .organization(java.lang.String)
//  .baseUrl(java.lang.String)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .namespace(java.lang.String)
//  .organizationId(java.lang.Number)
//  .path(java.lang.String)
//  .tokenBoundCidrs(java.util.List<java.lang.String>)
//  .tokenExplicitMaxTtl(java.lang.Number)
//  .tokenMaxTtl(java.lang.Number)
//  .tokenNoDefaultPolicy(java.lang.Boolean)
//  .tokenNoDefaultPolicy(IResolvable)
//  .tokenNumUses(java.lang.Number)
//  .tokenPeriod(java.lang.Number)
//  .tokenPolicies(java.util.List<java.lang.String>)
//  .tokenTtl(java.lang.Number)
//  .tokenType(java.lang.String)
//  .tune(IResolvable)
//  .tune(java.util.List<GithubAuthBackendTune>)
    .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.
organization java.lang.String The organization users must be part of.
baseUrl java.lang.String The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
description java.lang.String Specifies the description of the mount. This overrides the current stored value, if any.
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.2.0/docs/resources/github_auth_backend#id GithubAuthBackend#id}.
namespace java.lang.String Target namespace. (requires Enterprise).
organizationId java.lang.Number The ID of the organization users must be part of.
path java.lang.String Path where the auth backend is mounted.
tokenBoundCidrs java.util.List<java.lang.String> Specifies the blocks of IP addresses which are allowed to use the generated token.
tokenExplicitMaxTtl java.lang.Number Generated Token's Explicit Maximum TTL in seconds.
tokenMaxTtl java.lang.Number The maximum lifetime of the generated token.
tokenNoDefaultPolicy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, the 'default' policy will not automatically be added to generated tokens.
tokenNumUses java.lang.Number The maximum number of times a token may be used, a value of zero means unlimited.
tokenPeriod java.lang.Number Generated Token's Period.
tokenPolicies java.util.List<java.lang.String> Generated Token's Policies.
tokenTtl java.lang.Number The initial ttl of the token to generate in seconds.
tokenType java.lang.String The type of token to generate, service or batch.
tune com.hashicorp.cdktf.IResolvable OR java.util.List<GithubAuthBackendTune> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#tune GithubAuthBackend#tune}.
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>
organizationRequired 
public java.lang.String getOrganization();
  • Type: java.lang.String

The organization users must be part of.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#organization GithubAuthBackend#organization}

baseUrlOptional 
public java.lang.String getBaseUrl();
  • Type: java.lang.String

The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#base_url GithubAuthBackend#base_url}

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

Specifies the description of the mount. This overrides the current stored value, if any.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#description GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#disable_remount GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#id GithubAuthBackend#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 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.2.0/docs/resources/github_auth_backend#namespace GithubAuthBackend#namespace}

organizationIdOptional 
public java.lang.Number getOrganizationId();
  • Type: java.lang.Number

The ID of the organization users must be part of.

Vault will attempt to fetch and set this value if it is not provided (vault-1.10+)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#organization_id GithubAuthBackend#organization_id}

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

Path where the auth backend is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#path GithubAuthBackend#path}

tokenBoundCidrsOptional 
public java.util.List<java.lang.String> getTokenBoundCidrs();
  • Type: java.util.List<java.lang.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/github_auth_backend#token_bound_cidrs GithubAuthBackend#token_bound_cidrs}

tokenExplicitMaxTtlOptional 
public java.lang.Number getTokenExplicitMaxTtl();
  • Type: java.lang.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/github_auth_backend#token_explicit_max_ttl GithubAuthBackend#token_explicit_max_ttl}

tokenMaxTtlOptional 
public java.lang.Number getTokenMaxTtl();
  • Type: java.lang.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/github_auth_backend#token_max_ttl GithubAuthBackend#token_max_ttl}

tokenNoDefaultPolicyOptional 
public java.lang.Object getTokenNoDefaultPolicy();
  • Type: java.lang.Boolean OR com.hashicorp.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/github_auth_backend#token_no_default_policy GithubAuthBackend#token_no_default_policy}

tokenNumUsesOptional 
public java.lang.Number getTokenNumUses();
  • Type: java.lang.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/github_auth_backend#token_num_uses GithubAuthBackend#token_num_uses}

tokenPeriodOptional 
public java.lang.Number getTokenPeriod();
  • Type: java.lang.Number

Generated Token's Period.

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

tokenPoliciesOptional 
public java.util.List<java.lang.String> getTokenPolicies();
  • Type: java.util.List<java.lang.String>

Generated Token's Policies.

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

tokenTtlOptional 
public java.lang.Number getTokenTtl();
  • Type: java.lang.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/github_auth_backend#token_ttl GithubAuthBackend#token_ttl}

tokenTypeOptional 
public java.lang.String getTokenType();
  • Type: java.lang.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/github_auth_backend#token_type GithubAuthBackend#token_type}

tuneOptional 
public java.lang.Object getTune();

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#tune GithubAuthBackend#tune}.

GithubAuthBackendTune

Initializer 

import com.hashicorp.cdktf.providers.vault.github_auth_backend.GithubAuthBackendTune;

GithubAuthBackendTune.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.2.0/docs/resources/github_auth_backend#allowed_response_headers GithubAuthBackend#allowed_response_headers}.
auditNonHmacRequestKeys java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#audit_non_hmac_request_keys GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#audit_non_hmac_response_keys GithubAuthBackend#audit_non_hmac_response_keys}.
defaultLeaseTtl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#default_lease_ttl GithubAuthBackend#default_lease_ttl}.
listingVisibility java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#listing_visibility GithubAuthBackend#listing_visibility}.
maxLeaseTtl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#max_lease_ttl GithubAuthBackend#max_lease_ttl}.
passthroughRequestHeaders java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#passthrough_request_headers GithubAuthBackend#passthrough_request_headers}.
tokenType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/github_auth_backend#token_type GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#allowed_response_headers GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#audit_non_hmac_request_keys GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#audit_non_hmac_response_keys GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#default_lease_ttl GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#listing_visibility GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#max_lease_ttl GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#passthrough_request_headers GithubAuthBackend#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.2.0/docs/resources/github_auth_backend#token_type GithubAuthBackend#token_type}.

Classes

GithubAuthBackendTuneList

Initializers 

import com.hashicorp.cdktf.providers.vault.github_auth_backend.GithubAuthBackendTuneList;

new GithubAuthBackendTuneList(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 GithubAuthBackendTuneOutputReference 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<GithubAuthBackendTune> 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();

GithubAuthBackendTuneOutputReference

Initializers 

import com.hashicorp.cdktf.providers.vault.github_auth_backend.GithubAuthBackendTuneOutputReference;

new GithubAuthBackendTuneOutputReference(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 GithubAuthBackendTune 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();