1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getBackendService
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

gcp.compute.getBackendService

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

    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:

    Name string
    The name of the Backend Service.


    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    Name string
    The name of the Backend Service.


    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name String
    The name of the Backend Service.


    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name string
    The name of the Backend Service.


    project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name str
    The name of the Backend Service.


    project str
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name String
    The name of the Backend Service.


    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.

    getBackendService Result

    The following output properties are available:

    AffinityCookieTtlSec int
    Backends List<GetBackendServiceBackend>
    The set of backends that serve this Backend Service.
    CdnPolicies List<GetBackendServiceCdnPolicy>
    CircuitBreakers List<GetBackendServiceCircuitBreaker>
    CompressionMode string
    ConnectionDrainingTimeoutSec int
    Time for which instance will be drained (not accept new connections, but still work to finish started ones).
    ConsistentHash List<GetBackendServiceConsistentHash>
    CreationTimestamp string
    CustomRequestHeaders List<string>
    CustomResponseHeaders List<string>
    Description string
    Textual description for the Backend Service.
    EdgeSecurityPolicy string
    EnableCdn bool
    Whether or not Cloud CDN is enabled on the Backend Service.
    Fingerprint string
    The fingerprint of the Backend Service.
    GeneratedId int
    The unique identifier for the resource. This identifier is defined by the server.
    HealthChecks List<string>
    The set of HTTP/HTTPS health checks used by the Backend Service.
    Iaps List<GetBackendServiceIap>
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancingScheme string
    LocalityLbPolicies List<GetBackendServiceLocalityLbPolicy>
    LocalityLbPolicy string
    LogConfigs List<GetBackendServiceLogConfig>
    Name string
    OutlierDetections List<GetBackendServiceOutlierDetection>
    PortName string
    The name of a service that has been added to an instance group in this backend.
    Protocol string
    The protocol for incoming requests.
    SecurityPolicy string
    SecuritySettings List<GetBackendServiceSecuritySetting>
    SelfLink string
    The URI of the Backend Service.
    ServiceLbPolicy string
    SessionAffinity string
    The Backend Service session stickiness configuration.
    TimeoutSec int
    The number of seconds to wait for a backend to respond to a request before considering the request failed.
    Project string
    AffinityCookieTtlSec int
    Backends []GetBackendServiceBackend
    The set of backends that serve this Backend Service.
    CdnPolicies []GetBackendServiceCdnPolicy
    CircuitBreakers []GetBackendServiceCircuitBreaker
    CompressionMode string
    ConnectionDrainingTimeoutSec int
    Time for which instance will be drained (not accept new connections, but still work to finish started ones).
    ConsistentHash []GetBackendServiceConsistentHash
    CreationTimestamp string
    CustomRequestHeaders []string
    CustomResponseHeaders []string
    Description string
    Textual description for the Backend Service.
    EdgeSecurityPolicy string
    EnableCdn bool
    Whether or not Cloud CDN is enabled on the Backend Service.
    Fingerprint string
    The fingerprint of the Backend Service.
    GeneratedId int
    The unique identifier for the resource. This identifier is defined by the server.
    HealthChecks []string
    The set of HTTP/HTTPS health checks used by the Backend Service.
    Iaps []GetBackendServiceIap
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancingScheme string
    LocalityLbPolicies []GetBackendServiceLocalityLbPolicy
    LocalityLbPolicy string
    LogConfigs []GetBackendServiceLogConfig
    Name string
    OutlierDetections []GetBackendServiceOutlierDetection
    PortName string
    The name of a service that has been added to an instance group in this backend.
    Protocol string
    The protocol for incoming requests.
    SecurityPolicy string
    SecuritySettings []GetBackendServiceSecuritySetting
    SelfLink string
    The URI of the Backend Service.
    ServiceLbPolicy string
    SessionAffinity string
    The Backend Service session stickiness configuration.
    TimeoutSec int
    The number of seconds to wait for a backend to respond to a request before considering the request failed.
    Project string
    affinityCookieTtlSec Integer
    backends List<GetBackendServiceBackend>
    The set of backends that serve this Backend Service.
    cdnPolicies List<GetBackendServiceCdnPolicy>
    circuitBreakers List<GetBackendServiceCircuitBreaker>
    compressionMode String
    connectionDrainingTimeoutSec Integer
    Time for which instance will be drained (not accept new connections, but still work to finish started ones).
    consistentHash List<GetBackendServiceConsistentHash>
    creationTimestamp String
    customRequestHeaders List<String>
    customResponseHeaders List<String>
    description String
    Textual description for the Backend Service.
    edgeSecurityPolicy String
    enableCdn Boolean
    Whether or not Cloud CDN is enabled on the Backend Service.
    fingerprint String
    The fingerprint of the Backend Service.
    generatedId Integer
    The unique identifier for the resource. This identifier is defined by the server.
    healthChecks List<String>
    The set of HTTP/HTTPS health checks used by the Backend Service.
    iaps List<GetBackendServiceIap>
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancingScheme String
    localityLbPolicies List<GetBackendServiceLocalityLbPolicy>
    localityLbPolicy String
    logConfigs List<GetBackendServiceLogConfig>
    name String
    outlierDetections List<GetBackendServiceOutlierDetection>
    portName String
    The name of a service that has been added to an instance group in this backend.
    protocol String
    The protocol for incoming requests.
    securityPolicy String
    securitySettings List<GetBackendServiceSecuritySetting>
    selfLink String
    The URI of the Backend Service.
    serviceLbPolicy String
    sessionAffinity String
    The Backend Service session stickiness configuration.
    timeoutSec Integer
    The number of seconds to wait for a backend to respond to a request before considering the request failed.
    project String
    affinityCookieTtlSec number
    backends GetBackendServiceBackend[]
    The set of backends that serve this Backend Service.
    cdnPolicies GetBackendServiceCdnPolicy[]
    circuitBreakers GetBackendServiceCircuitBreaker[]
    compressionMode string
    connectionDrainingTimeoutSec number
    Time for which instance will be drained (not accept new connections, but still work to finish started ones).
    consistentHash GetBackendServiceConsistentHash[]
    creationTimestamp string
    customRequestHeaders string[]
    customResponseHeaders string[]
    description string
    Textual description for the Backend Service.
    edgeSecurityPolicy string
    enableCdn boolean
    Whether or not Cloud CDN is enabled on the Backend Service.
    fingerprint string
    The fingerprint of the Backend Service.
    generatedId number
    The unique identifier for the resource. This identifier is defined by the server.
    healthChecks string[]
    The set of HTTP/HTTPS health checks used by the Backend Service.
    iaps GetBackendServiceIap[]
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancingScheme string
    localityLbPolicies GetBackendServiceLocalityLbPolicy[]
    localityLbPolicy string
    logConfigs GetBackendServiceLogConfig[]
    name string
    outlierDetections GetBackendServiceOutlierDetection[]
    portName string
    The name of a service that has been added to an instance group in this backend.
    protocol string
    The protocol for incoming requests.
    securityPolicy string
    securitySettings GetBackendServiceSecuritySetting[]
    selfLink string
    The URI of the Backend Service.
    serviceLbPolicy string
    sessionAffinity string
    The Backend Service session stickiness configuration.
    timeoutSec number
    The number of seconds to wait for a backend to respond to a request before considering the request failed.
    project string
    affinity_cookie_ttl_sec int
    backends Sequence[GetBackendServiceBackend]
    The set of backends that serve this Backend Service.
    cdn_policies Sequence[GetBackendServiceCdnPolicy]
    circuit_breakers Sequence[GetBackendServiceCircuitBreaker]
    compression_mode str
    connection_draining_timeout_sec int
    Time for which instance will be drained (not accept new connections, but still work to finish started ones).
    consistent_hash Sequence[GetBackendServiceConsistentHash]
    creation_timestamp str
    custom_request_headers Sequence[str]
    custom_response_headers Sequence[str]
    description str
    Textual description for the Backend Service.
    edge_security_policy str
    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[GetBackendServiceIap]
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancing_scheme str
    locality_lb_policies Sequence[GetBackendServiceLocalityLbPolicy]
    locality_lb_policy str
    log_configs Sequence[GetBackendServiceLogConfig]
    name str
    outlier_detections Sequence[GetBackendServiceOutlierDetection]
    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[GetBackendServiceSecuritySetting]
    self_link str
    The URI of the Backend Service.
    service_lb_policy str
    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
    affinityCookieTtlSec Number
    backends List<Property Map>
    The set of backends that serve this Backend Service.
    cdnPolicies List<Property Map>
    circuitBreakers List<Property Map>
    compressionMode String
    connectionDrainingTimeoutSec Number
    Time for which instance will be drained (not accept new connections, but still work to finish started ones).
    consistentHash List<Property Map>
    creationTimestamp String
    customRequestHeaders List<String>
    customResponseHeaders List<String>
    description String
    Textual description for the Backend Service.
    edgeSecurityPolicy String
    enableCdn Boolean
    Whether or not Cloud CDN is enabled on the Backend Service.
    fingerprint String
    The fingerprint of the Backend Service.
    generatedId Number
    The unique identifier for the resource. This identifier is defined by the server.
    healthChecks 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.
    loadBalancingScheme String
    localityLbPolicies List<Property Map>
    localityLbPolicy String
    logConfigs List<Property Map>
    name String
    outlierDetections List<Property Map>
    portName String
    The name of a service that has been added to an instance group in this backend.
    protocol String
    The protocol for incoming requests.
    securityPolicy String
    securitySettings List<Property Map>
    selfLink String
    The URI of the Backend Service.
    serviceLbPolicy String
    sessionAffinity String
    The Backend Service session stickiness configuration.
    timeoutSec 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

    BalancingMode 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"]

    CapacityScaler 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.

    MaxConnections 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.

    MaxConnectionsPerEndpoint int

    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.

    MaxConnectionsPerInstance int

    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.

    MaxRate 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.

    MaxRatePerEndpoint double
    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.
    MaxRatePerInstance double
    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.
    MaxUtilization double
    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
    BalancingMode 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"]

    CapacityScaler 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.

    MaxConnections 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.

    MaxConnectionsPerEndpoint int

    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.

    MaxConnectionsPerInstance int

    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.

    MaxRate 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.

    MaxRatePerEndpoint float64
    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.
    MaxRatePerInstance float64
    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.
    MaxUtilization float64
    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
    balancingMode 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"]

    capacityScaler 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.

    maxConnections 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.

    maxConnectionsPerEndpoint Integer

    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.

    maxConnectionsPerInstance 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.

    maxRate 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.

    maxRatePerEndpoint Double
    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.
    maxRatePerInstance Double
    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.
    maxUtilization Double
    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].
    balancingMode 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"]

    capacityScaler 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.

    maxConnections 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.

    maxConnectionsPerEndpoint number

    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.

    maxConnectionsPerInstance number

    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.

    maxRate 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.

    maxRatePerEndpoint number
    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.
    maxRatePerInstance number
    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.
    maxUtilization 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_per_endpoint int

    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 int

    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_per_endpoint float
    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 float
    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].
    balancingMode 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"]

    capacityScaler 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.

    maxConnections 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.

    maxConnectionsPerEndpoint Number

    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.

    maxConnectionsPerInstance Number

    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.

    maxRate 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.

    maxRatePerEndpoint Number
    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.
    maxRatePerInstance Number
    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.
    maxUtilization Number
    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

    GetBackendServiceCdnPolicy

    BypassCacheOnRequestHeaders List<GetBackendServiceCdnPolicyBypassCacheOnRequestHeader>
    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.
    CacheKeyPolicies List<GetBackendServiceCdnPolicyCacheKeyPolicy>
    The CacheKeyPolicy for this CdnPolicy.
    CacheMode 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"]
    ClientTtl int
    Specifies the maximum allowed TTL for cached content served by this origin.
    DefaultTtl int
    Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
    MaxTtl int
    Specifies the maximum allowed TTL for cached content served by this origin.
    NegativeCaching bool
    Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
    NegativeCachingPolicies List<GetBackendServiceCdnPolicyNegativeCachingPolicy>
    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.
    ServeWhileStale int
    Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
    SignedUrlCacheMaxAgeSec int

    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.

    BypassCacheOnRequestHeaders []GetBackendServiceCdnPolicyBypassCacheOnRequestHeader
    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.
    CacheKeyPolicies []GetBackendServiceCdnPolicyCacheKeyPolicy
    The CacheKeyPolicy for this CdnPolicy.
    CacheMode 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"]
    ClientTtl int
    Specifies the maximum allowed TTL for cached content served by this origin.
    DefaultTtl int
    Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
    MaxTtl int
    Specifies the maximum allowed TTL for cached content served by this origin.
    NegativeCaching bool
    Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
    NegativeCachingPolicies []GetBackendServiceCdnPolicyNegativeCachingPolicy
    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.
    ServeWhileStale int
    Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
    SignedUrlCacheMaxAgeSec int

    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.

    bypassCacheOnRequestHeaders List<GetBackendServiceCdnPolicyBypassCacheOnRequestHeader>
    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.
    cacheKeyPolicies List<GetBackendServiceCdnPolicyCacheKeyPolicy>
    The CacheKeyPolicy for this CdnPolicy.
    cacheMode 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"]
    clientTtl Integer
    Specifies the maximum allowed TTL for cached content served by this origin.
    defaultTtl Integer
    Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
    maxTtl Integer
    Specifies the maximum allowed TTL for cached content served by this origin.
    negativeCaching Boolean
    Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
    negativeCachingPolicies List<GetBackendServiceCdnPolicyNegativeCachingPolicy>
    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.
    serveWhileStale Integer
    Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
    signedUrlCacheMaxAgeSec Integer

    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.

    bypassCacheOnRequestHeaders GetBackendServiceCdnPolicyBypassCacheOnRequestHeader[]
    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.
    cacheKeyPolicies GetBackendServiceCdnPolicyCacheKeyPolicy[]
    The CacheKeyPolicy for this CdnPolicy.
    cacheMode 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"]
    clientTtl number
    Specifies the maximum allowed TTL for cached content served by this origin.
    defaultTtl number
    Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
    maxTtl number
    Specifies the maximum allowed TTL for cached content served by this origin.
    negativeCaching boolean
    Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
    negativeCachingPolicies GetBackendServiceCdnPolicyNegativeCachingPolicy[]
    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.
    serveWhileStale number
    Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
    signedUrlCacheMaxAgeSec number

    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_on_request_headers Sequence[GetBackendServiceCdnPolicyBypassCacheOnRequestHeader]
    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_policies Sequence[GetBackendServiceCdnPolicyCacheKeyPolicy]
    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_policies Sequence[GetBackendServiceCdnPolicyNegativeCachingPolicy]
    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_stale int
    Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
    signed_url_cache_max_age_sec int

    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.

    bypassCacheOnRequestHeaders List<Property Map>
    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
    cacheKeyPolicies List<Property Map>
    The CacheKeyPolicy for this CdnPolicy.
    cacheMode String
    Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]
    clientTtl Number
    Specifies the maximum allowed TTL for cached content served by this origin.
    defaultTtl Number
    Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
    maxTtl Number
    Specifies the maximum allowed TTL for cached content served by this origin.
    negativeCaching Boolean
    Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
    negativeCachingPolicies List<Property Map>
    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.
    serveWhileStale Number
    Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
    signedUrlCacheMaxAgeSec Number

    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

    HeaderName string
    The header field name to match on when bypassing cache. Values are case-insensitive.
    HeaderName string
    The header field name to match on when bypassing cache. Values are case-insensitive.
    headerName String
    The header field name to match on when bypassing cache. Values are case-insensitive.
    headerName 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.
    headerName String
    The header field name to match on when bypassing cache. Values are case-insensitive.

    GetBackendServiceCdnPolicyCacheKeyPolicy

    IncludeHost bool
    If true requests to different hosts will be cached separately.
    IncludeHttpHeaders List<string>
    Allows HTTP request headers (by name) to be used in the cache key.
    IncludeNamedCookies List<string>
    Names of cookies to include in cache keys.
    IncludeProtocol bool
    If true, http and https requests will be cached separately.
    IncludeQueryString bool

    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

    If false, the query string will be excluded from the cache key entirely.

    QueryStringBlacklists List<string>

    Names of query string parameters to exclude in cache keys.

    All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    QueryStringWhitelists List<string>

    Names of query string parameters to include in cache keys.

    All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    IncludeHost bool
    If true requests to different hosts will be cached separately.
    IncludeHttpHeaders []string
    Allows HTTP request headers (by name) to be used in the cache key.
    IncludeNamedCookies []string
    Names of cookies to include in cache keys.
    IncludeProtocol bool
    If true, http and https requests will be cached separately.
    IncludeQueryString bool

    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

    If false, the query string will be excluded from the cache key entirely.

    QueryStringBlacklists []string

    Names of query string parameters to exclude in cache keys.

    All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    QueryStringWhitelists []string

    Names of query string parameters to include in cache keys.

    All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    includeHost Boolean
    If true requests to different hosts will be cached separately.
    includeHttpHeaders List<String>
    Allows HTTP request headers (by name) to be used in the cache key.
    includeNamedCookies List<String>
    Names of cookies to include in cache keys.
    includeProtocol Boolean
    If true, http and https requests will be cached separately.
    includeQueryString Boolean

    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

    If false, the query string will be excluded from the cache key entirely.

    queryStringBlacklists List<String>

    Names of query string parameters to exclude in cache keys.

    All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    queryStringWhitelists List<String>

    Names of query string parameters to include in cache keys.

    All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    includeHost boolean
    If true requests to different hosts will be cached separately.
    includeHttpHeaders string[]
    Allows HTTP request headers (by name) to be used in the cache key.
    includeNamedCookies string[]
    Names of cookies to include in cache keys.
    includeProtocol boolean
    If true, http and https requests will be cached separately.
    includeQueryString boolean

    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

    If false, the query string will be excluded from the cache key entirely.

    queryStringBlacklists string[]

    Names of query string parameters to exclude in cache keys.

    All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    queryStringWhitelists string[]

    Names of query string parameters to include in cache keys.

    All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    include_host bool
    If true requests to different hosts will be cached separately.
    include_http_headers Sequence[str]
    Allows HTTP request headers (by name) to be used in the cache key.
    include_named_cookies 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_string bool

    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

    If false, the query string will be excluded from the cache key entirely.

    query_string_blacklists Sequence[str]

    Names of query string parameters to exclude in cache keys.

    All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    query_string_whitelists Sequence[str]

    Names of query string parameters to include in cache keys.

    All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    includeHost Boolean
    If true requests to different hosts will be cached separately.
    includeHttpHeaders List<String>
    Allows HTTP request headers (by name) to be used in the cache key.
    includeNamedCookies List<String>
    Names of cookies to include in cache keys.
    includeProtocol Boolean
    If true, http and https requests will be cached separately.
    includeQueryString Boolean

    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

    If false, the query string will be excluded from the cache key entirely.

    queryStringBlacklists List<String>

    Names of query string parameters to exclude in cache keys.

    All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    queryStringWhitelists List<String>

    Names of query string parameters to include in cache keys.

    All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    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

    ConnectTimeouts List<GetBackendServiceCircuitBreakerConnectTimeout>
    The timeout for new network connections to hosts.
    MaxConnections int
    The maximum number of connections to the backend cluster. Defaults to 1024.
    MaxPendingRequests int
    The maximum number of pending requests to the backend cluster. Defaults to 1024.
    MaxRequests int
    The maximum number of parallel requests to the backend cluster. Defaults to 1024.
    MaxRequestsPerConnection int
    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.
    MaxRetries int
    The maximum number of parallel retries to the backend cluster. Defaults to 3.
    ConnectTimeouts []GetBackendServiceCircuitBreakerConnectTimeout
    The timeout for new network connections to hosts.
    MaxConnections int
    The maximum number of connections to the backend cluster. Defaults to 1024.
    MaxPendingRequests int
    The maximum number of pending requests to the backend cluster. Defaults to 1024.
    MaxRequests int
    The maximum number of parallel requests to the backend cluster. Defaults to 1024.
    MaxRequestsPerConnection int
    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.
    MaxRetries int
    The maximum number of parallel retries to the backend cluster. Defaults to 3.
    connectTimeouts List<GetBackendServiceCircuitBreakerConnectTimeout>
    The timeout for new network connections to hosts.
    maxConnections Integer
    The maximum number of connections to the backend cluster. Defaults to 1024.
    maxPendingRequests Integer
    The maximum number of pending requests to the backend cluster. Defaults to 1024.
    maxRequests Integer
    The maximum number of parallel requests to the backend cluster. Defaults to 1024.
    maxRequestsPerConnection Integer
    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.
    maxRetries Integer
    The maximum number of parallel retries to the backend cluster. Defaults to 3.
    connectTimeouts GetBackendServiceCircuitBreakerConnectTimeout[]
    The timeout for new network connections to hosts.
    maxConnections number
    The maximum number of connections to the backend cluster. Defaults to 1024.
    maxPendingRequests number
    The maximum number of pending requests to the backend cluster. Defaults to 1024.
    maxRequests number
    The maximum number of parallel requests to the backend cluster. Defaults to 1024.
    maxRequestsPerConnection number
    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.
    maxRetries number
    The maximum number of parallel retries to the backend cluster. Defaults to 3.
    connect_timeouts Sequence[GetBackendServiceCircuitBreakerConnectTimeout]
    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_requests int
    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_per_connection int
    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.
    connectTimeouts List<Property Map>
    The timeout for new network connections to hosts.
    maxConnections Number
    The maximum number of connections to the backend cluster. Defaults to 1024.
    maxPendingRequests Number
    The maximum number of pending requests to the backend cluster. Defaults to 1024.
    maxRequests Number
    The maximum number of parallel requests to the backend cluster. Defaults to 1024.
    maxRequestsPerConnection Number
    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.
    maxRetries 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

    HttpCookies List<GetBackendServiceConsistentHashHttpCooky>
    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.
    HttpHeaderName string
    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
    MinimumRingSize int
    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.
    HttpCookies []GetBackendServiceConsistentHashHttpCooky
    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.
    HttpHeaderName string
    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
    MinimumRingSize int
    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.
    httpCookies List<GetBackendServiceConsistentHashHttpCooky>
    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.
    httpHeaderName String
    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
    minimumRingSize Integer
    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.
    httpCookies GetBackendServiceConsistentHashHttpCooky[]
    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.
    httpHeaderName string
    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
    minimumRingSize number
    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.
    http_cookies Sequence[GetBackendServiceConsistentHashHttpCooky]
    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_name str
    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
    minimum_ring_size int
    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.
    httpCookies 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.
    httpHeaderName String
    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
    minimumRingSize Number
    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<GetBackendServiceConsistentHashHttpCookyTtl>
    Lifetime of the cookie.
    Name string
    The name of the Backend Service.


    Path string
    Path to set for the cookie.
    Ttls []GetBackendServiceConsistentHashHttpCookyTtl
    Lifetime of the cookie.
    name String
    The name of the Backend Service.


    path String
    Path to set for the cookie.
    ttls List<GetBackendServiceConsistentHashHttpCookyTtl>
    Lifetime of the cookie.
    name string
    The name of the Backend Service.


    path string
    Path to set for the cookie.
    ttls GetBackendServiceConsistentHashHttpCookyTtl[]
    Lifetime of the cookie.
    name str
    The name of the Backend Service.


    path str
    Path to set for the cookie.
    ttls Sequence[GetBackendServiceConsistentHashHttpCookyTtl]
    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

    Oauth2ClientId string
    OAuth2 Client ID for IAP
    Oauth2ClientSecret string
    OAuth2 Client Secret for IAP
    Oauth2ClientSecretSha256 string
    OAuth2 Client Secret SHA-256 for IAP
    Oauth2ClientId string
    OAuth2 Client ID for IAP
    Oauth2ClientSecret string
    OAuth2 Client Secret for IAP
    Oauth2ClientSecretSha256 string
    OAuth2 Client Secret SHA-256 for IAP
    oauth2ClientId String
    OAuth2 Client ID for IAP
    oauth2ClientSecret String
    OAuth2 Client Secret for IAP
    oauth2ClientSecretSha256 String
    OAuth2 Client Secret SHA-256 for IAP
    oauth2ClientId string
    OAuth2 Client ID for IAP
    oauth2ClientSecret string
    OAuth2 Client Secret for IAP
    oauth2ClientSecretSha256 string
    OAuth2 Client Secret SHA-256 for IAP
    oauth2_client_id str
    OAuth2 Client ID for IAP
    oauth2_client_secret str
    OAuth2 Client Secret for IAP
    oauth2_client_secret_sha256 str
    OAuth2 Client Secret SHA-256 for IAP
    oauth2ClientId String
    OAuth2 Client ID for IAP
    oauth2ClientSecret String
    OAuth2 Client Secret for IAP
    oauth2ClientSecretSha256 String
    OAuth2 Client Secret SHA-256 for IAP

    GetBackendServiceLocalityLbPolicy

    CustomPolicies List<GetBackendServiceLocalityLbPolicyCustomPolicy>
    The configuration for a custom policy implemented by the user and deployed with the client.
    Policies List<GetBackendServiceLocalityLbPolicyPolicy>
    The configuration for a built-in load balancing policy.
    CustomPolicies []GetBackendServiceLocalityLbPolicyCustomPolicy
    The configuration for a custom policy implemented by the user and deployed with the client.
    Policies []GetBackendServiceLocalityLbPolicyPolicy
    The configuration for a built-in load balancing policy.
    customPolicies List<GetBackendServiceLocalityLbPolicyCustomPolicy>
    The configuration for a custom policy implemented by the user and deployed with the client.
    policies List<GetBackendServiceLocalityLbPolicyPolicy>
    The configuration for a built-in load balancing policy.
    customPolicies GetBackendServiceLocalityLbPolicyCustomPolicy[]
    The configuration for a custom policy implemented by the user and deployed with the client.
    policies GetBackendServiceLocalityLbPolicyPolicy[]
    The configuration for a built-in load balancing policy.
    custom_policies Sequence[GetBackendServiceLocalityLbPolicyCustomPolicy]
    The configuration for a custom policy implemented by the user and deployed with the client.
    policies Sequence[GetBackendServiceLocalityLbPolicyPolicy]
    The configuration for a built-in load balancing policy.
    customPolicies 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

    Data string
    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    Name string
    The name of the Backend Service.


    Data string
    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    Name string
    The name of the Backend Service.


    data String
    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    name String
    The name of the Backend Service.


    data string
    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    name string
    The name of the Backend Service.


    data str
    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    name str
    The name of the Backend Service.


    data String
    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    name String
    The name of the Backend Service.


    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.
    SampleRate double
    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
    Enable bool
    Whether to enable logging for the load balancer traffic served by this backend service.
    SampleRate float64
    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
    enable Boolean
    Whether to enable logging for the load balancer traffic served by this backend service.
    sampleRate Double
    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
    enable boolean
    Whether to enable logging for the load balancer traffic served by this backend service.
    sampleRate number
    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
    enable bool
    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.
    sampleRate Number
    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

    GetBackendServiceOutlierDetection

    BaseEjectionTimes List<GetBackendServiceOutlierDetectionBaseEjectionTime>
    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.
    ConsecutiveErrors 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.
    ConsecutiveGatewayFailure int
    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
    EnforcingConsecutiveErrors int
    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.
    EnforcingConsecutiveGatewayFailure int
    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.
    EnforcingSuccessRate int
    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<GetBackendServiceOutlierDetectionInterval>
    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.
    MaxEjectionPercent int
    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
    SuccessRateMinimumHosts int
    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.
    SuccessRateRequestVolume int
    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this 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.
    SuccessRateStdevFactor int
    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * 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.
    BaseEjectionTimes []GetBackendServiceOutlierDetectionBaseEjectionTime
    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.
    ConsecutiveErrors 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.
    ConsecutiveGatewayFailure int
    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
    EnforcingConsecutiveErrors int
    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.
    EnforcingConsecutiveGatewayFailure int
    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.
    EnforcingSuccessRate int
    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 []GetBackendServiceOutlierDetectionInterval
    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.
    MaxEjectionPercent int
    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
    SuccessRateMinimumHosts int
    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.
    SuccessRateRequestVolume int
    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this 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.
    SuccessRateStdevFactor int
    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * 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.
    baseEjectionTimes List<GetBackendServiceOutlierDetectionBaseEjectionTime>
    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.
    consecutiveErrors 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.
    consecutiveGatewayFailure Integer
    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
    enforcingConsecutiveErrors Integer
    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.
    enforcingConsecutiveGatewayFailure Integer
    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.
    enforcingSuccessRate Integer
    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<GetBackendServiceOutlierDetectionInterval>
    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.
    maxEjectionPercent Integer
    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
    successRateMinimumHosts Integer
    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.
    successRateRequestVolume Integer
    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this 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.
    successRateStdevFactor Integer
    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * 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.
    baseEjectionTimes GetBackendServiceOutlierDetectionBaseEjectionTime[]
    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.
    consecutiveErrors 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.
    consecutiveGatewayFailure number
    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
    enforcingConsecutiveErrors number
    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.
    enforcingConsecutiveGatewayFailure number
    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.
    enforcingSuccessRate number
    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 GetBackendServiceOutlierDetectionInterval[]
    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.
    maxEjectionPercent number
    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
    successRateMinimumHosts number
    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.
    successRateRequestVolume number
    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this 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.
    successRateStdevFactor number
    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * 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_times Sequence[GetBackendServiceOutlierDetectionBaseEjectionTime]
    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_failure int
    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
    enforcing_consecutive_errors int
    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_gateway_failure int
    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_rate int
    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[GetBackendServiceOutlierDetectionInterval]
    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_percent int
    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
    success_rate_minimum_hosts int
    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_request_volume int
    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this 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_stdev_factor int
    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * 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.
    baseEjectionTimes List<Property Map>
    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.
    consecutiveErrors 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.
    consecutiveGatewayFailure Number
    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
    enforcingConsecutiveErrors Number
    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.
    enforcingConsecutiveGatewayFailure Number
    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.
    enforcingSuccessRate Number
    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.
    maxEjectionPercent Number
    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
    successRateMinimumHosts Number
    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.
    successRateRequestVolume Number
    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this 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.
    successRateStdevFactor Number
    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * 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

    ClientTlsPolicy string
    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.
    SubjectAltNames List<string>
    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.
    ClientTlsPolicy string
    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.
    SubjectAltNames []string
    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.
    clientTlsPolicy String
    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.
    subjectAltNames List<String>
    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.
    clientTlsPolicy string
    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.
    subjectAltNames string[]
    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_policy str
    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_names Sequence[str]
    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.
    clientTlsPolicy String
    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.
    subjectAltNames List<String>
    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.
    gcp logo
    Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi