Skip to content

Latest commit

 

History

History
1929 lines (1211 loc) · 86.6 KB

pkiSecretBackendCert.java.md

File metadata and controls

1929 lines (1211 loc) · 86.6 KB

pkiSecretBackendCert Submodule

Constructs

PkiSecretBackendCert

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

Initializers

import com.hashicorp.cdktf.providers.vault.pki_secret_backend_cert.PkiSecretBackendCert;

PkiSecretBackendCert.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)
    .commonName(java.lang.String)
    .name(java.lang.String)
//  .altNames(java.util.List<java.lang.String>)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .excludeCnFromSans(java.lang.Boolean)
//  .excludeCnFromSans(IResolvable)
//  .format(java.lang.String)
//  .id(java.lang.String)
//  .ipSans(java.util.List<java.lang.String>)
//  .issuerRef(java.lang.String)
//  .minSecondsRemaining(java.lang.Number)
//  .namespace(java.lang.String)
//  .otherSans(java.util.List<java.lang.String>)
//  .privateKeyFormat(java.lang.String)
//  .revoke(java.lang.Boolean)
//  .revoke(IResolvable)
//  .ttl(java.lang.String)
//  .uriSans(java.util.List<java.lang.String>)
//  .userIds(java.util.List<java.lang.String>)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
backend java.lang.String The PKI secret backend the resource belongs to.
commonName java.lang.String CN of the certificate to create.
name java.lang.String Name of the role to create the certificate against.
altNames java.util.List<java.lang.String> List of alternative names.
autoRenew java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If enabled, a new certificate will be generated if the expiration is within min_seconds_remaining.
excludeCnFromSans java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Flag to exclude CN from SANs.
format java.lang.String The format of data.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#id PkiSecretBackendCert#id}.
ipSans java.util.List<java.lang.String> List of alternative IPs.
issuerRef java.lang.String Specifies the default issuer of this request.
minSecondsRemaining java.lang.Number Generate a new certificate when the expiration is within this number of seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
otherSans java.util.List<java.lang.String> List of other SANs.
privateKeyFormat java.lang.String The private key format.
revoke java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Revoke the certificate upon resource destruction.
ttl java.lang.String Time to live.
uriSans java.util.List<java.lang.String> List of alternative URIs.
userIds java.util.List<java.lang.String> List of Subject User IDs.

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 PKI secret backend the resource belongs to.

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


commonNameRequired
  • Type: java.lang.String

CN of the certificate to create.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#common_name PkiSecretBackendCert#common_name}


nameRequired
  • Type: java.lang.String

Name of the role to create the certificate against.

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


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

List of alternative names.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#alt_names PkiSecretBackendCert#alt_names}


autoRenewOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.4.0/docs/resources/pki_secret_backend_cert#auto_renew PkiSecretBackendCert#auto_renew}


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

Flag to exclude CN from SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#exclude_cn_from_sans PkiSecretBackendCert#exclude_cn_from_sans}


formatOptional
  • Type: java.lang.String

The format of data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#format PkiSecretBackendCert#format}


idOptional
  • Type: java.lang.String

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


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

List of alternative IPs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#ip_sans PkiSecretBackendCert#ip_sans}


issuerRefOptional
  • Type: java.lang.String

Specifies the default issuer of this request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#issuer_ref PkiSecretBackendCert#issuer_ref}


minSecondsRemainingOptional
  • Type: java.lang.Number

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.4.0/docs/resources/pki_secret_backend_cert#min_seconds_remaining PkiSecretBackendCert#min_seconds_remaining}


namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

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


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

List of other SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#other_sans PkiSecretBackendCert#other_sans}


privateKeyFormatOptional
  • Type: java.lang.String

The private key format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#private_key_format PkiSecretBackendCert#private_key_format}


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

Revoke the certificate upon resource destruction.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#revoke PkiSecretBackendCert#revoke}


ttlOptional
  • Type: java.lang.String

Time to live.

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


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

List of alternative URIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#uri_sans PkiSecretBackendCert#uri_sans}


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

List of Subject User IDs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#user_ids PkiSecretBackendCert#user_ids}


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".
resetAltNames No description.
resetAutoRenew No description.
resetExcludeCnFromSans No description.
resetFormat No description.
resetId No description.
resetIpSans No description.
resetIssuerRef No description.
resetMinSecondsRemaining No description.
resetNamespace No description.
resetOtherSans No description.
resetPrivateKeyFormat No description.
resetRevoke No description.
resetTtl No description.
resetUriSans No description.
resetUserIds 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".


resetAltNames
public void resetAltNames()
resetAutoRenew
public void resetAutoRenew()
resetExcludeCnFromSans
public void resetExcludeCnFromSans()
resetFormat
public void resetFormat()
resetId
public void resetId()
resetIpSans
public void resetIpSans()
resetIssuerRef
public void resetIssuerRef()
resetMinSecondsRemaining
public void resetMinSecondsRemaining()
resetNamespace
public void resetNamespace()
resetOtherSans
public void resetOtherSans()
resetPrivateKeyFormat
public void resetPrivateKeyFormat()
resetRevoke
public void resetRevoke()
resetTtl
public void resetTtl()
resetUriSans
public void resetUriSans()
resetUserIds
public void resetUserIds()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a PkiSecretBackendCert resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.vault.pki_secret_backend_cert.PkiSecretBackendCert;

PkiSecretBackendCert.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.pki_secret_backend_cert.PkiSecretBackendCert;

PkiSecretBackendCert.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.vault.pki_secret_backend_cert.PkiSecretBackendCert;

PkiSecretBackendCert.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.vault.pki_secret_backend_cert.PkiSecretBackendCert;

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

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing PkiSecretBackendCert that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#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 PkiSecretBackendCert 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.
caChain java.lang.String No description.
certificate java.lang.String No description.
expiration java.lang.Number No description.
issuingCa java.lang.String No description.
privateKey java.lang.String No description.
privateKeyType java.lang.String No description.
renewPending com.hashicorp.cdktf.IResolvable No description.
serialNumber java.lang.String No description.
altNamesInput java.util.List<java.lang.String> No description.
autoRenewInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
backendInput java.lang.String No description.
commonNameInput java.lang.String No description.
excludeCnFromSansInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
formatInput java.lang.String No description.
idInput java.lang.String No description.
ipSansInput java.util.List<java.lang.String> No description.
issuerRefInput java.lang.String No description.
minSecondsRemainingInput java.lang.Number No description.
nameInput java.lang.String No description.
namespaceInput java.lang.String No description.
otherSansInput java.util.List<java.lang.String> No description.
privateKeyFormatInput java.lang.String No description.
revokeInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
ttlInput java.lang.String No description.
uriSansInput java.util.List<java.lang.String> No description.
userIdsInput java.util.List<java.lang.String> No description.
altNames java.util.List<java.lang.String> No description.
autoRenew java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
backend java.lang.String No description.
commonName java.lang.String No description.
excludeCnFromSans java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
format java.lang.String No description.
id java.lang.String No description.
ipSans java.util.List<java.lang.String> No description.
issuerRef java.lang.String No description.
minSecondsRemaining java.lang.Number No description.
name java.lang.String No description.
namespace java.lang.String No description.
otherSans java.util.List<java.lang.String> No description.
privateKeyFormat java.lang.String No description.
revoke java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
ttl java.lang.String No description.
uriSans java.util.List<java.lang.String> No description.
userIds java.util.List<java.lang.String> No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

caChainRequired
public java.lang.String getCaChain();
  • Type: java.lang.String

certificateRequired
public java.lang.String getCertificate();
  • Type: java.lang.String

expirationRequired
public java.lang.Number getExpiration();
  • Type: java.lang.Number

issuingCaRequired
public java.lang.String getIssuingCa();
  • Type: java.lang.String

privateKeyRequired
public java.lang.String getPrivateKey();
  • Type: java.lang.String

privateKeyTypeRequired
public java.lang.String getPrivateKeyType();
  • Type: java.lang.String

renewPendingRequired
public IResolvable getRenewPending();
  • Type: com.hashicorp.cdktf.IResolvable

serialNumberRequired
public java.lang.String getSerialNumber();
  • Type: java.lang.String

altNamesInputOptional
public java.util.List<java.lang.String> getAltNamesInput();
  • Type: java.util.List<java.lang.String>

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

backendInputOptional
public java.lang.String getBackendInput();
  • Type: java.lang.String

commonNameInputOptional
public java.lang.String getCommonNameInput();
  • Type: java.lang.String

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

formatInputOptional
public java.lang.String getFormatInput();
  • Type: java.lang.String

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

ipSansInputOptional
public java.util.List<java.lang.String> getIpSansInput();
  • Type: java.util.List<java.lang.String>

issuerRefInputOptional
public java.lang.String getIssuerRefInput();
  • Type: java.lang.String

minSecondsRemainingInputOptional
public java.lang.Number getMinSecondsRemainingInput();
  • Type: java.lang.Number

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

namespaceInputOptional
public java.lang.String getNamespaceInput();
  • Type: java.lang.String

otherSansInputOptional
public java.util.List<java.lang.String> getOtherSansInput();
  • Type: java.util.List<java.lang.String>

privateKeyFormatInputOptional
public java.lang.String getPrivateKeyFormatInput();
  • Type: java.lang.String

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

ttlInputOptional
public java.lang.String getTtlInput();
  • Type: java.lang.String

uriSansInputOptional
public java.util.List<java.lang.String> getUriSansInput();
  • Type: java.util.List<java.lang.String>

userIdsInputOptional
public java.util.List<java.lang.String> getUserIdsInput();
  • Type: java.util.List<java.lang.String>

altNamesRequired
public java.util.List<java.lang.String> getAltNames();
  • Type: java.util.List<java.lang.String>

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

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

commonNameRequired
public java.lang.String getCommonName();
  • Type: java.lang.String

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

formatRequired
public java.lang.String getFormat();
  • Type: java.lang.String

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

ipSansRequired
public java.util.List<java.lang.String> getIpSans();
  • Type: java.util.List<java.lang.String>

issuerRefRequired
public java.lang.String getIssuerRef();
  • Type: java.lang.String

minSecondsRemainingRequired
public java.lang.Number getMinSecondsRemaining();
  • Type: java.lang.Number

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

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

otherSansRequired
public java.util.List<java.lang.String> getOtherSans();
  • Type: java.util.List<java.lang.String>

privateKeyFormatRequired
public java.lang.String getPrivateKeyFormat();
  • Type: java.lang.String

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

ttlRequired
public java.lang.String getTtl();
  • Type: java.lang.String

uriSansRequired
public java.util.List<java.lang.String> getUriSans();
  • Type: java.util.List<java.lang.String>

userIdsRequired
public java.util.List<java.lang.String> getUserIds();
  • Type: java.util.List<java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

PkiSecretBackendCertConfig

Initializer

import com.hashicorp.cdktf.providers.vault.pki_secret_backend_cert.PkiSecretBackendCertConfig;

PkiSecretBackendCertConfig.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)
    .commonName(java.lang.String)
    .name(java.lang.String)
//  .altNames(java.util.List<java.lang.String>)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .excludeCnFromSans(java.lang.Boolean)
//  .excludeCnFromSans(IResolvable)
//  .format(java.lang.String)
//  .id(java.lang.String)
//  .ipSans(java.util.List<java.lang.String>)
//  .issuerRef(java.lang.String)
//  .minSecondsRemaining(java.lang.Number)
//  .namespace(java.lang.String)
//  .otherSans(java.util.List<java.lang.String>)
//  .privateKeyFormat(java.lang.String)
//  .revoke(java.lang.Boolean)
//  .revoke(IResolvable)
//  .ttl(java.lang.String)
//  .uriSans(java.util.List<java.lang.String>)
//  .userIds(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
backend java.lang.String The PKI secret backend the resource belongs to.
commonName java.lang.String CN of the certificate to create.
name java.lang.String Name of the role to create the certificate against.
altNames java.util.List<java.lang.String> List of alternative names.
autoRenew java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If enabled, a new certificate will be generated if the expiration is within min_seconds_remaining.
excludeCnFromSans java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Flag to exclude CN from SANs.
format java.lang.String The format of data.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#id PkiSecretBackendCert#id}.
ipSans java.util.List<java.lang.String> List of alternative IPs.
issuerRef java.lang.String Specifies the default issuer of this request.
minSecondsRemaining java.lang.Number Generate a new certificate when the expiration is within this number of seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
otherSans java.util.List<java.lang.String> List of other SANs.
privateKeyFormat java.lang.String The private key format.
revoke java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Revoke the certificate upon resource destruction.
ttl java.lang.String Time to live.
uriSans java.util.List<java.lang.String> List of alternative URIs.
userIds java.util.List<java.lang.String> List of Subject User IDs.

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 PKI secret backend the resource belongs to.

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


commonNameRequired
public java.lang.String getCommonName();
  • Type: java.lang.String

CN of the certificate to create.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#common_name PkiSecretBackendCert#common_name}


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

Name of the role to create the certificate against.

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


altNamesOptional
public java.util.List<java.lang.String> getAltNames();
  • Type: java.util.List<java.lang.String>

List of alternative names.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#alt_names PkiSecretBackendCert#alt_names}


autoRenewOptional
public java.lang.Object getAutoRenew();
  • Type: java.lang.Boolean OR com.hashicorp.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.4.0/docs/resources/pki_secret_backend_cert#auto_renew PkiSecretBackendCert#auto_renew}


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

Flag to exclude CN from SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#exclude_cn_from_sans PkiSecretBackendCert#exclude_cn_from_sans}


formatOptional
public java.lang.String getFormat();
  • Type: java.lang.String

The format of data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#format PkiSecretBackendCert#format}


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

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


ipSansOptional
public java.util.List<java.lang.String> getIpSans();
  • Type: java.util.List<java.lang.String>

List of alternative IPs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#ip_sans PkiSecretBackendCert#ip_sans}


issuerRefOptional
public java.lang.String getIssuerRef();
  • Type: java.lang.String

Specifies the default issuer of this request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#issuer_ref PkiSecretBackendCert#issuer_ref}


minSecondsRemainingOptional
public java.lang.Number getMinSecondsRemaining();
  • Type: java.lang.Number

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.4.0/docs/resources/pki_secret_backend_cert#min_seconds_remaining PkiSecretBackendCert#min_seconds_remaining}


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

Target namespace. (requires Enterprise).

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


otherSansOptional
public java.util.List<java.lang.String> getOtherSans();
  • Type: java.util.List<java.lang.String>

List of other SANs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#other_sans PkiSecretBackendCert#other_sans}


privateKeyFormatOptional
public java.lang.String getPrivateKeyFormat();
  • Type: java.lang.String

The private key format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#private_key_format PkiSecretBackendCert#private_key_format}


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

Revoke the certificate upon resource destruction.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#revoke PkiSecretBackendCert#revoke}


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

Time to live.

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


uriSansOptional
public java.util.List<java.lang.String> getUriSans();
  • Type: java.util.List<java.lang.String>

List of alternative URIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#uri_sans PkiSecretBackendCert#uri_sans}


userIdsOptional
public java.util.List<java.lang.String> getUserIds();
  • Type: java.util.List<java.lang.String>

List of Subject User IDs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/pki_secret_backend_cert#user_ids PkiSecretBackendCert#user_ids}