1. Packages
  2. Ibm Provider
  3. API Docs
  4. getContainerNlbDns
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getContainerNlbDns

Explore with Pulumi AI

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

    List NLB subdomains and either the NLB IP addresses (classic clusters) or the load balancer hostnames (VPC clusters) that are registered with the DNS provider for each NLB subdomain.

    Example Usage

    The following example retrieves information about NLB subdomains of a cluster that is named mycluster.

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dns = ibm.getContainerNlbDns({
        cluster: "mycluster",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    dns = ibm.get_container_nlb_dns(cluster="mycluster")
    
    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.LookupContainerNlbDns(ctx, &ibm.LookupContainerNlbDnsArgs{
    			Cluster: "mycluster",
    		}, nil)
    		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 dns = Ibm.GetContainerNlbDns.Invoke(new()
        {
            Cluster = "mycluster",
        });
    
    });
    
    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.GetContainerNlbDnsArgs;
    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 dns = IbmFunctions.getContainerNlbDns(GetContainerNlbDnsArgs.builder()
                .cluster("mycluster")
                .build());
    
        }
    }
    
    variables:
      dns:
        fn::invoke:
          function: ibm:getContainerNlbDns
          arguments:
            cluster: mycluster
    

    Using getContainerNlbDns

    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 getContainerNlbDns(args: GetContainerNlbDnsArgs, opts?: InvokeOptions): Promise<GetContainerNlbDnsResult>
    function getContainerNlbDnsOutput(args: GetContainerNlbDnsOutputArgs, opts?: InvokeOptions): Output<GetContainerNlbDnsResult>
    def get_container_nlb_dns(cluster: Optional[str] = None,
                              id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetContainerNlbDnsResult
    def get_container_nlb_dns_output(cluster: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetContainerNlbDnsResult]
    func LookupContainerNlbDns(ctx *Context, args *LookupContainerNlbDnsArgs, opts ...InvokeOption) (*LookupContainerNlbDnsResult, error)
    func LookupContainerNlbDnsOutput(ctx *Context, args *LookupContainerNlbDnsOutputArgs, opts ...InvokeOption) LookupContainerNlbDnsResultOutput

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

    public static class GetContainerNlbDns 
    {
        public static Task<GetContainerNlbDnsResult> InvokeAsync(GetContainerNlbDnsArgs args, InvokeOptions? opts = null)
        public static Output<GetContainerNlbDnsResult> Invoke(GetContainerNlbDnsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetContainerNlbDnsResult> getContainerNlbDns(GetContainerNlbDnsArgs args, InvokeOptions options)
    public static Output<GetContainerNlbDnsResult> getContainerNlbDns(GetContainerNlbDnsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getContainerNlbDns:getContainerNlbDns
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Cluster string
    The name or ID of the cluster.
    Id string
    Cluster string
    The name or ID of the cluster.
    Id string
    cluster String
    The name or ID of the cluster.
    id String
    cluster string
    The name or ID of the cluster.
    id string
    cluster str
    The name or ID of the cluster.
    id str
    cluster String
    The name or ID of the cluster.
    id String

    getContainerNlbDns Result

    The following output properties are available:

    Cluster string
    (String) Cluster Id.
    Id string
    NlbConfigs List<GetContainerNlbDnsNlbConfig>
    List of objects
    Cluster string
    (String) Cluster Id.
    Id string
    NlbConfigs []GetContainerNlbDnsNlbConfig
    List of objects
    cluster String
    (String) Cluster Id.
    id String
    nlbConfigs List<GetContainerNlbDnsNlbConfig>
    List of objects
    cluster string
    (String) Cluster Id.
    id string
    nlbConfigs GetContainerNlbDnsNlbConfig[]
    List of objects
    cluster str
    (String) Cluster Id.
    id str
    nlb_configs Sequence[GetContainerNlbDnsNlbConfig]
    List of objects
    cluster String
    (String) Cluster Id.
    id String
    nlbConfigs List<Property Map>
    List of objects

    Supporting Types

    GetContainerNlbDnsNlbConfig

    Cluster string
    The name or ID of the cluster.
    DnsType string
    (String) Type of DNS.
    LbHostname string
    (String) Host Name of load Balancer.
    NlbIps List<string>
    (List(String)) NLB IPs.
    NlbSubDomain string
    (String) NLB Sub-Domain.
    SecretName string
    (String) Name of the secret.
    SecretNamespace string
    (String) Namespace of Secret.
    SecretStatus string
    (String) Status of Secret.
    Type string
    (String) Nlb Type.
    Cluster string
    The name or ID of the cluster.
    DnsType string
    (String) Type of DNS.
    LbHostname string
    (String) Host Name of load Balancer.
    NlbIps []string
    (List(String)) NLB IPs.
    NlbSubDomain string
    (String) NLB Sub-Domain.
    SecretName string
    (String) Name of the secret.
    SecretNamespace string
    (String) Namespace of Secret.
    SecretStatus string
    (String) Status of Secret.
    Type string
    (String) Nlb Type.
    cluster String
    The name or ID of the cluster.
    dnsType String
    (String) Type of DNS.
    lbHostname String
    (String) Host Name of load Balancer.
    nlbIps List<String>
    (List(String)) NLB IPs.
    nlbSubDomain String
    (String) NLB Sub-Domain.
    secretName String
    (String) Name of the secret.
    secretNamespace String
    (String) Namespace of Secret.
    secretStatus String
    (String) Status of Secret.
    type String
    (String) Nlb Type.
    cluster string
    The name or ID of the cluster.
    dnsType string
    (String) Type of DNS.
    lbHostname string
    (String) Host Name of load Balancer.
    nlbIps string[]
    (List(String)) NLB IPs.
    nlbSubDomain string
    (String) NLB Sub-Domain.
    secretName string
    (String) Name of the secret.
    secretNamespace string
    (String) Namespace of Secret.
    secretStatus string
    (String) Status of Secret.
    type string
    (String) Nlb Type.
    cluster str
    The name or ID of the cluster.
    dns_type str
    (String) Type of DNS.
    lb_hostname str
    (String) Host Name of load Balancer.
    nlb_ips Sequence[str]
    (List(String)) NLB IPs.
    nlb_sub_domain str
    (String) NLB Sub-Domain.
    secret_name str
    (String) Name of the secret.
    secret_namespace str
    (String) Namespace of Secret.
    secret_status str
    (String) Status of Secret.
    type str
    (String) Nlb Type.
    cluster String
    The name or ID of the cluster.
    dnsType String
    (String) Type of DNS.
    lbHostname String
    (String) Host Name of load Balancer.
    nlbIps List<String>
    (List(String)) NLB IPs.
    nlbSubDomain String
    (String) NLB Sub-Domain.
    secretName String
    (String) Name of the secret.
    secretNamespace String
    (String) Namespace of Secret.
    secretStatus String
    (String) Status of Secret.
    type String
    (String) Nlb Type.

    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