Skip to content

Latest commit

 

History

History
1908 lines (1197 loc) · 90.1 KB

azureAuthBackendRole.java.md

File metadata and controls

1908 lines (1197 loc) · 90.1 KB
Raw

azureAuthBackendRole Submodule

Constructs

AzureAuthBackendRole

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

Initializers 

import com.hashicorp.cdktf.providers.vault.azure_auth_backend_role.AzureAuthBackendRole;

AzureAuthBackendRole.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)
//  .backend(java.lang.String)
//  .boundGroupIds(java.util.List<java.lang.String>)
//  .boundLocations(java.util.List<java.lang.String>)
//  .boundResourceGroups(java.util.List<java.lang.String>)
//  .boundScaleSets(java.util.List<java.lang.String>)
//  .boundServicePrincipalIds(java.util.List<java.lang.String>)
//  .boundSubscriptionIds(java.util.List<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.
role java.lang.String Name of the role.
backend java.lang.String Unique name of the auth backend to configure.
boundGroupIds java.util.List<java.lang.String> The list of group ids that login is restricted to.
boundLocations java.util.List<java.lang.String> The list of locations that login is restricted to.
boundResourceGroups java.util.List<java.lang.String> The list of resource groups that login is restricted to.
boundScaleSets java.util.List<java.lang.String> The list of scale set names that the login is restricted to.
boundServicePrincipalIds java.util.List<java.lang.String> The list of Service Principal IDs that login is restricted to.
boundSubscriptionIds java.util.List<java.lang.String> The list of subscription IDs that login is restricted to.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#id AzureAuthBackendRole#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>
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/azure_auth_backend_role#role AzureAuthBackendRole#role}

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/azure_auth_backend_role#backend AzureAuthBackendRole#backend}

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

The list of group ids that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_group_ids AzureAuthBackendRole#bound_group_ids}

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

The list of locations that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_locations AzureAuthBackendRole#bound_locations}

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

The list of resource groups that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_resource_groups AzureAuthBackendRole#bound_resource_groups}

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

The list of scale set names that the login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_scale_sets AzureAuthBackendRole#bound_scale_sets}

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

The list of Service Principal IDs that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_service_principal_ids AzureAuthBackendRole#bound_service_principal_ids}

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

The list of subscription IDs that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_subscription_ids AzureAuthBackendRole#bound_subscription_ids}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#id AzureAuthBackendRole#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.5.0/docs/resources/azure_auth_backend_role#namespace AzureAuthBackendRole#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.5.0/docs/resources/azure_auth_backend_role#token_bound_cidrs AzureAuthBackendRole#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/azure_auth_backend_role#token_explicit_max_ttl AzureAuthBackendRole#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/azure_auth_backend_role#token_max_ttl AzureAuthBackendRole#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/azure_auth_backend_role#token_no_default_policy AzureAuthBackendRole#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/azure_auth_backend_role#token_num_uses AzureAuthBackendRole#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/azure_auth_backend_role#token_period AzureAuthBackendRole#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/azure_auth_backend_role#token_policies AzureAuthBackendRole#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/azure_auth_backend_role#token_ttl AzureAuthBackendRole#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/azure_auth_backend_role#token_type AzureAuthBackendRole#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".
resetBackend No description.
resetBoundGroupIds No description.
resetBoundLocations No description.
resetBoundResourceGroups No description.
resetBoundScaleSets No description.
resetBoundServicePrincipalIds No description.
resetBoundSubscriptionIds 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()
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".

resetBackend 
public void resetBackend()
resetBoundGroupIds 
public void resetBoundGroupIds()
resetBoundLocations 
public void resetBoundLocations()
resetBoundResourceGroups 
public void resetBoundResourceGroups()
resetBoundScaleSets 
public void resetBoundScaleSets()
resetBoundServicePrincipalIds 
public void resetBoundServicePrincipalIds()
resetBoundSubscriptionIds 
public void resetBoundSubscriptionIds()
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.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a AzureAuthBackendRole resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.vault.azure_auth_backend_role.AzureAuthBackendRole;

AzureAuthBackendRole.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.azure_auth_backend_role.AzureAuthBackendRole;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing AzureAuthBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_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 AzureAuthBackendRole 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.
backendInput java.lang.String No description.
boundGroupIdsInput java.util.List<java.lang.String> No description.
boundLocationsInput java.util.List<java.lang.String> No description.
boundResourceGroupsInput java.util.List<java.lang.String> No description.
boundScaleSetsInput java.util.List<java.lang.String> No description.
boundServicePrincipalIdsInput java.util.List<java.lang.String> No description.
boundSubscriptionIdsInput java.util.List<java.lang.String> No description.
idInput java.lang.String No description.
namespaceInput java.lang.String No description.
roleInput 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.
boundGroupIds java.util.List<java.lang.String> No description.
boundLocations java.util.List<java.lang.String> No description.
boundResourceGroups java.util.List<java.lang.String> No description.
boundScaleSets java.util.List<java.lang.String> No description.
boundServicePrincipalIds java.util.List<java.lang.String> No description.
boundSubscriptionIds java.util.List<java.lang.String> No description.
id java.lang.String No description.
namespace java.lang.String No description.
role 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>
backendInputOptional 
public java.lang.String getBackendInput();
  • Type: java.lang.String
boundGroupIdsInputOptional 
public java.util.List<java.lang.String> getBoundGroupIdsInput();
  • Type: java.util.List<java.lang.String>
boundLocationsInputOptional 
public java.util.List<java.lang.String> getBoundLocationsInput();
  • Type: java.util.List<java.lang.String>
boundResourceGroupsInputOptional 
public java.util.List<java.lang.String> getBoundResourceGroupsInput();
  • Type: java.util.List<java.lang.String>
boundScaleSetsInputOptional 
public java.util.List<java.lang.String> getBoundScaleSetsInput();
  • Type: java.util.List<java.lang.String>
boundServicePrincipalIdsInputOptional 
public java.util.List<java.lang.String> getBoundServicePrincipalIdsInput();
  • Type: java.util.List<java.lang.String>
boundSubscriptionIdsInputOptional 
public java.util.List<java.lang.String> getBoundSubscriptionIdsInput();
  • Type: java.util.List<java.lang.String>
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
roleInputOptional 
public java.lang.String getRoleInput();
  • 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
boundGroupIdsRequired 
public java.util.List<java.lang.String> getBoundGroupIds();
  • Type: java.util.List<java.lang.String>
boundLocationsRequired 
public java.util.List<java.lang.String> getBoundLocations();
  • Type: java.util.List<java.lang.String>
boundResourceGroupsRequired 
public java.util.List<java.lang.String> getBoundResourceGroups();
  • Type: java.util.List<java.lang.String>
boundScaleSetsRequired 
public java.util.List<java.lang.String> getBoundScaleSets();
  • Type: java.util.List<java.lang.String>
boundServicePrincipalIdsRequired 
public java.util.List<java.lang.String> getBoundServicePrincipalIds();
  • Type: java.util.List<java.lang.String>
boundSubscriptionIdsRequired 
public java.util.List<java.lang.String> getBoundSubscriptionIds();
  • Type: java.util.List<java.lang.String>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
roleRequired 
public java.lang.String getRole();
  • 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

AzureAuthBackendRoleConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.azure_auth_backend_role.AzureAuthBackendRoleConfig;

AzureAuthBackendRoleConfig.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)
//  .backend(java.lang.String)
//  .boundGroupIds(java.util.List<java.lang.String>)
//  .boundLocations(java.util.List<java.lang.String>)
//  .boundResourceGroups(java.util.List<java.lang.String>)
//  .boundScaleSets(java.util.List<java.lang.String>)
//  .boundServicePrincipalIds(java.util.List<java.lang.String>)
//  .boundSubscriptionIds(java.util.List<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.
role java.lang.String Name of the role.
backend java.lang.String Unique name of the auth backend to configure.
boundGroupIds java.util.List<java.lang.String> The list of group ids that login is restricted to.
boundLocations java.util.List<java.lang.String> The list of locations that login is restricted to.
boundResourceGroups java.util.List<java.lang.String> The list of resource groups that login is restricted to.
boundScaleSets java.util.List<java.lang.String> The list of scale set names that the login is restricted to.
boundServicePrincipalIds java.util.List<java.lang.String> The list of Service Principal IDs that login is restricted to.
boundSubscriptionIds java.util.List<java.lang.String> The list of subscription IDs that login is restricted to.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#id AzureAuthBackendRole#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>
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/azure_auth_backend_role#role AzureAuthBackendRole#role}

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/azure_auth_backend_role#backend AzureAuthBackendRole#backend}

boundGroupIdsOptional 
public java.util.List<java.lang.String> getBoundGroupIds();
  • Type: java.util.List<java.lang.String>

The list of group ids that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_group_ids AzureAuthBackendRole#bound_group_ids}

boundLocationsOptional 
public java.util.List<java.lang.String> getBoundLocations();
  • Type: java.util.List<java.lang.String>

The list of locations that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_locations AzureAuthBackendRole#bound_locations}

boundResourceGroupsOptional 
public java.util.List<java.lang.String> getBoundResourceGroups();
  • Type: java.util.List<java.lang.String>

The list of resource groups that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_resource_groups AzureAuthBackendRole#bound_resource_groups}

boundScaleSetsOptional 
public java.util.List<java.lang.String> getBoundScaleSets();
  • Type: java.util.List<java.lang.String>

The list of scale set names that the login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_scale_sets AzureAuthBackendRole#bound_scale_sets}

boundServicePrincipalIdsOptional 
public java.util.List<java.lang.String> getBoundServicePrincipalIds();
  • Type: java.util.List<java.lang.String>

The list of Service Principal IDs that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_service_principal_ids AzureAuthBackendRole#bound_service_principal_ids}

boundSubscriptionIdsOptional 
public java.util.List<java.lang.String> getBoundSubscriptionIds();
  • Type: java.util.List<java.lang.String>

The list of subscription IDs that login is restricted to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/azure_auth_backend_role#bound_subscription_ids AzureAuthBackendRole#bound_subscription_ids}

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/azure_auth_backend_role#id AzureAuthBackendRole#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.5.0/docs/resources/azure_auth_backend_role#namespace AzureAuthBackendRole#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.5.0/docs/resources/azure_auth_backend_role#token_bound_cidrs AzureAuthBackendRole#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/azure_auth_backend_role#token_explicit_max_ttl AzureAuthBackendRole#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/azure_auth_backend_role#token_max_ttl AzureAuthBackendRole#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/azure_auth_backend_role#token_no_default_policy AzureAuthBackendRole#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/azure_auth_backend_role#token_num_uses AzureAuthBackendRole#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/azure_auth_backend_role#token_period AzureAuthBackendRole#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/azure_auth_backend_role#token_policies AzureAuthBackendRole#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/azure_auth_backend_role#token_ttl AzureAuthBackendRole#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/azure_auth_backend_role#token_type AzureAuthBackendRole#token_type}