Skip to content

Latest commit

 

History

History
1820 lines (1154 loc) · 75.8 KB

pkiSecretBackendSign.python.md

File metadata and controls

1820 lines (1154 loc) · 75.8 KB

pkiSecretBackendSign Submodule

Constructs

PkiSecretBackendSign

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

Initializers

from cdktf_cdktf_provider_vault import pki_secret_backend_sign

pkiSecretBackendSign.PkiSecretBackendSign(
  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,
  backend: str,
  common_name: str,
  csr: str,
  name: str,
  alt_names: typing.List[str] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  exclude_cn_from_sans: typing.Union[bool, IResolvable] = None,
  format: str = None,
  id: str = None,
  ip_sans: typing.List[str] = None,
  issuer_ref: str = None,
  min_seconds_remaining: typing.Union[int, float] = None,
  namespace: str = None,
  other_sans: typing.List[str] = None,
  ttl: str = None,
  uri_sans: typing.List[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.
backend str The PKI secret backend the resource belongs to.
common_name str CN of intermediate to create.
csr str The CSR.
name str Name of the role to create the certificate against.
alt_names typing.List[str] List of alternative names.
auto_renew typing.Union[bool, cdktf.IResolvable] If enabled, a new certificate will be generated if the expiration is within min_seconds_remaining.
exclude_cn_from_sans typing.Union[bool, cdktf.IResolvable] Flag to exclude CN from SANs.
format str The format of data.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#id PkiSecretBackendSign#id}.
ip_sans typing.List[str] List of alternative IPs.
issuer_ref str Specifies the default issuer of this request.
min_seconds_remaining typing.Union[int, float] Generate a new certificate when the expiration is within this number of seconds.
namespace str Target namespace. (requires Enterprise).
other_sans typing.List[str] List of other SANs.
ttl str Time to live.
uri_sans typing.List[str] List of alternative URIs.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope


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

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

depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
  • Type: cdktf.ITerraformIterator

lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
  • Type: cdktf.TerraformProvider

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

backendRequired
  • Type: str

The PKI secret backend the resource belongs to.

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


common_nameRequired
  • Type: str

CN of intermediate to create.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#common_name PkiSecretBackendSign#common_name}


csrRequired
  • Type: str

The CSR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#csr PkiSecretBackendSign#csr}


nameRequired
  • Type: str

Name of the role to create the certificate against.

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


alt_namesOptional
  • Type: typing.List[str]

List of alternative names.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#alt_names PkiSecretBackendSign#alt_names}


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

If enabled, a new certificate will be generated if the expiration is within min_seconds_remaining.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#auto_renew PkiSecretBackendSign#auto_renew}


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

Flag to exclude CN from SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#exclude_cn_from_sans PkiSecretBackendSign#exclude_cn_from_sans}


formatOptional
  • Type: str

The format of data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#format PkiSecretBackendSign#format}


idOptional
  • Type: str

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


ip_sansOptional
  • Type: typing.List[str]

List of alternative IPs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#ip_sans PkiSecretBackendSign#ip_sans}


issuer_refOptional
  • Type: str

Specifies the default issuer of this request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#issuer_ref PkiSecretBackendSign#issuer_ref}


min_seconds_remainingOptional
  • Type: typing.Union[int, float]

Generate a new certificate when the expiration is within this number of seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#min_seconds_remaining PkiSecretBackendSign#min_seconds_remaining}


namespaceOptional
  • Type: str

Target namespace. (requires Enterprise).

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


other_sansOptional
  • Type: typing.List[str]

List of other SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#other_sans PkiSecretBackendSign#other_sans}


ttlOptional
  • Type: str

Time to live.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#ttl PkiSecretBackendSign#ttl}


uri_sansOptional
  • Type: typing.List[str]

List of alternative URIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#uri_sans PkiSecretBackendSign#uri_sans}


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_alt_names No description.
reset_auto_renew No description.
reset_exclude_cn_from_sans No description.
reset_format No description.
reset_id No description.
reset_ip_sans No description.
reset_issuer_ref No description.
reset_min_seconds_remaining No description.
reset_namespace No description.
reset_other_sans No description.
reset_ttl No description.
reset_uri_sans 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
pathRequired
  • Type: str

valueRequired
  • 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_idRequired
  • 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_targetRequired
  • 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_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

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

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

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

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

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

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

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

has_resource_move
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktf.TerraformProvider

interpolation_for_attribute
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • 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.

idRequired
  • 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_targetRequired
  • Type: str

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


indexOptional
  • 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".

idRequired
  • Type: str

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


reset_alt_names
def reset_alt_names() -> None
reset_auto_renew
def reset_auto_renew() -> None
reset_exclude_cn_from_sans
def reset_exclude_cn_from_sans() -> None
reset_format
def reset_format() -> None
reset_id
def reset_id() -> None
reset_ip_sans
def reset_ip_sans() -> None
reset_issuer_ref
def reset_issuer_ref() -> None
reset_min_seconds_remaining
def reset_min_seconds_remaining() -> None
reset_namespace
def reset_namespace() -> None
reset_other_sans
def reset_other_sans() -> None
reset_ttl
def reset_ttl() -> None
reset_uri_sans
def reset_uri_sans() -> 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 PkiSecretBackendSign resource upon running "cdktf plan ".

is_construct
from cdktf_cdktf_provider_vault import pki_secret_backend_sign

pkiSecretBackendSign.PkiSecretBackendSign.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.

xRequired
  • Type: typing.Any

Any object.


is_terraform_element
from cdktf_cdktf_provider_vault import pki_secret_backend_sign

pkiSecretBackendSign.PkiSecretBackendSign.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktf_cdktf_provider_vault import pki_secret_backend_sign

pkiSecretBackendSign.PkiSecretBackendSign.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktf_cdktf_provider_vault import pki_secret_backend_sign

pkiSecretBackendSign.PkiSecretBackendSign.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


import_to_idRequired
  • Type: str

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


import_from_idRequired
  • Type: str

The id of the existing PkiSecretBackendSign that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the PkiSecretBackendSign 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.
ca_chain typing.List[str] No description.
certificate str No description.
expiration typing.Union[int, float] No description.
issuing_ca str No description.
renew_pending cdktf.IResolvable No description.
serial_number str No description.
alt_names_input typing.List[str] No description.
auto_renew_input typing.Union[bool, cdktf.IResolvable] No description.
backend_input str No description.
common_name_input str No description.
csr_input str No description.
exclude_cn_from_sans_input typing.Union[bool, cdktf.IResolvable] No description.
format_input str No description.
id_input str No description.
ip_sans_input typing.List[str] No description.
issuer_ref_input str No description.
min_seconds_remaining_input typing.Union[int, float] No description.
name_input str No description.
namespace_input str No description.
other_sans_input typing.List[str] No description.
ttl_input str No description.
uri_sans_input typing.List[str] No description.
alt_names typing.List[str] No description.
auto_renew typing.Union[bool, cdktf.IResolvable] No description.
backend str No description.
common_name str No description.
csr str No description.
exclude_cn_from_sans typing.Union[bool, cdktf.IResolvable] No description.
format str No description.
id str No description.
ip_sans typing.List[str] No description.
issuer_ref str No description.
min_seconds_remaining typing.Union[int, float] No description.
name str No description.
namespace str No description.
other_sans typing.List[str] No description.
ttl str No description.
uri_sans typing.List[str] No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack

fqnRequired
fqn: str
  • Type: str

friendly_unique_idRequired
friendly_unique_id: str
  • Type: str

terraform_meta_argumentsRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired
terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

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

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

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

ca_chainRequired
ca_chain: typing.List[str]
  • Type: typing.List[str]

certificateRequired
certificate: str
  • Type: str

expirationRequired
expiration: typing.Union[int, float]
  • Type: typing.Union[int, float]

issuing_caRequired
issuing_ca: str
  • Type: str

renew_pendingRequired
renew_pending: IResolvable
  • Type: cdktf.IResolvable

serial_numberRequired
serial_number: str
  • Type: str

alt_names_inputOptional
alt_names_input: typing.List[str]
  • Type: typing.List[str]

auto_renew_inputOptional
auto_renew_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

backend_inputOptional
backend_input: str
  • Type: str

common_name_inputOptional
common_name_input: str
  • Type: str

csr_inputOptional
csr_input: str
  • Type: str

exclude_cn_from_sans_inputOptional
exclude_cn_from_sans_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

format_inputOptional
format_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

ip_sans_inputOptional
ip_sans_input: typing.List[str]
  • Type: typing.List[str]

issuer_ref_inputOptional
issuer_ref_input: str
  • Type: str

min_seconds_remaining_inputOptional
min_seconds_remaining_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

name_inputOptional
name_input: str
  • Type: str

namespace_inputOptional
namespace_input: str
  • Type: str

other_sans_inputOptional
other_sans_input: typing.List[str]
  • Type: typing.List[str]

ttl_inputOptional
ttl_input: str
  • Type: str

uri_sans_inputOptional
uri_sans_input: typing.List[str]
  • Type: typing.List[str]

alt_namesRequired
alt_names: typing.List[str]
  • Type: typing.List[str]

auto_renewRequired
auto_renew: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

backendRequired
backend: str
  • Type: str

common_nameRequired
common_name: str
  • Type: str

csrRequired
csr: str
  • Type: str

exclude_cn_from_sansRequired
exclude_cn_from_sans: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

formatRequired
format: str
  • Type: str

idRequired
id: str
  • Type: str

ip_sansRequired
ip_sans: typing.List[str]
  • Type: typing.List[str]

issuer_refRequired
issuer_ref: str
  • Type: str

min_seconds_remainingRequired
min_seconds_remaining: typing.Union[int, float]
  • Type: typing.Union[int, float]

nameRequired
name: str
  • Type: str

namespaceRequired
namespace: str
  • Type: str

other_sansRequired
other_sans: typing.List[str]
  • Type: typing.List[str]

ttlRequired
ttl: str
  • Type: str

uri_sansRequired
uri_sans: typing.List[str]
  • Type: typing.List[str]

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

PkiSecretBackendSignConfig

Initializer

from cdktf_cdktf_provider_vault import pki_secret_backend_sign

pkiSecretBackendSign.PkiSecretBackendSignConfig(
  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,
  backend: str,
  common_name: str,
  csr: str,
  name: str,
  alt_names: typing.List[str] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  exclude_cn_from_sans: typing.Union[bool, IResolvable] = None,
  format: str = None,
  id: str = None,
  ip_sans: typing.List[str] = None,
  issuer_ref: str = None,
  min_seconds_remaining: typing.Union[int, float] = None,
  namespace: str = None,
  other_sans: typing.List[str] = None,
  ttl: str = None,
  uri_sans: typing.List[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.
backend str The PKI secret backend the resource belongs to.
common_name str CN of intermediate to create.
csr str The CSR.
name str Name of the role to create the certificate against.
alt_names typing.List[str] List of alternative names.
auto_renew typing.Union[bool, cdktf.IResolvable] If enabled, a new certificate will be generated if the expiration is within min_seconds_remaining.
exclude_cn_from_sans typing.Union[bool, cdktf.IResolvable] Flag to exclude CN from SANs.
format str The format of data.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#id PkiSecretBackendSign#id}.
ip_sans typing.List[str] List of alternative IPs.
issuer_ref str Specifies the default issuer of this request.
min_seconds_remaining typing.Union[int, float] Generate a new certificate when the expiration is within this number of seconds.
namespace str Target namespace. (requires Enterprise).
other_sans typing.List[str] List of other SANs.
ttl str Time to live.
uri_sans typing.List[str] List of alternative URIs.

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

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

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

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

backendRequired
backend: str
  • Type: str

The PKI secret backend the resource belongs to.

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


common_nameRequired
common_name: str
  • Type: str

CN of intermediate to create.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#common_name PkiSecretBackendSign#common_name}


csrRequired
csr: str
  • Type: str

The CSR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#csr PkiSecretBackendSign#csr}


nameRequired
name: str
  • Type: str

Name of the role to create the certificate against.

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


alt_namesOptional
alt_names: typing.List[str]
  • Type: typing.List[str]

List of alternative names.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#alt_names PkiSecretBackendSign#alt_names}


auto_renewOptional
auto_renew: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

If enabled, a new certificate will be generated if the expiration is within min_seconds_remaining.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#auto_renew PkiSecretBackendSign#auto_renew}


exclude_cn_from_sansOptional
exclude_cn_from_sans: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Flag to exclude CN from SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#exclude_cn_from_sans PkiSecretBackendSign#exclude_cn_from_sans}


formatOptional
format: str
  • Type: str

The format of data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#format PkiSecretBackendSign#format}


idOptional
id: str
  • Type: str

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


ip_sansOptional
ip_sans: typing.List[str]
  • Type: typing.List[str]

List of alternative IPs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#ip_sans PkiSecretBackendSign#ip_sans}


issuer_refOptional
issuer_ref: str
  • Type: str

Specifies the default issuer of this request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#issuer_ref PkiSecretBackendSign#issuer_ref}


min_seconds_remainingOptional
min_seconds_remaining: typing.Union[int, float]
  • Type: typing.Union[int, float]

Generate a new certificate when the expiration is within this number of seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#min_seconds_remaining PkiSecretBackendSign#min_seconds_remaining}


namespaceOptional
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/pki_secret_backend_sign#namespace PkiSecretBackendSign#namespace}


other_sansOptional
other_sans: typing.List[str]
  • Type: typing.List[str]

List of other SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#other_sans PkiSecretBackendSign#other_sans}


ttlOptional
ttl: str
  • Type: str

Time to live.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#ttl PkiSecretBackendSign#ttl}


uri_sansOptional
uri_sans: typing.List[str]
  • Type: typing.List[str]

List of alternative URIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/pki_secret_backend_sign#uri_sans PkiSecretBackendSign#uri_sans}