pub struct RegionBackendServiceResult {Show 32 fields
pub affinity_cookie_ttl_sec: Output<Option<i32>>,
pub backends: Output<Option<Vec<RegionBackendServiceBackend>>>,
pub cdn_policy: Output<RegionBackendServiceCdnPolicy>,
pub circuit_breakers: Output<Option<RegionBackendServiceCircuitBreakers>>,
pub connection_draining_timeout_sec: Output<Option<i32>>,
pub connection_tracking_policy: Output<Option<RegionBackendServiceConnectionTrackingPolicy>>,
pub consistent_hash: Output<Option<RegionBackendServiceConsistentHash>>,
pub creation_timestamp: Output<String>,
pub description: Output<Option<String>>,
pub enable_cdn: Output<Option<bool>>,
pub failover_policy: Output<Option<RegionBackendServiceFailoverPolicy>>,
pub fingerprint: Output<String>,
pub generated_id: Output<i32>,
pub health_checks: Output<Option<String>>,
pub iap: Output<RegionBackendServiceIap>,
pub ip_address_selection_policy: Output<Option<String>>,
pub load_balancing_scheme: Output<Option<String>>,
pub locality_lb_policy: Output<Option<String>>,
pub log_config: Output<RegionBackendServiceLogConfig>,
pub name: Output<String>,
pub network: Output<Option<String>>,
pub outlier_detection: Output<Option<RegionBackendServiceOutlierDetection>>,
pub port_name: Output<String>,
pub project: Output<String>,
pub protocol: Output<String>,
pub region: Output<String>,
pub security_policy: Output<Option<String>>,
pub self_link: Output<String>,
pub session_affinity: Output<String>,
pub strong_session_affinity_cookie: Output<Option<RegionBackendServiceStrongSessionAffinityCookie>>,
pub subsetting: Output<Option<RegionBackendServiceSubsetting>>,
pub timeout_sec: Output<i32>,
}
Fields§
Lifetime of cookies in seconds if session_affinity 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.
backends: Output<Option<Vec<RegionBackendServiceBackend>>>
The set of backends that serve this RegionBackendService. Structure is documented below.
cdn_policy: Output<RegionBackendServiceCdnPolicy>
Cloud CDN configuration for this BackendService. Structure is documented below.
circuit_breakers: Output<Option<RegionBackendServiceCircuitBreakers>>
Settings controlling the volume of connections to a backend service. This field
is applicable only when the load_balancing_scheme
is set to INTERNAL_MANAGED
and the protocol
is set to HTTP, HTTPS, or HTTP2.
Structure is documented below.
connection_draining_timeout_sec: Output<Option<i32>>
Time for which instance will be drained (not accept new connections, but still work to finish started).
connection_tracking_policy: Output<Option<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.
consistent_hash: Output<Option<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 -
creation_timestamp: Output<String>
Creation timestamp in RFC3339 text format.
description: Output<Option<String>>
An optional description of this resource.
enable_cdn: Output<Option<bool>>
If true, enable Cloud CDN for this RegionBackendService.
failover_policy: Output<Option<RegionBackendServiceFailoverPolicy>>
Policy for failovers. Structure is documented below.
fingerprint: Output<String>
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
generated_id: Output<i32>
The unique identifier for the resource. This identifier is defined by the server.
health_checks: Output<Option<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.
iap: Output<RegionBackendServiceIap>
Settings for enabling Cloud Identity Aware Proxy Structure is documented below.
ip_address_selection_policy: Output<Option<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
.
load_balancing_scheme: Output<Option<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
.
locality_lb_policy: Output<Option<String>>
The load balancing algorithm used within the scope of the locality. The possible values are:
ROUND_ROBIN
: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST
: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH
: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM
: The load balancer selects a random healthy host.ORIGINAL_DESTINATION
: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV
: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV
: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN
,LEAST_REQUEST
,RING_HASH
,RANDOM
,ORIGINAL_DESTINATION
,MAGLEV
,WEIGHTED_MAGLEV
.
log_config: Output<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.
name: Output<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.
network: Output<Option<String>>
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
outlier_detection: Output<Option<RegionBackendServiceOutlierDetection>>
Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the load_balancing_scheme
is set
to INTERNAL_MANAGED and the protocol
is set to HTTP, HTTPS, or HTTP2.
Structure is documented below.
port_name: Output<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).
project: Output<String>
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
protocol: Output<String>
The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are: HTTP
, HTTPS
, HTTP2
, SSL
, TCP
, UDP
, GRPC
, UNSPECIFIED
.
region: Output<String>
The Region in which the created backend service should reside. If it is not provided, the provider region is used.
security_policy: Output<Option<String>>
The security policy associated with this backend service.
self_link: Output<String>
The URI of the created resource.
session_affinity: Output<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
.
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.
subsetting: Output<Option<RegionBackendServiceSubsetting>>
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.
timeout_sec: Output<i32>
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.