Skip to content

Latest commit

 

History

History
1623 lines (1017 loc) · 77.3 KB

consulSecretBackendRole.java.md

File metadata and controls

1623 lines (1017 loc) · 77.3 KB
Raw

consulSecretBackendRole Submodule

Constructs

ConsulSecretBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role vault_consul_secret_backend_role}.

Initializers 

import com.hashicorp.cdktf.providers.vault.consul_secret_backend_role.ConsulSecretBackendRole;

ConsulSecretBackendRole.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>)
    .name(java.lang.String)
//  .backend(java.lang.String)
//  .consulNamespace(java.lang.String)
//  .consulPolicies(java.util.List<java.lang.String>)
//  .consulRoles(java.util.List<java.lang.String>)
//  .id(java.lang.String)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxTtl(java.lang.Number)
//  .namespace(java.lang.String)
//  .nodeIdentities(java.util.List<java.lang.String>)
//  .partition(java.lang.String)
//  .policies(java.util.List<java.lang.String>)
//  .serviceIdentities(java.util.List<java.lang.String>)
//  .ttl(java.lang.Number)
    .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.
name java.lang.String The name of an existing role against which to create this Consul credential.
backend java.lang.String The path of the Consul Secret Backend the role belongs to.
consulNamespace java.lang.String The Consul namespace that the token will be created in. Applicable for Vault 1.10+ and Consul 1.7+.
consulPolicies java.util.List<java.lang.String> List of Consul policies to associate with this role.
consulRoles java.util.List<java.lang.String> Set of Consul roles to attach to the token. Applicable for Vault 1.10+ with Consul 1.5+.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#id ConsulSecretBackendRole#id}.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Indicates that the token should not be replicated globally and instead be local to the current datacenter.
maxTtl java.lang.Number Maximum TTL for leases associated with this role, in seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
nodeIdentities java.util.List<java.lang.String> Set of Consul node identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.8+.
partition java.lang.String The Consul admin partition that the token will be created in. Applicable for Vault 1.10+ and Consul 1.11+.
policies java.util.List<java.lang.String> List of Consul policies to associate with this role.
serviceIdentities java.util.List<java.lang.String> Set of Consul service identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.5+.
ttl java.lang.Number Specifies the TTL for this role.
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>
nameRequired
  • Type: java.lang.String

The name of an existing role against which to create this Consul credential.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#name ConsulSecretBackendRole#name}

backendOptional
  • Type: java.lang.String

The path of the Consul Secret Backend the role belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#backend ConsulSecretBackendRole#backend}

consulNamespaceOptional
  • Type: java.lang.String

The Consul namespace that the token will be created in. Applicable for Vault 1.10+ and Consul 1.7+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#consul_namespace ConsulSecretBackendRole#consul_namespace}

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

List of Consul policies to associate with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#consul_policies ConsulSecretBackendRole#consul_policies}

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

Set of Consul roles to attach to the token. Applicable for Vault 1.10+ with Consul 1.5+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#consul_roles ConsulSecretBackendRole#consul_roles}

idOptional
  • Type: java.lang.String

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

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

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#local ConsulSecretBackendRole#local}

maxTtlOptional
  • Type: java.lang.Number

Maximum TTL for leases associated with this role, in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#max_ttl ConsulSecretBackendRole#max_ttl}

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#namespace ConsulSecretBackendRole#namespace}

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

Set of Consul node identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.8+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#node_identities ConsulSecretBackendRole#node_identities}

partitionOptional
  • Type: java.lang.String

The Consul admin partition that the token will be created in. Applicable for Vault 1.10+ and Consul 1.11+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#partition ConsulSecretBackendRole#partition}

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

List of Consul policies to associate with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#policies ConsulSecretBackendRole#policies}

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

Set of Consul service identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.5+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#service_identities ConsulSecretBackendRole#service_identities}

ttlOptional
  • Type: java.lang.Number

Specifies the TTL for this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#ttl ConsulSecretBackendRole#ttl}

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.
resetConsulNamespace No description.
resetConsulPolicies No description.
resetConsulRoles No description.
resetId No description.
resetLocal No description.
resetMaxTtl No description.
resetNamespace No description.
resetNodeIdentities No description.
resetPartition No description.
resetPolicies No description.
resetServiceIdentities No description.
resetTtl 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()
resetConsulNamespace 
public void resetConsulNamespace()
resetConsulPolicies 
public void resetConsulPolicies()
resetConsulRoles 
public void resetConsulRoles()
resetId 
public void resetId()
resetLocal 
public void resetLocal()
resetMaxTtl 
public void resetMaxTtl()
resetNamespace 
public void resetNamespace()
resetNodeIdentities 
public void resetNodeIdentities()
resetPartition 
public void resetPartition()
resetPolicies 
public void resetPolicies()
resetServiceIdentities 
public void resetServiceIdentities()
resetTtl 
public void resetTtl()

Static Functions

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

ConsulSecretBackendRole.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.consul_secret_backend_role.ConsulSecretBackendRole;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing ConsulSecretBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_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 ConsulSecretBackendRole 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.
consulNamespaceInput java.lang.String No description.
consulPoliciesInput java.util.List<java.lang.String> No description.
consulRolesInput java.util.List<java.lang.String> No description.
idInput java.lang.String No description.
localInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxTtlInput java.lang.Number No description.
nameInput java.lang.String No description.
namespaceInput java.lang.String No description.
nodeIdentitiesInput java.util.List<java.lang.String> No description.
partitionInput java.lang.String No description.
policiesInput java.util.List<java.lang.String> No description.
serviceIdentitiesInput java.util.List<java.lang.String> No description.
ttlInput java.lang.Number No description.
backend java.lang.String No description.
consulNamespace java.lang.String No description.
consulPolicies java.util.List<java.lang.String> No description.
consulRoles java.util.List<java.lang.String> No description.
id java.lang.String No description.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxTtl java.lang.Number No description.
name java.lang.String No description.
namespace java.lang.String No description.
nodeIdentities java.util.List<java.lang.String> No description.
partition java.lang.String No description.
policies java.util.List<java.lang.String> No description.
serviceIdentities java.util.List<java.lang.String> No description.
ttl java.lang.Number 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
consulNamespaceInputOptional 
public java.lang.String getConsulNamespaceInput();
  • Type: java.lang.String
consulPoliciesInputOptional 
public java.util.List<java.lang.String> getConsulPoliciesInput();
  • Type: java.util.List<java.lang.String>
consulRolesInputOptional 
public java.util.List<java.lang.String> getConsulRolesInput();
  • Type: java.util.List<java.lang.String>
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
localInputOptional 
public java.lang.Object getLocalInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxTtlInputOptional 
public java.lang.Number getMaxTtlInput();
  • Type: java.lang.Number
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
nodeIdentitiesInputOptional 
public java.util.List<java.lang.String> getNodeIdentitiesInput();
  • Type: java.util.List<java.lang.String>
partitionInputOptional 
public java.lang.String getPartitionInput();
  • Type: java.lang.String
policiesInputOptional 
public java.util.List<java.lang.String> getPoliciesInput();
  • Type: java.util.List<java.lang.String>
serviceIdentitiesInputOptional 
public java.util.List<java.lang.String> getServiceIdentitiesInput();
  • Type: java.util.List<java.lang.String>
ttlInputOptional 
public java.lang.Number getTtlInput();
  • Type: java.lang.Number
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String
consulNamespaceRequired 
public java.lang.String getConsulNamespace();
  • Type: java.lang.String
consulPoliciesRequired 
public java.util.List<java.lang.String> getConsulPolicies();
  • Type: java.util.List<java.lang.String>
consulRolesRequired 
public java.util.List<java.lang.String> getConsulRoles();
  • Type: java.util.List<java.lang.String>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
localRequired 
public java.lang.Object getLocal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxTtlRequired 
public java.lang.Number getMaxTtl();
  • Type: java.lang.Number
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
nodeIdentitiesRequired 
public java.util.List<java.lang.String> getNodeIdentities();
  • Type: java.util.List<java.lang.String>
partitionRequired 
public java.lang.String getPartition();
  • Type: java.lang.String
policiesRequired 
public java.util.List<java.lang.String> getPolicies();
  • Type: java.util.List<java.lang.String>
serviceIdentitiesRequired 
public java.util.List<java.lang.String> getServiceIdentities();
  • Type: java.util.List<java.lang.String>
ttlRequired 
public java.lang.Number getTtl();
  • Type: java.lang.Number

Constants

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

Structs

ConsulSecretBackendRoleConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.consul_secret_backend_role.ConsulSecretBackendRoleConfig;

ConsulSecretBackendRoleConfig.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>)
    .name(java.lang.String)
//  .backend(java.lang.String)
//  .consulNamespace(java.lang.String)
//  .consulPolicies(java.util.List<java.lang.String>)
//  .consulRoles(java.util.List<java.lang.String>)
//  .id(java.lang.String)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxTtl(java.lang.Number)
//  .namespace(java.lang.String)
//  .nodeIdentities(java.util.List<java.lang.String>)
//  .partition(java.lang.String)
//  .policies(java.util.List<java.lang.String>)
//  .serviceIdentities(java.util.List<java.lang.String>)
//  .ttl(java.lang.Number)
    .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.
name java.lang.String The name of an existing role against which to create this Consul credential.
backend java.lang.String The path of the Consul Secret Backend the role belongs to.
consulNamespace java.lang.String The Consul namespace that the token will be created in. Applicable for Vault 1.10+ and Consul 1.7+.
consulPolicies java.util.List<java.lang.String> List of Consul policies to associate with this role.
consulRoles java.util.List<java.lang.String> Set of Consul roles to attach to the token. Applicable for Vault 1.10+ with Consul 1.5+.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#id ConsulSecretBackendRole#id}.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Indicates that the token should not be replicated globally and instead be local to the current datacenter.
maxTtl java.lang.Number Maximum TTL for leases associated with this role, in seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
nodeIdentities java.util.List<java.lang.String> Set of Consul node identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.8+.
partition java.lang.String The Consul admin partition that the token will be created in. Applicable for Vault 1.10+ and Consul 1.11+.
policies java.util.List<java.lang.String> List of Consul policies to associate with this role.
serviceIdentities java.util.List<java.lang.String> Set of Consul service identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.5+.
ttl java.lang.Number Specifies the TTL for this role.
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>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

The name of an existing role against which to create this Consul credential.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#name ConsulSecretBackendRole#name}

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

The path of the Consul Secret Backend the role belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#backend ConsulSecretBackendRole#backend}

consulNamespaceOptional 
public java.lang.String getConsulNamespace();
  • Type: java.lang.String

The Consul namespace that the token will be created in. Applicable for Vault 1.10+ and Consul 1.7+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#consul_namespace ConsulSecretBackendRole#consul_namespace}

consulPoliciesOptional 
public java.util.List<java.lang.String> getConsulPolicies();
  • Type: java.util.List<java.lang.String>

List of Consul policies to associate with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#consul_policies ConsulSecretBackendRole#consul_policies}

consulRolesOptional 
public java.util.List<java.lang.String> getConsulRoles();
  • Type: java.util.List<java.lang.String>

Set of Consul roles to attach to the token. Applicable for Vault 1.10+ with Consul 1.5+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#consul_roles ConsulSecretBackendRole#consul_roles}

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

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

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

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#local ConsulSecretBackendRole#local}

maxTtlOptional 
public java.lang.Number getMaxTtl();
  • Type: java.lang.Number

Maximum TTL for leases associated with this role, in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#max_ttl ConsulSecretBackendRole#max_ttl}

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.4.0/docs/resources/consul_secret_backend_role#namespace ConsulSecretBackendRole#namespace}

nodeIdentitiesOptional 
public java.util.List<java.lang.String> getNodeIdentities();
  • Type: java.util.List<java.lang.String>

Set of Consul node identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.8+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#node_identities ConsulSecretBackendRole#node_identities}

partitionOptional 
public java.lang.String getPartition();
  • Type: java.lang.String

The Consul admin partition that the token will be created in. Applicable for Vault 1.10+ and Consul 1.11+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#partition ConsulSecretBackendRole#partition}

policiesOptional 
public java.util.List<java.lang.String> getPolicies();
  • Type: java.util.List<java.lang.String>

List of Consul policies to associate with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#policies ConsulSecretBackendRole#policies}

serviceIdentitiesOptional 
public java.util.List<java.lang.String> getServiceIdentities();
  • Type: java.util.List<java.lang.String>

Set of Consul service identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.5+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#service_identities ConsulSecretBackendRole#service_identities}

ttlOptional 
public java.lang.Number getTtl();
  • Type: java.lang.Number

Specifies the TTL for this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/consul_secret_backend_role#ttl ConsulSecretBackendRole#ttl}