gcp.compute.getBackendService
Explore with Pulumi AI
Provide access to a Backend Service’s attribute. For more information see the official documentation and the API.
Using getBackendService
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBackendService(args: GetBackendServiceArgs, opts?: InvokeOptions): Promise<GetBackendServiceResult>
function getBackendServiceOutput(args: GetBackendServiceOutputArgs, opts?: InvokeOptions): Output<GetBackendServiceResult>
def get_backend_service(name: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackendServiceResult
def get_backend_service_output(name: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackendServiceResult]
func LookupBackendService(ctx *Context, args *LookupBackendServiceArgs, opts ...InvokeOption) (*LookupBackendServiceResult, error)
func LookupBackendServiceOutput(ctx *Context, args *LookupBackendServiceOutputArgs, opts ...InvokeOption) LookupBackendServiceResultOutput
> Note: This function is named LookupBackendService
in the Go SDK.
public static class GetBackendService
{
public static Task<GetBackendServiceResult> InvokeAsync(GetBackendServiceArgs args, InvokeOptions? opts = null)
public static Output<GetBackendServiceResult> Invoke(GetBackendServiceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackendServiceResult> getBackendService(GetBackendServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:compute/getBackendService:getBackendService
arguments:
# arguments dictionary
The following arguments are supported:
getBackendService Result
The following output properties are available:
- int
- Backends
List<Get
Backend Service Backend> The set of backends that serve this Backend Service.
- Cdn
Policies List<GetBackend Service Cdn Policy> - Circuit
Breakers List<GetBackend Service Circuit Breaker> - Compression
Mode string - Connection
Draining intTimeout Sec Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- Consistent
Hash List<GetBackend Service Consistent Hash> - Creation
Timestamp string - Custom
Request List<string>Headers - Custom
Response List<string>Headers - Description string
Textual description for the Backend Service.
- Edge
Security stringPolicy - Enable
Cdn bool Whether or not Cloud CDN is enabled on the Backend Service.
- Fingerprint string
The fingerprint of the Backend Service.
- Generated
Id int The unique identifier for the resource. This identifier is defined by the server.
- Health
Checks List<string> The set of HTTP/HTTPS health checks used by the Backend Service.
- Iaps
List<Get
Backend Service Iap> - Id string
The provider-assigned unique ID for this managed resource.
- Load
Balancing stringScheme - Locality
Lb List<GetPolicies Backend Service Locality Lb Policy> - Locality
Lb stringPolicy - Log
Configs List<GetBackend Service Log Config> - Name string
- Outlier
Detections List<GetBackend Service Outlier Detection> - Port
Name string The name of a service that has been added to an instance group in this backend.
- Protocol string
The protocol for incoming requests.
- Security
Policy string - Security
Settings List<GetBackend Service Security Setting> - Self
Link string The URI of the Backend Service.
- Session
Affinity string The Backend Service session stickiness configuration.
- Timeout
Sec int The number of seconds to wait for a backend to respond to a request before considering the request failed.
- Project string
- int
- Backends
[]Get
Backend Service Backend The set of backends that serve this Backend Service.
- Cdn
Policies []GetBackend Service Cdn Policy - Circuit
Breakers []GetBackend Service Circuit Breaker - Compression
Mode string - Connection
Draining intTimeout Sec Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- Consistent
Hash []GetBackend Service Consistent Hash - Creation
Timestamp string - Custom
Request []stringHeaders - Custom
Response []stringHeaders - Description string
Textual description for the Backend Service.
- Edge
Security stringPolicy - Enable
Cdn bool Whether or not Cloud CDN is enabled on the Backend Service.
- Fingerprint string
The fingerprint of the Backend Service.
- Generated
Id int The unique identifier for the resource. This identifier is defined by the server.
- Health
Checks []string The set of HTTP/HTTPS health checks used by the Backend Service.
- Iaps
[]Get
Backend Service Iap - Id string
The provider-assigned unique ID for this managed resource.
- Load
Balancing stringScheme - Locality
Lb []GetPolicies Backend Service Locality Lb Policy - Locality
Lb stringPolicy - Log
Configs []GetBackend Service Log Config - Name string
- Outlier
Detections []GetBackend Service Outlier Detection - Port
Name string The name of a service that has been added to an instance group in this backend.
- Protocol string
The protocol for incoming requests.
- Security
Policy string - Security
Settings []GetBackend Service Security Setting - Self
Link string The URI of the Backend Service.
- Session
Affinity string The Backend Service session stickiness configuration.
- Timeout
Sec int The number of seconds to wait for a backend to respond to a request before considering the request failed.
- Project string
- Integer
- backends
List<Get
Backend Service Backend> The set of backends that serve this Backend Service.
- cdn
Policies List<GetBackend Service Cdn Policy> - circuit
Breakers List<GetBackend Service Circuit Breaker> - compression
Mode String - connection
Draining IntegerTimeout Sec Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent
Hash List<GetBackend Service Consistent Hash> - creation
Timestamp String - custom
Request List<String>Headers - custom
Response List<String>Headers - description String
Textual description for the Backend Service.
- edge
Security StringPolicy - enable
Cdn Boolean Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint String
The fingerprint of the Backend Service.
- generated
Id Integer The unique identifier for the resource. This identifier is defined by the server.
- health
Checks List<String> The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps
List<Get
Backend Service Iap> - id String
The provider-assigned unique ID for this managed resource.
- load
Balancing StringScheme - locality
Lb List<GetPolicies Backend Service Locality Lb Policy> - locality
Lb StringPolicy - log
Configs List<GetBackend Service Log Config> - name String
- outlier
Detections List<GetBackend Service Outlier Detection> - port
Name String The name of a service that has been added to an instance group in this backend.
- protocol String
The protocol for incoming requests.
- security
Policy String - security
Settings List<GetBackend Service Security Setting> - self
Link String The URI of the Backend Service.
- session
Affinity String The Backend Service session stickiness configuration.
- timeout
Sec Integer The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project String
- number
- backends
Get
Backend Service Backend[] The set of backends that serve this Backend Service.
- cdn
Policies GetBackend Service Cdn Policy[] - circuit
Breakers GetBackend Service Circuit Breaker[] - compression
Mode string - connection
Draining numberTimeout Sec Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent
Hash GetBackend Service Consistent Hash[] - creation
Timestamp string - custom
Request string[]Headers - custom
Response string[]Headers - description string
Textual description for the Backend Service.
- edge
Security stringPolicy - enable
Cdn boolean Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint string
The fingerprint of the Backend Service.
- generated
Id number The unique identifier for the resource. This identifier is defined by the server.
- health
Checks string[] The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps
Get
Backend Service Iap[] - id string
The provider-assigned unique ID for this managed resource.
- load
Balancing stringScheme - locality
Lb GetPolicies Backend Service Locality Lb Policy[] - locality
Lb stringPolicy - log
Configs GetBackend Service Log Config[] - name string
- outlier
Detections GetBackend Service Outlier Detection[] - port
Name string The name of a service that has been added to an instance group in this backend.
- protocol string
The protocol for incoming requests.
- security
Policy string - security
Settings GetBackend Service Security Setting[] - self
Link string The URI of the Backend Service.
- session
Affinity string The Backend Service session stickiness configuration.
- timeout
Sec number The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project string
- int
- backends
Sequence[Get
Backend Service Backend] The set of backends that serve this Backend Service.
- cdn_
policies Sequence[GetBackend Service Cdn Policy] - circuit_
breakers Sequence[GetBackend Service Circuit Breaker] - compression_
mode str - connection_
draining_ inttimeout_ sec Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent_
hash Sequence[GetBackend Service Consistent Hash] - creation_
timestamp str - custom_
request_ Sequence[str]headers - custom_
response_ Sequence[str]headers - description str
Textual description for the Backend Service.
- edge_
security_ strpolicy - enable_
cdn bool Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint str
The fingerprint of the Backend Service.
- generated_
id int The unique identifier for the resource. This identifier is defined by the server.
- health_
checks Sequence[str] The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps
Sequence[Get
Backend Service Iap] - id str
The provider-assigned unique ID for this managed resource.
- load_
balancing_ strscheme - locality_
lb_ Sequence[Getpolicies Backend Service Locality Lb Policy] - locality_
lb_ strpolicy - log_
configs Sequence[GetBackend Service Log Config] - name str
- outlier_
detections Sequence[GetBackend Service Outlier Detection] - port_
name str The name of a service that has been added to an instance group in this backend.
- protocol str
The protocol for incoming requests.
- security_
policy str - security_
settings Sequence[GetBackend Service Security Setting] - self_
link str The URI of the Backend Service.
- session_
affinity str The Backend Service session stickiness configuration.
- timeout_
sec int The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project str
- Number
- backends List<Property Map>
The set of backends that serve this Backend Service.
- cdn
Policies List<Property Map> - circuit
Breakers List<Property Map> - compression
Mode String - connection
Draining NumberTimeout Sec Time for which instance will be drained (not accept new connections, but still work to finish started ones).
- consistent
Hash List<Property Map> - creation
Timestamp String - custom
Request List<String>Headers - custom
Response List<String>Headers - description String
Textual description for the Backend Service.
- edge
Security StringPolicy - enable
Cdn Boolean Whether or not Cloud CDN is enabled on the Backend Service.
- fingerprint String
The fingerprint of the Backend Service.
- generated
Id Number The unique identifier for the resource. This identifier is defined by the server.
- health
Checks List<String> The set of HTTP/HTTPS health checks used by the Backend Service.
- iaps List<Property Map>
- id String
The provider-assigned unique ID for this managed resource.
- load
Balancing StringScheme - locality
Lb List<Property Map>Policies - locality
Lb StringPolicy - log
Configs List<Property Map> - name String
- outlier
Detections List<Property Map> - port
Name String The name of a service that has been added to an instance group in this backend.
- protocol String
The protocol for incoming requests.
- security
Policy String - security
Settings List<Property Map> - self
Link String The URI of the Backend Service.
- session
Affinity String The Backend Service session stickiness configuration.
- timeout
Sec Number The number of seconds to wait for a backend to respond to a request before considering the request failed.
- project String
Supporting Types
GetBackendServiceBackend
- Balancing
Mode string - Capacity
Scaler double - Description string
Textual description for the Backend Service.
- Group string
- Max
Connections int - Max
Connections intPer Endpoint - Max
Connections intPer Instance - Max
Rate int - Max
Rate doublePer Endpoint - Max
Rate doublePer Instance - Max
Utilization double
- Balancing
Mode string - Capacity
Scaler float64 - Description string
Textual description for the Backend Service.
- Group string
- Max
Connections int - Max
Connections intPer Endpoint - Max
Connections intPer Instance - Max
Rate int - Max
Rate float64Per Endpoint - Max
Rate float64Per Instance - Max
Utilization float64
- balancing
Mode String - capacity
Scaler Double - description String
Textual description for the Backend Service.
- group String
- max
Connections Integer - max
Connections IntegerPer Endpoint - max
Connections IntegerPer Instance - max
Rate Integer - max
Rate DoublePer Endpoint - max
Rate DoublePer Instance - max
Utilization Double
- balancing
Mode string - capacity
Scaler number - description string
Textual description for the Backend Service.
- group string
- max
Connections number - max
Connections numberPer Endpoint - max
Connections numberPer Instance - max
Rate number - max
Rate numberPer Endpoint - max
Rate numberPer Instance - max
Utilization number
- balancing_
mode str - capacity_
scaler float - description str
Textual description for the Backend Service.
- group str
- max_
connections int - max_
connections_ intper_ endpoint - max_
connections_ intper_ instance - max_
rate int - max_
rate_ floatper_ endpoint - max_
rate_ floatper_ instance - max_
utilization float
- balancing
Mode String - capacity
Scaler Number - description String
Textual description for the Backend Service.
- group String
- max
Connections Number - max
Connections NumberPer Endpoint - max
Connections NumberPer Instance - max
Rate Number - max
Rate NumberPer Endpoint - max
Rate NumberPer Instance - max
Utilization Number
GetBackendServiceCdnPolicy
- Bypass
Cache List<GetOn Request Headers Backend Service Cdn Policy Bypass Cache On Request Header> - Cache
Key List<GetPolicies Backend Service Cdn Policy Cache Key Policy> - Cache
Mode string - Client
Ttl int - Default
Ttl int - Max
Ttl int - Negative
Caching bool - Negative
Caching List<GetPolicies Backend Service Cdn Policy Negative Caching Policy> - Serve
While intStale - Signed
Url intCache Max Age Sec
- Bypass
Cache []GetOn Request Headers Backend Service Cdn Policy Bypass Cache On Request Header - Cache
Key []GetPolicies Backend Service Cdn Policy Cache Key Policy - Cache
Mode string - Client
Ttl int - Default
Ttl int - Max
Ttl int - Negative
Caching bool - Negative
Caching []GetPolicies Backend Service Cdn Policy Negative Caching Policy - Serve
While intStale - Signed
Url intCache Max Age Sec
- bypass
Cache List<GetOn Request Headers Backend Service Cdn Policy Bypass Cache On Request Header> - cache
Key List<GetPolicies Backend Service Cdn Policy Cache Key Policy> - cache
Mode String - client
Ttl Integer - default
Ttl Integer - max
Ttl Integer - negative
Caching Boolean - negative
Caching List<GetPolicies Backend Service Cdn Policy Negative Caching Policy> - serve
While IntegerStale - signed
Url IntegerCache Max Age Sec
- bypass
Cache GetOn Request Headers Backend Service Cdn Policy Bypass Cache On Request Header[] - cache
Key GetPolicies Backend Service Cdn Policy Cache Key Policy[] - cache
Mode string - client
Ttl number - default
Ttl number - max
Ttl number - negative
Caching boolean - negative
Caching GetPolicies Backend Service Cdn Policy Negative Caching Policy[] - serve
While numberStale - signed
Url numberCache Max Age Sec
- bypass_
cache_ Sequence[Geton_ request_ headers Backend Service Cdn Policy Bypass Cache On Request Header] - cache_
key_ Sequence[Getpolicies Backend Service Cdn Policy Cache Key Policy] - cache_
mode str - client_
ttl int - default_
ttl int - max_
ttl int - negative_
caching bool - negative_
caching_ Sequence[Getpolicies Backend Service Cdn Policy Negative Caching Policy] - serve_
while_ intstale - signed_
url_ intcache_ max_ age_ sec
- bypass
Cache List<Property Map>On Request Headers - cache
Key List<Property Map>Policies - cache
Mode String - client
Ttl Number - default
Ttl Number - max
Ttl Number - negative
Caching Boolean - negative
Caching List<Property Map>Policies - serve
While NumberStale - signed
Url NumberCache Max Age Sec
GetBackendServiceCdnPolicyBypassCacheOnRequestHeader
- Header
Name string
- Header
Name string
- header
Name String
- header
Name string
- header_
name str
- header
Name String
GetBackendServiceCdnPolicyCacheKeyPolicy
- Include
Host bool - Include
Http List<string>Headers - List<string>
- Include
Protocol bool - Include
Query boolString - Query
String List<string>Blacklists - Query
String List<string>Whitelists
- Include
Host bool - Include
Http []stringHeaders - []string
- Include
Protocol bool - Include
Query boolString - Query
String []stringBlacklists - Query
String []stringWhitelists
- include
Host Boolean - include
Http List<String>Headers - List<String>
- include
Protocol Boolean - include
Query BooleanString - query
String List<String>Blacklists - query
String List<String>Whitelists
- include
Host boolean - include
Http string[]Headers - string[]
- include
Protocol boolean - include
Query booleanString - query
String string[]Blacklists - query
String string[]Whitelists
- include_
host bool - include_
http_ Sequence[str]headers - Sequence[str]
- include_
protocol bool - include_
query_ boolstring - query_
string_ Sequence[str]blacklists - query_
string_ Sequence[str]whitelists
- include
Host Boolean - include
Http List<String>Headers - List<String>
- include
Protocol Boolean - include
Query BooleanString - query
String List<String>Blacklists - query
String List<String>Whitelists
GetBackendServiceCdnPolicyNegativeCachingPolicy
GetBackendServiceCircuitBreaker
- connect
Timeouts List<GetBackend Service Circuit Breaker Connect Timeout> - max
Connections Integer - max
Pending IntegerRequests - max
Requests Integer - max
Requests IntegerPer Connection - max
Retries Integer
- connect
Timeouts GetBackend Service Circuit Breaker Connect Timeout[] - max
Connections number - max
Pending numberRequests - max
Requests number - max
Requests numberPer Connection - max
Retries number
- connect
Timeouts List<Property Map> - max
Connections Number - max
Pending NumberRequests - max
Requests Number - max
Requests NumberPer Connection - max
Retries Number
GetBackendServiceCircuitBreakerConnectTimeout
GetBackendServiceConsistentHash
- List<Property Map>
- http
Header StringName - minimum
Ring NumberSize
GetBackendServiceConsistentHashHttpCooky
- Name string
The name of the Backend Service.
- Path string
- Ttls
List<Get
Backend Service Consistent Hash Http Cooky Ttl>
- Name string
The name of the Backend Service.
- Path string
- Ttls
[]Get
Backend Service Consistent Hash Http Cooky Ttl
- name String
The name of the Backend Service.
- path String
- ttls
List<Get
Backend Service Consistent Hash Http Cooky Ttl>
- name string
The name of the Backend Service.
- path string
- ttls
Get
Backend Service Consistent Hash Http Cooky Ttl[]
- name str
The name of the Backend Service.
- path str
- ttls
Sequence[Get
Backend Service Consistent Hash Http Cooky Ttl]
- name String
The name of the Backend Service.
- path String
- ttls List<Property Map>
GetBackendServiceConsistentHashHttpCookyTtl
GetBackendServiceIap
- Oauth2Client
Id string - Oauth2Client
Secret string - Oauth2Client
Secret stringSha256
- Oauth2Client
Id string - Oauth2Client
Secret string - Oauth2Client
Secret stringSha256
- oauth2Client
Id String - oauth2Client
Secret String - oauth2Client
Secret StringSha256
- oauth2Client
Id string - oauth2Client
Secret string - oauth2Client
Secret stringSha256
- oauth2Client
Id String - oauth2Client
Secret String - oauth2Client
Secret StringSha256
GetBackendServiceLocalityLbPolicy
GetBackendServiceLocalityLbPolicyCustomPolicy
GetBackendServiceLocalityLbPolicyPolicy
- Name string
The name of the Backend Service.
- Name string
The name of the Backend Service.
- name String
The name of the Backend Service.
- name string
The name of the Backend Service.
- name str
The name of the Backend Service.
- name String
The name of the Backend Service.
GetBackendServiceLogConfig
- Enable bool
- Sample
Rate double
- Enable bool
- Sample
Rate float64
- enable Boolean
- sample
Rate Double
- enable boolean
- sample
Rate number
- enable bool
- sample_
rate float
- enable Boolean
- sample
Rate Number
GetBackendServiceOutlierDetection
- Base
Ejection List<GetTimes Backend Service Outlier Detection Base Ejection Time> - Consecutive
Errors int - Consecutive
Gateway intFailure - Enforcing
Consecutive intErrors - Enforcing
Consecutive intGateway Failure - Enforcing
Success intRate - Intervals
List<Get
Backend Service Outlier Detection Interval> - Max
Ejection intPercent - Success
Rate intMinimum Hosts - Success
Rate intRequest Volume - Success
Rate intStdev Factor
- Base
Ejection []GetTimes Backend Service Outlier Detection Base Ejection Time - Consecutive
Errors int - Consecutive
Gateway intFailure - Enforcing
Consecutive intErrors - Enforcing
Consecutive intGateway Failure - Enforcing
Success intRate - Intervals
[]Get
Backend Service Outlier Detection Interval - Max
Ejection intPercent - Success
Rate intMinimum Hosts - Success
Rate intRequest Volume - Success
Rate intStdev Factor
- base
Ejection List<GetTimes Backend Service Outlier Detection Base Ejection Time> - consecutive
Errors Integer - consecutive
Gateway IntegerFailure - enforcing
Consecutive IntegerErrors - enforcing
Consecutive IntegerGateway Failure - enforcing
Success IntegerRate - intervals
List<Get
Backend Service Outlier Detection Interval> - max
Ejection IntegerPercent - success
Rate IntegerMinimum Hosts - success
Rate IntegerRequest Volume - success
Rate IntegerStdev Factor
- base
Ejection GetTimes Backend Service Outlier Detection Base Ejection Time[] - consecutive
Errors number - consecutive
Gateway numberFailure - enforcing
Consecutive numberErrors - enforcing
Consecutive numberGateway Failure - enforcing
Success numberRate - intervals
Get
Backend Service Outlier Detection Interval[] - max
Ejection numberPercent - success
Rate numberMinimum Hosts - success
Rate numberRequest Volume - success
Rate numberStdev Factor
- base_
ejection_ Sequence[Gettimes Backend Service Outlier Detection Base Ejection Time] - consecutive_
errors int - consecutive_
gateway_ intfailure - enforcing_
consecutive_ interrors - enforcing_
consecutive_ intgateway_ failure - enforcing_
success_ intrate - intervals
Sequence[Get
Backend Service Outlier Detection Interval] - max_
ejection_ intpercent - success_
rate_ intminimum_ hosts - success_
rate_ intrequest_ volume - success_
rate_ intstdev_ factor
- base
Ejection List<Property Map>Times - consecutive
Errors Number - consecutive
Gateway NumberFailure - enforcing
Consecutive NumberErrors - enforcing
Consecutive NumberGateway Failure - enforcing
Success NumberRate - intervals List<Property Map>
- max
Ejection NumberPercent - success
Rate NumberMinimum Hosts - success
Rate NumberRequest Volume - success
Rate NumberStdev Factor
GetBackendServiceOutlierDetectionBaseEjectionTime
GetBackendServiceOutlierDetectionInterval
GetBackendServiceSecuritySetting
- Client
Tls stringPolicy - Subject
Alt List<string>Names
- Client
Tls stringPolicy - Subject
Alt []stringNames
- client
Tls StringPolicy - subject
Alt List<String>Names
- client
Tls stringPolicy - subject
Alt string[]Names
- client_
tls_ strpolicy - subject_
alt_ Sequence[str]names
- client
Tls StringPolicy - subject
Alt List<String>Names
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.