dataVaultAwsAccessCredentials.typescript.md

dataVaultAwsAccessCredentials Submodule

Constructs

DataVaultAwsAccessCredentials

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials vault_aws_access_credentials}.

Initializers

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

new dataVaultAwsAccessCredentials.DataVaultAwsAccessCredentials(scope: Construct, id: string, config: DataVaultAwsAccessCredentialsConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataVaultAwsAccessCredentialsConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataVaultAwsAccessCredentialsConfig

---

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	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.
resetId	No description.
resetNamespace	No description.
resetRegion	No description.
resetRoleArn	No description.
resetTtl	No description.
resetType	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetId

public resetId(): void

resetNamespace

public resetNamespace(): void

resetRegion

public resetRegion(): void

resetRoleArn

public resetRoleArn(): void

resetTtl

public resetTtl(): void

resetType

public resetType(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformDataSource	No description.
generateConfigForImport	Generates CDKTF code for importing a DataVaultAwsAccessCredentials resource upon running "cdktf plan ".

---

isConstruct

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

dataVaultAwsAccessCredentials.DataVaultAwsAccessCredentials.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

dataVaultAwsAccessCredentials.DataVaultAwsAccessCredentials.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataVaultAwsAccessCredentials.DataVaultAwsAccessCredentials.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataVaultAwsAccessCredentials.DataVaultAwsAccessCredentials.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DataVaultAwsAccessCredentials that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataVaultAwsAccessCredentials 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.
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.
accessKey	string	No description.
leaseDuration	number	No description.
leaseId	string	No description.
leaseRenewable	cdktf.IResolvable	No description.
leaseStartTime	string	No description.
secretKey	string	No description.
securityToken	string	No description.
backendInput	string	No description.
idInput	string	No description.
namespaceInput	string	No description.
regionInput	string	No description.
roleArnInput	string	No description.
roleInput	string	No description.
ttlInput	string	No description.
typeInput	string	No description.
backend	string	No description.
id	string	No description.
namespace	string	No description.
region	string	No description.
role	string	No description.
roleArn	string	No description.
ttl	string	No description.
type	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

accessKey^Required

public readonly accessKey: string;

• Type: string

---

leaseDuration^Required

public readonly leaseDuration: number;

• Type: number

---

leaseId^Required

public readonly leaseId: string;

• Type: string

---

leaseRenewable^Required

public readonly leaseRenewable: IResolvable;

• Type: cdktf.IResolvable

---

leaseStartTime^Required

public readonly leaseStartTime: string;

• Type: string

---

secretKey^Required

public readonly secretKey: string;

• Type: string

---

securityToken^Required

public readonly securityToken: string;

• Type: string

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

roleArnInput^Optional

public readonly roleArnInput: string;

• Type: string

---

roleInput^Optional

public readonly roleInput: string;

• Type: string

---

ttlInput^Optional

public readonly ttlInput: string;

• Type: string

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

backend^Required

public readonly backend: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

role^Required

public readonly role: string;

• Type: string

---

roleArn^Required

public readonly roleArn: string;

• Type: string

---

ttl^Required

public readonly ttl: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataVaultAwsAccessCredentialsConfig

Initializer

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

const dataVaultAwsAccessCredentialsConfig: dataVaultAwsAccessCredentials.DataVaultAwsAccessCredentialsConfig = { ... }

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	AWS Secret Backend to read credentials from.
role	string	AWS Secret Role to read credentials from.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#id DataVaultAwsAccessCredentials#id}.
namespace	string	Target namespace. (requires Enterprise).
region	string	Region the read credentials belong to.
roleArn	string	ARN to use if multiple are available in the role. Required if the role has multiple ARNs.
ttl	string	User specified Time-To-Live for the STS token. Uses the Role defined default_sts_ttl when not specified.
type	string	Type of credentials to read. Must be either 'creds' for Access Key and Secret Key, or 'sts' for STS.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

backend^Required

public readonly backend: string;

• Type: string

AWS Secret Backend to read credentials from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#backend DataVaultAwsAccessCredentials#backend}

---

role^Required

public readonly role: string;

• Type: string

AWS Secret Role to read credentials from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#role DataVaultAwsAccessCredentials#role}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#id DataVaultAwsAccessCredentials#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.

---

namespace^Optional

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/data-sources/aws_access_credentials#namespace DataVaultAwsAccessCredentials#namespace}

---

region^Optional

public readonly region: string;

• Type: string

Region the read credentials belong to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#region DataVaultAwsAccessCredentials#region}

---

roleArn^Optional

public readonly roleArn: string;

• Type: string

ARN to use if multiple are available in the role. Required if the role has multiple ARNs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#role_arn DataVaultAwsAccessCredentials#role_arn}

---

ttl^Optional

public readonly ttl: string;

• Type: string

User specified Time-To-Live for the STS token. Uses the Role defined default_sts_ttl when not specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#ttl DataVaultAwsAccessCredentials#ttl}

---

type^Optional

public readonly type: string;

• Type: string

Type of credentials to read. Must be either 'creds' for Access Key and Secret Key, or 'sts' for STS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/data-sources/aws_access_credentials#type DataVaultAwsAccessCredentials#type}

---