Skip to content

Latest commit

 

History

History
1452 lines (902 loc) · 63.8 KB

transitSecretBackendKey.typescript.md

File metadata and controls

1452 lines (902 loc) · 63.8 KB

transitSecretBackendKey Submodule

Constructs

TransitSecretBackendKey

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

Initializers

import { transitSecretBackendKey } from '@cdktf/provider-vault'

new transitSecretBackendKey.TransitSecretBackendKey(scope: Construct, id: string, config: TransitSecretBackendKeyConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config TransitSecretBackendKeyConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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 toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

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: string

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


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


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

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 { transitSecretBackendKey } from '@cdktf/provider-vault'

transitSecretBackendKey.TransitSecretBackendKey.isConstruct(x: any)

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: any

Any object.


isTerraformElement
import { transitSecretBackendKey } from '@cdktf/provider-vault'

transitSecretBackendKey.TransitSecretBackendKey.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { transitSecretBackendKey } from '@cdktf/provider-vault'

transitSecretBackendKey.TransitSecretBackendKey.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { transitSecretBackendKey } from '@cdktf/provider-vault'

transitSecretBackendKey.TransitSecretBackendKey.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing TransitSecretBackendKey that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
keys cdktf.StringMapList No description.
latestVersion number No description.
minAvailableVersion number No description.
supportsDecryption cdktf.IResolvable No description.
supportsDerivation cdktf.IResolvable No description.
supportsEncryption cdktf.IResolvable No description.
supportsSigning cdktf.IResolvable No description.
allowPlaintextBackupInput boolean | cdktf.IResolvable No description.
autoRotatePeriodInput number No description.
backendInput string No description.
convergentEncryptionInput boolean | cdktf.IResolvable No description.
deletionAllowedInput boolean | cdktf.IResolvable No description.
derivedInput boolean | cdktf.IResolvable No description.
exportableInput boolean | cdktf.IResolvable No description.
idInput string No description.
keySizeInput number No description.
minDecryptionVersionInput number No description.
minEncryptionVersionInput number No description.
nameInput string No description.
namespaceInput string No description.
typeInput string No description.
allowPlaintextBackup boolean | cdktf.IResolvable No description.
autoRotatePeriod number No description.
backend string No description.
convergentEncryption boolean | cdktf.IResolvable No description.
deletionAllowed boolean | cdktf.IResolvable No description.
derived boolean | cdktf.IResolvable No description.
exportable boolean | cdktf.IResolvable No description.
id string No description.
keySize number No description.
minDecryptionVersion number No description.
minEncryptionVersion number No description.
name string No description.
namespace string No description.
type string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

keysRequired
public readonly keys: StringMapList;
  • Type: cdktf.StringMapList

latestVersionRequired
public readonly latestVersion: number;
  • Type: number

minAvailableVersionRequired
public readonly minAvailableVersion: number;
  • Type: number

supportsDecryptionRequired
public readonly supportsDecryption: IResolvable;
  • Type: cdktf.IResolvable

supportsDerivationRequired
public readonly supportsDerivation: IResolvable;
  • Type: cdktf.IResolvable

supportsEncryptionRequired
public readonly supportsEncryption: IResolvable;
  • Type: cdktf.IResolvable

supportsSigningRequired
public readonly supportsSigning: IResolvable;
  • Type: cdktf.IResolvable

allowPlaintextBackupInputOptional
public readonly allowPlaintextBackupInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

autoRotatePeriodInputOptional
public readonly autoRotatePeriodInput: number;
  • Type: number

backendInputOptional
public readonly backendInput: string;
  • Type: string

convergentEncryptionInputOptional
public readonly convergentEncryptionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

deletionAllowedInputOptional
public readonly deletionAllowedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

derivedInputOptional
public readonly derivedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

exportableInputOptional
public readonly exportableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

keySizeInputOptional
public readonly keySizeInput: number;
  • Type: number

minDecryptionVersionInputOptional
public readonly minDecryptionVersionInput: number;
  • Type: number

minEncryptionVersionInputOptional
public readonly minEncryptionVersionInput: number;
  • Type: number

nameInputOptional
public readonly nameInput: string;
  • Type: string

namespaceInputOptional
public readonly namespaceInput: string;
  • Type: string

typeInputOptional
public readonly typeInput: string;
  • Type: string

allowPlaintextBackupRequired
public readonly allowPlaintextBackup: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

autoRotatePeriodRequired
public readonly autoRotatePeriod: number;
  • Type: number

backendRequired
public readonly backend: string;
  • Type: string

convergentEncryptionRequired
public readonly convergentEncryption: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

deletionAllowedRequired
public readonly deletionAllowed: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

derivedRequired
public readonly derived: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

exportableRequired
public readonly exportable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

keySizeRequired
public readonly keySize: number;
  • Type: number

minDecryptionVersionRequired
public readonly minDecryptionVersion: number;
  • Type: number

minEncryptionVersionRequired
public readonly minEncryptionVersion: number;
  • Type: number

nameRequired
public readonly name: string;
  • Type: string

namespaceRequired
public readonly namespace: string;
  • Type: string

typeRequired
public readonly type: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

TransitSecretBackendKeyConfig

Initializer

import { transitSecretBackendKey } from '@cdktf/provider-vault'

const transitSecretBackendKeyConfig: transitSecretBackendKey.TransitSecretBackendKeyConfig = { ... }

Properties

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

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

backendRequired
public readonly backend: string;
  • Type: string

The Transit secret backend the resource belongs to.

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


nameRequired
public readonly name: string;
  • Type: string

Name of the encryption key to create.

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


allowPlaintextBackupOptional
public readonly allowPlaintextBackup: boolean | IResolvable;
  • Type: boolean | 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.6.0/docs/resources/transit_secret_backend_key#allow_plaintext_backup TransitSecretBackendKey#allow_plaintext_backup}


autoRotatePeriodOptional
public readonly autoRotatePeriod: number;
  • Type: 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.6.0/docs/resources/transit_secret_backend_key#auto_rotate_period TransitSecretBackendKey#auto_rotate_period}


convergentEncryptionOptional
public readonly convergentEncryption: boolean | IResolvable;
  • Type: boolean | 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.6.0/docs/resources/transit_secret_backend_key#convergent_encryption TransitSecretBackendKey#convergent_encryption}


deletionAllowedOptional
public readonly deletionAllowed: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies if the key is allowed to be deleted.

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


derivedOptional
public readonly derived: boolean | IResolvable;
  • Type: boolean | 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.6.0/docs/resources/transit_secret_backend_key#derived TransitSecretBackendKey#derived}


exportableOptional
public readonly exportable: boolean | IResolvable;
  • Type: boolean | 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.6.0/docs/resources/transit_secret_backend_key#exportable TransitSecretBackendKey#exportable}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.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 readonly keySize: number;
  • Type: 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.6.0/docs/resources/transit_secret_backend_key#key_size TransitSecretBackendKey#key_size}


minDecryptionVersionOptional
public readonly minDecryptionVersion: number;
  • Type: number

Minimum key version to use for decryption.

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


minEncryptionVersionOptional
public readonly minEncryptionVersion: number;
  • Type: number

Minimum key version to use for encryption.

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


namespaceOptional
public readonly namespace: string;
  • Type: string

Target namespace. (requires Enterprise).

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


typeOptional
public readonly type: string;
  • Type: 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.6.0/docs/resources/transit_secret_backend_key#type TransitSecretBackendKey#type}