Koyeb v0.1.11 published on Monday, Dec 9, 2024 by Koyeb
koyeb.getDomain
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as koyeb from "@pulumi/koyeb";
const my-domain = koyeb.getDomain({
    name: "www.exampled.tld",
});
import pulumi
import pulumi_koyeb as koyeb
my_domain = koyeb.get_domain(name="www.exampled.tld")
package main
import (
	"github.com/koyeb/pulumi-koyeb/sdk/go/koyeb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := koyeb.LookupDomain(ctx, &koyeb.LookupDomainArgs{
			Name: "www.exampled.tld",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Koyeb = Pulumi.Koyeb;
return await Deployment.RunAsync(() => 
{
    var my_domain = Koyeb.GetDomain.Invoke(new()
    {
        Name = "www.exampled.tld",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.koyeb.KoyebFunctions;
import com.pulumi.koyeb.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 my-domain = KoyebFunctions.getDomain(GetDomainArgs.builder()
            .name("www.exampled.tld")
            .build());
    }
}
variables:
  my-domain:
    fn::invoke:
      Function: koyeb:getDomain
      Arguments:
        name: www.exampled.tld
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(app_name: Optional[str] = None,
               deployment_group: Optional[str] = None,
               intended_cname: Optional[str] = None,
               messages: Optional[str] = None,
               name: Optional[str] = None,
               verified_at: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(app_name: Optional[pulumi.Input[str]] = None,
               deployment_group: Optional[pulumi.Input[str]] = None,
               intended_cname: Optional[pulumi.Input[str]] = None,
               messages: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               verified_at: 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: koyeb:index/getDomain:getDomain
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
 - The domain name
 - App
Name string - The app name the domain is assigned to
 - Deployment
Group string - The deployment group assigned to the domain
 - Intended
Cname string - The CNAME record to point the domain to
 - Messages string
 - The status messages of the domain
 - Verified
At string - The date and time of when the domain was last verified
 
- Name string
 - The domain name
 - App
Name string - The app name the domain is assigned to
 - Deployment
Group string - The deployment group assigned to the domain
 - Intended
Cname string - The CNAME record to point the domain to
 - Messages string
 - The status messages of the domain
 - Verified
At string - The date and time of when the domain was last verified
 
- name String
 - The domain name
 - app
Name String - The app name the domain is assigned to
 - deployment
Group String - The deployment group assigned to the domain
 - intended
Cname String - The CNAME record to point the domain to
 - messages String
 - The status messages of the domain
 - verified
At String - The date and time of when the domain was last verified
 
- name string
 - The domain name
 - app
Name string - The app name the domain is assigned to
 - deployment
Group string - The deployment group assigned to the domain
 - intended
Cname string - The CNAME record to point the domain to
 - messages string
 - The status messages of the domain
 - verified
At string - The date and time of when the domain was last verified
 
- name str
 - The domain name
 - app_
name str - The app name the domain is assigned to
 - deployment_
group str - The deployment group assigned to the domain
 - intended_
cname str - The CNAME record to point the domain to
 - messages str
 - The status messages of the domain
 - verified_
at str - The date and time of when the domain was last verified
 
- name String
 - The domain name
 - app
Name String - The app name the domain is assigned to
 - deployment
Group String - The deployment group assigned to the domain
 - intended
Cname String - The CNAME record to point the domain to
 - messages String
 - The status messages of the domain
 - verified
At String - The date and time of when the domain was last verified
 
getDomain Result
The following output properties are available:
- Created
At string - The date and time of when the domain was created
 - Deployment
Group string - The deployment group assigned to the domain
 - Id string
 - The domain ID
 - Intended
Cname string - The CNAME record to point the domain to
 - Messages string
 - The status messages of the domain
 - Name string
 - The domain name
 - Organization
Id string - The organization ID owning the domain
 - Status string
 - The status of the domain
 - Type string
 - The domain type
 - Updated
At string - The date and time of when the domain was last updated
 - Verified
At string - The date and time of when the domain was last verified
 - Version string
 - The version of the domain
 - App
Name string - The app name the domain is assigned to
 
- Created
At string - The date and time of when the domain was created
 - Deployment
Group string - The deployment group assigned to the domain
 - Id string
 - The domain ID
 - Intended
Cname string - The CNAME record to point the domain to
 - Messages string
 - The status messages of the domain
 - Name string
 - The domain name
 - Organization
Id string - The organization ID owning the domain
 - Status string
 - The status of the domain
 - Type string
 - The domain type
 - Updated
At string - The date and time of when the domain was last updated
 - Verified
At string - The date and time of when the domain was last verified
 - Version string
 - The version of the domain
 - App
Name string - The app name the domain is assigned to
 
- created
At String - The date and time of when the domain was created
 - deployment
Group String - The deployment group assigned to the domain
 - id String
 - The domain ID
 - intended
Cname String - The CNAME record to point the domain to
 - messages String
 - The status messages of the domain
 - name String
 - The domain name
 - organization
Id String - The organization ID owning the domain
 - status String
 - The status of the domain
 - type String
 - The domain type
 - updated
At String - The date and time of when the domain was last updated
 - verified
At String - The date and time of when the domain was last verified
 - version String
 - The version of the domain
 - app
Name String - The app name the domain is assigned to
 
- created
At string - The date and time of when the domain was created
 - deployment
Group string - The deployment group assigned to the domain
 - id string
 - The domain ID
 - intended
Cname string - The CNAME record to point the domain to
 - messages string
 - The status messages of the domain
 - name string
 - The domain name
 - organization
Id string - The organization ID owning the domain
 - status string
 - The status of the domain
 - type string
 - The domain type
 - updated
At string - The date and time of when the domain was last updated
 - verified
At string - The date and time of when the domain was last verified
 - version string
 - The version of the domain
 - app
Name string - The app name the domain is assigned to
 
- created_
at str - The date and time of when the domain was created
 - deployment_
group str - The deployment group assigned to the domain
 - id str
 - The domain ID
 - intended_
cname str - The CNAME record to point the domain to
 - messages str
 - The status messages of the domain
 - name str
 - The domain name
 - organization_
id str - The organization ID owning the domain
 - status str
 - The status of the domain
 - type str
 - The domain type
 - updated_
at str - The date and time of when the domain was last updated
 - verified_
at str - The date and time of when the domain was last verified
 - version str
 - The version of the domain
 - app_
name str - The app name the domain is assigned to
 
- created
At String - The date and time of when the domain was created
 - deployment
Group String - The deployment group assigned to the domain
 - id String
 - The domain ID
 - intended
Cname String - The CNAME record to point the domain to
 - messages String
 - The status messages of the domain
 - name String
 - The domain name
 - organization
Id String - The organization ID owning the domain
 - status String
 - The status of the domain
 - type String
 - The domain type
 - updated
At String - The date and time of when the domain was last updated
 - verified
At String - The date and time of when the domain was last verified
 - version String
 - The version of the domain
 - app
Name String - The app name the domain is assigned to
 
Package Details
- Repository
 - koyeb koyeb/pulumi-koyeb
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
koyebTerraform Provider.