`consulSecretBackend` Submodule

Constructs

ConsulSecretBackend

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

Initializers

from cdktf_cdktf_provider_vault import consul_secret_backend

consulSecretBackend.ConsulSecretBackend(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  address: str,
  bootstrap: typing.Union[bool, IResolvable] = None,
  ca_cert: str = None,
  client_cert: str = None,
  client_key: str = None,
  default_lease_ttl_seconds: typing.Union[int, float] = None,
  description: str = None,
  disable_remount: typing.Union[bool, IResolvable] = None,
  id: str = None,
  local: typing.Union[bool, IResolvable] = None,
  max_lease_ttl_seconds: typing.Union[int, float] = None,
  namespace: str = None,
  path: str = None,
  scheme: str = None,
  token: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`address`	`str`	Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
`bootstrap`	`typing.Union[bool, cdktf.IResolvable]`	Denotes a backend resource that is used to bootstrap the Consul ACL system.
`ca_cert`	`str`	CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
`client_cert`	`str`	Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
`client_key`	`str`	Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
`default_lease_ttl_seconds`	`typing.Union[int, float]`	Default lease duration for secrets in seconds.
`description`	`str`	Human-friendly description of the mount for the backend.
`disable_remount`	`typing.Union[bool, cdktf.IResolvable]`	If set, opts out of mount migration on path updates.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#id ConsulSecretBackend#id}.
`local`	`typing.Union[bool, cdktf.IResolvable]`	Specifies if the secret backend is local only.
`max_lease_ttl_seconds`	`typing.Union[int, float]`	Maximum possible lease duration for secrets in seconds.
`namespace`	`str`	Target namespace. (requires Enterprise).
`path`	`str`	Unique name of the Vault Consul mount to configure.
`scheme`	`str`	Specifies the URL scheme to use. Defaults to "http".
`token`	`str`	Specifies the Consul token to use when managing or issuing new tokens.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`address`^Required

Type: str

Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#address ConsulSecretBackend#address}

`bootstrap`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Denotes a backend resource that is used to bootstrap the Consul ACL system.

Only one resource may be used to bootstrap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#bootstrap ConsulSecretBackend#bootstrap}

`ca_cert`^Optional

Type: str

CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#ca_cert ConsulSecretBackend#ca_cert}

`client_cert`^Optional

Type: str

Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#client_cert ConsulSecretBackend#client_cert}

`client_key`^Optional

Type: str

Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#client_key ConsulSecretBackend#client_key}

`default_lease_ttl_seconds`^Optional

Type: typing.Union[int, float]

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#default_lease_ttl_seconds ConsulSecretBackend#default_lease_ttl_seconds}

`description`^Optional

Type: str

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#description ConsulSecretBackend#description}

`disable_remount`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#disable_remount ConsulSecretBackend#disable_remount}

`id`^Optional

Type: str

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

`local`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#local ConsulSecretBackend#local}

`max_lease_ttl_seconds`^Optional

Type: typing.Union[int, float]

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#max_lease_ttl_seconds ConsulSecretBackend#max_lease_ttl_seconds}

`namespace`^Optional

Type: str

Target namespace. (requires Enterprise).

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

`path`^Optional

Type: str

Unique name of the Vault Consul mount to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#path ConsulSecretBackend#path}

`scheme`^Optional

Type: str

Specifies the URL scheme to use. Defaults to "http".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#scheme ConsulSecretBackend#scheme}

`token`^Optional

Type: str

Specifies the Consul token to use when managing or issuing new tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#token ConsulSecretBackend#token}

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`reset_bootstrap`	No description.
`reset_ca_cert`	No description.
`reset_client_cert`	No description.
`reset_client_key`	No description.
`reset_default_lease_ttl_seconds`	No description.
`reset_description`	No description.
`reset_disable_remount`	No description.
`reset_id`	No description.
`reset_local`	No description.
`reset_max_lease_ttl_seconds`	No description.
`reset_namespace`	No description.
`reset_path`	No description.
`reset_scheme`	No description.
`reset_token`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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.

`id`^Required

Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`move_to`

def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`move_to_id`

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`reset_bootstrap`

def reset_bootstrap() -> None

`reset_ca_cert`

def reset_ca_cert() -> None

`reset_client_cert`

def reset_client_cert() -> None

`reset_client_key`

def reset_client_key() -> None

`reset_default_lease_ttl_seconds`

def reset_default_lease_ttl_seconds() -> None

`reset_description`

def reset_description() -> None

`reset_disable_remount`

def reset_disable_remount() -> None

`reset_id`

def reset_id() -> None

`reset_local`

def reset_local() -> None

`reset_max_lease_ttl_seconds`

def reset_max_lease_ttl_seconds() -> None

`reset_namespace`

def reset_namespace() -> None

`reset_path`

def reset_path() -> None

`reset_scheme`

def reset_scheme() -> None

`reset_token`

def reset_token() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a ConsulSecretBackend resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_vault import consul_secret_backend

consulSecretBackend.ConsulSecretBackend.is_construct(
  x: typing.Any
)

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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_vault import consul_secret_backend

consulSecretBackend.ConsulSecretBackend.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_vault import consul_secret_backend

consulSecretBackend.ConsulSecretBackend.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_vault import consul_secret_backend

consulSecretBackend.ConsulSecretBackend.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a ConsulSecretBackend resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

The construct id used in the generated config for the ConsulSecretBackend to import.

`import_from_id`^Required

Type: str

The id of the existing ConsulSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the ConsulSecretBackend to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`address_input`	`str`	No description.
`bootstrap_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`ca_cert_input`	`str`	No description.
`client_cert_input`	`str`	No description.
`client_key_input`	`str`	No description.
`default_lease_ttl_seconds_input`	`typing.Union[int, float]`	No description.
`description_input`	`str`	No description.
`disable_remount_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id_input`	`str`	No description.
`local_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`max_lease_ttl_seconds_input`	`typing.Union[int, float]`	No description.
`namespace_input`	`str`	No description.
`path_input`	`str`	No description.
`scheme_input`	`str`	No description.
`token_input`	`str`	No description.
`address`	`str`	No description.
`bootstrap`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`ca_cert`	`str`	No description.
`client_cert`	`str`	No description.
`client_key`	`str`	No description.
`default_lease_ttl_seconds`	`typing.Union[int, float]`	No description.
`description`	`str`	No description.
`disable_remount`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id`	`str`	No description.
`local`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`max_lease_ttl_seconds`	`typing.Union[int, float]`	No description.
`namespace`	`str`	No description.
`path`	`str`	No description.
`scheme`	`str`	No description.
`token`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`address_input`^Optional

address_input: str

Type: str

`bootstrap_input`^Optional

bootstrap_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`ca_cert_input`^Optional

ca_cert_input: str

Type: str

`client_cert_input`^Optional

client_cert_input: str

Type: str

`client_key_input`^Optional

client_key_input: str

Type: str

`default_lease_ttl_seconds_input`^Optional

default_lease_ttl_seconds_input: typing.Union[int, float]

Type: typing.Union[int, float]

`description_input`^Optional

description_input: str

Type: str

`disable_remount_input`^Optional

disable_remount_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id_input`^Optional

id_input: str

Type: str

`local_input`^Optional

local_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`max_lease_ttl_seconds_input`^Optional

max_lease_ttl_seconds_input: typing.Union[int, float]

Type: typing.Union[int, float]

`namespace_input`^Optional

namespace_input: str

Type: str

`path_input`^Optional

path_input: str

Type: str

`scheme_input`^Optional

scheme_input: str

Type: str

`token_input`^Optional

token_input: str

Type: str

`address`^Required

address: str

Type: str

`bootstrap`^Required

bootstrap: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`ca_cert`^Required

ca_cert: str

Type: str

`client_cert`^Required

client_cert: str

Type: str

`client_key`^Required

client_key: str

Type: str

`default_lease_ttl_seconds`^Required

default_lease_ttl_seconds: typing.Union[int, float]

Type: typing.Union[int, float]

`description`^Required

description: str

Type: str

`disable_remount`^Required

disable_remount: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id`^Required

id: str

Type: str

`local`^Required

local: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`max_lease_ttl_seconds`^Required

max_lease_ttl_seconds: typing.Union[int, float]

Type: typing.Union[int, float]

`namespace`^Required

namespace: str

Type: str

`path`^Required

path: str

Type: str

`scheme`^Required

scheme: str

Type: str

`token`^Required

token: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

ConsulSecretBackendConfig

Initializer

from cdktf_cdktf_provider_vault import consul_secret_backend

consulSecretBackend.ConsulSecretBackendConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  address: str,
  bootstrap: typing.Union[bool, IResolvable] = None,
  ca_cert: str = None,
  client_cert: str = None,
  client_key: str = None,
  default_lease_ttl_seconds: typing.Union[int, float] = None,
  description: str = None,
  disable_remount: typing.Union[bool, IResolvable] = None,
  id: str = None,
  local: typing.Union[bool, IResolvable] = None,
  max_lease_ttl_seconds: typing.Union[int, float] = None,
  namespace: str = None,
  path: str = None,
  scheme: str = None,
  token: str = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`address`	`str`	Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
`bootstrap`	`typing.Union[bool, cdktf.IResolvable]`	Denotes a backend resource that is used to bootstrap the Consul ACL system.
`ca_cert`	`str`	CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
`client_cert`	`str`	Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
`client_key`	`str`	Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
`default_lease_ttl_seconds`	`typing.Union[int, float]`	Default lease duration for secrets in seconds.
`description`	`str`	Human-friendly description of the mount for the backend.
`disable_remount`	`typing.Union[bool, cdktf.IResolvable]`	If set, opts out of mount migration on path updates.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#id ConsulSecretBackend#id}.
`local`	`typing.Union[bool, cdktf.IResolvable]`	Specifies if the secret backend is local only.
`max_lease_ttl_seconds`	`typing.Union[int, float]`	Maximum possible lease duration for secrets in seconds.
`namespace`	`str`	Target namespace. (requires Enterprise).
`path`	`str`	Unique name of the Vault Consul mount to configure.
`scheme`	`str`	Specifies the URL scheme to use. Defaults to "http".
`token`	`str`	Specifies the Consul token to use when managing or issuing new tokens.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`address`^Required

address: str

Type: str

Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#address ConsulSecretBackend#address}

`bootstrap`^Optional

bootstrap: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Denotes a backend resource that is used to bootstrap the Consul ACL system.

Only one resource may be used to bootstrap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#bootstrap ConsulSecretBackend#bootstrap}

`ca_cert`^Optional

ca_cert: str

Type: str

CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#ca_cert ConsulSecretBackend#ca_cert}

`client_cert`^Optional

client_cert: str

Type: str

Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#client_cert ConsulSecretBackend#client_cert}

`client_key`^Optional

client_key: str

Type: str

Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#client_key ConsulSecretBackend#client_key}

`default_lease_ttl_seconds`^Optional

default_lease_ttl_seconds: typing.Union[int, float]

Type: typing.Union[int, float]

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#default_lease_ttl_seconds ConsulSecretBackend#default_lease_ttl_seconds}

`description`^Optional

description: str

Type: str

Human-friendly description of the mount for the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#description ConsulSecretBackend#description}

`disable_remount`^Optional

disable_remount: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#disable_remount ConsulSecretBackend#disable_remount}

`id`^Optional

id: str

Type: str

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

`local`^Optional

local: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the secret backend is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#local ConsulSecretBackend#local}

`max_lease_ttl_seconds`^Optional

max_lease_ttl_seconds: typing.Union[int, float]

Type: typing.Union[int, float]

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#max_lease_ttl_seconds ConsulSecretBackend#max_lease_ttl_seconds}

`namespace`^Optional

namespace: str

Type: str

Target namespace. (requires Enterprise).

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

`path`^Optional

path: str

Type: str

Unique name of the Vault Consul mount to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#path ConsulSecretBackend#path}

`scheme`^Optional

scheme: str

Type: str

Specifies the URL scheme to use. Defaults to "http".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#scheme ConsulSecretBackend#scheme}

`token`^Optional

token: str

Type: str

Specifies the Consul token to use when managing or issuing new tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/consul_secret_backend#token ConsulSecretBackend#token}

Files

consulSecretBackend.python.md

Latest commit

History

consulSecretBackend.python.md

File metadata and controls

consulSecretBackend Submodule

Constructs