1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networkservices
  5. networkservices/v1beta1
  6. getLbTrafficExtension

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.networkservices/v1beta1.getLbTrafficExtension

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Gets details of the specified LbTrafficExtension resource.

Using getLbTrafficExtension

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 getLbTrafficExtension(args: GetLbTrafficExtensionArgs, opts?: InvokeOptions): Promise<GetLbTrafficExtensionResult>
function getLbTrafficExtensionOutput(args: GetLbTrafficExtensionOutputArgs, opts?: InvokeOptions): Output<GetLbTrafficExtensionResult>
Copy
def get_lb_traffic_extension(lb_traffic_extension_id: Optional[str] = None,
                             location: Optional[str] = None,
                             project: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetLbTrafficExtensionResult
def get_lb_traffic_extension_output(lb_traffic_extension_id: Optional[pulumi.Input[str]] = None,
                             location: Optional[pulumi.Input[str]] = None,
                             project: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetLbTrafficExtensionResult]
Copy
func LookupLbTrafficExtension(ctx *Context, args *LookupLbTrafficExtensionArgs, opts ...InvokeOption) (*LookupLbTrafficExtensionResult, error)
func LookupLbTrafficExtensionOutput(ctx *Context, args *LookupLbTrafficExtensionOutputArgs, opts ...InvokeOption) LookupLbTrafficExtensionResultOutput
Copy

> Note: This function is named LookupLbTrafficExtension in the Go SDK.

public static class GetLbTrafficExtension 
{
    public static Task<GetLbTrafficExtensionResult> InvokeAsync(GetLbTrafficExtensionArgs args, InvokeOptions? opts = null)
    public static Output<GetLbTrafficExtensionResult> Invoke(GetLbTrafficExtensionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLbTrafficExtensionResult> getLbTrafficExtension(GetLbTrafficExtensionArgs args, InvokeOptions options)
public static Output<GetLbTrafficExtensionResult> getLbTrafficExtension(GetLbTrafficExtensionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:networkservices/v1beta1:getLbTrafficExtension
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LbTrafficExtensionId This property is required. string
Location This property is required. string
Project string
LbTrafficExtensionId This property is required. string
Location This property is required. string
Project string
lbTrafficExtensionId This property is required. String
location This property is required. String
project String
lbTrafficExtensionId This property is required. string
location This property is required. string
project string
lb_traffic_extension_id This property is required. str
location This property is required. str
project str
lbTrafficExtensionId This property is required. String
location This property is required. String
project String

getLbTrafficExtension Result

The following output properties are available:

CreateTime string
The timestamp when the resource was created.
Description string
Optional. A human-readable description of the resource.
ExtensionChains List<Pulumi.GoogleNative.NetworkServices.V1Beta1.Outputs.ExtensionChainResponse>
A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
ForwardingRules List<string>
A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.
Labels Dictionary<string, string>
Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the following requirements.
LoadBalancingScheme string
All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
Name string
Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
UpdateTime string
The timestamp when the resource was updated.
CreateTime string
The timestamp when the resource was created.
Description string
Optional. A human-readable description of the resource.
ExtensionChains []ExtensionChainResponse
A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
ForwardingRules []string
A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.
Labels map[string]string
Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the following requirements.
LoadBalancingScheme string
All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
Name string
Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
UpdateTime string
The timestamp when the resource was updated.
createTime String
The timestamp when the resource was created.
description String
Optional. A human-readable description of the resource.
extensionChains List<ExtensionChainResponse>
A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
forwardingRules List<String>
A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.
labels Map<String,String>
Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the following requirements.
loadBalancingScheme String
All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
name String
Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
updateTime String
The timestamp when the resource was updated.
createTime string
The timestamp when the resource was created.
description string
Optional. A human-readable description of the resource.
extensionChains ExtensionChainResponse[]
A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
forwardingRules string[]
A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.
labels {[key: string]: string}
Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the following requirements.
loadBalancingScheme string
All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
name string
Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
updateTime string
The timestamp when the resource was updated.
create_time str
The timestamp when the resource was created.
description str
Optional. A human-readable description of the resource.
extension_chains Sequence[ExtensionChainResponse]
A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
forwarding_rules Sequence[str]
A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.
labels Mapping[str, str]
Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the following requirements.
load_balancing_scheme str
All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
name str
Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
update_time str
The timestamp when the resource was updated.
createTime String
The timestamp when the resource was created.
description String
Optional. A human-readable description of the resource.
extensionChains List<Property Map>
A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
forwardingRules List<String>
A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.
labels Map<String>
Optional. Set of labels associated with the LbTrafficExtension resource. The format must comply with the following requirements.
loadBalancingScheme String
All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.
name String
Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.
updateTime String
The timestamp when the resource was updated.

Supporting Types

ExtensionChainExtensionResponse

Authority This property is required. string
The :authority header in the gRPC request sent from Envoy to the extension service.
FailOpen This property is required. bool
Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE.
ForwardHeaders This property is required. List<string>
Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
Name This property is required. string
The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
Service This property is required. string
The reference to the service that runs the extension. Must be a reference to a backend service.
SupportedEvents This property is required. List<string>
Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource.
Timeout This property is required. string
Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.
Authority This property is required. string
The :authority header in the gRPC request sent from Envoy to the extension service.
FailOpen This property is required. bool
Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE.
ForwardHeaders This property is required. []string
Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
Name This property is required. string
The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
Service This property is required. string
The reference to the service that runs the extension. Must be a reference to a backend service.
SupportedEvents This property is required. []string
Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource.
Timeout This property is required. string
Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.
authority This property is required. String
The :authority header in the gRPC request sent from Envoy to the extension service.
failOpen This property is required. Boolean
Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE.
forwardHeaders This property is required. List<String>
Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
name This property is required. String
The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
service This property is required. String
The reference to the service that runs the extension. Must be a reference to a backend service.
supportedEvents This property is required. List<String>
Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource.
timeout This property is required. String
Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.
authority This property is required. string
The :authority header in the gRPC request sent from Envoy to the extension service.
failOpen This property is required. boolean
Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE.
forwardHeaders This property is required. string[]
Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
name This property is required. string
The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
service This property is required. string
The reference to the service that runs the extension. Must be a reference to a backend service.
supportedEvents This property is required. string[]
Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource.
timeout This property is required. string
Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.
authority This property is required. str
The :authority header in the gRPC request sent from Envoy to the extension service.
fail_open This property is required. bool
Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE.
forward_headers This property is required. Sequence[str]
Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
name This property is required. str
The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
service This property is required. str
The reference to the service that runs the extension. Must be a reference to a backend service.
supported_events This property is required. Sequence[str]
Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource.
timeout This property is required. str
Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.
authority This property is required. String
The :authority header in the gRPC request sent from Envoy to the extension service.
failOpen This property is required. Boolean
Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE.
forwardHeaders This property is required. List<String>
Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
name This property is required. String
The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
service This property is required. String
The reference to the service that runs the extension. Must be a reference to a backend service.
supportedEvents This property is required. List<String>
Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource.
timeout This property is required. String
Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.

ExtensionChainMatchConditionResponse

CelExpression This property is required. string
A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.
CelExpression This property is required. string
A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.
celExpression This property is required. String
A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.
celExpression This property is required. string
A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.
cel_expression This property is required. str
A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.
celExpression This property is required. String
A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.

ExtensionChainResponse

Extensions This property is required. List<Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.ExtensionChainExtensionResponse>
A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.
MatchCondition This property is required. Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.ExtensionChainMatchConditionResponse
Conditions under which this chain is invoked for a request.
Name This property is required. string
The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
Extensions This property is required. []ExtensionChainExtensionResponse
A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.
MatchCondition This property is required. ExtensionChainMatchConditionResponse
Conditions under which this chain is invoked for a request.
Name This property is required. string
The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
extensions This property is required. List<ExtensionChainExtensionResponse>
A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.
matchCondition This property is required. ExtensionChainMatchConditionResponse
Conditions under which this chain is invoked for a request.
name This property is required. String
The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
extensions This property is required. ExtensionChainExtensionResponse[]
A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.
matchCondition This property is required. ExtensionChainMatchConditionResponse
Conditions under which this chain is invoked for a request.
name This property is required. string
The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
extensions This property is required. Sequence[ExtensionChainExtensionResponse]
A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.
match_condition This property is required. ExtensionChainMatchConditionResponse
Conditions under which this chain is invoked for a request.
name This property is required. str
The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
extensions This property is required. List<Property Map>
A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for LbTrafficExtension resource. LbRouteExtension chains are limited to 1 extension per extension chain.
matchCondition This property is required. Property Map
Conditions under which this chain is invoked for a request.
name This property is required. String
The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi