Skip to content

Latest commit

 

History

History
1688 lines (1059 loc) · 76.9 KB

consulSecretBackend.java.md

File metadata and controls

1688 lines (1059 loc) · 76.9 KB
Raw

consulSecretBackend Submodule

Constructs

ConsulSecretBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend vault_consul_secret_backend}.

Initializers 

import com.hashicorp.cdktf.providers.vault.consul_secret_backend.ConsulSecretBackend;

ConsulSecretBackend.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>)
    .address(java.lang.String)
//  .bootstrap(java.lang.Boolean)
//  .bootstrap(IResolvable)
//  .caCert(java.lang.String)
//  .clientCert(java.lang.String)
//  .clientKey(java.lang.String)
//  .defaultLeaseTtlSeconds(java.lang.Number)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .namespace(java.lang.String)
//  .path(java.lang.String)
//  .scheme(java.lang.String)
//  .token(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.
address java.lang.String Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Denotes a backend resource that is used to bootstrap the Consul ACL system.
caCert java.lang.String CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert java.lang.String Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey java.lang.String Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds java.lang.Number Default lease duration for secrets in seconds.
description java.lang.String Human-friendly description of the mount for the 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.4.0/docs/resources/consul_secret_backend#id ConsulSecretBackend#id}.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the secret backend is local only.
maxLeaseTtlSeconds java.lang.Number Maximum possible lease duration for secrets in seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
path java.lang.String Unique name of the Vault Consul mount to configure.
scheme java.lang.String Specifies the URL scheme to use. Defaults to "http".
token java.lang.String Specifies the Consul token to use when managing or issuing new tokens.
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>
addressRequired
  • Type: java.lang.String

Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#address ConsulSecretBackend#address}

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

Denotes a backend resource that is used to bootstrap the Consul ACL system.

Only one resource may be used to bootstrap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#bootstrap ConsulSecretBackend#bootstrap}

caCertOptional
  • Type: java.lang.String

CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#ca_cert ConsulSecretBackend#ca_cert}

clientCertOptional
  • Type: java.lang.String

Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#client_cert ConsulSecretBackend#client_cert}

clientKeyOptional
  • Type: java.lang.String

Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#client_key ConsulSecretBackend#client_key}

defaultLeaseTtlSecondsOptional
  • Type: java.lang.Number

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#default_lease_ttl_seconds ConsulSecretBackend#default_lease_ttl_seconds}

descriptionOptional
  • Type: java.lang.String

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#description ConsulSecretBackend#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.4.0/docs/resources/consul_secret_backend#disable_remount ConsulSecretBackend#disable_remount}

idOptional
  • Type: java.lang.String

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

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

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#local ConsulSecretBackend#local}

maxLeaseTtlSecondsOptional
  • Type: java.lang.Number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#max_lease_ttl_seconds ConsulSecretBackend#max_lease_ttl_seconds}

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#namespace ConsulSecretBackend#namespace}

pathOptional
  • Type: java.lang.String

Unique name of the Vault Consul mount to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#path ConsulSecretBackend#path}

schemeOptional
  • Type: java.lang.String

Specifies the URL scheme to use. Defaults to "http".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#scheme ConsulSecretBackend#scheme}

tokenOptional
  • Type: java.lang.String

Specifies the Consul token to use when managing or issuing new tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#token ConsulSecretBackend#token}

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".
resetBootstrap No description.
resetCaCert No description.
resetClientCert No description.
resetClientKey No description.
resetDefaultLeaseTtlSeconds No description.
resetDescription No description.
resetDisableRemount No description.
resetId No description.
resetLocal No description.
resetMaxLeaseTtlSeconds No description.
resetNamespace No description.
resetPath No description.
resetScheme No description.
resetToken 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".

resetBootstrap 
public void resetBootstrap()
resetCaCert 
public void resetCaCert()
resetClientCert 
public void resetClientCert()
resetClientKey 
public void resetClientKey()
resetDefaultLeaseTtlSeconds 
public void resetDefaultLeaseTtlSeconds()
resetDescription 
public void resetDescription()
resetDisableRemount 
public void resetDisableRemount()
resetId 
public void resetId()
resetLocal 
public void resetLocal()
resetMaxLeaseTtlSeconds 
public void resetMaxLeaseTtlSeconds()
resetNamespace 
public void resetNamespace()
resetPath 
public void resetPath()
resetScheme 
public void resetScheme()
resetToken 
public void resetToken()

Static Functions

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

ConsulSecretBackend.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.consul_secret_backend.ConsulSecretBackend;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing ConsulSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_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 ConsulSecretBackend 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.
addressInput java.lang.String No description.
bootstrapInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
caCertInput java.lang.String No description.
clientCertInput java.lang.String No description.
clientKeyInput java.lang.String No description.
defaultLeaseTtlSecondsInput java.lang.Number 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.
localInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxLeaseTtlSecondsInput java.lang.Number No description.
namespaceInput java.lang.String No description.
pathInput java.lang.String No description.
schemeInput java.lang.String No description.
tokenInput java.lang.String No description.
address java.lang.String No description.
bootstrap java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
caCert java.lang.String No description.
clientCert java.lang.String No description.
clientKey java.lang.String No description.
defaultLeaseTtlSeconds java.lang.Number 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.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxLeaseTtlSeconds java.lang.Number No description.
namespace java.lang.String No description.
path java.lang.String No description.
scheme java.lang.String No description.
token 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>
addressInputOptional 
public java.lang.String getAddressInput();
  • Type: java.lang.String
bootstrapInputOptional 
public java.lang.Object getBootstrapInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
caCertInputOptional 
public java.lang.String getCaCertInput();
  • Type: java.lang.String
clientCertInputOptional 
public java.lang.String getClientCertInput();
  • Type: java.lang.String
clientKeyInputOptional 
public java.lang.String getClientKeyInput();
  • Type: java.lang.String
defaultLeaseTtlSecondsInputOptional 
public java.lang.Number getDefaultLeaseTtlSecondsInput();
  • Type: java.lang.Number
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
localInputOptional 
public java.lang.Object getLocalInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxLeaseTtlSecondsInputOptional 
public java.lang.Number getMaxLeaseTtlSecondsInput();
  • Type: java.lang.Number
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
schemeInputOptional 
public java.lang.String getSchemeInput();
  • Type: java.lang.String
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
addressRequired 
public java.lang.String getAddress();
  • Type: java.lang.String
bootstrapRequired 
public java.lang.Object getBootstrap();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
caCertRequired 
public java.lang.String getCaCert();
  • Type: java.lang.String
clientCertRequired 
public java.lang.String getClientCert();
  • Type: java.lang.String
clientKeyRequired 
public java.lang.String getClientKey();
  • Type: java.lang.String
defaultLeaseTtlSecondsRequired 
public java.lang.Number getDefaultLeaseTtlSeconds();
  • Type: java.lang.Number
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
localRequired 
public java.lang.Object getLocal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxLeaseTtlSecondsRequired 
public java.lang.Number getMaxLeaseTtlSeconds();
  • Type: java.lang.Number
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
schemeRequired 
public java.lang.String getScheme();
  • Type: java.lang.String
tokenRequired 
public java.lang.String getToken();
  • 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

ConsulSecretBackendConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.consul_secret_backend.ConsulSecretBackendConfig;

ConsulSecretBackendConfig.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>)
    .address(java.lang.String)
//  .bootstrap(java.lang.Boolean)
//  .bootstrap(IResolvable)
//  .caCert(java.lang.String)
//  .clientCert(java.lang.String)
//  .clientKey(java.lang.String)
//  .defaultLeaseTtlSeconds(java.lang.Number)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .namespace(java.lang.String)
//  .path(java.lang.String)
//  .scheme(java.lang.String)
//  .token(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.
address java.lang.String Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Denotes a backend resource that is used to bootstrap the Consul ACL system.
caCert java.lang.String CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert java.lang.String Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey java.lang.String Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds java.lang.Number Default lease duration for secrets in seconds.
description java.lang.String Human-friendly description of the mount for the 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.4.0/docs/resources/consul_secret_backend#id ConsulSecretBackend#id}.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the secret backend is local only.
maxLeaseTtlSeconds java.lang.Number Maximum possible lease duration for secrets in seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
path java.lang.String Unique name of the Vault Consul mount to configure.
scheme java.lang.String Specifies the URL scheme to use. Defaults to "http".
token java.lang.String Specifies the Consul token to use when managing or issuing new tokens.
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>
addressRequired 
public java.lang.String getAddress();
  • Type: java.lang.String

Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#address ConsulSecretBackend#address}

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

Denotes a backend resource that is used to bootstrap the Consul ACL system.

Only one resource may be used to bootstrap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#bootstrap ConsulSecretBackend#bootstrap}

caCertOptional 
public java.lang.String getCaCert();
  • Type: java.lang.String

CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#ca_cert ConsulSecretBackend#ca_cert}

clientCertOptional 
public java.lang.String getClientCert();
  • Type: java.lang.String

Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#client_cert ConsulSecretBackend#client_cert}

clientKeyOptional 
public java.lang.String getClientKey();
  • Type: java.lang.String

Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#client_key ConsulSecretBackend#client_key}

defaultLeaseTtlSecondsOptional 
public java.lang.Number getDefaultLeaseTtlSeconds();
  • Type: java.lang.Number

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#default_lease_ttl_seconds ConsulSecretBackend#default_lease_ttl_seconds}

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

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#description ConsulSecretBackend#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.4.0/docs/resources/consul_secret_backend#disable_remount ConsulSecretBackend#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.4.0/docs/resources/consul_secret_backend#id ConsulSecretBackend#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.

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

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#local ConsulSecretBackend#local}

maxLeaseTtlSecondsOptional 
public java.lang.Number getMaxLeaseTtlSeconds();
  • Type: java.lang.Number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#max_lease_ttl_seconds ConsulSecretBackend#max_lease_ttl_seconds}

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.4.0/docs/resources/consul_secret_backend#namespace ConsulSecretBackend#namespace}

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

Unique name of the Vault Consul mount to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#path ConsulSecretBackend#path}

schemeOptional 
public java.lang.String getScheme();
  • Type: java.lang.String

Specifies the URL scheme to use. Defaults to "http".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#scheme ConsulSecretBackend#scheme}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

Specifies the Consul token to use when managing or issuing new tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend#token ConsulSecretBackend#token}