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

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

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 a single ServiceLbPolicy.

    Using getServiceLbPolicy

    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 getServiceLbPolicy(args: GetServiceLbPolicyArgs, opts?: InvokeOptions): Promise<GetServiceLbPolicyResult>
    function getServiceLbPolicyOutput(args: GetServiceLbPolicyOutputArgs, opts?: InvokeOptions): Output<GetServiceLbPolicyResult>
    def get_service_lb_policy(location: Optional[str] = None,
                              project: Optional[str] = None,
                              service_lb_policy_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetServiceLbPolicyResult
    def get_service_lb_policy_output(location: Optional[pulumi.Input[str]] = None,
                              project: Optional[pulumi.Input[str]] = None,
                              service_lb_policy_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetServiceLbPolicyResult]
    func LookupServiceLbPolicy(ctx *Context, args *LookupServiceLbPolicyArgs, opts ...InvokeOption) (*LookupServiceLbPolicyResult, error)
    func LookupServiceLbPolicyOutput(ctx *Context, args *LookupServiceLbPolicyOutputArgs, opts ...InvokeOption) LookupServiceLbPolicyResultOutput

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

    public static class GetServiceLbPolicy 
    {
        public static Task<GetServiceLbPolicyResult> InvokeAsync(GetServiceLbPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceLbPolicyResult> Invoke(GetServiceLbPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceLbPolicyResult> getServiceLbPolicy(GetServiceLbPolicyArgs args, InvokeOptions options)
    public static Output<GetServiceLbPolicyResult> getServiceLbPolicy(GetServiceLbPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: google-native:networkservices/v1beta1:getServiceLbPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getServiceLbPolicy Result

    The following output properties are available:

    AutoCapacityDrain Pulumi.GoogleNative.NetworkServices.V1Beta1.Outputs.ServiceLbPolicyAutoCapacityDrainResponse
    Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    CreateTime string
    The timestamp when this resource was created.
    Description string
    Optional. A free-text description of the resource. Max length 1024 characters.
    FailoverConfig Pulumi.GoogleNative.NetworkServices.V1Beta1.Outputs.ServiceLbPolicyFailoverConfigResponse
    Optional. Configuration related to health based failover.
    Labels Dictionary<string, string>
    Optional. Set of label tags associated with the ServiceLbPolicy resource.
    LoadBalancingAlgorithm string
    Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
    Name string
    Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.
    UpdateTime string
    The timestamp when this resource was last updated.
    AutoCapacityDrain ServiceLbPolicyAutoCapacityDrainResponse
    Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    CreateTime string
    The timestamp when this resource was created.
    Description string
    Optional. A free-text description of the resource. Max length 1024 characters.
    FailoverConfig ServiceLbPolicyFailoverConfigResponse
    Optional. Configuration related to health based failover.
    Labels map[string]string
    Optional. Set of label tags associated with the ServiceLbPolicy resource.
    LoadBalancingAlgorithm string
    Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
    Name string
    Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.
    UpdateTime string
    The timestamp when this resource was last updated.
    autoCapacityDrain ServiceLbPolicyAutoCapacityDrainResponse
    Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    createTime String
    The timestamp when this resource was created.
    description String
    Optional. A free-text description of the resource. Max length 1024 characters.
    failoverConfig ServiceLbPolicyFailoverConfigResponse
    Optional. Configuration related to health based failover.
    labels Map<String,String>
    Optional. Set of label tags associated with the ServiceLbPolicy resource.
    loadBalancingAlgorithm String
    Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
    name String
    Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.
    updateTime String
    The timestamp when this resource was last updated.
    autoCapacityDrain ServiceLbPolicyAutoCapacityDrainResponse
    Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    createTime string
    The timestamp when this resource was created.
    description string
    Optional. A free-text description of the resource. Max length 1024 characters.
    failoverConfig ServiceLbPolicyFailoverConfigResponse
    Optional. Configuration related to health based failover.
    labels {[key: string]: string}
    Optional. Set of label tags associated with the ServiceLbPolicy resource.
    loadBalancingAlgorithm string
    Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
    name string
    Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.
    updateTime string
    The timestamp when this resource was last updated.
    auto_capacity_drain ServiceLbPolicyAutoCapacityDrainResponse
    Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    create_time str
    The timestamp when this resource was created.
    description str
    Optional. A free-text description of the resource. Max length 1024 characters.
    failover_config ServiceLbPolicyFailoverConfigResponse
    Optional. Configuration related to health based failover.
    labels Mapping[str, str]
    Optional. Set of label tags associated with the ServiceLbPolicy resource.
    load_balancing_algorithm str
    Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
    name str
    Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.
    update_time str
    The timestamp when this resource was last updated.
    autoCapacityDrain Property Map
    Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    createTime String
    The timestamp when this resource was created.
    description String
    Optional. A free-text description of the resource. Max length 1024 characters.
    failoverConfig Property Map
    Optional. Configuration related to health based failover.
    labels Map<String>
    Optional. Set of label tags associated with the ServiceLbPolicy resource.
    loadBalancingAlgorithm String
    Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
    name String
    Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.
    updateTime String
    The timestamp when this resource was last updated.

    Supporting Types

    ServiceLbPolicyAutoCapacityDrainResponse

    Enable bool
    Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
    Enable bool
    Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
    enable Boolean
    Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
    enable boolean
    Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
    enable bool
    Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
    enable Boolean
    Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.

    ServiceLbPolicyFailoverConfigResponse

    FailoverHealthThreshold int
    Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
    FailoverHealthThreshold int
    Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
    failoverHealthThreshold Integer
    Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
    failoverHealthThreshold number
    Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
    failover_health_threshold int
    Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
    failoverHealthThreshold Number
    Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.

    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