`awsSecretBackend` Submodule

Constructs

AwsSecretBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend vault_aws_secret_backend}.

Initializers

import com.hashicorp.cdktf.providers.vault.aws_secret_backend.AwsSecretBackend;

AwsSecretBackend.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>)
//  .accessKey(java.lang.String)
//  .defaultLeaseTtlSeconds(java.lang.Number)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .iamEndpoint(java.lang.String)
//  .id(java.lang.String)
//  .identityTokenAudience(java.lang.String)
//  .identityTokenKey(java.lang.String)
//  .identityTokenTtl(java.lang.Number)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .namespace(java.lang.String)
//  .path(java.lang.String)
//  .region(java.lang.String)
//  .roleArn(java.lang.String)
//  .secretKey(java.lang.String)
//  .stsEndpoint(java.lang.String)
//  .usernameTemplate(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.
`accessKey`	`java.lang.String`	The AWS Access Key ID to use when generating new credentials.
`defaultLeaseTtlSeconds`	`java.lang.Number`	Default lease duration for secrets in seconds.
`description`	`java.lang.String`	Human-friendly description of the mount for the backend.
`disableRemount`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	If set, opts out of mount migration on path updates.
`iamEndpoint`	`java.lang.String`	Specifies a custom HTTP IAM endpoint to use.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#id AwsSecretBackend#id}.
`identityTokenAudience`	`java.lang.String`	The audience claim value.
`identityTokenKey`	`java.lang.String`	The key to use for signing identity tokens.
`identityTokenTtl`	`java.lang.Number`	The TTL of generated identity tokens in seconds.
`local`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Specifies if the secret backend is local only.
`maxLeaseTtlSeconds`	`java.lang.Number`	Maximum possible lease duration for secrets in seconds.
`namespace`	`java.lang.String`	Target namespace. (requires Enterprise).
`path`	`java.lang.String`	Path to mount the backend at.
`region`	`java.lang.String`	The AWS region to make API calls against. Defaults to us-east-1.
`roleArn`	`java.lang.String`	Role ARN to assume for plugin identity token federation.
`secretKey`	`java.lang.String`	The AWS Secret Access Key to use when generating new credentials.
`stsEndpoint`	`java.lang.String`	Specifies a custom HTTP STS endpoint to use.
`usernameTemplate`	`java.lang.String`	Template describing how dynamic usernames are generated.

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

`forEach`^Optional

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

`accessKey`^Optional

Type: java.lang.String

The AWS Access Key ID to use when generating new credentials.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#access_key AwsSecretBackend#access_key}

`defaultLeaseTtlSeconds`^Optional

Type: java.lang.Number

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#default_lease_ttl_seconds AwsSecretBackend#default_lease_ttl_seconds}

`description`^Optional

Type: java.lang.String

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#description AwsSecretBackend#description}

`disableRemount`^Optional

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

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#disable_remount AwsSecretBackend#disable_remount}

`iamEndpoint`^Optional

Type: java.lang.String

Specifies a custom HTTP IAM endpoint to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#iam_endpoint AwsSecretBackend#iam_endpoint}

`id`^Optional

Type: java.lang.String

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

`identityTokenAudience`^Optional

Type: java.lang.String

The audience claim value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#identity_token_audience AwsSecretBackend#identity_token_audience}

`identityTokenKey`^Optional

Type: java.lang.String

The key to use for signing identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#identity_token_key AwsSecretBackend#identity_token_key}

`identityTokenTtl`^Optional

Type: java.lang.Number

The TTL of generated identity tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#identity_token_ttl AwsSecretBackend#identity_token_ttl}

`local`^Optional

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

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#local AwsSecretBackend#local}

`maxLeaseTtlSeconds`^Optional

Type: java.lang.Number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#max_lease_ttl_seconds AwsSecretBackend#max_lease_ttl_seconds}

`namespace`^Optional

Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#namespace AwsSecretBackend#namespace}

`path`^Optional

Type: java.lang.String

Path to mount the backend at.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#path AwsSecretBackend#path}

`region`^Optional

Type: java.lang.String

The AWS region to make API calls against. Defaults to us-east-1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#region AwsSecretBackend#region}

`roleArn`^Optional

Type: java.lang.String

Role ARN to assume for plugin identity token federation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#role_arn AwsSecretBackend#role_arn}

`secretKey`^Optional

Type: java.lang.String

The AWS Secret Access Key to use when generating new credentials.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#secret_key AwsSecretBackend#secret_key}

`stsEndpoint`^Optional

Type: java.lang.String

Specifies a custom HTTP STS endpoint to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#sts_endpoint AwsSecretBackend#sts_endpoint}

`usernameTemplate`^Optional

Type: java.lang.String

Template describing how dynamic usernames are generated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#username_template AwsSecretBackend#username_template}

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".
`resetAccessKey`	No description.
`resetDefaultLeaseTtlSeconds`	No description.
`resetDescription`	No description.
`resetDisableRemount`	No description.
`resetIamEndpoint`	No description.
`resetId`	No description.
`resetIdentityTokenAudience`	No description.
`resetIdentityTokenKey`	No description.
`resetIdentityTokenTtl`	No description.
`resetLocal`	No description.
`resetMaxLeaseTtlSeconds`	No description.
`resetNamespace`	No description.
`resetPath`	No description.
`resetRegion`	No description.
`resetRoleArn`	No description.
`resetSecretKey`	No description.
`resetStsEndpoint`	No description.
`resetUsernameTemplate`	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)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

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.

`moveTarget`^Required

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)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

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)

`id`^Required

Type: java.lang.String

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

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.

`id`^Required

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.

`moveTarget`^Required

Type: java.lang.String

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

`index`^Optional

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

`id`^Required

Type: java.lang.String

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

`resetAccessKey`

public void resetAccessKey()

`resetDefaultLeaseTtlSeconds`

public void resetDefaultLeaseTtlSeconds()

`resetDescription`

public void resetDescription()

`resetDisableRemount`

public void resetDisableRemount()

`resetIamEndpoint`

public void resetIamEndpoint()

`resetId`

public void resetId()

`resetIdentityTokenAudience`

public void resetIdentityTokenAudience()

`resetIdentityTokenKey`

public void resetIdentityTokenKey()

`resetIdentityTokenTtl`

public void resetIdentityTokenTtl()

`resetLocal`

public void resetLocal()

`resetMaxLeaseTtlSeconds`

public void resetMaxLeaseTtlSeconds()

`resetNamespace`

public void resetNamespace()

`resetPath`

public void resetPath()

`resetRegion`

public void resetRegion()

`resetRoleArn`

public void resetRoleArn()

`resetSecretKey`

public void resetSecretKey()

`resetStsEndpoint`

public void resetStsEndpoint()

`resetUsernameTemplate`

public void resetUsernameTemplate()

Static Functions

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

`isConstruct`

import com.hashicorp.cdktf.providers.vault.aws_secret_backend.AwsSecretBackend;

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

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import com.hashicorp.cdktf.providers.vault.aws_secret_backend.AwsSecretBackend;

AwsSecretBackend.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformResource`

import com.hashicorp.cdktf.providers.vault.aws_secret_backend.AwsSecretBackend;

AwsSecretBackend.isTerraformResource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import com.hashicorp.cdktf.providers.vault.aws_secret_backend.AwsSecretBackend;

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

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

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

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

`importFromId`^Required

Type: java.lang.String

The id of the existing AwsSecretBackend that should be imported.

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

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the AwsSecretBackend 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.
`accessKeyInput`	`java.lang.String`	No description.
`defaultLeaseTtlSecondsInput`	`java.lang.Number`	No description.
`descriptionInput`	`java.lang.String`	No description.
`disableRemountInput`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`iamEndpointInput`	`java.lang.String`	No description.
`identityTokenAudienceInput`	`java.lang.String`	No description.
`identityTokenKeyInput`	`java.lang.String`	No description.
`identityTokenTtlInput`	`java.lang.Number`	No description.
`idInput`	`java.lang.String`	No description.
`localInput`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`maxLeaseTtlSecondsInput`	`java.lang.Number`	No description.
`namespaceInput`	`java.lang.String`	No description.
`pathInput`	`java.lang.String`	No description.
`regionInput`	`java.lang.String`	No description.
`roleArnInput`	`java.lang.String`	No description.
`secretKeyInput`	`java.lang.String`	No description.
`stsEndpointInput`	`java.lang.String`	No description.
`usernameTemplateInput`	`java.lang.String`	No description.
`accessKey`	`java.lang.String`	No description.
`defaultLeaseTtlSeconds`	`java.lang.Number`	No description.
`description`	`java.lang.String`	No description.
`disableRemount`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`iamEndpoint`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`identityTokenAudience`	`java.lang.String`	No description.
`identityTokenKey`	`java.lang.String`	No description.
`identityTokenTtl`	`java.lang.Number`	No description.
`local`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`maxLeaseTtlSeconds`	`java.lang.Number`	No description.
`namespace`	`java.lang.String`	No description.
`path`	`java.lang.String`	No description.
`region`	`java.lang.String`	No description.
`roleArn`	`java.lang.String`	No description.
`secretKey`	`java.lang.String`	No description.
`stsEndpoint`	`java.lang.String`	No description.
`usernameTemplate`	`java.lang.String`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: com.hashicorp.cdktf.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public java.lang.Object getConnection();

Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

public java.lang.Object getCount();

Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

Type: java.util.List<java.lang.String>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

public java.lang.Object getProvisioners();

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

`accessKeyInput`^Optional

public java.lang.String getAccessKeyInput();

Type: java.lang.String

`defaultLeaseTtlSecondsInput`^Optional

public java.lang.Number getDefaultLeaseTtlSecondsInput();

Type: java.lang.Number

`descriptionInput`^Optional

public java.lang.String getDescriptionInput();

Type: java.lang.String

`disableRemountInput`^Optional

public java.lang.Object getDisableRemountInput();

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

`iamEndpointInput`^Optional

public java.lang.String getIamEndpointInput();

Type: java.lang.String

`identityTokenAudienceInput`^Optional

public java.lang.String getIdentityTokenAudienceInput();

Type: java.lang.String

`identityTokenKeyInput`^Optional

public java.lang.String getIdentityTokenKeyInput();

Type: java.lang.String

`identityTokenTtlInput`^Optional

public java.lang.Number getIdentityTokenTtlInput();

Type: java.lang.Number

`idInput`^Optional

public java.lang.String getIdInput();

Type: java.lang.String

`localInput`^Optional

public java.lang.Object getLocalInput();

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

`maxLeaseTtlSecondsInput`^Optional

public java.lang.Number getMaxLeaseTtlSecondsInput();

Type: java.lang.Number

`namespaceInput`^Optional

public java.lang.String getNamespaceInput();

Type: java.lang.String

`pathInput`^Optional

public java.lang.String getPathInput();

Type: java.lang.String

`regionInput`^Optional

public java.lang.String getRegionInput();

Type: java.lang.String

`roleArnInput`^Optional

public java.lang.String getRoleArnInput();

Type: java.lang.String

`secretKeyInput`^Optional

public java.lang.String getSecretKeyInput();

Type: java.lang.String

`stsEndpointInput`^Optional

public java.lang.String getStsEndpointInput();

Type: java.lang.String

`usernameTemplateInput`^Optional

public java.lang.String getUsernameTemplateInput();

Type: java.lang.String

`accessKey`^Required

public java.lang.String getAccessKey();

Type: java.lang.String

`defaultLeaseTtlSeconds`^Required

public java.lang.Number getDefaultLeaseTtlSeconds();

Type: java.lang.Number

`description`^Required

public java.lang.String getDescription();

Type: java.lang.String

`disableRemount`^Required

public java.lang.Object getDisableRemount();

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

`iamEndpoint`^Required

public java.lang.String getIamEndpoint();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`identityTokenAudience`^Required

public java.lang.String getIdentityTokenAudience();

Type: java.lang.String

`identityTokenKey`^Required

public java.lang.String getIdentityTokenKey();

Type: java.lang.String

`identityTokenTtl`^Required

public java.lang.Number getIdentityTokenTtl();

Type: java.lang.Number

`local`^Required

public java.lang.Object getLocal();

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

`maxLeaseTtlSeconds`^Required

public java.lang.Number getMaxLeaseTtlSeconds();

Type: java.lang.Number

`namespace`^Required

public java.lang.String getNamespace();

Type: java.lang.String

`path`^Required

public java.lang.String getPath();

Type: java.lang.String

`region`^Required

public java.lang.String getRegion();

Type: java.lang.String

`roleArn`^Required

public java.lang.String getRoleArn();

Type: java.lang.String

`secretKey`^Required

public java.lang.String getSecretKey();

Type: java.lang.String

`stsEndpoint`^Required

public java.lang.String getStsEndpoint();

Type: java.lang.String

`usernameTemplate`^Required

public java.lang.String getUsernameTemplate();

Type: java.lang.String

Constants

Name	Type	Description
`tfResourceType`	`java.lang.String`	No description.

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

AwsSecretBackendConfig

Initializer

import com.hashicorp.cdktf.providers.vault.aws_secret_backend.AwsSecretBackendConfig;

AwsSecretBackendConfig.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>)
//  .accessKey(java.lang.String)
//  .defaultLeaseTtlSeconds(java.lang.Number)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .iamEndpoint(java.lang.String)
//  .id(java.lang.String)
//  .identityTokenAudience(java.lang.String)
//  .identityTokenKey(java.lang.String)
//  .identityTokenTtl(java.lang.Number)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .namespace(java.lang.String)
//  .path(java.lang.String)
//  .region(java.lang.String)
//  .roleArn(java.lang.String)
//  .secretKey(java.lang.String)
//  .stsEndpoint(java.lang.String)
//  .usernameTemplate(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.
`accessKey`	`java.lang.String`	The AWS Access Key ID to use when generating new credentials.
`defaultLeaseTtlSeconds`	`java.lang.Number`	Default lease duration for secrets in seconds.
`description`	`java.lang.String`	Human-friendly description of the mount for the backend.
`disableRemount`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	If set, opts out of mount migration on path updates.
`iamEndpoint`	`java.lang.String`	Specifies a custom HTTP IAM endpoint to use.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#id AwsSecretBackend#id}.
`identityTokenAudience`	`java.lang.String`	The audience claim value.
`identityTokenKey`	`java.lang.String`	The key to use for signing identity tokens.
`identityTokenTtl`	`java.lang.Number`	The TTL of generated identity tokens in seconds.
`local`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Specifies if the secret backend is local only.
`maxLeaseTtlSeconds`	`java.lang.Number`	Maximum possible lease duration for secrets in seconds.
`namespace`	`java.lang.String`	Target namespace. (requires Enterprise).
`path`	`java.lang.String`	Path to mount the backend at.
`region`	`java.lang.String`	The AWS region to make API calls against. Defaults to us-east-1.
`roleArn`	`java.lang.String`	Role ARN to assume for plugin identity token federation.
`secretKey`	`java.lang.String`	The AWS Secret Access Key to use when generating new credentials.
`stsEndpoint`	`java.lang.String`	Specifies a custom HTTP STS endpoint to use.
`usernameTemplate`	`java.lang.String`	Template describing how dynamic usernames are generated.

`connection`^Optional

public java.lang.Object getConnection();

Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

public java.lang.Object getCount();

Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

public java.util.List<ITerraformDependable> getDependsOn();

Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

public java.lang.Object getProvisioners();

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

`accessKey`^Optional

public java.lang.String getAccessKey();

Type: java.lang.String

The AWS Access Key ID to use when generating new credentials.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#access_key AwsSecretBackend#access_key}

`defaultLeaseTtlSeconds`^Optional

public java.lang.Number getDefaultLeaseTtlSeconds();

Type: java.lang.Number

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#default_lease_ttl_seconds AwsSecretBackend#default_lease_ttl_seconds}

`description`^Optional

public java.lang.String getDescription();

Type: java.lang.String

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#description AwsSecretBackend#description}

`disableRemount`^Optional

public java.lang.Object getDisableRemount();

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

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#disable_remount AwsSecretBackend#disable_remount}

`iamEndpoint`^Optional

public java.lang.String getIamEndpoint();

Type: java.lang.String

Specifies a custom HTTP IAM endpoint to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#iam_endpoint AwsSecretBackend#iam_endpoint}

`id`^Optional

public java.lang.String getId();

Type: java.lang.String

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

`identityTokenAudience`^Optional

public java.lang.String getIdentityTokenAudience();

Type: java.lang.String

The audience claim value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#identity_token_audience AwsSecretBackend#identity_token_audience}

`identityTokenKey`^Optional

public java.lang.String getIdentityTokenKey();

Type: java.lang.String

The key to use for signing identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#identity_token_key AwsSecretBackend#identity_token_key}

`identityTokenTtl`^Optional

public java.lang.Number getIdentityTokenTtl();

Type: java.lang.Number

The TTL of generated identity tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#identity_token_ttl AwsSecretBackend#identity_token_ttl}

`local`^Optional

public java.lang.Object getLocal();

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

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#local AwsSecretBackend#local}

`maxLeaseTtlSeconds`^Optional

public java.lang.Number getMaxLeaseTtlSeconds();

Type: java.lang.Number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#max_lease_ttl_seconds AwsSecretBackend#max_lease_ttl_seconds}

`namespace`^Optional

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.4.0/docs/resources/aws_secret_backend#namespace AwsSecretBackend#namespace}

`path`^Optional

public java.lang.String getPath();

Type: java.lang.String

Path to mount the backend at.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#path AwsSecretBackend#path}

`region`^Optional

public java.lang.String getRegion();

Type: java.lang.String

The AWS region to make API calls against. Defaults to us-east-1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#region AwsSecretBackend#region}

`roleArn`^Optional

public java.lang.String getRoleArn();

Type: java.lang.String

Role ARN to assume for plugin identity token federation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#role_arn AwsSecretBackend#role_arn}

`secretKey`^Optional

public java.lang.String getSecretKey();

Type: java.lang.String

The AWS Secret Access Key to use when generating new credentials.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#secret_key AwsSecretBackend#secret_key}

`stsEndpoint`^Optional

public java.lang.String getStsEndpoint();

Type: java.lang.String

Specifies a custom HTTP STS endpoint to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#sts_endpoint AwsSecretBackend#sts_endpoint}

`usernameTemplate`^Optional

public java.lang.String getUsernameTemplate();

Type: java.lang.String

Template describing how dynamic usernames are generated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/aws_secret_backend#username_template AwsSecretBackend#username_template}

Files

awsSecretBackend.java.md

Latest commit

History

awsSecretBackend.java.md

File metadata and controls

awsSecretBackend Submodule

Constructs