gcp.compute.getBackendService
Explore with Pulumi AI
Provide access to a Backend Service’s attribute. For more information see the official documentation and the API.
Example Usage
data "google_compute_backend_service" "baz" {
name = "foobar"
}
resource "google_compute_backend_service" "default" {
name = "backend-service"
health_checks = [tolist(data.google_compute_backend_service.baz.health_checks)[0]]
}
Using getBackendService
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBackendService(args: GetBackendServiceArgs, opts?: InvokeOptions): Promise<GetBackendServiceResult>
function getBackendServiceOutput(args: GetBackendServiceOutputArgs, opts?: InvokeOptions): Output<GetBackendServiceResult>
def get_backend_service(name: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackendServiceResult
def get_backend_service_output(name: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackendServiceResult]
func LookupBackendService(ctx *Context, args *LookupBackendServiceArgs, opts ...InvokeOption) (*LookupBackendServiceResult, error)
func LookupBackendServiceOutput(ctx *Context, args *LookupBackendServiceOutputArgs, opts ...InvokeOption) LookupBackendServiceResultOutput
> Note: This function is named LookupBackendService
in the Go SDK.
public static class GetBackendService
{
public static Task<GetBackendServiceResult> InvokeAsync(GetBackendServiceArgs args, InvokeOptions? opts = null)
public static Output<GetBackendServiceResult> Invoke(GetBackendServiceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackendServiceResult> getBackendService(GetBackendServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:compute/getBackendService:getBackendService
arguments:
# arguments dictionary
The following arguments are supported:
getBackendService Result
The following output properties are available:
- int
- Backends
List<Get
Backend Service Backend> - The set of backends that serve this Backend Service.
- Cdn
Policies List<GetBackend Service Cdn Policy> - Circuit
Breakers List<GetBackend Service Circuit Breaker> - Compression
Mode string - Connection
Draining intTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- Consistent
Hash List<GetBackend Service Consistent Hash> - Creation
Timestamp string - Custom
Request List<string>Headers - Custom
Response List<string>Headers - Description string
- Textual description for the Backend Service.
- Edge
Security stringPolicy - Enable
Cdn bool - Whether or not Cloud CDN is enabled on the Backend Service.
- Fingerprint string
- The fingerprint of the Backend Service.
- Generated
Id int - The unique identifier for the resource. This identifier is defined by the server.
- Health
Checks List<string> - The set of HTTP/HTTPS health checks used by the Backend Service.
- Iaps
List<Get
Backend Service Iap> - Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancing stringScheme - Locality
Lb List<GetPolicies Backend Service Locality Lb Policy> - Locality
Lb stringPolicy - Log
Configs List<GetBackend Service Log Config> - Name string
- Outlier
Detections List<GetBackend Service Outlier Detection> - Port
Name string - The name of a service that has been added to an instance group in this backend.
- Protocol string
- The protocol for incoming requests.
- Security
Policy string - Security
Settings List<GetBackend Service Security Setting> - Self
Link string - The URI of the Backend Service.
- Service
Lb stringPolicy - Session
Affinity string - The Backend Service session stickiness configuration.
- Timeout
Sec int - The number of seconds to wait for a backend to respond to a request before considering the request failed.
- Project string
- int
- Backends
[]Get
Backend Service Backend - The set of backends that serve this Backend Service.
- Cdn
Policies []GetBackend Service Cdn Policy - Circuit
Breakers []GetBackend Service Circuit Breaker - Compression
Mode string - Connection
Draining intTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- Consistent
Hash []GetBackend Service Consistent Hash - Creation
Timestamp string - Custom
Request []stringHeaders - Custom
Response []stringHeaders - Description string
- Textual description for the Backend Service.
- Edge
Security stringPolicy - Enable
Cdn bool - Whether or not Cloud CDN is enabled on the Backend Service.
- Fingerprint string
- The fingerprint of the Backend Service.
- Generated
Id int - The unique identifier for the resource. This identifier is defined by the server.
- Health
Checks []string - The set of HTTP/HTTPS health checks used by the Backend Service.
- Iaps
[]Get
Backend Service Iap - Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancing stringScheme - Locality
Lb []GetPolicies Backend Service Locality Lb Policy - Locality
Lb stringPolicy - Log
Configs []GetBackend Service Log Config - Name string
- Outlier
Detections []GetBackend Service Outlier Detection - Port
Name string - The name of a service that has been added to an instance group in this backend.
- Protocol string
- The protocol for incoming requests.
- Security
Policy string - Security
Settings []GetBackend Service Security Setting - Self
Link string - The URI of the Backend Service.
- Service
Lb stringPolicy - Session
Affinity string - The Backend Service session stickiness configuration.
- Timeout
Sec int - The number of seconds to wait for a backend to respond to a request before considering the request failed.
- Project string
- Integer
- backends
List<Get
Backend Service Backend> - The set of backends that serve this Backend Service.
- cdn
Policies List<GetBackend Service Cdn Policy> - circuit
Breakers List<GetBackend Service Circuit Breaker> - compression
Mode String - connection
Draining IntegerTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent
Hash List<GetBackend Service Consistent Hash> - creation
Timestamp String - custom
Request List<String>Headers - custom
Response List<String>Headers - description String
- Textual description for the Backend Service.
- edge
Security StringPolicy - enable
Cdn Boolean - Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint String
- The fingerprint of the Backend Service.
- generated
Id Integer - The unique identifier for the resource. This identifier is defined by the server.
- health
Checks List<String> - The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps
List<Get
Backend Service Iap> - id String
- The provider-assigned unique ID for this managed resource.
- load
Balancing StringScheme - locality
Lb List<GetPolicies Backend Service Locality Lb Policy> - locality
Lb StringPolicy - log
Configs List<GetBackend Service Log Config> - name String
- outlier
Detections List<GetBackend Service Outlier Detection> - port
Name String - The name of a service that has been added to an instance group in this backend.
- protocol String
- The protocol for incoming requests.
- security
Policy String - security
Settings List<GetBackend Service Security Setting> - self
Link String - The URI of the Backend Service.
- service
Lb StringPolicy - session
Affinity String - The Backend Service session stickiness configuration.
- timeout
Sec Integer - The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project String
- number
- backends
Get
Backend Service Backend[] - The set of backends that serve this Backend Service.
- cdn
Policies GetBackend Service Cdn Policy[] - circuit
Breakers GetBackend Service Circuit Breaker[] - compression
Mode string - connection
Draining numberTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent
Hash GetBackend Service Consistent Hash[] - creation
Timestamp string - custom
Request string[]Headers - custom
Response string[]Headers - description string
- Textual description for the Backend Service.
- edge
Security stringPolicy - enable
Cdn boolean - Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint string
- The fingerprint of the Backend Service.
- generated
Id number - The unique identifier for the resource. This identifier is defined by the server.
- health
Checks string[] - The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps
Get
Backend Service Iap[] - id string
- The provider-assigned unique ID for this managed resource.
- load
Balancing stringScheme - locality
Lb GetPolicies Backend Service Locality Lb Policy[] - locality
Lb stringPolicy - log
Configs GetBackend Service Log Config[] - name string
- outlier
Detections GetBackend Service Outlier Detection[] - port
Name string - The name of a service that has been added to an instance group in this backend.
- protocol string
- The protocol for incoming requests.
- security
Policy string - security
Settings GetBackend Service Security Setting[] - self
Link string - The URI of the Backend Service.
- service
Lb stringPolicy - session
Affinity string - The Backend Service session stickiness configuration.
- timeout
Sec number - The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project string
- int
- backends
Sequence[Get
Backend Service Backend] - The set of backends that serve this Backend Service.
- cdn_
policies Sequence[GetBackend Service Cdn Policy] - circuit_
breakers Sequence[GetBackend Service Circuit Breaker] - compression_
mode str - connection_
draining_ inttimeout_ sec - Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent_
hash Sequence[GetBackend Service Consistent Hash] - creation_
timestamp str - custom_
request_ Sequence[str]headers - custom_
response_ Sequence[str]headers - description str
- Textual description for the Backend Service.
- edge_
security_ strpolicy - enable_
cdn bool - Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint str
- The fingerprint of the Backend Service.
- generated_
id int - The unique identifier for the resource. This identifier is defined by the server.
- health_
checks Sequence[str] - The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps
Sequence[Get
Backend Service Iap] - id str
- The provider-assigned unique ID for this managed resource.
- load_
balancing_ strscheme - locality_
lb_ Sequence[Getpolicies Backend Service Locality Lb Policy] - locality_
lb_ strpolicy - log_
configs Sequence[GetBackend Service Log Config] - name str
- outlier_
detections Sequence[GetBackend Service Outlier Detection] - port_
name str - The name of a service that has been added to an instance group in this backend.
- protocol str
- The protocol for incoming requests.
- security_
policy str - security_
settings Sequence[GetBackend Service Security Setting] - self_
link str - The URI of the Backend Service.
- service_
lb_ strpolicy - session_
affinity str - The Backend Service session stickiness configuration.
- timeout_
sec int - The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project str
- Number
- backends List<Property Map>
- The set of backends that serve this Backend Service.
- cdn
Policies List<Property Map> - circuit
Breakers List<Property Map> - compression
Mode String - connection
Draining NumberTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent
Hash List<Property Map> - creation
Timestamp String - custom
Request List<String>Headers - custom
Response List<String>Headers - description String
- Textual description for the Backend Service.
- edge
Security StringPolicy - enable
Cdn Boolean - Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint String
- The fingerprint of the Backend Service.
- generated
Id Number - The unique identifier for the resource. This identifier is defined by the server.
- health
Checks List<String> - The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps List<Property Map>
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancing StringScheme - locality
Lb List<Property Map>Policies - locality
Lb StringPolicy - log
Configs List<Property Map> - name String
- outlier
Detections List<Property Map> - port
Name String - The name of a service that has been added to an instance group in this backend.
- protocol String
- The protocol for incoming requests.
- security
Policy String - security
Settings List<Property Map> - self
Link String - The URI of the Backend Service.
- service
Lb StringPolicy - session
Affinity String - The Backend Service session stickiness configuration.
- timeout
Sec Number - The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project String
Supporting Types
GetBackendServiceBackend
- Balancing
Mode string Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview for an explanation of load balancing modes.
From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"]
- Capacity
Scaler double A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].
- Description string
- Textual description for the Backend Service.
- Group string
The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
- Max
Connections int The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
- Max
Connections intPer Endpoint The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.
- Max
Connections intPer Instance The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- Max
Rate int The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
- Max
Rate doublePer Endpoint - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.
- Max
Rate doublePer Instance - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- Max
Utilization double - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
- Balancing
Mode string Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview for an explanation of load balancing modes.
From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"]
- Capacity
Scaler float64 A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].
- Description string
- Textual description for the Backend Service.
- Group string
The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
- Max
Connections int The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
- Max
Connections intPer Endpoint The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.
- Max
Connections intPer Instance The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- Max
Rate int The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
- Max
Rate float64Per Endpoint - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.
- Max
Rate float64Per Instance - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- Max
Utilization float64 - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
- balancing
Mode String Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview for an explanation of load balancing modes.
From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"]
- capacity
Scaler Double A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].
- description String
- Textual description for the Backend Service.
- group String
The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
- max
Connections Integer The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
- max
Connections IntegerPer Endpoint The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.
- max
Connections IntegerPer Instance The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max
Rate Integer The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
- max
Rate DoublePer Endpoint - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.
- max
Rate DoublePer Instance - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- max
Utilization Double - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
- balancing
Mode string Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview for an explanation of load balancing modes.
From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"]
- capacity
Scaler number A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].
- description string
- Textual description for the Backend Service.
- group string
The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
- max
Connections number The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
- max
Connections numberPer Endpoint The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.
- max
Connections numberPer Instance The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max
Rate number The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
- max
Rate numberPer Endpoint - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.
- max
Rate numberPer Instance - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- max
Utilization number - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
- balancing_
mode str Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview for an explanation of load balancing modes.
From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"]
- capacity_
scaler float A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].
- description str
- Textual description for the Backend Service.
- group str
The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
- max_
connections int The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
- max_
connections_ intper_ endpoint The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.
- max_
connections_ intper_ instance The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max_
rate int The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
- max_
rate_ floatper_ endpoint - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.
- max_
rate_ floatper_ instance - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- max_
utilization float - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
- balancing
Mode String Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview for an explanation of load balancing modes.
From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"]
- capacity
Scaler Number A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is [0.0,1.0].
- description String
- Textual description for the Backend Service.
- group String
The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
- max
Connections Number The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
- max
Connections NumberPer Endpoint The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.
- max
Connections NumberPer Instance The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max
Rate Number The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
- max
Rate NumberPer Endpoint - The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.
- max
Rate NumberPer Instance - The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- max
Utilization Number - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
GetBackendServiceCdnPolicy
- Bypass
Cache List<GetOn Request Headers 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 List<GetPolicies Backend Service Cdn Policy Cache Key Policy> - 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, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
- Client
Ttl int - Specifies the maximum allowed TTL for cached content served by this origin.
- 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).
- Max
Ttl int - Specifies the maximum allowed TTL for cached content served by this origin.
- 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.
- Negative
Caching List<GetPolicies Backend Service Cdn Policy Negative Caching Policy> - Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
- 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.
- Signed
Url intCache Max Age Sec Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.
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 []GetOn Request Headers 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 []GetPolicies Backend Service Cdn Policy Cache Key Policy - 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, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
- Client
Ttl int - Specifies the maximum allowed TTL for cached content served by this origin.
- 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).
- Max
Ttl int - Specifies the maximum allowed TTL for cached content served by this origin.
- 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.
- Negative
Caching []GetPolicies Backend Service Cdn Policy Negative Caching Policy - Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
- 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.
- Signed
Url intCache Max Age Sec Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.
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<GetOn Request Headers 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 List<GetPolicies Backend Service Cdn Policy Cache Key Policy> - 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, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
- client
Ttl Integer - Specifies the maximum allowed TTL for cached content served by this origin.
- 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).
- max
Ttl Integer - Specifies the maximum allowed TTL for cached content served by this origin.
- 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.
- negative
Caching List<GetPolicies Backend Service Cdn Policy Negative Caching Policy> - Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
- 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.
- signed
Url IntegerCache Max Age Sec Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.
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 GetOn Request Headers 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 GetPolicies Backend Service Cdn Policy Cache Key Policy[] - 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, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
- client
Ttl number - Specifies the maximum allowed TTL for cached content served by this origin.
- 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).
- max
Ttl number - Specifies the maximum allowed TTL for cached content served by this origin.
- 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.
- negative
Caching GetPolicies Backend Service Cdn Policy Negative Caching Policy[] - Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
- 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.
- signed
Url numberCache Max Age Sec Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.
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[Geton_ request_ headers 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_ Sequence[Getpolicies Backend Service Cdn Policy Cache Key Policy] - 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, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
- client_
ttl int - Specifies the maximum allowed TTL for cached content served by this origin.
- 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).
- max_
ttl int - Specifies the maximum allowed TTL for cached content served by this origin.
- 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.
- negative_
caching_ Sequence[Getpolicies Backend Service Cdn Policy Negative Caching Policy] - Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
- 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.
- signed_
url_ intcache_ max_ age_ sec Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.
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 List<Property Map>Policies - 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, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
- client
Ttl Number - Specifies the maximum allowed TTL for cached content served by this origin.
- 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).
- max
Ttl Number - Specifies the maximum allowed TTL for cached content served by this origin.
- 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.
- negative
Caching List<Property Map>Policies - Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
- 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.
- signed
Url NumberCache Max Age Sec Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.
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.
GetBackendServiceCdnPolicyBypassCacheOnRequestHeader
- 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.
GetBackendServiceCdnPolicyCacheKeyPolicy
- 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>
- Names of cookies to include in cache keys.
- 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>Blacklists 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>Whitelists 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
- Names of cookies to include in cache keys.
- 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 []stringBlacklists 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 []stringWhitelists 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>
- Names of cookies to include in cache keys.
- 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>Blacklists 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>Whitelists 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 string[]Headers - Allows HTTP request headers (by name) to be used in the cache key.
- string[]
- Names of cookies to include in cache keys.
- 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 string[]Blacklists 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 string[]Whitelists 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_ Sequence[str]headers - Allows HTTP request headers (by name) to be used in the cache key.
- Sequence[str]
- Names of cookies to include in cache keys.
- 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_ Sequence[str]blacklists 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_ Sequence[str]whitelists 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>
- Names of cookies to include in cache keys.
- 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>Blacklists 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>Whitelists 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.
GetBackendServiceCdnPolicyNegativeCachingPolicy
- Code int
- The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 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, 308, 404, 405, 410, 421, 451 and 501 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, 308, 404, 405, 410, 421, 451 and 501 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, 308, 404, 405, 410, 421, 451 and 501 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, 308, 404, 405, 410, 421, 451 and 501 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, 308, 404, 405, 410, 421, 451 and 501 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.
GetBackendServiceCircuitBreaker
- Connect
Timeouts List<GetBackend Service Circuit Breaker Connect Timeout> - The timeout for new network connections to hosts.
- Max
Connections int - The maximum number of connections to the backend cluster. Defaults to 1024.
- Max
Pending intRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- Max
Requests int - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- Max
Requests intPer Connection - Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
- Max
Retries int - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- Connect
Timeouts []GetBackend Service Circuit Breaker Connect Timeout - The timeout for new network connections to hosts.
- Max
Connections int - The maximum number of connections to the backend cluster. Defaults to 1024.
- Max
Pending intRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- Max
Requests int - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- Max
Requests intPer Connection - Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
- Max
Retries int - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- connect
Timeouts List<GetBackend Service Circuit Breaker Connect Timeout> - The timeout for new network connections to hosts.
- max
Connections Integer - The maximum number of connections to the backend cluster. Defaults to 1024.
- max
Pending IntegerRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max
Requests Integer - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max
Requests IntegerPer Connection - Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
- max
Retries Integer - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- connect
Timeouts GetBackend Service Circuit Breaker Connect Timeout[] - The timeout for new network connections to hosts.
- max
Connections number - The maximum number of connections to the backend cluster. Defaults to 1024.
- max
Pending numberRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max
Requests number - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max
Requests numberPer Connection - Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
- max
Retries number - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- connect_
timeouts Sequence[GetBackend Service Circuit Breaker Connect Timeout] - The timeout for new network connections to hosts.
- max_
connections int - The maximum number of connections to the backend cluster. Defaults to 1024.
- max_
pending_ intrequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max_
requests int - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max_
requests_ intper_ connection - Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
- max_
retries int - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- connect
Timeouts List<Property Map> - The timeout for new network connections to hosts.
- max
Connections Number - The maximum number of connections to the backend cluster. Defaults to 1024.
- max
Pending NumberRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max
Requests Number - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max
Requests NumberPer Connection - Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
- max
Retries Number - The maximum number of parallel retries to the backend cluster. Defaults to 3.
GetBackendServiceCircuitBreakerConnectTimeout
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Integer
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds Integer
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds Number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
GetBackendServiceConsistentHash
- List<Get
Backend Service Consistent Hash Http Cooky> - Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
- Http
Header stringName - The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- Minimum
Ring intSize - The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.
- []Get
Backend Service Consistent Hash Http Cooky - Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
- Http
Header stringName - The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- Minimum
Ring intSize - The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.
- List<Get
Backend Service Consistent Hash Http Cooky> - Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
- http
Header StringName - The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum
Ring IntegerSize - The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.
- Get
Backend Service Consistent Hash Http Cooky[] - Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
- http
Header stringName - The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum
Ring numberSize - The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.
- Sequence[Get
Backend Service Consistent Hash Http Cooky] - Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
- http_
header_ strname - The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum_
ring_ intsize - The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.
- List<Property Map>
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
- http
Header StringName - The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
- minimum
Ring NumberSize - The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.
GetBackendServiceConsistentHashHttpCooky
- Name string
- The name of the Backend Service.
- Path string
- Path to set for the cookie.
- Ttls
List<Get
Backend Service Consistent Hash Http Cooky Ttl> - Lifetime of the cookie.
- Name string
- The name of the Backend Service.
- Path string
- Path to set for the cookie.
- Ttls
[]Get
Backend Service Consistent Hash Http Cooky Ttl - Lifetime of the cookie.
- name String
- The name of the Backend Service.
- path String
- Path to set for the cookie.
- ttls
List<Get
Backend Service Consistent Hash Http Cooky Ttl> - Lifetime of the cookie.
- name string
- The name of the Backend Service.
- path string
- Path to set for the cookie.
- ttls
Get
Backend Service Consistent Hash Http Cooky Ttl[] - Lifetime of the cookie.
- name str
- The name of the Backend Service.
- path str
- Path to set for the cookie.
- ttls
Sequence[Get
Backend Service Consistent Hash Http Cooky Ttl] - Lifetime of the cookie.
- name String
- The name of the Backend Service.
- path String
- Path to set for the cookie.
- ttls List<Property Map>
- Lifetime of the cookie.
GetBackendServiceConsistentHashHttpCookyTtl
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Integer
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds Integer
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds Number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
GetBackendServiceIap
- Oauth2Client
Id string - OAuth2 Client ID for IAP
- Oauth2Client
Secret string - OAuth2 Client Secret for IAP
- Oauth2Client
Secret stringSha256 - OAuth2 Client Secret SHA-256 for IAP
- Oauth2Client
Id string - OAuth2 Client ID for IAP
- Oauth2Client
Secret string - OAuth2 Client Secret for IAP
- Oauth2Client
Secret stringSha256 - OAuth2 Client Secret SHA-256 for IAP
- oauth2Client
Id String - OAuth2 Client ID for IAP
- oauth2Client
Secret String - OAuth2 Client Secret for IAP
- oauth2Client
Secret StringSha256 - OAuth2 Client Secret SHA-256 for IAP
- oauth2Client
Id string - OAuth2 Client ID for IAP
- oauth2Client
Secret string - OAuth2 Client Secret for IAP
- oauth2Client
Secret stringSha256 - OAuth2 Client Secret SHA-256 for IAP
- oauth2_
client_ strid - OAuth2 Client ID for IAP
- oauth2_
client_ strsecret - OAuth2 Client Secret for IAP
- oauth2_
client_ strsecret_ sha256 - OAuth2 Client Secret SHA-256 for IAP
- oauth2Client
Id String - OAuth2 Client ID for IAP
- oauth2Client
Secret String - OAuth2 Client Secret for IAP
- oauth2Client
Secret StringSha256 - OAuth2 Client Secret SHA-256 for IAP
GetBackendServiceLocalityLbPolicy
- Custom
Policies List<GetBackend Service Locality Lb Policy Custom Policy> - The configuration for a custom policy implemented by the user and deployed with the client.
- Policies
List<Get
Backend Service Locality Lb Policy Policy> - The configuration for a built-in load balancing policy.
- Custom
Policies []GetBackend Service Locality Lb Policy Custom Policy - The configuration for a custom policy implemented by the user and deployed with the client.
- Policies
[]Get
Backend Service Locality Lb Policy Policy - The configuration for a built-in load balancing policy.
- custom
Policies List<GetBackend Service Locality Lb Policy Custom Policy> - The configuration for a custom policy implemented by the user and deployed with the client.
- policies
List<Get
Backend Service Locality Lb Policy Policy> - The configuration for a built-in load balancing policy.
- custom
Policies GetBackend Service Locality Lb Policy Custom Policy[] - The configuration for a custom policy implemented by the user and deployed with the client.
- policies
Get
Backend Service Locality Lb Policy Policy[] - The configuration for a built-in load balancing policy.
- custom_
policies Sequence[GetBackend Service Locality Lb Policy Custom Policy] - The configuration for a custom policy implemented by the user and deployed with the client.
- policies
Sequence[Get
Backend Service Locality Lb Policy Policy] - The configuration for a built-in load balancing policy.
- custom
Policies List<Property Map> - The configuration for a custom policy implemented by the user and deployed with the client.
- policies List<Property Map>
- The configuration for a built-in load balancing policy.
GetBackendServiceLocalityLbPolicyCustomPolicy
GetBackendServiceLocalityLbPolicyPolicy
- Name string
- The name of the Backend Service.
- Name string
- The name of the Backend Service.
- name String
- The name of the Backend Service.
- name string
- The name of the Backend Service.
- name str
- The name of the Backend Service.
- name String
- The name of the Backend Service.
GetBackendServiceLogConfig
- Enable bool
- Whether to enable logging for the load balancer traffic served by this backend service.
- 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
- Whether to enable logging for the load balancer traffic served by this backend service.
- 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
- Whether to enable logging for the load balancer traffic served by this backend service.
- 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
- Whether to enable logging for the load balancer traffic served by this backend service.
- 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
- Whether to enable logging for the load balancer traffic served by this backend service.
- 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
- Whether to enable logging for the load balancer traffic served by this backend service.
- 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.
GetBackendServiceOutlierDetection
- Base
Ejection List<GetTimes Backend Service Outlier Detection Base Ejection Time> - The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
- Consecutive
Errors int - Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- Consecutive
Gateway intFailure - The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
- Enforcing
Consecutive intErrors - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- Enforcing
Consecutive intGateway Failure - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- Enforcing
Success intRate - The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- Intervals
List<Get
Backend Service Outlier Detection Interval> - Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
- Max
Ejection intPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- Success
Rate intMinimum Hosts - The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
- Success
Rate intRequest Volume - The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
- Success
Rate intStdev Factor - This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
- Base
Ejection []GetTimes Backend Service Outlier Detection Base Ejection Time - The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
- Consecutive
Errors int - Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- Consecutive
Gateway intFailure - The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
- Enforcing
Consecutive intErrors - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- Enforcing
Consecutive intGateway Failure - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- Enforcing
Success intRate - The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- Intervals
[]Get
Backend Service Outlier Detection Interval - Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
- Max
Ejection intPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- Success
Rate intMinimum Hosts - The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
- Success
Rate intRequest Volume - The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
- Success
Rate intStdev Factor - This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
- base
Ejection List<GetTimes Backend Service Outlier Detection Base Ejection Time> - The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
- consecutive
Errors Integer - Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive
Gateway IntegerFailure - The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
- enforcing
Consecutive IntegerErrors - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing
Consecutive IntegerGateway Failure - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing
Success IntegerRate - The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- intervals
List<Get
Backend Service Outlier Detection Interval> - Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
- max
Ejection IntegerPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success
Rate IntegerMinimum Hosts - The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
- success
Rate IntegerRequest Volume - The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
- success
Rate IntegerStdev Factor - This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
- base
Ejection GetTimes Backend Service Outlier Detection Base Ejection Time[] - The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
- consecutive
Errors number - Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive
Gateway numberFailure - The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
- enforcing
Consecutive numberErrors - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing
Consecutive numberGateway Failure - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing
Success numberRate - The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- intervals
Get
Backend Service Outlier Detection Interval[] - Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
- max
Ejection numberPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success
Rate numberMinimum Hosts - The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
- success
Rate numberRequest Volume - The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
- success
Rate numberStdev Factor - This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
- base_
ejection_ Sequence[Gettimes Backend Service Outlier Detection Base Ejection Time] - The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
- consecutive_
errors int - Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive_
gateway_ intfailure - The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
- enforcing_
consecutive_ interrors - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing_
consecutive_ intgateway_ failure - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing_
success_ intrate - The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- intervals
Sequence[Get
Backend Service Outlier Detection Interval] - Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
- max_
ejection_ intpercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success_
rate_ intminimum_ hosts - The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
- success_
rate_ intrequest_ volume - The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
- success_
rate_ intstdev_ factor - This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
- base
Ejection List<Property Map>Times - The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
- consecutive
Errors Number - Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
- consecutive
Gateway NumberFailure - The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
- enforcing
Consecutive NumberErrors - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- enforcing
Consecutive NumberGateway Failure - The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
- enforcing
Success NumberRate - The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
- intervals List<Property Map>
- Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
- max
Ejection NumberPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success
Rate NumberMinimum Hosts - The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
- success
Rate NumberRequest Volume - The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
- success
Rate NumberStdev Factor - This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
GetBackendServiceOutlierDetectionBaseEjectionTime
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Integer
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds Integer
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds Number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
GetBackendServiceOutlierDetectionInterval
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- Nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- Seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Integer
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds Integer
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos int
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds int
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
- nanos Number
- Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
- seconds Number
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
GetBackendServiceSecuritySetting
- Client
Tls stringPolicy - ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
- Subject
Alt List<string>Names - A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.
- Client
Tls stringPolicy - ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
- Subject
Alt []stringNames - A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.
- client
Tls StringPolicy - ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
- subject
Alt List<String>Names - A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.
- client
Tls stringPolicy - ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
- subject
Alt string[]Names - A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.
- client_
tls_ strpolicy - ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
- subject_
alt_ Sequence[str]names - A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.
- client
Tls StringPolicy - ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
- subject
Alt List<String>Names - A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.