Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Koyeb
  3. API Docs
  4. Domain
koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb
koyeb/pulumi-koyeb

koyeb.Domain

Explore with Pulumi AI

koyeb logo
koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb
koyeb/pulumi-koyeb

    Example Usage

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

const my_domain = new koyeb.Domain("my-domain", {name: "www.example.tld"});

    import pulumi
import pulumi_koyeb as koyeb

my_domain = koyeb.Domain("my-domain", name="www.example.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.NewDomain(ctx, "my-domain", &koyeb.DomainArgs{
			Name: pulumi.String("www.example.tld"),
		})
		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 = new Koyeb.Domain("my-domain", new()
    {
        Name = "www.example.tld",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.koyeb.Domain;
import com.pulumi.koyeb.DomainArgs;
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 my_domain = new Domain("my-domain", DomainArgs.builder()
            .name("www.example.tld")
            .build());

    }
}

    resources:
  my-domain:
    type: koyeb:Domain
    properties:
      name: www.example.tld

    Create Domain Resource

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

    Constructor syntax

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

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           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)
    func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

    type: koyeb:Domain
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 DomainArgs
    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 DomainArgs
    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 DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    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 domainResource = new Koyeb.Domain("domainResource", new()
{
    AppName = "string",
    DeploymentGroup = "string",
    IntendedCname = "string",
    Messages = "string",
    Name = "string",
    VerifiedAt = "string",
});

    example, err := koyeb.NewDomain(ctx, "domainResource", &koyeb.DomainArgs{
	AppName:         pulumi.String("string"),
	DeploymentGroup: pulumi.String("string"),
	IntendedCname:   pulumi.String("string"),
	Messages:        pulumi.String("string"),
	Name:            pulumi.String("string"),
	VerifiedAt:      pulumi.String("string"),
})

    var domainResource = new Domain("domainResource", DomainArgs.builder()
    .appName("string")
    .deploymentGroup("string")
    .intendedCname("string")
    .messages("string")
    .name("string")
    .verifiedAt("string")
    .build());

    domain_resource = koyeb.Domain("domainResource",
    app_name="string",
    deployment_group="string",
    intended_cname="string",
    messages="string",
    name="string",
    verified_at="string")

    const domainResource = new koyeb.Domain("domainResource", {
    appName: "string",
    deploymentGroup: "string",
    intendedCname: "string",
    messages: "string",
    name: "string",
    verifiedAt: "string",
});

    type: koyeb:Domain
properties:
    appName: string
    deploymentGroup: string
    intendedCname: string
    messages: string
    name: string
    verifiedAt: string

    Domain 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 Domain resource accepts the following input properties:

    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
    Name string
    The domain name
    VerifiedAt string
    The date and time of when the domain was last verified
    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
    Name string
    The domain name
    VerifiedAt string
    The date and time of when the domain was last verified
    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
    name String
    The domain name
    verifiedAt String
    The date and time of when the domain was last verified
    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
    name string
    The domain name
    verifiedAt string
    The date and time of when the domain was last verified
    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
    name str
    The domain name
    verified_at str
    The date and time of when the domain was last verified
    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
    name String
    The domain name
    verifiedAt String
    The date and time of when the domain was last verified

    Outputs

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

    CreatedAt string
    The date and time of when the domain was created
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Version string
    The version of the domain
    CreatedAt string
    The date and time of when the domain was created
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Version string
    The version of the domain
    createdAt String
    The date and time of when the domain was created
    id String
    The provider-assigned unique ID for this managed resource.
    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
    version String
    The version of the domain
    createdAt string
    The date and time of when the domain was created
    id string
    The provider-assigned unique ID for this managed resource.
    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
    version string
    The version of the domain
    created_at str
    The date and time of when the domain was created
    id str
    The provider-assigned unique ID for this managed resource.
    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
    version str
    The version of the domain
    createdAt String
    The date and time of when the domain was created
    id String
    The provider-assigned unique ID for this managed resource.
    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
    version String
    The version of the domain

    Look up Existing Domain Resource

    Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_name: Optional[str] = None,
        created_at: Optional[str] = None,
        deployment_group: Optional[str] = None,
        intended_cname: Optional[str] = None,
        messages: Optional[str] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        verified_at: Optional[str] = None,
        version: Optional[str] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    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
    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
    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
    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
    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
    app_name str
    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
    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
    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
    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

    Package Details

    Repository
    koyeb koyeb/pulumi-koyeb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the koyeb Terraform Provider.
    koyeb logo
    koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb
    koyeb/pulumi-koyeb