Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ContainerVpcAlb
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ContainerVpcAlb

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Enable or disable an Application Load Balancer (ALB) for a VPC cluster. For more information, about IBM container VPC ALB, see VPC: Exposing apps with load balancers for VPC.

    Example Usage

    In the following example, you can configure a ALB:

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

const alb = new ibm.ContainerVpcAlb("alb", {
    albId: "public-cr083d810e501d4c73b42184eab5a7ad56-alb",
    enable: true,
});

    import pulumi
import pulumi_ibm as ibm

alb = ibm.ContainerVpcAlb("alb",
    alb_id="public-cr083d810e501d4c73b42184eab5a7ad56-alb",
    enable=True)

    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.NewContainerVpcAlb(ctx, "alb", &ibm.ContainerVpcAlbArgs{
			AlbId:  pulumi.String("public-cr083d810e501d4c73b42184eab5a7ad56-alb"),
			Enable: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

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

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerVpcAlb;
import com.pulumi.ibm.ContainerVpcAlbArgs;
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) {
        var alb = new ContainerVpcAlb("alb", ContainerVpcAlbArgs.builder()
            .albId("public-cr083d810e501d4c73b42184eab5a7ad56-alb")
            .enable(true)
            .build());

    }
}

    resources:
  alb:
    type: ibm:ContainerVpcAlb
    properties:
      albId: public-cr083d810e501d4c73b42184eab5a7ad56-alb
      enable: true

    Create ContainerVpcAlb Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ContainerVpcAlb(name: string, args: ContainerVpcAlbArgs, opts?: CustomResourceOptions);
    @overload
def ContainerVpcAlb(resource_name: str,
                    args: ContainerVpcAlbArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ContainerVpcAlb(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    alb_id: Optional[str] = None,
                    container_vpc_alb_id: Optional[str] = None,
                    disable_deployment: Optional[bool] = None,
                    enable: Optional[bool] = None,
                    resource_group_id: Optional[str] = None,
                    timeouts: Optional[ContainerVpcAlbTimeoutsArgs] = None)
    func NewContainerVpcAlb(ctx *Context, name string, args ContainerVpcAlbArgs, opts ...ResourceOption) (*ContainerVpcAlb, error)
    public ContainerVpcAlb(string name, ContainerVpcAlbArgs args, CustomResourceOptions? opts = null)
    public ContainerVpcAlb(String name, ContainerVpcAlbArgs args)
public ContainerVpcAlb(String name, ContainerVpcAlbArgs args, CustomResourceOptions options)

    type: ibm:ContainerVpcAlb
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ContainerVpcAlbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ContainerVpcAlbArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ContainerVpcAlbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContainerVpcAlbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContainerVpcAlbArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var containerVpcAlbResource = new Ibm.ContainerVpcAlb("containerVpcAlbResource", new()
{
    AlbId = "string",
    ContainerVpcAlbId = "string",
    DisableDeployment = false,
    Enable = false,
    ResourceGroupId = "string",
    Timeouts = new Ibm.Inputs.ContainerVpcAlbTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

    example, err := ibm.NewContainerVpcAlb(ctx, "containerVpcAlbResource", &ibm.ContainerVpcAlbArgs{
	AlbId:             pulumi.String("string"),
	ContainerVpcAlbId: pulumi.String("string"),
	DisableDeployment: pulumi.Bool(false),
	Enable:            pulumi.Bool(false),
	ResourceGroupId:   pulumi.String("string"),
	Timeouts: &ibm.ContainerVpcAlbTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var containerVpcAlbResource = new ContainerVpcAlb("containerVpcAlbResource", ContainerVpcAlbArgs.builder()
    .albId("string")
    .containerVpcAlbId("string")
    .disableDeployment(false)
    .enable(false)
    .resourceGroupId("string")
    .timeouts(ContainerVpcAlbTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

    container_vpc_alb_resource = ibm.ContainerVpcAlb("containerVpcAlbResource",
    alb_id="string",
    container_vpc_alb_id="string",
    disable_deployment=False,
    enable=False,
    resource_group_id="string",
    timeouts={
        "create": "string",
        "update": "string",
    })

    const containerVpcAlbResource = new ibm.ContainerVpcAlb("containerVpcAlbResource", {
    albId: "string",
    containerVpcAlbId: "string",
    disableDeployment: false,
    enable: false,
    resourceGroupId: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: ibm:ContainerVpcAlb
properties:
    albId: string
    containerVpcAlbId: string
    disableDeployment: false
    enable: false
    resourceGroupId: string
    timeouts:
        create: string
        update: string

    ContainerVpcAlb Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ContainerVpcAlb resource accepts the following input properties:

    AlbId string
    The unique identifier of the application load balancer.
    ContainerVpcAlbId string
    (String) The ALB ID.
    DisableDeployment bool
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    Enable bool
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    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.
    Timeouts ContainerVpcAlbTimeouts
    AlbId string
    The unique identifier of the application load balancer.
    ContainerVpcAlbId string
    (String) The ALB ID.
    DisableDeployment bool
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    Enable bool
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    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.
    Timeouts ContainerVpcAlbTimeoutsArgs
    albId String
    The unique identifier of the application load balancer.
    containerVpcAlbId String
    (String) The ALB ID.
    disableDeployment Boolean
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable Boolean
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    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.
    timeouts ContainerVpcAlbTimeouts
    albId string
    The unique identifier of the application load balancer.
    containerVpcAlbId string
    (String) The ALB ID.
    disableDeployment boolean
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable boolean
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    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.
    timeouts ContainerVpcAlbTimeouts
    alb_id str
    The unique identifier of the application load balancer.
    container_vpc_alb_id str
    (String) The ALB ID.
    disable_deployment bool
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable bool
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    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.
    timeouts ContainerVpcAlbTimeoutsArgs
    albId String
    The unique identifier of the application load balancer.
    containerVpcAlbId String
    (String) The ALB ID.
    disableDeployment Boolean
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable Boolean
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    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.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ContainerVpcAlb resource produces the following output properties:

    AlbType string
    (String) The ALB type.
    Cluster string
    (String) The name of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerHostname string
    (String) The host name of the ALB.
    Name string
    (String) The name of the ALB.
    Resize bool
    (Bool) Resize of the ALB.
    State string
    (String) ALB state.
    Status string
    (String) The status of ALB.
    Zone string
    (String) The name of the zone.
    AlbType string
    (String) The ALB type.
    Cluster string
    (String) The name of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerHostname string
    (String) The host name of the ALB.
    Name string
    (String) The name of the ALB.
    Resize bool
    (Bool) Resize of the ALB.
    State string
    (String) ALB state.
    Status string
    (String) The status of ALB.
    Zone string
    (String) The name of the zone.
    albType String
    (String) The ALB type.
    cluster String
    (String) The name of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerHostname String
    (String) The host name of the ALB.
    name String
    (String) The name of the ALB.
    resize Boolean
    (Bool) Resize of the ALB.
    state String
    (String) ALB state.
    status String
    (String) The status of ALB.
    zone String
    (String) The name of the zone.
    albType string
    (String) The ALB type.
    cluster string
    (String) The name of the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerHostname string
    (String) The host name of the ALB.
    name string
    (String) The name of the ALB.
    resize boolean
    (Bool) Resize of the ALB.
    state string
    (String) ALB state.
    status string
    (String) The status of ALB.
    zone string
    (String) The name of the zone.
    alb_type str
    (String) The ALB type.
    cluster str
    (String) The name of the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_hostname str
    (String) The host name of the ALB.
    name str
    (String) The name of the ALB.
    resize bool
    (Bool) Resize of the ALB.
    state str
    (String) ALB state.
    status str
    (String) The status of ALB.
    zone str
    (String) The name of the zone.
    albType String
    (String) The ALB type.
    cluster String
    (String) The name of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerHostname String
    (String) The host name of the ALB.
    name String
    (String) The name of the ALB.
    resize Boolean
    (Bool) Resize of the ALB.
    state String
    (String) ALB state.
    status String
    (String) The status of ALB.
    zone String
    (String) The name of the zone.

    Look up Existing ContainerVpcAlb Resource

    Get an existing ContainerVpcAlb resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ContainerVpcAlbState, opts?: CustomResourceOptions): ContainerVpcAlb
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alb_id: Optional[str] = None,
        alb_type: Optional[str] = None,
        cluster: Optional[str] = None,
        container_vpc_alb_id: Optional[str] = None,
        disable_deployment: Optional[bool] = None,
        enable: Optional[bool] = None,
        load_balancer_hostname: Optional[str] = None,
        name: Optional[str] = None,
        resize: Optional[bool] = None,
        resource_group_id: Optional[str] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[ContainerVpcAlbTimeoutsArgs] = None,
        zone: Optional[str] = None) -> ContainerVpcAlb
    func GetContainerVpcAlb(ctx *Context, name string, id IDInput, state *ContainerVpcAlbState, opts ...ResourceOption) (*ContainerVpcAlb, error)
    public static ContainerVpcAlb Get(string name, Input<string> id, ContainerVpcAlbState? state, CustomResourceOptions? opts = null)
    public static ContainerVpcAlb get(String name, Output<String> id, ContainerVpcAlbState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ContainerVpcAlb    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlbId string
    The unique identifier of the application load balancer.
    AlbType string
    (String) The ALB type.
    Cluster string
    (String) The name of the cluster.
    ContainerVpcAlbId string
    (String) The ALB ID.
    DisableDeployment bool
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    Enable bool
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    LoadBalancerHostname string
    (String) The host name of the ALB.
    Name string
    (String) The name of the ALB.
    Resize bool
    (Bool) Resize of the ALB.
    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.
    State string
    (String) ALB state.
    Status string
    (String) The status of ALB.
    Timeouts ContainerVpcAlbTimeouts
    Zone string
    (String) The name of the zone.
    AlbId string
    The unique identifier of the application load balancer.
    AlbType string
    (String) The ALB type.
    Cluster string
    (String) The name of the cluster.
    ContainerVpcAlbId string
    (String) The ALB ID.
    DisableDeployment bool
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    Enable bool
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    LoadBalancerHostname string
    (String) The host name of the ALB.
    Name string
    (String) The name of the ALB.
    Resize bool
    (Bool) Resize of the ALB.
    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.
    State string
    (String) ALB state.
    Status string
    (String) The status of ALB.
    Timeouts ContainerVpcAlbTimeoutsArgs
    Zone string
    (String) The name of the zone.
    albId String
    The unique identifier of the application load balancer.
    albType String
    (String) The ALB type.
    cluster String
    (String) The name of the cluster.
    containerVpcAlbId String
    (String) The ALB ID.
    disableDeployment Boolean
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable Boolean
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    loadBalancerHostname String
    (String) The host name of the ALB.
    name String
    (String) The name of the ALB.
    resize Boolean
    (Bool) Resize of the ALB.
    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.
    state String
    (String) ALB state.
    status String
    (String) The status of ALB.
    timeouts ContainerVpcAlbTimeouts
    zone String
    (String) The name of the zone.
    albId string
    The unique identifier of the application load balancer.
    albType string
    (String) The ALB type.
    cluster string
    (String) The name of the cluster.
    containerVpcAlbId string
    (String) The ALB ID.
    disableDeployment boolean
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable boolean
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    loadBalancerHostname string
    (String) The host name of the ALB.
    name string
    (String) The name of the ALB.
    resize boolean
    (Bool) Resize of the ALB.
    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.
    state string
    (String) ALB state.
    status string
    (String) The status of ALB.
    timeouts ContainerVpcAlbTimeouts
    zone string
    (String) The name of the zone.
    alb_id str
    The unique identifier of the application load balancer.
    alb_type str
    (String) The ALB type.
    cluster str
    (String) The name of the cluster.
    container_vpc_alb_id str
    (String) The ALB ID.
    disable_deployment bool
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable bool
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    load_balancer_hostname str
    (String) The host name of the ALB.
    name str
    (String) The name of the ALB.
    resize bool
    (Bool) Resize of the ALB.
    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.
    state str
    (String) ALB state.
    status str
    (String) The status of ALB.
    timeouts ContainerVpcAlbTimeoutsArgs
    zone str
    (String) The name of the zone.
    albId String
    The unique identifier of the application load balancer.
    albType String
    (String) The ALB type.
    cluster String
    (String) The name of the cluster.
    containerVpcAlbId String
    (String) The ALB ID.
    disableDeployment Boolean
    Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. If you set this option, do not specify enable at the same time. Note You must include either enable or disable_deployment in the configuration, but must not include both.
    enable Boolean
    If set to true, the ALB in your cluster is enabled. If you set this option, do not specify disable_deployment at the same time.
    loadBalancerHostname String
    (String) The host name of the ALB.
    name String
    (String) The name of the ALB.
    resize Boolean
    (Bool) Resize of the ALB.
    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.
    state String
    (String) ALB state.
    status String
    (String) The status of ALB.
    timeouts Property Map
    zone String
    (String) The name of the zone.

    Supporting Types

    ContainerVpcAlbTimeouts, ContainerVpcAlbTimeoutsArgs

    Create string
    Update string
    Create string
    Update string
    create String
    update String
    create string
    update string
    create str
    update str
    create String
    update String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm