RegionBackendServiceArgs class

The set of arguments for RegionBackendService. The set of arguments for RegionBackendService.

Constructors

RegionBackendServiceArgs({Input<int?>? affinityCookieTtlSec, Input<List<RegionBackendServiceBackend>?>? backends, Input<RegionBackendServiceCdnPolicy?>? cdnPolicy, Input<RegionBackendServiceCircuitBreakers?>? circuitBreakers, Input<int?>? connectionDrainingTimeoutSec, Input<RegionBackendServiceConnectionTrackingPolicy?>? connectionTrackingPolicy, Input<RegionBackendServiceConsistentHash?>? consistentHash, Input<List<RegionBackendServiceCustomMetric>?>? customMetrics, Input<String?>? deletionPolicy, Input<String?>? description, Input<RegionBackendServiceDynamicForwarding?>? dynamicForwarding, Input<bool?>? enableCdn, Input<RegionBackendServiceFailoverPolicy?>? failoverPolicy, Input<RegionBackendServiceHaPolicy?>? haPolicy, Input<String?>? healthChecks, Input<RegionBackendServiceIap?>? iap, Input<String?>? ipAddressSelectionPolicy, Input<String?>? loadBalancingScheme, Input<String?>? localityLbPolicy, Input<RegionBackendServiceLogConfig?>? logConfig, Input<String?>? name, Input<String?>? network, Input<RegionBackendServiceNetworkPassThroughLbTrafficPolicy?>? networkPassThroughLbTrafficPolicy, Input<RegionBackendServiceOutlierDetection?>? outlierDetection, Input<RegionBackendServiceParams?>? params, Input<String?>? portName, Input<String?>? project, Input<String?>? protocol, Input<String?>? region, Input<String?>? securityPolicy, Input<String?>? sessionAffinity, Input<RegionBackendServiceStrongSessionAffinityCookie?>? strongSessionAffinityCookie, Input<RegionBackendServiceSubsetting?>? subsetting, Input<int?>? timeoutSec, Input<RegionBackendServiceTlsSettings?>? tlsSettings})
Creates a new RegionBackendServiceArgs. affinityCookieTtlSec Lifetime of cookies in seconds if sessionAffinity is backends The set of backends that serve this RegionBackendService. cdnPolicy Cloud CDN configuration for this BackendService. circuitBreakers Settings controlling the volume of connections to a backend service. This field connectionDrainingTimeoutSec Time for which instance will be drained (not accept new connectionTrackingPolicy Connection Tracking configuration for this BackendService. consistentHash Consistent Hash-based load balancing can be used to provide soft session customMetrics List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. dynamicForwarding (Optional, Beta) enableCdn If true, enable Cloud CDN for this RegionBackendService. failoverPolicy Policy for failovers. haPolicy Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. healthChecks The set of URLs to HealthCheck resources for health checking iap Settings for enabling Cloud Identity Aware Proxy. ipAddressSelectionPolicy Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC). loadBalancingScheme Indicates what kind of load balancing this regional backend service localityLbPolicy The load balancing algorithm used within the scope of the locality. logConfig This field denotes the logging options for the load balancer traffic served by this backend service. name Name of the resource. Provided by the client when the resource is network The URL of the network to which this backend service belongs. networkPassThroughLbTrafficPolicy Configures traffic steering properties of internal passthrough Network Load Balancers. outlierDetection Settings controlling eviction of unhealthy hosts from the load balancing pool. params Additional params passed with the request, but not persisted as part of resource payload portName A named port on a backend instance group representing the port for project The ID of the project in which the resource belongs. protocol The protocol this BackendService uses to communicate with backends. region The Region in which the created backend service should reside. securityPolicy The security policy associated with this backend service. sessionAffinity Type of session affinity to use. The default is NONE. Session affinity is strongSessionAffinityCookie Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. subsetting (Optional, Beta) timeoutSec The backend service timeout has a different meaning depending on the type of load balancer. tlsSettings Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
const
RegionBackendServiceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

affinityCookieTtlSec → Input<int?>?
Lifetime of cookies in seconds if sessionAffinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
final
backends → Input<List<RegionBackendServiceBackend>?>?
The set of backends that serve this RegionBackendService. Structure is documented below.
final
cdnPolicy → Input<RegionBackendServiceCdnPolicy?>?
Cloud CDN configuration for this BackendService. Structure is documented below.
final
circuitBreakers → Input<RegionBackendServiceCircuitBreakers?>?
Settings controlling the volume of connections to a backend service. This field is applicable only when the loadBalancingScheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, HTTP2 or H2C. Structure is documented below.
final
connectionDrainingTimeoutSec → Input<int?>?
Time for which instance will be drained (not accept new connections, but still work to finish started).
final
connectionTrackingPolicy → Input<RegionBackendServiceConnectionTrackingPolicy?>?
Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
final
consistentHash → Input<RegionBackendServiceConsistentHash?>?
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
final
customMetrics → Input<List<RegionBackendServiceCustomMetric>?>?
List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
An optional description of this resource.
final
dynamicForwarding → Input<RegionBackendServiceDynamicForwarding?>?
(Optional, Beta) Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. Structure is documented below.
final
enableCdn → Input<bool?>?
If true, enable Cloud CDN for this RegionBackendService.
final
failoverPolicy → Input<RegionBackendServiceFailoverPolicy?>?
Policy for failovers. Structure is documented below.
final
haPolicy → Input<RegionBackendServiceHaPolicy?>?
Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
healthChecks → Input<String?>?
The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
final
iap → Input<RegionBackendServiceIap?>?
Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
final
ipAddressSelectionPolicy → Input<String?>?
Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC). Possible values are: IPV4_ONLY, PREFER_IPV6, IPV6_ONLY.
final
loadBalancingScheme → Input<String?>?
Indicates what kind of load balancing this regional backend service will be used for. A backend service created for one type of load balancing cannot be used with the other(s). For more information, refer to Choosing a load balancer. Default value is INTERNAL. Possible values are: EXTERNAL, EXTERNAL_MANAGED, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED.
final
localityLbPolicy → Input<String?>?
The load balancing algorithm used within the scope of the locality. The possible values are:
final
logConfig → Input<RegionBackendServiceLogConfig?>?
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
final
name → Input<String?>?
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.
final
network → Input<String?>?
The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled. Changes to this field force recreation of the resource.
final
networkPassThroughLbTrafficPolicy → Input<RegionBackendServiceNetworkPassThroughLbTrafficPolicy?>?
Configures traffic steering properties of internal passthrough Network Load Balancers. Structure is documented below.
final
outlierDetection → Input<RegionBackendServiceOutlierDetection?>?
Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the loadBalancingScheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, HTTP2 or H2C. Structure is documented below.
final
params → Input<RegionBackendServiceParams?>?
Additional params passed with the request, but not persisted as part of resource payload Structure is documented below.
final
portName → Input<String?>?
A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
protocol → Input<String?>?
The protocol this BackendService uses to communicate with backends. The default is HTTP. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. Refer to the documentation for the load balancers or for Traffic Director for more information. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, UDP, GRPC, UNSPECIFIED, H2C.
final
region → Input<String?>?
The Region in which the created backend service should reside. If it is not provided, the provider region is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityPolicy → Input<String?>?
The security policy associated with this backend service.
final
sessionAffinity → Input<String?>?
Type of session affinity to use. The default is NONE. Session affinity is not applicable if the protocol is UDP. Possible values are: NONE, CLIENT_IP, CLIENT_IP_PORT_PROTO, CLIENT_IP_PROTO, GENERATED_COOKIE, HEADER_FIELD, HTTP_COOKIE, CLIENT_IP_NO_DESTINATION, STRONG_COOKIE_AFFINITY.
final
strongSessionAffinityCookie → Input<RegionBackendServiceStrongSessionAffinityCookie?>?
Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
final
subsetting → Input<RegionBackendServiceSubsetting?>?
(Optional, Beta) Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
final
timeoutSec → Input<int?>?
The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
final
tlsSettings → Input<RegionBackendServiceTlsSettings?>?
Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited