Skip to content

Latest commit

 

History

History
1886 lines (1178 loc) · 80.9 KB

kvSecretV2.java.md

File metadata and controls

1886 lines (1178 loc) · 80.9 KB
Raw

kvSecretV2 Submodule

Constructs

KvSecretV2

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

Initializers 

import com.hashicorp.cdktf.providers.vault.kv_secret_v2.KvSecretV2;

KvSecretV2.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>)
    .dataJson(java.lang.String)
    .mount(java.lang.String)
    .name(java.lang.String)
//  .cas(java.lang.Number)
//  .customMetadata(KvSecretV2CustomMetadata)
//  .deleteAllVersions(java.lang.Boolean)
//  .deleteAllVersions(IResolvable)
//  .disableRead(java.lang.Boolean)
//  .disableRead(IResolvable)
//  .id(java.lang.String)
//  .namespace(java.lang.String)
//  .options(java.util.Map<java.lang.String, 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.
dataJson java.lang.String JSON-encoded secret data to write.
mount java.lang.String Path where KV-V2 engine is mounted.
name java.lang.String Full name of the secret.
cas java.lang.Number This flag is required if cas_required is set to true on either the secret or the engine's config.
customMetadata KvSecretV2CustomMetadata custom_metadata block.
deleteAllVersions java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set to true, permanently deletes all versions for the specified key.
disableRead java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set to true, disables reading secret from Vault; note: drift won't be detected.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#id KvSecretV2#id}.
namespace java.lang.String Target namespace. (requires Enterprise).
options java.util.Map<java.lang.String, java.lang.String> An object that holds option settings.
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>
dataJsonRequired
  • Type: java.lang.String

JSON-encoded secret data to write.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#data_json KvSecretV2#data_json}

mountRequired
  • Type: java.lang.String

Path where KV-V2 engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#mount KvSecretV2#mount}

nameRequired
  • Type: java.lang.String

Full name of the secret.

For a nested secret, the name is the nested path excluding the mount and data prefix. For example, for a secret at 'kvv2/data/foo/bar/baz', the name is 'foo/bar/baz'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#name KvSecretV2#name}

casOptional
  • Type: java.lang.Number

This flag is required if cas_required is set to true on either the secret or the engine's config.

In order for a write to be successful, cas must be set to the current version of the secret.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#cas KvSecretV2#cas}

customMetadataOptional

custom_metadata block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#custom_metadata KvSecretV2#custom_metadata}

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

If set to true, permanently deletes all versions for the specified key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#delete_all_versions KvSecretV2#delete_all_versions}

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

If set to true, disables reading secret from Vault; note: drift won't be detected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#disable_read KvSecretV2#disable_read}

idOptional
  • Type: java.lang.String

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

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

An object that holds option settings.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#options KvSecretV2#options}

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".
putCustomMetadata No description.
resetCas No description.
resetCustomMetadata No description.
resetDeleteAllVersions No description.
resetDisableRead No description.
resetId No description.
resetNamespace No description.
resetOptions 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".

putCustomMetadata 
public void putCustomMetadata(KvSecretV2CustomMetadata value)
valueRequired
resetCas 
public void resetCas()
resetCustomMetadata 
public void resetCustomMetadata()
resetDeleteAllVersions 
public void resetDeleteAllVersions()
resetDisableRead 
public void resetDisableRead()
resetId 
public void resetId()
resetNamespace 
public void resetNamespace()
resetOptions 
public void resetOptions()

Static Functions

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

KvSecretV2.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.kv_secret_v2.KvSecretV2;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing KvSecretV2 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#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 KvSecretV2 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.
customMetadata KvSecretV2CustomMetadataOutputReference No description.
data com.hashicorp.cdktf.StringMap No description.
metadata com.hashicorp.cdktf.StringMap No description.
path java.lang.String No description.
casInput java.lang.Number No description.
customMetadataInput KvSecretV2CustomMetadata No description.
dataJsonInput java.lang.String No description.
deleteAllVersionsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
disableReadInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
mountInput java.lang.String No description.
nameInput java.lang.String No description.
namespaceInput java.lang.String No description.
optionsInput java.util.Map<java.lang.String, java.lang.String> No description.
cas java.lang.Number No description.
dataJson java.lang.String No description.
deleteAllVersions java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
disableRead java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
mount java.lang.String No description.
name java.lang.String No description.
namespace java.lang.String No description.
options java.util.Map<java.lang.String, 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>
customMetadataRequired 
public KvSecretV2CustomMetadataOutputReference getCustomMetadata();
dataRequired 
public StringMap getData();
  • Type: com.hashicorp.cdktf.StringMap
metadataRequired 
public StringMap getMetadata();
  • Type: com.hashicorp.cdktf.StringMap
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
casInputOptional 
public java.lang.Number getCasInput();
  • Type: java.lang.Number
customMetadataInputOptional 
public KvSecretV2CustomMetadata getCustomMetadataInput();
dataJsonInputOptional 
public java.lang.String getDataJsonInput();
  • Type: java.lang.String
deleteAllVersionsInputOptional 
public java.lang.Object getDeleteAllVersionsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
disableReadInputOptional 
public java.lang.Object getDisableReadInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
mountInputOptional 
public java.lang.String getMountInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
optionsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getOptionsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
casRequired 
public java.lang.Number getCas();
  • Type: java.lang.Number
dataJsonRequired 
public java.lang.String getDataJson();
  • Type: java.lang.String
deleteAllVersionsRequired 
public java.lang.Object getDeleteAllVersions();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
disableReadRequired 
public java.lang.Object getDisableRead();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
mountRequired 
public java.lang.String getMount();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
optionsRequired 
public java.util.Map<java.lang.String, java.lang.String> getOptions();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

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

Structs

KvSecretV2Config

Initializer 

import com.hashicorp.cdktf.providers.vault.kv_secret_v2.KvSecretV2Config;

KvSecretV2Config.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>)
    .dataJson(java.lang.String)
    .mount(java.lang.String)
    .name(java.lang.String)
//  .cas(java.lang.Number)
//  .customMetadata(KvSecretV2CustomMetadata)
//  .deleteAllVersions(java.lang.Boolean)
//  .deleteAllVersions(IResolvable)
//  .disableRead(java.lang.Boolean)
//  .disableRead(IResolvable)
//  .id(java.lang.String)
//  .namespace(java.lang.String)
//  .options(java.util.Map<java.lang.String, 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.
dataJson java.lang.String JSON-encoded secret data to write.
mount java.lang.String Path where KV-V2 engine is mounted.
name java.lang.String Full name of the secret.
cas java.lang.Number This flag is required if cas_required is set to true on either the secret or the engine's config.
customMetadata KvSecretV2CustomMetadata custom_metadata block.
deleteAllVersions java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set to true, permanently deletes all versions for the specified key.
disableRead java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set to true, disables reading secret from Vault; note: drift won't be detected.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#id KvSecretV2#id}.
namespace java.lang.String Target namespace. (requires Enterprise).
options java.util.Map<java.lang.String, java.lang.String> An object that holds option settings.
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>
dataJsonRequired 
public java.lang.String getDataJson();
  • Type: java.lang.String

JSON-encoded secret data to write.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#data_json KvSecretV2#data_json}

mountRequired 
public java.lang.String getMount();
  • Type: java.lang.String

Path where KV-V2 engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#mount KvSecretV2#mount}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Full name of the secret.

For a nested secret, the name is the nested path excluding the mount and data prefix. For example, for a secret at 'kvv2/data/foo/bar/baz', the name is 'foo/bar/baz'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#name KvSecretV2#name}

casOptional 
public java.lang.Number getCas();
  • Type: java.lang.Number

This flag is required if cas_required is set to true on either the secret or the engine's config.

In order for a write to be successful, cas must be set to the current version of the secret.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#cas KvSecretV2#cas}

customMetadataOptional 
public KvSecretV2CustomMetadata getCustomMetadata();

custom_metadata block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#custom_metadata KvSecretV2#custom_metadata}

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

If set to true, permanently deletes all versions for the specified key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#delete_all_versions KvSecretV2#delete_all_versions}

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

If set to true, disables reading secret from Vault; note: drift won't be detected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#disable_read KvSecretV2#disable_read}

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

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

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

An object that holds option settings.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#options KvSecretV2#options}

KvSecretV2CustomMetadata

Initializer 

import com.hashicorp.cdktf.providers.vault.kv_secret_v2.KvSecretV2CustomMetadata;

KvSecretV2CustomMetadata.builder()
//  .casRequired(java.lang.Boolean)
//  .casRequired(IResolvable)
//  .data(java.util.Map<java.lang.String, java.lang.String>)
//  .deleteVersionAfter(java.lang.Number)
//  .maxVersions(java.lang.Number)
    .build();

Properties

Name Type Description
casRequired java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, all keys will require the cas parameter to be set on all write requests.
data java.util.Map<java.lang.String, java.lang.String> A map of arbitrary string to string valued user-provided metadata meant to describe the secret.
deleteVersionAfter java.lang.Number If set, specifies the length of time before a version is deleted.
maxVersions java.lang.Number The number of versions to keep per key.
casRequiredOptional 
public java.lang.Object getCasRequired();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

If true, all keys will require the cas parameter to be set on all write requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#cas_required KvSecretV2#cas_required}

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

A map of arbitrary string to string valued user-provided metadata meant to describe the secret.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#data KvSecretV2#data}

deleteVersionAfterOptional 
public java.lang.Number getDeleteVersionAfter();
  • Type: java.lang.Number

If set, specifies the length of time before a version is deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#delete_version_after KvSecretV2#delete_version_after}

maxVersionsOptional 
public java.lang.Number getMaxVersions();
  • Type: java.lang.Number

The number of versions to keep per key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#max_versions KvSecretV2#max_versions}

Classes

KvSecretV2CustomMetadataOutputReference

Initializers 

import com.hashicorp.cdktf.providers.vault.kv_secret_v2.KvSecretV2CustomMetadataOutputReference;

new KvSecretV2CustomMetadataOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
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.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

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.
resetCasRequired No description.
resetData No description.
resetDeleteVersionAfter No description.
resetMaxVersions 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.

resetCasRequired 
public void resetCasRequired()
resetData 
public void resetData()
resetDeleteVersionAfter 
public void resetDeleteVersionAfter()
resetMaxVersions 
public void resetMaxVersions()

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.
casRequiredInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
dataInput java.util.Map<java.lang.String, java.lang.String> No description.
deleteVersionAfterInput java.lang.Number No description.
maxVersionsInput java.lang.Number No description.
casRequired java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
data java.util.Map<java.lang.String, java.lang.String> No description.
deleteVersionAfter java.lang.Number No description.
maxVersions java.lang.Number No description.
internalValue KvSecretV2CustomMetadata 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
casRequiredInputOptional 
public java.lang.Object getCasRequiredInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
dataInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getDataInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
deleteVersionAfterInputOptional 
public java.lang.Number getDeleteVersionAfterInput();
  • Type: java.lang.Number
maxVersionsInputOptional 
public java.lang.Number getMaxVersionsInput();
  • Type: java.lang.Number
casRequiredRequired 
public java.lang.Object getCasRequired();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
dataRequired 
public java.util.Map<java.lang.String, java.lang.String> getData();
  • Type: java.util.Map<java.lang.String, java.lang.String>
deleteVersionAfterRequired 
public java.lang.Number getDeleteVersionAfter();
  • Type: java.lang.Number
maxVersionsRequired 
public java.lang.Number getMaxVersions();
  • Type: java.lang.Number
internalValueOptional 
public KvSecretV2CustomMetadata getInternalValue();