Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getContainerVpcAlb
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getContainerVpcAlb

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Retrieve information about all the Kubernetes cluster ALB on IBM Cloud as a read-only data source. For more information, about Kubernets container VPC ALB, see VPC: Exposing apps with load balancers for VPC.

Example Usage

The following example retrieves information of an ALB.

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const alb = ibm.getContainerVpcAlb({
    albId: "public-cr083d810e501d4c73b42184eab5a7ad56-alb",
});
Copy
import pulumi
import pulumi_ibm as ibm

alb = ibm.get_container_vpc_alb(alb_id="public-cr083d810e501d4c73b42184eab5a7ad56-alb")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupContainerVpcAlb(ctx, &ibm.LookupContainerVpcAlbArgs{
			AlbId: "public-cr083d810e501d4c73b42184eab5a7ad56-alb",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var alb = Ibm.GetContainerVpcAlb.Invoke(new()
    {
        AlbId = "public-cr083d810e501d4c73b42184eab5a7ad56-alb",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetContainerVpcAlbArgs;
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) {
        final var alb = IbmFunctions.getContainerVpcAlb(GetContainerVpcAlbArgs.builder()
            .albId("public-cr083d810e501d4c73b42184eab5a7ad56-alb")
            .build());

    }
}
Copy
variables:
  alb:
    fn::invoke:
      function: ibm:getContainerVpcAlb
      arguments:
        albId: public-cr083d810e501d4c73b42184eab5a7ad56-alb
Copy

Using getContainerVpcAlb

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 getContainerVpcAlb(args: GetContainerVpcAlbArgs, opts?: InvokeOptions): Promise<GetContainerVpcAlbResult>
function getContainerVpcAlbOutput(args: GetContainerVpcAlbOutputArgs, opts?: InvokeOptions): Output<GetContainerVpcAlbResult>
Copy
def get_container_vpc_alb(alb_id: Optional[str] = None,
                          id: Optional[str] = None,
                          resource_group_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetContainerVpcAlbResult
def get_container_vpc_alb_output(alb_id: Optional[pulumi.Input[str]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          resource_group_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetContainerVpcAlbResult]
Copy
func LookupContainerVpcAlb(ctx *Context, args *LookupContainerVpcAlbArgs, opts ...InvokeOption) (*LookupContainerVpcAlbResult, error)
func LookupContainerVpcAlbOutput(ctx *Context, args *LookupContainerVpcAlbOutputArgs, opts ...InvokeOption) LookupContainerVpcAlbResultOutput
Copy

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

public static class GetContainerVpcAlb 
{
    public static Task<GetContainerVpcAlbResult> InvokeAsync(GetContainerVpcAlbArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerVpcAlbResult> Invoke(GetContainerVpcAlbInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetContainerVpcAlbResult> getContainerVpcAlb(GetContainerVpcAlbArgs args, InvokeOptions options)
public static Output<GetContainerVpcAlbResult> getContainerVpcAlb(GetContainerVpcAlbArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getContainerVpcAlb:getContainerVpcAlb
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AlbId This property is required. string
The ID of the ALB.
Id string
(String) The ALB ID.
ResourceGroupId string
The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.
AlbId This property is required. string
The ID of the ALB.
Id string
(String) The ALB ID.
ResourceGroupId string
The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.
albId This property is required. String
The ID of the ALB.
id String
(String) The ALB ID.
resourceGroupId String
The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.
albId This property is required. string
The ID of the ALB.
id string
(String) The ALB ID.
resourceGroupId string
The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.
alb_id This property is required. str
The ID of the ALB.
id str
(String) The ALB ID.
resource_group_id str
The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.
albId This property is required. String
The ID of the ALB.
id String
(String) The ALB ID.
resourceGroupId String
The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

getContainerVpcAlb Result

The following output properties are available:

AlbId string
AlbType string
(String) The ALB type.
Cluster string
(String) The name of the cluster.
DisableDeployment bool
(String) Disable the ALB deployment details.
Enable bool
(String) Enable an ALB for the cluster.
Id string
(String) The ALB ID.
LoadBalancerHostname string
(String) The name of the load balancer.
Name string
(String) The name of the ALB.
Resize bool
(String) Resize of the ALB.
State string
(String) ALB state.
Status string
(String) The status of ALB.
Zone string
(String) The name of the zone.
ResourceGroupId string
AlbId string
AlbType string
(String) The ALB type.
Cluster string
(String) The name of the cluster.
DisableDeployment bool
(String) Disable the ALB deployment details.
Enable bool
(String) Enable an ALB for the cluster.
Id string
(String) The ALB ID.
LoadBalancerHostname string
(String) The name of the load balancer.
Name string
(String) The name of the ALB.
Resize bool
(String) Resize of the ALB.
State string
(String) ALB state.
Status string
(String) The status of ALB.
Zone string
(String) The name of the zone.
ResourceGroupId string
albId String
albType String
(String) The ALB type.
cluster String
(String) The name of the cluster.
disableDeployment Boolean
(String) Disable the ALB deployment details.
enable Boolean
(String) Enable an ALB for the cluster.
id String
(String) The ALB ID.
loadBalancerHostname String
(String) The name of the load balancer.
name String
(String) The name of the ALB.
resize Boolean
(String) Resize of the ALB.
state String
(String) ALB state.
status String
(String) The status of ALB.
zone String
(String) The name of the zone.
resourceGroupId String
albId string
albType string
(String) The ALB type.
cluster string
(String) The name of the cluster.
disableDeployment boolean
(String) Disable the ALB deployment details.
enable boolean
(String) Enable an ALB for the cluster.
id string
(String) The ALB ID.
loadBalancerHostname string
(String) The name of the load balancer.
name string
(String) The name of the ALB.
resize boolean
(String) Resize of the ALB.
state string
(String) ALB state.
status string
(String) The status of ALB.
zone string
(String) The name of the zone.
resourceGroupId string
alb_id str
alb_type str
(String) The ALB type.
cluster str
(String) The name of the cluster.
disable_deployment bool
(String) Disable the ALB deployment details.
enable bool
(String) Enable an ALB for the cluster.
id str
(String) The ALB ID.
load_balancer_hostname str
(String) The name of the load balancer.
name str
(String) The name of the ALB.
resize bool
(String) Resize of the ALB.
state str
(String) ALB state.
status str
(String) The status of ALB.
zone str
(String) The name of the zone.
resource_group_id str
albId String
albType String
(String) The ALB type.
cluster String
(String) The name of the cluster.
disableDeployment Boolean
(String) Disable the ALB deployment details.
enable Boolean
(String) Enable an ALB for the cluster.
id String
(String) The ALB ID.
loadBalancerHostname String
(String) The name of the load balancer.
name String
(String) The name of the ALB.
resize Boolean
(String) Resize of the ALB.
state String
(String) ALB state.
status String
(String) The status of ALB.
zone String
(String) The name of the zone.
resourceGroupId String

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm