pub struct BackendServiceArgsBuilder<S: State = Empty> { /* private fields */ }
Expand description
Use builder syntax to set the inputs and finish with build_struct()
.
Implementations§
source§impl<S: State> BackendServiceArgsBuilder<S>
impl<S: State> BackendServiceArgsBuilder<S>
sourcepub fn build_struct(self) -> BackendServiceArgswhere
S: IsComplete,
pub fn build_struct(self) -> BackendServiceArgswhere
S: IsComplete,
Finish building and return the requested object
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<i32>> as Default>::default()
.
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.
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<i32>> as Default>::default()
.
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.
sourcepub fn backends(
self,
value: impl Into<Output<Option<Vec<BackendServiceBackend>>>>,
) -> BackendServiceArgsBuilder<SetBackends<S>>where
S::Backends: IsUnset,
pub fn backends(
self,
value: impl Into<Output<Option<Vec<BackendServiceBackend>>>>,
) -> BackendServiceArgsBuilder<SetBackends<S>>where
S::Backends: IsUnset,
sourcepub fn maybe_backends(
self,
value: Option<impl Into<Output<Option<Vec<BackendServiceBackend>>>>>,
) -> BackendServiceArgsBuilder<SetBackends<S>>where
S::Backends: IsUnset,
pub fn maybe_backends(
self,
value: Option<impl Into<Output<Option<Vec<BackendServiceBackend>>>>>,
) -> BackendServiceArgsBuilder<SetBackends<S>>where
S::Backends: IsUnset,
sourcepub fn cdn_policy(
self,
value: impl Into<Output<Option<BackendServiceCdnPolicy>>>,
) -> BackendServiceArgsBuilder<SetCdnPolicy<S>>where
S::CdnPolicy: IsUnset,
pub fn cdn_policy(
self,
value: impl Into<Output<Option<BackendServiceCdnPolicy>>>,
) -> BackendServiceArgsBuilder<SetCdnPolicy<S>>where
S::CdnPolicy: IsUnset,
sourcepub fn maybe_cdn_policy(
self,
value: Option<impl Into<Output<Option<BackendServiceCdnPolicy>>>>,
) -> BackendServiceArgsBuilder<SetCdnPolicy<S>>where
S::CdnPolicy: IsUnset,
pub fn maybe_cdn_policy(
self,
value: Option<impl Into<Output<Option<BackendServiceCdnPolicy>>>>,
) -> BackendServiceArgsBuilder<SetCdnPolicy<S>>where
S::CdnPolicy: IsUnset,
sourcepub fn circuit_breakers(
self,
value: impl Into<Output<Option<BackendServiceCircuitBreakers>>>,
) -> BackendServiceArgsBuilder<SetCircuitBreakers<S>>where
S::CircuitBreakers: IsUnset,
pub fn circuit_breakers(
self,
value: impl Into<Output<Option<BackendServiceCircuitBreakers>>>,
) -> BackendServiceArgsBuilder<SetCircuitBreakers<S>>where
S::CircuitBreakers: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceCircuitBreakers>,
> as Default>::default()
Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.
sourcepub fn maybe_circuit_breakers(
self,
value: Option<impl Into<Output<Option<BackendServiceCircuitBreakers>>>>,
) -> BackendServiceArgsBuilder<SetCircuitBreakers<S>>where
S::CircuitBreakers: IsUnset,
pub fn maybe_circuit_breakers(
self,
value: Option<impl Into<Output<Option<BackendServiceCircuitBreakers>>>>,
) -> BackendServiceArgsBuilder<SetCircuitBreakers<S>>where
S::CircuitBreakers: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceCircuitBreakers>,
> as Default>::default()
Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.
sourcepub fn compression_mode(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetCompressionMode<S>>where
S::CompressionMode: IsUnset,
pub fn compression_mode(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetCompressionMode<S>>where
S::CompressionMode: IsUnset,
sourcepub fn maybe_compression_mode(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetCompressionMode<S>>where
S::CompressionMode: IsUnset,
pub fn maybe_compression_mode(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetCompressionMode<S>>where
S::CompressionMode: IsUnset,
sourcepub fn connection_draining_timeout_sec(
self,
value: impl Into<Output<Option<i32>>>,
) -> BackendServiceArgsBuilder<SetConnectionDrainingTimeoutSec<S>>where
S::ConnectionDrainingTimeoutSec: IsUnset,
pub fn connection_draining_timeout_sec(
self,
value: impl Into<Output<Option<i32>>>,
) -> BackendServiceArgsBuilder<SetConnectionDrainingTimeoutSec<S>>where
S::ConnectionDrainingTimeoutSec: IsUnset,
sourcepub fn maybe_connection_draining_timeout_sec(
self,
value: Option<impl Into<Output<Option<i32>>>>,
) -> BackendServiceArgsBuilder<SetConnectionDrainingTimeoutSec<S>>where
S::ConnectionDrainingTimeoutSec: IsUnset,
pub fn maybe_connection_draining_timeout_sec(
self,
value: Option<impl Into<Output<Option<i32>>>>,
) -> BackendServiceArgsBuilder<SetConnectionDrainingTimeoutSec<S>>where
S::ConnectionDrainingTimeoutSec: IsUnset,
sourcepub fn consistent_hash(
self,
value: impl Into<Output<Option<BackendServiceConsistentHash>>>,
) -> BackendServiceArgsBuilder<SetConsistentHash<S>>where
S::ConsistentHash: IsUnset,
pub fn consistent_hash(
self,
value: impl Into<Output<Option<BackendServiceConsistentHash>>>,
) -> BackendServiceArgsBuilder<SetConsistentHash<S>>where
S::ConsistentHash: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceConsistentHash>,
> as Default>::default()
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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.
sourcepub fn maybe_consistent_hash(
self,
value: Option<impl Into<Output<Option<BackendServiceConsistentHash>>>>,
) -> BackendServiceArgsBuilder<SetConsistentHash<S>>where
S::ConsistentHash: IsUnset,
pub fn maybe_consistent_hash(
self,
value: Option<impl Into<Output<Option<BackendServiceConsistentHash>>>>,
) -> BackendServiceArgsBuilder<SetConsistentHash<S>>where
S::ConsistentHash: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceConsistentHash>,
> as Default>::default()
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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.
sourcepub fn custom_request_headers(
self,
value: impl Into<Output<Option<Vec<String>>>>,
) -> BackendServiceArgsBuilder<SetCustomRequestHeaders<S>>where
S::CustomRequestHeaders: IsUnset,
pub fn custom_request_headers(
self,
value: impl Into<Output<Option<Vec<String>>>>,
) -> BackendServiceArgsBuilder<SetCustomRequestHeaders<S>>where
S::CustomRequestHeaders: IsUnset,
sourcepub fn maybe_custom_request_headers(
self,
value: Option<impl Into<Output<Option<Vec<String>>>>>,
) -> BackendServiceArgsBuilder<SetCustomRequestHeaders<S>>where
S::CustomRequestHeaders: IsUnset,
pub fn maybe_custom_request_headers(
self,
value: Option<impl Into<Output<Option<Vec<String>>>>>,
) -> BackendServiceArgsBuilder<SetCustomRequestHeaders<S>>where
S::CustomRequestHeaders: IsUnset,
sourcepub fn custom_response_headers(
self,
value: impl Into<Output<Option<Vec<String>>>>,
) -> BackendServiceArgsBuilder<SetCustomResponseHeaders<S>>where
S::CustomResponseHeaders: IsUnset,
pub fn custom_response_headers(
self,
value: impl Into<Output<Option<Vec<String>>>>,
) -> BackendServiceArgsBuilder<SetCustomResponseHeaders<S>>where
S::CustomResponseHeaders: IsUnset,
sourcepub fn maybe_custom_response_headers(
self,
value: Option<impl Into<Output<Option<Vec<String>>>>>,
) -> BackendServiceArgsBuilder<SetCustomResponseHeaders<S>>where
S::CustomResponseHeaders: IsUnset,
pub fn maybe_custom_response_headers(
self,
value: Option<impl Into<Output<Option<Vec<String>>>>>,
) -> BackendServiceArgsBuilder<SetCustomResponseHeaders<S>>where
S::CustomResponseHeaders: IsUnset,
sourcepub fn description(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetDescription<S>>where
S::Description: IsUnset,
pub fn description(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetDescription<S>>where
S::Description: IsUnset,
sourcepub fn maybe_description(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetDescription<S>>where
S::Description: IsUnset,
pub fn maybe_description(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetDescription<S>>where
S::Description: IsUnset,
sourcepub fn edge_security_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetEdgeSecurityPolicy<S>>where
S::EdgeSecurityPolicy: IsUnset,
pub fn edge_security_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetEdgeSecurityPolicy<S>>where
S::EdgeSecurityPolicy: IsUnset,
sourcepub fn maybe_edge_security_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetEdgeSecurityPolicy<S>>where
S::EdgeSecurityPolicy: IsUnset,
pub fn maybe_edge_security_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetEdgeSecurityPolicy<S>>where
S::EdgeSecurityPolicy: IsUnset,
sourcepub fn enable_cdn(
self,
value: impl Into<Output<Option<bool>>>,
) -> BackendServiceArgsBuilder<SetEnableCdn<S>>where
S::EnableCdn: IsUnset,
pub fn enable_cdn(
self,
value: impl Into<Output<Option<bool>>>,
) -> BackendServiceArgsBuilder<SetEnableCdn<S>>where
S::EnableCdn: IsUnset,
sourcepub fn maybe_enable_cdn(
self,
value: Option<impl Into<Output<Option<bool>>>>,
) -> BackendServiceArgsBuilder<SetEnableCdn<S>>where
S::EnableCdn: IsUnset,
pub fn maybe_enable_cdn(
self,
value: Option<impl Into<Output<Option<bool>>>>,
) -> BackendServiceArgsBuilder<SetEnableCdn<S>>where
S::EnableCdn: IsUnset,
sourcepub fn health_checks(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetHealthChecks<S>>where
S::HealthChecks: IsUnset,
pub fn health_checks(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetHealthChecks<S>>where
S::HealthChecks: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.
sourcepub fn maybe_health_checks(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetHealthChecks<S>>where
S::HealthChecks: IsUnset,
pub fn maybe_health_checks(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetHealthChecks<S>>where
S::HealthChecks: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.
sourcepub fn iap(
self,
value: impl Into<Output<Option<BackendServiceIap>>>,
) -> BackendServiceArgsBuilder<SetIap<S>>where
S::Iap: IsUnset,
pub fn iap(
self,
value: impl Into<Output<Option<BackendServiceIap>>>,
) -> BackendServiceArgsBuilder<SetIap<S>>where
S::Iap: IsUnset,
sourcepub fn maybe_iap(
self,
value: Option<impl Into<Output<Option<BackendServiceIap>>>>,
) -> BackendServiceArgsBuilder<SetIap<S>>where
S::Iap: IsUnset,
pub fn maybe_iap(
self,
value: Option<impl Into<Output<Option<BackendServiceIap>>>>,
) -> BackendServiceArgsBuilder<SetIap<S>>where
S::Iap: IsUnset,
sourcepub fn ip_address_selection_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetIpAddressSelectionPolicy<S>>where
S::IpAddressSelectionPolicy: IsUnset,
pub fn ip_address_selection_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetIpAddressSelectionPolicy<S>>where
S::IpAddressSelectionPolicy: IsUnset,
sourcepub fn maybe_ip_address_selection_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetIpAddressSelectionPolicy<S>>where
S::IpAddressSelectionPolicy: IsUnset,
pub fn maybe_ip_address_selection_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetIpAddressSelectionPolicy<S>>where
S::IpAddressSelectionPolicy: IsUnset,
sourcepub fn load_balancing_scheme(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetLoadBalancingScheme<S>>where
S::LoadBalancingScheme: IsUnset,
pub fn load_balancing_scheme(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetLoadBalancingScheme<S>>where
S::LoadBalancingScheme: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
Indicates whether the backend service will be used with internal or
external load balancing. A backend service created for one type of
load balancing cannot be used with the other. For more information, refer to
Choosing a load balancer.
Default value is EXTERNAL
.
Possible values are: EXTERNAL
, INTERNAL_SELF_MANAGED
, INTERNAL_MANAGED
, EXTERNAL_MANAGED
.
sourcepub fn maybe_load_balancing_scheme(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetLoadBalancingScheme<S>>where
S::LoadBalancingScheme: IsUnset,
pub fn maybe_load_balancing_scheme(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetLoadBalancingScheme<S>>where
S::LoadBalancingScheme: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
Indicates whether the backend service will be used with internal or
external load balancing. A backend service created for one type of
load balancing cannot be used with the other. For more information, refer to
Choosing a load balancer.
Default value is EXTERNAL
.
Possible values are: EXTERNAL
, INTERNAL_SELF_MANAGED
, INTERNAL_MANAGED
, EXTERNAL_MANAGED
.
sourcepub fn locality_lb_policies(
self,
value: impl Into<Output<Option<Vec<BackendServiceLocalityLbPolicy>>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicies<S>>where
S::LocalityLbPolicies: IsUnset,
pub fn locality_lb_policies(
self,
value: impl Into<Output<Option<Vec<BackendServiceLocalityLbPolicy>>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicies<S>>where
S::LocalityLbPolicies: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<Vec<super::super::types::compute::BackendServiceLocalityLbPolicy>>,
> as Default>::default()
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.
sourcepub fn maybe_locality_lb_policies(
self,
value: Option<impl Into<Output<Option<Vec<BackendServiceLocalityLbPolicy>>>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicies<S>>where
S::LocalityLbPolicies: IsUnset,
pub fn maybe_locality_lb_policies(
self,
value: Option<impl Into<Output<Option<Vec<BackendServiceLocalityLbPolicy>>>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicies<S>>where
S::LocalityLbPolicies: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<Vec<super::super::types::compute::BackendServiceLocalityLbPolicy>>,
> as Default>::default()
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.
sourcepub fn locality_lb_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicy<S>>where
S::LocalityLbPolicy: IsUnset,
pub fn locality_lb_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicy<S>>where
S::LocalityLbPolicy: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
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
.
sourcepub fn maybe_locality_lb_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicy<S>>where
S::LocalityLbPolicy: IsUnset,
pub fn maybe_locality_lb_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetLocalityLbPolicy<S>>where
S::LocalityLbPolicy: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
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
.
sourcepub fn log_config(
self,
value: impl Into<Output<Option<BackendServiceLogConfig>>>,
) -> BackendServiceArgsBuilder<SetLogConfig<S>>where
S::LogConfig: IsUnset,
pub fn log_config(
self,
value: impl Into<Output<Option<BackendServiceLogConfig>>>,
) -> BackendServiceArgsBuilder<SetLogConfig<S>>where
S::LogConfig: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceLogConfig>,
> as Default>::default()
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.
sourcepub fn maybe_log_config(
self,
value: Option<impl Into<Output<Option<BackendServiceLogConfig>>>>,
) -> BackendServiceArgsBuilder<SetLogConfig<S>>where
S::LogConfig: IsUnset,
pub fn maybe_log_config(
self,
value: Option<impl Into<Output<Option<BackendServiceLogConfig>>>>,
) -> BackendServiceArgsBuilder<SetLogConfig<S>>where
S::LogConfig: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceLogConfig>,
> as Default>::default()
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.
sourcepub fn name(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetName<S>>where
S::Name: IsUnset,
pub fn name(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetName<S>>where
S::Name: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
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.
sourcepub fn maybe_name(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetName<S>>where
S::Name: IsUnset,
pub fn maybe_name(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetName<S>>where
S::Name: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
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.
sourcepub fn outlier_detection(
self,
value: impl Into<Output<Option<BackendServiceOutlierDetection>>>,
) -> BackendServiceArgsBuilder<SetOutlierDetection<S>>where
S::OutlierDetection: IsUnset,
pub fn outlier_detection(
self,
value: impl Into<Output<Option<BackendServiceOutlierDetection>>>,
) -> BackendServiceArgsBuilder<SetOutlierDetection<S>>where
S::OutlierDetection: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceOutlierDetection>,
> as Default>::default()
Settings controlling eviction of unhealthy hosts from the load balancing pool. Applicable backend service types can be a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. Structure is documented below.
sourcepub fn maybe_outlier_detection(
self,
value: Option<impl Into<Output<Option<BackendServiceOutlierDetection>>>>,
) -> BackendServiceArgsBuilder<SetOutlierDetection<S>>where
S::OutlierDetection: IsUnset,
pub fn maybe_outlier_detection(
self,
value: Option<impl Into<Output<Option<BackendServiceOutlierDetection>>>>,
) -> BackendServiceArgsBuilder<SetOutlierDetection<S>>where
S::OutlierDetection: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceOutlierDetection>,
> as Default>::default()
Settings controlling eviction of unhealthy hosts from the load balancing pool. Applicable backend service types can be a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. Structure is documented below.
sourcepub fn port_name(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetPortName<S>>where
S::PortName: IsUnset,
pub fn port_name(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetPortName<S>>where
S::PortName: IsUnset,
sourcepub fn maybe_port_name(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetPortName<S>>where
S::PortName: IsUnset,
pub fn maybe_port_name(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetPortName<S>>where
S::PortName: IsUnset,
sourcepub fn project(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetProject<S>>where
S::Project: IsUnset,
pub fn project(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetProject<S>>where
S::Project: IsUnset,
sourcepub fn maybe_project(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetProject<S>>where
S::Project: IsUnset,
pub fn maybe_project(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetProject<S>>where
S::Project: IsUnset,
sourcepub fn protocol(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetProtocol<S>>where
S::Protocol: IsUnset,
pub fn protocol(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetProtocol<S>>where
S::Protocol: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
The protocol this BackendService 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. NOTE: With protocol “UNSPECIFIED”,
the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing
with TCP/UDP/L3_DEFAULT Forwarding Rule protocol.
Possible values are: HTTP
, HTTPS
, HTTP2
, TCP
, SSL
, GRPC
, UNSPECIFIED
.
sourcepub fn maybe_protocol(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetProtocol<S>>where
S::Protocol: IsUnset,
pub fn maybe_protocol(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetProtocol<S>>where
S::Protocol: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
The protocol this BackendService 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. NOTE: With protocol “UNSPECIFIED”,
the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing
with TCP/UDP/L3_DEFAULT Forwarding Rule protocol.
Possible values are: HTTP
, HTTPS
, HTTP2
, TCP
, SSL
, GRPC
, UNSPECIFIED
.
sourcepub fn security_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetSecurityPolicy<S>>where
S::SecurityPolicy: IsUnset,
pub fn security_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetSecurityPolicy<S>>where
S::SecurityPolicy: IsUnset,
sourcepub fn maybe_security_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetSecurityPolicy<S>>where
S::SecurityPolicy: IsUnset,
pub fn maybe_security_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetSecurityPolicy<S>>where
S::SecurityPolicy: IsUnset,
sourcepub fn security_settings(
self,
value: impl Into<Output<Option<BackendServiceSecuritySettings>>>,
) -> BackendServiceArgsBuilder<SetSecuritySettings<S>>where
S::SecuritySettings: IsUnset,
pub fn security_settings(
self,
value: impl Into<Output<Option<BackendServiceSecuritySettings>>>,
) -> BackendServiceArgsBuilder<SetSecuritySettings<S>>where
S::SecuritySettings: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceSecuritySettings>,
> as Default>::default()
The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.
sourcepub fn maybe_security_settings(
self,
value: Option<impl Into<Output<Option<BackendServiceSecuritySettings>>>>,
) -> BackendServiceArgsBuilder<SetSecuritySettings<S>>where
S::SecuritySettings: IsUnset,
pub fn maybe_security_settings(
self,
value: Option<impl Into<Output<Option<BackendServiceSecuritySettings>>>>,
) -> BackendServiceArgsBuilder<SetSecuritySettings<S>>where
S::SecuritySettings: IsUnset,
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceSecuritySettings>,
> as Default>::default()
The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.
sourcepub fn service_lb_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetServiceLbPolicy<S>>where
S::ServiceLbPolicy: IsUnset,
pub fn service_lb_policy(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetServiceLbPolicy<S>>where
S::ServiceLbPolicy: IsUnset,
sourcepub fn maybe_service_lb_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetServiceLbPolicy<S>>where
S::ServiceLbPolicy: IsUnset,
pub fn maybe_service_lb_policy(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetServiceLbPolicy<S>>where
S::ServiceLbPolicy: IsUnset,
sourcepub fn session_affinity(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetSessionAffinity<S>>where
S::SessionAffinity: IsUnset,
pub fn session_affinity(
self,
value: impl Into<Output<Option<String>>>,
) -> BackendServiceArgsBuilder<SetSessionAffinity<S>>where
S::SessionAffinity: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
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
, STRONG_COOKIE_AFFINITY
.
sourcepub fn maybe_session_affinity(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetSessionAffinity<S>>where
S::SessionAffinity: IsUnset,
pub fn maybe_session_affinity(
self,
value: Option<impl Into<Output<Option<String>>>>,
) -> BackendServiceArgsBuilder<SetSessionAffinity<S>>where
S::SessionAffinity: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default()
.
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
, STRONG_COOKIE_AFFINITY
.
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceStrongSessionAffinityCookie>,
> as Default>::default()
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.
Optional (Some / Option setters). Default:
<pulumi_wasm_rust::Output<
Option<super::super::types::compute::BackendServiceStrongSessionAffinityCookie>,
> as Default>::default()
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.
sourcepub fn timeout_sec(
self,
value: impl Into<Output<Option<i32>>>,
) -> BackendServiceArgsBuilder<SetTimeoutSec<S>>where
S::TimeoutSec: IsUnset,
pub fn timeout_sec(
self,
value: impl Into<Output<Option<i32>>>,
) -> BackendServiceArgsBuilder<SetTimeoutSec<S>>where
S::TimeoutSec: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<i32>> as Default>::default()
.
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.
sourcepub fn maybe_timeout_sec(
self,
value: Option<impl Into<Output<Option<i32>>>>,
) -> BackendServiceArgsBuilder<SetTimeoutSec<S>>where
S::TimeoutSec: IsUnset,
pub fn maybe_timeout_sec(
self,
value: Option<impl Into<Output<Option<i32>>>>,
) -> BackendServiceArgsBuilder<SetTimeoutSec<S>>where
S::TimeoutSec: IsUnset,
Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<i32>> as Default>::default()
.
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.