Skip to content

Latest commit

 

History

History
2499 lines (1572 loc) · 119 KB

awsAuthBackendRole.java.md

File metadata and controls

2499 lines (1572 loc) · 119 KB

awsAuthBackendRole Submodule

Constructs

AwsAuthBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role vault_aws_auth_backend_role}.

Initializers

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_role.AwsAuthBackendRole;

AwsAuthBackendRole.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>)
    .role(java.lang.String)
//  .allowInstanceMigration(java.lang.Boolean)
//  .allowInstanceMigration(IResolvable)
//  .authType(java.lang.String)
//  .backend(java.lang.String)
//  .boundAccountIds(java.util.List<java.lang.String>)
//  .boundAmiIds(java.util.List<java.lang.String>)
//  .boundEc2InstanceIds(java.util.List<java.lang.String>)
//  .boundIamInstanceProfileArns(java.util.List<java.lang.String>)
//  .boundIamPrincipalArns(java.util.List<java.lang.String>)
//  .boundIamRoleArns(java.util.List<java.lang.String>)
//  .boundRegions(java.util.List<java.lang.String>)
//  .boundSubnetIds(java.util.List<java.lang.String>)
//  .boundVpcIds(java.util.List<java.lang.String>)
//  .disallowReauthentication(java.lang.Boolean)
//  .disallowReauthentication(IResolvable)
//  .id(java.lang.String)
//  .inferredAwsRegion(java.lang.String)
//  .inferredEntityType(java.lang.String)
//  .namespace(java.lang.String)
//  .resolveAwsUniqueIds(java.lang.Boolean)
//  .resolveAwsUniqueIds(IResolvable)
//  .roleTag(java.lang.String)
//  .tokenBoundCidrs(java.util.List<java.lang.String>)
//  .tokenExplicitMaxTtl(java.lang.Number)
//  .tokenMaxTtl(java.lang.Number)
//  .tokenNoDefaultPolicy(java.lang.Boolean)
//  .tokenNoDefaultPolicy(IResolvable)
//  .tokenNumUses(java.lang.Number)
//  .tokenPeriod(java.lang.Number)
//  .tokenPolicies(java.util.List<java.lang.String>)
//  .tokenTtl(java.lang.Number)
//  .tokenType(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.
role java.lang.String Name of the role.
allowInstanceMigration java.lang.Boolean OR com.hashicorp.cdktf.IResolvable When true, allows migration of the underlying instance where the client resides. Use with caution.
authType java.lang.String The auth type permitted for this role.
backend java.lang.String Unique name of the auth backend to configure.
boundAccountIds java.util.List<java.lang.String> Only EC2 instances with this account ID in their identity document will be permitted to log in.
boundAmiIds java.util.List<java.lang.String> Only EC2 instances using this AMI ID will be permitted to log in.
boundEc2InstanceIds java.util.List<java.lang.String> Only EC2 instances that match this instance ID will be permitted to log in.
boundIamInstanceProfileArns java.util.List<java.lang.String> Only EC2 instances associated with an IAM instance profile ARN that matches this value will be permitted to log in.
boundIamPrincipalArns java.util.List<java.lang.String> The IAM principal that must be authenticated using the iam auth method.
boundIamRoleArns java.util.List<java.lang.String> Only EC2 instances that match this IAM role ARN will be permitted to log in.
boundRegions java.util.List<java.lang.String> Only EC2 instances in this region will be permitted to log in.
boundSubnetIds java.util.List<java.lang.String> Only EC2 instances associated with this subnet ID will be permitted to log in.
boundVpcIds java.util.List<java.lang.String> Only EC2 instances associated with this VPC ID will be permitted to log in.
disallowReauthentication java.lang.Boolean OR com.hashicorp.cdktf.IResolvable When true, only allows a single token to be granted per instance ID.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#id AwsAuthBackendRole#id}.
inferredAwsRegion java.lang.String The region to search for the inferred entities in.
inferredEntityType java.lang.String The type of inferencing Vault should do.
namespace java.lang.String Target namespace. (requires Enterprise).
resolveAwsUniqueIds java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not Vault should resolve the bound_iam_principal_arn to an AWS Unique ID.
roleTag java.lang.String The key of the tag on EC2 instance to use for role tags.
tokenBoundCidrs java.util.List<java.lang.String> Specifies the blocks of IP addresses which are allowed to use the generated token.
tokenExplicitMaxTtl java.lang.Number Generated Token's Explicit Maximum TTL in seconds.
tokenMaxTtl java.lang.Number The maximum lifetime of the generated token.
tokenNoDefaultPolicy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, the 'default' policy will not automatically be added to generated tokens.
tokenNumUses java.lang.Number The maximum number of times a token may be used, a value of zero means unlimited.
tokenPeriod java.lang.Number Generated Token's Period.
tokenPolicies java.util.List<java.lang.String> Generated Token's Policies.
tokenTtl java.lang.Number The initial ttl of the token to generate in seconds.
tokenType java.lang.String The type of token to generate, service or batch.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


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

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

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

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

roleRequired
  • Type: java.lang.String

Name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#role AwsAuthBackendRole#role}


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

When true, allows migration of the underlying instance where the client resides. Use with caution.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#allow_instance_migration AwsAuthBackendRole#allow_instance_migration}


authTypeOptional
  • Type: java.lang.String

The auth type permitted for this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#auth_type AwsAuthBackendRole#auth_type}


backendOptional
  • 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.5.0/docs/resources/aws_auth_backend_role#backend AwsAuthBackendRole#backend}


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

Only EC2 instances with this account ID in their identity document will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_account_ids AwsAuthBackendRole#bound_account_ids}


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

Only EC2 instances using this AMI ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_ami_ids AwsAuthBackendRole#bound_ami_ids}


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

Only EC2 instances that match this instance ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_ec2_instance_ids AwsAuthBackendRole#bound_ec2_instance_ids}


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

Only EC2 instances associated with an IAM instance profile ARN that matches this value will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_iam_instance_profile_arns AwsAuthBackendRole#bound_iam_instance_profile_arns}


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

The IAM principal that must be authenticated using the iam auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_iam_principal_arns AwsAuthBackendRole#bound_iam_principal_arns}


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

Only EC2 instances that match this IAM role ARN will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_iam_role_arns AwsAuthBackendRole#bound_iam_role_arns}


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

Only EC2 instances in this region will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_regions AwsAuthBackendRole#bound_regions}


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

Only EC2 instances associated with this subnet ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_subnet_ids AwsAuthBackendRole#bound_subnet_ids}


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

Only EC2 instances associated with this VPC ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_vpc_ids AwsAuthBackendRole#bound_vpc_ids}


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

When true, only allows a single token to be granted per instance ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#disallow_reauthentication AwsAuthBackendRole#disallow_reauthentication}


idOptional
  • Type: java.lang.String

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


inferredAwsRegionOptional
  • Type: java.lang.String

The region to search for the inferred entities in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#inferred_aws_region AwsAuthBackendRole#inferred_aws_region}


inferredEntityTypeOptional
  • Type: java.lang.String

The type of inferencing Vault should do.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#inferred_entity_type AwsAuthBackendRole#inferred_entity_type}


namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#namespace AwsAuthBackendRole#namespace}


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

Whether or not Vault should resolve the bound_iam_principal_arn to an AWS Unique ID.

When true, deleting a principal and recreating it with the same name won't automatically grant the new principal the same roles in Vault that the old principal had.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#resolve_aws_unique_ids AwsAuthBackendRole#resolve_aws_unique_ids}


roleTagOptional
  • Type: java.lang.String

The key of the tag on EC2 instance to use for role tags.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#role_tag AwsAuthBackendRole#role_tag}


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

Specifies the blocks of IP addresses which are allowed to use the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_bound_cidrs AwsAuthBackendRole#token_bound_cidrs}


tokenExplicitMaxTtlOptional
  • Type: java.lang.Number

Generated Token's Explicit Maximum TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_explicit_max_ttl AwsAuthBackendRole#token_explicit_max_ttl}


tokenMaxTtlOptional
  • Type: java.lang.Number

The maximum lifetime of the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_max_ttl AwsAuthBackendRole#token_max_ttl}


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

If true, the 'default' policy will not automatically be added to generated tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_no_default_policy AwsAuthBackendRole#token_no_default_policy}


tokenNumUsesOptional
  • Type: java.lang.Number

The maximum number of times a token may be used, a value of zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_num_uses AwsAuthBackendRole#token_num_uses}


tokenPeriodOptional
  • Type: java.lang.Number

Generated Token's Period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_period AwsAuthBackendRole#token_period}


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

Generated Token's Policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_policies AwsAuthBackendRole#token_policies}


tokenTtlOptional
  • Type: java.lang.Number

The initial ttl of the token to generate in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_ttl AwsAuthBackendRole#token_ttl}


tokenTypeOptional
  • Type: java.lang.String

The type of token to generate, service or batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_type AwsAuthBackendRole#token_type}


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".
resetAllowInstanceMigration No description.
resetAuthType No description.
resetBackend No description.
resetBoundAccountIds No description.
resetBoundAmiIds No description.
resetBoundEc2InstanceIds No description.
resetBoundIamInstanceProfileArns No description.
resetBoundIamPrincipalArns No description.
resetBoundIamRoleArns No description.
resetBoundRegions No description.
resetBoundSubnetIds No description.
resetBoundVpcIds No description.
resetDisallowReauthentication No description.
resetId No description.
resetInferredAwsRegion No description.
resetInferredEntityType No description.
resetNamespace No description.
resetResolveAwsUniqueIds No description.
resetRoleTag No description.
resetTokenBoundCidrs No description.
resetTokenExplicitMaxTtl No description.
resetTokenMaxTtl No description.
resetTokenNoDefaultPolicy No description.
resetTokenNumUses No description.
resetTokenPeriod No description.
resetTokenPolicies No description.
resetTokenTtl No description.
resetTokenType 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)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

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

moveTargetRequired
  • 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)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • 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)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • 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.

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

moveTargetRequired
  • Type: java.lang.String

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


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

idRequired
  • Type: java.lang.String

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


resetAllowInstanceMigration
public void resetAllowInstanceMigration()
resetAuthType
public void resetAuthType()
resetBackend
public void resetBackend()
resetBoundAccountIds
public void resetBoundAccountIds()
resetBoundAmiIds
public void resetBoundAmiIds()
resetBoundEc2InstanceIds
public void resetBoundEc2InstanceIds()
resetBoundIamInstanceProfileArns
public void resetBoundIamInstanceProfileArns()
resetBoundIamPrincipalArns
public void resetBoundIamPrincipalArns()
resetBoundIamRoleArns
public void resetBoundIamRoleArns()
resetBoundRegions
public void resetBoundRegions()
resetBoundSubnetIds
public void resetBoundSubnetIds()
resetBoundVpcIds
public void resetBoundVpcIds()
resetDisallowReauthentication
public void resetDisallowReauthentication()
resetId
public void resetId()
resetInferredAwsRegion
public void resetInferredAwsRegion()
resetInferredEntityType
public void resetInferredEntityType()
resetNamespace
public void resetNamespace()
resetResolveAwsUniqueIds
public void resetResolveAwsUniqueIds()
resetRoleTag
public void resetRoleTag()
resetTokenBoundCidrs
public void resetTokenBoundCidrs()
resetTokenExplicitMaxTtl
public void resetTokenExplicitMaxTtl()
resetTokenMaxTtl
public void resetTokenMaxTtl()
resetTokenNoDefaultPolicy
public void resetTokenNoDefaultPolicy()
resetTokenNumUses
public void resetTokenNumUses()
resetTokenPeriod
public void resetTokenPeriod()
resetTokenPolicies
public void resetTokenPolicies()
resetTokenTtl
public void resetTokenTtl()
resetTokenType
public void resetTokenType()

Static Functions

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

isConstruct
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_role.AwsAuthBackendRole;

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

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_role.AwsAuthBackendRole;

AwsAuthBackendRole.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_role.AwsAuthBackendRole;

AwsAuthBackendRole.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_role.AwsAuthBackendRole;

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

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing AwsAuthBackendRole that should be imported.

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


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the AwsAuthBackendRole 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.
roleId java.lang.String No description.
allowInstanceMigrationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
authTypeInput java.lang.String No description.
backendInput java.lang.String No description.
boundAccountIdsInput java.util.List<java.lang.String> No description.
boundAmiIdsInput java.util.List<java.lang.String> No description.
boundEc2InstanceIdsInput java.util.List<java.lang.String> No description.
boundIamInstanceProfileArnsInput java.util.List<java.lang.String> No description.
boundIamPrincipalArnsInput java.util.List<java.lang.String> No description.
boundIamRoleArnsInput java.util.List<java.lang.String> No description.
boundRegionsInput java.util.List<java.lang.String> No description.
boundSubnetIdsInput java.util.List<java.lang.String> No description.
boundVpcIdsInput java.util.List<java.lang.String> No description.
disallowReauthenticationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
inferredAwsRegionInput java.lang.String No description.
inferredEntityTypeInput java.lang.String No description.
namespaceInput java.lang.String No description.
resolveAwsUniqueIdsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
roleInput java.lang.String No description.
roleTagInput java.lang.String No description.
tokenBoundCidrsInput java.util.List<java.lang.String> No description.
tokenExplicitMaxTtlInput java.lang.Number No description.
tokenMaxTtlInput java.lang.Number No description.
tokenNoDefaultPolicyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tokenNumUsesInput java.lang.Number No description.
tokenPeriodInput java.lang.Number No description.
tokenPoliciesInput java.util.List<java.lang.String> No description.
tokenTtlInput java.lang.Number No description.
tokenTypeInput java.lang.String No description.
allowInstanceMigration java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
authType java.lang.String No description.
backend java.lang.String No description.
boundAccountIds java.util.List<java.lang.String> No description.
boundAmiIds java.util.List<java.lang.String> No description.
boundEc2InstanceIds java.util.List<java.lang.String> No description.
boundIamInstanceProfileArns java.util.List<java.lang.String> No description.
boundIamPrincipalArns java.util.List<java.lang.String> No description.
boundIamRoleArns java.util.List<java.lang.String> No description.
boundRegions java.util.List<java.lang.String> No description.
boundSubnetIds java.util.List<java.lang.String> No description.
boundVpcIds java.util.List<java.lang.String> No description.
disallowReauthentication java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
inferredAwsRegion java.lang.String No description.
inferredEntityType java.lang.String No description.
namespace java.lang.String No description.
resolveAwsUniqueIds java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
role java.lang.String No description.
roleTag java.lang.String No description.
tokenBoundCidrs java.util.List<java.lang.String> No description.
tokenExplicitMaxTtl java.lang.Number No description.
tokenMaxTtl java.lang.Number No description.
tokenNoDefaultPolicy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tokenNumUses java.lang.Number No description.
tokenPeriod java.lang.Number No description.
tokenPolicies java.util.List<java.lang.String> No description.
tokenTtl java.lang.Number No description.
tokenType java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

roleIdRequired
public java.lang.String getRoleId();
  • Type: java.lang.String

allowInstanceMigrationInputOptional
public java.lang.Object getAllowInstanceMigrationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

authTypeInputOptional
public java.lang.String getAuthTypeInput();
  • Type: java.lang.String

backendInputOptional
public java.lang.String getBackendInput();
  • Type: java.lang.String

boundAccountIdsInputOptional
public java.util.List<java.lang.String> getBoundAccountIdsInput();
  • Type: java.util.List<java.lang.String>

boundAmiIdsInputOptional
public java.util.List<java.lang.String> getBoundAmiIdsInput();
  • Type: java.util.List<java.lang.String>

boundEc2InstanceIdsInputOptional
public java.util.List<java.lang.String> getBoundEc2InstanceIdsInput();
  • Type: java.util.List<java.lang.String>

boundIamInstanceProfileArnsInputOptional
public java.util.List<java.lang.String> getBoundIamInstanceProfileArnsInput();
  • Type: java.util.List<java.lang.String>

boundIamPrincipalArnsInputOptional
public java.util.List<java.lang.String> getBoundIamPrincipalArnsInput();
  • Type: java.util.List<java.lang.String>

boundIamRoleArnsInputOptional
public java.util.List<java.lang.String> getBoundIamRoleArnsInput();
  • Type: java.util.List<java.lang.String>

boundRegionsInputOptional
public java.util.List<java.lang.String> getBoundRegionsInput();
  • Type: java.util.List<java.lang.String>

boundSubnetIdsInputOptional
public java.util.List<java.lang.String> getBoundSubnetIdsInput();
  • Type: java.util.List<java.lang.String>

boundVpcIdsInputOptional
public java.util.List<java.lang.String> getBoundVpcIdsInput();
  • Type: java.util.List<java.lang.String>

disallowReauthenticationInputOptional
public java.lang.Object getDisallowReauthenticationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

inferredAwsRegionInputOptional
public java.lang.String getInferredAwsRegionInput();
  • Type: java.lang.String

inferredEntityTypeInputOptional
public java.lang.String getInferredEntityTypeInput();
  • Type: java.lang.String

namespaceInputOptional
public java.lang.String getNamespaceInput();
  • Type: java.lang.String

resolveAwsUniqueIdsInputOptional
public java.lang.Object getResolveAwsUniqueIdsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

roleInputOptional
public java.lang.String getRoleInput();
  • Type: java.lang.String

roleTagInputOptional
public java.lang.String getRoleTagInput();
  • Type: java.lang.String

tokenBoundCidrsInputOptional
public java.util.List<java.lang.String> getTokenBoundCidrsInput();
  • Type: java.util.List<java.lang.String>

tokenExplicitMaxTtlInputOptional
public java.lang.Number getTokenExplicitMaxTtlInput();
  • Type: java.lang.Number

tokenMaxTtlInputOptional
public java.lang.Number getTokenMaxTtlInput();
  • Type: java.lang.Number

tokenNoDefaultPolicyInputOptional
public java.lang.Object getTokenNoDefaultPolicyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

tokenNumUsesInputOptional
public java.lang.Number getTokenNumUsesInput();
  • Type: java.lang.Number

tokenPeriodInputOptional
public java.lang.Number getTokenPeriodInput();
  • Type: java.lang.Number

tokenPoliciesInputOptional
public java.util.List<java.lang.String> getTokenPoliciesInput();
  • Type: java.util.List<java.lang.String>

tokenTtlInputOptional
public java.lang.Number getTokenTtlInput();
  • Type: java.lang.Number

tokenTypeInputOptional
public java.lang.String getTokenTypeInput();
  • Type: java.lang.String

allowInstanceMigrationRequired
public java.lang.Object getAllowInstanceMigration();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

authTypeRequired
public java.lang.String getAuthType();
  • Type: java.lang.String

backendRequired
public java.lang.String getBackend();
  • Type: java.lang.String

boundAccountIdsRequired
public java.util.List<java.lang.String> getBoundAccountIds();
  • Type: java.util.List<java.lang.String>

boundAmiIdsRequired
public java.util.List<java.lang.String> getBoundAmiIds();
  • Type: java.util.List<java.lang.String>

boundEc2InstanceIdsRequired
public java.util.List<java.lang.String> getBoundEc2InstanceIds();
  • Type: java.util.List<java.lang.String>

boundIamInstanceProfileArnsRequired
public java.util.List<java.lang.String> getBoundIamInstanceProfileArns();
  • Type: java.util.List<java.lang.String>

boundIamPrincipalArnsRequired
public java.util.List<java.lang.String> getBoundIamPrincipalArns();
  • Type: java.util.List<java.lang.String>

boundIamRoleArnsRequired
public java.util.List<java.lang.String> getBoundIamRoleArns();
  • Type: java.util.List<java.lang.String>

boundRegionsRequired
public java.util.List<java.lang.String> getBoundRegions();
  • Type: java.util.List<java.lang.String>

boundSubnetIdsRequired
public java.util.List<java.lang.String> getBoundSubnetIds();
  • Type: java.util.List<java.lang.String>

boundVpcIdsRequired
public java.util.List<java.lang.String> getBoundVpcIds();
  • Type: java.util.List<java.lang.String>

disallowReauthenticationRequired
public java.lang.Object getDisallowReauthentication();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

idRequired
public java.lang.String getId();
  • Type: java.lang.String

inferredAwsRegionRequired
public java.lang.String getInferredAwsRegion();
  • Type: java.lang.String

inferredEntityTypeRequired
public java.lang.String getInferredEntityType();
  • Type: java.lang.String

namespaceRequired
public java.lang.String getNamespace();
  • Type: java.lang.String

resolveAwsUniqueIdsRequired
public java.lang.Object getResolveAwsUniqueIds();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

roleRequired
public java.lang.String getRole();
  • Type: java.lang.String

roleTagRequired
public java.lang.String getRoleTag();
  • Type: java.lang.String

tokenBoundCidrsRequired
public java.util.List<java.lang.String> getTokenBoundCidrs();
  • Type: java.util.List<java.lang.String>

tokenExplicitMaxTtlRequired
public java.lang.Number getTokenExplicitMaxTtl();
  • Type: java.lang.Number

tokenMaxTtlRequired
public java.lang.Number getTokenMaxTtl();
  • Type: java.lang.Number

tokenNoDefaultPolicyRequired
public java.lang.Object getTokenNoDefaultPolicy();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

tokenNumUsesRequired
public java.lang.Number getTokenNumUses();
  • Type: java.lang.Number

tokenPeriodRequired
public java.lang.Number getTokenPeriod();
  • Type: java.lang.Number

tokenPoliciesRequired
public java.util.List<java.lang.String> getTokenPolicies();
  • Type: java.util.List<java.lang.String>

tokenTtlRequired
public java.lang.Number getTokenTtl();
  • Type: java.lang.Number

tokenTypeRequired
public java.lang.String getTokenType();
  • Type: java.lang.String

Constants

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

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

AwsAuthBackendRoleConfig

Initializer

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_role.AwsAuthBackendRoleConfig;

AwsAuthBackendRoleConfig.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>)
    .role(java.lang.String)
//  .allowInstanceMigration(java.lang.Boolean)
//  .allowInstanceMigration(IResolvable)
//  .authType(java.lang.String)
//  .backend(java.lang.String)
//  .boundAccountIds(java.util.List<java.lang.String>)
//  .boundAmiIds(java.util.List<java.lang.String>)
//  .boundEc2InstanceIds(java.util.List<java.lang.String>)
//  .boundIamInstanceProfileArns(java.util.List<java.lang.String>)
//  .boundIamPrincipalArns(java.util.List<java.lang.String>)
//  .boundIamRoleArns(java.util.List<java.lang.String>)
//  .boundRegions(java.util.List<java.lang.String>)
//  .boundSubnetIds(java.util.List<java.lang.String>)
//  .boundVpcIds(java.util.List<java.lang.String>)
//  .disallowReauthentication(java.lang.Boolean)
//  .disallowReauthentication(IResolvable)
//  .id(java.lang.String)
//  .inferredAwsRegion(java.lang.String)
//  .inferredEntityType(java.lang.String)
//  .namespace(java.lang.String)
//  .resolveAwsUniqueIds(java.lang.Boolean)
//  .resolveAwsUniqueIds(IResolvable)
//  .roleTag(java.lang.String)
//  .tokenBoundCidrs(java.util.List<java.lang.String>)
//  .tokenExplicitMaxTtl(java.lang.Number)
//  .tokenMaxTtl(java.lang.Number)
//  .tokenNoDefaultPolicy(java.lang.Boolean)
//  .tokenNoDefaultPolicy(IResolvable)
//  .tokenNumUses(java.lang.Number)
//  .tokenPeriod(java.lang.Number)
//  .tokenPolicies(java.util.List<java.lang.String>)
//  .tokenTtl(java.lang.Number)
//  .tokenType(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.
role java.lang.String Name of the role.
allowInstanceMigration java.lang.Boolean OR com.hashicorp.cdktf.IResolvable When true, allows migration of the underlying instance where the client resides. Use with caution.
authType java.lang.String The auth type permitted for this role.
backend java.lang.String Unique name of the auth backend to configure.
boundAccountIds java.util.List<java.lang.String> Only EC2 instances with this account ID in their identity document will be permitted to log in.
boundAmiIds java.util.List<java.lang.String> Only EC2 instances using this AMI ID will be permitted to log in.
boundEc2InstanceIds java.util.List<java.lang.String> Only EC2 instances that match this instance ID will be permitted to log in.
boundIamInstanceProfileArns java.util.List<java.lang.String> Only EC2 instances associated with an IAM instance profile ARN that matches this value will be permitted to log in.
boundIamPrincipalArns java.util.List<java.lang.String> The IAM principal that must be authenticated using the iam auth method.
boundIamRoleArns java.util.List<java.lang.String> Only EC2 instances that match this IAM role ARN will be permitted to log in.
boundRegions java.util.List<java.lang.String> Only EC2 instances in this region will be permitted to log in.
boundSubnetIds java.util.List<java.lang.String> Only EC2 instances associated with this subnet ID will be permitted to log in.
boundVpcIds java.util.List<java.lang.String> Only EC2 instances associated with this VPC ID will be permitted to log in.
disallowReauthentication java.lang.Boolean OR com.hashicorp.cdktf.IResolvable When true, only allows a single token to be granted per instance ID.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#id AwsAuthBackendRole#id}.
inferredAwsRegion java.lang.String The region to search for the inferred entities in.
inferredEntityType java.lang.String The type of inferencing Vault should do.
namespace java.lang.String Target namespace. (requires Enterprise).
resolveAwsUniqueIds java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not Vault should resolve the bound_iam_principal_arn to an AWS Unique ID.
roleTag java.lang.String The key of the tag on EC2 instance to use for role tags.
tokenBoundCidrs java.util.List<java.lang.String> Specifies the blocks of IP addresses which are allowed to use the generated token.
tokenExplicitMaxTtl java.lang.Number Generated Token's Explicit Maximum TTL in seconds.
tokenMaxTtl java.lang.Number The maximum lifetime of the generated token.
tokenNoDefaultPolicy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, the 'default' policy will not automatically be added to generated tokens.
tokenNumUses java.lang.Number The maximum number of times a token may be used, a value of zero means unlimited.
tokenPeriod java.lang.Number Generated Token's Period.
tokenPolicies java.util.List<java.lang.String> Generated Token's Policies.
tokenTtl java.lang.Number The initial ttl of the token to generate in seconds.
tokenType java.lang.String The type of token to generate, service or batch.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

roleRequired
public java.lang.String getRole();
  • Type: java.lang.String

Name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#role AwsAuthBackendRole#role}


allowInstanceMigrationOptional
public java.lang.Object getAllowInstanceMigration();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

When true, allows migration of the underlying instance where the client resides. Use with caution.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#allow_instance_migration AwsAuthBackendRole#allow_instance_migration}


authTypeOptional
public java.lang.String getAuthType();
  • Type: java.lang.String

The auth type permitted for this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#auth_type AwsAuthBackendRole#auth_type}


backendOptional
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.5.0/docs/resources/aws_auth_backend_role#backend AwsAuthBackendRole#backend}


boundAccountIdsOptional
public java.util.List<java.lang.String> getBoundAccountIds();
  • Type: java.util.List<java.lang.String>

Only EC2 instances with this account ID in their identity document will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_account_ids AwsAuthBackendRole#bound_account_ids}


boundAmiIdsOptional
public java.util.List<java.lang.String> getBoundAmiIds();
  • Type: java.util.List<java.lang.String>

Only EC2 instances using this AMI ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_ami_ids AwsAuthBackendRole#bound_ami_ids}


boundEc2InstanceIdsOptional
public java.util.List<java.lang.String> getBoundEc2InstanceIds();
  • Type: java.util.List<java.lang.String>

Only EC2 instances that match this instance ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_ec2_instance_ids AwsAuthBackendRole#bound_ec2_instance_ids}


boundIamInstanceProfileArnsOptional
public java.util.List<java.lang.String> getBoundIamInstanceProfileArns();
  • Type: java.util.List<java.lang.String>

Only EC2 instances associated with an IAM instance profile ARN that matches this value will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_iam_instance_profile_arns AwsAuthBackendRole#bound_iam_instance_profile_arns}


boundIamPrincipalArnsOptional
public java.util.List<java.lang.String> getBoundIamPrincipalArns();
  • Type: java.util.List<java.lang.String>

The IAM principal that must be authenticated using the iam auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_iam_principal_arns AwsAuthBackendRole#bound_iam_principal_arns}


boundIamRoleArnsOptional
public java.util.List<java.lang.String> getBoundIamRoleArns();
  • Type: java.util.List<java.lang.String>

Only EC2 instances that match this IAM role ARN will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_iam_role_arns AwsAuthBackendRole#bound_iam_role_arns}


boundRegionsOptional
public java.util.List<java.lang.String> getBoundRegions();
  • Type: java.util.List<java.lang.String>

Only EC2 instances in this region will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_regions AwsAuthBackendRole#bound_regions}


boundSubnetIdsOptional
public java.util.List<java.lang.String> getBoundSubnetIds();
  • Type: java.util.List<java.lang.String>

Only EC2 instances associated with this subnet ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_subnet_ids AwsAuthBackendRole#bound_subnet_ids}


boundVpcIdsOptional
public java.util.List<java.lang.String> getBoundVpcIds();
  • Type: java.util.List<java.lang.String>

Only EC2 instances associated with this VPC ID will be permitted to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#bound_vpc_ids AwsAuthBackendRole#bound_vpc_ids}


disallowReauthenticationOptional
public java.lang.Object getDisallowReauthentication();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

When true, only allows a single token to be granted per instance ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#disallow_reauthentication AwsAuthBackendRole#disallow_reauthentication}


idOptional
public java.lang.String getId();
  • Type: java.lang.String

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


inferredAwsRegionOptional
public java.lang.String getInferredAwsRegion();
  • Type: java.lang.String

The region to search for the inferred entities in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#inferred_aws_region AwsAuthBackendRole#inferred_aws_region}


inferredEntityTypeOptional
public java.lang.String getInferredEntityType();
  • Type: java.lang.String

The type of inferencing Vault should do.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#inferred_entity_type AwsAuthBackendRole#inferred_entity_type}


namespaceOptional
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.5.0/docs/resources/aws_auth_backend_role#namespace AwsAuthBackendRole#namespace}


resolveAwsUniqueIdsOptional
public java.lang.Object getResolveAwsUniqueIds();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not Vault should resolve the bound_iam_principal_arn to an AWS Unique ID.

When true, deleting a principal and recreating it with the same name won't automatically grant the new principal the same roles in Vault that the old principal had.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#resolve_aws_unique_ids AwsAuthBackendRole#resolve_aws_unique_ids}


roleTagOptional
public java.lang.String getRoleTag();
  • Type: java.lang.String

The key of the tag on EC2 instance to use for role tags.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#role_tag AwsAuthBackendRole#role_tag}


tokenBoundCidrsOptional
public java.util.List<java.lang.String> getTokenBoundCidrs();
  • Type: java.util.List<java.lang.String>

Specifies the blocks of IP addresses which are allowed to use the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_bound_cidrs AwsAuthBackendRole#token_bound_cidrs}


tokenExplicitMaxTtlOptional
public java.lang.Number getTokenExplicitMaxTtl();
  • Type: java.lang.Number

Generated Token's Explicit Maximum TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_explicit_max_ttl AwsAuthBackendRole#token_explicit_max_ttl}


tokenMaxTtlOptional
public java.lang.Number getTokenMaxTtl();
  • Type: java.lang.Number

The maximum lifetime of the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_max_ttl AwsAuthBackendRole#token_max_ttl}


tokenNoDefaultPolicyOptional
public java.lang.Object getTokenNoDefaultPolicy();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

If true, the 'default' policy will not automatically be added to generated tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_no_default_policy AwsAuthBackendRole#token_no_default_policy}


tokenNumUsesOptional
public java.lang.Number getTokenNumUses();
  • Type: java.lang.Number

The maximum number of times a token may be used, a value of zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_num_uses AwsAuthBackendRole#token_num_uses}


tokenPeriodOptional
public java.lang.Number getTokenPeriod();
  • Type: java.lang.Number

Generated Token's Period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_period AwsAuthBackendRole#token_period}


tokenPoliciesOptional
public java.util.List<java.lang.String> getTokenPolicies();
  • Type: java.util.List<java.lang.String>

Generated Token's Policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_policies AwsAuthBackendRole#token_policies}


tokenTtlOptional
public java.lang.Number getTokenTtl();
  • Type: java.lang.Number

The initial ttl of the token to generate in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_ttl AwsAuthBackendRole#token_ttl}


tokenTypeOptional
public java.lang.String getTokenType();
  • Type: java.lang.String

The type of token to generate, service or batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/aws_auth_backend_role#token_type AwsAuthBackendRole#token_type}