Skip to content

Latest commit

 

History

History
1725 lines (1081 loc) · 82 KB

transitSecretBackendKey.java.md

File metadata and controls

1725 lines (1081 loc) · 82 KB
Raw

transitSecretBackendKey Submodule

Constructs

TransitSecretBackendKey

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

Initializers 

import com.hashicorp.cdktf.providers.vault.transit_secret_backend_key.TransitSecretBackendKey;

TransitSecretBackendKey.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>)
    .backend(java.lang.String)
    .name(java.lang.String)
//  .allowPlaintextBackup(java.lang.Boolean)
//  .allowPlaintextBackup(IResolvable)
//  .autoRotatePeriod(java.lang.Number)
//  .convergentEncryption(java.lang.Boolean)
//  .convergentEncryption(IResolvable)
//  .deletionAllowed(java.lang.Boolean)
//  .deletionAllowed(IResolvable)
//  .derived(java.lang.Boolean)
//  .derived(IResolvable)
//  .exportable(java.lang.Boolean)
//  .exportable(IResolvable)
//  .id(java.lang.String)
//  .keySize(java.lang.Number)
//  .minDecryptionVersion(java.lang.Number)
//  .minEncryptionVersion(java.lang.Number)
//  .namespace(java.lang.String)
//  .type(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
backend java.lang.String The Transit secret backend the resource belongs to.
name java.lang.String Name of the encryption key to create.
allowPlaintextBackup java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.
autoRotatePeriod java.lang.Number Amount of seconds the key should live before being automatically rotated.
convergentEncryption java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext.
deletionAllowed java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the key is allowed to be deleted.
derived java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if key derivation is to be used.
exportable java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables keys to be exportable.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#id TransitSecretBackendKey#id}.
keySize java.lang.Number The key size in bytes for algorithms that allow variable key sizes.
minDecryptionVersion java.lang.Number Minimum key version to use for decryption.
minEncryptionVersion java.lang.Number Minimum key version to use for encryption.
namespace java.lang.String Target namespace. (requires Enterprise).
type java.lang.String Specifies the type of key to create.
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>
backendRequired
  • Type: java.lang.String

The Transit secret backend the resource belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#backend TransitSecretBackendKey#backend}

nameRequired
  • Type: java.lang.String

Name of the encryption key to create.

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

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

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#allow_plaintext_backup TransitSecretBackendKey#allow_plaintext_backup}

autoRotatePeriodOptional
  • Type: java.lang.Number

Amount of seconds the key should live before being automatically rotated.

A value of 0 disables automatic rotation for the key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#auto_rotate_period TransitSecretBackendKey#auto_rotate_period}

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

Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext.

This requires derived to be set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#convergent_encryption TransitSecretBackendKey#convergent_encryption}

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

Specifies if the key is allowed to be deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#deletion_allowed TransitSecretBackendKey#deletion_allowed}

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

Specifies if key derivation is to be used.

If enabled, all encrypt/decrypt requests to this key must provide a context which is used for key derivation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#derived TransitSecretBackendKey#derived}

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

Enables keys to be exportable.

This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#exportable TransitSecretBackendKey#exportable}

idOptional
  • Type: java.lang.String

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

keySizeOptional
  • Type: java.lang.Number

The key size in bytes for algorithms that allow variable key sizes.

Currently only applicable to HMAC; this value must be between 32 and 512.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#key_size TransitSecretBackendKey#key_size}

minDecryptionVersionOptional
  • Type: java.lang.Number

Minimum key version to use for decryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#min_decryption_version TransitSecretBackendKey#min_decryption_version}

minEncryptionVersionOptional
  • Type: java.lang.Number

Minimum key version to use for encryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#min_encryption_version TransitSecretBackendKey#min_encryption_version}

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/transit_secret_backend_key#namespace TransitSecretBackendKey#namespace}

typeOptional
  • Type: java.lang.String

Specifies the type of key to create.

The currently-supported types are: aes128-gcm96, aes256-gcm96, chacha20-poly1305, ed25519, ecdsa-p256, ecdsa-p384, ecdsa-p521, hmac, rsa-2048, rsa-3072, rsa-4096

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

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetAllowPlaintextBackup No description.
resetAutoRotatePeriod No description.
resetConvergentEncryption No description.
resetDeletionAllowed No description.
resetDerived No description.
resetExportable No description.
resetId No description.
resetKeySize No description.
resetMinDecryptionVersion No description.
resetMinEncryptionVersion No description.
resetNamespace No description.
resetType No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

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

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

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

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

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

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

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

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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

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

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

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

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

idRequired
  • Type: java.lang.String

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

resetAllowPlaintextBackup 
public void resetAllowPlaintextBackup()
resetAutoRotatePeriod 
public void resetAutoRotatePeriod()
resetConvergentEncryption 
public void resetConvergentEncryption()
resetDeletionAllowed 
public void resetDeletionAllowed()
resetDerived 
public void resetDerived()
resetExportable 
public void resetExportable()
resetId 
public void resetId()
resetKeySize 
public void resetKeySize()
resetMinDecryptionVersion 
public void resetMinDecryptionVersion()
resetMinEncryptionVersion 
public void resetMinEncryptionVersion()
resetNamespace 
public void resetNamespace()
resetType 
public void resetType()

Static Functions

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

TransitSecretBackendKey.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.transit_secret_backend_key.TransitSecretBackendKey;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing TransitSecretBackendKey that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#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 TransitSecretBackendKey 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.
keys com.hashicorp.cdktf.StringMapList No description.
latestVersion java.lang.Number No description.
minAvailableVersion java.lang.Number No description.
supportsDecryption com.hashicorp.cdktf.IResolvable No description.
supportsDerivation com.hashicorp.cdktf.IResolvable No description.
supportsEncryption com.hashicorp.cdktf.IResolvable No description.
supportsSigning com.hashicorp.cdktf.IResolvable No description.
allowPlaintextBackupInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoRotatePeriodInput java.lang.Number No description.
backendInput java.lang.String No description.
convergentEncryptionInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
deletionAllowedInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
derivedInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
exportableInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
keySizeInput java.lang.Number No description.
minDecryptionVersionInput java.lang.Number No description.
minEncryptionVersionInput java.lang.Number No description.
nameInput java.lang.String No description.
namespaceInput java.lang.String No description.
typeInput java.lang.String No description.
allowPlaintextBackup java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
autoRotatePeriod java.lang.Number No description.
backend java.lang.String No description.
convergentEncryption java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
deletionAllowed java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
derived java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
exportable java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
keySize java.lang.Number No description.
minDecryptionVersion java.lang.Number No description.
minEncryptionVersion java.lang.Number No description.
name java.lang.String No description.
namespace java.lang.String No description.
type java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
keysRequired 
public StringMapList getKeys();
  • Type: com.hashicorp.cdktf.StringMapList
latestVersionRequired 
public java.lang.Number getLatestVersion();
  • Type: java.lang.Number
minAvailableVersionRequired 
public java.lang.Number getMinAvailableVersion();
  • Type: java.lang.Number
supportsDecryptionRequired 
public IResolvable getSupportsDecryption();
  • Type: com.hashicorp.cdktf.IResolvable
supportsDerivationRequired 
public IResolvable getSupportsDerivation();
  • Type: com.hashicorp.cdktf.IResolvable
supportsEncryptionRequired 
public IResolvable getSupportsEncryption();
  • Type: com.hashicorp.cdktf.IResolvable
supportsSigningRequired 
public IResolvable getSupportsSigning();
  • Type: com.hashicorp.cdktf.IResolvable
allowPlaintextBackupInputOptional 
public java.lang.Object getAllowPlaintextBackupInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
autoRotatePeriodInputOptional 
public java.lang.Number getAutoRotatePeriodInput();
  • Type: java.lang.Number
backendInputOptional 
public java.lang.String getBackendInput();
  • Type: java.lang.String
convergentEncryptionInputOptional 
public java.lang.Object getConvergentEncryptionInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
deletionAllowedInputOptional 
public java.lang.Object getDeletionAllowedInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
derivedInputOptional 
public java.lang.Object getDerivedInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
exportableInputOptional 
public java.lang.Object getExportableInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
keySizeInputOptional 
public java.lang.Number getKeySizeInput();
  • Type: java.lang.Number
minDecryptionVersionInputOptional 
public java.lang.Number getMinDecryptionVersionInput();
  • Type: java.lang.Number
minEncryptionVersionInputOptional 
public java.lang.Number getMinEncryptionVersionInput();
  • Type: java.lang.Number
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
typeInputOptional 
public java.lang.String getTypeInput();
  • Type: java.lang.String
allowPlaintextBackupRequired 
public java.lang.Object getAllowPlaintextBackup();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
autoRotatePeriodRequired 
public java.lang.Number getAutoRotatePeriod();
  • Type: java.lang.Number
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String
convergentEncryptionRequired 
public java.lang.Object getConvergentEncryption();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
deletionAllowedRequired 
public java.lang.Object getDeletionAllowed();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
derivedRequired 
public java.lang.Object getDerived();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
exportableRequired 
public java.lang.Object getExportable();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
keySizeRequired 
public java.lang.Number getKeySize();
  • Type: java.lang.Number
minDecryptionVersionRequired 
public java.lang.Number getMinDecryptionVersion();
  • Type: java.lang.Number
minEncryptionVersionRequired 
public java.lang.Number getMinEncryptionVersion();
  • Type: java.lang.Number
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String

Constants

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

Structs

TransitSecretBackendKeyConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.transit_secret_backend_key.TransitSecretBackendKeyConfig;

TransitSecretBackendKeyConfig.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>)
    .backend(java.lang.String)
    .name(java.lang.String)
//  .allowPlaintextBackup(java.lang.Boolean)
//  .allowPlaintextBackup(IResolvable)
//  .autoRotatePeriod(java.lang.Number)
//  .convergentEncryption(java.lang.Boolean)
//  .convergentEncryption(IResolvable)
//  .deletionAllowed(java.lang.Boolean)
//  .deletionAllowed(IResolvable)
//  .derived(java.lang.Boolean)
//  .derived(IResolvable)
//  .exportable(java.lang.Boolean)
//  .exportable(IResolvable)
//  .id(java.lang.String)
//  .keySize(java.lang.Number)
//  .minDecryptionVersion(java.lang.Number)
//  .minEncryptionVersion(java.lang.Number)
//  .namespace(java.lang.String)
//  .type(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
backend java.lang.String The Transit secret backend the resource belongs to.
name java.lang.String Name of the encryption key to create.
allowPlaintextBackup java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.
autoRotatePeriod java.lang.Number Amount of seconds the key should live before being automatically rotated.
convergentEncryption java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext.
deletionAllowed java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the key is allowed to be deleted.
derived java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if key derivation is to be used.
exportable java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables keys to be exportable.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#id TransitSecretBackendKey#id}.
keySize java.lang.Number The key size in bytes for algorithms that allow variable key sizes.
minDecryptionVersion java.lang.Number Minimum key version to use for decryption.
minEncryptionVersion java.lang.Number Minimum key version to use for encryption.
namespace java.lang.String Target namespace. (requires Enterprise).
type java.lang.String Specifies the type of key to create.
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>
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String

The Transit secret backend the resource belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#backend TransitSecretBackendKey#backend}

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

Name of the encryption key to create.

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

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

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#allow_plaintext_backup TransitSecretBackendKey#allow_plaintext_backup}

autoRotatePeriodOptional 
public java.lang.Number getAutoRotatePeriod();
  • Type: java.lang.Number

Amount of seconds the key should live before being automatically rotated.

A value of 0 disables automatic rotation for the key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#auto_rotate_period TransitSecretBackendKey#auto_rotate_period}

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

Whether or not to support convergent encryption, where the same plaintext creates the same ciphertext.

This requires derived to be set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#convergent_encryption TransitSecretBackendKey#convergent_encryption}

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

Specifies if the key is allowed to be deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#deletion_allowed TransitSecretBackendKey#deletion_allowed}

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

Specifies if key derivation is to be used.

If enabled, all encrypt/decrypt requests to this key must provide a context which is used for key derivation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#derived TransitSecretBackendKey#derived}

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

Enables keys to be exportable.

This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#exportable TransitSecretBackendKey#exportable}

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/transit_secret_backend_key#id TransitSecretBackendKey#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.

keySizeOptional 
public java.lang.Number getKeySize();
  • Type: java.lang.Number

The key size in bytes for algorithms that allow variable key sizes.

Currently only applicable to HMAC; this value must be between 32 and 512.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#key_size TransitSecretBackendKey#key_size}

minDecryptionVersionOptional 
public java.lang.Number getMinDecryptionVersion();
  • Type: java.lang.Number

Minimum key version to use for decryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#min_decryption_version TransitSecretBackendKey#min_decryption_version}

minEncryptionVersionOptional 
public java.lang.Number getMinEncryptionVersion();
  • Type: java.lang.Number

Minimum key version to use for encryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/transit_secret_backend_key#min_encryption_version TransitSecretBackendKey#min_encryption_version}

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/transit_secret_backend_key#namespace TransitSecretBackendKey#namespace}

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

Specifies the type of key to create.

The currently-supported types are: aes128-gcm96, aes256-gcm96, chacha20-poly1305, ed25519, ecdsa-p256, ecdsa-p384, ecdsa-p521, hmac, rsa-2048, rsa-3072, rsa-4096

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