Skip to content

Latest commit

 

History

History
2312 lines (1442 loc) · 116 KB

gatewayConnectionTunnel.java.md

File metadata and controls

2312 lines (1442 loc) · 116 KB
Raw

gatewayConnectionTunnel Submodule

Constructs

GatewayConnectionTunnel

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

Initializers 

import com.hashicorp.cdktf.providers.upcloud.gateway_connection_tunnel.GatewayConnectionTunnel;

GatewayConnectionTunnel.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>)
    .connectionId(java.lang.String)
    .ipsecAuthPsk(GatewayConnectionTunnelIpsecAuthPsk)
    .localAddressName(java.lang.String)
    .name(java.lang.String)
    .remoteAddress(java.lang.String)
//  .id(java.lang.String)
//  .ipsecProperties(GatewayConnectionTunnelIpsecProperties)
    .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.
connectionId java.lang.String ID of the upcloud_gateway_connection resource to which the tunnel belongs.
ipsecAuthPsk GatewayConnectionTunnelIpsecAuthPsk ipsec_auth_psk block.
localAddressName java.lang.String Public (UpCloud) endpoint address of this tunnel.
name java.lang.String The name of the tunnel, should be unique within the connection.
remoteAddress java.lang.String Remote public IP address of the tunnel.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#id GatewayConnectionTunnel#id}.
ipsecProperties GatewayConnectionTunnelIpsecProperties ipsec_properties block.
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>
connectionIdRequired
  • Type: java.lang.String

ID of the upcloud_gateway_connection resource to which the tunnel belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#connection_id GatewayConnectionTunnel#connection_id}

ipsecAuthPskRequired

ipsec_auth_psk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#ipsec_auth_psk GatewayConnectionTunnel#ipsec_auth_psk}

localAddressNameRequired
  • Type: java.lang.String

Public (UpCloud) endpoint address of this tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#local_address_name GatewayConnectionTunnel#local_address_name}

nameRequired
  • Type: java.lang.String

The name of the tunnel, should be unique within the connection.

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

remoteAddressRequired
  • Type: java.lang.String

Remote public IP address of the tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#remote_address GatewayConnectionTunnel#remote_address}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#id GatewayConnectionTunnel#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

ipsecPropertiesOptional

ipsec_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#ipsec_properties GatewayConnectionTunnel#ipsec_properties}

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".
putIpsecAuthPsk No description.
putIpsecProperties No description.
resetId No description.
resetIpsecProperties 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".

putIpsecAuthPsk 
public void putIpsecAuthPsk(GatewayConnectionTunnelIpsecAuthPsk value)
valueRequired
putIpsecProperties 
public void putIpsecProperties(GatewayConnectionTunnelIpsecProperties value)
valueRequired
resetId 
public void resetId()
resetIpsecProperties 
public void resetIpsecProperties()

Static Functions

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

GatewayConnectionTunnel.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.gateway_connection_tunnel.GatewayConnectionTunnel;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing GatewayConnectionTunnel that should be imported.

Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#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 GatewayConnectionTunnel 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.
ipsecAuthPsk GatewayConnectionTunnelIpsecAuthPskOutputReference No description.
ipsecProperties GatewayConnectionTunnelIpsecPropertiesOutputReference No description.
operationalState java.lang.String No description.
uuid java.lang.String No description.
connectionIdInput java.lang.String No description.
idInput java.lang.String No description.
ipsecAuthPskInput GatewayConnectionTunnelIpsecAuthPsk No description.
ipsecPropertiesInput GatewayConnectionTunnelIpsecProperties No description.
localAddressNameInput java.lang.String No description.
nameInput java.lang.String No description.
remoteAddressInput java.lang.String No description.
connectionId java.lang.String No description.
id java.lang.String No description.
localAddressName java.lang.String No description.
name java.lang.String No description.
remoteAddress 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>
ipsecAuthPskRequired 
public GatewayConnectionTunnelIpsecAuthPskOutputReference getIpsecAuthPsk();
ipsecPropertiesRequired 
public GatewayConnectionTunnelIpsecPropertiesOutputReference getIpsecProperties();
operationalStateRequired 
public java.lang.String getOperationalState();
  • Type: java.lang.String
uuidRequired 
public java.lang.String getUuid();
  • Type: java.lang.String
connectionIdInputOptional 
public java.lang.String getConnectionIdInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
ipsecAuthPskInputOptional 
public GatewayConnectionTunnelIpsecAuthPsk getIpsecAuthPskInput();
ipsecPropertiesInputOptional 
public GatewayConnectionTunnelIpsecProperties getIpsecPropertiesInput();
localAddressNameInputOptional 
public java.lang.String getLocalAddressNameInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
remoteAddressInputOptional 
public java.lang.String getRemoteAddressInput();
  • Type: java.lang.String
connectionIdRequired 
public java.lang.String getConnectionId();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
localAddressNameRequired 
public java.lang.String getLocalAddressName();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
remoteAddressRequired 
public java.lang.String getRemoteAddress();
  • 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

GatewayConnectionTunnelConfig

Initializer 

import com.hashicorp.cdktf.providers.upcloud.gateway_connection_tunnel.GatewayConnectionTunnelConfig;

GatewayConnectionTunnelConfig.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>)
    .connectionId(java.lang.String)
    .ipsecAuthPsk(GatewayConnectionTunnelIpsecAuthPsk)
    .localAddressName(java.lang.String)
    .name(java.lang.String)
    .remoteAddress(java.lang.String)
//  .id(java.lang.String)
//  .ipsecProperties(GatewayConnectionTunnelIpsecProperties)
    .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.
connectionId java.lang.String ID of the upcloud_gateway_connection resource to which the tunnel belongs.
ipsecAuthPsk GatewayConnectionTunnelIpsecAuthPsk ipsec_auth_psk block.
localAddressName java.lang.String Public (UpCloud) endpoint address of this tunnel.
name java.lang.String The name of the tunnel, should be unique within the connection.
remoteAddress java.lang.String Remote public IP address of the tunnel.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#id GatewayConnectionTunnel#id}.
ipsecProperties GatewayConnectionTunnelIpsecProperties ipsec_properties block.
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>
connectionIdRequired 
public java.lang.String getConnectionId();
  • Type: java.lang.String

ID of the upcloud_gateway_connection resource to which the tunnel belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#connection_id GatewayConnectionTunnel#connection_id}

ipsecAuthPskRequired 
public GatewayConnectionTunnelIpsecAuthPsk getIpsecAuthPsk();

ipsec_auth_psk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#ipsec_auth_psk GatewayConnectionTunnel#ipsec_auth_psk}

localAddressNameRequired 
public java.lang.String getLocalAddressName();
  • Type: java.lang.String

Public (UpCloud) endpoint address of this tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#local_address_name GatewayConnectionTunnel#local_address_name}

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

The name of the tunnel, should be unique within the connection.

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

remoteAddressRequired 
public java.lang.String getRemoteAddress();
  • Type: java.lang.String

Remote public IP address of the tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#remote_address GatewayConnectionTunnel#remote_address}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#id GatewayConnectionTunnel#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

ipsecPropertiesOptional 
public GatewayConnectionTunnelIpsecProperties getIpsecProperties();

ipsec_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#ipsec_properties GatewayConnectionTunnel#ipsec_properties}

GatewayConnectionTunnelIpsecAuthPsk

Initializer 

import com.hashicorp.cdktf.providers.upcloud.gateway_connection_tunnel.GatewayConnectionTunnelIpsecAuthPsk;

GatewayConnectionTunnelIpsecAuthPsk.builder()
    .psk(java.lang.String)
    .build();

Properties

Name Type Description
psk java.lang.String The pre-shared key.
pskRequired 
public java.lang.String getPsk();
  • Type: java.lang.String

The pre-shared key.

This value is only used during resource creation and is not returned in the state. It is not possible to update this value. If you need to update it, delete the connection and create a new one.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#psk GatewayConnectionTunnel#psk}

GatewayConnectionTunnelIpsecProperties

Initializer 

import com.hashicorp.cdktf.providers.upcloud.gateway_connection_tunnel.GatewayConnectionTunnelIpsecProperties;

GatewayConnectionTunnelIpsecProperties.builder()
//  .childRekeyTime(java.lang.Number)
//  .dpdDelay(java.lang.Number)
//  .dpdTimeout(java.lang.Number)
//  .ikeLifetime(java.lang.Number)
//  .phase1Algorithms(java.util.List<java.lang.String>)
//  .phase1DhGroupNumbers(java.util.List<java.lang.Number>)
//  .phase1IntegrityAlgorithms(java.util.List<java.lang.String>)
//  .phase2Algorithms(java.util.List<java.lang.String>)
//  .phase2DhGroupNumbers(java.util.List<java.lang.Number>)
//  .phase2IntegrityAlgorithms(java.util.List<java.lang.String>)
//  .rekeyTime(java.lang.Number)
    .build();

Properties

Name Type Description
childRekeyTime java.lang.Number IKE child SA rekey time in seconds.
dpdDelay java.lang.Number Delay before sending Dead Peer Detection packets if no traffic is detected, in seconds.
dpdTimeout java.lang.Number Timeout period for DPD reply before considering the peer to be dead, in seconds.
ikeLifetime java.lang.Number Maximum IKE SA lifetime in seconds.
phase1Algorithms java.util.List<java.lang.String> List of Phase 1: Proposal algorithms.
phase1DhGroupNumbers java.util.List<java.lang.Number> List of Phase 1 Diffie-Hellman group numbers.
phase1IntegrityAlgorithms java.util.List<java.lang.String> List of Phase 1 integrity algorithms.
phase2Algorithms java.util.List<java.lang.String> List of Phase 2: Security Association algorithms.
phase2DhGroupNumbers java.util.List<java.lang.Number> List of Phase 2 Diffie-Hellman group numbers.
phase2IntegrityAlgorithms java.util.List<java.lang.String> List of Phase 2 integrity algorithms.
rekeyTime java.lang.Number IKE SA rekey time in seconds.
childRekeyTimeOptional 
public java.lang.Number getChildRekeyTime();
  • Type: java.lang.Number

IKE child SA rekey time in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#child_rekey_time GatewayConnectionTunnel#child_rekey_time}

dpdDelayOptional 
public java.lang.Number getDpdDelay();
  • Type: java.lang.Number

Delay before sending Dead Peer Detection packets if no traffic is detected, in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#dpd_delay GatewayConnectionTunnel#dpd_delay}

dpdTimeoutOptional 
public java.lang.Number getDpdTimeout();
  • Type: java.lang.Number

Timeout period for DPD reply before considering the peer to be dead, in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#dpd_timeout GatewayConnectionTunnel#dpd_timeout}

ikeLifetimeOptional 
public java.lang.Number getIkeLifetime();
  • Type: java.lang.Number

Maximum IKE SA lifetime in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#ike_lifetime GatewayConnectionTunnel#ike_lifetime}

phase1AlgorithmsOptional 
public java.util.List<java.lang.String> getPhase1Algorithms();
  • Type: java.util.List<java.lang.String>

List of Phase 1: Proposal algorithms.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#phase1_algorithms GatewayConnectionTunnel#phase1_algorithms}

phase1DhGroupNumbersOptional 
public java.util.List<java.lang.Number> getPhase1DhGroupNumbers();
  • Type: java.util.List<java.lang.Number>

List of Phase 1 Diffie-Hellman group numbers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#phase1_dh_group_numbers GatewayConnectionTunnel#phase1_dh_group_numbers}

phase1IntegrityAlgorithmsOptional 
public java.util.List<java.lang.String> getPhase1IntegrityAlgorithms();
  • Type: java.util.List<java.lang.String>

List of Phase 1 integrity algorithms.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#phase1_integrity_algorithms GatewayConnectionTunnel#phase1_integrity_algorithms}

phase2AlgorithmsOptional 
public java.util.List<java.lang.String> getPhase2Algorithms();
  • Type: java.util.List<java.lang.String>

List of Phase 2: Security Association algorithms.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#phase2_algorithms GatewayConnectionTunnel#phase2_algorithms}

phase2DhGroupNumbersOptional 
public java.util.List<java.lang.Number> getPhase2DhGroupNumbers();
  • Type: java.util.List<java.lang.Number>

List of Phase 2 Diffie-Hellman group numbers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#phase2_dh_group_numbers GatewayConnectionTunnel#phase2_dh_group_numbers}

phase2IntegrityAlgorithmsOptional 
public java.util.List<java.lang.String> getPhase2IntegrityAlgorithms();
  • Type: java.util.List<java.lang.String>

List of Phase 2 integrity algorithms.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#phase2_integrity_algorithms GatewayConnectionTunnel#phase2_integrity_algorithms}

rekeyTimeOptional 
public java.lang.Number getRekeyTime();
  • Type: java.lang.Number

IKE SA rekey time in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#rekey_time GatewayConnectionTunnel#rekey_time}

Classes

GatewayConnectionTunnelIpsecAuthPskOutputReference

Initializers 

import com.hashicorp.cdktf.providers.upcloud.gateway_connection_tunnel.GatewayConnectionTunnelIpsecAuthPskOutputReference;

new GatewayConnectionTunnelIpsecAuthPskOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
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.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

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

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.
pskInput java.lang.String No description.
psk java.lang.String No description.
internalValue GatewayConnectionTunnelIpsecAuthPsk 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
pskInputOptional 
public java.lang.String getPskInput();
  • Type: java.lang.String
pskRequired 
public java.lang.String getPsk();
  • Type: java.lang.String
internalValueOptional 
public GatewayConnectionTunnelIpsecAuthPsk getInternalValue();

GatewayConnectionTunnelIpsecPropertiesOutputReference

Initializers 

import com.hashicorp.cdktf.providers.upcloud.gateway_connection_tunnel.GatewayConnectionTunnelIpsecPropertiesOutputReference;

new GatewayConnectionTunnelIpsecPropertiesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
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.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

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.
resetChildRekeyTime No description.
resetDpdDelay No description.
resetDpdTimeout No description.
resetIkeLifetime No description.
resetPhase1Algorithms No description.
resetPhase1DhGroupNumbers No description.
resetPhase1IntegrityAlgorithms No description.
resetPhase2Algorithms No description.
resetPhase2DhGroupNumbers No description.
resetPhase2IntegrityAlgorithms No description.
resetRekeyTime 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.

resetChildRekeyTime 
public void resetChildRekeyTime()
resetDpdDelay 
public void resetDpdDelay()
resetDpdTimeout 
public void resetDpdTimeout()
resetIkeLifetime 
public void resetIkeLifetime()
resetPhase1Algorithms 
public void resetPhase1Algorithms()
resetPhase1DhGroupNumbers 
public void resetPhase1DhGroupNumbers()
resetPhase1IntegrityAlgorithms 
public void resetPhase1IntegrityAlgorithms()
resetPhase2Algorithms 
public void resetPhase2Algorithms()
resetPhase2DhGroupNumbers 
public void resetPhase2DhGroupNumbers()
resetPhase2IntegrityAlgorithms 
public void resetPhase2IntegrityAlgorithms()
resetRekeyTime 
public void resetRekeyTime()

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.
childRekeyTimeInput java.lang.Number No description.
dpdDelayInput java.lang.Number No description.
dpdTimeoutInput java.lang.Number No description.
ikeLifetimeInput java.lang.Number No description.
phase1AlgorithmsInput java.util.List<java.lang.String> No description.
phase1DhGroupNumbersInput java.util.List<java.lang.Number> No description.
phase1IntegrityAlgorithmsInput java.util.List<java.lang.String> No description.
phase2AlgorithmsInput java.util.List<java.lang.String> No description.
phase2DhGroupNumbersInput java.util.List<java.lang.Number> No description.
phase2IntegrityAlgorithmsInput java.util.List<java.lang.String> No description.
rekeyTimeInput java.lang.Number No description.
childRekeyTime java.lang.Number No description.
dpdDelay java.lang.Number No description.
dpdTimeout java.lang.Number No description.
ikeLifetime java.lang.Number No description.
phase1Algorithms java.util.List<java.lang.String> No description.
phase1DhGroupNumbers java.util.List<java.lang.Number> No description.
phase1IntegrityAlgorithms java.util.List<java.lang.String> No description.
phase2Algorithms java.util.List<java.lang.String> No description.
phase2DhGroupNumbers java.util.List<java.lang.Number> No description.
phase2IntegrityAlgorithms java.util.List<java.lang.String> No description.
rekeyTime java.lang.Number No description.
internalValue GatewayConnectionTunnelIpsecProperties 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
childRekeyTimeInputOptional 
public java.lang.Number getChildRekeyTimeInput();
  • Type: java.lang.Number
dpdDelayInputOptional 
public java.lang.Number getDpdDelayInput();
  • Type: java.lang.Number
dpdTimeoutInputOptional 
public java.lang.Number getDpdTimeoutInput();
  • Type: java.lang.Number
ikeLifetimeInputOptional 
public java.lang.Number getIkeLifetimeInput();
  • Type: java.lang.Number
phase1AlgorithmsInputOptional 
public java.util.List<java.lang.String> getPhase1AlgorithmsInput();
  • Type: java.util.List<java.lang.String>
phase1DhGroupNumbersInputOptional 
public java.util.List<java.lang.Number> getPhase1DhGroupNumbersInput();
  • Type: java.util.List<java.lang.Number>
phase1IntegrityAlgorithmsInputOptional 
public java.util.List<java.lang.String> getPhase1IntegrityAlgorithmsInput();
  • Type: java.util.List<java.lang.String>
phase2AlgorithmsInputOptional 
public java.util.List<java.lang.String> getPhase2AlgorithmsInput();
  • Type: java.util.List<java.lang.String>
phase2DhGroupNumbersInputOptional 
public java.util.List<java.lang.Number> getPhase2DhGroupNumbersInput();
  • Type: java.util.List<java.lang.Number>
phase2IntegrityAlgorithmsInputOptional 
public java.util.List<java.lang.String> getPhase2IntegrityAlgorithmsInput();
  • Type: java.util.List<java.lang.String>
rekeyTimeInputOptional 
public java.lang.Number getRekeyTimeInput();
  • Type: java.lang.Number
childRekeyTimeRequired 
public java.lang.Number getChildRekeyTime();
  • Type: java.lang.Number
dpdDelayRequired 
public java.lang.Number getDpdDelay();
  • Type: java.lang.Number
dpdTimeoutRequired 
public java.lang.Number getDpdTimeout();
  • Type: java.lang.Number
ikeLifetimeRequired 
public java.lang.Number getIkeLifetime();
  • Type: java.lang.Number
phase1AlgorithmsRequired 
public java.util.List<java.lang.String> getPhase1Algorithms();
  • Type: java.util.List<java.lang.String>
phase1DhGroupNumbersRequired 
public java.util.List<java.lang.Number> getPhase1DhGroupNumbers();
  • Type: java.util.List<java.lang.Number>
phase1IntegrityAlgorithmsRequired 
public java.util.List<java.lang.String> getPhase1IntegrityAlgorithms();
  • Type: java.util.List<java.lang.String>
phase2AlgorithmsRequired 
public java.util.List<java.lang.String> getPhase2Algorithms();
  • Type: java.util.List<java.lang.String>
phase2DhGroupNumbersRequired 
public java.util.List<java.lang.Number> getPhase2DhGroupNumbers();
  • Type: java.util.List<java.lang.Number>
phase2IntegrityAlgorithmsRequired 
public java.util.List<java.lang.String> getPhase2IntegrityAlgorithms();
  • Type: java.util.List<java.lang.String>
rekeyTimeRequired 
public java.lang.Number getRekeyTime();
  • Type: java.lang.Number
internalValueOptional 
public GatewayConnectionTunnelIpsecProperties getInternalValue();