1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. getDomain
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community

cloudfoundry.getDomain

Explore with Pulumi AI

cloudfoundry logo
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community

    Gets information on a Cloud Foundry domain.

    Example Usage

    The following example looks up a name in the current deployment with the host name local within the local application domain.

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudfoundry from "@pulumi/cloudfoundry";
    
    const domain = cloudfoundry.getDomain({
        subDomain: "local",
    });
    
    import pulumi
    import pulumi_cloudfoundry as cloudfoundry
    
    domain = cloudfoundry.get_domain(sub_domain="local")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cloudfoundry/cloudfoundry"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudfoundry.LookupDomain(ctx, &cloudfoundry.LookupDomainArgs{
    			SubDomain: pulumi.StringRef("local"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudfoundry = Pulumi.Cloudfoundry;
    
    return await Deployment.RunAsync(() => 
    {
        var domain = Cloudfoundry.GetDomain.Invoke(new()
        {
            SubDomain = "local",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudfoundry.CloudfoundryFunctions;
    import com.pulumi.cloudfoundry.inputs.GetDomainArgs;
    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 domain = CloudfoundryFunctions.getDomain(GetDomainArgs.builder()
                .subDomain("local")
                .build());
    
        }
    }
    
    variables:
      domain:
        fn::invoke:
          function: cloudfoundry:getDomain
          arguments:
            subDomain: local
    

    Using getDomain

    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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
    function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
    def get_domain(domain: Optional[str] = None,
                   id: Optional[str] = None,
                   name: Optional[str] = None,
                   sub_domain: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDomainResult
    def get_domain_output(domain: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   sub_domain: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
    func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
    func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

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

    public static class GetDomain 
    {
        public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
        public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
    public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudfoundry:index/getDomain:getDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Domain string
    The domain name
    Id string
    The GUID of the domain
    Name string
    This value will be computed based on the sub_domain or domain attributes. If provided then this argument will be used as the full domain name.
    SubDomain string
    The sub-domain of the full domain name
    Domain string
    The domain name
    Id string
    The GUID of the domain
    Name string
    This value will be computed based on the sub_domain or domain attributes. If provided then this argument will be used as the full domain name.
    SubDomain string
    The sub-domain of the full domain name
    domain String
    The domain name
    id String
    The GUID of the domain
    name String
    This value will be computed based on the sub_domain or domain attributes. If provided then this argument will be used as the full domain name.
    subDomain String
    The sub-domain of the full domain name
    domain string
    The domain name
    id string
    The GUID of the domain
    name string
    This value will be computed based on the sub_domain or domain attributes. If provided then this argument will be used as the full domain name.
    subDomain string
    The sub-domain of the full domain name
    domain str
    The domain name
    id str
    The GUID of the domain
    name str
    This value will be computed based on the sub_domain or domain attributes. If provided then this argument will be used as the full domain name.
    sub_domain str
    The sub-domain of the full domain name
    domain String
    The domain name
    id String
    The GUID of the domain
    name String
    This value will be computed based on the sub_domain or domain attributes. If provided then this argument will be used as the full domain name.
    subDomain String
    The sub-domain of the full domain name

    getDomain Result

    The following output properties are available:

    Domain string
    The part of the domain name if not provided as an argument
    Id string
    The GUID of the domain
    Internal bool
    Flag that sets the domain as an internal domain
    Name string
    The full domain name if not provided as an argument
    Org string
    The org if this is a private domain owned by an org
    SubDomain string
    Domain string
    The part of the domain name if not provided as an argument
    Id string
    The GUID of the domain
    Internal bool
    Flag that sets the domain as an internal domain
    Name string
    The full domain name if not provided as an argument
    Org string
    The org if this is a private domain owned by an org
    SubDomain string
    domain String
    The part of the domain name if not provided as an argument
    id String
    The GUID of the domain
    internal Boolean
    Flag that sets the domain as an internal domain
    name String
    The full domain name if not provided as an argument
    org String
    The org if this is a private domain owned by an org
    subDomain String
    domain string
    The part of the domain name if not provided as an argument
    id string
    The GUID of the domain
    internal boolean
    Flag that sets the domain as an internal domain
    name string
    The full domain name if not provided as an argument
    org string
    The org if this is a private domain owned by an org
    subDomain string
    domain str
    The part of the domain name if not provided as an argument
    id str
    The GUID of the domain
    internal bool
    Flag that sets the domain as an internal domain
    name str
    The full domain name if not provided as an argument
    org str
    The org if this is a private domain owned by an org
    sub_domain str
    domain String
    The part of the domain name if not provided as an argument
    id String
    The GUID of the domain
    internal Boolean
    Flag that sets the domain as an internal domain
    name String
    The full domain name if not provided as an argument
    org String
    The org if this is a private domain owned by an org
    subDomain String

    Package Details

    Repository
    cloudfoundry cloudfoundry-community/terraform-provider-cloudfoundry
    License
    Notes
    This Pulumi package is based on the cloudfoundry Terraform Provider.
    cloudfoundry logo
    cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community