Skip to content

Latest commit

 

History

History
1687 lines (1058 loc) · 78.2 KB

awsAuthBackendClient.java.md

File metadata and controls

1687 lines (1058 loc) · 78.2 KB

awsAuthBackendClient Submodule

Constructs

AwsAuthBackendClient

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client vault_aws_auth_backend_client}.

Initializers 

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_client.AwsAuthBackendClient;

AwsAuthBackendClient.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)
//  .backend(java.lang.String)
//  .ec2Endpoint(java.lang.String)
//  .iamEndpoint(java.lang.String)
//  .iamServerIdHeaderValue(java.lang.String)
//  .id(java.lang.String)
//  .identityTokenAudience(java.lang.String)
//  .identityTokenTtl(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .namespace(java.lang.String)
//  .roleArn(java.lang.String)
//  .secretKey(java.lang.String)
//  .stsEndpoint(java.lang.String)
//  .stsRegion(java.lang.String)
//  .useStsRegionFromClient(java.lang.Boolean)
//  .useStsRegionFromClient(IResolvable)
    .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 AWS Access key with permissions to query AWS APIs.
backend java.lang.String Unique name of the auth backend to configure.
ec2Endpoint java.lang.String URL to override the default generated endpoint for making AWS EC2 API calls.
iamEndpoint java.lang.String URL to override the default generated endpoint for making AWS IAM API calls.
iamServerIdHeaderValue java.lang.String The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the iam auth method.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#id AwsAuthBackendClient#id}.
identityTokenAudience java.lang.String The audience claim value.
identityTokenTtl java.lang.Number The TTL of generated identity tokens in seconds.
maxRetries java.lang.Number Number of max retries the client should use for recoverable errors.
namespace java.lang.String Target namespace. (requires Enterprise).
roleArn java.lang.String Role ARN to assume for plugin identity token federation.
secretKey java.lang.String AWS Secret key with permissions to query AWS APIs.
stsEndpoint java.lang.String URL to override the default generated endpoint for making AWS STS API calls.
stsRegion java.lang.String Region to override the default region for making AWS STS API calls.
useStsRegionFromClient java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, will override sts_region and use the region from the client request's header.
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>
accessKeyOptional
  • Type: java.lang.String

AWS Access key with permissions to query AWS APIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#access_key AwsAuthBackendClient#access_key}

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.6.0/docs/resources/aws_auth_backend_client#backend AwsAuthBackendClient#backend}

ec2EndpointOptional
  • Type: java.lang.String

URL to override the default generated endpoint for making AWS EC2 API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#ec2_endpoint AwsAuthBackendClient#ec2_endpoint}

iamEndpointOptional
  • Type: java.lang.String

URL to override the default generated endpoint for making AWS IAM API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#iam_endpoint AwsAuthBackendClient#iam_endpoint}

iamServerIdHeaderValueOptional
  • Type: java.lang.String

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the iam auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#iam_server_id_header_value AwsAuthBackendClient#iam_server_id_header_value}

idOptional
  • Type: java.lang.String

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

identityTokenAudienceOptional
  • Type: java.lang.String

The audience claim value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#identity_token_audience AwsAuthBackendClient#identity_token_audience}

identityTokenTtlOptional
  • 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.6.0/docs/resources/aws_auth_backend_client#identity_token_ttl AwsAuthBackendClient#identity_token_ttl}

maxRetriesOptional
  • Type: java.lang.Number

Number of max retries the client should use for recoverable errors.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#max_retries AwsAuthBackendClient#max_retries}

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#namespace AwsAuthBackendClient#namespace}

roleArnOptional
  • 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.6.0/docs/resources/aws_auth_backend_client#role_arn AwsAuthBackendClient#role_arn}

secretKeyOptional
  • Type: java.lang.String

AWS Secret key with permissions to query AWS APIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#secret_key AwsAuthBackendClient#secret_key}

stsEndpointOptional
  • Type: java.lang.String

URL to override the default generated endpoint for making AWS STS API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#sts_endpoint AwsAuthBackendClient#sts_endpoint}

stsRegionOptional
  • Type: java.lang.String

Region to override the default region for making AWS STS API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#sts_region AwsAuthBackendClient#sts_region}

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

If set, will override sts_region and use the region from the client request's header.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#use_sts_region_from_client AwsAuthBackendClient#use_sts_region_from_client}

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.
resetBackend No description.
resetEc2Endpoint No description.
resetIamEndpoint No description.
resetIamServerIdHeaderValue No description.
resetId No description.
resetIdentityTokenAudience No description.
resetIdentityTokenTtl No description.
resetMaxRetries No description.
resetNamespace No description.
resetRoleArn No description.
resetSecretKey No description.
resetStsEndpoint No description.
resetStsRegion No description.
resetUseStsRegionFromClient 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".

resetAccessKey 
public void resetAccessKey()
resetBackend 
public void resetBackend()
resetEc2Endpoint 
public void resetEc2Endpoint()
resetIamEndpoint 
public void resetIamEndpoint()
resetIamServerIdHeaderValue 
public void resetIamServerIdHeaderValue()
resetId 
public void resetId()
resetIdentityTokenAudience 
public void resetIdentityTokenAudience()
resetIdentityTokenTtl 
public void resetIdentityTokenTtl()
resetMaxRetries 
public void resetMaxRetries()
resetNamespace 
public void resetNamespace()
resetRoleArn 
public void resetRoleArn()
resetSecretKey 
public void resetSecretKey()
resetStsEndpoint 
public void resetStsEndpoint()
resetStsRegion 
public void resetStsRegion()
resetUseStsRegionFromClient 
public void resetUseStsRegionFromClient()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a AwsAuthBackendClient resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_client.AwsAuthBackendClient;

AwsAuthBackendClient.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_client.AwsAuthBackendClient;

AwsAuthBackendClient.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_client.AwsAuthBackendClient;

AwsAuthBackendClient.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.vault.aws_auth_backend_client.AwsAuthBackendClient;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing AwsAuthBackendClient that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#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 AwsAuthBackendClient 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.
backendInput java.lang.String No description.
ec2EndpointInput java.lang.String No description.
iamEndpointInput java.lang.String No description.
iamServerIdHeaderValueInput java.lang.String No description.
identityTokenAudienceInput java.lang.String No description.
identityTokenTtlInput java.lang.Number No description.
idInput java.lang.String No description.
maxRetriesInput java.lang.Number No description.
namespaceInput java.lang.String No description.
roleArnInput java.lang.String No description.
secretKeyInput java.lang.String No description.
stsEndpointInput java.lang.String No description.
stsRegionInput java.lang.String No description.
useStsRegionFromClientInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
accessKey java.lang.String No description.
backend java.lang.String No description.
ec2Endpoint java.lang.String No description.
iamEndpoint java.lang.String No description.
iamServerIdHeaderValue java.lang.String No description.
id java.lang.String No description.
identityTokenAudience java.lang.String No description.
identityTokenTtl java.lang.Number No description.
maxRetries java.lang.Number No description.
namespace java.lang.String No description.
roleArn java.lang.String No description.
secretKey java.lang.String No description.
stsEndpoint java.lang.String No description.
stsRegion java.lang.String No description.
useStsRegionFromClient java.lang.Boolean OR com.hashicorp.cdktf.IResolvable 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>
accessKeyInputOptional 
public java.lang.String getAccessKeyInput();
  • Type: java.lang.String
backendInputOptional 
public java.lang.String getBackendInput();
  • Type: java.lang.String
ec2EndpointInputOptional 
public java.lang.String getEc2EndpointInput();
  • Type: java.lang.String
iamEndpointInputOptional 
public java.lang.String getIamEndpointInput();
  • Type: java.lang.String
iamServerIdHeaderValueInputOptional 
public java.lang.String getIamServerIdHeaderValueInput();
  • Type: java.lang.String
identityTokenAudienceInputOptional 
public java.lang.String getIdentityTokenAudienceInput();
  • Type: java.lang.String
identityTokenTtlInputOptional 
public java.lang.Number getIdentityTokenTtlInput();
  • Type: java.lang.Number
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
maxRetriesInputOptional 
public java.lang.Number getMaxRetriesInput();
  • Type: java.lang.Number
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
roleArnInputOptional 
public java.lang.String getRoleArnInput();
  • Type: java.lang.String
secretKeyInputOptional 
public java.lang.String getSecretKeyInput();
  • Type: java.lang.String
stsEndpointInputOptional 
public java.lang.String getStsEndpointInput();
  • Type: java.lang.String
stsRegionInputOptional 
public java.lang.String getStsRegionInput();
  • Type: java.lang.String
useStsRegionFromClientInputOptional 
public java.lang.Object getUseStsRegionFromClientInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
accessKeyRequired 
public java.lang.String getAccessKey();
  • Type: java.lang.String
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String
ec2EndpointRequired 
public java.lang.String getEc2Endpoint();
  • Type: java.lang.String
iamEndpointRequired 
public java.lang.String getIamEndpoint();
  • Type: java.lang.String
iamServerIdHeaderValueRequired 
public java.lang.String getIamServerIdHeaderValue();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
identityTokenAudienceRequired 
public java.lang.String getIdentityTokenAudience();
  • Type: java.lang.String
identityTokenTtlRequired 
public java.lang.Number getIdentityTokenTtl();
  • Type: java.lang.Number
maxRetriesRequired 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
roleArnRequired 
public java.lang.String getRoleArn();
  • Type: java.lang.String
secretKeyRequired 
public java.lang.String getSecretKey();
  • Type: java.lang.String
stsEndpointRequired 
public java.lang.String getStsEndpoint();
  • Type: java.lang.String
stsRegionRequired 
public java.lang.String getStsRegion();
  • Type: java.lang.String
useStsRegionFromClientRequired 
public java.lang.Object getUseStsRegionFromClient();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

AwsAuthBackendClientConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.aws_auth_backend_client.AwsAuthBackendClientConfig;

AwsAuthBackendClientConfig.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)
//  .backend(java.lang.String)
//  .ec2Endpoint(java.lang.String)
//  .iamEndpoint(java.lang.String)
//  .iamServerIdHeaderValue(java.lang.String)
//  .id(java.lang.String)
//  .identityTokenAudience(java.lang.String)
//  .identityTokenTtl(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .namespace(java.lang.String)
//  .roleArn(java.lang.String)
//  .secretKey(java.lang.String)
//  .stsEndpoint(java.lang.String)
//  .stsRegion(java.lang.String)
//  .useStsRegionFromClient(java.lang.Boolean)
//  .useStsRegionFromClient(IResolvable)
    .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 AWS Access key with permissions to query AWS APIs.
backend java.lang.String Unique name of the auth backend to configure.
ec2Endpoint java.lang.String URL to override the default generated endpoint for making AWS EC2 API calls.
iamEndpoint java.lang.String URL to override the default generated endpoint for making AWS IAM API calls.
iamServerIdHeaderValue java.lang.String The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the iam auth method.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#id AwsAuthBackendClient#id}.
identityTokenAudience java.lang.String The audience claim value.
identityTokenTtl java.lang.Number The TTL of generated identity tokens in seconds.
maxRetries java.lang.Number Number of max retries the client should use for recoverable errors.
namespace java.lang.String Target namespace. (requires Enterprise).
roleArn java.lang.String Role ARN to assume for plugin identity token federation.
secretKey java.lang.String AWS Secret key with permissions to query AWS APIs.
stsEndpoint java.lang.String URL to override the default generated endpoint for making AWS STS API calls.
stsRegion java.lang.String Region to override the default region for making AWS STS API calls.
useStsRegionFromClient java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, will override sts_region and use the region from the client request's header.
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>
accessKeyOptional 
public java.lang.String getAccessKey();
  • Type: java.lang.String

AWS Access key with permissions to query AWS APIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#access_key AwsAuthBackendClient#access_key}

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.6.0/docs/resources/aws_auth_backend_client#backend AwsAuthBackendClient#backend}

ec2EndpointOptional 
public java.lang.String getEc2Endpoint();
  • Type: java.lang.String

URL to override the default generated endpoint for making AWS EC2 API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#ec2_endpoint AwsAuthBackendClient#ec2_endpoint}

iamEndpointOptional 
public java.lang.String getIamEndpoint();
  • Type: java.lang.String

URL to override the default generated endpoint for making AWS IAM API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#iam_endpoint AwsAuthBackendClient#iam_endpoint}

iamServerIdHeaderValueOptional 
public java.lang.String getIamServerIdHeaderValue();
  • Type: java.lang.String

The value to require in the X-Vault-AWS-IAM-Server-ID header as part of GetCallerIdentity requests that are used in the iam auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#iam_server_id_header_value AwsAuthBackendClient#iam_server_id_header_value}

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

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

identityTokenAudienceOptional 
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.6.0/docs/resources/aws_auth_backend_client#identity_token_audience AwsAuthBackendClient#identity_token_audience}

identityTokenTtlOptional 
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.6.0/docs/resources/aws_auth_backend_client#identity_token_ttl AwsAuthBackendClient#identity_token_ttl}

maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number

Number of max retries the client should use for recoverable errors.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#max_retries AwsAuthBackendClient#max_retries}

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.6.0/docs/resources/aws_auth_backend_client#namespace AwsAuthBackendClient#namespace}

roleArnOptional 
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.6.0/docs/resources/aws_auth_backend_client#role_arn AwsAuthBackendClient#role_arn}

secretKeyOptional 
public java.lang.String getSecretKey();
  • Type: java.lang.String

AWS Secret key with permissions to query AWS APIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#secret_key AwsAuthBackendClient#secret_key}

stsEndpointOptional 
public java.lang.String getStsEndpoint();
  • Type: java.lang.String

URL to override the default generated endpoint for making AWS STS API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#sts_endpoint AwsAuthBackendClient#sts_endpoint}

stsRegionOptional 
public java.lang.String getStsRegion();
  • Type: java.lang.String

Region to override the default region for making AWS STS API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#sts_region AwsAuthBackendClient#sts_region}

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

If set, will override sts_region and use the region from the client request's header.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/aws_auth_backend_client#use_sts_region_from_client AwsAuthBackendClient#use_sts_region_from_client}