`awsAuthBackendStsRole` Submodule

Constructs

AwsAuthBackendStsRole

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

Initializers

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_sts_role.AwsAuthBackendStsRole;

AwsAuthBackendStsRole.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>)
    .accountId(java.lang.String)
    .stsRole(java.lang.String)
//  .backend(java.lang.String)
//  .id(java.lang.String)
//  .namespace(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.
`accountId`	`java.lang.String`	AWS account ID to be associated with STS role.
`stsRole`	`java.lang.String`	AWS ARN for STS role to be assumed when interacting with the account specified.
`backend`	`java.lang.String`	Unique name of the auth backend to configure.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#id AwsAuthBackendStsRole#id}.
`namespace`	`java.lang.String`	Target namespace. (requires Enterprise).

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

`accountId`^Required

Type: java.lang.String

AWS account ID to be associated with STS role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#account_id AwsAuthBackendStsRole#account_id}

`stsRole`^Required

Type: java.lang.String

AWS ARN for STS role to be assumed when interacting with the account specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#sts_role AwsAuthBackendStsRole#sts_role}

`backend`^Optional

Type: java.lang.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_sts_role#backend AwsAuthBackendStsRole#backend}

`id`^Optional

Type: java.lang.String

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

Type: java.lang.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_sts_role#namespace AwsAuthBackendStsRole#namespace}

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.
`resetId`	No description.
`resetNamespace`	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".

`resetBackend`

public void resetBackend()

`resetId`

public void resetId()

`resetNamespace`

public void resetNamespace()

Static Functions

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

`isConstruct`

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_sts_role.AwsAuthBackendStsRole;

AwsAuthBackendStsRole.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_auth_backend_sts_role.AwsAuthBackendStsRole;

AwsAuthBackendStsRole.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformResource`

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_sts_role.AwsAuthBackendStsRole;

AwsAuthBackendStsRole.isTerraformResource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_sts_role.AwsAuthBackendStsRole;

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

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

`importFromId`^Required

Type: java.lang.String

The id of the existing AwsAuthBackendStsRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#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 AwsAuthBackendStsRole 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.
`accountIdInput`	`java.lang.String`	No description.
`backendInput`	`java.lang.String`	No description.
`idInput`	`java.lang.String`	No description.
`namespaceInput`	`java.lang.String`	No description.
`stsRoleInput`	`java.lang.String`	No description.
`accountId`	`java.lang.String`	No description.
`backend`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`namespace`	`java.lang.String`	No description.
`stsRole`	`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>

`accountIdInput`^Optional

public java.lang.String getAccountIdInput();

Type: java.lang.String

`backendInput`^Optional

public java.lang.String getBackendInput();

Type: java.lang.String

`idInput`^Optional

public java.lang.String getIdInput();

Type: java.lang.String

`namespaceInput`^Optional

public java.lang.String getNamespaceInput();

Type: java.lang.String

`stsRoleInput`^Optional

public java.lang.String getStsRoleInput();

Type: java.lang.String

`accountId`^Required

public java.lang.String getAccountId();

Type: java.lang.String

`backend`^Required

public java.lang.String getBackend();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`namespace`^Required

public java.lang.String getNamespace();

Type: java.lang.String

`stsRole`^Required

public java.lang.String getStsRole();

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

AwsAuthBackendStsRoleConfig

Initializer

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_sts_role.AwsAuthBackendStsRoleConfig;

AwsAuthBackendStsRoleConfig.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>)
    .accountId(java.lang.String)
    .stsRole(java.lang.String)
//  .backend(java.lang.String)
//  .id(java.lang.String)
//  .namespace(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.
`accountId`	`java.lang.String`	AWS account ID to be associated with STS role.
`stsRole`	`java.lang.String`	AWS ARN for STS role to be assumed when interacting with the account specified.
`backend`	`java.lang.String`	Unique name of the auth backend to configure.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#id AwsAuthBackendStsRole#id}.
`namespace`	`java.lang.String`	Target namespace. (requires Enterprise).

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

`accountId`^Required

public java.lang.String getAccountId();

Type: java.lang.String

AWS account ID to be associated with STS role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#account_id AwsAuthBackendStsRole#account_id}

`stsRole`^Required

public java.lang.String getStsRole();

Type: java.lang.String

AWS ARN for STS role to be assumed when interacting with the account specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/aws_auth_backend_sts_role#sts_role AwsAuthBackendStsRole#sts_role}

`backend`^Optional

public java.lang.String getBackend();

Type: java.lang.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_sts_role#backend AwsAuthBackendStsRole#backend}

`id`^Optional

public java.lang.String getId();

Type: java.lang.String

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

Files

awsAuthBackendStsRole.java.md

Latest commit

History

awsAuthBackendStsRole.java.md

File metadata and controls

awsAuthBackendStsRole Submodule

Constructs