Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.compute/alpha.BackendService
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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
new BackendService(name: string, args?: BackendServiceArgs, opts?: CustomResourceOptions);
@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,
vpc_network_scope: Optional[BackendServiceVpcNetworkScope] = None)
func NewBackendService(ctx *Context, name string, args *BackendServiceArgs, opts ...ResourceOption) (*BackendService, error)
public BackendService(string name, BackendServiceArgs? args = null, CustomResourceOptions? opts = null)
public BackendService(String name, BackendServiceArgs args)
public BackendService(String name, BackendServiceArgs args, CustomResourceOptions options)
type: google-native:compute/alpha:BackendService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BackendServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- 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.
- opts CustomResourceOptions
- 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 backendServiceResource = new GoogleNative.Compute.Alpha.BackendService("backendServiceResource", new()
{
AffinityCookieTtlSec = 0,
Backends = new[]
{
new GoogleNative.Compute.Alpha.Inputs.BackendArgs
{
BalancingMode = GoogleNative.Compute.Alpha.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 = GoogleNative.Compute.Alpha.BackendPreference.Default,
},
},
CdnPolicy = new GoogleNative.Compute.Alpha.Inputs.BackendServiceCdnPolicyArgs
{
BypassCacheOnRequestHeaders = new[]
{
new GoogleNative.Compute.Alpha.Inputs.BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs
{
HeaderName = "string",
},
},
CacheKeyPolicy = new GoogleNative.Compute.Alpha.Inputs.CacheKeyPolicyArgs
{
IncludeHost = false,
IncludeHttpHeaders = new[]
{
"string",
},
IncludeNamedCookies = new[]
{
"string",
},
IncludeProtocol = false,
IncludeQueryString = false,
QueryStringBlacklist = new[]
{
"string",
},
QueryStringWhitelist = new[]
{
"string",
},
},
CacheMode = GoogleNative.Compute.Alpha.BackendServiceCdnPolicyCacheMode.CacheAllStatic,
ClientTtl = 0,
DefaultTtl = 0,
MaxTtl = 0,
NegativeCaching = false,
NegativeCachingPolicy = new[]
{
new GoogleNative.Compute.Alpha.Inputs.BackendServiceCdnPolicyNegativeCachingPolicyArgs
{
Code = 0,
Ttl = 0,
},
},
RequestCoalescing = false,
ServeWhileStale = 0,
SignedUrlCacheMaxAgeSec = "string",
},
CircuitBreakers = new GoogleNative.Compute.Alpha.Inputs.CircuitBreakersArgs
{
ConnectTimeout = new GoogleNative.Compute.Alpha.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
MaxConnections = 0,
MaxPendingRequests = 0,
MaxRequests = 0,
MaxRequestsPerConnection = 0,
MaxRetries = 0,
},
CompressionMode = GoogleNative.Compute.Alpha.BackendServiceCompressionMode.Automatic,
ConnectionDraining = new GoogleNative.Compute.Alpha.Inputs.ConnectionDrainingArgs
{
DrainingTimeoutSec = 0,
},
ConnectionTrackingPolicy = new GoogleNative.Compute.Alpha.Inputs.BackendServiceConnectionTrackingPolicyArgs
{
ConnectionPersistenceOnUnhealthyBackends = GoogleNative.Compute.Alpha.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.AlwaysPersist,
EnableStrongAffinity = false,
IdleTimeoutSec = 0,
TrackingMode = GoogleNative.Compute.Alpha.BackendServiceConnectionTrackingPolicyTrackingMode.InvalidTrackingMode,
},
ConsistentHash = new GoogleNative.Compute.Alpha.Inputs.ConsistentHashLoadBalancerSettingsArgs
{
HttpCookie = new GoogleNative.Compute.Alpha.Inputs.ConsistentHashLoadBalancerSettingsHttpCookieArgs
{
Name = "string",
Path = "string",
Ttl = new GoogleNative.Compute.Alpha.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
},
HttpHeaderName = "string",
MinimumRingSize = "string",
},
CustomRequestHeaders = new[]
{
"string",
},
CustomResponseHeaders = new[]
{
"string",
},
Description = "string",
EnableCDN = false,
FailoverPolicy = new GoogleNative.Compute.Alpha.Inputs.BackendServiceFailoverPolicyArgs
{
DisableConnectionDrainOnFailover = false,
DropTrafficIfUnhealthy = false,
FailoverRatio = 0,
},
HealthChecks = new[]
{
"string",
},
Iap = new GoogleNative.Compute.Alpha.Inputs.BackendServiceIAPArgs
{
Enabled = false,
Oauth2ClientId = "string",
Oauth2ClientInfo = new GoogleNative.Compute.Alpha.Inputs.BackendServiceIAPOAuth2ClientInfoArgs
{
ApplicationName = "string",
ClientName = "string",
DeveloperEmailAddress = "string",
},
Oauth2ClientSecret = "string",
},
IpAddressSelectionPolicy = GoogleNative.Compute.Alpha.BackendServiceIpAddressSelectionPolicy.Ipv4Only,
LoadBalancingScheme = GoogleNative.Compute.Alpha.BackendServiceLoadBalancingScheme.External,
LocalityLbPolicies = new[]
{
new GoogleNative.Compute.Alpha.Inputs.BackendServiceLocalityLoadBalancingPolicyConfigArgs
{
CustomPolicy = new GoogleNative.Compute.Alpha.Inputs.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs
{
Data = "string",
Name = "string",
},
Policy = new GoogleNative.Compute.Alpha.Inputs.BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs
{
Name = GoogleNative.Compute.Alpha.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.InvalidLbPolicy,
},
},
},
LocalityLbPolicy = GoogleNative.Compute.Alpha.BackendServiceLocalityLbPolicy.InvalidLbPolicy,
LogConfig = new GoogleNative.Compute.Alpha.Inputs.BackendServiceLogConfigArgs
{
Enable = false,
OptionalFields = new[]
{
"string",
},
OptionalMode = GoogleNative.Compute.Alpha.BackendServiceLogConfigOptionalMode.Custom,
SampleRate = 0,
},
MaxStreamDuration = new GoogleNative.Compute.Alpha.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
Metadatas =
{
{ "string", "string" },
},
Name = "string",
Network = "string",
OutlierDetection = new GoogleNative.Compute.Alpha.Inputs.OutlierDetectionArgs
{
BaseEjectionTime = new GoogleNative.Compute.Alpha.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
ConsecutiveErrors = 0,
ConsecutiveGatewayFailure = 0,
EnforcingConsecutiveErrors = 0,
EnforcingConsecutiveGatewayFailure = 0,
EnforcingSuccessRate = 0,
Interval = new GoogleNative.Compute.Alpha.Inputs.DurationArgs
{
Nanos = 0,
Seconds = "string",
},
MaxEjectionPercent = 0,
SuccessRateMinimumHosts = 0,
SuccessRateRequestVolume = 0,
SuccessRateStdevFactor = 0,
},
PortName = "string",
Project = "string",
Protocol = GoogleNative.Compute.Alpha.BackendServiceProtocol.All,
RequestId = "string",
SecuritySettings = new GoogleNative.Compute.Alpha.Inputs.SecuritySettingsArgs
{
AwsV4Authentication = new GoogleNative.Compute.Alpha.Inputs.AWSV4SignatureArgs
{
AccessKey = "string",
AccessKeyId = "string",
AccessKeyVersion = "string",
OriginRegion = "string",
},
ClientTlsPolicy = "string",
SubjectAltNames = new[]
{
"string",
},
},
ServiceBindings = new[]
{
"string",
},
ServiceLbPolicy = "string",
SessionAffinity = GoogleNative.Compute.Alpha.BackendServiceSessionAffinity.ClientIp,
Subsetting = new GoogleNative.Compute.Alpha.Inputs.SubsettingArgs
{
Policy = GoogleNative.Compute.Alpha.SubsettingPolicy.ConsistentHashSubsetting,
SubsetSize = 0,
},
TimeoutSec = 0,
UsedBy = new[]
{
new GoogleNative.Compute.Alpha.Inputs.BackendServiceUsedByArgs
{
Reference = "string",
},
},
VpcNetworkScope = GoogleNative.Compute.Alpha.BackendServiceVpcNetworkScope.GlobalVpcNetwork,
});
example, err := compute.NewBackendService(ctx, "backendServiceResource", &compute.BackendServiceArgs{
AffinityCookieTtlSec: pulumi.Int(0),
Backends: compute.BackendArray{
&compute.BackendArgs{
BalancingMode: compute.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: compute.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: compute.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: compute.BackendServiceCompressionModeAutomatic,
ConnectionDraining: &compute.ConnectionDrainingArgs{
DrainingTimeoutSec: pulumi.Int(0),
},
ConnectionTrackingPolicy: &compute.BackendServiceConnectionTrackingPolicyArgs{
ConnectionPersistenceOnUnhealthyBackends: compute.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackendsAlwaysPersist,
EnableStrongAffinity: pulumi.Bool(false),
IdleTimeoutSec: pulumi.Int(0),
TrackingMode: compute.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"),
Oauth2ClientInfo: &compute.BackendServiceIAPOAuth2ClientInfoArgs{
ApplicationName: pulumi.String("string"),
ClientName: pulumi.String("string"),
DeveloperEmailAddress: pulumi.String("string"),
},
Oauth2ClientSecret: pulumi.String("string"),
},
IpAddressSelectionPolicy: compute.BackendServiceIpAddressSelectionPolicyIpv4Only,
LoadBalancingScheme: compute.BackendServiceLoadBalancingSchemeExternal,
LocalityLbPolicies: compute.BackendServiceLocalityLoadBalancingPolicyConfigArray{
&compute.BackendServiceLocalityLoadBalancingPolicyConfigArgs{
CustomPolicy: &compute.BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs{
Data: pulumi.String("string"),
Name: pulumi.String("string"),
},
Policy: &compute.BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs{
Name: compute.BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameInvalidLbPolicy,
},
},
},
LocalityLbPolicy: compute.BackendServiceLocalityLbPolicyInvalidLbPolicy,
LogConfig: &compute.BackendServiceLogConfigArgs{
Enable: pulumi.Bool(false),
OptionalFields: pulumi.StringArray{
pulumi.String("string"),
},
OptionalMode: compute.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: compute.BackendServiceProtocolAll,
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: compute.BackendServiceSessionAffinityClientIp,
Subsetting: &compute.SubsettingArgs{
Policy: compute.SubsettingPolicyConsistentHashSubsetting,
SubsetSize: pulumi.Int(0),
},
TimeoutSec: pulumi.Int(0),
UsedBy: compute.BackendServiceUsedByArray{
&compute.BackendServiceUsedByArgs{
Reference: pulumi.String("string"),
},
},
VpcNetworkScope: compute.BackendServiceVpcNetworkScopeGlobalVpcNetwork,
})
var backendServiceResource = new BackendService("backendServiceResource", BackendServiceArgs.builder()
.affinityCookieTtlSec(0)
.backends(BackendArgs.builder()
.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")
.build())
.cdnPolicy(BackendServiceCdnPolicyArgs.builder()
.bypassCacheOnRequestHeaders(BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs.builder()
.headerName("string")
.build())
.cacheKeyPolicy(CacheKeyPolicyArgs.builder()
.includeHost(false)
.includeHttpHeaders("string")
.includeNamedCookies("string")
.includeProtocol(false)
.includeQueryString(false)
.queryStringBlacklist("string")
.queryStringWhitelist("string")
.build())
.cacheMode("CACHE_ALL_STATIC")
.clientTtl(0)
.defaultTtl(0)
.maxTtl(0)
.negativeCaching(false)
.negativeCachingPolicy(BackendServiceCdnPolicyNegativeCachingPolicyArgs.builder()
.code(0)
.ttl(0)
.build())
.requestCoalescing(false)
.serveWhileStale(0)
.signedUrlCacheMaxAgeSec("string")
.build())
.circuitBreakers(CircuitBreakersArgs.builder()
.connectTimeout(DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.maxConnections(0)
.maxPendingRequests(0)
.maxRequests(0)
.maxRequestsPerConnection(0)
.maxRetries(0)
.build())
.compressionMode("AUTOMATIC")
.connectionDraining(ConnectionDrainingArgs.builder()
.drainingTimeoutSec(0)
.build())
.connectionTrackingPolicy(BackendServiceConnectionTrackingPolicyArgs.builder()
.connectionPersistenceOnUnhealthyBackends("ALWAYS_PERSIST")
.enableStrongAffinity(false)
.idleTimeoutSec(0)
.trackingMode("INVALID_TRACKING_MODE")
.build())
.consistentHash(ConsistentHashLoadBalancerSettingsArgs.builder()
.httpCookie(ConsistentHashLoadBalancerSettingsHttpCookieArgs.builder()
.name("string")
.path("string")
.ttl(DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.build())
.httpHeaderName("string")
.minimumRingSize("string")
.build())
.customRequestHeaders("string")
.customResponseHeaders("string")
.description("string")
.enableCDN(false)
.failoverPolicy(BackendServiceFailoverPolicyArgs.builder()
.disableConnectionDrainOnFailover(false)
.dropTrafficIfUnhealthy(false)
.failoverRatio(0)
.build())
.healthChecks("string")
.iap(BackendServiceIAPArgs.builder()
.enabled(false)
.oauth2ClientId("string")
.oauth2ClientInfo(BackendServiceIAPOAuth2ClientInfoArgs.builder()
.applicationName("string")
.clientName("string")
.developerEmailAddress("string")
.build())
.oauth2ClientSecret("string")
.build())
.ipAddressSelectionPolicy("IPV4_ONLY")
.loadBalancingScheme("EXTERNAL")
.localityLbPolicies(BackendServiceLocalityLoadBalancingPolicyConfigArgs.builder()
.customPolicy(BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs.builder()
.data("string")
.name("string")
.build())
.policy(BackendServiceLocalityLoadBalancingPolicyConfigPolicyArgs.builder()
.name("INVALID_LB_POLICY")
.build())
.build())
.localityLbPolicy("INVALID_LB_POLICY")
.logConfig(BackendServiceLogConfigArgs.builder()
.enable(false)
.optionalFields("string")
.optionalMode("CUSTOM")
.sampleRate(0)
.build())
.maxStreamDuration(DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.metadatas(Map.of("string", "string"))
.name("string")
.network("string")
.outlierDetection(OutlierDetectionArgs.builder()
.baseEjectionTime(DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.consecutiveErrors(0)
.consecutiveGatewayFailure(0)
.enforcingConsecutiveErrors(0)
.enforcingConsecutiveGatewayFailure(0)
.enforcingSuccessRate(0)
.interval(DurationArgs.builder()
.nanos(0)
.seconds("string")
.build())
.maxEjectionPercent(0)
.successRateMinimumHosts(0)
.successRateRequestVolume(0)
.successRateStdevFactor(0)
.build())
.portName("string")
.project("string")
.protocol("ALL")
.requestId("string")
.securitySettings(SecuritySettingsArgs.builder()
.awsV4Authentication(AWSV4SignatureArgs.builder()
.accessKey("string")
.accessKeyId("string")
.accessKeyVersion("string")
.originRegion("string")
.build())
.clientTlsPolicy("string")
.subjectAltNames("string")
.build())
.serviceBindings("string")
.serviceLbPolicy("string")
.sessionAffinity("CLIENT_IP")
.subsetting(SubsettingArgs.builder()
.policy("CONSISTENT_HASH_SUBSETTING")
.subsetSize(0)
.build())
.timeoutSec(0)
.usedBy(BackendServiceUsedByArgs.builder()
.reference("string")
.build())
.vpcNetworkScope("GLOBAL_VPC_NETWORK")
.build());
backend_service_resource = google_native.compute.alpha.BackendService("backendServiceResource",
affinity_cookie_ttl_sec=0,
backends=[{
"balancing_mode": google_native.compute.alpha.BackendBalancingMode.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": google_native.compute.alpha.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.alpha.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.alpha.BackendServiceCompressionMode.AUTOMATIC,
connection_draining={
"draining_timeout_sec": 0,
},
connection_tracking_policy={
"connection_persistence_on_unhealthy_backends": google_native.compute.alpha.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.ALWAYS_PERSIST,
"enable_strong_affinity": False,
"idle_timeout_sec": 0,
"tracking_mode": google_native.compute.alpha.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": 0,
},
health_checks=["string"],
iap={
"enabled": False,
"oauth2_client_id": "string",
"oauth2_client_info": {
"application_name": "string",
"client_name": "string",
"developer_email_address": "string",
},
"oauth2_client_secret": "string",
},
ip_address_selection_policy=google_native.compute.alpha.BackendServiceIpAddressSelectionPolicy.IPV4_ONLY,
load_balancing_scheme=google_native.compute.alpha.BackendServiceLoadBalancingScheme.EXTERNAL,
locality_lb_policies=[{
"custom_policy": {
"data": "string",
"name": "string",
},
"policy": {
"name": google_native.compute.alpha.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.INVALID_LB_POLICY,
},
}],
locality_lb_policy=google_native.compute.alpha.BackendServiceLocalityLbPolicy.INVALID_LB_POLICY,
log_config={
"enable": False,
"optional_fields": ["string"],
"optional_mode": google_native.compute.alpha.BackendServiceLogConfigOptionalMode.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=google_native.compute.alpha.BackendServiceProtocol.ALL,
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.alpha.BackendServiceSessionAffinity.CLIENT_IP,
subsetting={
"policy": google_native.compute.alpha.SubsettingPolicy.CONSISTENT_HASH_SUBSETTING,
"subset_size": 0,
},
timeout_sec=0,
used_by=[{
"reference": "string",
}],
vpc_network_scope=google_native.compute.alpha.BackendServiceVpcNetworkScope.GLOBAL_VPC_NETWORK)
const backendServiceResource = new google_native.compute.alpha.BackendService("backendServiceResource", {
affinityCookieTtlSec: 0,
backends: [{
balancingMode: google_native.compute.alpha.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.alpha.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.alpha.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.alpha.BackendServiceCompressionMode.Automatic,
connectionDraining: {
drainingTimeoutSec: 0,
},
connectionTrackingPolicy: {
connectionPersistenceOnUnhealthyBackends: google_native.compute.alpha.BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends.AlwaysPersist,
enableStrongAffinity: false,
idleTimeoutSec: 0,
trackingMode: google_native.compute.alpha.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",
oauth2ClientInfo: {
applicationName: "string",
clientName: "string",
developerEmailAddress: "string",
},
oauth2ClientSecret: "string",
},
ipAddressSelectionPolicy: google_native.compute.alpha.BackendServiceIpAddressSelectionPolicy.Ipv4Only,
loadBalancingScheme: google_native.compute.alpha.BackendServiceLoadBalancingScheme.External,
localityLbPolicies: [{
customPolicy: {
data: "string",
name: "string",
},
policy: {
name: google_native.compute.alpha.BackendServiceLocalityLoadBalancingPolicyConfigPolicyName.InvalidLbPolicy,
},
}],
localityLbPolicy: google_native.compute.alpha.BackendServiceLocalityLbPolicy.InvalidLbPolicy,
logConfig: {
enable: false,
optionalFields: ["string"],
optionalMode: google_native.compute.alpha.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.alpha.BackendServiceProtocol.All,
requestId: "string",
securitySettings: {
awsV4Authentication: {
accessKey: "string",
accessKeyId: "string",
accessKeyVersion: "string",
originRegion: "string",
},
clientTlsPolicy: "string",
subjectAltNames: ["string"],
},
serviceBindings: ["string"],
serviceLbPolicy: "string",
sessionAffinity: google_native.compute.alpha.BackendServiceSessionAffinity.ClientIp,
subsetting: {
policy: google_native.compute.alpha.SubsettingPolicy.ConsistentHashSubsetting,
subsetSize: 0,
},
timeoutSec: 0,
usedBy: [{
reference: "string",
}],
vpcNetworkScope: google_native.compute.alpha.BackendServiceVpcNetworkScope.GlobalVpcNetwork,
});
type: google-native:compute/alpha: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
oauth2ClientInfo:
applicationName: string
clientName: string
developerEmailAddress: 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: ALL
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
vpcNetworkScope: GLOBAL_VPC_NETWORK
BackendService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
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:
- 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.
Google Native. Compute. Alpha. Inputs. Backend> - The list of backends that serve this BackendService.
- Cdn
Policy Pulumi.Google Native. Compute. Alpha. Inputs. Backend Service Cdn Policy - Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- Circuit
Breakers Pulumi.Google Native. Compute. Alpha. Inputs. Circuit Breakers - Compression
Mode Pulumi.Google Native. Compute. Alpha. Backend Service Compression Mode - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- Connection
Draining Pulumi.Google Native. Compute. Alpha. Inputs. Connection Draining - Connection
Tracking Pulumi.Policy Google Native. Compute. Alpha. Inputs. Backend Service Connection Tracking Policy - 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 Pulumi.Google Native. Compute. Alpha. Inputs. Consistent Hash Load Balancer Settings - 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.
- Custom
Request List<string>Headers - Headers that the load balancer adds to proxied requests. See Creating custom headers.
- Custom
Response List<string>Headers - 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 Pulumi.Google Native. Compute. Alpha. Inputs. Backend Service Failover Policy - 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
Pulumi.
Google Native. Compute. Alpha. Inputs. Backend Service IAP - The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- Ip
Address Pulumi.Selection Policy Google Native. Compute. Alpha. Backend Service Ip Address Selection Policy - 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 Pulumi.Scheme Google Native. Compute. Alpha. Backend Service 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 List<Pulumi.Policies Google Native. Compute. Alpha. Inputs. Backend Service Locality Load Balancing Policy Config> - 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 Pulumi.Policy Google Native. Compute. Alpha. Backend Service Locality Lb Policy - 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 Pulumi.Google Native. Compute. Alpha. Inputs. Backend Service Log Config - 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 Pulumi.Duration Google Native. Compute. Alpha. 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.
- Outlier
Detection Pulumi.Google Native. Compute. Alpha. Inputs. Outlier Detection - 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.
- 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
Pulumi.
Google Native. Compute. Alpha. Backend Service Protocol - 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 Pulumi.Google Native. Compute. Alpha. Inputs. Security Settings - 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 stringPolicy - 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 Pulumi.Google Native. Compute. Alpha. Backend Service Session Affinity - 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.
Google Native. Compute. Alpha. Inputs. Subsetting - 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 List<Pulumi.Google Native. Compute. Alpha. Inputs. Backend Service Used By> - Vpc
Network Pulumi.Scope Google Native. Compute. Alpha. Backend Service Vpc Network Scope - The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used.
- 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
[]Backend
Args - The list of backends that serve this BackendService.
- Cdn
Policy BackendService Cdn Policy Args - Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- Circuit
Breakers CircuitBreakers Args - Compression
Mode BackendService Compression Mode - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- Connection
Draining ConnectionDraining Args - Connection
Tracking BackendPolicy Service Connection Tracking Policy Args - 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 ConsistentHash Load Balancer Settings Args - 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.
- Custom
Request []stringHeaders - Headers that the load balancer adds to proxied requests. See Creating custom headers.
- Custom
Response []stringHeaders - 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 BackendService Failover Policy Args - 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 []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
Backend
Service IAPArgs - The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- Ip
Address BackendSelection Policy Service Ip Address Selection Policy - 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 BackendScheme Service 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 []BackendPolicies Service Locality Load Balancing Policy Config Args - 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 BackendPolicy Service Locality Lb Policy - 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 BackendService Log Config Args - 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 DurationDuration Args - 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.
- Outlier
Detection OutlierDetection Args - 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.
- 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
Backend
Service Protocol - 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 SecuritySettings Args - 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 []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 stringPolicy - 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 BackendService Session Affinity - 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
Args - 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 []BackendService Used By Args - Vpc
Network BackendScope Service Vpc Network Scope - The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used.
- 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.
- cdn
Policy BackendService Cdn Policy - Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuit
Breakers CircuitBreakers - compression
Mode BackendService Compression Mode - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connection
Draining ConnectionDraining - connection
Tracking BackendPolicy Service Connection Tracking Policy - 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 ConsistentHash Load Balancer Settings - 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.
- custom
Request List<String>Headers - Headers that the load balancer adds to proxied requests. See Creating custom headers.
- custom
Response List<String>Headers - 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 Boolean - If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failover
Policy BackendService Failover Policy - 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
Backend
Service IAP - The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ip
Address BackendSelection Policy Service Ip Address Selection Policy - 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 BackendScheme Service 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 List<BackendPolicies Service Locality Load Balancing Policy Config> - 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 BackendPolicy Service Locality Lb Policy - 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 BackendService Log Config - 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 DurationDuration - 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.
- outlier
Detection 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.
- 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
Backend
Service Protocol - 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 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.
- 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 StringPolicy - 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 BackendService Session Affinity - 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
- timeout
Sec 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.
- used
By List<BackendService Used By> - vpc
Network BackendScope Service Vpc Network Scope - The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used.
- 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.
- cdn
Policy BackendService Cdn Policy - Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuit
Breakers CircuitBreakers - compression
Mode BackendService Compression Mode - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connection
Draining ConnectionDraining - connection
Tracking BackendPolicy Service Connection Tracking Policy - 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 ConsistentHash Load Balancer Settings - 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.
- custom
Request string[]Headers - Headers that the load balancer adds to proxied requests. See Creating custom headers.
- custom
Response string[]Headers - 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 boolean - If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failover
Policy BackendService Failover Policy - 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 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
Backend
Service IAP - The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ip
Address BackendSelection Policy Service Ip Address Selection Policy - 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 BackendScheme Service 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 BackendPolicies Service Locality Load Balancing Policy Config[] - 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 BackendPolicy Service Locality Lb Policy - 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 BackendService Log Config - 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 DurationDuration - 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.
- outlier
Detection 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.
- 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
Backend
Service Protocol - 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 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.
- service
Bindings 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 stringPolicy - 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 BackendService Session Affinity - 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
- 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 BackendService Used By[] - vpc
Network BackendScope Service Vpc Network Scope - The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used.
- 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[Backend
Args] - The list of backends that serve this BackendService.
- cdn_
policy BackendService Cdn Policy Args - Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuit_
breakers CircuitBreakers Args - compression_
mode BackendService Compression Mode - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connection_
draining ConnectionDraining Args - connection_
tracking_ Backendpolicy Service Connection Tracking Policy Args - 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 ConsistentHash Load Balancer Settings Args - 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.
- custom_
request_ Sequence[str]headers - Headers that the load balancer adds to proxied requests. See Creating custom headers.
- custom_
response_ Sequence[str]headers - 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 BackendService Failover Policy Args - 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
Backend
Service IAPArgs - The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ip_
address_ Backendselection_ policy Service Ip Address Selection Policy - 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_ Backendscheme Service 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_ Sequence[Backendpolicies Service Locality Load Balancing Policy Config Args] - 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_ Backendpolicy Service Locality Lb Policy - 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 BackendService Log Config Args - 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_ Durationduration Args - 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 OutlierDetection Args - 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.
- 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
Backend
Service Protocol - 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 SecuritySettings Args - 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_ strpolicy - 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 BackendService Session Affinity - 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
Args - 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[BackendService Used By Args] - vpc_
network_ Backendscope Service Vpc Network Scope - The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used.
- 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.
- cdn
Policy Property Map - Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
- circuit
Breakers Property Map - compression
Mode "AUTOMATIC" | "DISABLED" - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
- connection
Draining Property Map - connection
Tracking Property MapPolicy - 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 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.
- custom
Request List<String>Headers - Headers that the load balancer adds to proxied requests. See Creating custom headers.
- custom
Response List<String>Headers - 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 Boolean - If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
- failover
Policy 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.
- 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 Property Map
- The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
- ip
Address "IPV4_ONLY" | "IPV6_ONLY" | "IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED" | "PREFER_IPV6"Selection Policy - 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 "EXTERNAL" | "EXTERNAL_MANAGED" | "INTERNAL" | "INTERNAL_MANAGED" | "INTERNAL_SELF_MANAGED" | "INVALID_LOAD_BALANCING_SCHEME"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 List<Property Map>Policies - 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 "INVALID_LB_POLICY" | "LEAST_REQUEST" | "MAGLEV" | "ORIGINAL_DESTINATION" | "RANDOM" | "RING_HASH" | "ROUND_ROBIN" | "WEIGHTED_MAGLEV"Policy - 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 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.
- max
Stream Property MapDuration - 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 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.
- 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 "ALL" | "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 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.
- 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 StringPolicy - 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 Property Map
- 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<Property Map> - vpc
Network "GLOBAL_VPC_NETWORK" | "REGIONAL_VPC_NETWORK"Scope - The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used.
Outputs
All input properties are implicitly available as output properties. Additionally, the BackendService resource produces the following output properties:
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Edge
Security stringPolicy - 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.
- Self
Link stringWith Id - Server-defined URL for this resource with the resource id.
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Edge
Security stringPolicy - 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.
- Self
Link stringWith Id - Server-defined URL for this resource with the resource id.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- edge
Security StringPolicy - 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.
- self
Link StringWith Id - Server-defined URL for this resource with the resource id.
- creation
Timestamp string - Creation timestamp in RFC3339 text format.
- edge
Security stringPolicy - 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.
- self
Link stringWith Id - Server-defined URL for this resource with the resource id.
- creation_
timestamp str - Creation timestamp in RFC3339 text format.
- edge_
security_ strpolicy - 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.
- self_
link_ strwith_ id - Server-defined URL for this resource with the resource id.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- edge
Security StringPolicy - 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.
- self
Link StringWith Id - Server-defined URL for this resource with the resource id.
Supporting Types
AWSV4Signature, AWSV4SignatureArgs
- 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 stringId - The identifier of an access key used for s3 bucket authentication.
- Access
Key stringVersion - 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.
- 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 stringId - The identifier of an access key used for s3 bucket authentication.
- Access
Key stringVersion - 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.
- 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 StringId - The identifier of an access key used for s3 bucket authentication.
- access
Key StringVersion - 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.
- 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 stringId - The identifier of an access key used for s3 bucket authentication.
- access
Key stringVersion - 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.
- 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_ strid - The identifier of an access key used for s3 bucket authentication.
- access_
key_ strversion - 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.
- 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 StringId - The identifier of an access key used for s3 bucket authentication.
- access
Key StringVersion - 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.
AWSV4SignatureResponse, AWSV4SignatureResponseArgs
- 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 stringId - The identifier of an access key used for s3 bucket authentication.
- Access
Key stringVersion - 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.
- 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 stringId - The identifier of an access key used for s3 bucket authentication.
- Access
Key stringVersion - 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.
- 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 StringId - The identifier of an access key used for s3 bucket authentication.
- access
Key StringVersion - 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.
- 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 stringId - The identifier of an access key used for s3 bucket authentication.
- access
Key stringVersion - 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.
- 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_ strid - The identifier of an access key used for s3 bucket authentication.
- access_
key_ strversion - 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.
- 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 StringId - The identifier of an access key used for s3 bucket authentication.
- access
Key StringVersion - 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.
AuthenticationPolicy, AuthenticationPolicyArgs
- Origins
List<Pulumi.
Google Native. Compute. Alpha. Inputs. Origin Authentication Method> - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- Peers
List<Pulumi.
Google Native. Compute. Alpha. Inputs. Peer Authentication Method> - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- Principal
Binding Pulumi.Google Native. Compute. Alpha. Authentication Policy Principal Binding - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- Server
Tls Pulumi.Context Google Native. Compute. Alpha. Inputs. Tls Context - Configures the mechanism to obtain server-side security certificates and identity information.
- Origins
[]Origin
Authentication Method - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- Peers
[]Peer
Authentication Method - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- Principal
Binding AuthenticationPolicy Principal Binding - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- Server
Tls TlsContext Context - Configures the mechanism to obtain server-side security certificates and identity information.
- origins
List<Origin
Authentication Method> - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers
List<Peer
Authentication Method> - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal
Binding AuthenticationPolicy Principal Binding - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server
Tls TlsContext Context - Configures the mechanism to obtain server-side security certificates and identity information.
- origins
Origin
Authentication Method[] - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers
Peer
Authentication Method[] - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal
Binding AuthenticationPolicy Principal Binding - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server
Tls TlsContext Context - Configures the mechanism to obtain server-side security certificates and identity information.
- origins
Sequence[Origin
Authentication Method] - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers
Sequence[Peer
Authentication Method] - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal_
binding AuthenticationPolicy Principal Binding - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server_
tls_ Tlscontext Context - Configures the mechanism to obtain server-side security certificates and identity information.
- origins List<Property Map>
- List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers List<Property Map>
- List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal
Binding "INVALID" | "USE_ORIGIN" | "USE_PEER" - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server
Tls Property MapContext - Configures the mechanism to obtain server-side security certificates and identity information.
AuthenticationPolicyPrincipalBinding, AuthenticationPolicyPrincipalBindingArgs
- Invalid
- INVALID
- Use
Origin - USE_ORIGINPrincipal will be set to the identity from origin authentication.
- Use
Peer - USE_PEERPrincipal will be set to the identity from peer authentication.
- Authentication
Policy Principal Binding Invalid - INVALID
- Authentication
Policy Principal Binding Use Origin - USE_ORIGINPrincipal will be set to the identity from origin authentication.
- Authentication
Policy Principal Binding Use Peer - USE_PEERPrincipal will be set to the identity from peer authentication.
- Invalid
- INVALID
- Use
Origin - USE_ORIGINPrincipal will be set to the identity from origin authentication.
- Use
Peer - USE_PEERPrincipal will be set to the identity from peer authentication.
- Invalid
- INVALID
- Use
Origin - USE_ORIGINPrincipal will be set to the identity from origin authentication.
- Use
Peer - USE_PEERPrincipal will be set to the identity from peer authentication.
- INVALID
- INVALID
- USE_ORIGIN
- USE_ORIGINPrincipal will be set to the identity from origin authentication.
- USE_PEER
- USE_PEERPrincipal will be set to the identity from peer authentication.
- "INVALID"
- INVALID
- "USE_ORIGIN"
- USE_ORIGINPrincipal will be set to the identity from origin authentication.
- "USE_PEER"
- USE_PEERPrincipal will be set to the identity from peer authentication.
AuthenticationPolicyResponse, AuthenticationPolicyResponseArgs
- Origins
List<Pulumi.
Google Native. Compute. Alpha. Inputs. Origin Authentication Method Response> - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- Peers
List<Pulumi.
Google Native. Compute. Alpha. Inputs. Peer Authentication Method Response> - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- Principal
Binding string - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- Server
Tls Pulumi.Context Google Native. Compute. Alpha. Inputs. Tls Context Response - Configures the mechanism to obtain server-side security certificates and identity information.
- Origins
[]Origin
Authentication Method Response - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- Peers
[]Peer
Authentication Method Response - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- Principal
Binding string - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- Server
Tls TlsContext Context Response - Configures the mechanism to obtain server-side security certificates and identity information.
- origins
List<Origin
Authentication Method Response> - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers
List<Peer
Authentication Method Response> - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal
Binding String - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server
Tls TlsContext Context Response - Configures the mechanism to obtain server-side security certificates and identity information.
- origins
Origin
Authentication Method Response[] - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers
Peer
Authentication Method Response[] - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal
Binding string - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server
Tls TlsContext Context Response - Configures the mechanism to obtain server-side security certificates and identity information.
- origins
Sequence[Origin
Authentication Method Response] - List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers
Sequence[Peer
Authentication Method Response] - List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal_
binding str - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server_
tls_ Tlscontext Context Response - Configures the mechanism to obtain server-side security certificates and identity information.
- origins List<Property Map>
- List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required.
- peers List<Property Map>
- List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required.
- principal
Binding String - Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication.
- server
Tls Property MapContext - Configures the mechanism to obtain server-side security certificates and identity information.
AuthorizationConfig, AuthorizationConfigArgs
- Policies
List<Pulumi.
Google Native. Compute. Alpha. Inputs. Rbac Policy> - List of RbacPolicies.
- Policies
[]Rbac
Policy - List of RbacPolicies.
- policies
List<Rbac
Policy> - List of RbacPolicies.
- policies
Rbac
Policy[] - List of RbacPolicies.
- policies
Sequence[Rbac
Policy] - List of RbacPolicies.
- policies List<Property Map>
- List of RbacPolicies.
AuthorizationConfigResponse, AuthorizationConfigResponseArgs
- Policies
List<Pulumi.
Google Native. Compute. Alpha. Inputs. Rbac Policy Response> - List of RbacPolicies.
- Policies
[]Rbac
Policy Response - List of RbacPolicies.
- policies
List<Rbac
Policy Response> - List of RbacPolicies.
- policies
Rbac
Policy Response[] - List of RbacPolicies.
- policies
Sequence[Rbac
Policy Response] - List of RbacPolicies.
- policies List<Property Map>
- List of RbacPolicies.
Backend, BackendArgs
- Balancing
Mode Pulumi.Google Native. Compute. Alpha. Backend Balancing Mode - 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 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.
- 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 intPer Endpoint - 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 intPer Instance - 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 doublePer Endpoint - 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 doublePer Instance - 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 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.
Google Native. Compute. Alpha. Backend Preference - 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 BackendBalancing Mode - 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 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.
- 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 intPer Endpoint - 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 intPer Instance - 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 float64Per Endpoint - 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 float64Per Instance - 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 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
Backend
Preference - 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 BackendBalancing Mode - 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 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.
- max
Connections 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.
- max
Connections IntegerPer Endpoint - 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 IntegerPer Instance - 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 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.
- max
Rate DoublePer Endpoint - 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 DoublePer Instance - 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 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
Backend
Preference - 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 BackendBalancing Mode - 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 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.
- 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 numberPer Endpoint - 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 numberPer Instance - 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 numberPer Endpoint - 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 numberPer Instance - 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
Backend
Preference - 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 BackendBalancing Mode - 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_ intper_ endpoint - 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_ intper_ instance - 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_ floatper_ endpoint - 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_ floatper_ instance - 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
Backend
Preference - 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 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.
- 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 NumberPer Endpoint - 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 NumberPer Instance - 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 NumberPer Endpoint - 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 NumberPer Instance - 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
BackendBalancingMode, BackendBalancingModeArgs
- Connection
- CONNECTIONBalance based on the number of simultaneous connections.
- Rate
- RATEBalance based on requests per second (RPS).
- Utilization
- UTILIZATIONBalance based on the backend utilization.
- Backend
Balancing Mode Connection - CONNECTIONBalance based on the number of simultaneous connections.
- Backend
Balancing Mode Rate - RATEBalance based on requests per second (RPS).
- Backend
Balancing Mode Utilization - UTILIZATIONBalance based on the backend utilization.
- Connection
- CONNECTIONBalance based on the number of simultaneous connections.
- Rate
- RATEBalance based on requests per second (RPS).
- Utilization
- UTILIZATIONBalance based on the backend utilization.
- Connection
- CONNECTIONBalance based on the number of simultaneous connections.
- Rate
- RATEBalance based on requests per second (RPS).
- Utilization
- UTILIZATIONBalance based on the backend utilization.
- CONNECTION
- CONNECTIONBalance based on the number of simultaneous connections.
- RATE
- RATEBalance based on requests per second (RPS).
- UTILIZATION
- UTILIZATIONBalance based on the backend utilization.
- "CONNECTION"
- CONNECTIONBalance based on the number of simultaneous connections.
- "RATE"
- RATEBalance based on requests per second (RPS).
- "UTILIZATION"
- UTILIZATIONBalance based on the backend utilization.
BackendPreference, BackendPreferenceArgs
- Default
- DEFAULTNo preference.
- Preference
Unspecified - PREFERENCE_UNSPECIFIEDIf preference is unspecified, we set it to the DEFAULT value
- Preferred
- PREFERREDTraffic will be sent to this backend first.
- Backend
Preference Default - DEFAULTNo preference.
- Backend
Preference Preference Unspecified - PREFERENCE_UNSPECIFIEDIf preference is unspecified, we set it to the DEFAULT value
- Backend
Preference Preferred - PREFERREDTraffic will be sent to this backend first.
- Default
- DEFAULTNo preference.
- Preference
Unspecified - PREFERENCE_UNSPECIFIEDIf preference is unspecified, we set it to the DEFAULT value
- Preferred
- PREFERREDTraffic will be sent to this backend first.
- Default
- DEFAULTNo preference.
- Preference
Unspecified - PREFERENCE_UNSPECIFIEDIf preference is unspecified, we set it to the DEFAULT value
- Preferred
- PREFERREDTraffic will be sent to this backend first.
- DEFAULT
- DEFAULTNo preference.
- PREFERENCE_UNSPECIFIED
- PREFERENCE_UNSPECIFIEDIf preference is unspecified, we set it to the DEFAULT value
- PREFERRED
- PREFERREDTraffic will be sent to this backend first.
- "DEFAULT"
- DEFAULTNo preference.
- "PREFERENCE_UNSPECIFIED"
- PREFERENCE_UNSPECIFIEDIf preference is unspecified, we set it to the DEFAULT value
- "PREFERRED"
- PREFERREDTraffic will be sent to this backend first.
BackendResponse, BackendResponseArgs
- 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 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.
- 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 intPer Endpoint - 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 intPer Instance - 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 doublePer Endpoint - 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 doublePer Instance - 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 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
- 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 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.
- 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 intPer Endpoint - 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 intPer Instance - 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 float64Per Endpoint - 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 float64Per Instance - 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 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 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.
- max
Connections 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.
- max
Connections IntegerPer Endpoint - 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 IntegerPer Instance - 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 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.
- max
Rate DoublePer Endpoint - 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 DoublePer Instance - 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 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
- 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 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.
- 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 numberPer Endpoint - 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 numberPer Instance - 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 numberPer Endpoint - 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 numberPer Instance - 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
- 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_ intper_ endpoint - 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_ intper_ instance - 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_ floatper_ endpoint - 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_ floatper_ instance - 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
- 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 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.
- 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 NumberPer Endpoint - 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 NumberPer Instance - 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 NumberPer Endpoint - 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 NumberPer Instance - 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
BackendServiceCdnPolicy, BackendServiceCdnPolicyArgs
- Bypass
Cache List<Pulumi.On Request Headers Google Native. Compute. Alpha. Inputs. Backend Service Cdn Policy Bypass Cache On Request Header> - 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 Pulumi.Policy Google Native. Compute. Alpha. Inputs. Cache Key Policy - The CacheKeyPolicy for this CdnPolicy.
- Cache
Mode Pulumi.Google Native. Compute. Alpha. Backend Service Cdn Policy Cache Mode - 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 List<Pulumi.Policy Google Native. Compute. Alpha. Inputs. Backend Service Cdn Policy Negative Caching Policy> - 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 intStale - 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 stringCache Max Age Sec - 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
Cache []BackendOn Request Headers Service Cdn Policy Bypass Cache On Request Header - 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 CachePolicy Key Policy - The CacheKeyPolicy for this CdnPolicy.
- Cache
Mode BackendService Cdn Policy Cache Mode - 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 []BackendPolicy Service Cdn Policy Negative Caching Policy - 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 intStale - 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 stringCache Max Age Sec - 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
Cache List<BackendOn Request Headers Service Cdn Policy Bypass Cache On Request Header> - 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 CachePolicy Key Policy - The CacheKeyPolicy for this CdnPolicy.
- cache
Mode BackendService Cdn Policy Cache Mode - 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 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).
- default
Ttl 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.
- max
Ttl 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.
- negative
Caching 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.
- negative
Caching List<BackendPolicy Service Cdn Policy Negative Caching Policy> - 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 Boolean - If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve
While IntegerStale - 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 StringCache Max Age Sec - 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
Cache BackendOn Request Headers Service Cdn Policy Bypass Cache On Request Header[] - 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 CachePolicy Key Policy - The CacheKeyPolicy for this CdnPolicy.
- cache
Mode BackendService Cdn Policy Cache Mode - 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 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.
- negative
Caching BackendPolicy Service Cdn Policy Negative Caching Policy[] - 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 boolean - If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve
While numberStale - 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 stringCache Max Age Sec - 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_
cache_ Sequence[Backendon_ request_ headers Service Cdn Policy Bypass Cache On Request Header] - 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_ Cachepolicy Key Policy - The CacheKeyPolicy for this CdnPolicy.
- cache_
mode BackendService Cdn Policy Cache Mode - 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_ Sequence[Backendpolicy Service Cdn Policy Negative Caching Policy] - 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_ intstale - 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_ strcache_ max_ age_ sec - 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
Cache List<Property Map>On Request Headers - 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 Property MapPolicy - 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 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.
- negative
Caching List<Property Map>Policy - 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 Boolean - If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve
While NumberStale - 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 StringCache Max Age Sec - 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, BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs
- Header
Name string - The header field name to match on when bypassing cache. Values are case-insensitive.
- Header
Name string - The header field name to match on when bypassing cache. Values are case-insensitive.
- header
Name String - The header field name to match on when bypassing cache. Values are case-insensitive.
- header
Name string - The header field name to match on when bypassing cache. Values are case-insensitive.
- header_
name str - The header field name to match on when bypassing cache. Values are case-insensitive.
- header
Name String - The header field name to match on when bypassing cache. Values are case-insensitive.
BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponse, BackendServiceCdnPolicyBypassCacheOnRequestHeaderResponseArgs
- Header
Name string - The header field name to match on when bypassing cache. Values are case-insensitive.
- Header
Name string - The header field name to match on when bypassing cache. Values are case-insensitive.
- header
Name String - The header field name to match on when bypassing cache. Values are case-insensitive.
- header
Name string - The header field name to match on when bypassing cache. Values are case-insensitive.
- header_
name str - The header field name to match on when bypassing cache. Values are case-insensitive.
- header
Name String - The header field name to match on when bypassing cache. Values are case-insensitive.
BackendServiceCdnPolicyCacheMode, BackendServiceCdnPolicyCacheModeArgs
- Cache
All Static - CACHE_ALL_STATICAutomatically 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_ALLCache 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_HEADERSRequires 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.
- Backend
Service Cdn Policy Cache Mode Cache All Static - CACHE_ALL_STATICAutomatically 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.
- Backend
Service Cdn Policy Cache Mode Force Cache All - FORCE_CACHE_ALLCache 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.
- Backend
Service Cdn Policy Cache Mode Invalid Cache Mode - INVALID_CACHE_MODE
- Backend
Service Cdn Policy Cache Mode Use Origin Headers - USE_ORIGIN_HEADERSRequires 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.
- Cache
All Static - CACHE_ALL_STATICAutomatically 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_ALLCache 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_HEADERSRequires 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.
- Cache
All Static - CACHE_ALL_STATICAutomatically 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_ALLCache 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_HEADERSRequires 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.
- CACHE_ALL_STATIC
- CACHE_ALL_STATICAutomatically 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_ALLCache 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_HEADERSRequires 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.
- "CACHE_ALL_STATIC"
- CACHE_ALL_STATICAutomatically 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_ALLCache 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_HEADERSRequires 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
- 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 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, BackendServiceCdnPolicyNegativeCachingPolicyResponseArgs
- 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 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, BackendServiceCdnPolicyResponseArgs
- Bypass
Cache List<Pulumi.On Request Headers Google Native. Compute. Alpha. Inputs. Backend Service Cdn Policy Bypass Cache On Request Header Response> - 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 Pulumi.Policy Google Native. Compute. Alpha. Inputs. Cache Key Policy Response - 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 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 List<Pulumi.Policy Google Native. Compute. Alpha. Inputs. Backend Service Cdn Policy Negative Caching Policy Response> - 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 intStale - 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 stringCache Max Age Sec - 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 List<string>Key Names - Names of the keys for signing request URLs.
- Bypass
Cache []BackendOn Request Headers Service Cdn Policy Bypass Cache On Request Header Response - 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 CachePolicy Key Policy Response - 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 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 []BackendPolicy Service Cdn Policy Negative Caching Policy Response - 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 intStale - 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 stringCache Max Age Sec - 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 []stringKey Names - Names of the keys for signing request URLs.
- bypass
Cache List<BackendOn Request Headers Service Cdn Policy Bypass Cache On Request Header Response> - 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 CachePolicy Key Policy Response - 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 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).
- default
Ttl 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.
- max
Ttl 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.
- negative
Caching 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.
- negative
Caching List<BackendPolicy Service Cdn Policy Negative Caching Policy Response> - 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 Boolean - If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve
While IntegerStale - 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 StringCache Max Age Sec - 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 List<String>Key Names - Names of the keys for signing request URLs.
- bypass
Cache BackendOn Request Headers Service Cdn Policy Bypass Cache On Request Header Response[] - 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 CachePolicy Key Policy Response - 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 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.
- negative
Caching BackendPolicy Service Cdn Policy Negative Caching Policy Response[] - 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 boolean - If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve
While numberStale - 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 stringCache Max Age Sec - 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 string[]Key Names - Names of the keys for signing request URLs.
- bypass_
cache_ Sequence[Backendon_ request_ headers Service Cdn Policy Bypass Cache On Request Header Response] - 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_ Cachepolicy Key Policy Response - 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_ Sequence[Backendpolicy Service Cdn Policy Negative Caching Policy Response] - 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_ intstale - 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_ strcache_ max_ age_ sec - 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_ Sequence[str]key_ names - Names of the keys for signing request URLs.
- bypass
Cache List<Property Map>On Request Headers - 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 Property MapPolicy - 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 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.
- negative
Caching List<Property Map>Policy - 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 Boolean - If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- serve
While NumberStale - 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 StringCache Max Age Sec - 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 List<String>Key Names - Names of the keys for signing request URLs.
BackendServiceCompressionMode, BackendServiceCompressionModeArgs
- Automatic
- AUTOMATICAutomatically uses the best compression based on the Accept-Encoding header sent by the client.
- Disabled
- DISABLEDDisables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
- Backend
Service Compression Mode Automatic - AUTOMATICAutomatically uses the best compression based on the Accept-Encoding header sent by the client.
- Backend
Service Compression Mode Disabled - DISABLEDDisables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
- Automatic
- AUTOMATICAutomatically uses the best compression based on the Accept-Encoding header sent by the client.
- Disabled
- DISABLEDDisables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
- Automatic
- AUTOMATICAutomatically uses the best compression based on the Accept-Encoding header sent by the client.
- Disabled
- DISABLEDDisables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
- AUTOMATIC
- AUTOMATICAutomatically uses the best compression based on the Accept-Encoding header sent by the client.
- DISABLED
- DISABLEDDisables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
- "AUTOMATIC"
- AUTOMATICAutomatically uses the best compression based on the Accept-Encoding header sent by the client.
- "DISABLED"
- DISABLEDDisables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.
BackendServiceConnectionTrackingPolicy, BackendServiceConnectionTrackingPolicyArgs
- Connection
Persistence Pulumi.On Unhealthy Backends Google Native. Compute. Alpha. Backend Service Connection Tracking Policy Connection Persistence On Unhealthy Backends - 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 boolAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- Idle
Timeout intSec - 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 Pulumi.Google Native. Compute. Alpha. Backend Service Connection Tracking Policy Tracking Mode - 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 BackendOn Unhealthy Backends Service Connection Tracking Policy Connection Persistence On Unhealthy Backends - 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 boolAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- Idle
Timeout intSec - 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 BackendService Connection Tracking Policy Tracking Mode - 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 BackendOn Unhealthy Backends Service Connection Tracking Policy Connection Persistence On Unhealthy Backends - 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 BooleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout IntegerSec - 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 BackendService Connection Tracking Policy Tracking Mode - 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 BackendOn Unhealthy Backends Service Connection Tracking Policy Connection Persistence On Unhealthy Backends - 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 booleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout numberSec - 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 BackendService Connection Tracking Policy Tracking Mode - 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_ Backendon_ unhealthy_ backends Service Connection Tracking Policy Connection Persistence On Unhealthy Backends - 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_ boolaffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_
timeout_ intsec - 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 BackendService Connection Tracking Policy Tracking Mode - 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 "ALWAYS_PERSIST" | "DEFAULT_FOR_PROTOCOL" | "NEVER_PERSIST"On Unhealthy Backends - 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 BooleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout NumberSec - 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.
BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackends, BackendServiceConnectionTrackingPolicyConnectionPersistenceOnUnhealthyBackendsArgs
- Always
Persist - ALWAYS_PERSIST
- Default
For Protocol - DEFAULT_FOR_PROTOCOL
- Never
Persist - NEVER_PERSIST
- Backend
Service Connection Tracking Policy Connection Persistence On Unhealthy Backends Always Persist - ALWAYS_PERSIST
- Backend
Service Connection Tracking Policy Connection Persistence On Unhealthy Backends Default For Protocol - DEFAULT_FOR_PROTOCOL
- Backend
Service Connection Tracking Policy Connection Persistence On Unhealthy Backends Never Persist - NEVER_PERSIST
- Always
Persist - ALWAYS_PERSIST
- Default
For Protocol - DEFAULT_FOR_PROTOCOL
- Never
Persist - NEVER_PERSIST
- Always
Persist - ALWAYS_PERSIST
- Default
For Protocol - DEFAULT_FOR_PROTOCOL
- Never
Persist - NEVER_PERSIST
- ALWAYS_PERSIST
- ALWAYS_PERSIST
- DEFAULT_FOR_PROTOCOL
- DEFAULT_FOR_PROTOCOL
- NEVER_PERSIST
- NEVER_PERSIST
- "ALWAYS_PERSIST"
- ALWAYS_PERSIST
- "DEFAULT_FOR_PROTOCOL"
- DEFAULT_FOR_PROTOCOL
- "NEVER_PERSIST"
- NEVER_PERSIST
BackendServiceConnectionTrackingPolicyResponse, BackendServiceConnectionTrackingPolicyResponseArgs
- Connection
Persistence stringOn Unhealthy Backends - 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 boolAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- Idle
Timeout intSec - 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.
- Connection
Persistence stringOn Unhealthy Backends - 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 boolAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- Idle
Timeout intSec - 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.
- connection
Persistence StringOn Unhealthy Backends - 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 BooleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout IntegerSec - 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.
- connection
Persistence stringOn Unhealthy Backends - 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 booleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout numberSec - 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.
- connection_
persistence_ stron_ unhealthy_ backends - 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_ boolaffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_
timeout_ intsec - 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.
- connection
Persistence StringOn Unhealthy Backends - 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 BooleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout NumberSec - 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.
BackendServiceConnectionTrackingPolicyTrackingMode, BackendServiceConnectionTrackingPolicyTrackingModeArgs
- Invalid
Tracking Mode - INVALID_TRACKING_MODE
- Per
Connection - PER_CONNECTION
- Per
Session - PER_SESSION
- Backend
Service Connection Tracking Policy Tracking Mode Invalid Tracking Mode - INVALID_TRACKING_MODE
- Backend
Service Connection Tracking Policy Tracking Mode Per Connection - PER_CONNECTION
- Backend
Service Connection Tracking Policy Tracking Mode Per Session - PER_SESSION
- Invalid
Tracking Mode - INVALID_TRACKING_MODE
- Per
Connection - PER_CONNECTION
- Per
Session - PER_SESSION
- Invalid
Tracking Mode - INVALID_TRACKING_MODE
- Per
Connection - PER_CONNECTION
- Per
Session - PER_SESSION
- INVALID_TRACKING_MODE
- INVALID_TRACKING_MODE
- PER_CONNECTION
- PER_CONNECTION
- PER_SESSION
- PER_SESSION
- "INVALID_TRACKING_MODE"
- INVALID_TRACKING_MODE
- "PER_CONNECTION"
- PER_CONNECTION
- "PER_SESSION"
- PER_SESSION
BackendServiceFailoverPolicy, BackendServiceFailoverPolicyArgs
- Disable
Connection boolDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- Drop
Traffic boolIf Unhealthy - 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.
- Failover
Ratio 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.
- Disable
Connection boolDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- Drop
Traffic boolIf Unhealthy - 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.
- Failover
Ratio 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.
- disable
Connection BooleanDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- drop
Traffic BooleanIf Unhealthy - 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.
- failover
Ratio 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.
- disable
Connection booleanDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- drop
Traffic booleanIf Unhealthy - 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.
- failover
Ratio 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.
- disable_
connection_ booldrain_ on_ failover - This can be set to true only if the protocol is TCP. The default is false.
- drop_
traffic_ boolif_ unhealthy - 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.
- failover_
ratio float - 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.
- disable
Connection BooleanDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- drop
Traffic BooleanIf Unhealthy - 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.
- failover
Ratio 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, BackendServiceFailoverPolicyResponseArgs
- Disable
Connection boolDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- Drop
Traffic boolIf Unhealthy - 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.
- Failover
Ratio 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.
- Disable
Connection boolDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- Drop
Traffic boolIf Unhealthy - 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.
- Failover
Ratio 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.
- disable
Connection BooleanDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- drop
Traffic BooleanIf Unhealthy - 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.
- failover
Ratio 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.
- disable
Connection booleanDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- drop
Traffic booleanIf Unhealthy - 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.
- failover
Ratio 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.
- disable_
connection_ booldrain_ on_ failover - This can be set to true only if the protocol is TCP. The default is false.
- drop_
traffic_ boolif_ unhealthy - 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.
- failover_
ratio float - 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.
- disable
Connection BooleanDrain On Failover - This can be set to true only if the protocol is TCP. The default is false.
- drop
Traffic BooleanIf Unhealthy - 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.
- failover
Ratio 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
- Enabled bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2Client
Id string - OAuth2 client ID to use for the authentication flow.
- Oauth2Client
Info Pulumi.Google Native. Compute. Alpha. Inputs. Backend Service IAPOAuth2Client Info - [Input Only] OAuth client info required to generate client id to be used for IAP.
- Oauth2Client
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 bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2Client
Id string - OAuth2 client ID to use for the authentication flow.
- Oauth2Client
Info BackendService IAPOAuth2Client Info - [Input Only] OAuth client info required to generate client id to be used for IAP.
- Oauth2Client
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.
- oauth2Client
Id String - OAuth2 client ID to use for the authentication flow.
- oauth2Client
Info BackendService IAPOAuth2Client Info - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2Client
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.
- oauth2Client
Id string - OAuth2 client ID to use for the authentication flow.
- oauth2Client
Info BackendService IAPOAuth2Client Info - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2Client
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 bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2_
client_ strid - OAuth2 client ID to use for the authentication flow.
- oauth2_
client_ Backendinfo Service IAPOAuth2Client Info - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2_
client_ strsecret - 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.
- oauth2Client
Id String - OAuth2 client ID to use for the authentication flow.
- oauth2Client
Info Property Map - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2Client
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
BackendServiceIAPOAuth2ClientInfo, BackendServiceIAPOAuth2ClientInfoArgs
- Application
Name string - Application name to be used in OAuth consent screen.
- Client
Name string - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- Developer
Email stringAddress - Developer's information to be used in OAuth consent screen.
- Application
Name string - Application name to be used in OAuth consent screen.
- Client
Name string - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- Developer
Email stringAddress - Developer's information to be used in OAuth consent screen.
- application
Name String - Application name to be used in OAuth consent screen.
- client
Name String - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer
Email StringAddress - Developer's information to be used in OAuth consent screen.
- application
Name string - Application name to be used in OAuth consent screen.
- client
Name string - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer
Email stringAddress - Developer's information to be used in OAuth consent screen.
- application_
name str - Application name to be used in OAuth consent screen.
- client_
name str - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer_
email_ straddress - Developer's information to be used in OAuth consent screen.
- application
Name String - Application name to be used in OAuth consent screen.
- client
Name String - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer
Email StringAddress - Developer's information to be used in OAuth consent screen.
BackendServiceIAPOAuth2ClientInfoResponse, BackendServiceIAPOAuth2ClientInfoResponseArgs
- Application
Name string - Application name to be used in OAuth consent screen.
- Client
Name string - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- Developer
Email stringAddress - Developer's information to be used in OAuth consent screen.
- Application
Name string - Application name to be used in OAuth consent screen.
- Client
Name string - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- Developer
Email stringAddress - Developer's information to be used in OAuth consent screen.
- application
Name String - Application name to be used in OAuth consent screen.
- client
Name String - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer
Email StringAddress - Developer's information to be used in OAuth consent screen.
- application
Name string - Application name to be used in OAuth consent screen.
- client
Name string - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer
Email stringAddress - Developer's information to be used in OAuth consent screen.
- application_
name str - Application name to be used in OAuth consent screen.
- client_
name str - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer_
email_ straddress - Developer's information to be used in OAuth consent screen.
- application
Name String - Application name to be used in OAuth consent screen.
- client
Name String - Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
- developer
Email StringAddress - Developer's information to be used in OAuth consent screen.
BackendServiceIAPResponse, BackendServiceIAPResponseArgs
- Enabled bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2Client
Id string - OAuth2 client ID to use for the authentication flow.
- Oauth2Client
Info Pulumi.Google Native. Compute. Alpha. Inputs. Backend Service IAPOAuth2Client Info Response - [Input Only] OAuth client info required to generate client id to be used for IAP.
- Oauth2Client
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
- Oauth2Client
Secret stringSha256 - SHA256 hash value for the field oauth2_client_secret above.
- Enabled bool
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2Client
Id string - OAuth2 client ID to use for the authentication flow.
- Oauth2Client
Info BackendService IAPOAuth2Client Info Response - [Input Only] OAuth client info required to generate client id to be used for IAP.
- Oauth2Client
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
- Oauth2Client
Secret stringSha256 - SHA256 hash value for the field oauth2_client_secret above.
- enabled Boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2Client
Id String - OAuth2 client ID to use for the authentication flow.
- oauth2Client
Info BackendService IAPOAuth2Client Info Response - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2Client
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
- oauth2Client
Secret StringSha256 - SHA256 hash value for the field oauth2_client_secret above.
- enabled boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2Client
Id string - OAuth2 client ID to use for the authentication flow.
- oauth2Client
Info BackendService IAPOAuth2Client Info Response - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2Client
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
- oauth2Client
Secret stringSha256 - 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_ strid - OAuth2 client ID to use for the authentication flow.
- oauth2_
client_ Backendinfo Service IAPOAuth2Client Info Response - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2_
client_ strsecret - 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_ strsecret_ sha256 - SHA256 hash value for the field oauth2_client_secret above.
- enabled Boolean
- Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2Client
Id String - OAuth2 client ID to use for the authentication flow.
- oauth2Client
Info Property Map - [Input Only] OAuth client info required to generate client id to be used for IAP.
- oauth2Client
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
- oauth2Client
Secret StringSha256 - SHA256 hash value for the field oauth2_client_secret above.
BackendServiceIpAddressSelectionPolicy, BackendServiceIpAddressSelectionPolicyArgs
- Ipv4Only
- IPV4_ONLYOnly 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_ONLYOnly 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_UNSPECIFIEDUnspecified IP address selection policy.
- Prefer
Ipv6 - PREFER_IPV6Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).
- Backend
Service Ip Address Selection Policy Ipv4Only - IPV4_ONLYOnly 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.
- Backend
Service Ip Address Selection Policy Ipv6Only - IPV6_ONLYOnly 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.
- Backend
Service Ip Address Selection Policy Ip Address Selection Policy Unspecified - IP_ADDRESS_SELECTION_POLICY_UNSPECIFIEDUnspecified IP address selection policy.
- Backend
Service Ip Address Selection Policy Prefer Ipv6 - PREFER_IPV6Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).
- Ipv4Only
- IPV4_ONLYOnly 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_ONLYOnly 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_UNSPECIFIEDUnspecified IP address selection policy.
- Prefer
Ipv6 - PREFER_IPV6Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).
- Ipv4Only
- IPV4_ONLYOnly 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_ONLYOnly 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_UNSPECIFIEDUnspecified IP address selection policy.
- Prefer
Ipv6 - PREFER_IPV6Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).
- IPV4_ONLY
- IPV4_ONLYOnly 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_ONLYOnly 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_UNSPECIFIEDUnspecified IP address selection policy.
- PREFER_IPV6
- PREFER_IPV6Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).
- "IPV4_ONLY"
- IPV4_ONLYOnly 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_ONLYOnly 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_UNSPECIFIEDUnspecified IP address selection policy.
- "PREFER_IPV6"
- PREFER_IPV6Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).
BackendServiceLoadBalancingScheme, BackendServiceLoadBalancingSchemeArgs
- External
- EXTERNALSignifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
- External
Managed - EXTERNAL_MANAGEDSignifies that this will be used for External Managed HTTP(S) Load Balancing.
- Internal
- INTERNALSignifies that this will be used for Internal TCP/UDP Load Balancing.
- Internal
Managed - INTERNAL_MANAGEDSignifies that this will be used for Internal HTTP(S) Load Balancing.
- Internal
Self Managed - INTERNAL_SELF_MANAGEDSignifies that this will be used by Traffic Director.
- Invalid
Load Balancing Scheme - INVALID_LOAD_BALANCING_SCHEME
- Backend
Service Load Balancing Scheme External - EXTERNALSignifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
- Backend
Service Load Balancing Scheme External Managed - EXTERNAL_MANAGEDSignifies that this will be used for External Managed HTTP(S) Load Balancing.
- Backend
Service Load Balancing Scheme Internal - INTERNALSignifies that this will be used for Internal TCP/UDP Load Balancing.
- Backend
Service Load Balancing Scheme Internal Managed - INTERNAL_MANAGEDSignifies that this will be used for Internal HTTP(S) Load Balancing.
- Backend
Service Load Balancing Scheme Internal Self Managed - INTERNAL_SELF_MANAGEDSignifies that this will be used by Traffic Director.
- Backend
Service Load Balancing Scheme Invalid Load Balancing Scheme - INVALID_LOAD_BALANCING_SCHEME
- External
- EXTERNALSignifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
- External
Managed - EXTERNAL_MANAGEDSignifies that this will be used for External Managed HTTP(S) Load Balancing.
- Internal
- INTERNALSignifies that this will be used for Internal TCP/UDP Load Balancing.
- Internal
Managed - INTERNAL_MANAGEDSignifies that this will be used for Internal HTTP(S) Load Balancing.
- Internal
Self Managed - INTERNAL_SELF_MANAGEDSignifies that this will be used by Traffic Director.
- Invalid
Load Balancing Scheme - INVALID_LOAD_BALANCING_SCHEME
- External
- EXTERNALSignifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
- External
Managed - EXTERNAL_MANAGEDSignifies that this will be used for External Managed HTTP(S) Load Balancing.
- Internal
- INTERNALSignifies that this will be used for Internal TCP/UDP Load Balancing.
- Internal
Managed - INTERNAL_MANAGEDSignifies that this will be used for Internal HTTP(S) Load Balancing.
- Internal
Self Managed - INTERNAL_SELF_MANAGEDSignifies that this will be used by Traffic Director.
- Invalid
Load Balancing Scheme - INVALID_LOAD_BALANCING_SCHEME
- EXTERNAL
- EXTERNALSignifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
- EXTERNAL_MANAGED
- EXTERNAL_MANAGEDSignifies that this will be used for External Managed HTTP(S) Load Balancing.
- INTERNAL
- INTERNALSignifies that this will be used for Internal TCP/UDP Load Balancing.
- INTERNAL_MANAGED
- INTERNAL_MANAGEDSignifies that this will be used for Internal HTTP(S) Load Balancing.
- INTERNAL_SELF_MANAGED
- INTERNAL_SELF_MANAGEDSignifies that this will be used by Traffic Director.
- INVALID_LOAD_BALANCING_SCHEME
- INVALID_LOAD_BALANCING_SCHEME
- "EXTERNAL"
- EXTERNALSignifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing
- "EXTERNAL_MANAGED"
- EXTERNAL_MANAGEDSignifies that this will be used for External Managed HTTP(S) Load Balancing.
- "INTERNAL"
- INTERNALSignifies that this will be used for Internal TCP/UDP Load Balancing.
- "INTERNAL_MANAGED"
- INTERNAL_MANAGEDSignifies that this will be used for Internal HTTP(S) Load Balancing.
- "INTERNAL_SELF_MANAGED"
- INTERNAL_SELF_MANAGEDSignifies that this will be used by Traffic Director.
- "INVALID_LOAD_BALANCING_SCHEME"
- INVALID_LOAD_BALANCING_SCHEME
BackendServiceLocalityLbPolicy, BackendServiceLocalityLbPolicyArgs
- Invalid
Lb Policy - INVALID_LB_POLICY
- Least
Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Maglev
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- Ring
Hash - RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Weighted
Maglev - WEIGHTED_MAGLEVPer-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.
- Backend
Service Locality Lb Policy Invalid Lb Policy - INVALID_LB_POLICY
- Backend
Service Locality Lb Policy Least Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Backend
Service Locality Lb Policy Maglev - MAGLEVThis 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
- Backend
Service Locality Lb Policy Original Destination - ORIGINAL_DESTINATIONBackend 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.
- Backend
Service Locality Lb Policy Random - RANDOMThe load balancer selects a random healthy host.
- Backend
Service Locality Lb Policy Ring Hash - RING_HASHThe 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.
- Backend
Service Locality Lb Policy Round Robin - ROUND_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Backend
Service Locality Lb Policy Weighted Maglev - WEIGHTED_MAGLEVPer-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.
- Invalid
Lb Policy - INVALID_LB_POLICY
- Least
Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Maglev
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- Ring
Hash - RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Weighted
Maglev - WEIGHTED_MAGLEVPer-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.
- Invalid
Lb Policy - INVALID_LB_POLICY
- Least
Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Maglev
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- Ring
Hash - RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Weighted
Maglev - WEIGHTED_MAGLEVPer-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.
- INVALID_LB_POLICY
- INVALID_LB_POLICY
- LEAST_REQUEST
- LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- MAGLEV
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- RING_HASH
- RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- WEIGHTED_MAGLEV
- WEIGHTED_MAGLEVPer-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.
- "INVALID_LB_POLICY"
- INVALID_LB_POLICY
- "LEAST_REQUEST"
- LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- "MAGLEV"
- MAGLEVThis 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_DESTINATIONBackend 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"
- RANDOMThe load balancer selects a random healthy host.
- "RING_HASH"
- RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- "WEIGHTED_MAGLEV"
- WEIGHTED_MAGLEVPer-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
BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy, BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyArgs
- 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, BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicyResponseArgs
- 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
- Name
Pulumi.
Google Native. Compute. Alpha. Backend Service Locality Load Balancing Policy Config Policy Name - 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
Backend
Service Locality Load Balancing Policy Config Policy Name - 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
Backend
Service Locality Load Balancing Policy Config Policy Name - 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
Backend
Service Locality Load Balancing Policy Config Policy Name - 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
Backend
Service Locality Load Balancing Policy Config Policy Name - 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 "INVALID_LB_POLICY" | "LEAST_REQUEST" | "MAGLEV" | "ORIGINAL_DESTINATION" | "RANDOM" | "RING_HASH" | "ROUND_ROBIN" | "WEIGHTED_MAGLEV"
- 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, BackendServiceLocalityLoadBalancingPolicyConfigPolicyNameArgs
- Invalid
Lb Policy - INVALID_LB_POLICY
- Least
Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Maglev
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- Ring
Hash - RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Weighted
Maglev - WEIGHTED_MAGLEVPer-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.
- Backend
Service Locality Load Balancing Policy Config Policy Name Invalid Lb Policy - INVALID_LB_POLICY
- Backend
Service Locality Load Balancing Policy Config Policy Name Least Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Backend
Service Locality Load Balancing Policy Config Policy Name Maglev - MAGLEVThis 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
- Backend
Service Locality Load Balancing Policy Config Policy Name Original Destination - ORIGINAL_DESTINATIONBackend 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.
- Backend
Service Locality Load Balancing Policy Config Policy Name Random - RANDOMThe load balancer selects a random healthy host.
- Backend
Service Locality Load Balancing Policy Config Policy Name Ring Hash - RING_HASHThe 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.
- Backend
Service Locality Load Balancing Policy Config Policy Name Round Robin - ROUND_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Backend
Service Locality Load Balancing Policy Config Policy Name Weighted Maglev - WEIGHTED_MAGLEVPer-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.
- Invalid
Lb Policy - INVALID_LB_POLICY
- Least
Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Maglev
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- Ring
Hash - RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Weighted
Maglev - WEIGHTED_MAGLEVPer-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.
- Invalid
Lb Policy - INVALID_LB_POLICY
- Least
Request - LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- Maglev
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- Ring
Hash - RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- Weighted
Maglev - WEIGHTED_MAGLEVPer-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.
- INVALID_LB_POLICY
- INVALID_LB_POLICY
- LEAST_REQUEST
- LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- MAGLEV
- MAGLEVThis 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_DESTINATIONBackend 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
- RANDOMThe load balancer selects a random healthy host.
- RING_HASH
- RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- WEIGHTED_MAGLEV
- WEIGHTED_MAGLEVPer-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.
- "INVALID_LB_POLICY"
- INVALID_LB_POLICY
- "LEAST_REQUEST"
- LEAST_REQUESTAn O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
- "MAGLEV"
- MAGLEVThis 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_DESTINATIONBackend 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"
- RANDOMThe load balancer selects a random healthy host.
- "RING_HASH"
- RING_HASHThe 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_ROBINThis is a simple policy in which each healthy backend is selected in round robin order. This is the default.
- "WEIGHTED_MAGLEV"
- WEIGHTED_MAGLEVPer-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, BackendServiceLocalityLoadBalancingPolicyConfigPolicyResponseArgs
- 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, BackendServiceLocalityLoadBalancingPolicyConfigResponseArgs
BackendServiceLogConfig, BackendServiceLogConfigArgs
- Enable bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- Optional
Pulumi.
Google Native. Compute. Alpha. Backend Service Log Config Optional - Deprecated in favor of optionalMode. 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.
- 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 Pulumi.Google Native. Compute. Alpha. Backend Service Log Config Optional Mode - 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 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.
- Optional
Backend
Service Log Config Optional - Deprecated in favor of optionalMode. 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.
- Optional
Fields []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 BackendService Log Config Optional Mode - 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 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 Boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional
Backend
Service Log Config Optional - Deprecated in favor of optionalMode. 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.
- 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 BackendService Log Config Optional Mode - 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 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.
- optional
Backend
Service Log Config Optional - Deprecated in favor of optionalMode. 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.
- optional
Fields 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 BackendService Log Config Optional Mode - 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 bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional
Backend
Service Log Config Optional - Deprecated in favor of optionalMode. 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.
- 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 BackendService Log Config Optional Mode - 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.
- optional "CUSTOM" | "EXCLUDE_ALL_OPTIONAL" | "INCLUDE_ALL_OPTIONAL" | "UNSPECIFIED_OPTIONAL_MODE"
- Deprecated in favor of optionalMode. 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.
- 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" | "UNSPECIFIED_OPTIONAL_MODE" - 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.
BackendServiceLogConfigOptional, BackendServiceLogConfigOptionalArgs
- Custom
- CUSTOMA subset of optional fields.
- Exclude
All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Include
All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Unspecified
Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- Backend
Service Log Config Optional Custom - CUSTOMA subset of optional fields.
- Backend
Service Log Config Optional Exclude All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Backend
Service Log Config Optional Include All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Backend
Service Log Config Optional Unspecified Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- Custom
- CUSTOMA subset of optional fields.
- Exclude
All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Include
All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Unspecified
Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- Custom
- CUSTOMA subset of optional fields.
- Exclude
All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Include
All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Unspecified
Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- CUSTOM
- CUSTOMA subset of optional fields.
- EXCLUDE_ALL_OPTIONAL
- EXCLUDE_ALL_OPTIONALNone optional fields.
- INCLUDE_ALL_OPTIONAL
- INCLUDE_ALL_OPTIONALAll optional fields.
- UNSPECIFIED_OPTIONAL_MODE
- UNSPECIFIED_OPTIONAL_MODE
- "CUSTOM"
- CUSTOMA subset of optional fields.
- "EXCLUDE_ALL_OPTIONAL"
- EXCLUDE_ALL_OPTIONALNone optional fields.
- "INCLUDE_ALL_OPTIONAL"
- INCLUDE_ALL_OPTIONALAll optional fields.
- "UNSPECIFIED_OPTIONAL_MODE"
- UNSPECIFIED_OPTIONAL_MODE
BackendServiceLogConfigOptionalMode, BackendServiceLogConfigOptionalModeArgs
- Custom
- CUSTOMA subset of optional fields.
- Exclude
All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Include
All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Unspecified
Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- Backend
Service Log Config Optional Mode Custom - CUSTOMA subset of optional fields.
- Backend
Service Log Config Optional Mode Exclude All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Backend
Service Log Config Optional Mode Include All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Backend
Service Log Config Optional Mode Unspecified Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- Custom
- CUSTOMA subset of optional fields.
- Exclude
All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Include
All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Unspecified
Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- Custom
- CUSTOMA subset of optional fields.
- Exclude
All Optional - EXCLUDE_ALL_OPTIONALNone optional fields.
- Include
All Optional - INCLUDE_ALL_OPTIONALAll optional fields.
- Unspecified
Optional Mode - UNSPECIFIED_OPTIONAL_MODE
- CUSTOM
- CUSTOMA subset of optional fields.
- EXCLUDE_ALL_OPTIONAL
- EXCLUDE_ALL_OPTIONALNone optional fields.
- INCLUDE_ALL_OPTIONAL
- INCLUDE_ALL_OPTIONALAll optional fields.
- UNSPECIFIED_OPTIONAL_MODE
- UNSPECIFIED_OPTIONAL_MODE
- "CUSTOM"
- CUSTOMA subset of optional fields.
- "EXCLUDE_ALL_OPTIONAL"
- EXCLUDE_ALL_OPTIONALNone optional fields.
- "INCLUDE_ALL_OPTIONAL"
- INCLUDE_ALL_OPTIONALAll optional fields.
- "UNSPECIFIED_OPTIONAL_MODE"
- UNSPECIFIED_OPTIONAL_MODE
BackendServiceLogConfigResponse, BackendServiceLogConfigResponseArgs
- Enable bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- Optional string
- Deprecated in favor of optionalMode. 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.
- 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 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.
- Optional string
- Deprecated in favor of optionalMode. 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.
- Optional
Fields []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 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 Boolean
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional String
- Deprecated in favor of optionalMode. 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.
- 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 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.
- optional string
- Deprecated in favor of optionalMode. 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.
- optional
Fields 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 bool
- Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
- optional str
- Deprecated in favor of optionalMode. 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.
- 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.
- optional String
- Deprecated in favor of optionalMode. 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.
- 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.
BackendServiceProtocol, BackendServiceProtocolArgs
- All
- ALLALL includes TCP, UDP, ICMP, ESP, AH and SCTP. Note that this should never be used together with target_xx_proxies.
- Grpc
- GRPCgRPC (available for Traffic Director).
- Http
- HTTP
- Http2
- HTTP2HTTP/2 with SSL.
- Https
- HTTPS
- Ssl
- SSLTCP proxying with SSL.
- Tcp
- TCPTCP proxying or TCP pass-through.
- Udp
- UDPUDP.
- Unspecified
- UNSPECIFIEDIf a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
- Backend
Service Protocol All - ALLALL includes TCP, UDP, ICMP, ESP, AH and SCTP. Note that this should never be used together with target_xx_proxies.
- Backend
Service Protocol Grpc - GRPCgRPC (available for Traffic Director).
- Backend
Service Protocol Http - HTTP
- Backend
Service Protocol Http2 - HTTP2HTTP/2 with SSL.
- Backend
Service Protocol Https - HTTPS
- Backend
Service Protocol Ssl - SSLTCP proxying with SSL.
- Backend
Service Protocol Tcp - TCPTCP proxying or TCP pass-through.
- Backend
Service Protocol Udp - UDPUDP.
- Backend
Service Protocol Unspecified - UNSPECIFIEDIf a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
- All
- ALLALL includes TCP, UDP, ICMP, ESP, AH and SCTP. Note that this should never be used together with target_xx_proxies.
- Grpc
- GRPCgRPC (available for Traffic Director).
- Http
- HTTP
- Http2
- HTTP2HTTP/2 with SSL.
- Https
- HTTPS
- Ssl
- SSLTCP proxying with SSL.
- Tcp
- TCPTCP proxying or TCP pass-through.
- Udp
- UDPUDP.
- Unspecified
- UNSPECIFIEDIf a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
- All
- ALLALL includes TCP, UDP, ICMP, ESP, AH and SCTP. Note that this should never be used together with target_xx_proxies.
- Grpc
- GRPCgRPC (available for Traffic Director).
- Http
- HTTP
- Http2
- HTTP2HTTP/2 with SSL.
- Https
- HTTPS
- Ssl
- SSLTCP proxying with SSL.
- Tcp
- TCPTCP proxying or TCP pass-through.
- Udp
- UDPUDP.
- Unspecified
- UNSPECIFIEDIf a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
- ALL
- ALLALL includes TCP, UDP, ICMP, ESP, AH and SCTP. Note that this should never be used together with target_xx_proxies.
- GRPC
- GRPCgRPC (available for Traffic Director).
- HTTP
- HTTP
- HTTP2
- HTTP2HTTP/2 with SSL.
- HTTPS
- HTTPS
- SSL
- SSLTCP proxying with SSL.
- TCP
- TCPTCP proxying or TCP pass-through.
- UDP
- UDPUDP.
- UNSPECIFIED
- UNSPECIFIEDIf a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
- "ALL"
- ALLALL includes TCP, UDP, ICMP, ESP, AH and SCTP. Note that this should never be used together with target_xx_proxies.
- "GRPC"
- GRPCgRPC (available for Traffic Director).
- "HTTP"
- HTTP
- "HTTP2"
- HTTP2HTTP/2 with SSL.
- "HTTPS"
- HTTPS
- "SSL"
- SSLTCP proxying with SSL.
- "TCP"
- TCPTCP proxying or TCP pass-through.
- "UDP"
- UDPUDP.
- "UNSPECIFIED"
- UNSPECIFIEDIf a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.
BackendServiceSessionAffinity, BackendServiceSessionAffinityArgs
- Client
Ip - CLIENT_IP2-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_DESTINATION1-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_PROTO5-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_PROTO3-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_COOKIEHash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
- Header
Field - HEADER_FIELDThe hash is based on a user specified header field.
- Http
Cookie - HTTP_COOKIEThe hash is based on a user provided cookie.
- None
- NONENo session affinity. Connections from the same client IP may go to any instance in the pool.
- Backend
Service Session Affinity Client Ip - CLIENT_IP2-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.
- Backend
Service Session Affinity Client Ip No Destination - CLIENT_IP_NO_DESTINATION1-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.
- Backend
Service Session Affinity Client Ip Port Proto - CLIENT_IP_PORT_PROTO5-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.
- Backend
Service Session Affinity Client Ip Proto - CLIENT_IP_PROTO3-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.
- Backend
Service Session Affinity Generated Cookie - GENERATED_COOKIEHash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
- Backend
Service Session Affinity Header Field - HEADER_FIELDThe hash is based on a user specified header field.
- Backend
Service Session Affinity Http Cookie - HTTP_COOKIEThe hash is based on a user provided cookie.
- Backend
Service Session Affinity None - NONENo session affinity. Connections from the same client IP may go to any instance in the pool.
- Client
Ip - CLIENT_IP2-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_DESTINATION1-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_PROTO5-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_PROTO3-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_COOKIEHash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
- Header
Field - HEADER_FIELDThe hash is based on a user specified header field.
- Http
Cookie - HTTP_COOKIEThe hash is based on a user provided cookie.
- None
- NONENo session affinity. Connections from the same client IP may go to any instance in the pool.
- Client
Ip - CLIENT_IP2-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_DESTINATION1-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_PROTO5-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_PROTO3-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_COOKIEHash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
- Header
Field - HEADER_FIELDThe hash is based on a user specified header field.
- Http
Cookie - HTTP_COOKIEThe hash is based on a user provided cookie.
- None
- NONENo session affinity. Connections from the same client IP may go to any instance in the pool.
- CLIENT_IP
- CLIENT_IP2-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_DESTINATION1-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_PROTO5-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_PROTO3-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_COOKIEHash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
- HEADER_FIELD
- HEADER_FIELDThe hash is based on a user specified header field.
- HTTP_COOKIE
- HTTP_COOKIEThe hash is based on a user provided cookie.
- NONE
- NONENo session affinity. Connections from the same client IP may go to any instance in the pool.
- "CLIENT_IP"
- CLIENT_IP2-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_DESTINATION1-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_PROTO5-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_PROTO3-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_COOKIEHash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
- "HEADER_FIELD"
- HEADER_FIELDThe hash is based on a user specified header field.
- "HTTP_COOKIE"
- HTTP_COOKIEThe hash is based on a user provided cookie.
- "NONE"
- NONENo session affinity. Connections from the same client IP may go to any instance in the pool.
BackendServiceUsedBy, BackendServiceUsedByArgs
- Reference string
- Reference string
- reference String
- reference string
- reference str
- reference String
BackendServiceUsedByResponse, BackendServiceUsedByResponseArgs
- Reference string
- Reference string
- reference String
- reference string
- reference str
- reference String
BackendServiceVpcNetworkScope, BackendServiceVpcNetworkScopeArgs
- Global
Vpc Network - GLOBAL_VPC_NETWORKThe backend service can only have backends in global VPCs
- Regional
Vpc Network - REGIONAL_VPC_NETWORKThe backend service can only have backends in regional VPCs
- Backend
Service Vpc Network Scope Global Vpc Network - GLOBAL_VPC_NETWORKThe backend service can only have backends in global VPCs
- Backend
Service Vpc Network Scope Regional Vpc Network - REGIONAL_VPC_NETWORKThe backend service can only have backends in regional VPCs
- Global
Vpc Network - GLOBAL_VPC_NETWORKThe backend service can only have backends in global VPCs
- Regional
Vpc Network - REGIONAL_VPC_NETWORKThe backend service can only have backends in regional VPCs
- Global
Vpc Network - GLOBAL_VPC_NETWORKThe backend service can only have backends in global VPCs
- Regional
Vpc Network - REGIONAL_VPC_NETWORKThe backend service can only have backends in regional VPCs
- GLOBAL_VPC_NETWORK
- GLOBAL_VPC_NETWORKThe backend service can only have backends in global VPCs
- REGIONAL_VPC_NETWORK
- REGIONAL_VPC_NETWORKThe backend service can only have backends in regional VPCs
- "GLOBAL_VPC_NETWORK"
- GLOBAL_VPC_NETWORKThe backend service can only have backends in global VPCs
- "REGIONAL_VPC_NETWORK"
- REGIONAL_VPC_NETWORKThe backend service can only have backends in regional VPCs
CacheKeyPolicy, CacheKeyPolicyArgs
- Include
Host bool - If true, requests to different hosts will be cached separately.
- Include
Http List<string>Headers - Allows HTTP request headers (by name) to be used in the cache key.
- 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 boolString - 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 List<string>Blacklist - 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 List<string>Whitelist - 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.
- Include
Http []stringHeaders - Allows HTTP request headers (by name) to be used in the cache key.
- []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 boolString - 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 []stringBlacklist - 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 []stringWhitelist - 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 Boolean - If true, requests to different hosts will be cached separately.
- include
Http List<String>Headers - Allows HTTP request headers (by name) to be used in the cache key.
- 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 Boolean - If true, http and https requests will be cached separately.
- include
Query BooleanString - 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 List<String>Blacklist - 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 List<String>Whitelist - 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 boolean - If true, requests to different hosts will be cached separately.