1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getBackendService
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi

gcp.compute.getBackendService

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Provide access to a Backend Service’s attribute. For more information see the official documentation and the API.

    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.

    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.

    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.

    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.

    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.

    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.

    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
    CapacityScaler float64
    Description string

    Textual description for the Backend Service.

    Group string
    MaxConnections int
    MaxConnectionsPerEndpoint int
    MaxConnectionsPerInstance int
    MaxRate int
    MaxRatePerEndpoint float64
    MaxRatePerInstance float64
    MaxUtilization float64
    balancingMode String
    capacityScaler Double
    description String

    Textual description for the Backend Service.

    group String
    maxConnections Integer
    maxConnectionsPerEndpoint Integer
    maxConnectionsPerInstance Integer
    maxRate Integer
    maxRatePerEndpoint Double
    maxRatePerInstance Double
    maxUtilization Double
    balancingMode string
    capacityScaler number
    description string

    Textual description for the Backend Service.

    group string
    maxConnections number
    maxConnectionsPerEndpoint number
    maxConnectionsPerInstance number
    maxRate number
    maxRatePerEndpoint number
    maxRatePerInstance number
    maxUtilization number
    balancingMode String
    capacityScaler Number
    description String

    Textual description for the Backend Service.

    group String
    maxConnections Number
    maxConnectionsPerEndpoint Number
    maxConnectionsPerInstance Number
    maxRate Number
    maxRatePerEndpoint Number
    maxRatePerInstance Number
    maxUtilization Number

    GetBackendServiceCdnPolicy

    GetBackendServiceCdnPolicyBypassCacheOnRequestHeader

    HeaderName string
    HeaderName string
    headerName String
    headerName string
    headerName String

    GetBackendServiceCdnPolicyCacheKeyPolicy

    GetBackendServiceCdnPolicyNegativeCachingPolicy

    Code int
    Ttl int
    Code int
    Ttl int
    code Integer
    ttl Integer
    code number
    ttl number
    code int
    ttl int
    code Number
    ttl Number

    GetBackendServiceCircuitBreaker

    GetBackendServiceCircuitBreakerConnectTimeout

    Nanos int
    Seconds int
    Nanos int
    Seconds int
    nanos Integer
    seconds Integer
    nanos number
    seconds number
    nanos int
    seconds int
    nanos Number
    seconds Number

    GetBackendServiceConsistentHash

    GetBackendServiceConsistentHashHttpCooky

    Name string

    The name of the Backend Service.


    Path string
    Ttls List<GetBackendServiceConsistentHashHttpCookyTtl>
    Name string

    The name of the Backend Service.


    Path string
    Ttls []GetBackendServiceConsistentHashHttpCookyTtl
    name String

    The name of the Backend Service.


    path String
    ttls List<GetBackendServiceConsistentHashHttpCookyTtl>
    name string

    The name of the Backend Service.


    path string
    ttls GetBackendServiceConsistentHashHttpCookyTtl[]
    name String

    The name of the Backend Service.


    path String
    ttls List<Property Map>

    GetBackendServiceConsistentHashHttpCookyTtl

    Nanos int
    Seconds int
    Nanos int
    Seconds int
    nanos Integer
    seconds Integer
    nanos number
    seconds number
    nanos int
    seconds int
    nanos Number
    seconds Number

    GetBackendServiceIap

    GetBackendServiceLocalityLbPolicy

    GetBackendServiceLocalityLbPolicyCustomPolicy

    Data string
    Name string

    The name of the Backend Service.


    Data string
    Name string

    The name of the Backend Service.


    data String
    name String

    The name of the Backend Service.


    data string
    name string

    The name of the Backend Service.


    data str
    name str

    The name of the Backend Service.


    data String
    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
    SampleRate double
    Enable bool
    SampleRate float64
    enable Boolean
    sampleRate Double
    enable boolean
    sampleRate number
    enable Boolean
    sampleRate Number

    GetBackendServiceOutlierDetection

    GetBackendServiceOutlierDetectionBaseEjectionTime

    Nanos int
    Seconds int
    Nanos int
    Seconds int
    nanos Integer
    seconds Integer
    nanos number
    seconds number
    nanos int
    seconds int
    nanos Number
    seconds Number

    GetBackendServiceOutlierDetectionInterval

    Nanos int
    Seconds int
    Nanos int
    Seconds int
    nanos Integer
    seconds Integer
    nanos number
    seconds number
    nanos int
    seconds int
    nanos Number
    seconds Number

    GetBackendServiceSecuritySetting

    ClientTlsPolicy string
    SubjectAltNames List<string>
    clientTlsPolicy String
    subjectAltNames List<String>
    clientTlsPolicy String
    subjectAltNames List<String>

    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 v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi