1. Packages
  2. Scaleway
  3. API Docs
  4. getLbFrontends
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

scaleway.getLbFrontends

Explore with Pulumi AI

scaleway logo
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

    Gets information about multiple Load Balancer frontends.

    For more information, see the main documentation or API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumi/scaleway";
    
    // Find frontends that share the same LB ID
    const byLBID = scaleway.getLbFrontends({
        lbId: lb01.id,
    });
    // Find frontends by LB ID and name
    const byLBIDAndName = scaleway.getLbFrontends({
        lbId: lb01.id,
        name: "tf-frontend-datasource",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    # Find frontends that share the same LB ID
    by_lbid = scaleway.get_lb_frontends(lb_id=lb01["id"])
    # Find frontends by LB ID and name
    by_lbid_and_name = scaleway.get_lb_frontends(lb_id=lb01["id"],
        name="tf-frontend-datasource")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Find frontends that share the same LB ID
    		_, err := scaleway.GetLbFrontends(ctx, &scaleway.GetLbFrontendsArgs{
    			LbId: lb01.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Find frontends by LB ID and name
    		_, err = scaleway.GetLbFrontends(ctx, &scaleway.GetLbFrontendsArgs{
    			LbId: lb01.Id,
    			Name: pulumi.StringRef("tf-frontend-datasource"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumi.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        // Find frontends that share the same LB ID
        var byLBID = Scaleway.GetLbFrontends.Invoke(new()
        {
            LbId = lb01.Id,
        });
    
        // Find frontends by LB ID and name
        var byLBIDAndName = Scaleway.GetLbFrontends.Invoke(new()
        {
            LbId = lb01.Id,
            Name = "tf-frontend-datasource",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.ScalewayFunctions;
    import com.pulumi.scaleway.inputs.GetLbFrontendsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Find frontends that share the same LB ID
            final var byLBID = ScalewayFunctions.getLbFrontends(GetLbFrontendsArgs.builder()
                .lbId(lb01.id())
                .build());
    
            // Find frontends by LB ID and name
            final var byLBIDAndName = ScalewayFunctions.getLbFrontends(GetLbFrontendsArgs.builder()
                .lbId(lb01.id())
                .name("tf-frontend-datasource")
                .build());
    
        }
    }
    
    variables:
      # Find frontends that share the same LB ID
      byLBID:
        fn::invoke:
          Function: scaleway:getLbFrontends
          Arguments:
            lbId: ${lb01.id}
      # Find frontends by LB ID and name
      byLBIDAndName:
        fn::invoke:
          Function: scaleway:getLbFrontends
          Arguments:
            lbId: ${lb01.id}
            name: tf-frontend-datasource
    

    Using getLbFrontends

    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 getLbFrontends(args: GetLbFrontendsArgs, opts?: InvokeOptions): Promise<GetLbFrontendsResult>
    function getLbFrontendsOutput(args: GetLbFrontendsOutputArgs, opts?: InvokeOptions): Output<GetLbFrontendsResult>
    def get_lb_frontends(lb_id: Optional[str] = None,
                         name: Optional[str] = None,
                         project_id: Optional[str] = None,
                         zone: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetLbFrontendsResult
    def get_lb_frontends_output(lb_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         zone: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetLbFrontendsResult]
    func GetLbFrontends(ctx *Context, args *GetLbFrontendsArgs, opts ...InvokeOption) (*GetLbFrontendsResult, error)
    func GetLbFrontendsOutput(ctx *Context, args *GetLbFrontendsOutputArgs, opts ...InvokeOption) GetLbFrontendsResultOutput

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

    public static class GetLbFrontends 
    {
        public static Task<GetLbFrontendsResult> InvokeAsync(GetLbFrontendsArgs args, InvokeOptions? opts = null)
        public static Output<GetLbFrontendsResult> Invoke(GetLbFrontendsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLbFrontendsResult> getLbFrontends(GetLbFrontendsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scaleway:index/getLbFrontends:getLbFrontends
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LbId string
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    Name string
    The frontend name to filter for. Frontends with a matching name are listed.
    ProjectId string
    Zone string
    zone) The zone in which the frontends exist.
    LbId string
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    Name string
    The frontend name to filter for. Frontends with a matching name are listed.
    ProjectId string
    Zone string
    zone) The zone in which the frontends exist.
    lbId String
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name String
    The frontend name to filter for. Frontends with a matching name are listed.
    projectId String
    zone String
    zone) The zone in which the frontends exist.
    lbId string
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name string
    The frontend name to filter for. Frontends with a matching name are listed.
    projectId string
    zone string
    zone) The zone in which the frontends exist.
    lb_id str
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name str
    The frontend name to filter for. Frontends with a matching name are listed.
    project_id str
    zone str
    zone) The zone in which the frontends exist.
    lbId String
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name String
    The frontend name to filter for. Frontends with a matching name are listed.
    projectId String
    zone String
    zone) The zone in which the frontends exist.

    getLbFrontends Result

    The following output properties are available:

    Frontends List<Pulumiverse.Scaleway.Outputs.GetLbFrontendsFrontend>
    List of retrieved frontends
    Id string
    The provider-assigned unique ID for this managed resource.
    LbId string
    OrganizationId string
    ProjectId string
    Zone string
    Name string
    Frontends []GetLbFrontendsFrontend
    List of retrieved frontends
    Id string
    The provider-assigned unique ID for this managed resource.
    LbId string
    OrganizationId string
    ProjectId string
    Zone string
    Name string
    frontends List<GetLbFrontendsFrontend>
    List of retrieved frontends
    id String
    The provider-assigned unique ID for this managed resource.
    lbId String
    organizationId String
    projectId String
    zone String
    name String
    frontends GetLbFrontendsFrontend[]
    List of retrieved frontends
    id string
    The provider-assigned unique ID for this managed resource.
    lbId string
    organizationId string
    projectId string
    zone string
    name string
    frontends Sequence[GetLbFrontendsFrontend]
    List of retrieved frontends
    id str
    The provider-assigned unique ID for this managed resource.
    lb_id str
    organization_id str
    project_id str
    zone str
    name str
    frontends List<Property Map>
    List of retrieved frontends
    id String
    The provider-assigned unique ID for this managed resource.
    lbId String
    organizationId String
    projectId String
    zone String
    name String

    Supporting Types

    GetLbFrontendsFrontend

    BackendId string

    The Load Balancer backend ID this frontend is attached to.

    Important: Load Balancer backend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    CertificateIds List<string>
    List of certificate IDs that are used by the frontend.
    CreatedAt string
    The date on which the frontend was created (RFC 3339 format).
    EnableHttp3 bool
    Whether HTTP/3 protocol is activated.
    Id string

    The ID of the associated frontend.

    Important: LB frontend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    InboundPort int
    TCP port the frontend listens to.
    LbId string
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    Name string
    The frontend name to filter for. Frontends with a matching name are listed.
    TimeoutClient string
    Maximum inactivity time on the client side.
    UpdateAt string
    The date aont which the frontend was last updated (RFC 3339 format).
    BackendId string

    The Load Balancer backend ID this frontend is attached to.

    Important: Load Balancer backend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    CertificateIds []string
    List of certificate IDs that are used by the frontend.
    CreatedAt string
    The date on which the frontend was created (RFC 3339 format).
    EnableHttp3 bool
    Whether HTTP/3 protocol is activated.
    Id string

    The ID of the associated frontend.

    Important: LB frontend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    InboundPort int
    TCP port the frontend listens to.
    LbId string
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    Name string
    The frontend name to filter for. Frontends with a matching name are listed.
    TimeoutClient string
    Maximum inactivity time on the client side.
    UpdateAt string
    The date aont which the frontend was last updated (RFC 3339 format).
    backendId String

    The Load Balancer backend ID this frontend is attached to.

    Important: Load Balancer backend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    certificateIds List<String>
    List of certificate IDs that are used by the frontend.
    createdAt String
    The date on which the frontend was created (RFC 3339 format).
    enableHttp3 Boolean
    Whether HTTP/3 protocol is activated.
    id String

    The ID of the associated frontend.

    Important: LB frontend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    inboundPort Integer
    TCP port the frontend listens to.
    lbId String
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name String
    The frontend name to filter for. Frontends with a matching name are listed.
    timeoutClient String
    Maximum inactivity time on the client side.
    updateAt String
    The date aont which the frontend was last updated (RFC 3339 format).
    backendId string

    The Load Balancer backend ID this frontend is attached to.

    Important: Load Balancer backend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    certificateIds string[]
    List of certificate IDs that are used by the frontend.
    createdAt string
    The date on which the frontend was created (RFC 3339 format).
    enableHttp3 boolean
    Whether HTTP/3 protocol is activated.
    id string

    The ID of the associated frontend.

    Important: LB frontend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    inboundPort number
    TCP port the frontend listens to.
    lbId string
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name string
    The frontend name to filter for. Frontends with a matching name are listed.
    timeoutClient string
    Maximum inactivity time on the client side.
    updateAt string
    The date aont which the frontend was last updated (RFC 3339 format).
    backend_id str

    The Load Balancer backend ID this frontend is attached to.

    Important: Load Balancer backend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    certificate_ids Sequence[str]
    List of certificate IDs that are used by the frontend.
    created_at str
    The date on which the frontend was created (RFC 3339 format).
    enable_http3 bool
    Whether HTTP/3 protocol is activated.
    id str

    The ID of the associated frontend.

    Important: LB frontend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    inbound_port int
    TCP port the frontend listens to.
    lb_id str
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name str
    The frontend name to filter for. Frontends with a matching name are listed.
    timeout_client str
    Maximum inactivity time on the client side.
    update_at str
    The date aont which the frontend was last updated (RFC 3339 format).
    backendId String

    The Load Balancer backend ID this frontend is attached to.

    Important: Load Balancer backend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    certificateIds List<String>
    List of certificate IDs that are used by the frontend.
    createdAt String
    The date on which the frontend was created (RFC 3339 format).
    enableHttp3 Boolean
    Whether HTTP/3 protocol is activated.
    id String

    The ID of the associated frontend.

    Important: LB frontend IDs are zoned, which means they are of the form {zone}/{id}, e.g. fr-par-1/11111111-1111-1111-1111-111111111111

    inboundPort Number
    TCP port the frontend listens to.
    lbId String
    The Load Balancer ID this frontend is attached to. Frontends with a matching ID are listed.
    name String
    The frontend name to filter for. Frontends with a matching name are listed.
    timeoutClient String
    Maximum inactivity time on the client side.
    updateAt String
    The date aont which the frontend was last updated (RFC 3339 format).

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse