Skip to content

Latest commit

 

History

History
2526 lines (1601 loc) · 118 KB

gatewayConnectionTunnel.python.md

File metadata and controls

2526 lines (1601 loc) · 118 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 

from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnel(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  connection_id: str,
  ipsec_auth_psk: GatewayConnectionTunnelIpsecAuthPsk,
  local_address_name: str,
  name: str,
  remote_address: str,
  id: str = None,
  ipsec_properties: GatewayConnectionTunnelIpsecProperties = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
connection_id str ID of the upcloud_gateway_connection resource to which the tunnel belongs.
ipsec_auth_psk GatewayConnectionTunnelIpsecAuthPsk ipsec_auth_psk block.
local_address_name str Public (UpCloud) endpoint address of this tunnel.
name str The name of the tunnel, should be unique within the connection.
remote_address str Remote public IP address of the tunnel.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#id GatewayConnectionTunnel#id}.
ipsec_properties GatewayConnectionTunnelIpsecProperties ipsec_properties block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
connection_idRequired
  • Type: str

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}

ipsec_auth_pskRequired

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}

local_address_nameRequired
  • Type: str

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

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}

remote_addressRequired
  • Type: str

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

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.

ipsec_propertiesOptional

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
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_ipsec_auth_psk No description.
put_ipsec_properties No description.
reset_id No description.
reset_ipsec_properties No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

put_ipsec_auth_psk 
def put_ipsec_auth_psk(
  psk: str
) -> None
pskRequired
  • Type: str

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}

put_ipsec_properties 
def put_ipsec_properties(
  child_rekey_time: typing.Union[int, float] = None,
  dpd_delay: typing.Union[int, float] = None,
  dpd_timeout: typing.Union[int, float] = None,
  ike_lifetime: typing.Union[int, float] = None,
  phase1_algorithms: typing.List[str] = None,
  phase1_dh_group_numbers: typing.List[typing.Union[int, float]] = None,
  phase1_integrity_algorithms: typing.List[str] = None,
  phase2_algorithms: typing.List[str] = None,
  phase2_dh_group_numbers: typing.List[typing.Union[int, float]] = None,
  phase2_integrity_algorithms: typing.List[str] = None,
  rekey_time: typing.Union[int, float] = None
) -> None
child_rekey_timeOptional
  • Type: typing.Union[int, float]

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}

dpd_delayOptional
  • Type: typing.Union[int, float]

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}

dpd_timeoutOptional
  • Type: typing.Union[int, float]

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}

ike_lifetimeOptional
  • Type: typing.Union[int, float]

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}

phase1_algorithmsOptional
  • Type: typing.List[str]

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}

phase1_dh_group_numbersOptional
  • Type: typing.List[typing.Union[int, float]]

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}

phase1_integrity_algorithmsOptional
  • Type: typing.List[str]

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}

phase2_algorithmsOptional
  • Type: typing.List[str]

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}

phase2_dh_group_numbersOptional
  • Type: typing.List[typing.Union[int, float]]

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}

phase2_integrity_algorithmsOptional
  • Type: typing.List[str]

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}

rekey_timeOptional
  • Type: typing.Union[int, float]

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}

reset_id 
def reset_id() -> None
reset_ipsec_properties 
def reset_ipsec_properties() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a GatewayConnectionTunnel resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnel.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnel.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnel.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnel.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
ipsec_auth_psk GatewayConnectionTunnelIpsecAuthPskOutputReference No description.
ipsec_properties GatewayConnectionTunnelIpsecPropertiesOutputReference No description.
operational_state str No description.
uuid str No description.
connection_id_input str No description.
id_input str No description.
ipsec_auth_psk_input GatewayConnectionTunnelIpsecAuthPsk No description.
ipsec_properties_input GatewayConnectionTunnelIpsecProperties No description.
local_address_name_input str No description.
name_input str No description.
remote_address_input str No description.
connection_id str No description.
id str No description.
local_address_name str No description.
name str No description.
remote_address str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
ipsec_auth_pskRequired 
ipsec_auth_psk: GatewayConnectionTunnelIpsecAuthPskOutputReference
ipsec_propertiesRequired 
ipsec_properties: GatewayConnectionTunnelIpsecPropertiesOutputReference
operational_stateRequired 
operational_state: str
  • Type: str
uuidRequired 
uuid: str
  • Type: str
connection_id_inputOptional 
connection_id_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
ipsec_auth_psk_inputOptional 
ipsec_auth_psk_input: GatewayConnectionTunnelIpsecAuthPsk
ipsec_properties_inputOptional 
ipsec_properties_input: GatewayConnectionTunnelIpsecProperties
local_address_name_inputOptional 
local_address_name_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
remote_address_inputOptional 
remote_address_input: str
  • Type: str
connection_idRequired 
connection_id: str
  • Type: str
idRequired 
id: str
  • Type: str
local_address_nameRequired 
local_address_name: str
  • Type: str
nameRequired 
name: str
  • Type: str
remote_addressRequired 
remote_address: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

GatewayConnectionTunnelConfig

Initializer 

from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnelConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  connection_id: str,
  ipsec_auth_psk: GatewayConnectionTunnelIpsecAuthPsk,
  local_address_name: str,
  name: str,
  remote_address: str,
  id: str = None,
  ipsec_properties: GatewayConnectionTunnelIpsecProperties = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
connection_id str ID of the upcloud_gateway_connection resource to which the tunnel belongs.
ipsec_auth_psk GatewayConnectionTunnelIpsecAuthPsk ipsec_auth_psk block.
local_address_name str Public (UpCloud) endpoint address of this tunnel.
name str The name of the tunnel, should be unique within the connection.
remote_address str Remote public IP address of the tunnel.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/gateway_connection_tunnel#id GatewayConnectionTunnel#id}.
ipsec_properties GatewayConnectionTunnelIpsecProperties ipsec_properties block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
connection_idRequired 
connection_id: str
  • Type: str

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}

ipsec_auth_pskRequired 
ipsec_auth_psk: GatewayConnectionTunnelIpsecAuthPsk

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}

local_address_nameRequired 
local_address_name: str
  • Type: str

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 
name: str
  • Type: str

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}

remote_addressRequired 
remote_address: str
  • Type: str

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 
id: str
  • Type: str

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.

ipsec_propertiesOptional 
ipsec_properties: GatewayConnectionTunnelIpsecProperties

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 

from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnelIpsecAuthPsk(
  psk: str
)

Properties

Name Type Description
psk str The pre-shared key.
pskRequired 
psk: str
  • Type: str

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 

from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnelIpsecProperties(
  child_rekey_time: typing.Union[int, float] = None,
  dpd_delay: typing.Union[int, float] = None,
  dpd_timeout: typing.Union[int, float] = None,
  ike_lifetime: typing.Union[int, float] = None,
  phase1_algorithms: typing.List[str] = None,
  phase1_dh_group_numbers: typing.List[typing.Union[int, float]] = None,
  phase1_integrity_algorithms: typing.List[str] = None,
  phase2_algorithms: typing.List[str] = None,
  phase2_dh_group_numbers: typing.List[typing.Union[int, float]] = None,
  phase2_integrity_algorithms: typing.List[str] = None,
  rekey_time: typing.Union[int, float] = None
)

Properties

Name Type Description
child_rekey_time typing.Union[int, float] IKE child SA rekey time in seconds.
dpd_delay typing.Union[int, float] Delay before sending Dead Peer Detection packets if no traffic is detected, in seconds.
dpd_timeout typing.Union[int, float] Timeout period for DPD reply before considering the peer to be dead, in seconds.
ike_lifetime typing.Union[int, float] Maximum IKE SA lifetime in seconds.
phase1_algorithms typing.List[str] List of Phase 1: Proposal algorithms.
phase1_dh_group_numbers typing.List[typing.Union[int, float]] List of Phase 1 Diffie-Hellman group numbers.
phase1_integrity_algorithms typing.List[str] List of Phase 1 integrity algorithms.
phase2_algorithms typing.List[str] List of Phase 2: Security Association algorithms.
phase2_dh_group_numbers typing.List[typing.Union[int, float]] List of Phase 2 Diffie-Hellman group numbers.
phase2_integrity_algorithms typing.List[str] List of Phase 2 integrity algorithms.
rekey_time typing.Union[int, float] IKE SA rekey time in seconds.
child_rekey_timeOptional 
child_rekey_time: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

dpd_delayOptional 
dpd_delay: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

dpd_timeoutOptional 
dpd_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

ike_lifetimeOptional 
ike_lifetime: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

phase1_algorithmsOptional 
phase1_algorithms: typing.List[str]
  • Type: typing.List[str]

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}

phase1_dh_group_numbersOptional 
phase1_dh_group_numbers: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]

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}

phase1_integrity_algorithmsOptional 
phase1_integrity_algorithms: typing.List[str]
  • Type: typing.List[str]

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}

phase2_algorithmsOptional 
phase2_algorithms: typing.List[str]
  • Type: typing.List[str]

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}

phase2_dh_group_numbersOptional 
phase2_dh_group_numbers: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]

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}

phase2_integrity_algorithmsOptional 
phase2_integrity_algorithms: typing.List[str]
  • Type: typing.List[str]

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}

rekey_timeOptional 
rekey_time: typing.Union[int, float]
  • Type: typing.Union[int, float]

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 

from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnelIpsecAuthPskOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
psk_input str No description.
psk str No description.
internal_value GatewayConnectionTunnelIpsecAuthPsk No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
psk_inputOptional 
psk_input: str
  • Type: str
pskRequired 
psk: str
  • Type: str
internal_valueOptional 
internal_value: GatewayConnectionTunnelIpsecAuthPsk

GatewayConnectionTunnelIpsecPropertiesOutputReference

Initializers 

from cdktf_cdktf_provider_upcloud import gateway_connection_tunnel

gatewayConnectionTunnel.GatewayConnectionTunnelIpsecPropertiesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_child_rekey_time No description.
reset_dpd_delay No description.
reset_dpd_timeout No description.
reset_ike_lifetime No description.
reset_phase1_algorithms No description.
reset_phase1_dh_group_numbers No description.
reset_phase1_integrity_algorithms No description.
reset_phase2_algorithms No description.
reset_phase2_dh_group_numbers No description.
reset_phase2_integrity_algorithms No description.
reset_rekey_time No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_child_rekey_time 
def reset_child_rekey_time() -> None
reset_dpd_delay 
def reset_dpd_delay() -> None
reset_dpd_timeout 
def reset_dpd_timeout() -> None
reset_ike_lifetime 
def reset_ike_lifetime() -> None
reset_phase1_algorithms 
def reset_phase1_algorithms() -> None
reset_phase1_dh_group_numbers 
def reset_phase1_dh_group_numbers() -> None
reset_phase1_integrity_algorithms 
def reset_phase1_integrity_algorithms() -> None
reset_phase2_algorithms 
def reset_phase2_algorithms() -> None
reset_phase2_dh_group_numbers 
def reset_phase2_dh_group_numbers() -> None
reset_phase2_integrity_algorithms 
def reset_phase2_integrity_algorithms() -> None
reset_rekey_time 
def reset_rekey_time() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
child_rekey_time_input typing.Union[int, float] No description.
dpd_delay_input typing.Union[int, float] No description.
dpd_timeout_input typing.Union[int, float] No description.
ike_lifetime_input typing.Union[int, float] No description.
phase1_algorithms_input typing.List[str] No description.
phase1_dh_group_numbers_input typing.List[typing.Union[int, float]] No description.
phase1_integrity_algorithms_input typing.List[str] No description.
phase2_algorithms_input typing.List[str] No description.
phase2_dh_group_numbers_input typing.List[typing.Union[int, float]] No description.
phase2_integrity_algorithms_input typing.List[str] No description.
rekey_time_input typing.Union[int, float] No description.
child_rekey_time typing.Union[int, float] No description.
dpd_delay typing.Union[int, float] No description.
dpd_timeout typing.Union[int, float] No description.
ike_lifetime typing.Union[int, float] No description.
phase1_algorithms typing.List[str] No description.
phase1_dh_group_numbers typing.List[typing.Union[int, float]] No description.
phase1_integrity_algorithms typing.List[str] No description.
phase2_algorithms typing.List[str] No description.
phase2_dh_group_numbers typing.List[typing.Union[int, float]] No description.
phase2_integrity_algorithms typing.List[str] No description.
rekey_time typing.Union[int, float] No description.
internal_value GatewayConnectionTunnelIpsecProperties No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
child_rekey_time_inputOptional 
child_rekey_time_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
dpd_delay_inputOptional 
dpd_delay_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
dpd_timeout_inputOptional 
dpd_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
ike_lifetime_inputOptional 
ike_lifetime_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
phase1_algorithms_inputOptional 
phase1_algorithms_input: typing.List[str]
  • Type: typing.List[str]
phase1_dh_group_numbers_inputOptional 
phase1_dh_group_numbers_input: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
phase1_integrity_algorithms_inputOptional 
phase1_integrity_algorithms_input: typing.List[str]
  • Type: typing.List[str]
phase2_algorithms_inputOptional 
phase2_algorithms_input: typing.List[str]
  • Type: typing.List[str]
phase2_dh_group_numbers_inputOptional 
phase2_dh_group_numbers_input: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
phase2_integrity_algorithms_inputOptional 
phase2_integrity_algorithms_input: typing.List[str]
  • Type: typing.List[str]
rekey_time_inputOptional 
rekey_time_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
child_rekey_timeRequired 
child_rekey_time: typing.Union[int, float]
  • Type: typing.Union[int, float]
dpd_delayRequired 
dpd_delay: typing.Union[int, float]
  • Type: typing.Union[int, float]
dpd_timeoutRequired 
dpd_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
ike_lifetimeRequired 
ike_lifetime: typing.Union[int, float]
  • Type: typing.Union[int, float]
phase1_algorithmsRequired 
phase1_algorithms: typing.List[str]
  • Type: typing.List[str]
phase1_dh_group_numbersRequired 
phase1_dh_group_numbers: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
phase1_integrity_algorithmsRequired 
phase1_integrity_algorithms: typing.List[str]
  • Type: typing.List[str]
phase2_algorithmsRequired 
phase2_algorithms: typing.List[str]
  • Type: typing.List[str]
phase2_dh_group_numbersRequired 
phase2_dh_group_numbers: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
phase2_integrity_algorithmsRequired 
phase2_integrity_algorithms: typing.List[str]
  • Type: typing.List[str]
rekey_timeRequired 
rekey_time: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: GatewayConnectionTunnelIpsecProperties