Skip to content

Latest commit

 

History

History
2220 lines (1389 loc) · 107 KB

loadbalancerBackend.java.md

File metadata and controls

2220 lines (1389 loc) · 107 KB
Raw

loadbalancerBackend Submodule

Constructs

LoadbalancerBackend

Represents a {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend upcloud_loadbalancer_backend}.

Initializers 

import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackend;

LoadbalancerBackend.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>)
    .loadbalancer(java.lang.String)
    .name(java.lang.String)
//  .properties(IResolvable)
//  .properties(java.util.List<LoadbalancerBackendProperties>)
//  .resolverName(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.
loadbalancer java.lang.String UUID of the load balancer to which the backend is connected.
name java.lang.String The name of the backend. Must be unique within the load balancer service.
properties com.hashicorp.cdktf.IResolvable OR java.util.List<LoadbalancerBackendProperties> properties block.
resolverName java.lang.String Domain name resolver used with dynamic type members.
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>
loadbalancerRequired
  • Type: java.lang.String

UUID of the load balancer to which the backend is connected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#loadbalancer LoadbalancerBackend#loadbalancer}

nameRequired
  • Type: java.lang.String

The name of the backend. Must be unique within the load balancer service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#name LoadbalancerBackend#name}

propertiesOptional

properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#properties LoadbalancerBackend#properties}

resolverNameOptional
  • Type: java.lang.String

Domain name resolver used with dynamic type members.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#resolver_name LoadbalancerBackend#resolver_name}

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".
putProperties No description.
resetProperties No description.
resetResolverName 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".

putProperties 
public void putProperties(IResolvable OR java.util.List<LoadbalancerBackendProperties> value)
valueRequired
resetProperties 
public void resetProperties()
resetResolverName 
public void resetResolverName()

Static Functions

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

LoadbalancerBackend.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.upcloud.loadbalancer_backend.LoadbalancerBackend;

LoadbalancerBackend.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackend;

LoadbalancerBackend.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackend;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing LoadbalancerBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#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 LoadbalancerBackend 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.
id java.lang.String No description.
members java.util.List<java.lang.String> No description.
properties LoadbalancerBackendPropertiesList No description.
tlsConfigs java.util.List<java.lang.String> No description.
loadbalancerInput java.lang.String No description.
nameInput java.lang.String No description.
propertiesInput com.hashicorp.cdktf.IResolvable OR java.util.List<LoadbalancerBackendProperties> No description.
resolverNameInput java.lang.String No description.
loadbalancer java.lang.String No description.
name java.lang.String No description.
resolverName 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>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
membersRequired 
public java.util.List<java.lang.String> getMembers();
  • Type: java.util.List<java.lang.String>
propertiesRequired 
public LoadbalancerBackendPropertiesList getProperties();
tlsConfigsRequired 
public java.util.List<java.lang.String> getTlsConfigs();
  • Type: java.util.List<java.lang.String>
loadbalancerInputOptional 
public java.lang.String getLoadbalancerInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
propertiesInputOptional 
public java.lang.Object getPropertiesInput();
resolverNameInputOptional 
public java.lang.String getResolverNameInput();
  • Type: java.lang.String
loadbalancerRequired 
public java.lang.String getLoadbalancer();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
resolverNameRequired 
public java.lang.String getResolverName();
  • Type: java.lang.String

Constants

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

Structs

LoadbalancerBackendConfig

Initializer 

import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackendConfig;

LoadbalancerBackendConfig.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>)
    .loadbalancer(java.lang.String)
    .name(java.lang.String)
//  .properties(IResolvable)
//  .properties(java.util.List<LoadbalancerBackendProperties>)
//  .resolverName(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.
loadbalancer java.lang.String UUID of the load balancer to which the backend is connected.
name java.lang.String The name of the backend. Must be unique within the load balancer service.
properties com.hashicorp.cdktf.IResolvable OR java.util.List<LoadbalancerBackendProperties> properties block.
resolverName java.lang.String Domain name resolver used with dynamic type members.
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>
loadbalancerRequired 
public java.lang.String getLoadbalancer();
  • Type: java.lang.String

UUID of the load balancer to which the backend is connected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#loadbalancer LoadbalancerBackend#loadbalancer}

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

The name of the backend. Must be unique within the load balancer service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#name LoadbalancerBackend#name}

propertiesOptional 
public java.lang.Object getProperties();

properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#properties LoadbalancerBackend#properties}

resolverNameOptional 
public java.lang.String getResolverName();
  • Type: java.lang.String

Domain name resolver used with dynamic type members.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#resolver_name LoadbalancerBackend#resolver_name}

LoadbalancerBackendProperties

Initializer 

import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackendProperties;

LoadbalancerBackendProperties.builder()
//  .healthCheckExpectedStatus(java.lang.Number)
//  .healthCheckFall(java.lang.Number)
//  .healthCheckInterval(java.lang.Number)
//  .healthCheckRise(java.lang.Number)
//  .healthCheckTlsVerify(java.lang.Boolean)
//  .healthCheckTlsVerify(IResolvable)
//  .healthCheckType(java.lang.String)
//  .healthCheckUrl(java.lang.String)
//  .http2Enabled(java.lang.Boolean)
//  .http2Enabled(IResolvable)
//  .outboundProxyProtocol(java.lang.String)
//  .stickySessionCookieName(java.lang.String)
//  .timeoutServer(java.lang.Number)
//  .timeoutTunnel(java.lang.Number)
//  .tlsEnabled(java.lang.Boolean)
//  .tlsEnabled(IResolvable)
//  .tlsUseSystemCa(java.lang.Boolean)
//  .tlsUseSystemCa(IResolvable)
//  .tlsVerify(java.lang.Boolean)
//  .tlsVerify(IResolvable)
    .build();

Properties

Name Type Description
healthCheckExpectedStatus java.lang.Number Expected HTTP status code returned by the customer application to mark server as healthy. Ignored for tcp health_check_type.
healthCheckFall java.lang.Number Sets how many failed health checks are allowed until the backend member is taken off from the rotation.
healthCheckInterval java.lang.Number Interval between health checks in seconds.
healthCheckRise java.lang.Number Sets how many successful health checks are required to put the backend member back into rotation.
healthCheckTlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables certificate verification with the system CA certificate bundle. Works with https scheme in health_check_url, otherwise ignored.
healthCheckType java.lang.String Health check type.
healthCheckUrl java.lang.String Target path for health check HTTP GET requests. Ignored for tcp health_check_type.
http2Enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Allow HTTP/2 connections to backend members by utilizing ALPN extension of TLS protocol, therefore it can only be enabled when tls_enabled is set to true.
outboundProxyProtocol java.lang.String Enable outbound proxy protocol by setting the desired version. Defaults to empty string. Empty string disables proxy protocol.
stickySessionCookieName java.lang.String Sets sticky session cookie name. Empty string disables sticky session.
timeoutServer java.lang.Number Backend server timeout in seconds.
timeoutTunnel java.lang.Number Maximum inactivity time on the client and server side for tunnels in seconds.
tlsEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables TLS connection from the load balancer to backend servers.
tlsUseSystemCa java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If enabled, then the system CA certificate bundle will be used for the certificate verification.
tlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables backend servers certificate verification.
healthCheckExpectedStatusOptional 
public java.lang.Number getHealthCheckExpectedStatus();
  • Type: java.lang.Number

Expected HTTP status code returned by the customer application to mark server as healthy. Ignored for tcp health_check_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_expected_status LoadbalancerBackend#health_check_expected_status}

healthCheckFallOptional 
public java.lang.Number getHealthCheckFall();
  • Type: java.lang.Number

Sets how many failed health checks are allowed until the backend member is taken off from the rotation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_fall LoadbalancerBackend#health_check_fall}

healthCheckIntervalOptional 
public java.lang.Number getHealthCheckInterval();
  • Type: java.lang.Number

Interval between health checks in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_interval LoadbalancerBackend#health_check_interval}

healthCheckRiseOptional 
public java.lang.Number getHealthCheckRise();
  • Type: java.lang.Number

Sets how many successful health checks are required to put the backend member back into rotation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_rise LoadbalancerBackend#health_check_rise}

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

Enables certificate verification with the system CA certificate bundle. Works with https scheme in health_check_url, otherwise ignored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_tls_verify LoadbalancerBackend#health_check_tls_verify}

healthCheckTypeOptional 
public java.lang.String getHealthCheckType();
  • Type: java.lang.String

Health check type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_type LoadbalancerBackend#health_check_type}

healthCheckUrlOptional 
public java.lang.String getHealthCheckUrl();
  • Type: java.lang.String

Target path for health check HTTP GET requests. Ignored for tcp health_check_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#health_check_url LoadbalancerBackend#health_check_url}

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

Allow HTTP/2 connections to backend members by utilizing ALPN extension of TLS protocol, therefore it can only be enabled when tls_enabled is set to true.

Note: members should support HTTP/2 for this setting to work.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#http2_enabled LoadbalancerBackend#http2_enabled}

outboundProxyProtocolOptional 
public java.lang.String getOutboundProxyProtocol();
  • Type: java.lang.String

Enable outbound proxy protocol by setting the desired version. Defaults to empty string. Empty string disables proxy protocol.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#outbound_proxy_protocol LoadbalancerBackend#outbound_proxy_protocol}

stickySessionCookieNameOptional 
public java.lang.String getStickySessionCookieName();
  • Type: java.lang.String

Sets sticky session cookie name. Empty string disables sticky session.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#sticky_session_cookie_name LoadbalancerBackend#sticky_session_cookie_name}

timeoutServerOptional 
public java.lang.Number getTimeoutServer();
  • Type: java.lang.Number

Backend server timeout in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#timeout_server LoadbalancerBackend#timeout_server}

timeoutTunnelOptional 
public java.lang.Number getTimeoutTunnel();
  • Type: java.lang.Number

Maximum inactivity time on the client and server side for tunnels in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#timeout_tunnel LoadbalancerBackend#timeout_tunnel}

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

Enables TLS connection from the load balancer to backend servers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#tls_enabled LoadbalancerBackend#tls_enabled}

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

If enabled, then the system CA certificate bundle will be used for the certificate verification.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#tls_use_system_ca LoadbalancerBackend#tls_use_system_ca}

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

Enables backend servers certificate verification.

Please make sure that TLS config with the certificate bundle of type authority attached to the backend or tls_use_system_ca enabled. Note: tls_verify has preference over health_check_tls_verify when tls_enabled in true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/loadbalancer_backend#tls_verify LoadbalancerBackend#tls_verify}

Classes

LoadbalancerBackendPropertiesList

Initializers 

import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackendPropertiesList;

new LoadbalancerBackendPropertiesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public LoadbalancerBackendPropertiesOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<LoadbalancerBackendProperties> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

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

LoadbalancerBackendPropertiesOutputReference

Initializers 

import com.hashicorp.cdktf.providers.upcloud.loadbalancer_backend.LoadbalancerBackendPropertiesOutputReference;

new LoadbalancerBackendPropertiesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetHealthCheckExpectedStatus No description.
resetHealthCheckFall No description.
resetHealthCheckInterval No description.
resetHealthCheckRise No description.
resetHealthCheckTlsVerify No description.
resetHealthCheckType No description.
resetHealthCheckUrl No description.
resetHttp2Enabled No description.
resetOutboundProxyProtocol No description.
resetStickySessionCookieName No description.
resetTimeoutServer No description.
resetTimeoutTunnel No description.
resetTlsEnabled No description.
resetTlsUseSystemCa No description.
resetTlsVerify No description.
computeFqn 
public java.lang.String computeFqn()
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
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetHealthCheckExpectedStatus 
public void resetHealthCheckExpectedStatus()
resetHealthCheckFall 
public void resetHealthCheckFall()
resetHealthCheckInterval 
public void resetHealthCheckInterval()
resetHealthCheckRise 
public void resetHealthCheckRise()
resetHealthCheckTlsVerify 
public void resetHealthCheckTlsVerify()
resetHealthCheckType 
public void resetHealthCheckType()
resetHealthCheckUrl 
public void resetHealthCheckUrl()
resetHttp2Enabled 
public void resetHttp2Enabled()
resetOutboundProxyProtocol 
public void resetOutboundProxyProtocol()
resetStickySessionCookieName 
public void resetStickySessionCookieName()
resetTimeoutServer 
public void resetTimeoutServer()
resetTimeoutTunnel 
public void resetTimeoutTunnel()
resetTlsEnabled 
public void resetTlsEnabled()
resetTlsUseSystemCa 
public void resetTlsUseSystemCa()
resetTlsVerify 
public void resetTlsVerify()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
healthCheckExpectedStatusInput java.lang.Number No description.
healthCheckFallInput java.lang.Number No description.
healthCheckIntervalInput java.lang.Number No description.
healthCheckRiseInput java.lang.Number No description.
healthCheckTlsVerifyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
healthCheckTypeInput java.lang.String No description.
healthCheckUrlInput java.lang.String No description.
http2EnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
outboundProxyProtocolInput java.lang.String No description.
stickySessionCookieNameInput java.lang.String No description.
timeoutServerInput java.lang.Number No description.
timeoutTunnelInput java.lang.Number No description.
tlsEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tlsUseSystemCaInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tlsVerifyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
healthCheckExpectedStatus java.lang.Number No description.
healthCheckFall java.lang.Number No description.
healthCheckInterval java.lang.Number No description.
healthCheckRise java.lang.Number No description.
healthCheckTlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
healthCheckType java.lang.String No description.
healthCheckUrl java.lang.String No description.
http2Enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
outboundProxyProtocol java.lang.String No description.
stickySessionCookieName java.lang.String No description.
timeoutServer java.lang.Number No description.
timeoutTunnel java.lang.Number No description.
tlsEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tlsUseSystemCa java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue com.hashicorp.cdktf.IResolvable OR LoadbalancerBackendProperties No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
healthCheckExpectedStatusInputOptional 
public java.lang.Number getHealthCheckExpectedStatusInput();
  • Type: java.lang.Number
healthCheckFallInputOptional 
public java.lang.Number getHealthCheckFallInput();
  • Type: java.lang.Number
healthCheckIntervalInputOptional 
public java.lang.Number getHealthCheckIntervalInput();
  • Type: java.lang.Number
healthCheckRiseInputOptional 
public java.lang.Number getHealthCheckRiseInput();
  • Type: java.lang.Number
healthCheckTlsVerifyInputOptional 
public java.lang.Object getHealthCheckTlsVerifyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
healthCheckTypeInputOptional 
public java.lang.String getHealthCheckTypeInput();
  • Type: java.lang.String
healthCheckUrlInputOptional 
public java.lang.String getHealthCheckUrlInput();
  • Type: java.lang.String
http2EnabledInputOptional 
public java.lang.Object getHttp2EnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
outboundProxyProtocolInputOptional 
public java.lang.String getOutboundProxyProtocolInput();
  • Type: java.lang.String
stickySessionCookieNameInputOptional 
public java.lang.String getStickySessionCookieNameInput();
  • Type: java.lang.String
timeoutServerInputOptional 
public java.lang.Number getTimeoutServerInput();
  • Type: java.lang.Number
timeoutTunnelInputOptional 
public java.lang.Number getTimeoutTunnelInput();
  • Type: java.lang.Number
tlsEnabledInputOptional 
public java.lang.Object getTlsEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tlsUseSystemCaInputOptional 
public java.lang.Object getTlsUseSystemCaInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tlsVerifyInputOptional 
public java.lang.Object getTlsVerifyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
healthCheckExpectedStatusRequired 
public java.lang.Number getHealthCheckExpectedStatus();
  • Type: java.lang.Number
healthCheckFallRequired 
public java.lang.Number getHealthCheckFall();
  • Type: java.lang.Number
healthCheckIntervalRequired 
public java.lang.Number getHealthCheckInterval();
  • Type: java.lang.Number
healthCheckRiseRequired 
public java.lang.Number getHealthCheckRise();
  • Type: java.lang.Number
healthCheckTlsVerifyRequired 
public java.lang.Object getHealthCheckTlsVerify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
healthCheckTypeRequired 
public java.lang.String getHealthCheckType();
  • Type: java.lang.String
healthCheckUrlRequired 
public java.lang.String getHealthCheckUrl();
  • Type: java.lang.String
http2EnabledRequired 
public java.lang.Object getHttp2Enabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
outboundProxyProtocolRequired 
public java.lang.String getOutboundProxyProtocol();
  • Type: java.lang.String
stickySessionCookieNameRequired 
public java.lang.String getStickySessionCookieName();
  • Type: java.lang.String
timeoutServerRequired 
public java.lang.Number getTimeoutServer();
  • Type: java.lang.Number
timeoutTunnelRequired 
public java.lang.Number getTimeoutTunnel();
  • Type: java.lang.Number
tlsEnabledRequired 
public java.lang.Object getTlsEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tlsUseSystemCaRequired 
public java.lang.Object getTlsUseSystemCa();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tlsVerifyRequired 
public java.lang.Object getTlsVerify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
internalValueOptional 
public java.lang.Object getInternalValue();