Skip to main content

Initializer

import { DataTerraformRemoteStateHttpConfig } from 'cdktn'

const dataTerraformRemoteStateHttpConfig: DataTerraformRemoteStateHttpConfig = { ... }

Properties

NameTypeDescription
defaults{[ key: string ]: any}No description.
workspacestringNo description.
addressstring(Required) The address of the REST endpoint.
clientCaCertificatePemstring(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePemstring(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPemstring(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddressstring(Optional) The address of the lock REST endpoint.
lockMethodstring(Optional) The HTTP method to use when locking.
passwordstring(Optional) The password for HTTP basic authentication.
retryMaxnumber(Optional) The number of HTTP request retries.
retryWaitMaxnumber(Optional) The maximum time in seconds to wait between HTTP request attempts.
retryWaitMinnumber(Optional) The minimum time in seconds to wait between HTTP request attempts.
skipCertVerificationboolean(Optional) Whether to skip TLS verification.
unlockAddressstring(Optional) The address of the unlock REST endpoint.
unlockMethodstring(Optional) The HTTP method to use when unlocking.
updateMethodstring(Optional) HTTP method to use when updating state.
usernamestring(Optional) The username for HTTP basic authentication.

defaultsOptional

public readonly defaults: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

workspaceOptional

public readonly workspace: string;
  • Type: string

addressRequired

public readonly address: string;
  • Type: string
(Required) The address of the REST endpoint.

clientCaCertificatePemOptional

public readonly clientCaCertificatePem: string;
  • Type: string
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

clientCertificatePemOptional

public readonly clientCertificatePem: string;
  • Type: string
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

clientPrivateKeyPemOptional

public readonly clientPrivateKeyPem: string;
  • Type: string
(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

lockAddressOptional

public readonly lockAddress: string;
  • Type: string
(Optional) The address of the lock REST endpoint. Defaults to disabled.

lockMethodOptional

public readonly lockMethod: string;
  • Type: string
(Optional) The HTTP method to use when locking. Defaults to LOCK.

passwordOptional

public readonly password: string;
  • Type: string
(Optional) The password for HTTP basic authentication.

retryMaxOptional

public readonly retryMax: number;
  • Type: number
(Optional) The number of HTTP request retries. Defaults to 2.

retryWaitMaxOptional

public readonly retryWaitMax: number;
  • Type: number
(Optional) The maximum time in seconds to wait between HTTP request attempts. Defaults to 30.

retryWaitMinOptional

public readonly retryWaitMin: number;
  • Type: number
(Optional) The minimum time in seconds to wait between HTTP request attempts. Defaults to 1.

skipCertVerificationOptional

public readonly skipCertVerification: boolean;
  • Type: boolean
(Optional) Whether to skip TLS verification. Defaults to false.

unlockAddressOptional

public readonly unlockAddress: string;
  • Type: string
(Optional) The address of the unlock REST endpoint. Defaults to disabled.

unlockMethodOptional

public readonly unlockMethod: string;
  • Type: string
(Optional) The HTTP method to use when unlocking. Defaults to UNLOCK.

updateMethodOptional

public readonly updateMethod: string;
  • Type: string
(Optional) HTTP method to use when updating state. Defaults to POST.

usernameOptional

public readonly username: string;
  • Type: string
(Optional) The username for HTTP basic authentication.