`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

using HashiCorp.Cdktf.Providers.Tls;

new LocallySignedCert(Construct Scope, string Id, LocallySignedCertConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`LocallySignedCertConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: LocallySignedCertConfig

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`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(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.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

Type: object

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

`MoveToId`

private void MoveToId(string Id)

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

`Id`^Required

Type: string

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

`ResetEarlyRenewalHours`

private void ResetEarlyRenewalHours()

`ResetIsCaCertificate`

private void ResetIsCaCertificate()

`ResetSetSubjectKeyId`

private 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`

using HashiCorp.Cdktf.Providers.Tls;

LocallySignedCert.IsConstruct(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.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Tls;

LocallySignedCert.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Tls;

LocallySignedCert.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Tls;

LocallySignedCert.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

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

`ImportFromId`^Required

Type: 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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`CaKeyAlgorithm`	`string`	No description.
`CertPem`	`string`	No description.
`Id`	`string`	No description.
`ReadyForRenewal`	`HashiCorp.Cdktf.IResolvable`	No description.
`ValidityEndTime`	`string`	No description.
`ValidityStartTime`	`string`	No description.
`AllowedUsesInput`	`string[]`	No description.
`CaCertPemInput`	`string`	No description.
`CaPrivateKeyPemInput`	`string`	No description.
`CertRequestPemInput`	`string`	No description.
`EarlyRenewalHoursInput`	`double`	No description.
`IsCaCertificateInput`	`object`	No description.
`SetSubjectKeyIdInput`	`object`	No description.
`ValidityPeriodHoursInput`	`double`	No description.
`AllowedUses`	`string[]`	No description.
`CaCertPem`	`string`	No description.
`CaPrivateKeyPem`	`string`	No description.
`CertRequestPem`	`string`	No description.
`EarlyRenewalHours`	`double`	No description.
`IsCaCertificate`	`object`	No description.
`SetSubjectKeyId`	`object`	No description.
`ValidityPeriodHours`	`double`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`CaKeyAlgorithm`^Required

public string CaKeyAlgorithm { get; }

Type: string

`CertPem`^Required

public string CertPem { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`ReadyForRenewal`^Required

public IResolvable ReadyForRenewal { get; }

Type: HashiCorp.Cdktf.IResolvable

`ValidityEndTime`^Required

public string ValidityEndTime { get; }

Type: string

`ValidityStartTime`^Required

public string ValidityStartTime { get; }

Type: string

`AllowedUsesInput`^Optional

public string[] AllowedUsesInput { get; }

Type: string[]

`CaCertPemInput`^Optional

public string CaCertPemInput { get; }

Type: string

`CaPrivateKeyPemInput`^Optional

public string CaPrivateKeyPemInput { get; }

Type: string

`CertRequestPemInput`^Optional

public string CertRequestPemInput { get; }

Type: string

`EarlyRenewalHoursInput`^Optional

public double EarlyRenewalHoursInput { get; }

Type: double

`IsCaCertificateInput`^Optional

public object IsCaCertificateInput { get; }

Type: object

`SetSubjectKeyIdInput`^Optional

public object SetSubjectKeyIdInput { get; }

Type: object

`ValidityPeriodHoursInput`^Optional

public double ValidityPeriodHoursInput { get; }

Type: double

`AllowedUses`^Required

public string[] AllowedUses { get; }

Type: string[]

`CaCertPem`^Required

public string CaCertPem { get; }

Type: string

`CaPrivateKeyPem`^Required

public string CaPrivateKeyPem { get; }

Type: string

`CertRequestPem`^Required

public string CertRequestPem { get; }

Type: string

`EarlyRenewalHours`^Required

public double EarlyRenewalHours { get; }

Type: double

`IsCaCertificate`^Required

public object IsCaCertificate { get; }

Type: object

`SetSubjectKeyId`^Required

public object SetSubjectKeyId { get; }

Type: object

`ValidityPeriodHours`^Required

public double ValidityPeriodHours { get; }

Type: double

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

LocallySignedCertConfig

Initializer

using HashiCorp.Cdktf.Providers.Tls;

new LocallySignedCertConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string[] AllowedUses,
    string CaCertPem,
    string CaPrivateKeyPem,
    string CertRequestPem,
    double ValidityPeriodHours,
    double EarlyRenewalHours = null,
    object IsCaCertificate = null,
    object SetSubjectKeyId = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`AllowedUses`	`string[]`	List of key usages allowed for the issued certificate.
`CaCertPem`	`string`	Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.
`CaPrivateKeyPem`	`string`	Private key of the Certificate Authority (CA) used to sign the certificate, in PEM (RFC 1421) format.
`CertRequestPem`	`string`	Certificate request data in PEM (RFC 1421) format.
`ValidityPeriodHours`	`double`	Number of hours, after initial issuing, that the certificate will remain valid for.
`EarlyRenewalHours`	`double`	The resource will consider the certificate to have expired the given number of hours before its actual expiry time.
`IsCaCertificate`	`object`	Is the generated certificate representing a Certificate Authority (CA) (default: `false`).
`SetSubjectKeyId`	`object`	Should the generated certificate include a subject key identifier (default: `false`).

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`AllowedUses`^Required

public string[] AllowedUses { get; set; }

Type: 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}

`CaCertPem`^Required

public string CaCertPem { get; set; }

Type: 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}

`CaPrivateKeyPem`^Required

public string CaPrivateKeyPem { get; set; }

Type: 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}

`CertRequestPem`^Required

public string CertRequestPem { get; set; }

Type: 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}

`ValidityPeriodHours`^Required

public double ValidityPeriodHours { get; set; }

Type: double

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}

`EarlyRenewalHours`^Optional

public double EarlyRenewalHours { get; set; }

Type: double

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}

`IsCaCertificate`^Optional

public object IsCaCertificate { get; set; }

Type: object

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}

`SetSubjectKeyId`^Optional

public object SetSubjectKeyId { get; set; }

Type: object

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}

Files

locallySignedCert.csharp.md

Latest commit

History

locallySignedCert.csharp.md

File metadata and controls

locallySignedCert Submodule

Constructs