Java: HttpBackend

CDKTN Core API Reference for HttpBackend in Java.

Initializers

import io.cdktn.cdktn.HttpBackend;

HttpBackend.Builder.create(Construct scope)
    .address(java.lang.String)
//  .clientCaCertificatePem(java.lang.String)
//  .clientCertificatePem(java.lang.String)
//  .clientPrivateKeyPem(java.lang.String)
//  .lockAddress(java.lang.String)
//  .lockMethod(java.lang.String)
//  .password(java.lang.String)
//  .retryMax(java.lang.Number)
//  .retryWaitMax(java.lang.Number)
//  .retryWaitMin(java.lang.Number)
//  .skipCertVerification(java.lang.Boolean)
//  .unlockAddress(java.lang.String)
//  .unlockMethod(java.lang.String)
//  .updateMethod(java.lang.String)
//  .username(java.lang.String)
    .build();

Name	Type	Description
scope	software.constructs.Construct	No description.
address	java.lang.String	(Required) The address of the REST endpoint.
clientCaCertificatePem	java.lang.String	(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePem	java.lang.String	(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPem	java.lang.String	(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddress	java.lang.String	(Optional) The address of the lock REST endpoint.
lockMethod	java.lang.String	(Optional) The HTTP method to use when locking.
password	java.lang.String	(Optional) The password for HTTP basic authentication.
retryMax	java.lang.Number	(Optional) The number of HTTP request retries.
retryWaitMax	java.lang.Number	(Optional) The maximum time in seconds to wait between HTTP request attempts.
retryWaitMin	java.lang.Number	(Optional) The minimum time in seconds to wait between HTTP request attempts.
skipCertVerification	java.lang.Boolean	(Optional) Whether to skip TLS verification.
unlockAddress	java.lang.String	(Optional) The address of the unlock REST endpoint.
unlockMethod	java.lang.String	(Optional) The HTTP method to use when unlocking.
updateMethod	java.lang.String	(Optional) HTTP method to use when updating state.
username	java.lang.String	(Optional) The username for HTTP basic authentication.

---

scope^Required

• Type: software.constructs.Construct

---

address^Required

• Type: java.lang.String

(Required) The address of the REST endpoint.

---

clientCaCertificatePem^Optional

• Type: java.lang.String

(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

---

clientCertificatePem^Optional

• Type: java.lang.String

(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

---

clientPrivateKeyPem^Optional

• Type: java.lang.String

(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

---

lockAddress^Optional

• Type: java.lang.String

(Optional) The address of the lock REST endpoint.

Defaults to disabled.

---

lockMethod^Optional

• Type: java.lang.String

(Optional) The HTTP method to use when locking.

Defaults to LOCK.

---

password^Optional

• Type: java.lang.String

(Optional) The password for HTTP basic authentication.

---

retryMax^Optional

• Type: java.lang.Number

(Optional) The number of HTTP request retries.

Defaults to 2.

---

retryWaitMax^Optional

• Type: java.lang.Number

(Optional) The maximum time in seconds to wait between HTTP request attempts.

Defaults to 30.

---

retryWaitMin^Optional

• Type: java.lang.Number

(Optional) The minimum time in seconds to wait between HTTP request attempts.

Defaults to 1.

---

skipCertVerification^Optional

• Type: java.lang.Boolean

(Optional) Whether to skip TLS verification.

Defaults to false.

---

unlockAddress^Optional

• Type: java.lang.String

(Optional) The address of the unlock REST endpoint.

Defaults to disabled.

---

unlockMethod^Optional

• Type: java.lang.String

(Optional) The HTTP method to use when unlocking.

Defaults to UNLOCK.

---

updateMethod^Optional

• Type: java.lang.String

(Optional) HTTP method to use when updating state.

Defaults to POST.

---

username^Optional

• Type: java.lang.String

(Optional) The username for HTTP basic authentication.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to 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.
getRemoteStateDataSource	Creates a TerraformRemoteState resource that accesses this backend.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

with

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: software.constructs.IMixin…

The mixins to apply.

---

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

path^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

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

getRemoteStateDataSource

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: software.constructs.Construct

---

name^Required

• Type: java.lang.String

---

_fromStack^Required

• Type: java.lang.String

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isBackend	No description.

---

isConstruct

import io.cdktn.cdktn.HttpBackend;

HttpBackend.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.

x^Required

• Type: java.lang.Object

Any object.

---

isTerraformElement

import io.cdktn.cdktn.HttpBackend;

HttpBackend.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

---

isBackend

import io.cdktn.cdktn.HttpBackend;

HttpBackend.isBackend(java.lang.Object x)

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	software.constructs.Node	The tree node.
cdktfStack	TerraformStack	No description.
fqn	java.lang.String	No description.
friendlyUniqueId	java.lang.String	No description.

---

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

---

cdktfStack^Required

public TerraformStack getCdktfStack();

• Type: TerraformStack

---

fqn^Required

public java.lang.String getFqn();

• Type: java.lang.String

---

friendlyUniqueId^Required

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

---