Skip to content

Latest commit

 

History

History
1528 lines (961 loc) · 74.1 KB

dataVaultGcpAuthBackendRole.java.md

File metadata and controls

1528 lines (961 loc) · 74.1 KB
Raw

dataVaultGcpAuthBackendRole Submodule

Constructs

DataVaultGcpAuthBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_auth_backend_role vault_gcp_auth_backend_role}.

Initializers 

import com.hashicorp.cdktf.providers.vault.data_vault_gcp_auth_backend_role.DataVaultGcpAuthBackendRole;

DataVaultGcpAuthBackendRole.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>)
    .roleName(java.lang.String)
//  .backend(java.lang.String)
//  .id(java.lang.String)
//  .namespace(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.
roleName java.lang.String Name of the role.
backend java.lang.String Unique name of the auth backend to configure.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_auth_backend_role#id DataVaultGcpAuthBackendRole#id}.
namespace java.lang.String Target namespace. (requires Enterprise).
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>
roleNameRequired
  • Type: java.lang.String

Name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_auth_backend_role#role_name DataVaultGcpAuthBackendRole#role_name}

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.2.0/docs/data-sources/gcp_auth_backend_role#backend DataVaultGcpAuthBackendRole#backend}

idOptional
  • Type: java.lang.String

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

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_auth_backend_role#namespace DataVaultGcpAuthBackendRole#namespace}

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.2.0/docs/data-sources/gcp_auth_backend_role#token_bound_cidrs DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_explicit_max_ttl DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_max_ttl DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_no_default_policy DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_num_uses DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_period DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_policies DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_ttl DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_type DataVaultGcpAuthBackendRole#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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
interpolationForAttribute No description.
resetBackend No description.
resetId No description.
resetNamespace 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()

Adds this resource to the terraform JSON output.

toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

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
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
resetBackend 
public void resetBackend()
resetId 
public void resetId()
resetNamespace 
public void resetNamespace()
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.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataVaultGcpAuthBackendRole resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.vault.data_vault_gcp_auth_backend_role.DataVaultGcpAuthBackendRole;

DataVaultGcpAuthBackendRole.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.data_vault_gcp_auth_backend_role.DataVaultGcpAuthBackendRole;

DataVaultGcpAuthBackendRole.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformDataSource 
import com.hashicorp.cdktf.providers.vault.data_vault_gcp_auth_backend_role.DataVaultGcpAuthBackendRole;

DataVaultGcpAuthBackendRole.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.vault.data_vault_gcp_auth_backend_role.DataVaultGcpAuthBackendRole;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing DataVaultGcpAuthBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_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 DataVaultGcpAuthBackendRole 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.
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.
boundInstanceGroups java.util.List<java.lang.String> No description.
boundLabels java.util.List<java.lang.String> No description.
boundProjects java.util.List<java.lang.String> No description.
boundRegions java.util.List<java.lang.String> No description.
boundServiceAccounts java.util.List<java.lang.String> No description.
boundZones java.util.List<java.lang.String> No description.
roleId java.lang.String No description.
type java.lang.String No description.
backendInput java.lang.String No description.
idInput java.lang.String No description.
namespaceInput java.lang.String No description.
roleNameInput 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.
backend java.lang.String No description.
id java.lang.String No description.
namespace java.lang.String No description.
roleName 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
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
boundInstanceGroupsRequired 
public java.util.List<java.lang.String> getBoundInstanceGroups();
  • Type: java.util.List<java.lang.String>
boundLabelsRequired 
public java.util.List<java.lang.String> getBoundLabels();
  • Type: java.util.List<java.lang.String>
boundProjectsRequired 
public java.util.List<java.lang.String> getBoundProjects();
  • Type: java.util.List<java.lang.String>
boundRegionsRequired 
public java.util.List<java.lang.String> getBoundRegions();
  • Type: java.util.List<java.lang.String>
boundServiceAccountsRequired 
public java.util.List<java.lang.String> getBoundServiceAccounts();
  • Type: java.util.List<java.lang.String>
boundZonesRequired 
public java.util.List<java.lang.String> getBoundZones();
  • Type: java.util.List<java.lang.String>
roleIdRequired 
public java.lang.String getRoleId();
  • Type: java.lang.String
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String
backendInputOptional 
public java.lang.String getBackendInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
roleNameInputOptional 
public java.lang.String getRoleNameInput();
  • 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
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
roleNameRequired 
public java.lang.String getRoleName();
  • 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

DataVaultGcpAuthBackendRoleConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.data_vault_gcp_auth_backend_role.DataVaultGcpAuthBackendRoleConfig;

DataVaultGcpAuthBackendRoleConfig.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>)
    .roleName(java.lang.String)
//  .backend(java.lang.String)
//  .id(java.lang.String)
//  .namespace(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.
roleName java.lang.String Name of the role.
backend java.lang.String Unique name of the auth backend to configure.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_auth_backend_role#id DataVaultGcpAuthBackendRole#id}.
namespace java.lang.String Target namespace. (requires Enterprise).
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>
roleNameRequired 
public java.lang.String getRoleName();
  • Type: java.lang.String

Name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/gcp_auth_backend_role#role_name DataVaultGcpAuthBackendRole#role_name}

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.2.0/docs/data-sources/gcp_auth_backend_role#backend DataVaultGcpAuthBackendRole#backend}

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

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

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.2.0/docs/data-sources/gcp_auth_backend_role#namespace DataVaultGcpAuthBackendRole#namespace}

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.2.0/docs/data-sources/gcp_auth_backend_role#token_bound_cidrs DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_explicit_max_ttl DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_max_ttl DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_no_default_policy DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_num_uses DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_period DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_policies DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_ttl DataVaultGcpAuthBackendRole#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.2.0/docs/data-sources/gcp_auth_backend_role#token_type DataVaultGcpAuthBackendRole#token_type}