Skip to content

Latest commit

 

History

History
3777 lines (2449 loc) · 174 KB

computeForwardingRule.python.md

File metadata and controls

3777 lines (2449 loc) · 174 KB
Raw

computeForwardingRule Submodule

Constructs

ComputeForwardingRule

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule google_compute_forwarding_rule}.

Initializers 

from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRule(
  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,
  name: str,
  allow_global_access: typing.Union[bool, IResolvable] = None,
  allow_psc_global_access: typing.Union[bool, IResolvable] = None,
  all_ports: typing.Union[bool, IResolvable] = None,
  backend_service: str = None,
  description: str = None,
  id: str = None,
  ip_address: str = None,
  ip_protocol: str = None,
  ip_version: str = None,
  is_mirroring_collector: typing.Union[bool, IResolvable] = None,
  labels: typing.Mapping[str] = None,
  load_balancing_scheme: str = None,
  network: str = None,
  network_tier: str = None,
  no_automate_dns_zone: typing.Union[bool, IResolvable] = None,
  port_range: str = None,
  ports: typing.List[str] = None,
  project: str = None,
  recreate_closed_psc: typing.Union[bool, IResolvable] = None,
  region: str = None,
  service_directory_registrations: ComputeForwardingRuleServiceDirectoryRegistrations = None,
  service_label: str = None,
  source_ip_ranges: typing.List[str] = None,
  subnetwork: str = None,
  target: str = None,
  timeouts: ComputeForwardingRuleTimeouts = 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.
name str Name of the resource;
allow_global_access typing.Union[bool, cdktf.IResolvable] This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.
allow_psc_global_access typing.Union[bool, cdktf.IResolvable] This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
all_ports typing.Union[bool, cdktf.IResolvable] The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
backend_service str Identifies the backend service to which the forwarding rule sends traffic.
description str An optional description of this resource. Provide this property when you create the resource.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}.
ip_address str IP address for which this forwarding rule accepts traffic.
ip_protocol str The IP protocol to which this rule applies.
ip_version str The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.
is_mirroring_collector typing.Union[bool, cdktf.IResolvable] Indicates whether or not this load balancer can be used as a collector for packet mirroring.
labels typing.Mapping[str] Labels to apply to this forwarding rule. A list of key->value pairs.
load_balancing_scheme str Specifies the forwarding rule type.
network str This field is not used for external load balancing.
network_tier str This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.
no_automate_dns_zone typing.Union[bool, cdktf.IResolvable] This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
port_range str The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
ports typing.List[str] The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.
recreate_closed_psc typing.Union[bool, cdktf.IResolvable] This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.
region str A reference to the region where the regional forwarding rule resides.
service_directory_registrations ComputeForwardingRuleServiceDirectoryRegistrations service_directory_registrations block.
service_label str An optional prefix to the service name for this Forwarding Rule.
source_ip_ranges typing.List[str] If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
subnetwork str This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
target str The URL of the target resource to receive the matched traffic.
timeouts ComputeForwardingRuleTimeouts timeouts 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]]
nameRequired
  • Type: str

Name of the resource;

provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.

Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#name ComputeForwardingRule#name}

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

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}

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

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}

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

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.

Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

  • It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
  • It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
  • Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}

backend_serviceOptional
  • Type: str

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#backend_service ComputeForwardingRule#backend_service}

descriptionOptional
  • Type: str

An optional description of this resource. Provide this property when you create the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#description ComputeForwardingRule#description}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#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.

ip_addressOptional
  • Type: str

IP address for which this forwarding rule accepts traffic.

When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

  • When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
  • When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

The forwarding rule's 'target' or 'backendService', and in most cases, also the 'loadBalancingScheme', determine the type of IP address that you can use. For detailed information, see IP address specifications.

When reading an 'IPAddress', the API always returns the IP address number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#ip_address ComputeForwardingRule#ip_address}

ip_protocolOptional
  • Type: str

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

A Forwarding Rule with protocol L3_DEFAULT can attach with target instance or backend service with UNSPECIFIED protocol. A forwarding rule with "L3_DEFAULT" IPProtocal cannot be attached to a backend service with TCP or UDP. Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#ip_protocol ComputeForwardingRule#ip_protocol}

ip_versionOptional
  • Type: str

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#ip_version ComputeForwardingRule#ip_version}

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

Indicates whether or not this load balancer can be used as a collector for packet mirroring.

To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a 'PacketMirroring' rule applies to them.

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}

labelsOptional
  • Type: typing.Mapping[str]

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#labels ComputeForwardingRule#labels}

load_balancing_schemeOptional
  • Type: str

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#load_balancing_scheme ComputeForwardingRule#load_balancing_scheme}

networkOptional
  • Type: str

This field is not used for external load balancing.

For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#network ComputeForwardingRule#network}

network_tierOptional
  • Type: str

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#network_tier ComputeForwardingRule#network_tier}

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

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.

Non-PSC forwarding rules do not use this field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}

port_rangeOptional
  • Type: str

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.

Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

  • It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
  • It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
  • Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

portsOptional
  • Type: typing.List[str]

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.

Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

  • It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
  • It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
  • You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.

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

This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}

regionOptional
  • Type: str

A reference to the region where the regional forwarding rule resides.

This field is not applicable to global forwarding rules.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#region ComputeForwardingRule#region}

service_directory_registrationsOptional

service_directory_registrations block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service_directory_registrations ComputeForwardingRule#service_directory_registrations}

service_labelOptional
  • Type: str

An optional prefix to the service name for this Forwarding Rule.

If specified, will be the first label of the fully qualified service name.

The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

This field is only used for INTERNAL load balancing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service_label ComputeForwardingRule#service_label}

source_ip_rangesOptional
  • Type: typing.List[str]

If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.

Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#source_ip_ranges ComputeForwardingRule#source_ip_ranges}

subnetworkOptional
  • Type: str

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#subnetwork ComputeForwardingRule#subnetwork}

targetOptional
  • Type: str

The URL of the target resource to receive the matched traffic.

For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource.

The forwarded traffic must be of a type appropriate to the target object.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#target ComputeForwardingRule#target}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#timeouts ComputeForwardingRule#timeouts}

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_service_directory_registrations No description.
put_timeouts No description.
reset_allow_global_access No description.
reset_allow_psc_global_access No description.
reset_all_ports No description.
reset_backend_service No description.
reset_description No description.
reset_id No description.
reset_ip_address No description.
reset_ip_protocol No description.
reset_ip_version No description.
reset_is_mirroring_collector No description.
reset_labels No description.
reset_load_balancing_scheme No description.
reset_network No description.
reset_network_tier No description.
reset_no_automate_dns_zone No description.
reset_port_range No description.
reset_ports No description.
reset_project No description.
reset_recreate_closed_psc No description.
reset_region No description.
reset_service_directory_registrations No description.
reset_service_label No description.
reset_source_ip_ranges No description.
reset_subnetwork No description.
reset_target No description.
reset_timeouts 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_service_directory_registrations 
def put_service_directory_registrations(
  namespace: str = None,
  service: str = None
) -> None
namespaceOptional
  • Type: str

Service Directory namespace to register the forwarding rule under.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#namespace ComputeForwardingRule#namespace}

serviceOptional
  • Type: str

Service Directory service to register the forwarding rule under.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service ComputeForwardingRule#service}

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#create ComputeForwardingRule#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#delete ComputeForwardingRule#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#update ComputeForwardingRule#update}.

reset_allow_global_access 
def reset_allow_global_access() -> None
reset_allow_psc_global_access 
def reset_allow_psc_global_access() -> None
reset_all_ports 
def reset_all_ports() -> None
reset_backend_service 
def reset_backend_service() -> None
reset_description 
def reset_description() -> None
reset_id 
def reset_id() -> None
reset_ip_address 
def reset_ip_address() -> None
reset_ip_protocol 
def reset_ip_protocol() -> None
reset_ip_version 
def reset_ip_version() -> None
reset_is_mirroring_collector 
def reset_is_mirroring_collector() -> None
reset_labels 
def reset_labels() -> None
reset_load_balancing_scheme 
def reset_load_balancing_scheme() -> None
reset_network 
def reset_network() -> None
reset_network_tier 
def reset_network_tier() -> None
reset_no_automate_dns_zone 
def reset_no_automate_dns_zone() -> None
reset_port_range 
def reset_port_range() -> None
reset_ports 
def reset_ports() -> None
reset_project 
def reset_project() -> None
reset_recreate_closed_psc 
def reset_recreate_closed_psc() -> None
reset_region 
def reset_region() -> None
reset_service_directory_registrations 
def reset_service_directory_registrations() -> None
reset_service_label 
def reset_service_label() -> None
reset_source_ip_ranges 
def reset_source_ip_ranges() -> None
reset_subnetwork 
def reset_subnetwork() -> None
reset_target 
def reset_target() -> None
reset_timeouts 
def reset_timeouts() -> 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 ComputeForwardingRule resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRule.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_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRule.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRule.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRule.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

import_from_idRequired
  • Type: str

The id of the existing ComputeForwardingRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#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 ComputeForwardingRule 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.
base_forwarding_rule str No description.
creation_timestamp str No description.
effective_labels cdktf.StringMap No description.
forwarding_rule_id typing.Union[int, float] No description.
label_fingerprint str No description.
psc_connection_id str No description.
psc_connection_status str No description.
self_link str No description.
service_directory_registrations ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference No description.
service_name str No description.
terraform_labels cdktf.StringMap No description.
timeouts ComputeForwardingRuleTimeoutsOutputReference No description.
allow_global_access_input typing.Union[bool, cdktf.IResolvable] No description.
allow_psc_global_access_input typing.Union[bool, cdktf.IResolvable] No description.
all_ports_input typing.Union[bool, cdktf.IResolvable] No description.
backend_service_input str No description.
description_input str No description.
id_input str No description.
ip_address_input str No description.
ip_protocol_input str No description.
ip_version_input str No description.
is_mirroring_collector_input typing.Union[bool, cdktf.IResolvable] No description.
labels_input typing.Mapping[str] No description.
load_balancing_scheme_input str No description.
name_input str No description.
network_input str No description.
network_tier_input str No description.
no_automate_dns_zone_input typing.Union[bool, cdktf.IResolvable] No description.
port_range_input str No description.
ports_input typing.List[str] No description.
project_input str No description.
recreate_closed_psc_input typing.Union[bool, cdktf.IResolvable] No description.
region_input str No description.
service_directory_registrations_input ComputeForwardingRuleServiceDirectoryRegistrations No description.
service_label_input str No description.
source_ip_ranges_input typing.List[str] No description.
subnetwork_input str No description.
target_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, ComputeForwardingRuleTimeouts] No description.
allow_global_access typing.Union[bool, cdktf.IResolvable] No description.
allow_psc_global_access typing.Union[bool, cdktf.IResolvable] No description.
all_ports typing.Union[bool, cdktf.IResolvable] No description.
backend_service str No description.
description str No description.
id str No description.
ip_address str No description.
ip_protocol str No description.
ip_version str No description.
is_mirroring_collector typing.Union[bool, cdktf.IResolvable] No description.
labels typing.Mapping[str] No description.
load_balancing_scheme str No description.
name str No description.
network str No description.
network_tier str No description.
no_automate_dns_zone typing.Union[bool, cdktf.IResolvable] No description.
port_range str No description.
ports typing.List[str] No description.
project str No description.
recreate_closed_psc typing.Union[bool, cdktf.IResolvable] No description.
region str No description.
service_label str No description.
source_ip_ranges typing.List[str] No description.
subnetwork str No description.
target 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]]
base_forwarding_ruleRequired 
base_forwarding_rule: str
  • Type: str
creation_timestampRequired 
creation_timestamp: str
  • Type: str
effective_labelsRequired 
effective_labels: StringMap
  • Type: cdktf.StringMap
forwarding_rule_idRequired 
forwarding_rule_id: typing.Union[int, float]
  • Type: typing.Union[int, float]
label_fingerprintRequired 
label_fingerprint: str
  • Type: str
psc_connection_idRequired 
psc_connection_id: str
  • Type: str
psc_connection_statusRequired 
psc_connection_status: str
  • Type: str
self_linkRequired 
self_link: str
  • Type: str
service_directory_registrationsRequired 
service_directory_registrations: ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference
service_nameRequired 
service_name: str
  • Type: str
terraform_labelsRequired 
terraform_labels: StringMap
  • Type: cdktf.StringMap
timeoutsRequired 
timeouts: ComputeForwardingRuleTimeoutsOutputReference
allow_global_access_inputOptional 
allow_global_access_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
allow_psc_global_access_inputOptional 
allow_psc_global_access_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
all_ports_inputOptional 
all_ports_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
backend_service_inputOptional 
backend_service_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
ip_address_inputOptional 
ip_address_input: str
  • Type: str
ip_protocol_inputOptional 
ip_protocol_input: str
  • Type: str
ip_version_inputOptional 
ip_version_input: str
  • Type: str
is_mirroring_collector_inputOptional 
is_mirroring_collector_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
labels_inputOptional 
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
load_balancing_scheme_inputOptional 
load_balancing_scheme_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
network_inputOptional 
network_input: str
  • Type: str
network_tier_inputOptional 
network_tier_input: str
  • Type: str
no_automate_dns_zone_inputOptional 
no_automate_dns_zone_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
port_range_inputOptional 
port_range_input: str
  • Type: str
ports_inputOptional 
ports_input: typing.List[str]
  • Type: typing.List[str]
project_inputOptional 
project_input: str
  • Type: str
recreate_closed_psc_inputOptional 
recreate_closed_psc_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
region_inputOptional 
region_input: str
  • Type: str
service_directory_registrations_inputOptional 
service_directory_registrations_input: ComputeForwardingRuleServiceDirectoryRegistrations
service_label_inputOptional 
service_label_input: str
  • Type: str
source_ip_ranges_inputOptional 
source_ip_ranges_input: typing.List[str]
  • Type: typing.List[str]
subnetwork_inputOptional 
subnetwork_input: str
  • Type: str
target_inputOptional 
target_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, ComputeForwardingRuleTimeouts]
allow_global_accessRequired 
allow_global_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
allow_psc_global_accessRequired 
allow_psc_global_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
all_portsRequired 
all_ports: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
backend_serviceRequired 
backend_service: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
idRequired 
id: str
  • Type: str
ip_addressRequired 
ip_address: str
  • Type: str
ip_protocolRequired 
ip_protocol: str
  • Type: str
ip_versionRequired 
ip_version: str
  • Type: str
is_mirroring_collectorRequired 
is_mirroring_collector: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
labelsRequired 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]
load_balancing_schemeRequired 
load_balancing_scheme: str
  • Type: str
nameRequired 
name: str
  • Type: str
networkRequired 
network: str
  • Type: str
network_tierRequired 
network_tier: str
  • Type: str
no_automate_dns_zoneRequired 
no_automate_dns_zone: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
port_rangeRequired 
port_range: str
  • Type: str
portsRequired 
ports: typing.List[str]
  • Type: typing.List[str]
projectRequired 
project: str
  • Type: str
recreate_closed_pscRequired 
recreate_closed_psc: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
regionRequired 
region: str
  • Type: str
service_labelRequired 
service_label: str
  • Type: str
source_ip_rangesRequired 
source_ip_ranges: typing.List[str]
  • Type: typing.List[str]
subnetworkRequired 
subnetwork: str
  • Type: str
targetRequired 
target: str
  • Type: str

Constants

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

Structs

ComputeForwardingRuleConfig

Initializer 

from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRuleConfig(
  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,
  name: str,
  allow_global_access: typing.Union[bool, IResolvable] = None,
  allow_psc_global_access: typing.Union[bool, IResolvable] = None,
  all_ports: typing.Union[bool, IResolvable] = None,
  backend_service: str = None,
  description: str = None,
  id: str = None,
  ip_address: str = None,
  ip_protocol: str = None,
  ip_version: str = None,
  is_mirroring_collector: typing.Union[bool, IResolvable] = None,
  labels: typing.Mapping[str] = None,
  load_balancing_scheme: str = None,
  network: str = None,
  network_tier: str = None,
  no_automate_dns_zone: typing.Union[bool, IResolvable] = None,
  port_range: str = None,
  ports: typing.List[str] = None,
  project: str = None,
  recreate_closed_psc: typing.Union[bool, IResolvable] = None,
  region: str = None,
  service_directory_registrations: ComputeForwardingRuleServiceDirectoryRegistrations = None,
  service_label: str = None,
  source_ip_ranges: typing.List[str] = None,
  subnetwork: str = None,
  target: str = None,
  timeouts: ComputeForwardingRuleTimeouts = 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.
name str Name of the resource;
allow_global_access typing.Union[bool, cdktf.IResolvable] This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.
allow_psc_global_access typing.Union[bool, cdktf.IResolvable] This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
all_ports typing.Union[bool, cdktf.IResolvable] The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
backend_service str Identifies the backend service to which the forwarding rule sends traffic.
description str An optional description of this resource. Provide this property when you create the resource.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}.
ip_address str IP address for which this forwarding rule accepts traffic.
ip_protocol str The IP protocol to which this rule applies.
ip_version str The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.
is_mirroring_collector typing.Union[bool, cdktf.IResolvable] Indicates whether or not this load balancer can be used as a collector for packet mirroring.
labels typing.Mapping[str] Labels to apply to this forwarding rule. A list of key->value pairs.
load_balancing_scheme str Specifies the forwarding rule type.
network str This field is not used for external load balancing.
network_tier str This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.
no_automate_dns_zone typing.Union[bool, cdktf.IResolvable] This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
port_range str The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
ports typing.List[str] The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.
recreate_closed_psc typing.Union[bool, cdktf.IResolvable] This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.
region str A reference to the region where the regional forwarding rule resides.
service_directory_registrations ComputeForwardingRuleServiceDirectoryRegistrations service_directory_registrations block.
service_label str An optional prefix to the service name for this Forwarding Rule.
source_ip_ranges typing.List[str] If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
subnetwork str This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
target str The URL of the target resource to receive the matched traffic.
timeouts ComputeForwardingRuleTimeouts timeouts 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]]
nameRequired 
name: str
  • Type: str

Name of the resource;

provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.

Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#name ComputeForwardingRule#name}

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

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}

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

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}

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

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.

Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

  • It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
  • It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
  • Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}

backend_serviceOptional 
backend_service: str
  • Type: str

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#backend_service ComputeForwardingRule#backend_service}

descriptionOptional 
description: str
  • Type: str

An optional description of this resource. Provide this property when you create the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#description ComputeForwardingRule#description}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#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.

ip_addressOptional 
ip_address: str
  • Type: str

IP address for which this forwarding rule accepts traffic.

When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

  • When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
  • When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

The forwarding rule's 'target' or 'backendService', and in most cases, also the 'loadBalancingScheme', determine the type of IP address that you can use. For detailed information, see IP address specifications.

When reading an 'IPAddress', the API always returns the IP address number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#ip_address ComputeForwardingRule#ip_address}

ip_protocolOptional 
ip_protocol: str
  • Type: str

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

A Forwarding Rule with protocol L3_DEFAULT can attach with target instance or backend service with UNSPECIFIED protocol. A forwarding rule with "L3_DEFAULT" IPProtocal cannot be attached to a backend service with TCP or UDP. Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#ip_protocol ComputeForwardingRule#ip_protocol}

ip_versionOptional 
ip_version: str
  • Type: str

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#ip_version ComputeForwardingRule#ip_version}

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

Indicates whether or not this load balancer can be used as a collector for packet mirroring.

To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a 'PacketMirroring' rule applies to them.

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}

labelsOptional 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#labels ComputeForwardingRule#labels}

load_balancing_schemeOptional 
load_balancing_scheme: str
  • Type: str

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#load_balancing_scheme ComputeForwardingRule#load_balancing_scheme}

networkOptional 
network: str
  • Type: str

This field is not used for external load balancing.

For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#network ComputeForwardingRule#network}

network_tierOptional 
network_tier: str
  • Type: str

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#network_tier ComputeForwardingRule#network_tier}

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

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.

Non-PSC forwarding rules do not use this field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}

port_rangeOptional 
port_range: str
  • Type: str

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.

Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

  • It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
  • It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
  • Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

portsOptional 
ports: typing.List[str]
  • Type: typing.List[str]

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.

Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

  • It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
  • It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
  • You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

projectOptional 
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.

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

This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}

regionOptional 
region: str
  • Type: str

A reference to the region where the regional forwarding rule resides.

This field is not applicable to global forwarding rules.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#region ComputeForwardingRule#region}

service_directory_registrationsOptional 
service_directory_registrations: ComputeForwardingRuleServiceDirectoryRegistrations

service_directory_registrations block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service_directory_registrations ComputeForwardingRule#service_directory_registrations}

service_labelOptional 
service_label: str
  • Type: str

An optional prefix to the service name for this Forwarding Rule.

If specified, will be the first label of the fully qualified service name.

The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

This field is only used for INTERNAL load balancing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service_label ComputeForwardingRule#service_label}

source_ip_rangesOptional 
source_ip_ranges: typing.List[str]
  • Type: typing.List[str]

If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.

Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#source_ip_ranges ComputeForwardingRule#source_ip_ranges}

subnetworkOptional 
subnetwork: str
  • Type: str

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#subnetwork ComputeForwardingRule#subnetwork}

targetOptional 
target: str
  • Type: str

The URL of the target resource to receive the matched traffic.

For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource.

The forwarded traffic must be of a type appropriate to the target object.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#target ComputeForwardingRule#target}

timeoutsOptional 
timeouts: ComputeForwardingRuleTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#timeouts ComputeForwardingRule#timeouts}

ComputeForwardingRuleServiceDirectoryRegistrations

Initializer 

from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRuleServiceDirectoryRegistrations(
  namespace: str = None,
  service: str = None
)

Properties

Name Type Description
namespace str Service Directory namespace to register the forwarding rule under.
service str Service Directory service to register the forwarding rule under.
namespaceOptional 
namespace: str
  • Type: str

Service Directory namespace to register the forwarding rule under.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#namespace ComputeForwardingRule#namespace}

serviceOptional 
service: str
  • Type: str

Service Directory service to register the forwarding rule under.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service ComputeForwardingRule#service}

ComputeForwardingRuleTimeouts

Initializer 

from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRuleTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#create ComputeForwardingRule#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#delete ComputeForwardingRule#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#update ComputeForwardingRule#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#create ComputeForwardingRule#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#delete ComputeForwardingRule#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#update ComputeForwardingRule#update}.

Classes

ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference

Initializers 

from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference(
  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_namespace No description.
reset_service 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_namespace 
def reset_namespace() -> None
reset_service 
def reset_service() -> 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.
namespace_input str No description.
service_input str No description.
namespace str No description.
service str No description.
internal_value ComputeForwardingRuleServiceDirectoryRegistrations 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
namespace_inputOptional 
namespace_input: str
  • Type: str
service_inputOptional 
service_input: str
  • Type: str
namespaceRequired 
namespace: str
  • Type: str
serviceRequired 
service: str
  • Type: str
internal_valueOptional 
internal_value: ComputeForwardingRuleServiceDirectoryRegistrations

ComputeForwardingRuleTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import compute_forwarding_rule

computeForwardingRule.ComputeForwardingRuleTimeoutsOutputReference(
  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_create No description.
reset_delete No description.
reset_update 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_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> 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.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, ComputeForwardingRuleTimeouts] 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
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, ComputeForwardingRuleTimeouts]