awsAuthBackendConfigIdentity.typescript.md

awsAuthBackendConfigIdentity Submodule

Constructs

AwsAuthBackendConfigIdentity

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity vault_aws_auth_backend_config_identity}.

Initializers

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

new awsAuthBackendConfigIdentity.AwsAuthBackendConfigIdentity(scope: Construct, id: string, config?: AwsAuthBackendConfigIdentityConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	AwsAuthBackendConfigIdentityConfig	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^Optional

• Type: AwsAuthBackendConfigIdentityConfig

---

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".
resetBackend	No description.
resetEc2Alias	No description.
resetEc2Metadata	No description.
resetIamAlias	No description.
resetIamMetadata	No description.
resetId	No description.
resetNamespace	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

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.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

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

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• 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.

id^Required

• 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.

moveTarget^Required

• Type: string

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

---

index^Optional

• 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".

id^Required

• Type: string

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

---

resetBackend

public resetBackend(): void

resetEc2Alias

public resetEc2Alias(): void

resetEc2Metadata

public resetEc2Metadata(): void

resetIamAlias

public resetIamAlias(): void

resetIamMetadata

public resetIamMetadata(): void

resetId

public resetId(): void

resetNamespace

public resetNamespace(): 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 AwsAuthBackendConfigIdentity resource upon running "cdktf plan ".

---

isConstruct

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

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

awsAuthBackendConfigIdentity.AwsAuthBackendConfigIdentity.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

awsAuthBackendConfigIdentity.AwsAuthBackendConfigIdentity.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

awsAuthBackendConfigIdentity.AwsAuthBackendConfigIdentity.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing AwsAuthBackendConfigIdentity that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#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 AwsAuthBackendConfigIdentity 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.
backendInput	string	No description.
ec2AliasInput	string	No description.
ec2MetadataInput	string[]	No description.
iamAliasInput	string	No description.
iamMetadataInput	string[]	No description.
idInput	string	No description.
namespaceInput	string	No description.
backend	string	No description.
ec2Alias	string	No description.
ec2Metadata	string[]	No description.
iamAlias	string	No description.
iamMetadata	string[]	No description.
id	string	No description.
namespace	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

---

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

---

provisioners^Optional

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

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

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

ec2AliasInput^Optional

public readonly ec2AliasInput: string;

• Type: string

---

ec2MetadataInput^Optional

public readonly ec2MetadataInput: string[];

• Type: string[]

---

iamAliasInput^Optional

public readonly iamAliasInput: string;

• Type: string

---

iamMetadataInput^Optional

public readonly iamMetadataInput: string[];

• Type: string[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

backend^Required

public readonly backend: string;

• Type: string

---

ec2Alias^Required

public readonly ec2Alias: string;

• Type: string

---

ec2Metadata^Required

public readonly ec2Metadata: string[];

• Type: string[]

---

iamAlias^Required

public readonly iamAlias: string;

• Type: string

---

iamMetadata^Required

public readonly iamMetadata: string[];

• Type: string[]

---

id^Required

public readonly id: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

AwsAuthBackendConfigIdentityConfig

Initializer

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

const awsAuthBackendConfigIdentityConfig: awsAuthBackendConfigIdentity.AwsAuthBackendConfigIdentityConfig = { ... }

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	Unique name of the auth backend to configure.
ec2Alias	string	Configures how to generate the identity alias when using the ec2 auth method.
ec2Metadata	string[]	The metadata to include on the token returned by the login endpoint.
iamAlias	string	How to generate the identity alias when using the iam auth method.
iamMetadata	string[]	The metadata to include on the token returned by the login endpoint.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#id AwsAuthBackendConfigIdentity#id}.
namespace	string	Target namespace. (requires Enterprise).

---

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^Optional

public readonly backend: string;

• Type: string

Unique name of the auth backend to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#backend AwsAuthBackendConfigIdentity#backend}

---

ec2Alias^Optional

public readonly ec2Alias: string;

• Type: string

Configures how to generate the identity alias when using the ec2 auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#ec2_alias AwsAuthBackendConfigIdentity#ec2_alias}

---

ec2Metadata^Optional

public readonly ec2Metadata: string[];

• Type: string[]

The metadata to include on the token returned by the login endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#ec2_metadata AwsAuthBackendConfigIdentity#ec2_metadata}

---

iamAlias^Optional

public readonly iamAlias: string;

• Type: string

How to generate the identity alias when using the iam auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#iam_alias AwsAuthBackendConfigIdentity#iam_alias}

---

iamMetadata^Optional

public readonly iamMetadata: string[];

• Type: string[]

The metadata to include on the token returned by the login endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#iam_metadata AwsAuthBackendConfigIdentity#iam_metadata}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_config_identity#id AwsAuthBackendConfigIdentity#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.2.0/docs/resources/aws_auth_backend_config_identity#namespace AwsAuthBackendConfigIdentity#namespace}

---