Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt vault_transit_encrypt}.
import { dataVaultTransitEncrypt } from '@cdktf/provider-vault'
new dataVaultTransitEncrypt.DataVaultTransitEncrypt(scope: Construct, id: string, config: DataVaultTransitEncryptConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
DataVaultTransitEncryptConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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 |
Adds this resource to the terraform JSON output. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
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. |
resetContext |
No description. |
resetId |
No description. |
resetKeyVersion |
No description. |
resetNamespace |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public resetContext(): void
public resetId(): void
public resetKeyVersion(): void
public resetNamespace(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformDataSource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a DataVaultTransitEncrypt resource upon running "cdktf plan ". |
import { dataVaultTransitEncrypt } from '@cdktf/provider-vault'
dataVaultTransitEncrypt.DataVaultTransitEncrypt.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.
- Type: any
Any object.
import { dataVaultTransitEncrypt } from '@cdktf/provider-vault'
dataVaultTransitEncrypt.DataVaultTransitEncrypt.isTerraformElement(x: any)
- Type: any
import { dataVaultTransitEncrypt } from '@cdktf/provider-vault'
dataVaultTransitEncrypt.DataVaultTransitEncrypt.isTerraformDataSource(x: any)
- Type: any
import { dataVaultTransitEncrypt } from '@cdktf/provider-vault'
dataVaultTransitEncrypt.DataVaultTransitEncrypt.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a DataVaultTransitEncrypt resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the DataVaultTransitEncrypt to import.
- Type: string
The id of the existing DataVaultTransitEncrypt that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the DataVaultTransitEncrypt to import is found.
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. |
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. |
ciphertext |
string |
No description. |
backendInput |
string |
No description. |
contextInput |
string |
No description. |
idInput |
string |
No description. |
keyInput |
string |
No description. |
keyVersionInput |
number |
No description. |
namespaceInput |
string |
No description. |
plaintextInput |
string |
No description. |
backend |
string |
No description. |
context |
string |
No description. |
id |
string |
No description. |
key |
string |
No description. |
keyVersion |
number |
No description. |
namespace |
string |
No description. |
plaintext |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly ciphertext: string;
- Type: string
public readonly backendInput: string;
- Type: string
public readonly contextInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly keyInput: string;
- Type: string
public readonly keyVersionInput: number;
- Type: number
public readonly namespaceInput: string;
- Type: string
public readonly plaintextInput: string;
- Type: string
public readonly backend: string;
- Type: string
public readonly context: string;
- Type: string
public readonly id: string;
- Type: string
public readonly key: string;
- Type: string
public readonly keyVersion: number;
- Type: number
public readonly namespace: string;
- Type: string
public readonly plaintext: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { dataVaultTransitEncrypt } from '@cdktf/provider-vault'
const dataVaultTransitEncryptConfig: dataVaultTransitEncrypt.DataVaultTransitEncryptConfig = { ... }
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 key belongs to. |
key |
string |
Name of the encryption key to use. |
plaintext |
string |
Map of strings read from Vault. |
context |
string |
Specifies the context for key derivation. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#id DataVaultTransitEncrypt#id}. |
keyVersion |
number |
The version of the key to use for encryption. |
namespace |
string |
Target namespace. (requires Enterprise). |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly backend: string;
- Type: string
The Transit secret backend the key belongs to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#backend DataVaultTransitEncrypt#backend}
public readonly key: string;
- Type: string
Name of the encryption key to use.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#key DataVaultTransitEncrypt#key}
public readonly plaintext: string;
- Type: string
Map of strings read from Vault.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#plaintext DataVaultTransitEncrypt#plaintext}
public readonly context: string;
- Type: string
Specifies the context for key derivation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#context DataVaultTransitEncrypt#context}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#id DataVaultTransitEncrypt#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.
public readonly keyVersion: number;
- Type: number
The version of the key to use for encryption.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#key_version DataVaultTransitEncrypt#key_version}
public readonly namespace: string;
- Type: string
Target namespace. (requires Enterprise).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transit_encrypt#namespace DataVaultTransitEncrypt#namespace}