Skip to content

Latest commit

 

History

History
1925 lines (1220 loc) · 80.4 KB

ipsecTunnel.python.md

File metadata and controls

1925 lines (1220 loc) · 80.4 KB

ipsecTunnel Submodule

Constructs

IpsecTunnel

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel cloudflare_ipsec_tunnel}.

Initializers 

from cdktf_cdktf_provider_cloudflare import ipsec_tunnel

ipsecTunnel.IpsecTunnel(
  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,
  cloudflare_endpoint: str,
  customer_endpoint: str,
  interface_address: str,
  name: str,
  account_id: str = None,
  allow_null_cipher: typing.Union[bool, IResolvable] = None,
  description: str = None,
  fqdn_id: str = None,
  health_check_direction: str = None,
  health_check_enabled: typing.Union[bool, IResolvable] = None,
  health_check_rate: str = None,
  health_check_target: str = None,
  health_check_type: str = None,
  hex_id: str = None,
  id: str = None,
  psk: str = None,
  remote_id: str = None,
  replay_protection: typing.Union[bool, IResolvable] = None,
  user_id: str = 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.
cloudflare_endpoint str IP address assigned to the Cloudflare side of the IPsec tunnel.
customer_endpoint str IP address assigned to the customer side of the IPsec tunnel.
interface_address str 31-bit prefix (/31 in CIDR notation) supporting 2 hosts, one for each side of the tunnel.
name str Name of the IPsec tunnel.
account_id str The account identifier to target for the resource. Modifying this attribute will force creation of a new resource..
allow_null_cipher typing.Union[bool, cdktf.IResolvable] Specifies if this tunnel may use a null cipher (ENCR_NULL) in Phase 2. Defaults to false.
description str An optional description of the IPsec tunnel.
fqdn_id str remote_id in the form of a fqdn. This value is generated by cloudflare.
health_check_direction str Specifies the direction for the health check. Available values: unidirectional, bidirectional Default: unidirectional.
health_check_enabled typing.Union[bool, cdktf.IResolvable] Specifies if ICMP tunnel health checks are enabled. Default: true.
health_check_rate str Specifies the ICMP rate for the health check. Available values: low, mid, high Default: mid.
health_check_target str The IP address of the customer endpoint that will receive tunnel health checks. Default: <customer_gre_endpoint>.
health_check_type str Specifies the ICMP echo type for the health check (request or reply). Available values: request, reply Default: reply.
hex_id str remote_id as a hex string. This value is generated by cloudflare.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#id IpsecTunnel#id}.
psk str Pre shared key to be used with the IPsec tunnel. If left unset, it will be autogenerated.
remote_id str ID to be used while setting up the IPsec tunnel. This value is generated by cloudflare.
replay_protection typing.Union[bool, cdktf.IResolvable] Specifies if replay protection is enabled. Defaults to false.
user_id str remote_id in the form of an email address. This value is generated by cloudflare.
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]]
cloudflare_endpointRequired
  • Type: str

IP address assigned to the Cloudflare side of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#cloudflare_endpoint IpsecTunnel#cloudflare_endpoint}

customer_endpointRequired
  • Type: str

IP address assigned to the customer side of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#customer_endpoint IpsecTunnel#customer_endpoint}

interface_addressRequired
  • Type: str

31-bit prefix (/31 in CIDR notation) supporting 2 hosts, one for each side of the tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#interface_address IpsecTunnel#interface_address}

nameRequired
  • Type: str

Name of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#name IpsecTunnel#name}

account_idOptional
  • Type: str

The account identifier to target for the resource. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#account_id IpsecTunnel#account_id}

allow_null_cipherOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if this tunnel may use a null cipher (ENCR_NULL) in Phase 2. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#allow_null_cipher IpsecTunnel#allow_null_cipher}

descriptionOptional
  • Type: str

An optional description of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#description IpsecTunnel#description}

fqdn_idOptional
  • Type: str

remote_id in the form of a fqdn. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#fqdn_id IpsecTunnel#fqdn_id}

health_check_directionOptional
  • Type: str

Specifies the direction for the health check. Available values: unidirectional, bidirectional Default: unidirectional.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_direction IpsecTunnel#health_check_direction}

health_check_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if ICMP tunnel health checks are enabled. Default: true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_enabled IpsecTunnel#health_check_enabled}

health_check_rateOptional
  • Type: str

Specifies the ICMP rate for the health check. Available values: low, mid, high Default: mid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_rate IpsecTunnel#health_check_rate}

health_check_targetOptional
  • Type: str

The IP address of the customer endpoint that will receive tunnel health checks. Default: <customer_gre_endpoint>.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_target IpsecTunnel#health_check_target}

health_check_typeOptional
  • Type: str

Specifies the ICMP echo type for the health check (request or reply). Available values: request, reply Default: reply.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_type IpsecTunnel#health_check_type}

hex_idOptional
  • Type: str

remote_id as a hex string. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#hex_id IpsecTunnel#hex_id}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#id IpsecTunnel#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.

pskOptional
  • Type: str

Pre shared key to be used with the IPsec tunnel. If left unset, it will be autogenerated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#psk IpsecTunnel#psk}

remote_idOptional
  • Type: str

ID to be used while setting up the IPsec tunnel. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#remote_id IpsecTunnel#remote_id}

replay_protectionOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if replay protection is enabled. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#replay_protection IpsecTunnel#replay_protection}

user_idOptional
  • Type: str

remote_id in the form of an email address. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#user_id IpsecTunnel#user_id}

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".
reset_account_id No description.
reset_allow_null_cipher No description.
reset_description No description.
reset_fqdn_id No description.
reset_health_check_direction No description.
reset_health_check_enabled No description.
reset_health_check_rate No description.
reset_health_check_target No description.
reset_health_check_type No description.
reset_hex_id No description.
reset_id No description.
reset_psk No description.
reset_remote_id No description.
reset_replay_protection No description.
reset_user_id 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".

reset_account_id 
def reset_account_id() -> None
reset_allow_null_cipher 
def reset_allow_null_cipher() -> None
reset_description 
def reset_description() -> None
reset_fqdn_id 
def reset_fqdn_id() -> None
reset_health_check_direction 
def reset_health_check_direction() -> None
reset_health_check_enabled 
def reset_health_check_enabled() -> None
reset_health_check_rate 
def reset_health_check_rate() -> None
reset_health_check_target 
def reset_health_check_target() -> None
reset_health_check_type 
def reset_health_check_type() -> None
reset_hex_id 
def reset_hex_id() -> None
reset_id 
def reset_id() -> None
reset_psk 
def reset_psk() -> None
reset_remote_id 
def reset_remote_id() -> None
reset_replay_protection 
def reset_replay_protection() -> None
reset_user_id 
def reset_user_id() -> 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 IpsecTunnel resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_cloudflare import ipsec_tunnel

ipsecTunnel.IpsecTunnel.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_cloudflare import ipsec_tunnel

ipsecTunnel.IpsecTunnel.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_cloudflare import ipsec_tunnel

ipsecTunnel.IpsecTunnel.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_cloudflare import ipsec_tunnel

ipsecTunnel.IpsecTunnel.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

import_from_idRequired
  • Type: str

The id of the existing IpsecTunnel that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_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 IpsecTunnel 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.
account_id_input str No description.
allow_null_cipher_input typing.Union[bool, cdktf.IResolvable] No description.
cloudflare_endpoint_input str No description.
customer_endpoint_input str No description.
description_input str No description.
fqdn_id_input str No description.
health_check_direction_input str No description.
health_check_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
health_check_rate_input str No description.
health_check_target_input str No description.
health_check_type_input str No description.
hex_id_input str No description.
id_input str No description.
interface_address_input str No description.
name_input str No description.
psk_input str No description.
remote_id_input str No description.
replay_protection_input typing.Union[bool, cdktf.IResolvable] No description.
user_id_input str No description.
account_id str No description.
allow_null_cipher typing.Union[bool, cdktf.IResolvable] No description.
cloudflare_endpoint str No description.
customer_endpoint str No description.
description str No description.
fqdn_id str No description.
health_check_direction str No description.
health_check_enabled typing.Union[bool, cdktf.IResolvable] No description.
health_check_rate str No description.
health_check_target str No description.
health_check_type str No description.
hex_id str No description.
id str No description.
interface_address str No description.
name str No description.
psk str No description.
remote_id str No description.
replay_protection typing.Union[bool, cdktf.IResolvable] No description.
user_id 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]]
account_id_inputOptional 
account_id_input: str
  • Type: str
allow_null_cipher_inputOptional 
allow_null_cipher_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
cloudflare_endpoint_inputOptional 
cloudflare_endpoint_input: str
  • Type: str
customer_endpoint_inputOptional 
customer_endpoint_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
fqdn_id_inputOptional 
fqdn_id_input: str
  • Type: str
health_check_direction_inputOptional 
health_check_direction_input: str
  • Type: str
health_check_enabled_inputOptional 
health_check_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
health_check_rate_inputOptional 
health_check_rate_input: str
  • Type: str
health_check_target_inputOptional 
health_check_target_input: str
  • Type: str
health_check_type_inputOptional 
health_check_type_input: str
  • Type: str
hex_id_inputOptional 
hex_id_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
interface_address_inputOptional 
interface_address_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
psk_inputOptional 
psk_input: str
  • Type: str
remote_id_inputOptional 
remote_id_input: str
  • Type: str
replay_protection_inputOptional 
replay_protection_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
user_id_inputOptional 
user_id_input: str
  • Type: str
account_idRequired 
account_id: str
  • Type: str
allow_null_cipherRequired 
allow_null_cipher: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
cloudflare_endpointRequired 
cloudflare_endpoint: str
  • Type: str
customer_endpointRequired 
customer_endpoint: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
fqdn_idRequired 
fqdn_id: str
  • Type: str
health_check_directionRequired 
health_check_direction: str
  • Type: str
health_check_enabledRequired 
health_check_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
health_check_rateRequired 
health_check_rate: str
  • Type: str
health_check_targetRequired 
health_check_target: str
  • Type: str
health_check_typeRequired 
health_check_type: str
  • Type: str
hex_idRequired 
hex_id: str
  • Type: str
idRequired 
id: str
  • Type: str
interface_addressRequired 
interface_address: str
  • Type: str
nameRequired 
name: str
  • Type: str
pskRequired 
psk: str
  • Type: str
remote_idRequired 
remote_id: str
  • Type: str
replay_protectionRequired 
replay_protection: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
user_idRequired 
user_id: str
  • Type: str

Constants

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

Structs

IpsecTunnelConfig

Initializer 

from cdktf_cdktf_provider_cloudflare import ipsec_tunnel

ipsecTunnel.IpsecTunnelConfig(
  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,
  cloudflare_endpoint: str,
  customer_endpoint: str,
  interface_address: str,
  name: str,
  account_id: str = None,
  allow_null_cipher: typing.Union[bool, IResolvable] = None,
  description: str = None,
  fqdn_id: str = None,
  health_check_direction: str = None,
  health_check_enabled: typing.Union[bool, IResolvable] = None,
  health_check_rate: str = None,
  health_check_target: str = None,
  health_check_type: str = None,
  hex_id: str = None,
  id: str = None,
  psk: str = None,
  remote_id: str = None,
  replay_protection: typing.Union[bool, IResolvable] = None,
  user_id: str = 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.
cloudflare_endpoint str IP address assigned to the Cloudflare side of the IPsec tunnel.
customer_endpoint str IP address assigned to the customer side of the IPsec tunnel.
interface_address str 31-bit prefix (/31 in CIDR notation) supporting 2 hosts, one for each side of the tunnel.
name str Name of the IPsec tunnel.
account_id str The account identifier to target for the resource. Modifying this attribute will force creation of a new resource..
allow_null_cipher typing.Union[bool, cdktf.IResolvable] Specifies if this tunnel may use a null cipher (ENCR_NULL) in Phase 2. Defaults to false.
description str An optional description of the IPsec tunnel.
fqdn_id str remote_id in the form of a fqdn. This value is generated by cloudflare.
health_check_direction str Specifies the direction for the health check. Available values: unidirectional, bidirectional Default: unidirectional.
health_check_enabled typing.Union[bool, cdktf.IResolvable] Specifies if ICMP tunnel health checks are enabled. Default: true.
health_check_rate str Specifies the ICMP rate for the health check. Available values: low, mid, high Default: mid.
health_check_target str The IP address of the customer endpoint that will receive tunnel health checks. Default: <customer_gre_endpoint>.
health_check_type str Specifies the ICMP echo type for the health check (request or reply). Available values: request, reply Default: reply.
hex_id str remote_id as a hex string. This value is generated by cloudflare.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#id IpsecTunnel#id}.
psk str Pre shared key to be used with the IPsec tunnel. If left unset, it will be autogenerated.
remote_id str ID to be used while setting up the IPsec tunnel. This value is generated by cloudflare.
replay_protection typing.Union[bool, cdktf.IResolvable] Specifies if replay protection is enabled. Defaults to false.
user_id str remote_id in the form of an email address. This value is generated by cloudflare.
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]]
cloudflare_endpointRequired 
cloudflare_endpoint: str
  • Type: str

IP address assigned to the Cloudflare side of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#cloudflare_endpoint IpsecTunnel#cloudflare_endpoint}

customer_endpointRequired 
customer_endpoint: str
  • Type: str

IP address assigned to the customer side of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#customer_endpoint IpsecTunnel#customer_endpoint}

interface_addressRequired 
interface_address: str
  • Type: str

31-bit prefix (/31 in CIDR notation) supporting 2 hosts, one for each side of the tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#interface_address IpsecTunnel#interface_address}

nameRequired 
name: str
  • Type: str

Name of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#name IpsecTunnel#name}

account_idOptional 
account_id: str
  • Type: str

The account identifier to target for the resource. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#account_id IpsecTunnel#account_id}

allow_null_cipherOptional 
allow_null_cipher: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if this tunnel may use a null cipher (ENCR_NULL) in Phase 2. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#allow_null_cipher IpsecTunnel#allow_null_cipher}

descriptionOptional 
description: str
  • Type: str

An optional description of the IPsec tunnel.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#description IpsecTunnel#description}

fqdn_idOptional 
fqdn_id: str
  • Type: str

remote_id in the form of a fqdn. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#fqdn_id IpsecTunnel#fqdn_id}

health_check_directionOptional 
health_check_direction: str
  • Type: str

Specifies the direction for the health check. Available values: unidirectional, bidirectional Default: unidirectional.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_direction IpsecTunnel#health_check_direction}

health_check_enabledOptional 
health_check_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if ICMP tunnel health checks are enabled. Default: true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_enabled IpsecTunnel#health_check_enabled}

health_check_rateOptional 
health_check_rate: str
  • Type: str

Specifies the ICMP rate for the health check. Available values: low, mid, high Default: mid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_rate IpsecTunnel#health_check_rate}

health_check_targetOptional 
health_check_target: str
  • Type: str

The IP address of the customer endpoint that will receive tunnel health checks. Default: <customer_gre_endpoint>.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_target IpsecTunnel#health_check_target}

health_check_typeOptional 
health_check_type: str
  • Type: str

Specifies the ICMP echo type for the health check (request or reply). Available values: request, reply Default: reply.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#health_check_type IpsecTunnel#health_check_type}

hex_idOptional 
hex_id: str
  • Type: str

remote_id as a hex string. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#hex_id IpsecTunnel#hex_id}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#id IpsecTunnel#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.

pskOptional 
psk: str
  • Type: str

Pre shared key to be used with the IPsec tunnel. If left unset, it will be autogenerated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#psk IpsecTunnel#psk}

remote_idOptional 
remote_id: str
  • Type: str

ID to be used while setting up the IPsec tunnel. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#remote_id IpsecTunnel#remote_id}

replay_protectionOptional 
replay_protection: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if replay protection is enabled. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#replay_protection IpsecTunnel#replay_protection}

user_idOptional 
user_id: str
  • Type: str

remote_id in the form of an email address. This value is generated by cloudflare.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/ipsec_tunnel#user_id IpsecTunnel#user_id}