GetBackendService

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

Using GetBackendService

function getBackendService(args: GetBackendServiceArgs, opts?: InvokeOptions): Promise<GetBackendServiceResult>

function  get_backend_service(name=None, project=None, opts=None)

func LookupBackendService(ctx *Context, args *LookupBackendServiceArgs, opts ...InvokeOption) (*LookupBackendServiceResult, error)

Note: This function is named LookupBackendService in the Go SDK.

public static class GetBackendService {
    public static Task<GetBackendServiceResult> InvokeAsync(GetBackendServiceArgs args, InvokeOptions? opts = null)
}

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

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>
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>
Description string: Textual description for the Backend Service.
EnableCdn bool: Whether or not Cloud CDN is enabled on the Backend Service.
Fingerprint string: The fingerprint of the Backend Service.
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
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
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
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
Description string: Textual description for the Backend Service.
EnableCdn bool: Whether or not Cloud CDN is enabled on the Backend Service.
Fingerprint string: The fingerprint of the Backend Service.
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
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
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 number
backends GetBackendServiceBackend[]: The set of backends that serve this Backend Service.
cdnPolicies GetBackendServiceCdnPolicy[]
circuitBreakers GetBackendServiceCircuitBreaker[]
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[]
description string: Textual description for the Backend Service.
enableCdn boolean: Whether or not Cloud CDN is enabled on the Backend Service.
fingerprint string: The fingerprint of the Backend Service.
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
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
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 float
backends List[GetBackendServiceBackend]: The set of backends that serve this Backend Service.
cdn_policies List[GetBackendServiceCdnPolicy]
circuit_breakers List[GetBackendServiceCircuitBreaker]
connection_draining_timeout_sec float: Time for which instance will be drained (not accept new connections, but still work to finish started ones).
consistent_hash List[GetBackendServiceConsistentHash]
creation_timestamp str
custom_request_headers List[str]
description str: Textual description for the Backend Service.
enable_cdn bool: Whether or not Cloud CDN is enabled on the Backend Service.
fingerprint str: The fingerprint of the Backend Service.
health_checks List[str]: The set of HTTP/HTTPS health checks used by the Backend Service.
iaps List[GetBackendServiceIap]
id str: The provider-assigned unique ID for this managed resource.
load_balancing_scheme str
locality_lb_policy str
log_configs List[GetBackendServiceLogConfig]
name str
outlier_detections List[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
self_link str: The URI of the Backend Service.
session_affinity str: The Backend Service session stickiness configuration.
timeout_sec float: The number of seconds to wait for a backend to respond to a request before considering the request failed.
project str

Supporting Types

GetBackendServiceBackend

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

BalancingMode string
CapacityScaler double
Description string: Textual description for the Backend Service.
Group string
MaxConnections int
MaxConnectionsPerEndpoint int
MaxConnectionsPerInstance int
MaxRate int
MaxRatePerEndpoint double
MaxRatePerInstance double
MaxUtilization double

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 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 str
capacityScaler float
description str: Textual description for the Backend Service.
group str
maxConnections float
maxConnectionsPerEndpoint float
maxConnectionsPerInstance float
maxRate float
maxRatePerEndpoint float
maxRatePerInstance float
maxUtilization float

GetBackendServiceCdnPolicy

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

CacheKeyPolicies List<GetBackendServiceCdnPolicyCacheKeyPolicyArgs>
SignedUrlCacheMaxAgeSec int

CacheKeyPolicies []GetBackendServiceCdnPolicyCacheKeyPolicy
SignedUrlCacheMaxAgeSec int

cacheKeyPolicies GetBackendServiceCdnPolicyCacheKeyPolicy[]
signedUrlCacheMaxAgeSec number

cacheKeyPolicies List[GetBackendServiceCdnPolicyCacheKeyPolicy]
signedUrlCacheMaxAgeSec float

GetBackendServiceCdnPolicyCacheKeyPolicy

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

IncludeHost bool
IncludeProtocol bool
IncludeQueryString bool
QueryStringBlacklists List<string>
QueryStringWhitelists List<string>

IncludeHost bool
IncludeProtocol bool
IncludeQueryString bool
QueryStringBlacklists []string
QueryStringWhitelists []string

includeHost boolean
includeProtocol boolean
includeQueryString boolean
queryStringBlacklists string[]
queryStringWhitelists string[]

includeHost bool
includeProtocol bool
includeQueryString bool
queryStringBlacklists List[str]
queryStringWhitelists List[str]

GetBackendServiceCircuitBreaker

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ConnectTimeouts List<GetBackendServiceCircuitBreakerConnectTimeoutArgs>
MaxConnections int
MaxPendingRequests int
MaxRequests int
MaxRequestsPerConnection int
MaxRetries int

ConnectTimeouts []GetBackendServiceCircuitBreakerConnectTimeout
MaxConnections int
MaxPendingRequests int
MaxRequests int
MaxRequestsPerConnection int
MaxRetries int

connectTimeouts GetBackendServiceCircuitBreakerConnectTimeout[]
maxConnections number
maxPendingRequests number
maxRequests number
maxRequestsPerConnection number
maxRetries number

connectTimeouts List[GetBackendServiceCircuitBreakerConnectTimeout]
maxConnections float
maxPendingRequests float
maxRequests float
maxRequestsPerConnection float
maxRetries float

GetBackendServiceCircuitBreakerConnectTimeout

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Nanos int
Seconds int

Nanos int
Seconds int

nanos number
seconds number

nanos float
seconds float

GetBackendServiceConsistentHash

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

HttpCookies List<GetBackendServiceConsistentHashHttpCookyArgs>
HttpHeaderName string
MinimumRingSize int

HttpCookies []GetBackendServiceConsistentHashHttpCooky
HttpHeaderName string
MinimumRingSize int

httpCookies GetBackendServiceConsistentHashHttpCooky[]
httpHeaderName string
minimumRingSize number

httpCookies List[GetBackendServiceConsistentHashHttpCooky]
httpHeaderName str
minimumRingSize float

GetBackendServiceConsistentHashHttpCooky

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Name string: The name of the Backend Service.
Path string
Ttls List<GetBackendServiceConsistentHashHttpCookyTtlArgs>

Name string: The name of the Backend Service.
Path string
Ttls []GetBackendServiceConsistentHashHttpCookyTtl

name string: The name of the Backend Service.
path string
ttls GetBackendServiceConsistentHashHttpCookyTtl[]

name str: The name of the Backend Service.
path str
ttls List[GetBackendServiceConsistentHashHttpCookyTtl]

GetBackendServiceConsistentHashHttpCookyTtl

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Nanos int
Seconds int

Nanos int
Seconds int

nanos number
seconds number

nanos float
seconds float

GetBackendServiceIap

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Oauth2ClientId string
Oauth2ClientSecret string
Oauth2ClientSecretSha256 string

Oauth2ClientId string
Oauth2ClientSecret string
Oauth2ClientSecretSha256 string

oauth2ClientId string
oauth2ClientSecret string
oauth2ClientSecretSha256 string

oauth2ClientId str
oauth2ClientSecret str
oauth2ClientSecretSha256 str

GetBackendServiceLogConfig

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Enable bool
SampleRate double

Enable bool
SampleRate float64

enable boolean
sampleRate number

enable bool
sampleRate float

GetBackendServiceOutlierDetection

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

GetBackendServiceOutlierDetectionBaseEjectionTime

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Nanos int
Seconds int

Nanos int
Seconds int

nanos number
seconds number

nanos float
seconds float

GetBackendServiceOutlierDetectionInterval

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Nanos int
Seconds int

Nanos int
Seconds int

nanos number
seconds number

nanos float
seconds float

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.