Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
scaleway.getLoadbalancer
Explore with Pulumi AI
Gets information about a Load Balancer.
For more information, see the main documentation or API documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";
// Get info by name
const byName = scaleway.getLoadbalancer({
name: "foobar",
});
// Get info by ID
const byId = scaleway.getLoadbalancer({
lbId: "11111111-1111-1111-1111-111111111111",
});
import pulumi
import pulumi_scaleway as scaleway
# Get info by name
by_name = scaleway.get_loadbalancer(name="foobar")
# Get info by ID
by_id = scaleway.get_loadbalancer(lb_id="11111111-1111-1111-1111-111111111111")
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 {
// Get info by name
_, err := scaleway.LookupLoadbalancer(ctx, &scaleway.LookupLoadbalancerArgs{
Name: pulumi.StringRef("foobar"),
}, nil)
if err != nil {
return err
}
// Get info by ID
_, err = scaleway.LookupLoadbalancer(ctx, &scaleway.LookupLoadbalancerArgs{
LbId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
}, 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(() =>
{
// Get info by name
var byName = Scaleway.GetLoadbalancer.Invoke(new()
{
Name = "foobar",
});
// Get info by ID
var byId = Scaleway.GetLoadbalancer.Invoke(new()
{
LbId = "11111111-1111-1111-1111-111111111111",
});
});
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.GetLoadbalancerArgs;
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) {
// Get info by name
final var byName = ScalewayFunctions.getLoadbalancer(GetLoadbalancerArgs.builder()
.name("foobar")
.build());
// Get info by ID
final var byId = ScalewayFunctions.getLoadbalancer(GetLoadbalancerArgs.builder()
.lbId("11111111-1111-1111-1111-111111111111")
.build());
}
}
variables:
# Get info by name
byName:
fn::invoke:
Function: scaleway:getLoadbalancer
Arguments:
name: foobar
# Get info by ID
byId:
fn::invoke:
Function: scaleway:getLoadbalancer
Arguments:
lbId: 11111111-1111-1111-1111-111111111111
Using getLoadbalancer
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 getLoadbalancer(args: GetLoadbalancerArgs, opts?: InvokeOptions): Promise<GetLoadbalancerResult>
function getLoadbalancerOutput(args: GetLoadbalancerOutputArgs, opts?: InvokeOptions): Output<GetLoadbalancerResult>
def get_loadbalancer(lb_id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
release_ip: Optional[bool] = None,
zone: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetLoadbalancerResult
def get_loadbalancer_output(lb_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
release_ip: Optional[pulumi.Input[bool]] = None,
zone: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetLoadbalancerResult]
func LookupLoadbalancer(ctx *Context, args *LookupLoadbalancerArgs, opts ...InvokeOption) (*LookupLoadbalancerResult, error)
func LookupLoadbalancerOutput(ctx *Context, args *LookupLoadbalancerOutputArgs, opts ...InvokeOption) LookupLoadbalancerResultOutput
> Note: This function is named LookupLoadbalancer
in the Go SDK.
public static class GetLoadbalancer
{
public static Task<GetLoadbalancerResult> InvokeAsync(GetLoadbalancerArgs args, InvokeOptions? opts = null)
public static Output<GetLoadbalancerResult> Invoke(GetLoadbalancerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLoadbalancerResult> getLoadbalancer(GetLoadbalancerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: scaleway:index/getLoadbalancer:getLoadbalancer
arguments:
# arguments dictionary
The following arguments are supported:
- lb_
id str - name str
- The Load Balancer name.
- project_
id str - The ID of the Project the Load Balancer is associated with.
- release_
ip bool - zone str
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
getLoadbalancer Result
The following output properties are available:
- Assign
Flexible boolIp - Assign
Flexible boolIpv6 - Description string
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string - The Load Balancer public IP address.
- Ip
Id string - Ip
Ids List<string> - Ipv6Address string
- Organization
Id string - Private
Networks List<Pulumiverse.Scaleway. Outputs. Get Loadbalancer Private Network> - Region string
- Ssl
Compatibility stringLevel - List<string>
- The tags associated with the Load Balancer.
- Type string
- The Load Balancer type.
- Lb
Id string - Name string
- Project
Id string - Release
Ip bool - Zone string
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- Assign
Flexible boolIp - Assign
Flexible boolIpv6 - Description string
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string - The Load Balancer public IP address.
- Ip
Id string - Ip
Ids []string - Ipv6Address string
- Organization
Id string - Private
Networks []GetLoadbalancer Private Network - Region string
- Ssl
Compatibility stringLevel - []string
- The tags associated with the Load Balancer.
- Type string
- The Load Balancer type.
- Lb
Id string - Name string
- Project
Id string - Release
Ip bool - Zone string
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- assign
Flexible BooleanIp - assign
Flexible BooleanIpv6 - description String
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address String - The Load Balancer public IP address.
- ip
Id String - ip
Ids List<String> - ipv6Address String
- organization
Id String - private
Networks List<GetLoadbalancer Private Network> - region String
- ssl
Compatibility StringLevel - List<String>
- The tags associated with the Load Balancer.
- type String
- The Load Balancer type.
- lb
Id String - name String
- project
Id String - release
Ip Boolean - zone String
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- assign
Flexible booleanIp - assign
Flexible booleanIpv6 - description string
- id string
- The provider-assigned unique ID for this managed resource.
- ip
Address string - The Load Balancer public IP address.
- ip
Id string - ip
Ids string[] - ipv6Address string
- organization
Id string - private
Networks GetLoadbalancer Private Network[] - region string
- ssl
Compatibility stringLevel - string[]
- The tags associated with the Load Balancer.
- type string
- The Load Balancer type.
- lb
Id string - name string
- project
Id string - release
Ip boolean - zone string
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- assign_
flexible_ boolip - assign_
flexible_ boolipv6 - description str
- id str
- The provider-assigned unique ID for this managed resource.
- ip_
address str - The Load Balancer public IP address.
- ip_
id str - ip_
ids Sequence[str] - ipv6_
address str - organization_
id str - private_
networks Sequence[GetLoadbalancer Private Network] - region str
- ssl_
compatibility_ strlevel - Sequence[str]
- The tags associated with the Load Balancer.
- type str
- The Load Balancer type.
- lb_
id str - name str
- project_
id str - release_
ip bool - zone str
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- assign
Flexible BooleanIp - assign
Flexible BooleanIpv6 - description String
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address String - The Load Balancer public IP address.
- ip
Id String - ip
Ids List<String> - ipv6Address String
- organization
Id String - private
Networks List<Property Map> - region String
- ssl
Compatibility StringLevel - List<String>
- The tags associated with the Load Balancer.
- type String
- The Load Balancer type.
- lb
Id String - name String
- project
Id String - release
Ip Boolean - zone String
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
Supporting Types
GetLoadbalancerPrivateNetwork
- Dhcp
Config bool - Set to true if you want to let DHCP assign IP addresses
- Ipam
Ids List<string> - IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
- Private
Network stringId - The Private Network ID
- Static
Configs List<string> - Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
- Status string
- The status of private network connection
- Zone string
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- Dhcp
Config bool - Set to true if you want to let DHCP assign IP addresses
- Ipam
Ids []string - IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
- Private
Network stringId - The Private Network ID
- Static
Configs []string - Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
- Status string
- The status of private network connection
- Zone string
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- dhcp
Config Boolean - Set to true if you want to let DHCP assign IP addresses
- ipam
Ids List<String> - IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
- private
Network StringId - The Private Network ID
- static
Configs List<String> - Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
- status String
- The status of private network connection
- zone String
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- dhcp
Config boolean - Set to true if you want to let DHCP assign IP addresses
- ipam
Ids string[] - IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
- private
Network stringId - The Private Network ID
- static
Configs string[] - Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
- status string
- The status of private network connection
- zone string
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- dhcp_
config bool - Set to true if you want to let DHCP assign IP addresses
- ipam_
ids Sequence[str] - IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
- private_
network_ strid - The Private Network ID
- static_
configs Sequence[str] - Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
- status str
- The status of private network connection
- zone str
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
- dhcp
Config Boolean - Set to true if you want to let DHCP assign IP addresses
- ipam
Ids List<String> - IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
- private
Network StringId - The Private Network ID
- static
Configs List<String> - Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
- status String
- The status of private network connection
- zone String
- (Defaults to provider
zone
) The zone in which the Load Balancer exists.
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scaleway
Terraform Provider.