koyeb.getDomain

Explore with Pulumi AI

Koyeb v0.1.11 published on Monday, Dec 9, 2024 by Koyeb

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 dictionary

The following arguments are supported:

Name string: The domain name
AppName string: The app name the domain is assigned to
DeploymentGroup string: The deployment group assigned to the domain
IntendedCname string: The CNAME record to point the domain to
Messages string: The status messages of the domain
VerifiedAt string: The date and time of when the domain was last verified

Name string: The domain name
AppName string: The app name the domain is assigned to
DeploymentGroup string: The deployment group assigned to the domain
IntendedCname string: The CNAME record to point the domain to
Messages string: The status messages of the domain
VerifiedAt string: The date and time of when the domain was last verified

name String: The domain name
appName String: The app name the domain is assigned to
deploymentGroup String: The deployment group assigned to the domain
intendedCname String: The CNAME record to point the domain to
messages String: The status messages of the domain
verifiedAt String: The date and time of when the domain was last verified

name string: The domain name
appName string: The app name the domain is assigned to
deploymentGroup string: The deployment group assigned to the domain
intendedCname string: The CNAME record to point the domain to
messages string: The status messages of the domain
verifiedAt 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
appName String: The app name the domain is assigned to
deploymentGroup String: The deployment group assigned to the domain
intendedCname String: The CNAME record to point the domain to
messages String: The status messages of the domain
verifiedAt String: The date and time of when the domain was last verified

getDomain Result

The following output properties are available:

CreatedAt string: The date and time of when the domain was created
DeploymentGroup string: The deployment group assigned to the domain
Id string: The domain ID
IntendedCname string: The CNAME record to point the domain to
Messages string: The status messages of the domain
Name string: The domain name
OrganizationId string: The organization ID owning the domain
Status string: The status of the domain
Type string: The domain type
UpdatedAt string: The date and time of when the domain was last updated
VerifiedAt string: The date and time of when the domain was last verified
Version string: The version of the domain
AppName string: The app name the domain is assigned to

CreatedAt string: The date and time of when the domain was created
DeploymentGroup string: The deployment group assigned to the domain
Id string: The domain ID
IntendedCname string: The CNAME record to point the domain to
Messages string: The status messages of the domain
Name string: The domain name
OrganizationId string: The organization ID owning the domain
Status string: The status of the domain
Type string: The domain type
UpdatedAt string: The date and time of when the domain was last updated
VerifiedAt string: The date and time of when the domain was last verified
Version string: The version of the domain
AppName string: The app name the domain is assigned to

createdAt String: The date and time of when the domain was created
deploymentGroup String: The deployment group assigned to the domain
id String: The domain ID
intendedCname String: The CNAME record to point the domain to
messages String: The status messages of the domain
name String: The domain name
organizationId String: The organization ID owning the domain
status String: The status of the domain
type String: The domain type
updatedAt String: The date and time of when the domain was last updated
verifiedAt String: The date and time of when the domain was last verified
version String: The version of the domain
appName String: The app name the domain is assigned to

createdAt string: The date and time of when the domain was created
deploymentGroup string: The deployment group assigned to the domain
id string: The domain ID
intendedCname string: The CNAME record to point the domain to
messages string: The status messages of the domain
name string: The domain name
organizationId string: The organization ID owning the domain
status string: The status of the domain
type string: The domain type
updatedAt string: The date and time of when the domain was last updated
verifiedAt string: The date and time of when the domain was last verified
version string: The version of the domain
appName 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

createdAt String: The date and time of when the domain was created
deploymentGroup String: The deployment group assigned to the domain
id String: The domain ID
intendedCname String: The CNAME record to point the domain to
messages String: The status messages of the domain
name String: The domain name
organizationId String: The organization ID owning the domain
status String: The status of the domain
type String: The domain type
updatedAt String: The date and time of when the domain was last updated
verifiedAt String: The date and time of when the domain was last verified
version String: The version of the domain
appName 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 koyeb Terraform Provider.

Koyeb v0.1.11 published on Monday, Dec 9, 2024 by Koyeb

koyeb/pulumi-koyeb

koyeb.getDomain

On this page

On this page

Example Usage

Using getDomain

getDomain Result

Package Details

On this page

On this page