Skip to content

Latest commit

 

History

History
1695 lines (1058 loc) · 86 KB

kubernetesSecretBackendRole.java.md

File metadata and controls

1695 lines (1058 loc) · 86 KB
Raw

kubernetesSecretBackendRole Submodule

Constructs

KubernetesSecretBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role vault_kubernetes_secret_backend_role}.

Initializers 

import com.hashicorp.cdktf.providers.vault.kubernetes_secret_backend_role.KubernetesSecretBackendRole;

KubernetesSecretBackendRole.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>)
    .backend(java.lang.String)
    .name(java.lang.String)
//  .allowedKubernetesNamespaces(java.util.List<java.lang.String>)
//  .allowedKubernetesNamespaceSelector(java.lang.String)
//  .extraAnnotations(java.util.Map<java.lang.String, java.lang.String>)
//  .extraLabels(java.util.Map<java.lang.String, java.lang.String>)
//  .generatedRoleRules(java.lang.String)
//  .id(java.lang.String)
//  .kubernetesRoleName(java.lang.String)
//  .kubernetesRoleType(java.lang.String)
//  .namespace(java.lang.String)
//  .nameTemplate(java.lang.String)
//  .serviceAccountName(java.lang.String)
//  .tokenDefaultTtl(java.lang.Number)
//  .tokenMaxTtl(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.
backend java.lang.String The mount path for the Kubernetes secrets engine.
name java.lang.String The name of the role.
allowedKubernetesNamespaces java.util.List<java.lang.String> The list of Kubernetes namespaces this role can generate credentials for.
allowedKubernetesNamespaceSelector java.lang.String A label selector for Kubernetes namespaces in which credentials can begenerated.
extraAnnotations java.util.Map<java.lang.String, java.lang.String> Additional annotations to apply to all generated Kubernetes objects.
extraLabels java.util.Map<java.lang.String, java.lang.String> Additional labels to apply to all generated Kubernetes objects.
generatedRoleRules java.lang.String The Role or ClusterRole rules to use when generating a role.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#id KubernetesSecretBackendRole#id}.
kubernetesRoleName java.lang.String The pre-existing Role or ClusterRole to bind a generated service account to.
kubernetesRoleType java.lang.String Specifies whether the Kubernetes role is a Role or ClusterRole.
namespace java.lang.String Target namespace. (requires Enterprise).
nameTemplate java.lang.String The name template to use when generating service accounts, roles and role bindings.
serviceAccountName java.lang.String The pre-existing service account to generate tokens for.
tokenDefaultTtl java.lang.Number The default TTL for generated Kubernetes tokens in seconds.
tokenMaxTtl java.lang.Number The maximum TTL for generated Kubernetes tokens in seconds.
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>
backendRequired
  • Type: java.lang.String

The mount path for the Kubernetes secrets engine.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#backend KubernetesSecretBackendRole#backend}

nameRequired
  • Type: java.lang.String

The name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#name KubernetesSecretBackendRole#name}

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

The list of Kubernetes namespaces this role can generate credentials for.

If set to '*' all namespaces are allowed. If set withallowed_kubernetes_namespace_selector, the conditions are ORed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#allowed_kubernetes_namespaces KubernetesSecretBackendRole#allowed_kubernetes_namespaces}

allowedKubernetesNamespaceSelectorOptional
  • Type: java.lang.String

A label selector for Kubernetes namespaces in which credentials can begenerated.

Accepts either a JSON or YAML object. The value should be of typeLabelSelector. If set with allowed_kubernetes_namespace, the conditions are ORed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#allowed_kubernetes_namespace_selector KubernetesSecretBackendRole#allowed_kubernetes_namespace_selector}

extraAnnotationsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Additional annotations to apply to all generated Kubernetes objects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#extra_annotations KubernetesSecretBackendRole#extra_annotations}

extraLabelsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Additional labels to apply to all generated Kubernetes objects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#extra_labels KubernetesSecretBackendRole#extra_labels}

generatedRoleRulesOptional
  • Type: java.lang.String

The Role or ClusterRole rules to use when generating a role.

Accepts either JSON or YAML formatted rules. Mutually exclusive with 'service_account_name' and 'kubernetes_role_name'. If set, the entire chain of Kubernetes objects will be generated when credentials are requested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#generated_role_rules KubernetesSecretBackendRole#generated_role_rules}

idOptional
  • Type: java.lang.String

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

kubernetesRoleNameOptional
  • Type: java.lang.String

The pre-existing Role or ClusterRole to bind a generated service account to.

Mutually exclusive with 'service_account_name' and 'generated_role_rules'. If set, Kubernetes token, service account, and role binding objects will be created when credentials are requested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#kubernetes_role_name KubernetesSecretBackendRole#kubernetes_role_name}

kubernetesRoleTypeOptional
  • Type: java.lang.String

Specifies whether the Kubernetes role is a Role or ClusterRole.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#kubernetes_role_type KubernetesSecretBackendRole#kubernetes_role_type}

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/resources/kubernetes_secret_backend_role#namespace KubernetesSecretBackendRole#namespace}

nameTemplateOptional
  • Type: java.lang.String

The name template to use when generating service accounts, roles and role bindings.

If unset, a default template is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#name_template KubernetesSecretBackendRole#name_template}

serviceAccountNameOptional
  • Type: java.lang.String

The pre-existing service account to generate tokens for.

Mutually exclusive with 'kubernetes_role_name' and 'generated_role_rules'. If set, only a Kubernetes token will be created when credentials are requested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#service_account_name KubernetesSecretBackendRole#service_account_name}

tokenDefaultTtlOptional
  • Type: java.lang.Number

The default TTL for generated Kubernetes tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#token_default_ttl KubernetesSecretBackendRole#token_default_ttl}

tokenMaxTtlOptional
  • Type: java.lang.Number

The maximum TTL for generated Kubernetes tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#token_max_ttl KubernetesSecretBackendRole#token_max_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".
resetAllowedKubernetesNamespaces No description.
resetAllowedKubernetesNamespaceSelector No description.
resetExtraAnnotations No description.
resetExtraLabels No description.
resetGeneratedRoleRules No description.
resetId No description.
resetKubernetesRoleName No description.
resetKubernetesRoleType No description.
resetNamespace No description.
resetNameTemplate No description.
resetServiceAccountName No description.
resetTokenDefaultTtl No description.
resetTokenMaxTtl 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".

resetAllowedKubernetesNamespaces 
public void resetAllowedKubernetesNamespaces()
resetAllowedKubernetesNamespaceSelector 
public void resetAllowedKubernetesNamespaceSelector()
resetExtraAnnotations 
public void resetExtraAnnotations()
resetExtraLabels 
public void resetExtraLabels()
resetGeneratedRoleRules 
public void resetGeneratedRoleRules()
resetId 
public void resetId()
resetKubernetesRoleName 
public void resetKubernetesRoleName()
resetKubernetesRoleType 
public void resetKubernetesRoleType()
resetNamespace 
public void resetNamespace()
resetNameTemplate 
public void resetNameTemplate()
resetServiceAccountName 
public void resetServiceAccountName()
resetTokenDefaultTtl 
public void resetTokenDefaultTtl()
resetTokenMaxTtl 
public void resetTokenMaxTtl()

Static Functions

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

KubernetesSecretBackendRole.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.kubernetes_secret_backend_role.KubernetesSecretBackendRole;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing KubernetesSecretBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_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 KubernetesSecretBackendRole 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.
allowedKubernetesNamespaceSelectorInput java.lang.String No description.
allowedKubernetesNamespacesInput java.util.List<java.lang.String> No description.
backendInput java.lang.String No description.
extraAnnotationsInput java.util.Map<java.lang.String, java.lang.String> No description.
extraLabelsInput java.util.Map<java.lang.String, java.lang.String> No description.
generatedRoleRulesInput java.lang.String No description.
idInput java.lang.String No description.
kubernetesRoleNameInput java.lang.String No description.
kubernetesRoleTypeInput java.lang.String No description.
nameInput java.lang.String No description.
namespaceInput java.lang.String No description.
nameTemplateInput java.lang.String No description.
serviceAccountNameInput java.lang.String No description.
tokenDefaultTtlInput java.lang.Number No description.
tokenMaxTtlInput java.lang.Number No description.
allowedKubernetesNamespaces java.util.List<java.lang.String> No description.
allowedKubernetesNamespaceSelector java.lang.String No description.
backend java.lang.String No description.
extraAnnotations java.util.Map<java.lang.String, java.lang.String> No description.
extraLabels java.util.Map<java.lang.String, java.lang.String> No description.
generatedRoleRules java.lang.String No description.
id java.lang.String No description.
kubernetesRoleName java.lang.String No description.
kubernetesRoleType java.lang.String No description.
name java.lang.String No description.
namespace java.lang.String No description.
nameTemplate java.lang.String No description.
serviceAccountName java.lang.String No description.
tokenDefaultTtl java.lang.Number No description.
tokenMaxTtl 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>
allowedKubernetesNamespaceSelectorInputOptional 
public java.lang.String getAllowedKubernetesNamespaceSelectorInput();
  • Type: java.lang.String
allowedKubernetesNamespacesInputOptional 
public java.util.List<java.lang.String> getAllowedKubernetesNamespacesInput();
  • Type: java.util.List<java.lang.String>
backendInputOptional 
public java.lang.String getBackendInput();
  • Type: java.lang.String
extraAnnotationsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getExtraAnnotationsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
extraLabelsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getExtraLabelsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
generatedRoleRulesInputOptional 
public java.lang.String getGeneratedRoleRulesInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
kubernetesRoleNameInputOptional 
public java.lang.String getKubernetesRoleNameInput();
  • Type: java.lang.String
kubernetesRoleTypeInputOptional 
public java.lang.String getKubernetesRoleTypeInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
nameTemplateInputOptional 
public java.lang.String getNameTemplateInput();
  • Type: java.lang.String
serviceAccountNameInputOptional 
public java.lang.String getServiceAccountNameInput();
  • Type: java.lang.String
tokenDefaultTtlInputOptional 
public java.lang.Number getTokenDefaultTtlInput();
  • Type: java.lang.Number
tokenMaxTtlInputOptional 
public java.lang.Number getTokenMaxTtlInput();
  • Type: java.lang.Number
allowedKubernetesNamespacesRequired 
public java.util.List<java.lang.String> getAllowedKubernetesNamespaces();
  • Type: java.util.List<java.lang.String>
allowedKubernetesNamespaceSelectorRequired 
public java.lang.String getAllowedKubernetesNamespaceSelector();
  • Type: java.lang.String
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String
extraAnnotationsRequired 
public java.util.Map<java.lang.String, java.lang.String> getExtraAnnotations();
  • Type: java.util.Map<java.lang.String, java.lang.String>
extraLabelsRequired 
public java.util.Map<java.lang.String, java.lang.String> getExtraLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>
generatedRoleRulesRequired 
public java.lang.String getGeneratedRoleRules();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
kubernetesRoleNameRequired 
public java.lang.String getKubernetesRoleName();
  • Type: java.lang.String
kubernetesRoleTypeRequired 
public java.lang.String getKubernetesRoleType();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
nameTemplateRequired 
public java.lang.String getNameTemplate();
  • Type: java.lang.String
serviceAccountNameRequired 
public java.lang.String getServiceAccountName();
  • Type: java.lang.String
tokenDefaultTtlRequired 
public java.lang.Number getTokenDefaultTtl();
  • Type: java.lang.Number
tokenMaxTtlRequired 
public java.lang.Number getTokenMaxTtl();
  • 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

KubernetesSecretBackendRoleConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.kubernetes_secret_backend_role.KubernetesSecretBackendRoleConfig;

KubernetesSecretBackendRoleConfig.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>)
    .backend(java.lang.String)
    .name(java.lang.String)
//  .allowedKubernetesNamespaces(java.util.List<java.lang.String>)
//  .allowedKubernetesNamespaceSelector(java.lang.String)
//  .extraAnnotations(java.util.Map<java.lang.String, java.lang.String>)
//  .extraLabels(java.util.Map<java.lang.String, java.lang.String>)
//  .generatedRoleRules(java.lang.String)
//  .id(java.lang.String)
//  .kubernetesRoleName(java.lang.String)
//  .kubernetesRoleType(java.lang.String)
//  .namespace(java.lang.String)
//  .nameTemplate(java.lang.String)
//  .serviceAccountName(java.lang.String)
//  .tokenDefaultTtl(java.lang.Number)
//  .tokenMaxTtl(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.
backend java.lang.String The mount path for the Kubernetes secrets engine.
name java.lang.String The name of the role.
allowedKubernetesNamespaces java.util.List<java.lang.String> The list of Kubernetes namespaces this role can generate credentials for.
allowedKubernetesNamespaceSelector java.lang.String A label selector for Kubernetes namespaces in which credentials can begenerated.
extraAnnotations java.util.Map<java.lang.String, java.lang.String> Additional annotations to apply to all generated Kubernetes objects.
extraLabels java.util.Map<java.lang.String, java.lang.String> Additional labels to apply to all generated Kubernetes objects.
generatedRoleRules java.lang.String The Role or ClusterRole rules to use when generating a role.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#id KubernetesSecretBackendRole#id}.
kubernetesRoleName java.lang.String The pre-existing Role or ClusterRole to bind a generated service account to.
kubernetesRoleType java.lang.String Specifies whether the Kubernetes role is a Role or ClusterRole.
namespace java.lang.String Target namespace. (requires Enterprise).
nameTemplate java.lang.String The name template to use when generating service accounts, roles and role bindings.
serviceAccountName java.lang.String The pre-existing service account to generate tokens for.
tokenDefaultTtl java.lang.Number The default TTL for generated Kubernetes tokens in seconds.
tokenMaxTtl java.lang.Number The maximum TTL for generated Kubernetes tokens in seconds.
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>
backendRequired 
public java.lang.String getBackend();
  • Type: java.lang.String

The mount path for the Kubernetes secrets engine.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#backend KubernetesSecretBackendRole#backend}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

The name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#name KubernetesSecretBackendRole#name}

allowedKubernetesNamespacesOptional 
public java.util.List<java.lang.String> getAllowedKubernetesNamespaces();
  • Type: java.util.List<java.lang.String>

The list of Kubernetes namespaces this role can generate credentials for.

If set to '*' all namespaces are allowed. If set withallowed_kubernetes_namespace_selector, the conditions are ORed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#allowed_kubernetes_namespaces KubernetesSecretBackendRole#allowed_kubernetes_namespaces}

allowedKubernetesNamespaceSelectorOptional 
public java.lang.String getAllowedKubernetesNamespaceSelector();
  • Type: java.lang.String

A label selector for Kubernetes namespaces in which credentials can begenerated.

Accepts either a JSON or YAML object. The value should be of typeLabelSelector. If set with allowed_kubernetes_namespace, the conditions are ORed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#allowed_kubernetes_namespace_selector KubernetesSecretBackendRole#allowed_kubernetes_namespace_selector}

extraAnnotationsOptional 
public java.util.Map<java.lang.String, java.lang.String> getExtraAnnotations();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Additional annotations to apply to all generated Kubernetes objects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#extra_annotations KubernetesSecretBackendRole#extra_annotations}

extraLabelsOptional 
public java.util.Map<java.lang.String, java.lang.String> getExtraLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Additional labels to apply to all generated Kubernetes objects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#extra_labels KubernetesSecretBackendRole#extra_labels}

generatedRoleRulesOptional 
public java.lang.String getGeneratedRoleRules();
  • Type: java.lang.String

The Role or ClusterRole rules to use when generating a role.

Accepts either JSON or YAML formatted rules. Mutually exclusive with 'service_account_name' and 'kubernetes_role_name'. If set, the entire chain of Kubernetes objects will be generated when credentials are requested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#generated_role_rules KubernetesSecretBackendRole#generated_role_rules}

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/resources/kubernetes_secret_backend_role#id KubernetesSecretBackendRole#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.

kubernetesRoleNameOptional 
public java.lang.String getKubernetesRoleName();
  • Type: java.lang.String

The pre-existing Role or ClusterRole to bind a generated service account to.

Mutually exclusive with 'service_account_name' and 'generated_role_rules'. If set, Kubernetes token, service account, and role binding objects will be created when credentials are requested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#kubernetes_role_name KubernetesSecretBackendRole#kubernetes_role_name}

kubernetesRoleTypeOptional 
public java.lang.String getKubernetesRoleType();
  • Type: java.lang.String

Specifies whether the Kubernetes role is a Role or ClusterRole.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#kubernetes_role_type KubernetesSecretBackendRole#kubernetes_role_type}

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

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#namespace KubernetesSecretBackendRole#namespace}

nameTemplateOptional 
public java.lang.String getNameTemplate();
  • Type: java.lang.String

The name template to use when generating service accounts, roles and role bindings.

If unset, a default template is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#name_template KubernetesSecretBackendRole#name_template}

serviceAccountNameOptional 
public java.lang.String getServiceAccountName();
  • Type: java.lang.String

The pre-existing service account to generate tokens for.

Mutually exclusive with 'kubernetes_role_name' and 'generated_role_rules'. If set, only a Kubernetes token will be created when credentials are requested.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#service_account_name KubernetesSecretBackendRole#service_account_name}

tokenDefaultTtlOptional 
public java.lang.Number getTokenDefaultTtl();
  • Type: java.lang.Number

The default TTL for generated Kubernetes tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#token_default_ttl KubernetesSecretBackendRole#token_default_ttl}

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

The maximum TTL for generated Kubernetes tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/kubernetes_secret_backend_role#token_max_ttl KubernetesSecretBackendRole#token_max_ttl}