Skip to content

Latest commit

 

History

History
1327 lines (827 loc) · 62.5 KB

locallySignedCert.java.md

File metadata and controls

1327 lines (827 loc) · 62.5 KB
Raw

locallySignedCert Submodule

Constructs

LocallySignedCert

Represents a {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert tls_locally_signed_cert}.

Initializers 

import com.hashicorp.cdktf.providers.tls.locally_signed_cert.LocallySignedCert;

LocallySignedCert.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>)
    .allowedUses(java.util.List<java.lang.String>)
    .caCertPem(java.lang.String)
    .caPrivateKeyPem(java.lang.String)
    .certRequestPem(java.lang.String)
    .validityPeriodHours(java.lang.Number)
//  .earlyRenewalHours(java.lang.Number)
//  .isCaCertificate(java.lang.Boolean)
//  .isCaCertificate(IResolvable)
//  .setSubjectKeyId(java.lang.Boolean)
//  .setSubjectKeyId(IResolvable)
    .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.
allowedUses java.util.List<java.lang.String> List of key usages allowed for the issued certificate.
caCertPem java.lang.String Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.
caPrivateKeyPem java.lang.String Private key of the Certificate Authority (CA) used to sign the certificate, in PEM (RFC 1421) format.
certRequestPem java.lang.String Certificate request data in PEM (RFC 1421) format.
validityPeriodHours java.lang.Number Number of hours, after initial issuing, that the certificate will remain valid for.
earlyRenewalHours java.lang.Number The resource will consider the certificate to have expired the given number of hours before its actual expiry time.
isCaCertificate java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Is the generated certificate representing a Certificate Authority (CA) (default: false).
setSubjectKeyId java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Should the generated certificate include a subject key identifier (default: false).
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>
allowedUsesRequired
  • Type: java.util.List<java.lang.String>

List of key usages allowed for the issued certificate.

Values are defined in RFC 5280 and combine flags defined by both Key Usages and Extended Key Usages. Accepted values: any_extended, cert_signing, client_auth, code_signing, content_commitment, crl_signing, data_encipherment, decipher_only, digital_signature, email_protection, encipher_only, ipsec_end_system, ipsec_tunnel, ipsec_user, key_agreement, key_encipherment, microsoft_commercial_code_signing, microsoft_kernel_code_signing, microsoft_server_gated_crypto, netscape_server_gated_crypto, ocsp_signing, server_auth, timestamping.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#allowed_uses LocallySignedCert#allowed_uses}

caCertPemRequired
  • Type: java.lang.String

Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#ca_cert_pem LocallySignedCert#ca_cert_pem}

caPrivateKeyPemRequired
  • Type: java.lang.String

Private key of the Certificate Authority (CA) used to sign the certificate, in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#ca_private_key_pem LocallySignedCert#ca_private_key_pem}

certRequestPemRequired
  • Type: java.lang.String

Certificate request data in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#cert_request_pem LocallySignedCert#cert_request_pem}

validityPeriodHoursRequired
  • Type: java.lang.Number

Number of hours, after initial issuing, that the certificate will remain valid for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#validity_period_hours LocallySignedCert#validity_period_hours}

earlyRenewalHoursOptional
  • Type: java.lang.Number

The resource will consider the certificate to have expired the given number of hours before its actual expiry time.

This can be useful to deploy an updated certificate in advance of the expiration of the current certificate. However, the old certificate remains valid until its true expiration time, since this resource does not (and cannot) support certificate revocation. Also, this advance update can only be performed should the Terraform configuration be applied during the early renewal period. (default: 0)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#early_renewal_hours LocallySignedCert#early_renewal_hours}

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

Is the generated certificate representing a Certificate Authority (CA) (default: false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#is_ca_certificate LocallySignedCert#is_ca_certificate}

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

Should the generated certificate include a subject key identifier (default: false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#set_subject_key_id LocallySignedCert#set_subject_key_id}

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".
resetEarlyRenewalHours No description.
resetIsCaCertificate No description.
resetSetSubjectKeyId 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".

resetEarlyRenewalHours 
public void resetEarlyRenewalHours()
resetIsCaCertificate 
public void resetIsCaCertificate()
resetSetSubjectKeyId 
public void resetSetSubjectKeyId()

Static Functions

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

LocallySignedCert.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.tls.locally_signed_cert.LocallySignedCert;

LocallySignedCert.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.tls.locally_signed_cert.LocallySignedCert;

LocallySignedCert.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.tls.locally_signed_cert.LocallySignedCert;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing LocallySignedCert that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_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 LocallySignedCert 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.
caKeyAlgorithm java.lang.String No description.
certPem java.lang.String No description.
id java.lang.String No description.
readyForRenewal com.hashicorp.cdktf.IResolvable No description.
validityEndTime java.lang.String No description.
validityStartTime java.lang.String No description.
allowedUsesInput java.util.List<java.lang.String> No description.
caCertPemInput java.lang.String No description.
caPrivateKeyPemInput java.lang.String No description.
certRequestPemInput java.lang.String No description.
earlyRenewalHoursInput java.lang.Number No description.
isCaCertificateInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
setSubjectKeyIdInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
validityPeriodHoursInput java.lang.Number No description.
allowedUses java.util.List<java.lang.String> No description.
caCertPem java.lang.String No description.
caPrivateKeyPem java.lang.String No description.
certRequestPem java.lang.String No description.
earlyRenewalHours java.lang.Number No description.
isCaCertificate java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
setSubjectKeyId java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
validityPeriodHours java.lang.Number No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
caKeyAlgorithmRequired 
public java.lang.String getCaKeyAlgorithm();
  • Type: java.lang.String
certPemRequired 
public java.lang.String getCertPem();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
readyForRenewalRequired 
public IResolvable getReadyForRenewal();
  • Type: com.hashicorp.cdktf.IResolvable
validityEndTimeRequired 
public java.lang.String getValidityEndTime();
  • Type: java.lang.String
validityStartTimeRequired 
public java.lang.String getValidityStartTime();
  • Type: java.lang.String
allowedUsesInputOptional 
public java.util.List<java.lang.String> getAllowedUsesInput();
  • Type: java.util.List<java.lang.String>
caCertPemInputOptional 
public java.lang.String getCaCertPemInput();
  • Type: java.lang.String
caPrivateKeyPemInputOptional 
public java.lang.String getCaPrivateKeyPemInput();
  • Type: java.lang.String
certRequestPemInputOptional 
public java.lang.String getCertRequestPemInput();
  • Type: java.lang.String
earlyRenewalHoursInputOptional 
public java.lang.Number getEarlyRenewalHoursInput();
  • Type: java.lang.Number
isCaCertificateInputOptional 
public java.lang.Object getIsCaCertificateInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
setSubjectKeyIdInputOptional 
public java.lang.Object getSetSubjectKeyIdInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
validityPeriodHoursInputOptional 
public java.lang.Number getValidityPeriodHoursInput();
  • Type: java.lang.Number
allowedUsesRequired 
public java.util.List<java.lang.String> getAllowedUses();
  • Type: java.util.List<java.lang.String>
caCertPemRequired 
public java.lang.String getCaCertPem();
  • Type: java.lang.String
caPrivateKeyPemRequired 
public java.lang.String getCaPrivateKeyPem();
  • Type: java.lang.String
certRequestPemRequired 
public java.lang.String getCertRequestPem();
  • Type: java.lang.String
earlyRenewalHoursRequired 
public java.lang.Number getEarlyRenewalHours();
  • Type: java.lang.Number
isCaCertificateRequired 
public java.lang.Object getIsCaCertificate();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
setSubjectKeyIdRequired 
public java.lang.Object getSetSubjectKeyId();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
validityPeriodHoursRequired 
public java.lang.Number getValidityPeriodHours();
  • Type: java.lang.Number

Constants

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

Structs

LocallySignedCertConfig

Initializer 

import com.hashicorp.cdktf.providers.tls.locally_signed_cert.LocallySignedCertConfig;

LocallySignedCertConfig.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>)
    .allowedUses(java.util.List<java.lang.String>)
    .caCertPem(java.lang.String)
    .caPrivateKeyPem(java.lang.String)
    .certRequestPem(java.lang.String)
    .validityPeriodHours(java.lang.Number)
//  .earlyRenewalHours(java.lang.Number)
//  .isCaCertificate(java.lang.Boolean)
//  .isCaCertificate(IResolvable)
//  .setSubjectKeyId(java.lang.Boolean)
//  .setSubjectKeyId(IResolvable)
    .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.
allowedUses java.util.List<java.lang.String> List of key usages allowed for the issued certificate.
caCertPem java.lang.String Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.
caPrivateKeyPem java.lang.String Private key of the Certificate Authority (CA) used to sign the certificate, in PEM (RFC 1421) format.
certRequestPem java.lang.String Certificate request data in PEM (RFC 1421) format.
validityPeriodHours java.lang.Number Number of hours, after initial issuing, that the certificate will remain valid for.
earlyRenewalHours java.lang.Number The resource will consider the certificate to have expired the given number of hours before its actual expiry time.
isCaCertificate java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Is the generated certificate representing a Certificate Authority (CA) (default: false).
setSubjectKeyId java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Should the generated certificate include a subject key identifier (default: false).
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>
allowedUsesRequired 
public java.util.List<java.lang.String> getAllowedUses();
  • Type: java.util.List<java.lang.String>

List of key usages allowed for the issued certificate.

Values are defined in RFC 5280 and combine flags defined by both Key Usages and Extended Key Usages. Accepted values: any_extended, cert_signing, client_auth, code_signing, content_commitment, crl_signing, data_encipherment, decipher_only, digital_signature, email_protection, encipher_only, ipsec_end_system, ipsec_tunnel, ipsec_user, key_agreement, key_encipherment, microsoft_commercial_code_signing, microsoft_kernel_code_signing, microsoft_server_gated_crypto, netscape_server_gated_crypto, ocsp_signing, server_auth, timestamping.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#allowed_uses LocallySignedCert#allowed_uses}

caCertPemRequired 
public java.lang.String getCaCertPem();
  • Type: java.lang.String

Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#ca_cert_pem LocallySignedCert#ca_cert_pem}

caPrivateKeyPemRequired 
public java.lang.String getCaPrivateKeyPem();
  • Type: java.lang.String

Private key of the Certificate Authority (CA) used to sign the certificate, in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#ca_private_key_pem LocallySignedCert#ca_private_key_pem}

certRequestPemRequired 
public java.lang.String getCertRequestPem();
  • Type: java.lang.String

Certificate request data in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#cert_request_pem LocallySignedCert#cert_request_pem}

validityPeriodHoursRequired 
public java.lang.Number getValidityPeriodHours();
  • Type: java.lang.Number

Number of hours, after initial issuing, that the certificate will remain valid for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#validity_period_hours LocallySignedCert#validity_period_hours}

earlyRenewalHoursOptional 
public java.lang.Number getEarlyRenewalHours();
  • Type: java.lang.Number

The resource will consider the certificate to have expired the given number of hours before its actual expiry time.

This can be useful to deploy an updated certificate in advance of the expiration of the current certificate. However, the old certificate remains valid until its true expiration time, since this resource does not (and cannot) support certificate revocation. Also, this advance update can only be performed should the Terraform configuration be applied during the early renewal period. (default: 0)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#early_renewal_hours LocallySignedCert#early_renewal_hours}

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

Is the generated certificate representing a Certificate Authority (CA) (default: false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#is_ca_certificate LocallySignedCert#is_ca_certificate}

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

Should the generated certificate include a subject key identifier (default: false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tls/4.0.5/docs/resources/locally_signed_cert#set_subject_key_id LocallySignedCert#set_subject_key_id}