Parameter |
Choices/Defaults |
Comments |
affinity_cookie_ttl_sec
integer
|
|
Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
When the load balancing scheme is INTERNAL, this field is not used.
|
auth_kind
string
/ required
|
Choices:
- application
- machineaccount
- serviceaccount
|
The type of credential used.
|
backends
list
|
|
The set of backends that serve this BackendService.
|
|
balancing_mode
string
|
Default:
"UTILIZATION"
|
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).
Some valid choices include: "UTILIZATION", "RATE", "CONNECTION"
|
|
capacity_scaler
string
|
Default:
"1.0"
|
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
|
|
An optional description of this resource.
Provide this property when you create the resource.
|
|
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 service can not contain mix of 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_per_endpoint
integer
added in 2.9 |
|
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_per_instance
integer
|
|
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_per_endpoint
string
added in 2.9 |
|
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_per_instance
string
|
|
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
string
|
Default:
"0.8"
|
Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
|
cdn_policy
dictionary
|
|
Cloud CDN configuration for this BackendService.
|
|
cache_key_policy
dictionary
|
|
The CacheKeyPolicy for this CdnPolicy.
|
|
|
include_host
boolean
|
|
If true requests to different hosts will be cached separately.
|
|
|
include_protocol
boolean
|
|
If true, http and https requests will be cached separately.
|
|
|
include_query_string
boolean
|
|
If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.
If false, the query string will be excluded from the cache key entirely.
|
|
|
query_string_blacklist
list
|
|
Names of query string parameters to exclude in cache keys.
All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both.
'&' and '=' will be percent encoded and not treated as delimiters.
|
|
|
query_string_whitelist
list
|
|
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.
|
|
signed_url_cache_max_age_sec
integer
added in 2.8 |
Default:
"3600"
|
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.
|
connection_draining
dictionary
|
|
Settings for connection draining .
|
|
draining_timeout_sec
integer
|
Default:
"300"
|
Time for which instance will be drained (not accept new connections, but still work to finish started).
|
description
string
|
|
An optional description of this resource.
|
enable_cdn
boolean
|
|
If true, enable Cloud CDN for this BackendService.
|
env_type
string
|
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
health_checks
list
/ required
|
|
The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
For internal load balancing, a URL to a HealthCheck resource must be specified instead.
|
iap
dictionary
added in 2.7 |
|
Settings for enabling Cloud Identity Aware Proxy.
|
|
enabled
boolean
|
|
Enables IAP.
|
|
oauth2_client_id
string
/ required
|
|
OAuth2 Client ID for IAP .
|
|
oauth2_client_secret
string
/ required
|
|
OAuth2 Client Secret for IAP .
|
load_balancing_scheme
string
added in 2.7 |
Default:
"EXTERNAL"
|
Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a global backend service. Defaults to `EXTERNAL`.
Some valid choices include: "EXTERNAL", "INTERNAL_SELF_MANAGED"
|
name
string
/ required
|
|
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
port_name
string
|
|
Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
|
project
string
|
|
The Google Cloud Platform project to use.
|
protocol
string
|
|
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors if used with the GA API.
Some valid choices include: "HTTP", "HTTPS", "HTTP2", "TCP", "SSL"
|
scopes
list
|
|
Array of scopes to be used.
|
security_policy
string
added in 2.8 |
|
The security policy associated with this backend service.
|
service_account_contents
jsonarg
|
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
service_account_email
string
|
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
service_account_file
path
|
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
session_affinity
string
|
|
Type of session affinity to use. The default is NONE.
When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
When the protocol is UDP, this field is not used.
Some valid choices include: "NONE", "CLIENT_IP", "GENERATED_COOKIE"
|
state
string
|
Choices:
present ←
- absent
|
Whether the given object should exist in GCP
|
timeout_sec
integer
|
|
How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].
aliases: timeout_seconds
|