Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .
Create BackendService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def BackendService(resource_name: str,
args: Optional[BackendServiceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def BackendService(resource_name: str,
opts: Optional[ResourceOptions] = None,
affinity_cookie_ttl_sec: Optional[int] = None,
backends: Optional[Sequence[BackendArgs]] = None,
cdn_policy: Optional[BackendServiceCdnPolicyArgs] = None,
circuit_breakers: Optional[CircuitBreakersArgs] = None,
compression_mode: Optional[BackendServiceCompressionMode] = None,
connection_draining: Optional[ConnectionDrainingArgs] = None,
connection_tracking_policy: Optional[BackendServiceConnectionTrackingPolicyArgs] = None,
consistent_hash: Optional[ConsistentHashLoadBalancerSettingsArgs] = None,
custom_request_headers: Optional[Sequence[str]] = None,
custom_response_headers: Optional[Sequence[str]] = None,
description: Optional[str] = None,
enable_cdn: Optional[bool] = None,
failover_policy: Optional[BackendServiceFailoverPolicyArgs] = None,
health_checks: Optional[Sequence[str]] = None,
iap: Optional[BackendServiceIAPArgs] = None,
ip_address_selection_policy: Optional[BackendServiceIpAddressSelectionPolicy] = None,
load_balancing_scheme: Optional[BackendServiceLoadBalancingScheme] = None,
locality_lb_policies: Optional[Sequence[BackendServiceLocalityLoadBalancingPolicyConfigArgs]] = None,
locality_lb_policy: Optional[BackendServiceLocalityLbPolicy] = None,
log_config: Optional[BackendServiceLogConfigArgs] = None,
max_stream_duration: Optional[DurationArgs] = None,
metadatas: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network: Optional[str] = None,
outlier_detection: Optional[OutlierDetectionArgs] = None,
port: Optional[int] = None,
port_name: Optional[str] = None,
project: Optional[str] = None,
protocol: Optional[BackendServiceProtocol] = None,
request_id: Optional[str] = None,
security_settings: Optional[SecuritySettingsArgs] = None,
service_bindings: Optional[Sequence[str]] = None,
service_lb_policy: Optional[str] = None,
session_affinity: Optional[BackendServiceSessionAffinity] = None,
subsetting: Optional[SubsettingArgs] = None,
timeout_sec: Optional[int] = None,
used_by: Optional[Sequence[BackendServiceUsedByArgs]] = None)
type: google-native:compute/beta:BackendService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_compute_beta_backend_service" "name" {
# resource properties
}
Parameters
- resource_name
str
- The unique name of the resource.
- args
BackendServiceArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
BackendServiceArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
BackendServiceArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var google_nativeBackendServiceResource = new GoogleNative.Compute.Beta.BackendService("google-nativeBackendServiceResource", new()
{
AffinityCookieTtlSec = 0,
Backends = new[]
{
new GoogleNative.Compute.Beta.Inputs.BackendArgs
{
BalancingMode = GoogleNative.Compute.Beta.BackendBalancingMode.Connection,
CapacityScaler = 0.0,
Description = "string",
Failover = false,
Group = "string",
MaxConnections = 0,
MaxConnectionsPerEndpoint = 0,
MaxConnectionsPerInstance = 0,
MaxRate = 0,
MaxRatePerEndpoint = 0.0,
MaxRatePerInstance = 0.0,
MaxUtilization = 0.0,
Preference = GoogleNative.Compute.Beta.BackendPreference.Default,
},
},
CdnPolicy = new GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyArgs
{
BypassCacheOnRequestHeaders = new[]
{
new GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs
{
HeaderName = "string",
},
},
CacheKeyPolicy = new GoogleNative.Compute.Beta.Inputs.CacheKeyPolicyArgs
{
IncludeHost = false,
IncludeHttpHeaders = new[]
{
"string",
},
IncludeNamedCookies = new[]
{
"string",
},
IncludeProtocol = false,
IncludeQueryString = false,
QueryStringBlacklist = new[]
{
"string",
},
QueryStringWhitelist = new[]
{
"string",
},
},
CacheMode = GoogleNative.Compute.Beta.BackendServiceCdnPolicyCacheMode.CacheAllStatic,
ClientTtl = 0,
DefaultTtl = 0,
MaxTtl = 0,
NegativeCaching = false,
NegativeCachingPolicy = new[]
{
new GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyNegativeCachingPolicyArgs
{
Code = 0,
Ttl = 0,
},
},
RequestCoalescing = false,
ServeWhileStale = 0,
SignedUrlCacheMaxAgeSec = "string",
},
CircuitBreakers = new GoogleNative.Compute.Beta.Inputs.CircuitBreakersArgs
{
ConnectTimeout = new GoogleNative.Compute.Beta.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
MaxConnections = 0,
MaxPendingRequests = 0,
MaxRequests = 0,
MaxRequestsPerConnection = 0,
MaxRetries = 0,
},
CompressionMode = GoogleNative.Compute.Beta.BackendServiceCompressionMode.Automatic,
ConnectionDraining = new GoogleNative.Compute.Beta.Inputs.ConnectionDrainingArgs
{
DrainingTimeoutSec = 0,
},
ConnectionTrackingPolicy = new GoogleNative.Compute.Beta.Inputs.BackendServiceConnectionTrackingPolicyArgs
{
ConnectionPersistenceOnUnhealthyBackends = GoogleNative.Compute.Beta.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.AlwaysPersist,
EnableStrongAffinity = false,
IdleTimeoutSec = 0,
TrackingMode = GoogleNative.Compute.Beta.BackendServiceConnectionTrackingPolicyTrackingMode.InvalidTrackingMode,
},
ConsistentHash = new GoogleNative.Compute.Beta.Inputs.ConsistentHashLoadBalancerSettingsArgs
{
HttpCookie = new GoogleNative.Compute.Beta.Inputs.ConsistentHashLoadBalancerSettingsHttpCookieArgs
{
Name = "string",
Path = "string",
Ttl = new GoogleNative.Compute.Beta.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
},
HttpHeaderName = "string",
MinimumRingSize = "string",
},
CustomRequestHeaders = new[]
{
"string",
},
CustomResponseHeaders = new[]
{
"string",
},
Description = "string",
EnableCDN = false,
FailoverPolicy = new GoogleNative.Compute.Beta.Inputs.BackendServiceFailoverPolicyArgs
{
DisableConnectionDrainOnFailover = false,
DropTrafficIfUnhealthy = false,
FailoverRatio = 0.0,
},
HealthChecks = new[]
{
"string",
},
Iap = new GoogleNative.Compute.Beta.Inputs.BackendServiceIAPArgs
{
Enabled = false,
Oauth2ClientId = "string",
Oauth2ClientSecret = "string",
},
IpAddressSelectionPolicy = GoogleNative.Compute.Beta.BackendServiceIpAddressSelectionPolicy.Ipv4Only,
LoadBalancingScheme = GoogleNative.Compute.Beta.BackendServiceLoadBalancingScheme.External,
LocalityLbPolicies = new[]
{
new GoogleNative.Compute.Beta.Inputs.BackendServiceLocalityLoadBalancingPolicyConfigArgs
{
CustomPolicy = new GoogleNative.Compute.Beta.Inputs.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs
{
Data = "string",
Name = "string",
},
Policy = new GoogleNative.Compute.Beta.Inputs.BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs
{
Name = GoogleNative.Compute.Beta.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.InvalidLbPolicy,
},
},
},
LocalityLbPolicy = GoogleNative.Compute.Beta.BackendServiceLocalityLbPolicy.InvalidLbPolicy,
LogConfig = new GoogleNative.Compute.Beta.Inputs.BackendServiceLogConfigArgs
{
Enable = false,
OptionalFields = new[]
{
"string",
},
OptionalMode = GoogleNative.Compute.Beta.BackendServiceLogConfigOptionalMode.Custom,
SampleRate = 0.0,
},
MaxStreamDuration = new GoogleNative.Compute.Beta.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
Metadatas =
{
{ "string", "string" },
},
Name = "string",
Network = "string",
OutlierDetection = new GoogleNative.Compute.Beta.Inputs.OutlierDetectionArgs
{
BaseEjectionTime = new GoogleNative.Compute.Beta.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
ConsecutiveErrors = 0,
ConsecutiveGatewayFailure = 0,
EnforcingConsecutiveErrors = 0,
EnforcingConsecutiveGatewayFailure = 0,
EnforcingSuccessRate = 0,
Interval = new GoogleNative.Compute.Beta.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
MaxEjectionPercent = 0,
SuccessRateMinimumHosts = 0,
SuccessRateRequestVolume = 0,
SuccessRateStdevFactor = 0,
},
PortName = "string",
Project = "string",
Protocol = GoogleNative.Compute.Beta.BackendServiceProtocol.Grpc,
RequestId = "string",
SecuritySettings = new GoogleNative.Compute.Beta.Inputs.SecuritySettingsArgs
{
AwsV4Authentication = new GoogleNative.Compute.Beta.Inputs.AWSV4SignatureArgs
{
AccessKey = "string",
AccessKeyId = "string",
AccessKeyVersion = "string",
OriginRegion = "string",
},
ClientTlsPolicy = "string",
SubjectAltNames = new[]
{
"string",
},
},
ServiceBindings = new[]
{
"string",
},
ServiceLbPolicy = "string",
SessionAffinity = GoogleNative.Compute.Beta.BackendServiceSessionAffinity.ClientIp,
Subsetting = new GoogleNative.Compute.Beta.Inputs.SubsettingArgs
{
Policy = GoogleNative.Compute.Beta.SubsettingPolicy.ConsistentHashSubsetting,
SubsetSize = 0,
},
TimeoutSec = 0,
UsedBy = new[]
{
new GoogleNative.Compute.Beta.Inputs.BackendServiceUsedByArgs
{
Reference = "string",
},
},
});
example, err := computebeta.NewBackendService(ctx, "google-nativeBackendServiceResource", &computebeta.BackendServiceArgs{
AffinityCookieTtlSec: pulumi.Int(0),
Backends: compute.BackendArray{
&compute.BackendArgs{
BalancingMode: computebeta.BackendBalancingModeConnection,
CapacityScaler: pulumi.Float64(0),
Description: pulumi.String("string"),
Failover: pulumi.Bool(false),
Group: pulumi.String("string"),
MaxConnections: pulumi.Int(0),
MaxConnectionsPerEndpoint: pulumi.Int(0),
MaxConnectionsPerInstance: pulumi.Int(0),
MaxRate: pulumi.Int(0),
MaxRatePerEndpoint: pulumi.Float64(0),
MaxRatePerInstance: pulumi.Float64(0),
MaxUtilization: pulumi.Float64(0),
Preference: computebeta.BackendPreferenceDefault,
},
},
CdnPolicy: &compute.BackendServiceCdnPolicyArgs{
BypassCacheOnRequestHeaders: compute.BackendServiceCdnPolicyBypassCacheOnRequestHeaderArray{
&compute.BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs{
HeaderName: pulumi.String("string"),
},
},
CacheKeyPolicy: &compute.CacheKeyPolicyArgs{
IncludeHost: pulumi.Bool(false),
IncludeHttpHeaders: pulumi.StringArray{
pulumi.String("string"),
},
IncludeNamedCookies: pulumi.StringArray{
pulumi.String("string"),
},
IncludeProtocol: pulumi.Bool(false),
IncludeQueryString: pulumi.Bool(false),
QueryStringBlacklist: pulumi.StringArray{
pulumi.String("string"),
},
QueryStringWhitelist: pulumi.StringArray{
pulumi.String("string"),
},
},
CacheMode: computebeta.BackendServiceCdnPolicyCacheModeCacheAllStatic,
ClientTtl: pulumi.Int(0),
DefaultTtl: pulumi.Int(0),
MaxTtl: pulumi.Int(0),
NegativeCaching: pulumi.Bool(false),
NegativeCachingPolicy: compute.BackendServiceCdnPolicyNegativeCachingPolicyArray{
&compute.BackendServiceCdnPolicyNegativeCachingPolicyArgs{
Code: pulumi.Int(0),
Ttl: pulumi.Int(0),
},
},
RequestCoalescing: pulumi.Bool(false),
ServeWhileStale: pulumi.Int(0),
SignedUrlCacheMaxAgeSec: pulumi.String("string"),
},
CircuitBreakers: &compute.CircuitBreakersArgs{
ConnectTimeout: &compute.DurationArgs{
Nanos: pulumi.Int(0),
Seconds: pulumi.String("string"),
},
MaxConnections: pulumi.Int(0),
MaxPendingRequests: pulumi.Int(0),
MaxRequests: pulumi.Int(0),
MaxRequestsPerConnection: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
},
CompressionMode: computebeta.BackendServiceCompressionModeAutomatic,
ConnectionDraining: &compute.ConnectionDrainingArgs{
DrainingTimeoutSec: pulumi.Int(0),
},
ConnectionTrackingPolicy: &compute.BackendServiceConnectionTrackingPolicyArgs{
ConnectionPersistenceOnUnhealthyBackends: computebeta.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackendsAlwaysPersist,
EnableStrongAffinity: pulumi.Bool(false),
IdleTimeoutSec: pulumi.Int(0),
TrackingMode: computebeta.BackendServiceConnectionTrackingPolicyTrackingModeInvalidTrackingMode,
},
ConsistentHash: &compute.ConsistentHashLoadBalancerSettingsArgs{
HttpCookie: &compute.ConsistentHashLoadBalancerSettingsHttpCookieArgs{
Name: pulumi.String("string"),
Path: pulumi.String("string"),
Ttl: &compute.DurationArgs{
Nanos: pulumi.Int(0),
Seconds: pulumi.String("string"),
},
},
HttpHeaderName: pulumi.String("string"),
MinimumRingSize: pulumi.String("string"),
},
CustomRequestHeaders: pulumi.StringArray{
pulumi.String("string"),
},
CustomResponseHeaders: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
EnableCDN: pulumi.Bool(false),
FailoverPolicy: &compute.BackendServiceFailoverPolicyArgs{
DisableConnectionDrainOnFailover: pulumi.Bool(false),
DropTrafficIfUnhealthy: pulumi.Bool(false),
FailoverRatio: pulumi.Float64(0),
},
HealthChecks: pulumi.StringArray{
pulumi.String("string"),
},
Iap: &compute.BackendServiceIAPArgs{
Enabled: pulumi.Bool(false),
Oauth2ClientId: pulumi.String("string"),
Oauth2ClientSecret: pulumi.String("string"),
},
IpAddressSelectionPolicy: computebeta.BackendServiceIpAddressSelectionPolicyIpv4Only,
LoadBalancingScheme: computebeta.BackendServiceLoadBalancingSchemeExternal,
LocalityLbPolicies: compute.BackendServiceLocalityLoadBalancingPolicyConfigArray{
&compute.BackendServiceLocalityLoadBalancingPolicyConfigArgs{
CustomPolicy: &compute.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs{
Data: pulumi.String("string"),
Name: pulumi.String("string"),
},
Policy: &compute.BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs{
Name: computebeta.BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameInvalidLbPolicy,
},
},
},
LocalityLbPolicy: computebeta.BackendServiceLocalityLbPolicyInvalidLbPolicy,
LogConfig: &compute.BackendServiceLogConfigArgs{
Enable: pulumi.Bool(false),
OptionalFields: pulumi.StringArray{
pulumi.String("string"),
},
OptionalMode: computebeta.BackendServiceLogConfigOptionalModeCustom,
SampleRate: pulumi.Float64(0),
},
MaxStreamDuration: &compute.DurationArgs{
Nanos: pulumi.Int(0),
Seconds: pulumi.String("string"),
},
Metadatas: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Network: pulumi.String("string"),
OutlierDetection: &compute.OutlierDetectionArgs{
BaseEjectionTime: &compute.DurationArgs{
Nanos: pulumi.Int(0),
Seconds: pulumi.String("string"),
},
ConsecutiveErrors: pulumi.Int(0),
ConsecutiveGatewayFailure: pulumi.Int(0),
EnforcingConsecutiveErrors: pulumi.Int(0),
EnforcingConsecutiveGatewayFailure: pulumi.Int(0),
EnforcingSuccessRate: pulumi.Int(0),
Interval: &compute.DurationArgs{
Nanos: pulumi.Int(0),
Seconds: pulumi.String("string"),
},
MaxEjectionPercent: pulumi.Int(0),
SuccessRateMinimumHosts: pulumi.Int(0),
SuccessRateRequestVolume: pulumi.Int(0),
SuccessRateStdevFactor: pulumi.Int(0),
},
PortName: pulumi.String("string"),
Project: pulumi.String("string"),
Protocol: computebeta.BackendServiceProtocolGrpc,
RequestId: pulumi.String("string"),
SecuritySettings: &compute.SecuritySettingsArgs{
AwsV4Authentication: &compute.AWSV4SignatureArgs{
AccessKey: pulumi.String("string"),
AccessKeyId: pulumi.String("string"),
AccessKeyVersion: pulumi.String("string"),
OriginRegion: pulumi.String("string"),
},
ClientTlsPolicy: pulumi.String("string"),
SubjectAltNames: pulumi.StringArray{
pulumi.String("string"),
},
},
ServiceBindings: pulumi.StringArray{
pulumi.String("string"),
},
ServiceLbPolicy: pulumi.String("string"),
SessionAffinity: computebeta.BackendServiceSessionAffinityClientIp,
Subsetting: &compute.SubsettingArgs{
Policy: computebeta.SubsettingPolicyConsistentHashSubsetting,
SubsetSize: pulumi.Int(0),
},
TimeoutSec: pulumi.Int(0),
UsedBy: compute.BackendServiceUsedByArray{
&compute.BackendServiceUsedByArgs{
Reference: pulumi.String("string"),
},
},
})
resource "google-native_compute_beta_backend_service" "google-nativeBackendServiceResource" {
lifecycle {
create_before_destroy = true
}
affinity_cookie_ttl_sec = 0
backends {
balancing_mode = "CONNECTION"
capacity_scaler = 0
description = "string"
failover = false
group = "string"
max_connections = 0
max_connections_per_endpoint = 0
max_connections_per_instance = 0
max_rate = 0
max_rate_per_endpoint = 0
max_rate_per_instance = 0
max_utilization = 0
preference = "DEFAULT"
}
cdn_policy = {
bypass_cache_on_request_headers = [{
header_name = "string"
}]
cache_key_policy = {
include_host = false
include_http_headers = ["string"]
include_named_cookies = ["string"]
include_protocol = false
include_query_string = false
query_string_blacklist = ["string"]
query_string_whitelist = ["string"]
}
cache_mode = "CACHE_ALL_STATIC"
client_ttl = 0
default_ttl = 0
max_ttl = 0
negative_caching = false
negative_caching_policy = [{
code = 0
ttl = 0
}]
request_coalescing = false
serve_while_stale = 0
signed_url_cache_max_age_sec = "string"
}
circuit_breakers = {
connect_timeout = {
nanos = 0
seconds = "string"
}
max_connections = 0
max_pending_requests = 0
max_requests = 0
max_requests_per_connection = 0
max_retries = 0
}
compression_mode = "AUTOMATIC"
connection_draining = {
draining_timeout_sec = 0
}
connection_tracking_policy = {
connection_persistence_on_unhealthy_backends = "ALWAYS_PERSIST"
enable_strong_affinity = false
idle_timeout_sec = 0
tracking_mode = "INVALID_TRACKING_MODE"
}
consistent_hash = {
http_cookie = {
name = "string"
path = "string"
ttl = {
nanos = 0
seconds = "string"
}
}
http_header_name = "string"
minimum_ring_size = "string"
}
custom_request_headers = ["string"]
custom_response_headers = ["string"]
description = "string"
enable_cdn = false
failover_policy = {
disable_connection_drain_on_failover = false
drop_traffic_if_unhealthy = false
failover_ratio = 0
}
health_checks = ["string"]
iap = {
enabled = false
oauth2_client_id = "string"
oauth2_client_secret = "string"
}
ip_address_selection_policy = "IPV4_ONLY"
load_balancing_scheme = "EXTERNAL"
locality_lb_policies {
custom_policy = {
data = "string"
name = "string"
}
policy = {
name = "INVALID_LB_POLICY"
}
}
locality_lb_policy = "INVALID_LB_POLICY"
log_config = {
enable = false
optional_fields = ["string"]
optional_mode = "CUSTOM"
sample_rate = 0
}
max_stream_duration = {
nanos = 0
seconds = "string"
}
metadatas = {
"string" = "string"
}
name = "string"
network = "string"
outlier_detection = {
base_ejection_time = {
nanos = 0
seconds = "string"
}
consecutive_errors = 0
consecutive_gateway_failure = 0
enforcing_consecutive_errors = 0
enforcing_consecutive_gateway_failure = 0
enforcing_success_rate = 0
interval = {
nanos = 0
seconds = "string"
}
max_ejection_percent = 0
success_rate_minimum_hosts = 0
success_rate_request_volume = 0
success_rate_stdev_factor = 0
}
port_name = "string"
project = "string"
protocol = "GRPC"
request_id = "string"
security_settings = {
aws_v4_authentication = {
access_key = "string"
access_key_id = "string"
access_key_version = "string"
origin_region = "string"
}
client_tls_policy = "string"
subject_alt_names = ["string"]
}
service_bindings = ["string"]
service_lb_policy = "string"
session_affinity = "CLIENT_IP"
subsetting = {
policy = "CONSISTENT_HASH_SUBSETTING"
subset_size = 0
}
timeout_sec = 0
used_by {
reference = "string"
}
}
var google_nativeBackendServiceResource = new com.pulumi.googlenative.compute.BackendService("google-nativeBackendServiceResource", com.pulumi.googlenative.compute.BackendServiceArgs.builder()
.affinityCookieTtlSec(0)
.backends(com.pulumi.googlenative.compute.inputs.BackendArgs.builder()
.balancingMode(com.pulumi.googlenative.compute_beta.enums.BackendBalancingMode.Connection)
.capacityScaler(0.0)
.description("string")
.failover(false)
.group("string")
.maxConnections(0)
.maxConnectionsPerEndpoint(0)
.maxConnectionsPerInstance(0)
.maxRate(0)
.maxRatePerEndpoint(0.0)
.maxRatePerInstance(0.0)
.maxUtilization(0.0)
.preference(com.pulumi.googlenative.compute_beta.enums.BackendPreference.Default)
.build())
.cdnPolicy(com.pulumi.googlenative.compute.inputs.BackendServiceCdnPolicyArgs.builder()
.bypassCacheOnRequestHeaders(com.pulumi.googlenative.compute.inputs.BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs.builder()
.headerName("string")
.build())
.cacheKeyPolicy(com.pulumi.googlenative.compute.inputs.CacheKeyPolicyArgs.builder()
.includeHost(false)
.includeHttpHeaders("string")
.includeNamedCookies("string")
.includeProtocol(false)
.includeQueryString(false)
.queryStringBlacklist("string")
.queryStringWhitelist("string")
.build())
.cacheMode(com.pulumi.googlenative.compute_beta.enums.BackendServiceCdnPolicyCacheMode.CacheAllStatic)
.clientTtl(0)
.defaultTtl(0)
.maxTtl(0)
.negativeCaching(false)
.negativeCachingPolicy(com.pulumi.googlenative.compute.inputs.BackendServiceCdnPolicyNegativeCachingPolicyArgs.builder()
.code(0)
.ttl(0)
.build())
.requestCoalescing(false)
.serveWhileStale(0)
.signedUrlCacheMaxAgeSec("string")
.build())
.circuitBreakers(com.pulumi.googlenative.compute.inputs.CircuitBreakersArgs.builder()
.connectTimeout(com.pulumi.googlenative.compute.inputs.DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.maxConnections(0)
.maxPendingRequests(0)
.maxRequests(0)
.maxRequestsPerConnection(0)
.maxRetries(0)
.build())
.compressionMode(com.pulumi.googlenative.compute_beta.enums.BackendServiceCompressionMode.Automatic)
.connectionDraining(com.pulumi.googlenative.compute.inputs.ConnectionDrainingArgs.builder()
.drainingTimeoutSec(0)
.build())
.connectionTrackingPolicy(com.pulumi.googlenative.compute.inputs.BackendServiceConnectionTrackingPolicyArgs.builder()
.connectionPersistenceOnUnhealthyBackends(com.pulumi.googlenative.compute_beta.enums.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.AlwaysPersist)
.enableStrongAffinity(false)
.idleTimeoutSec(0)
.trackingMode(com.pulumi.googlenative.compute_beta.enums.BackendServiceConnectionTrackingPolicyTrackingMode.InvalidTrackingMode)
.build())
.consistentHash(com.pulumi.googlenative.compute.inputs.ConsistentHashLoadBalancerSettingsArgs.builder()
.httpCookie(com.pulumi.googlenative.compute.inputs.ConsistentHashLoadBalancerSettingsHttpCookieArgs.builder()
.name("string")
.path("string")
.ttl(com.pulumi.googlenative.compute.inputs.DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.build())
.httpHeaderName("string")
.minimumRingSize("string")
.build())
.customRequestHeaders("string")
.customResponseHeaders("string")
.description("string")
.enableCDN(false)
.failoverPolicy(com.pulumi.googlenative.compute.inputs.BackendServiceFailoverPolicyArgs.builder()
.disableConnectionDrainOnFailover(false)
.dropTrafficIfUnhealthy(false)
.failoverRatio(0.0)
.build())
.healthChecks("string")
.iap(com.pulumi.googlenative.compute.inputs.BackendServiceIAPArgs.builder()
.enabled(false)
.oauth2ClientId("string")
.oauth2ClientSecret("string")
.build())
.ipAddressSelectionPolicy(com.pulumi.googlenative.compute_beta.enums.BackendServiceIpAddressSelectionPolicy.Ipv4Only)
.loadBalancingScheme(com.pulumi.googlenative.compute_beta.enums.BackendServiceLoadBalancingScheme.External)
.localityLbPolicies(com.pulumi.googlenative.compute.inputs.BackendServiceLocalityLoadBalancingPolicyConfigArgs.builder()
.customPolicy(com.pulumi.googlenative.compute.inputs.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs.builder()
.data("string")
.name("string")
.build())
.policy(com.pulumi.googlenative.compute.inputs.BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs.builder()
.name(com.pulumi.googlenative.compute_beta.enums.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.InvalidLbPolicy)
.build())
.build())
.localityLbPolicy(com.pulumi.googlenative.compute_beta.enums.BackendServiceLocalityLbPolicy.InvalidLbPolicy)
.logConfig(com.pulumi.googlenative.compute.inputs.BackendServiceLogConfigArgs.builder()
.enable(false)
.optionalFields("string")
.optionalMode(com.pulumi.googlenative.compute_beta.enums.BackendServiceLogConfigOptionalMode.Custom)
.sampleRate(0.0)
.build())
.maxStreamDuration(com.pulumi.googlenative.compute.inputs.DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.metadatas(Map.of("string", "string"))
.name("string")
.network("string")
.outlierDetection(com.pulumi.googlenative.compute.inputs.OutlierDetectionArgs.builder()
.baseEjectionTime(com.pulumi.googlenative.compute.inputs.DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.consecutiveErrors(0)
.consecutiveGatewayFailure(0)
.enforcingConsecutiveErrors(0)
.enforcingConsecutiveGatewayFailure(0)
.enforcingSuccessRate(0)
.interval(com.pulumi.googlenative.compute.inputs.DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.maxEjectionPercent(0)
.successRateMinimumHosts(0)
.successRateRequestVolume(0)
.successRateStdevFactor(0)
.build())
.portName("string")
.project("string")
.protocol(com.pulumi.googlenative.compute_beta.enums.BackendServiceProtocol.Grpc)
.requestId("string")
.securitySettings(com.pulumi.googlenative.compute.inputs.SecuritySettingsArgs.builder()
.awsV4Authentication(com.pulumi.googlenative.compute.inputs.AWSV4SignatureArgs.builder()
.accessKey("string")
.accessKeyId("string")
.accessKeyVersion("string")
.originRegion("string")
.build())
.clientTlsPolicy("string")
.subjectAltNames("string")
.build())
.serviceBindings("string")
.serviceLbPolicy("string")
.sessionAffinity(com.pulumi.googlenative.compute_beta.enums.BackendServiceSessionAffinity.ClientIp)
.subsetting(com.pulumi.googlenative.compute.inputs.SubsettingArgs.builder()
.policy(com.pulumi.googlenative.compute_beta.enums.SubsettingPolicy.ConsistentHashSubsetting)
.subsetSize(0)
.build())
.timeoutSec(0)
.usedBy(com.pulumi.googlenative.compute.inputs.BackendServiceUsedByArgs.builder()
.reference("string")
.build())
.build());
google_native_backend_service_resource = google_native.compute.beta.BackendService("google-nativeBackendServiceResource",
affinity_cookie_ttl_sec=0,
backends=[{
"balancing_mode": google_native.compute.beta.BackendBalancingMode.CONNECTION,
"capacity_scaler": float(0),
"description": "string",
"failover": False,
"group": "string",
"max_connections": 0,
"max_connections_per_endpoint": 0,
"max_connections_per_instance": 0,
"max_rate": 0,
"max_rate_per_endpoint": float(0),
"max_rate_per_instance": float(0),
"max_utilization": float(0),
"preference": google_native.compute.beta.BackendPreference.DEFAULT,
}],
cdn_policy={
"bypass_cache_on_request_headers": [{
"header_name": "string",
}],
"cache_key_policy": {
"include_host": False,
"include_http_headers": ["string"],
"include_named_cookies": ["string"],
"include_protocol": False,
"include_query_string": False,
"query_string_blacklist": ["string"],
"query_string_whitelist": ["string"],
},
"cache_mode": google_native.compute.beta.BackendServiceCdnPolicyCacheMode.CACHE_ALL_STATIC,
"client_ttl": 0,
"default_ttl": 0,
"max_ttl": 0,
"negative_caching": False,
"negative_caching_policy": [{
"code": 0,
"ttl": 0,
}],
"request_coalescing": False,
"serve_while_stale": 0,
"signed_url_cache_max_age_sec": "string",
},
circuit_breakers={
"connect_timeout": {
"nanos": 0,
"seconds": "string",
},
"max_connections": 0,
"max_pending_requests": 0,
"max_requests": 0,
"max_requests_per_connection": 0,
"max_retries": 0,
},
compression_mode=google_native.compute.beta.BackendServiceCompressionMode.AUTOMATIC,
connection_draining={
"draining_timeout_sec": 0,
},
connection_tracking_policy={
"connection_persistence_on_unhealthy_backends": google_native.compute.beta.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.ALWAYS_PERSIST,
"enable_strong_affinity": False,
"idle_timeout_sec": 0,
"tracking_mode": google_native.compute.beta.BackendServiceConnectionTrackingPolicyTrackingMode.INVALID_TRACKING_MODE,
},
consistent_hash={
"http_cookie": {
"name": "string",
"path": "string",
"ttl": {
"nanos": 0,
"seconds": "string",
},
},
"http_header_name": "string",
"minimum_ring_size": "string",
},
custom_request_headers=["string"],
custom_response_headers=["string"],
description="string",
enable_cdn=False,
failover_policy={
"disable_connection_drain_on_failover": False,
"drop_traffic_if_unhealthy": False,
"failover_ratio": float(0),
},
health_checks=["string"],
iap={
"enabled": False,
"oauth2_client_id": "string",
"oauth2_client_secret": "string",
},
ip_address_selection_policy=google_native.compute.beta.BackendServiceIpAddressSelectionPolicy.IPV4_ONLY,
load_balancing_scheme=google_native.compute.beta.BackendServiceLoadBalancingScheme.EXTERNAL,
locality_lb_policies=[{
"custom_policy": {
"data": "string",
"name": "string",
},
"policy": {
"name": google_native.compute.beta.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.INVALID_LB_POLICY,
},
}],
locality_lb_policy=google_native.compute.beta.BackendServiceLocalityLbPolicy.INVALID_LB_POLICY,
log_config={
"enable": False,
"optional_fields": ["string"],
"optional_mode": google_native.compute.beta.BackendServiceLogConfigOptionalMode.CUSTOM,
"sample_rate": float(0),
},
max_stream_duration={
"nanos": 0,
"seconds": "string",
},
metadatas={
"string": "string",
},
name="string",
network="string",
outlier_detection={
"base_ejection_time": {
"nanos": 0,
"seconds": "string",
},
"consecutive_errors": 0,
"consecutive_gateway_failure": 0,
"enforcing_consecutive_errors": 0,
"enforcing_consecutive_gateway_failure": 0,
"enforcing_success_rate": 0,
"interval": {
"nanos": 0,
"seconds": "string",
},
"max_ejection_percent": 0,
"success_rate_minimum_hosts": 0,
"success_rate_request_volume": 0,
"success_rate_stdev_factor": 0,
},
port_name="string",
project="string",
protocol=google_native.compute.beta.BackendServiceProtocol.GRPC,
request_id="string",
security_settings={
"aws_v4_authentication": {
"access_key": "string",
"access_key_id": "string",
"access_key_version": "string",
"origin_region": "string",
},
"client_tls_policy": "string",
"subject_alt_names": ["string"],
},
service_bindings=["string"],
service_lb_policy="string",
session_affinity=google_native.compute.beta.BackendServiceSessionAffinity.CLIENT_IP,
subsetting={
"policy": google_native.compute.beta.SubsettingPolicy.CONSISTENT_HASH_SUBSETTING,
"subset_size": 0,
},
timeout_sec=0,
used_by=[{
"reference": "string",
}])
const google_nativeBackendServiceResource = new google_native.compute.beta.BackendService("google-nativeBackendServiceResource", {
affinityCookieTtlSec: 0,
backends: [{
balancingMode: google_native.compute.beta.BackendBalancingMode.Connection,
capacityScaler: 0,
description: "string",
failover: false,
group: "string",
maxConnections: 0,
maxConnectionsPerEndpoint: 0,
maxConnectionsPerInstance: 0,
maxRate: 0,
maxRatePerEndpoint: 0,
maxRatePerInstance: 0,
maxUtilization: 0,
preference: google_native.compute.beta.BackendPreference.Default,
}],
cdnPolicy: {
bypassCacheOnRequestHeaders: [{
headerName: "string",
}],
cacheKeyPolicy: {
includeHost: false,
includeHttpHeaders: ["string"],
includeNamedCookies: ["string"],
includeProtocol: false,
includeQueryString: false,
queryStringBlacklist: ["string"],
queryStringWhitelist: ["string"],
},
cacheMode: google_native.compute.beta.BackendServiceCdnPolicyCacheMode.CacheAllStatic,
clientTtl: 0,
defaultTtl: 0,
maxTtl: 0,
negativeCaching: false,
negativeCachingPolicy: [{
code: 0,
ttl: 0,
}],
requestCoalescing: false,
serveWhileStale: 0,
signedUrlCacheMaxAgeSec: "string",
},
circuitBreakers: {
connectTimeout: {
nanos: 0,
seconds: "string",
},
maxConnections: 0,
maxPendingRequests: 0,
maxRequests: 0,
maxRequestsPerConnection: 0,
maxRetries: 0,
},
compressionMode: google_native.compute.beta.BackendServiceCompressionMode.Automatic,
connectionDraining: {
drainingTimeoutSec: 0,
},
connectionTrackingPolicy: {
connectionPersistenceOnUnhealthyBackends: google_native.compute.beta.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.AlwaysPersist,
enableStrongAffinity: false,
idleTimeoutSec: 0,
trackingMode: google_native.compute.beta.BackendServiceConnectionTrackingPolicyTrackingMode.InvalidTrackingMode,
},
consistentHash: {
httpCookie: {
name: "string",
path: "string",
ttl: {
nanos: 0,
seconds: "string",
},
},
httpHeaderName: "string",
minimumRingSize: "string",
},
customRequestHeaders: ["string"],
customResponseHeaders: ["string"],
description: "string",
enableCDN: false,
failoverPolicy: {
disableConnectionDrainOnFailover: false,
dropTrafficIfUnhealthy: false,
failoverRatio: 0,
},
healthChecks: ["string"],
iap: {
enabled: false,
oauth2ClientId: "string",
oauth2ClientSecret: "string",
},
ipAddressSelectionPolicy: google_native.compute.beta.BackendServiceIpAddressSelectionPolicy.Ipv4Only,
loadBalancingScheme: google_native.compute.beta.BackendServiceLoadBalancingScheme.External,
localityLbPolicies: [{
customPolicy: {
data: "string",
name: "string",
},
policy: {
name: google_native.compute.beta.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.InvalidLbPolicy,
},
}],
localityLbPolicy: google_native.compute.beta.BackendServiceLocalityLbPolicy.InvalidLbPolicy,
logConfig: {
enable: false,
optionalFields: ["string"],
optionalMode: google_native.compute.beta.BackendServiceLogConfigOptionalMode.Custom,
sampleRate: 0,
},
maxStreamDuration: {
nanos: 0,
seconds: "string",
},
metadatas: {
string: "string",
},
name: "string",
network: "string",
outlierDetection: {
baseEjectionTime: {
nanos: 0,
seconds: "string",
},
consecutiveErrors: 0,
consecutiveGatewayFailure: 0,
enforcingConsecutiveErrors: 0,
enforcingConsecutiveGatewayFailure: 0,
enforcingSuccessRate: 0,
interval: {
nanos: 0,
seconds: "string",
},
maxEjectionPercent: 0,
successRateMinimumHosts: 0,
successRateRequestVolume: 0,
successRateStdevFactor: 0,
},
portName: "string",
project: "string",
protocol: google_native.compute.beta.BackendServiceProtocol.Grpc,
requestId: "string",
securitySettings: {
awsV4Authentication: {
accessKey: "string",
accessKeyId: "string",
accessKeyVersion: "string",
originRegion: "string",
},
clientTlsPolicy: "string",
subjectAltNames: ["string"],
},
serviceBindings: ["string"],
serviceLbPolicy: "string",
sessionAffinity: google_native.compute.beta.BackendServiceSessionAffinity.ClientIp,
subsetting: {
policy: google_native.compute.beta.SubsettingPolicy.ConsistentHashSubsetting,
subsetSize: 0,
},
timeoutSec: 0,
usedBy: [{
reference: "string",
}],
});
type: google-native:compute/beta:BackendService
properties:
affinityCookieTtlSec: 0
backends:
- balancingMode: CONNECTION
capacityScaler: 0
description: string
failover: false
group: string
maxConnections: 0
maxConnectionsPerEndpoint: 0
maxConnectionsPerInstance: 0
maxRate: 0
maxRatePerEndpoint: 0
maxRatePerInstance: 0
maxUtilization: 0
preference: DEFAULT
cdnPolicy:
bypassCacheOnRequestHeaders:
- headerName: string
cacheKeyPolicy:
includeHost: false
includeHttpHeaders:
- string
includeNamedCookies:
- string
includeProtocol: false
includeQueryString: false
queryStringBlacklist:
- string
queryStringWhitelist:
- string
cacheMode: CACHE_ALL_STATIC
clientTtl: 0
defaultTtl: 0
maxTtl: 0
negativeCaching: false
negativeCachingPolicy:
- code: 0
ttl: 0
requestCoalescing: false
serveWhileStale: 0
signedUrlCacheMaxAgeSec: string
circuitBreakers:
connectTimeout:
nanos: 0
seconds: string
maxConnections: 0
maxPendingRequests: 0
maxRequests: 0
maxRequestsPerConnection: 0
maxRetries: 0
compressionMode: AUTOMATIC
connectionDraining:
drainingTimeoutSec: 0
connectionTrackingPolicy:
connectionPersistenceOnUnhealthyBackends: ALWAYS_PERSIST
enableStrongAffinity: false
idleTimeoutSec: 0
trackingMode: INVALID_TRACKING_MODE
consistentHash:
httpCookie:
name: string
path: string
ttl:
nanos: 0
seconds: string
httpHeaderName: string
minimumRingSize: string
customRequestHeaders:
- string
customResponseHeaders:
- string
description: string
enableCDN: false
failoverPolicy:
disableConnectionDrainOnFailover: false
dropTrafficIfUnhealthy: false
failoverRatio: 0
healthChecks:
- string
iap:
enabled: false
oauth2ClientId: string
oauth2ClientSecret: string
ipAddressSelectionPolicy: IPV4_ONLY
loadBalancingScheme: EXTERNAL
localityLbPolicies:
- customPolicy:
data: string
name: string
policy:
name: INVALID_LB_POLICY
localityLbPolicy: INVALID_LB_POLICY
logConfig:
enable: false
optionalFields:
- string
optionalMode: CUSTOM
sampleRate: 0
maxStreamDuration:
nanos: 0
seconds: string
metadatas:
string: string
name: string
network: string
outlierDetection:
baseEjectionTime:
nanos: 0
seconds: string
consecutiveErrors: 0
consecutiveGatewayFailure: 0
enforcingConsecutiveErrors: 0
enforcingConsecutiveGatewayFailure: 0
enforcingSuccessRate: 0
interval:
nanos: 0
seconds: string
maxEjectionPercent: 0
successRateMinimumHosts: 0
successRateRequestVolume: 0
successRateStdevFactor: 0
portName: string
project: string
protocol: GRPC
requestId: string
securitySettings:
awsV4Authentication:
accessKey: string
accessKeyId: string
accessKeyVersion: string
originRegion: string
clientTlsPolicy: string
subjectAltNames:
- string
serviceBindings:
- string
serviceLbPolicy: string
sessionAffinity: CLIENT_IP
subsetting:
policy: CONSISTENT_HASH_SUBSETTING
subsetSize: 0
timeoutSec: 0
usedBy:
- reference: string
BackendService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BackendService resource accepts the following input properties:
- AffinityCookieTtlSec
int
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- Backends
List<Pulumi.GoogleNative.Compute.Beta.Inputs.Backend>
- The list of backends that serve this BackendService.
- CdnPolicy
Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicy
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- CircuitBreakers
Pulumi.GoogleNative.Compute.Beta.Inputs.CircuitBreakers
- CompressionMode
Pulumi.GoogleNative.Compute.Beta.BackendServiceCompressionMode
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- ConnectionDraining
Pulumi.GoogleNative.Compute.Beta.Inputs.ConnectionDraining
- ConnectionTrackingPolicy
Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceConnectionTrackingPolicy
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- ConsistentHash
Pulumi.GoogleNative.Compute.Beta.Inputs.ConsistentHashLoadBalancerSettings
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
List<string>
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
List<string>
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- Description
string
- An optional description of this resource. Provide this property when you create the resource.
- EnableCDN
bool
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- FailoverPolicy
Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceFailoverPolicy
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- HealthChecks
List<string>
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- Iap
Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceIAP
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- IpAddressSelectionPolicy
Pulumi.GoogleNative.Compute.Beta.BackendServiceIpAddressSelectionPolicy
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- LoadBalancingScheme
Pulumi.GoogleNative.Compute.Beta.BackendServiceLoadBalancingScheme
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- LocalityLbPolicies
List<Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceLocalityLoadBalancingPolicyConfig>
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- LocalityLbPolicy
Pulumi.GoogleNative.Compute.Beta.BackendServiceLocalityLbPolicy
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- LogConfig
Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceLogConfig
- 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.
- MaxStreamDuration
Pulumi.GoogleNative.Compute.Beta.Inputs.Duration
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- Metadatas
Dictionary<string, string>
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- Name
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]([-a-z0-9]*[a-z0-9])? 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
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.
- OutlierDetection
Pulumi.GoogleNative.Compute.Beta.Inputs.OutlierDetection
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- Port
int
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- PortName
string
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- Project
string
- Protocol
Pulumi.GoogleNative.Compute.Beta.BackendServiceProtocol
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- RequestId
string
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- SecuritySettings
Pulumi.GoogleNative.Compute.Beta.Inputs.SecuritySettings
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- ServiceBindings
List<string>
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- ServiceLbPolicy
string
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- SessionAffinity
Pulumi.GoogleNative.Compute.Beta.BackendServiceSessionAffinity
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- Subsetting
Pulumi.GoogleNative.Compute.Beta.Inputs.Subsetting
- TimeoutSec
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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- UsedBy
List<Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceUsedBy>
- AffinityCookieTtlSec
int
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- Backends
[]BackendArgs
- The list of backends that serve this BackendService.
- CdnPolicy
BackendServiceCdnPolicyArgs
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- CircuitBreakers
CircuitBreakersArgs
- CompressionMode
BackendServiceCompressionMode
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- ConnectionDraining
ConnectionDrainingArgs
- ConnectionTrackingPolicy
BackendServiceConnectionTrackingPolicyArgs
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- ConsistentHash
ConsistentHashLoadBalancerSettingsArgs
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
[]string
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
[]string
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- Description
string
- An optional description of this resource. Provide this property when you create the resource.
- EnableCDN
bool
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- FailoverPolicy
BackendServiceFailoverPolicyArgs
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- HealthChecks
[]string
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- Iap
BackendServiceIAPArgs
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- IpAddressSelectionPolicy
BackendServiceIpAddressSelectionPolicy
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- LoadBalancingScheme
BackendServiceLoadBalancingScheme
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- LocalityLbPolicies
[]BackendServiceLocalityLoadBalancingPolicyConfigArgs
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- LocalityLbPolicy
BackendServiceLocalityLbPolicy
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- LogConfig
BackendServiceLogConfigArgs
- 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.
- MaxStreamDuration
DurationArgs
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- Metadatas
map[string]string
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- Name
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]([-a-z0-9]*[a-z0-9])? 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
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.
- OutlierDetection
OutlierDetectionArgs
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- Port
int
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- PortName
string
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- Project
string
- Protocol
BackendServiceProtocol
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- RequestId
string
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- SecuritySettings
SecuritySettingsArgs
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- ServiceBindings
[]string
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- ServiceLbPolicy
string
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- SessionAffinity
BackendServiceSessionAffinity
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- Subsetting
SubsettingArgs
- TimeoutSec
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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- UsedBy
[]BackendServiceUsedByArgs
- affinity_cookie_ttl_sec
number
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- backends
list(object)
- The list of backends that serve this BackendService.
- cdn_policy
object
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuit_breakers
object
- compression_mode
"AUTOMATIC" | "DISABLED"
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connection_draining
object
- connection_tracking_policy
object
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- consistent_hash
object
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
list(string)
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
list(string)
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- description
string
- An optional description of this resource. Provide this property when you create the resource.
- enable_cdn
bool
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failover_policy
object
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- health_checks
list(string)
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- iap
object
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ip_address_selection_policy
"IPV4_ONLY" | "IPV6_ONLY" | "IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED" | "PREFER_IPV6"
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- load_balancing_scheme
"EXTERNAL" | "EXTERNAL_MANAGED" | "INTERNAL" | "INTERNAL_MANAGED" | "INTERNAL_SELF_MANAGED" | "INVALID_LOAD_BALANCING_SCHEME"
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- locality_lb_policies
list(object)
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- locality_lb_policy
"INVALID_LB_POLICY" | "LEAST_REQUEST" | "MAGLEV" | "ORIGINAL_DESTINATION" | "RANDOM" | "RING_HASH" | "ROUND_ROBIN" | "WEIGHTED_MAGLEV"
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- log_config
object
- 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.
- max_stream_duration
object
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- metadatas
map(string)
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- name
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]([-a-z0-9]*[a-z0-9])? 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
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
object
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- port
number
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- port_name
string
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- project
string
- protocol
"GRPC" | "HTTP" | "HTTP2" | "HTTPS" | "SSL" | "TCP" | "UDP" | "UNSPECIFIED"
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- request_id
string
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- security_settings
object
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- service_bindings
list(string)
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- service_lb_policy
string
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- session_affinity
"CLIENT_IP" | "CLIENT_IP_NO_DESTINATION" | "CLIENT_IP_PORT_PROTO" | "CLIENT_IP_PROTO" | "GENERATED_COOKIE" | "HEADER_FIELD" | "HTTP_COOKIE" | "NONE"
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- subsetting
object
- timeout_sec
number
- 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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- used_by
list(object)
- affinityCookieTtlSec
Integer
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- backends
List<Backend>
- The list of backends that serve this BackendService.
- cdnPolicy
BackendServiceCdnPolicy
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuitBreakers
CircuitBreakers
- compressionMode
BackendServiceCompressionMode
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connectionDraining
ConnectionDraining
- connectionTrackingPolicy
BackendServiceConnectionTrackingPolicy
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- consistentHash
ConsistentHashLoadBalancerSettings
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
List<String>
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
List<String>
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- description
String
- An optional description of this resource. Provide this property when you create the resource.
- enableCDN
Boolean
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failoverPolicy
BackendServiceFailoverPolicy
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- healthChecks
List<String>
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- iap
BackendServiceIAP
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ipAddressSelectionPolicy
BackendServiceIpAddressSelectionPolicy
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- loadBalancingScheme
BackendServiceLoadBalancingScheme
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- localityLbPolicies
List<BackendServiceLocalityLoadBalancingPolicyConfig>
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- localityLbPolicy
BackendServiceLocalityLbPolicy
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- logConfig
BackendServiceLogConfig
- 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.
- maxStreamDuration
Duration
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- metadatas
Map<String,String>
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- name
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]([-a-z0-9]*[a-z0-9])? 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
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.
- outlierDetection
OutlierDetection
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- port
Integer
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- portName
String
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- project
String
- protocol
BackendServiceProtocol
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- requestId
String
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- securitySettings
SecuritySettings
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- serviceBindings
List<String>
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- serviceLbPolicy
String
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- sessionAffinity
BackendServiceSessionAffinity
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- subsetting
Subsetting
- timeoutSec
Integer
- 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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- usedBy
List<BackendServiceUsedBy>
- affinityCookieTtlSec
number
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- backends
Backend[]
- The list of backends that serve this BackendService.
- cdnPolicy
BackendServiceCdnPolicy
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuitBreakers
CircuitBreakers
- compressionMode
BackendServiceCompressionMode
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connectionDraining
ConnectionDraining
- connectionTrackingPolicy
BackendServiceConnectionTrackingPolicy
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- consistentHash
ConsistentHashLoadBalancerSettings
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
string[]
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
string[]
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- description
string
- An optional description of this resource. Provide this property when you create the resource.
- enableCDN
boolean
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failoverPolicy
BackendServiceFailoverPolicy
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- healthChecks
string[]
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- iap
BackendServiceIAP
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ipAddressSelectionPolicy
BackendServiceIpAddressSelectionPolicy
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- loadBalancingScheme
BackendServiceLoadBalancingScheme
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- localityLbPolicies
BackendServiceLocalityLoadBalancingPolicyConfig[]
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- localityLbPolicy
BackendServiceLocalityLbPolicy
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- logConfig
BackendServiceLogConfig
- 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.
- maxStreamDuration
Duration
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- metadatas
{[key: string]: string}
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- name
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]([-a-z0-9]*[a-z0-9])? 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
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.
- outlierDetection
OutlierDetection
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- port
number
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- portName
string
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- project
string
- protocol
BackendServiceProtocol
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- requestId
string
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- securitySettings
SecuritySettings
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- serviceBindings
string[]
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- serviceLbPolicy
string
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- sessionAffinity
BackendServiceSessionAffinity
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- subsetting
Subsetting
- timeoutSec
number
- 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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- usedBy
BackendServiceUsedBy[]
- affinity_cookie_ttl_sec
int
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- backends
Sequence[BackendArgs]
- The list of backends that serve this BackendService.
- cdn_policy
BackendServiceCdnPolicyArgs
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuit_breakers
CircuitBreakersArgs
- compression_mode
BackendServiceCompressionMode
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connection_draining
ConnectionDrainingArgs
- connection_tracking_policy
BackendServiceConnectionTrackingPolicyArgs
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- consistent_hash
ConsistentHashLoadBalancerSettingsArgs
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
Sequence[str]
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
Sequence[str]
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- description
str
- An optional description of this resource. Provide this property when you create the resource.
- enable_cdn
bool
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failover_policy
BackendServiceFailoverPolicyArgs
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- health_checks
Sequence[str]
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- iap
BackendServiceIAPArgs
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ip_address_selection_policy
BackendServiceIpAddressSelectionPolicy
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- load_balancing_scheme
BackendServiceLoadBalancingScheme
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- locality_lb_policies
Sequence[BackendServiceLocalityLoadBalancingPolicyConfigArgs]
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- locality_lb_policy
BackendServiceLocalityLbPolicy
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- log_config
BackendServiceLogConfigArgs
- 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.
- max_stream_duration
DurationArgs
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- metadatas
Mapping[str, str]
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- name
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]([-a-z0-9]*[a-z0-9])? 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
str
- 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
OutlierDetectionArgs
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- port
int
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- port_name
str
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- project
str
- protocol
BackendServiceProtocol
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- request_id
str
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- security_settings
SecuritySettingsArgs
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- service_bindings
Sequence[str]
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- service_lb_policy
str
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- session_affinity
BackendServiceSessionAffinity
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- subsetting
SubsettingArgs
- timeout_sec
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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- used_by
Sequence[BackendServiceUsedByArgs]
- affinityCookieTtlSec
Number
- Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- backends
List<Property Map>
- The list of backends that serve this BackendService.
- cdnPolicy
Property Map
- Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuitBreakers
Property Map
- compressionMode
"AUTOMATIC" | "DISABLED"
- Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connectionDraining
Property Map
- connectionTrackingPolicy
Property Map
- Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
- consistentHash
Property Map
- 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
-
List<String>
- Headers that the load balancer adds to proxied requests. See Creating custom headers.
-
List<String>
- Headers that the load balancer adds to proxied responses. See Creating custom headers.
- description
String
- An optional description of this resource. Provide this property when you create the resource.
- enableCDN
Boolean
- If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failoverPolicy
Property Map
- Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- healthChecks
List<String>
- The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
- iap
Property Map
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ipAddressSelectionPolicy
"IPV4_ONLY" | "IPV6_ONLY" | "IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED" | "PREFER_IPV6"
- Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
- loadBalancingScheme
"EXTERNAL" | "EXTERNAL_MANAGED" | "INTERNAL" | "INTERNAL_MANAGED" | "INTERNAL_SELF_MANAGED" | "INVALID_LOAD_BALANCING_SCHEME"
- Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
- localityLbPolicies
List<Property Map>
- A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
- localityLbPolicy
"INVALID_LB_POLICY" | "LEAST_REQUEST" | "MAGLEV" | "ORIGINAL_DESTINATION" | "RANDOM" | "RING_HASH" | "ROUND_ROBIN" | "WEIGHTED_MAGLEV"
- 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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
- logConfig
Property Map
- 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.
- maxStreamDuration
Property Map
- Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
- metadatas
Map<String>
- Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
- name
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]([-a-z0-9]*[a-z0-9])? 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
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.
- outlierDetection
Property Map
- Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- port
Number
- Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Deprecated: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
- portName
String
- A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
- project
String
- protocol
"GRPC" | "HTTP" | "HTTP2" | "HTTPS" | "SSL" | "TCP" | "UDP" | "UNSPECIFIED"
- The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
- requestId
String
- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- securitySettings
Property Map
- This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- serviceBindings
List<String>
- URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
- serviceLbPolicy
String
- URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
- sessionAffinity
"CLIENT_IP" | "CLIENT_IP_NO_DESTINATION" | "CLIENT_IP_PORT_PROTO" | "CLIENT_IP_PROTO" | "GENERATED_COOKIE" | "HEADER_FIELD" | "HTTP_COOKIE" | "NONE"
- Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
- subsetting
Property Map
- timeoutSec
Number
- 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. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
- usedBy
List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the BackendService resource produces the following output properties:
- CreationTimestamp
string
- Creation timestamp in RFC3339 text format.
- EdgeSecurityPolicy
string
- The resource URL for the edge security policy associated with this backend service.
- Fingerprint
string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Kind
string
- Type of resource. Always compute#backendService for backend services.
- Region
string
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- SecurityPolicy
string
- The resource URL for the security policy associated with this backend service.
- SelfLink
string
- Server-defined URL for the resource.
- CreationTimestamp
string
- Creation timestamp in RFC3339 text format.
- EdgeSecurityPolicy
string
- The resource URL for the edge security policy associated with this backend service.
- Fingerprint
string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Kind
string
- Type of resource. Always compute#backendService for backend services.
- Region
string
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- SecurityPolicy
string
- The resource URL for the security policy associated with this backend service.
- SelfLink
string
- Server-defined URL for the resource.
- creation_timestamp
string
- Creation timestamp in RFC3339 text format.
- edge_security_policy
string
- The resource URL for the edge security policy associated with this backend service.
- fingerprint
string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- id
string
- The provider-assigned unique ID for this managed resource.
- kind
string
- Type of resource. Always compute#backendService for backend services.
- region
string
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- security_policy
string
- The resource URL for the security policy associated with this backend service.
- self_link
string
- Server-defined URL for the resource.
- creationTimestamp
String
- Creation timestamp in RFC3339 text format.
- edgeSecurityPolicy
String
- The resource URL for the edge security policy associated with this backend service.
- fingerprint
String
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- id
String
- The provider-assigned unique ID for this managed resource.
- kind
String
- Type of resource. Always compute#backendService for backend services.
- region
String
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- securityPolicy
String
- The resource URL for the security policy associated with this backend service.
- selfLink
String
- Server-defined URL for the resource.
- creationTimestamp
string
- Creation timestamp in RFC3339 text format.
- edgeSecurityPolicy
string
- The resource URL for the edge security policy associated with this backend service.
- fingerprint
string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- id
string
- The provider-assigned unique ID for this managed resource.
- kind
string
- Type of resource. Always compute#backendService for backend services.
- region
string
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- securityPolicy
string
- The resource URL for the security policy associated with this backend service.
- selfLink
string
- Server-defined URL for the resource.
- creation_timestamp
str
- Creation timestamp in RFC3339 text format.
- edge_security_policy
str
- The resource URL for the edge security policy associated with this backend service.
- fingerprint
str
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- id
str
- The provider-assigned unique ID for this managed resource.
- kind
str
- Type of resource. Always compute#backendService for backend services.
- region
str
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- security_policy
str
- The resource URL for the security policy associated with this backend service.
- self_link
str
- Server-defined URL for the resource.
- creationTimestamp
String
- Creation timestamp in RFC3339 text format.
- edgeSecurityPolicy
String
- The resource URL for the edge security policy associated with this backend service.
- fingerprint
String
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
- id
String
- The provider-assigned unique ID for this managed resource.
- kind
String
- Type of resource. Always compute#backendService for backend services.
- region
String
- URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- securityPolicy
String
- The resource URL for the security policy associated with this backend service.
- selfLink
String
- Server-defined URL for the resource.
Look up Existing BackendService Resource
Get an existing BackendService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static BackendService get(String name, Output<String> id, CustomResourceOptions options)
resources: existingBackendService: type: google-native:compute/beta:BackendService get: id: ${id}
import {
to = google-native_compute_beta_backend_service.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
BackendServiceState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
AWSV4Signature, AWSV4SignatureArgs
Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.
- AccessKey
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- AccessKeyId
string
- The identifier of an access key used for s3 bucket authentication.
- AccessKeyVersion
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- OriginRegion
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- AccessKey
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- AccessKeyId
string
- The identifier of an access key used for s3 bucket authentication.
- AccessKeyVersion
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- OriginRegion
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- access_key
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- access_key_id
string
- The identifier of an access key used for s3 bucket authentication.
- access_key_version
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- origin_region
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- accessKey
String
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- accessKeyId
String
- The identifier of an access key used for s3 bucket authentication.
- accessKeyVersion
String
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- originRegion
String
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- accessKey
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- accessKeyId
string
- The identifier of an access key used for s3 bucket authentication.
- accessKeyVersion
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- originRegion
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- access_key
str
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- access_key_id
str
- The identifier of an access key used for s3 bucket authentication.
- access_key_version
str
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- origin_region
str
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- accessKey
String
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- accessKeyId
String
- The identifier of an access key used for s3 bucket authentication.
- accessKeyVersion
String
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- originRegion
String
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
AWSV4SignatureResponse
Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.
- AccessKey
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- AccessKeyId
string
- The identifier of an access key used for s3 bucket authentication.
- AccessKeyVersion
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- OriginRegion
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- AccessKey
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- AccessKeyId
string
- The identifier of an access key used for s3 bucket authentication.
- AccessKeyVersion
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- OriginRegion
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- access_key
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- access_key_id
string
- The identifier of an access key used for s3 bucket authentication.
- access_key_version
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- origin_region
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- accessKey
String
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- accessKeyId
String
- The identifier of an access key used for s3 bucket authentication.
- accessKeyVersion
String
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- originRegion
String
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- accessKey
string
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- accessKeyId
string
- The identifier of an access key used for s3 bucket authentication.
- accessKeyVersion
string
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- originRegion
string
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- access_key
str
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- access_key_id
str
- The identifier of an access key used for s3 bucket authentication.
- access_key_version
str
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- origin_region
str
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
- accessKey
String
- The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
- accessKeyId
String
- The identifier of an access key used for s3 bucket authentication.
- accessKeyVersion
String
- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
- originRegion
String
- The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
Backend, BackendArgs
Message containing information of one individual backend.
- BalancingMode
Pulumi.GoogleNative.Compute.Beta.BackendBalancingMode
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- CapacityScaler
double
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- Description
string
- An optional description of this resource. Provide this property when you create the resource.
- Failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- Group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- MaxConnections
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerEndpoint
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerInstance
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxRate
int
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerEndpoint
double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerInstance
double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxUtilization
double
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- Preference
Pulumi.GoogleNative.Compute.Beta.BackendPreference
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- BalancingMode
BackendBalancingMode
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- CapacityScaler
float64
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- Description
string
- An optional description of this resource. Provide this property when you create the resource.
- Failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- Group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- MaxConnections
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerEndpoint
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerInstance
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxRate
int
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerEndpoint
float64
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerInstance
float64
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxUtilization
float64
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- Preference
BackendPreference
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancing_mode
"CONNECTION" | "RATE" | "UTILIZATION"
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacity_scaler
number
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
string
- An optional description of this resource. Provide this property when you create the resource.
- failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- max_connections
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_endpoint
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_instance
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_rate
number
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_endpoint
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_instance
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_utilization
number
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
"DEFAULT" | "PREFERENCE_UNSPECIFIED" | "PREFERRED"
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancingMode
BackendBalancingMode
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacityScaler
Double
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
String
- An optional description of this resource. Provide this property when you create the resource.
- failover
Boolean
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
String
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- maxConnections
Integer
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerEndpoint
Integer
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerInstance
Integer
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxRate
Integer
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerEndpoint
Double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerInstance
Double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxUtilization
Double
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
BackendPreference
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancingMode
BackendBalancingMode
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacityScaler
number
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
string
- An optional description of this resource. Provide this property when you create the resource.
- failover
boolean
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- maxConnections
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerEndpoint
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerInstance
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxRate
number
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerEndpoint
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerInstance
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxUtilization
number
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
BackendPreference
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancing_mode
BackendBalancingMode
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacity_scaler
float
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
str
- An optional description of this resource. Provide this property when you create the resource.
- failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
str
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- max_connections
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_endpoint
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_instance
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_rate
int
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_endpoint
float
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_instance
float
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_utilization
float
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
BackendPreference
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancingMode
"CONNECTION" | "RATE" | "UTILIZATION"
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacityScaler
Number
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
String
- An optional description of this resource. Provide this property when you create the resource.
- failover
Boolean
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
String
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- maxConnections
Number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerEndpoint
Number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerInstance
Number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxRate
Number
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerEndpoint
Number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerInstance
Number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxUtilization
Number
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
"DEFAULT" | "PREFERENCE_UNSPECIFIED" | "PREFERRED"
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
BackendBalancingMode
Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
| Name | Value | Description |
|---|
| Connection | CONNECTION | Balance based on the number of simultaneous connections. |
| Rate | RATE | Balance based on requests per second (RPS). |
| Utilization | UTILIZATION | Balance based on the backend utilization. |
| Name | Value | Description |
|---|
| BackendBalancingModeConnection | CONNECTION | Balance based on the number of simultaneous connections. |
| BackendBalancingModeRate | RATE | Balance based on requests per second (RPS). |
| BackendBalancingModeUtilization | UTILIZATION | Balance based on the backend utilization. |
| Value | Description |
|---|
CONNECTION | Balance based on the number of simultaneous connections. |
RATE | Balance based on requests per second (RPS). |
UTILIZATION | Balance based on the backend utilization. |
| Name | Value | Description |
|---|
| Connection | CONNECTION | Balance based on the number of simultaneous connections. |
| Rate | RATE | Balance based on requests per second (RPS). |
| Utilization | UTILIZATION | Balance based on the backend utilization. |
| Name | Value | Description |
|---|
| Connection | CONNECTION | Balance based on the number of simultaneous connections. |
| Rate | RATE | Balance based on requests per second (RPS). |
| Utilization | UTILIZATION | Balance based on the backend utilization. |
| Name | Value | Description |
|---|
| CONNECTION | CONNECTION | Balance based on the number of simultaneous connections. |
| RATE | RATE | Balance based on requests per second (RPS). |
| UTILIZATION | UTILIZATION | Balance based on the backend utilization. |
| Value | Description |
|---|
CONNECTION | Balance based on the number of simultaneous connections. |
RATE | Balance based on requests per second (RPS). |
UTILIZATION | Balance based on the backend utilization. |
BackendPreference
This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
| Name | Value | Description |
|---|
| Default | DEFAULT | No preference. |
| PreferenceUnspecified | PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
| Preferred | PREFERRED | Traffic will be sent to this backend first. |
| Name | Value | Description |
|---|
| BackendPreferenceDefault | DEFAULT | No preference. |
| BackendPreferencePreferenceUnspecified | PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
| BackendPreferencePreferred | PREFERRED | Traffic will be sent to this backend first. |
| Value | Description |
|---|
DEFAULT | No preference. |
PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
PREFERRED | Traffic will be sent to this backend first. |
| Name | Value | Description |
|---|
| Default | DEFAULT | No preference. |
| PreferenceUnspecified | PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
| Preferred | PREFERRED | Traffic will be sent to this backend first. |
| Name | Value | Description |
|---|
| Default | DEFAULT | No preference. |
| PreferenceUnspecified | PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
| Preferred | PREFERRED | Traffic will be sent to this backend first. |
| Name | Value | Description |
|---|
| DEFAULT | DEFAULT | No preference. |
| PREFERENCE_UNSPECIFIED | PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
| PREFERRED | PREFERRED | Traffic will be sent to this backend first. |
| Value | Description |
|---|
DEFAULT | No preference. |
PREFERENCE_UNSPECIFIED | If preference is unspecified, we set it to the DEFAULT value |
PREFERRED | Traffic will be sent to this backend first. |
BackendResponse
Message containing information of one individual backend.
- BalancingMode
string
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- CapacityScaler
double
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- Description
string
- An optional description of this resource. Provide this property when you create the resource.
- Failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- Group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- MaxConnections
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerEndpoint
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerInstance
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxRate
int
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerEndpoint
double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerInstance
double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxUtilization
double
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- Preference
string
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- BalancingMode
string
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- CapacityScaler
float64
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- Description
string
- An optional description of this resource. Provide this property when you create the resource.
- Failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- Group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- MaxConnections
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerEndpoint
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxConnectionsPerInstance
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- MaxRate
int
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerEndpoint
float64
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxRatePerInstance
float64
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- MaxUtilization
float64
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- Preference
string
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancing_mode
string
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacity_scaler
number
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
string
- An optional description of this resource. Provide this property when you create the resource.
- failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- max_connections
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_endpoint
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_instance
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_rate
number
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_endpoint
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_instance
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_utilization
number
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
string
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancingMode
String
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacityScaler
Double
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
String
- An optional description of this resource. Provide this property when you create the resource.
- failover
Boolean
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
String
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- maxConnections
Integer
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerEndpoint
Integer
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerInstance
Integer
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxRate
Integer
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerEndpoint
Double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerInstance
Double
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxUtilization
Double
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
String
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancingMode
string
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacityScaler
number
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
string
- An optional description of this resource. Provide this property when you create the resource.
- failover
boolean
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
string
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- maxConnections
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerEndpoint
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerInstance
number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxRate
number
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerEndpoint
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerInstance
number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxUtilization
number
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
string
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancing_mode
str
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacity_scaler
float
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
str
- An optional description of this resource. Provide this property when you create the resource.
- failover
bool
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
str
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- max_connections
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_endpoint
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_connections_per_instance
int
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- max_rate
int
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_endpoint
float
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_rate_per_instance
float
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- max_utilization
float
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
str
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
- balancingMode
String
- Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
- capacityScaler
Number
- A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
- description
String
- An optional description of this resource. Provide this property when you create the resource.
- failover
Boolean
- This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
- group
String
- The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
- maxConnections
Number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerEndpoint
Number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxConnectionsPerInstance
Number
- Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.
- maxRate
Number
- Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerEndpoint
Number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxRatePerInstance
Number
- Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.
- maxUtilization
Number
- Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
- preference
String
- This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
BackendServiceCdnPolicy, BackendServiceCdnPolicyArgs
Message containing Cloud CDN configuration for a backend service.
-
List<Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyBypassCacheOnRequestHeader>
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- CacheKeyPolicy
Pulumi.GoogleNative.Compute.Beta.Inputs.CacheKeyPolicy
- The CacheKeyPolicy for this CdnPolicy.
- CacheMode
Pulumi.GoogleNative.Compute.Beta.BackendServiceCdnPolicyCacheMode
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- ClientTtl
int
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- DefaultTtl
int
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- MaxTtl
int
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- NegativeCaching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- NegativeCachingPolicy
List<Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyNegativeCachingPolicy>
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- RequestCoalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- ServeWhileStale
int
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- SignedUrlCacheMaxAgeSec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
-
[]BackendServiceCdnPolicyBypassCacheOnRequestHeader
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- CacheKeyPolicy
CacheKeyPolicy
- The CacheKeyPolicy for this CdnPolicy.
- CacheMode
BackendServiceCdnPolicyCacheMode
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- ClientTtl
int
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- DefaultTtl
int
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- MaxTtl
int
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- NegativeCaching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- NegativeCachingPolicy
[]BackendServiceCdnPolicyNegativeCachingPolicy
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- RequestCoalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- ServeWhileStale
int
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- SignedUrlCacheMaxAgeSec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
-
list(object)
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cache_key_policy
object
- The CacheKeyPolicy for this CdnPolicy.
- cache_mode
"CACHE_ALL_STATIC" | "FORCE_CACHE_ALL" | "INVALID_CACHE_MODE" | "USE_ORIGIN_HEADERS"
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- client_ttl
number
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- default_ttl
number
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- max_ttl
number
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negative_caching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negative_caching_policy
list(object)
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- request_coalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve_while_stale
number
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signed_url_cache_max_age_sec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
-
List<BackendServiceCdnPolicyBypassCacheOnRequestHeader>
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cacheKeyPolicy
CacheKeyPolicy
- The CacheKeyPolicy for this CdnPolicy.
- cacheMode
BackendServiceCdnPolicyCacheMode
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- clientTtl
Integer
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- defaultTtl
Integer
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- maxTtl
Integer
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negativeCaching
Boolean
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negativeCachingPolicy
List<BackendServiceCdnPolicyNegativeCachingPolicy>
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- requestCoalescing
Boolean
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serveWhileStale
Integer
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signedUrlCacheMaxAgeSec
String
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
-
BackendServiceCdnPolicyBypassCacheOnRequestHeader[]
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cacheKeyPolicy
CacheKeyPolicy
- The CacheKeyPolicy for this CdnPolicy.
- cacheMode
BackendServiceCdnPolicyCacheMode
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- clientTtl
number
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- defaultTtl
number
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- maxTtl
number
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negativeCaching
boolean
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negativeCachingPolicy
BackendServiceCdnPolicyNegativeCachingPolicy[]
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- requestCoalescing
boolean
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serveWhileStale
number
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signedUrlCacheMaxAgeSec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
-
Sequence[BackendServiceCdnPolicyBypassCacheOnRequestHeader]
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cache_key_policy
CacheKeyPolicy
- The CacheKeyPolicy for this CdnPolicy.
- cache_mode
BackendServiceCdnPolicyCacheMode
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- client_ttl
int
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- default_ttl
int
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- max_ttl
int
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negative_caching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negative_caching_policy
Sequence[BackendServiceCdnPolicyNegativeCachingPolicy]
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- request_coalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve_while_stale
int
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signed_url_cache_max_age_sec
str
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
-
List<Property Map>
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cacheKeyPolicy
Property Map
- The CacheKeyPolicy for this CdnPolicy.
- cacheMode
"CACHE_ALL_STATIC" | "FORCE_CACHE_ALL" | "INVALID_CACHE_MODE" | "USE_ORIGIN_HEADERS"
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- clientTtl
Number
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- defaultTtl
Number
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- maxTtl
Number
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negativeCaching
Boolean
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negativeCachingPolicy
List<Property Map>
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- requestCoalescing
Boolean
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serveWhileStale
Number
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signedUrlCacheMaxAgeSec
String
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
String
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
str
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
String
- The header field name to match on when bypassing cache. Values are case-insensitive.
Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
String
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
string
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
str
- The header field name to match on when bypassing cache. Values are case-insensitive.
-
String
- The header field name to match on when bypassing cache. Values are case-insensitive.
BackendServiceCdnPolicyCacheMode
Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
| Name | Value | Description |
|---|
| CacheAllStatic | CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
| ForceCacheAll | FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
| InvalidCacheMode | INVALID_CACHE_MODE | |
| UseOriginHeaders | USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
| Name | Value | Description |
|---|
| BackendServiceCdnPolicyCacheModeCacheAllStatic | CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
| BackendServiceCdnPolicyCacheModeForceCacheAll | FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
| BackendServiceCdnPolicyCacheModeInvalidCacheMode | INVALID_CACHE_MODE | |
| BackendServiceCdnPolicyCacheModeUseOriginHeaders | USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
| Value | Description |
|---|
CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
INVALID_CACHE_MODE | |
USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
| Name | Value | Description |
|---|
| CacheAllStatic | CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
| ForceCacheAll | FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
| InvalidCacheMode | INVALID_CACHE_MODE | |
| UseOriginHeaders | USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
| Name | Value | Description |
|---|
| CacheAllStatic | CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
| ForceCacheAll | FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
| InvalidCacheMode | INVALID_CACHE_MODE | |
| UseOriginHeaders | USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
| Name | Value | Description |
|---|
| CACHE_ALL_STATIC | CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
| FORCE_CACHE_ALL | FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
| INVALID_CACHE_MODE | INVALID_CACHE_MODE | |
| USE_ORIGIN_HEADERS | USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
| Value | Description |
|---|
CACHE_ALL_STATIC | Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. |
FORCE_CACHE_ALL | Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. |
INVALID_CACHE_MODE | |
USE_ORIGIN_HEADERS | Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. |
BackendServiceCdnPolicyNegativeCachingPolicy, BackendServiceCdnPolicyNegativeCachingPolicyArgs
Specify CDN TTLs for response error codes.
- Code
int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- Ttl
int
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- Code
int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- Ttl
int
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
number
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
number
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
Integer
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
Integer
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
number
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
number
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
int
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
Number
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
Number
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
BackendServiceCdnPolicyNegativeCachingPolicyResponse
Specify CDN TTLs for response error codes.
- Code
int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- Ttl
int
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- Code
int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- Ttl
int
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
number
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
number
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
Integer
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
Integer
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
number
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
number
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
int
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- code
Number
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
- ttl
Number
- The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
BackendServiceCdnPolicyResponse
Message containing Cloud CDN configuration for a backend service.
-
List<Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponse>
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- CacheKeyPolicy
Pulumi.GoogleNative.Compute.Beta.Inputs.CacheKeyPolicyResponse
- The CacheKeyPolicy for this CdnPolicy.
- CacheMode
string
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- ClientTtl
int
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- DefaultTtl
int
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- MaxTtl
int
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- NegativeCaching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- NegativeCachingPolicy
List<Pulumi.GoogleNative.Compute.Beta.Inputs.BackendServiceCdnPolicyNegativeCachingPolicyResponse>
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- RequestCoalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- ServeWhileStale
int
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- SignedUrlCacheMaxAgeSec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- SignedUrlKeyNames
List<string>
- Names of the keys for signing request URLs.
-
[]BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponse
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- CacheKeyPolicy
CacheKeyPolicyResponse
- The CacheKeyPolicy for this CdnPolicy.
- CacheMode
string
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- ClientTtl
int
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- DefaultTtl
int
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- MaxTtl
int
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- NegativeCaching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- NegativeCachingPolicy
[]BackendServiceCdnPolicyNegativeCachingPolicyResponse
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- RequestCoalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- ServeWhileStale
int
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- SignedUrlCacheMaxAgeSec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- SignedUrlKeyNames
[]string
- Names of the keys for signing request URLs.
-
list(object)
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cache_key_policy
object
- The CacheKeyPolicy for this CdnPolicy.
- cache_mode
string
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- client_ttl
number
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- default_ttl
number
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- max_ttl
number
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negative_caching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negative_caching_policy
list(object)
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- request_coalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve_while_stale
number
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signed_url_cache_max_age_sec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- signed_url_key_names
list(string)
- Names of the keys for signing request URLs.
-
List<BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponse>
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cacheKeyPolicy
CacheKeyPolicyResponse
- The CacheKeyPolicy for this CdnPolicy.
- cacheMode
String
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- clientTtl
Integer
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- defaultTtl
Integer
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- maxTtl
Integer
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negativeCaching
Boolean
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negativeCachingPolicy
List<BackendServiceCdnPolicyNegativeCachingPolicyResponse>
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- requestCoalescing
Boolean
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serveWhileStale
Integer
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signedUrlCacheMaxAgeSec
String
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- signedUrlKeyNames
List<String>
- Names of the keys for signing request URLs.
-
BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponse[]
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cacheKeyPolicy
CacheKeyPolicyResponse
- The CacheKeyPolicy for this CdnPolicy.
- cacheMode
string
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- clientTtl
number
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- defaultTtl
number
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- maxTtl
number
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negativeCaching
boolean
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negativeCachingPolicy
BackendServiceCdnPolicyNegativeCachingPolicyResponse[]
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- requestCoalescing
boolean
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serveWhileStale
number
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signedUrlCacheMaxAgeSec
string
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- signedUrlKeyNames
string[]
- Names of the keys for signing request URLs.
-
Sequence[BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponse]
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cache_key_policy
CacheKeyPolicyResponse
- The CacheKeyPolicy for this CdnPolicy.
- cache_mode
str
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- client_ttl
int
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- default_ttl
int
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- max_ttl
int
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negative_caching
bool
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negative_caching_policy
Sequence[BackendServiceCdnPolicyNegativeCachingPolicyResponse]
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- request_coalescing
bool
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve_while_stale
int
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signed_url_cache_max_age_sec
str
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- signed_url_key_names
Sequence[str]
- Names of the keys for signing request URLs.
-
List<Property Map>
- Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
- cacheKeyPolicy
Property Map
- The CacheKeyPolicy for this CdnPolicy.
- cacheMode
String
- Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
- clientTtl
Number
- Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
- defaultTtl
Number
- Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- maxTtl
Number
- Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- negativeCaching
Boolean
- Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
- negativeCachingPolicy
List<Property Map>
- Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
- requestCoalescing
Boolean
- If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serveWhileStale
Number
- Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
- signedUrlCacheMaxAgeSec
String
- Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
- signedUrlKeyNames
List<String>
- Names of the keys for signing request URLs.
BackendServiceCompressionMode
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
| Name | Value | Description |
|---|
| Automatic | AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
| Disabled | DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
| Name | Value | Description |
|---|
| BackendServiceCompressionModeAutomatic | AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
| BackendServiceCompressionModeDisabled | DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
| Value | Description |
|---|
AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
| Name | Value | Description |
|---|
| Automatic | AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
| Disabled | DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
| Name | Value | Description |
|---|
| Automatic | AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
| Disabled | DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
| Name | Value | Description |
|---|
| AUTOMATIC | AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
| DISABLED | DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
| Value | Description |
|---|
AUTOMATIC | Automatically uses the best compression based on the Accept-Encoding header sent by the client. |
DISABLED | Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients. |
BackendServiceConnectionTrackingPolicy, BackendServiceConnectionTrackingPolicyArgs
Connection Tracking configuration for this BackendService.
- ConnectionPersistenceOnUnhealthyBackends
BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- EnableStrongAffinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- IdleTimeoutSec
int
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- TrackingMode
BackendServiceConnectionTrackingPolicyTrackingMode
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connection_persistence_on_unhealthy_backends
"ALWAYS_PERSIST" | "DEFAULT_FOR_PROTOCOL" | "NEVER_PERSIST"
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enable_strong_affinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_timeout_sec
number
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- tracking_mode
"INVALID_TRACKING_MODE" | "PER_CONNECTION" | "PER_SESSION"
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connectionPersistenceOnUnhealthyBackends
BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enableStrongAffinity
Boolean
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idleTimeoutSec
Integer
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- trackingMode
BackendServiceConnectionTrackingPolicyTrackingMode
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connectionPersistenceOnUnhealthyBackends
BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enableStrongAffinity
boolean
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idleTimeoutSec
number
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- trackingMode
BackendServiceConnectionTrackingPolicyTrackingMode
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connection_persistence_on_unhealthy_backends
BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enable_strong_affinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_timeout_sec
int
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- tracking_mode
BackendServiceConnectionTrackingPolicyTrackingMode
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connectionPersistenceOnUnhealthyBackends
"ALWAYS_PERSIST" | "DEFAULT_FOR_PROTOCOL" | "NEVER_PERSIST"
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enableStrongAffinity
Boolean
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idleTimeoutSec
Number
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- trackingMode
"INVALID_TRACKING_MODE" | "PER_CONNECTION" | "PER_SESSION"
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends
Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
| Name | Value |
|---|
| AlwaysPersist | ALWAYS_PERSIST |
| DefaultForProtocol | DEFAULT_FOR_PROTOCOL |
| NeverPersist | NEVER_PERSIST |
| Name | Value |
|---|
| BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackendsAlwaysPersist | ALWAYS_PERSIST |
| BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackendsDefaultForProtocol | DEFAULT_FOR_PROTOCOL |
| BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackendsNeverPersist | NEVER_PERSIST |
| Value |
|---|
ALWAYS_PERSIST |
DEFAULT_FOR_PROTOCOL |
NEVER_PERSIST |
| Name | Value |
|---|
| AlwaysPersist | ALWAYS_PERSIST |
| DefaultForProtocol | DEFAULT_FOR_PROTOCOL |
| NeverPersist | NEVER_PERSIST |
| Name | Value |
|---|
| AlwaysPersist | ALWAYS_PERSIST |
| DefaultForProtocol | DEFAULT_FOR_PROTOCOL |
| NeverPersist | NEVER_PERSIST |
| Name | Value |
|---|
| ALWAYS_PERSIST | ALWAYS_PERSIST |
| DEFAULT_FOR_PROTOCOL | DEFAULT_FOR_PROTOCOL |
| NEVER_PERSIST | NEVER_PERSIST |
| Value |
|---|
ALWAYS_PERSIST |
DEFAULT_FOR_PROTOCOL |
NEVER_PERSIST |
BackendServiceConnectionTrackingPolicyResponse
Connection Tracking configuration for this BackendService.
- ConnectionPersistenceOnUnhealthyBackends
string
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- EnableStrongAffinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- IdleTimeoutSec
int
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- TrackingMode
string
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- ConnectionPersistenceOnUnhealthyBackends
string
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- EnableStrongAffinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- IdleTimeoutSec
int
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- TrackingMode
string
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connection_persistence_on_unhealthy_backends
string
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enable_strong_affinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_timeout_sec
number
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- tracking_mode
string
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connectionPersistenceOnUnhealthyBackends
String
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enableStrongAffinity
Boolean
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idleTimeoutSec
Integer
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- trackingMode
String
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connectionPersistenceOnUnhealthyBackends
string
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enableStrongAffinity
boolean
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idleTimeoutSec
number
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- trackingMode
string
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connection_persistence_on_unhealthy_backends
str
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enable_strong_affinity
bool
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_timeout_sec
int
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- tracking_mode
str
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
- connectionPersistenceOnUnhealthyBackends
String
- Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
- enableStrongAffinity
Boolean
- Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idleTimeoutSec
Number
- Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.
- trackingMode
String
- Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
BackendServiceConnectionTrackingPolicyTrackingMode
Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
| Name | Value |
|---|
| InvalidTrackingMode | INVALID_TRACKING_MODE |
| PerConnection | PER_CONNECTION |
| PerSession | PER_SESSION |
| Name | Value |
|---|
| BackendServiceConnectionTrackingPolicyTrackingModeInvalidTrackingMode | INVALID_TRACKING_MODE |
| BackendServiceConnectionTrackingPolicyTrackingModePerConnection | PER_CONNECTION |
| BackendServiceConnectionTrackingPolicyTrackingModePerSession | PER_SESSION |
| Value |
|---|
INVALID_TRACKING_MODE |
PER_CONNECTION |
PER_SESSION |
| Name | Value |
|---|
| InvalidTrackingMode | INVALID_TRACKING_MODE |
| PerConnection | PER_CONNECTION |
| PerSession | PER_SESSION |
| Name | Value |
|---|
| InvalidTrackingMode | INVALID_TRACKING_MODE |
| PerConnection | PER_CONNECTION |
| PerSession | PER_SESSION |
| Name | Value |
|---|
| INVALID_TRACKING_MODE | INVALID_TRACKING_MODE |
| PER_CONNECTION | PER_CONNECTION |
| PER_SESSION | PER_SESSION |
| Value |
|---|
INVALID_TRACKING_MODE |
PER_CONNECTION |
PER_SESSION |
BackendServiceFailoverPolicy, BackendServiceFailoverPolicyArgs
For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).
- DisableConnectionDrainOnFailover
bool
- This can be set to true only if the protocol is TCP. The default is false.
- DropTrafficIfUnhealthy
bool
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- FailoverRatio
double
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- DisableConnectionDrainOnFailover
bool
- This can be set to true only if the protocol is TCP. The default is false.
- DropTrafficIfUnhealthy
bool
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- FailoverRatio
float64
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- disableConnectionDrainOnFailover
Boolean
- This can be set to true only if the protocol is TCP. The default is false.
- dropTrafficIfUnhealthy
Boolean
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- failoverRatio
Double
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- disableConnectionDrainOnFailover
boolean
- This can be set to true only if the protocol is TCP. The default is false.
- dropTrafficIfUnhealthy
boolean
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- failoverRatio
number
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- disableConnectionDrainOnFailover
Boolean
- This can be set to true only if the protocol is TCP. The default is false.
- dropTrafficIfUnhealthy
Boolean
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- failoverRatio
Number
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
BackendServiceFailoverPolicyResponse
For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).
- DisableConnectionDrainOnFailover
bool
- This can be set to true only if the protocol is TCP. The default is false.
- DropTrafficIfUnhealthy
bool
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- FailoverRatio
double
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- DisableConnectionDrainOnFailover
bool
- This can be set to true only if the protocol is TCP. The default is false.
- DropTrafficIfUnhealthy
bool
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- FailoverRatio
float64
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- disableConnectionDrainOnFailover
Boolean
- This can be set to true only if the protocol is TCP. The default is false.
- dropTrafficIfUnhealthy
Boolean
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- failoverRatio
Double
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- disableConnectionDrainOnFailover
boolean
- This can be set to true only if the protocol is TCP. The default is false.
- dropTrafficIfUnhealthy
boolean
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- failoverRatio
number
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
- disableConnectionDrainOnFailover
Boolean
- This can be set to true only if the protocol is TCP. The default is false.
- dropTrafficIfUnhealthy
Boolean
- If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.
- failoverRatio
Number
- The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.
BackendServiceIAP, BackendServiceIAPArgs
Identity-Aware Proxy
- Enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2ClientId
string
- OAuth2 client ID to use for the authentication flow.
- Oauth2ClientSecret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- Enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2ClientId
string
- OAuth2 client ID to use for the authentication flow.
- Oauth2ClientSecret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2_client_id
string
- OAuth2 client ID to use for the authentication flow.
- oauth2_client_secret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- enabled
Boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2ClientId
String
- OAuth2 client ID to use for the authentication flow.
- oauth2ClientSecret
String
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- enabled
boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2ClientId
string
- OAuth2 client ID to use for the authentication flow.
- oauth2ClientSecret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2_client_id
str
- OAuth2 client ID to use for the authentication flow.
- oauth2_client_secret
str
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- enabled
Boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2ClientId
String
- OAuth2 client ID to use for the authentication flow.
- oauth2ClientSecret
String
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
BackendServiceIAPResponse
Identity-Aware Proxy
- Enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2ClientId
string
- OAuth2 client ID to use for the authentication flow.
- Oauth2ClientSecret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- Oauth2ClientSecretSha256
string
- SHA256 hash value for the field oauth2_client_secret above.
- Enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2ClientId
string
- OAuth2 client ID to use for the authentication flow.
- Oauth2ClientSecret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- Oauth2ClientSecretSha256
string
- SHA256 hash value for the field oauth2_client_secret above.
- enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2_client_id
string
- OAuth2 client ID to use for the authentication flow.
- oauth2_client_secret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- oauth2_client_secret_sha256
string
- SHA256 hash value for the field oauth2_client_secret above.
- enabled
Boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2ClientId
String
- OAuth2 client ID to use for the authentication flow.
- oauth2ClientSecret
String
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- oauth2ClientSecretSha256
String
- SHA256 hash value for the field oauth2_client_secret above.
- enabled
boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2ClientId
string
- OAuth2 client ID to use for the authentication flow.
- oauth2ClientSecret
string
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- oauth2ClientSecretSha256
string
- SHA256 hash value for the field oauth2_client_secret above.
- enabled
bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2_client_id
str
- OAuth2 client ID to use for the authentication flow.
- oauth2_client_secret
str
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- oauth2_client_secret_sha256
str
- SHA256 hash value for the field oauth2_client_secret above.
- enabled
Boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2ClientId
String
- OAuth2 client ID to use for the authentication flow.
- oauth2ClientSecret
String
- OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
- oauth2ClientSecretSha256
String
- SHA256 hash value for the field oauth2_client_secret above.
BackendServiceIpAddressSelectionPolicy
Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
| Name | Value | Description |
|---|
| Ipv4Only | IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
| Ipv6Only | IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
| IpAddressSelectionPolicyUnspecified | IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
| PreferIpv6 | PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
| Name | Value | Description |
|---|
| BackendServiceIpAddressSelectionPolicyIpv4Only | IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
| BackendServiceIpAddressSelectionPolicyIpv6Only | IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
| BackendServiceIpAddressSelectionPolicyIpAddressSelectionPolicyUnspecified | IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
| BackendServiceIpAddressSelectionPolicyPreferIpv6 | PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
| Value | Description |
|---|
IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
| Name | Value | Description |
|---|
| Ipv4Only | IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
| Ipv6Only | IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
| IpAddressSelectionPolicyUnspecified | IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
| PreferIpv6 | PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
| Name | Value | Description |
|---|
| Ipv4Only | IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
| Ipv6Only | IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
| IpAddressSelectionPolicyUnspecified | IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
| PreferIpv6 | PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
| Name | Value | Description |
|---|
| IPV4_ONLY | IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
| IPV6_ONLY | IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
| IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
| PREFER_IPV6 | PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
| Value | Description |
|---|
IPV4_ONLY | Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. |
IPV6_ONLY | Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. |
IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED | Unspecified IP address selection policy. |
PREFER_IPV6 | Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). |
BackendServiceLoadBalancingScheme
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
| Name | Value | Description |
|---|
| External | EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
| ExternalManaged | EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
| Internal | INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
| InternalManaged | INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
| InternalSelfManaged | INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
| InvalidLoadBalancingScheme | INVALID_LOAD_BALANCING_SCHEME | |
| Name | Value | Description |
|---|
| BackendServiceLoadBalancingSchemeExternal | EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
| BackendServiceLoadBalancingSchemeExternalManaged | EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
| BackendServiceLoadBalancingSchemeInternal | INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
| BackendServiceLoadBalancingSchemeInternalManaged | INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
| BackendServiceLoadBalancingSchemeInternalSelfManaged | INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
| BackendServiceLoadBalancingSchemeInvalidLoadBalancingScheme | INVALID_LOAD_BALANCING_SCHEME | |
| Value | Description |
|---|
EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
INVALID_LOAD_BALANCING_SCHEME | |
| Name | Value | Description |
|---|
| External | EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
| ExternalManaged | EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
| Internal | INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
| InternalManaged | INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
| InternalSelfManaged | INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
| InvalidLoadBalancingScheme | INVALID_LOAD_BALANCING_SCHEME | |
| Name | Value | Description |
|---|
| External | EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
| ExternalManaged | EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
| Internal | INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
| InternalManaged | INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
| InternalSelfManaged | INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
| InvalidLoadBalancingScheme | INVALID_LOAD_BALANCING_SCHEME | |
| Name | Value | Description |
|---|
| EXTERNAL | EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
| EXTERNAL_MANAGED | EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
| INTERNAL | INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
| INTERNAL_MANAGED | INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
| INTERNAL_SELF_MANAGED | INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
| INVALID_LOAD_BALANCING_SCHEME | INVALID_LOAD_BALANCING_SCHEME | |
| Value | Description |
|---|
EXTERNAL | Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing |
EXTERNAL_MANAGED | Signifies that this will be used for External Managed HTTP(S) Load Balancing. |
INTERNAL | Signifies that this will be used for Internal TCP/UDP Load Balancing. |
INTERNAL_MANAGED | Signifies that this will be used for Internal HTTP(S) Load Balancing. |
INTERNAL_SELF_MANAGED | Signifies that this will be used by Traffic Director. |
INVALID_LOAD_BALANCING_SCHEME | |
BackendServiceLocalityLbPolicy
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. This is the default. - 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, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to 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 validateForProxyless field set to true.
| Name | Value | Description |
|---|
| InvalidLbPolicy | INVALID_LB_POLICY | |
| LeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| Maglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| OriginalDestination | 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. |
| Random | RANDOM | The load balancer selects a random healthy host. |
| RingHash | 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. |
| RoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| BackendServiceLocalityLbPolicyInvalidLbPolicy | INVALID_LB_POLICY | |
| BackendServiceLocalityLbPolicyLeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| BackendServiceLocalityLbPolicyMaglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| BackendServiceLocalityLbPolicyOriginalDestination | 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. |
| BackendServiceLocalityLbPolicyRandom | RANDOM | The load balancer selects a random healthy host. |
| BackendServiceLocalityLbPolicyRingHash | 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. |
| BackendServiceLocalityLbPolicyRoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| BackendServiceLocalityLbPolicyWeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Value | Description |
|---|
INVALID_LB_POLICY | |
LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
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. |
RANDOM | The load balancer selects a random healthy host. |
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. |
ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| InvalidLbPolicy | INVALID_LB_POLICY | |
| LeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| Maglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| OriginalDestination | 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. |
| Random | RANDOM | The load balancer selects a random healthy host. |
| RingHash | 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. |
| RoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| InvalidLbPolicy | INVALID_LB_POLICY | |
| LeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| Maglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| OriginalDestination | 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. |
| Random | RANDOM | The load balancer selects a random healthy host. |
| RingHash | 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. |
| RoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| INVALID_LB_POLICY | INVALID_LB_POLICY | |
| LEAST_REQUEST | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| MAGLEV | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| ORIGINAL_DESTINATION | 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. |
| RANDOM | RANDOM | The load balancer selects a random healthy host. |
| RING_HASH | 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. |
| ROUND_ROBIN | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WEIGHTED_MAGLEV | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Value | Description |
|---|
INVALID_LB_POLICY | |
LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
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. |
RANDOM | The load balancer selects a random healthy host. |
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. |
ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
BackendServiceLocalityLoadBalancingPolicyConfig, BackendServiceLocalityLoadBalancingPolicyConfigArgs
Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user.
BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy, BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs
The configuration for a custom policy implemented by the user and deployed with the client.
- Data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- Name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- Data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- Name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
String
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
String
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
str
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
str
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
String
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
String
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyResponse
The configuration for a custom policy implemented by the user and deployed with the client.
- Data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- Name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- Data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- Name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
String
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
String
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
string
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
string
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
str
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
str
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
- data
String
- An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
- name
String
- Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
BackendServiceLocalityLoadBalancingPolicyConfigPolicy, BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs
The configuration for a built-in load balancing policy.
- Name
BackendServiceLocalityLoadBalancingPolicyConfigPolicyName
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
BackendServiceLocalityLoadBalancingPolicyConfigPolicyName
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
BackendServiceLocalityLoadBalancingPolicyConfigPolicyName
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
BackendServiceLocalityLoadBalancingPolicyConfigPolicyName
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
BackendServiceLocalityLoadBalancingPolicyConfigPolicyName
The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
| Name | Value | Description |
|---|
| InvalidLbPolicy | INVALID_LB_POLICY | |
| LeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| Maglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| OriginalDestination | 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. |
| Random | RANDOM | The load balancer selects a random healthy host. |
| RingHash | 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. |
| RoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameInvalidLbPolicy | INVALID_LB_POLICY | |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameLeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameMaglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameOriginalDestination | 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. |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameRandom | RANDOM | The load balancer selects a random healthy host. |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameRingHash | 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. |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameRoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameWeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Value | Description |
|---|
INVALID_LB_POLICY | |
LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
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. |
RANDOM | The load balancer selects a random healthy host. |
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. |
ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| InvalidLbPolicy | INVALID_LB_POLICY | |
| LeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| Maglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| OriginalDestination | 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. |
| Random | RANDOM | The load balancer selects a random healthy host. |
| RingHash | 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. |
| RoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| InvalidLbPolicy | INVALID_LB_POLICY | |
| LeastRequest | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| Maglev | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| OriginalDestination | 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. |
| Random | RANDOM | The load balancer selects a random healthy host. |
| RingHash | 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. |
| RoundRobin | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WeightedMaglev | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Name | Value | Description |
|---|
| INVALID_LB_POLICY | INVALID_LB_POLICY | |
| LEAST_REQUEST | LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
| MAGLEV | MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
| ORIGINAL_DESTINATION | 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. |
| RANDOM | RANDOM | The load balancer selects a random healthy host. |
| RING_HASH | 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. |
| ROUND_ROBIN | ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
| WEIGHTED_MAGLEV | WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
| Value | Description |
|---|
INVALID_LB_POLICY | |
LEAST_REQUEST | An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. |
MAGLEV | This algorithm implements consistent hashing to backends. Maglev can be 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, see https://ai.google/research/pubs/pub44824 |
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. |
RANDOM | The load balancer selects a random healthy host. |
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. |
ROUND_ROBIN | This is a simple policy in which each healthy backend is selected in round robin order. This is the default. |
WEIGHTED_MAGLEV | Per-instance weighted Load Balancing via health check reported weights. 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 weighted 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. This option is only supported in Network Load Balancing. |
BackendServiceLocalityLoadBalancingPolicyConfigPolicyResponse
The configuration for a built-in load balancing policy.
- Name
string
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- Name
string
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
string
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
String
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
string
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
str
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
- name
String
- The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
BackendServiceLocalityLoadBalancingPolicyConfigResponse
Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user.
BackendServiceLogConfig, BackendServiceLogConfigArgs
The available logging options for the load balancer traffic served by this backend service.
- Enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- OptionalFields
List<string>
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- OptionalMode
Pulumi.GoogleNative.Compute.Beta.BackendServiceLogConfigOptionalMode
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- SampleRate
double
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- Enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- OptionalFields
[]string
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- OptionalMode
BackendServiceLogConfigOptionalMode
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- SampleRate
float64
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional_fields
list(string)
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optional_mode
"CUSTOM" | "EXCLUDE_ALL_OPTIONAL" | "INCLUDE_ALL_OPTIONAL"
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sample_rate
number
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
Boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optionalFields
List<String>
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optionalMode
BackendServiceLogConfigOptionalMode
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sampleRate
Double
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optionalFields
string[]
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optionalMode
BackendServiceLogConfigOptionalMode
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sampleRate
number
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional_fields
Sequence[str]
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optional_mode
BackendServiceLogConfigOptionalMode
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sample_rate
float
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
Boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optionalFields
List<String>
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optionalMode
"CUSTOM" | "EXCLUDE_ALL_OPTIONAL" | "INCLUDE_ALL_OPTIONAL"
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sampleRate
Number
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
BackendServiceLogConfigOptionalMode
This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
| Name | Value | Description |
|---|
| Custom | CUSTOM | A subset of optional fields. |
| ExcludeAllOptional | EXCLUDE_ALL_OPTIONAL | None optional fields. |
| IncludeAllOptional | INCLUDE_ALL_OPTIONAL | All optional fields. |
| Name | Value | Description |
|---|
| BackendServiceLogConfigOptionalModeCustom | CUSTOM | A subset of optional fields. |
| BackendServiceLogConfigOptionalModeExcludeAllOptional | EXCLUDE_ALL_OPTIONAL | None optional fields. |
| BackendServiceLogConfigOptionalModeIncludeAllOptional | INCLUDE_ALL_OPTIONAL | All optional fields. |
| Value | Description |
|---|
CUSTOM | A subset of optional fields. |
EXCLUDE_ALL_OPTIONAL | None optional fields. |
INCLUDE_ALL_OPTIONAL | All optional fields. |
| Name | Value | Description |
|---|
| Custom | CUSTOM | A subset of optional fields. |
| ExcludeAllOptional | EXCLUDE_ALL_OPTIONAL | None optional fields. |
| IncludeAllOptional | INCLUDE_ALL_OPTIONAL | All optional fields. |
| Name | Value | Description |
|---|
| Custom | CUSTOM | A subset of optional fields. |
| ExcludeAllOptional | EXCLUDE_ALL_OPTIONAL | None optional fields. |
| IncludeAllOptional | INCLUDE_ALL_OPTIONAL | All optional fields. |
| Name | Value | Description |
|---|
| CUSTOM | CUSTOM | A subset of optional fields. |
| EXCLUDE_ALL_OPTIONAL | EXCLUDE_ALL_OPTIONAL | None optional fields. |
| INCLUDE_ALL_OPTIONAL | INCLUDE_ALL_OPTIONAL | All optional fields. |
| Value | Description |
|---|
CUSTOM | A subset of optional fields. |
EXCLUDE_ALL_OPTIONAL | None optional fields. |
INCLUDE_ALL_OPTIONAL | All optional fields. |
BackendServiceLogConfigResponse
The available logging options for the load balancer traffic served by this backend service.
- Enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- OptionalFields
List<string>
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- OptionalMode
string
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- SampleRate
double
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- Enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- OptionalFields
[]string
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- OptionalMode
string
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- SampleRate
float64
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional_fields
list(string)
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optional_mode
string
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sample_rate
number
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
Boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optionalFields
List<String>
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optionalMode
String
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sampleRate
Double
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optionalFields
string[]
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optionalMode
string
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sampleRate
number
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional_fields
Sequence[str]
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optional_mode
str
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sample_rate
float
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
- enable
Boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optionalFields
List<String>
- This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
- optionalMode
String
- This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
- sampleRate
Number
- This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
BackendServiceProtocol
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
| Name | Value | Description |
|---|
| Grpc | GRPC | gRPC (available for Traffic Director). |
| Http | HTTP | |
| Http2 | HTTP2 | HTTP/2 with SSL. |
| Https | HTTPS | |
| Ssl | SSL | TCP proxying with SSL. |
| Tcp | TCP | TCP proxying or TCP pass-through. |
| Udp | UDP | UDP. |
| Unspecified | UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
| Name | Value | Description |
|---|
| BackendServiceProtocolGrpc | GRPC | gRPC (available for Traffic Director). |
| BackendServiceProtocolHttp | HTTP | |
| BackendServiceProtocolHttp2 | HTTP2 | HTTP/2 with SSL. |
| BackendServiceProtocolHttps | HTTPS | |
| BackendServiceProtocolSsl | SSL | TCP proxying with SSL. |
| BackendServiceProtocolTcp | TCP | TCP proxying or TCP pass-through. |
| BackendServiceProtocolUdp | UDP | UDP. |
| BackendServiceProtocolUnspecified | UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
| Value | Description |
|---|
GRPC | gRPC (available for Traffic Director). |
HTTP | |
HTTP2 | HTTP/2 with SSL. |
HTTPS | |
SSL | TCP proxying with SSL. |
TCP | TCP proxying or TCP pass-through. |
UDP | UDP. |
UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
| Name | Value | Description |
|---|
| Grpc | GRPC | gRPC (available for Traffic Director). |
| Http | HTTP | |
| Http2 | HTTP2 | HTTP/2 with SSL. |
| Https | HTTPS | |
| Ssl | SSL | TCP proxying with SSL. |
| Tcp | TCP | TCP proxying or TCP pass-through. |
| Udp | UDP | UDP. |
| Unspecified | UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
| Name | Value | Description |
|---|
| Grpc | GRPC | gRPC (available for Traffic Director). |
| Http | HTTP | |
| Http2 | HTTP2 | HTTP/2 with SSL. |
| Https | HTTPS | |
| Ssl | SSL | TCP proxying with SSL. |
| Tcp | TCP | TCP proxying or TCP pass-through. |
| Udp | UDP | UDP. |
| Unspecified | UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
| Name | Value | Description |
|---|
| GRPC | GRPC | gRPC (available for Traffic Director). |
| HTTP | HTTP | |
| HTTP2 | HTTP2 | HTTP/2 with SSL. |
| HTTPS | HTTPS | |
| SSL | SSL | TCP proxying with SSL. |
| TCP | TCP | TCP proxying or TCP pass-through. |
| UDP | UDP | UDP. |
| UNSPECIFIED | UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
| Value | Description |
|---|
GRPC | gRPC (available for Traffic Director). |
HTTP | |
HTTP2 | HTTP/2 with SSL. |
HTTPS | |
SSL | TCP proxying with SSL. |
TCP | TCP proxying or TCP pass-through. |
UDP | UDP. |
UNSPECIFIED | If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules. |
BackendServiceSessionAffinity
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity.
| Name | Value | Description |
|---|
| ClientIp | CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
| ClientIpNoDestination | CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
| ClientIpPortProto | CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| ClientIpProto | CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| GeneratedCookie | GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
| HeaderField | HEADER_FIELD | The hash is based on a user specified header field. |
| HttpCookie | HTTP_COOKIE | The hash is based on a user provided cookie. |
| None | NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
| Name | Value | Description |
|---|
| BackendServiceSessionAffinityClientIp | CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
| BackendServiceSessionAffinityClientIpNoDestination | CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
| BackendServiceSessionAffinityClientIpPortProto | CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| BackendServiceSessionAffinityClientIpProto | CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| BackendServiceSessionAffinityGeneratedCookie | GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
| BackendServiceSessionAffinityHeaderField | HEADER_FIELD | The hash is based on a user specified header field. |
| BackendServiceSessionAffinityHttpCookie | HTTP_COOKIE | The hash is based on a user provided cookie. |
| BackendServiceSessionAffinityNone | NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
| Value | Description |
|---|
CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
HEADER_FIELD | The hash is based on a user specified header field. |
HTTP_COOKIE | The hash is based on a user provided cookie. |
NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
| Name | Value | Description |
|---|
| ClientIp | CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
| ClientIpNoDestination | CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
| ClientIpPortProto | CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| ClientIpProto | CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| GeneratedCookie | GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
| HeaderField | HEADER_FIELD | The hash is based on a user specified header field. |
| HttpCookie | HTTP_COOKIE | The hash is based on a user provided cookie. |
| None | NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
| Name | Value | Description |
|---|
| ClientIp | CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
| ClientIpNoDestination | CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
| ClientIpPortProto | CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| ClientIpProto | CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| GeneratedCookie | GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
| HeaderField | HEADER_FIELD | The hash is based on a user specified header field. |
| HttpCookie | HTTP_COOKIE | The hash is based on a user provided cookie. |
| None | NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
| Name | Value | Description |
|---|
| CLIENT_IP | CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
| CLIENT_IP_NO_DESTINATION | CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
| CLIENT_IP_PORT_PROTO | CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| CLIENT_IP_PROTO | CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
| GENERATED_COOKIE | GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
| HEADER_FIELD | HEADER_FIELD | The hash is based on a user specified header field. |
| HTTP_COOKIE | HTTP_COOKIE | The hash is based on a user provided cookie. |
| NONE | NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
| Value | Description |
|---|
CLIENT_IP | 2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. |
CLIENT_IP_NO_DESTINATION | 1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing. |
CLIENT_IP_PORT_PROTO | 5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
CLIENT_IP_PROTO | 3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing. |
GENERATED_COOKIE | Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing. |
HEADER_FIELD | The hash is based on a user specified header field. |
HTTP_COOKIE | The hash is based on a user provided cookie. |
NONE | No session affinity. Connections from the same client IP may go to any instance in the pool. |
BackendServiceUsedBy, BackendServiceUsedByArgs
BackendServiceUsedByResponse
CacheKeyPolicy, CacheKeyPolicyArgs
Message containing what to include in the cache key for a request for Cloud CDN.
- IncludeHost
bool
- If true, requests to different hosts will be cached separately.
-
List<string>
- Allows HTTP request headers (by name) to be used in the cache key.
- IncludeNamedCookies
List<string>
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- IncludeProtocol
bool
- If true, http and https requests will be cached separately.
- IncludeQueryString
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- QueryStringBlacklist
List<string>
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- QueryStringWhitelist
List<string>
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- IncludeHost
bool
- If true, requests to different hosts will be cached separately.
-
[]string
- Allows HTTP request headers (by name) to be used in the cache key.
- IncludeNamedCookies
[]string
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- IncludeProtocol
bool
- If true, http and https requests will be cached separately.
- IncludeQueryString
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- QueryStringBlacklist
[]string
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- QueryStringWhitelist
[]string
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- include_host
bool
- If true, requests to different hosts will be cached separately.
-
list(string)
- Allows HTTP request headers (by name) to be used in the cache key.
- include_named_cookies
list(string)
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- include_protocol
bool
- If true, http and https requests will be cached separately.
- include_query_string
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- query_string_blacklist
list(string)
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- query_string_whitelist
list(string)
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- includeHost
Boolean
- If true, requests to different hosts will be cached separately.
-
List<String>
- Allows HTTP request headers (by name) to be used in the cache key.
- includeNamedCookies
List<String>
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- includeProtocol
Boolean
- If true, http and https requests will be cached separately.
- includeQueryString
Boolean
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- queryStringBlacklist
List<String>
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- queryStringWhitelist
List<String>
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- includeHost
boolean
- If true, requests to different hosts will be cached separately.
-
string[]
- Allows HTTP request headers (by name) to be used in the cache key.
- includeNamedCookies
string[]
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- includeProtocol
boolean
- If true, http and https requests will be cached separately.
- includeQueryString
boolean
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- queryStringBlacklist
string[]
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- queryStringWhitelist
string[]
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- include_host
bool
- If true, requests to different hosts will be cached separately.
-
Sequence[str]
- Allows HTTP request headers (by name) to be used in the cache key.
- include_named_cookies
Sequence[str]
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- include_protocol
bool
- If true, http and https requests will be cached separately.
- include_query_string
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- query_string_blacklist
Sequence[str]
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- query_string_whitelist
Sequence[str]
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- includeHost
Boolean
- If true, requests to different hosts will be cached separately.
-
List<String>
- Allows HTTP request headers (by name) to be used in the cache key.
- includeNamedCookies
List<String>
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- includeProtocol
Boolean
- If true, http and https requests will be cached separately.
- includeQueryString
Boolean
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- queryStringBlacklist
List<String>
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- queryStringWhitelist
List<String>
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
CacheKeyPolicyResponse
Message containing what to include in the cache key for a request for Cloud CDN.
- IncludeHost
bool
- If true, requests to different hosts will be cached separately.
-
List<string>
- Allows HTTP request headers (by name) to be used in the cache key.
- IncludeNamedCookies
List<string>
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- IncludeProtocol
bool
- If true, http and https requests will be cached separately.
- IncludeQueryString
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- QueryStringBlacklist
List<string>
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- QueryStringWhitelist
List<string>
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- IncludeHost
bool
- If true, requests to different hosts will be cached separately.
-
[]string
- Allows HTTP request headers (by name) to be used in the cache key.
- IncludeNamedCookies
[]string
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- IncludeProtocol
bool
- If true, http and https requests will be cached separately.
- IncludeQueryString
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- QueryStringBlacklist
[]string
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- QueryStringWhitelist
[]string
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- include_host
bool
- If true, requests to different hosts will be cached separately.
-
list(string)
- Allows HTTP request headers (by name) to be used in the cache key.
- include_named_cookies
list(string)
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- include_protocol
bool
- If true, http and https requests will be cached separately.
- include_query_string
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- query_string_blacklist
list(string)
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- query_string_whitelist
list(string)
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- includeHost
Boolean
- If true, requests to different hosts will be cached separately.
-
List<String>
- Allows HTTP request headers (by name) to be used in the cache key.
- includeNamedCookies
List<String>
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- includeProtocol
Boolean
- If true, http and https requests will be cached separately.
- includeQueryString
Boolean
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- queryStringBlacklist
List<String>
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- queryStringWhitelist
List<String>
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- includeHost
boolean
- If true, requests to different hosts will be cached separately.
-
string[]
- Allows HTTP request headers (by name) to be used in the cache key.
- includeNamedCookies
string[]
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- includeProtocol
boolean
- If true, http and https requests will be cached separately.
- includeQueryString
boolean
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- queryStringBlacklist
string[]
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- queryStringWhitelist
string[]
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- include_host
bool
- If true, requests to different hosts will be cached separately.
-
Sequence[str]
- Allows HTTP request headers (by name) to be used in the cache key.
- include_named_cookies
Sequence[str]
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- include_protocol
bool
- If true, http and https requests will be cached separately.
- include_query_string
bool
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- query_string_blacklist
Sequence[str]
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- query_string_whitelist
Sequence[str]
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- includeHost
Boolean
- If true, requests to different hosts will be cached separately.
-
List<String>
- Allows HTTP request headers (by name) to be used in the cache key.
- includeNamedCookies
List<String>
- Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
- includeProtocol
Boolean
- If true, http and https requests will be cached separately.
- includeQueryString
Boolean
- If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
- queryStringBlacklist
List<String>
- Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
- queryStringWhitelist
List<String>
- Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
CircuitBreakers, CircuitBreakersArgs
Settings controlling the volume of requests, connections and retries to this backend service.
- ConnectTimeout
Pulumi.GoogleNative.Compute.Beta.Inputs.Duration
- The timeout for new network connections to hosts.
- MaxConnections
int
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxPendingRequests
int
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRequests
int
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- MaxRequestsPerConnection
int
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRetries
int
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- ConnectTimeout
Duration
- The timeout for new network connections to hosts.
- MaxConnections
int
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxPendingRequests
int
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRequests
int
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- MaxRequestsPerConnection
int
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRetries
int
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connect_timeout
object
- The timeout for new network connections to hosts.
- max_connections
number
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_pending_requests
number
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_requests
number
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- max_requests_per_connection
number
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_retries
number
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connectTimeout
Duration
- The timeout for new network connections to hosts.
- maxConnections
Integer
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxPendingRequests
Integer
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRequests
Integer
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- maxRequestsPerConnection
Integer
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRetries
Integer
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connectTimeout
Duration
- The timeout for new network connections to hosts.
- maxConnections
number
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxPendingRequests
number
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRequests
number
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- maxRequestsPerConnection
number
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRetries
number
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connect_timeout
Duration
- The timeout for new network connections to hosts.
- max_connections
int
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_pending_requests
int
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_requests
int
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- max_requests_per_connection
int
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_retries
int
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connectTimeout
Property Map
- The timeout for new network connections to hosts.
- maxConnections
Number
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxPendingRequests
Number
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRequests
Number
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- maxRequestsPerConnection
Number
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRetries
Number
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
CircuitBreakersResponse
Settings controlling the volume of requests, connections and retries to this backend service.
- ConnectTimeout
Pulumi.GoogleNative.Compute.Beta.Inputs.DurationResponse
- The timeout for new network connections to hosts.
- MaxConnections
int
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxPendingRequests
int
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRequests
int
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- MaxRequestsPerConnection
int
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRetries
int
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- ConnectTimeout
DurationResponse
- The timeout for new network connections to hosts.
- MaxConnections
int
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxPendingRequests
int
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRequests
int
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- MaxRequestsPerConnection
int
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- MaxRetries
int
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connect_timeout
object
- The timeout for new network connections to hosts.
- max_connections
number
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_pending_requests
number
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_requests
number
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- max_requests_per_connection
number
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_retries
number
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connectTimeout
DurationResponse
- The timeout for new network connections to hosts.
- maxConnections
Integer
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxPendingRequests
Integer
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRequests
Integer
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- maxRequestsPerConnection
Integer
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRetries
Integer
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connectTimeout
DurationResponse
- The timeout for new network connections to hosts.
- maxConnections
number
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxPendingRequests
number
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRequests
number
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- maxRequestsPerConnection
number
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRetries
number
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connect_timeout
DurationResponse
- The timeout for new network connections to hosts.
- max_connections
int
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_pending_requests
int
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_requests
int
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- max_requests_per_connection
int
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- max_retries
int
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- connectTimeout
Property Map
- The timeout for new network connections to hosts.
- maxConnections
Number
- The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxPendingRequests
Number
- The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRequests
Number
- The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
- maxRequestsPerConnection
Number
- Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
- maxRetries
Number
- The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
ConnectionDraining, ConnectionDrainingArgs
Message containing connection draining configuration.
- DrainingTimeoutSec
int
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- DrainingTimeoutSec
int
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- draining_timeout_sec
number
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- drainingTimeoutSec
Integer
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- drainingTimeoutSec
number
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- draining_timeout_sec
int
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- drainingTimeoutSec
Number
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
ConnectionDrainingResponse
Message containing connection draining configuration.
- DrainingTimeoutSec
int
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- DrainingTimeoutSec
int
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- draining_timeout_sec
number
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- drainingTimeoutSec
Integer
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- drainingTimeoutSec
number
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- draining_timeout_sec
int
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
- drainingTimeoutSec
Number
- Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
ConsistentHashLoadBalancerSettings, ConsistentHashLoadBalancerSettingsArgs
This message defines settings for a consistent hash style load balancer.
- HttpCookie
Pulumi.GoogleNative.Compute.Beta.Inputs.ConsistentHashLoadBalancerSettingsHttpCookie
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- MinimumRingSize
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- HttpCookie
ConsistentHashLoadBalancerSettingsHttpCookie
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- MinimumRingSize
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- http_cookie
object
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum_ring_size
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- httpCookie
ConsistentHashLoadBalancerSettingsHttpCookie
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
String
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimumRingSize
String
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- httpCookie
ConsistentHashLoadBalancerSettingsHttpCookie
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimumRingSize
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- http_cookie
ConsistentHashLoadBalancerSettingsHttpCookie
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
str
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum_ring_size
str
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- httpCookie
Property Map
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
String
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimumRingSize
String
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
ConsistentHashLoadBalancerSettingsHttpCookie, ConsistentHashLoadBalancerSettingsHttpCookieArgs
The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.
- Name
string
- Name of the cookie.
- Path
string
- Path to set for the cookie.
- Ttl
Duration
- Lifetime of the cookie.
- name
string
- Name of the cookie.
- path
string
- Path to set for the cookie.
- ttl
object
- Lifetime of the cookie.
- name
String
- Name of the cookie.
- path
String
- Path to set for the cookie.
- ttl
Duration
- Lifetime of the cookie.
- name
string
- Name of the cookie.
- path
string
- Path to set for the cookie.
- ttl
Duration
- Lifetime of the cookie.
- name
str
- Name of the cookie.
- path
str
- Path to set for the cookie.
- ttl
Duration
- Lifetime of the cookie.
ConsistentHashLoadBalancerSettingsHttpCookieResponse
The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.
- name
string
- Name of the cookie.
- path
string
- Path to set for the cookie.
- ttl
object
- Lifetime of the cookie.
ConsistentHashLoadBalancerSettingsResponse
This message defines settings for a consistent hash style load balancer.
- HttpCookie
Pulumi.GoogleNative.Compute.Beta.Inputs.ConsistentHashLoadBalancerSettingsHttpCookieResponse
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- MinimumRingSize
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- HttpCookie
ConsistentHashLoadBalancerSettingsHttpCookieResponse
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- MinimumRingSize
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- http_cookie
object
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum_ring_size
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- httpCookie
ConsistentHashLoadBalancerSettingsHttpCookieResponse
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
String
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimumRingSize
String
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- httpCookie
ConsistentHashLoadBalancerSettingsHttpCookieResponse
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
string
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimumRingSize
string
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- http_cookie
ConsistentHashLoadBalancerSettingsHttpCookieResponse
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
str
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum_ring_size
str
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
- httpCookie
Property Map
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
-
String
- The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimumRingSize
String
- The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
Duration, DurationArgs
A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
- Nanos
int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - Seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- Nanos
int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - Seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
Integer
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
String
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
str
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
Number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
String
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
DurationResponse
A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
- Nanos
int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - Seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- Nanos
int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - Seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
Integer
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
String
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
string
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
str
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos
Number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0
seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive. - seconds
String
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
OutlierDetection, OutlierDetectionArgs
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
- BaseEjectionTime
Pulumi.GoogleNative.Compute.Beta.Inputs.Duration
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- ConsecutiveErrors
int
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- ConsecutiveGatewayFailure
int
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- EnforcingConsecutiveErrors
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- EnforcingConsecutiveGatewayFailure
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- EnforcingSuccessRate
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- Interval
Pulumi.GoogleNative.Compute.Beta.Inputs.Duration
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- MaxEjectionPercent
int
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- SuccessRateMinimumHosts
int
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- SuccessRateRequestVolume
int
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- SuccessRateStdevFactor
int
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- BaseEjectionTime
Duration
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- ConsecutiveErrors
int
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- ConsecutiveGatewayFailure
int
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- EnforcingConsecutiveErrors
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- EnforcingConsecutiveGatewayFailure
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- EnforcingSuccessRate
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- Interval
Duration
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- MaxEjectionPercent
int
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- SuccessRateMinimumHosts
int
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- SuccessRateRequestVolume
int
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- SuccessRateStdevFactor
int
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- base_ejection_time
object
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutive_errors
number
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive_gateway_failure
number
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcing_consecutive_errors
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing_consecutive_gateway_failure
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing_success_rate
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
object
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- max_ejection_percent
number
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- success_rate_minimum_hosts
number
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- success_rate_request_volume
number
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- success_rate_stdev_factor
number
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- baseEjectionTime
Duration
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutiveErrors
Integer
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutiveGatewayFailure
Integer
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcingConsecutiveErrors
Integer
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcingConsecutiveGatewayFailure
Integer
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcingSuccessRate
Integer
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
Duration
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- maxEjectionPercent
Integer
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- successRateMinimumHosts
Integer
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- successRateRequestVolume
Integer
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- successRateStdevFactor
Integer
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- baseEjectionTime
Duration
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutiveErrors
number
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutiveGatewayFailure
number
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcingConsecutiveErrors
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcingConsecutiveGatewayFailure
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcingSuccessRate
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
Duration
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- maxEjectionPercent
number
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- successRateMinimumHosts
number
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- successRateRequestVolume
number
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- successRateStdevFactor
number
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- base_ejection_time
Duration
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutive_errors
int
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive_gateway_failure
int
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcing_consecutive_errors
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing_consecutive_gateway_failure
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing_success_rate
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
Duration
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- max_ejection_percent
int
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- success_rate_minimum_hosts
int
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- success_rate_request_volume
int
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- success_rate_stdev_factor
int
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- baseEjectionTime
Property Map
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutiveErrors
Number
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutiveGatewayFailure
Number
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcingConsecutiveErrors
Number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcingConsecutiveGatewayFailure
Number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcingSuccessRate
Number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
Property Map
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- maxEjectionPercent
Number
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- successRateMinimumHosts
Number
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- successRateRequestVolume
Number
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- successRateStdevFactor
Number
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
OutlierDetectionResponse
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
- BaseEjectionTime
Pulumi.GoogleNative.Compute.Beta.Inputs.DurationResponse
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- ConsecutiveErrors
int
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- ConsecutiveGatewayFailure
int
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- EnforcingConsecutiveErrors
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- EnforcingConsecutiveGatewayFailure
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- EnforcingSuccessRate
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- Interval
Pulumi.GoogleNative.Compute.Beta.Inputs.DurationResponse
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- MaxEjectionPercent
int
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- SuccessRateMinimumHosts
int
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- SuccessRateRequestVolume
int
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- SuccessRateStdevFactor
int
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- BaseEjectionTime
DurationResponse
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- ConsecutiveErrors
int
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- ConsecutiveGatewayFailure
int
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- EnforcingConsecutiveErrors
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- EnforcingConsecutiveGatewayFailure
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- EnforcingSuccessRate
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- Interval
DurationResponse
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- MaxEjectionPercent
int
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- SuccessRateMinimumHosts
int
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- SuccessRateRequestVolume
int
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- SuccessRateStdevFactor
int
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- base_ejection_time
object
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutive_errors
number
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive_gateway_failure
number
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcing_consecutive_errors
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing_consecutive_gateway_failure
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing_success_rate
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
object
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- max_ejection_percent
number
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- success_rate_minimum_hosts
number
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- success_rate_request_volume
number
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- success_rate_stdev_factor
number
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- baseEjectionTime
DurationResponse
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutiveErrors
Integer
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutiveGatewayFailure
Integer
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcingConsecutiveErrors
Integer
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcingConsecutiveGatewayFailure
Integer
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcingSuccessRate
Integer
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
DurationResponse
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- maxEjectionPercent
Integer
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- successRateMinimumHosts
Integer
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- successRateRequestVolume
Integer
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- successRateStdevFactor
Integer
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- baseEjectionTime
DurationResponse
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutiveErrors
number
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutiveGatewayFailure
number
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcingConsecutiveErrors
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcingConsecutiveGatewayFailure
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcingSuccessRate
number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
DurationResponse
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- maxEjectionPercent
number
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- successRateMinimumHosts
number
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- successRateRequestVolume
number
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- successRateStdevFactor
number
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- base_ejection_time
DurationResponse
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutive_errors
int
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive_gateway_failure
int
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcing_consecutive_errors
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing_consecutive_gateway_failure
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing_success_rate
int
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
DurationResponse
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- max_ejection_percent
int
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- success_rate_minimum_hosts
int
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- success_rate_request_volume
int
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- success_rate_stdev_factor
int
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
- baseEjectionTime
Property Map
- The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
- consecutiveErrors
Number
- Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutiveGatewayFailure
Number
- The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
- enforcingConsecutiveErrors
Number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcingConsecutiveGatewayFailure
Number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcingSuccessRate
Number
- The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- interval
Property Map
- Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
- maxEjectionPercent
Number
- Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
- successRateMinimumHosts
Number
- The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
- successRateRequestVolume
Number
- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
- successRateStdevFactor
Number
- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.
SecuritySettings, SecuritySettingsArgs
The authentication and authorization settings for a BackendService.
- Authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- AwsV4Authentication
Pulumi.GoogleNative.Compute.Beta.Inputs.AWSV4Signature
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- ClientTlsPolicy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- SubjectAltNames
List<string>
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- Authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- AwsV4Authentication
AWSV4Signature
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- ClientTlsPolicy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- SubjectAltNames
[]string
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- aws_v4_authentication
object
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- client_tls_policy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subject_alt_names
list(string)
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
String
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- awsV4Authentication
AWSV4Signature
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- clientTlsPolicy
String
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subjectAltNames
List<String>
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- awsV4Authentication
AWSV4Signature
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- clientTlsPolicy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subjectAltNames
string[]
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
str
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- aws_v4_authentication
AWSV4Signature
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- client_tls_policy
str
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subject_alt_names
Sequence[str]
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
String
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- awsV4Authentication
Property Map
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- clientTlsPolicy
String
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subjectAltNames
List<String>
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
SecuritySettingsResponse
The authentication and authorization settings for a BackendService.
- Authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- AwsV4Authentication
Pulumi.GoogleNative.Compute.Beta.Inputs.AWSV4SignatureResponse
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- ClientTlsPolicy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- SubjectAltNames
List<string>
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- Authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- AwsV4Authentication
AWSV4SignatureResponse
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- ClientTlsPolicy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- SubjectAltNames
[]string
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- aws_v4_authentication
object
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- client_tls_policy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subject_alt_names
list(string)
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
String
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- awsV4Authentication
AWSV4SignatureResponse
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- clientTlsPolicy
String
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subjectAltNames
List<String>
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
string
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- awsV4Authentication
AWSV4SignatureResponse
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- clientTlsPolicy
string
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subjectAltNames
string[]
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
str
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- aws_v4_authentication
AWSV4SignatureResponse
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- client_tls_policy
str
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subject_alt_names
Sequence[str]
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
- authentication
String
- [Deprecated] Use clientTlsPolicy instead.
Deprecated: [Deprecated] Use clientTlsPolicy instead.
- awsV4Authentication
Property Map
- The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
- clientTlsPolicy
String
- Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
- subjectAltNames
List<String>
- Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
Subsetting, SubsettingArgs
Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
- Policy
Pulumi.GoogleNative.Compute.Beta.SubsettingPolicy
- SubsetSize
int
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- Policy
SubsettingPolicy
- SubsetSize
int
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
"CONSISTENT_HASH_SUBSETTING" | "NONE"
- subset_size
number
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
SubsettingPolicy
- subsetSize
Integer
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
SubsettingPolicy
- subsetSize
number
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
SubsettingPolicy
- subset_size
int
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
"CONSISTENT_HASH_SUBSETTING" | "NONE"
- subsetSize
Number
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
SubsettingPolicy
| Name | Value | Description |
|---|
| ConsistentHashSubsetting | CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
| None | NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
| Name | Value | Description |
|---|
| SubsettingPolicyConsistentHashSubsetting | CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
| SubsettingPolicyNone | NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
| Value | Description |
|---|
CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
| Name | Value | Description |
|---|
| ConsistentHashSubsetting | CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
| None | NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
| Name | Value | Description |
|---|
| ConsistentHashSubsetting | CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
| None | NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
| Name | Value | Description |
|---|
| CONSISTENT_HASH_SUBSETTING | CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
| NONE | NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
| Value | Description |
|---|
CONSISTENT_HASH_SUBSETTING | Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the subset_size parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled. |
NONE | No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends. |
SubsettingResponse
Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
- Policy
string
- SubsetSize
int
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- Policy
string
- SubsetSize
int
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
string
- subset_size
number
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
String
- subsetSize
Integer
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
string
- subsetSize
number
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
str
- subset_size
int
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
- policy
String
- subsetSize
Number
- The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the
CONSISTENT_HASH_SUBSETTING algorithm. Can only be set if policy is set to CONSISTENT_HASH_SUBSETTING. Can only be set if load balancing scheme is INTERNAL_MANAGED or INTERNAL_SELF_MANAGED. subset_size is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If subset_size is larger than the number of backends/endpoints, then subsetting is disabled.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0