1. Packages
  2. Exoscale
  3. API Docs
  4. Domain
Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse

exoscale.Domain

Explore with Pulumi AI

exoscale logo
Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse

    Manage Exoscale DNS Domains.

    Corresponding data source: exoscale_domain.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as exoscale from "@pulumiverse/exoscale";
    
    const myDomain = new exoscale.Domain("myDomain", {});
    
    import pulumi
    import pulumiverse_exoscale as exoscale
    
    my_domain = exoscale.Domain("myDomain")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-exoscale/sdk/go/exoscale"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := exoscale.NewDomain(ctx, "myDomain", nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Exoscale = Pulumiverse.Exoscale;
    
    return await Deployment.RunAsync(() => 
    {
        var myDomain = new Exoscale.Domain("myDomain");
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.exoscale.Domain;
    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 myDomain = new Domain("myDomain");
    
        }
    }
    
    resources:
      myDomain:
        type: exoscale:Domain
    

    Next step is to attach exoscale_domain_record(s) to the domain.

    Please refer to the examples directory for complete configuration examples.

    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,
               name: 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: exoscale: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 Exoscale.Domain("domainResource", new()
    {
        Name = "string",
    });
    
    example, err := exoscale.NewDomain(ctx, "domainResource", &exoscale.DomainArgs{
    	Name: pulumi.String("string"),
    })
    
    var domainResource = new Domain("domainResource", DomainArgs.builder()
        .name("string")
        .build());
    
    domain_resource = exoscale.Domain("domainResource", name="string")
    
    const domainResource = new exoscale.Domain("domainResource", {name: "string"});
    
    type: exoscale:Domain
    properties:
        name: 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

    The Domain resource accepts the following input properties:

    Name string
    ❗ The DNS domain name.
    Name string
    ❗ The DNS domain name.
    name String
    ❗ The DNS domain name.
    name string
    ❗ The DNS domain name.
    name str
    ❗ The DNS domain name.
    name String
    ❗ The DNS domain name.

    Outputs

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

    AutoRenew bool
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    ExpiresOn string
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The domain state.

    Deprecated: Not used, will be removed in the future

    Token string
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    AutoRenew bool
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    ExpiresOn string
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The domain state.

    Deprecated: Not used, will be removed in the future

    Token string
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    autoRenew Boolean
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expiresOn String
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The domain state.

    Deprecated: Not used, will be removed in the future

    token String
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    autoRenew boolean
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expiresOn string
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The domain state.

    Deprecated: Not used, will be removed in the future

    token string
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    auto_renew bool
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expires_on str
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The domain state.

    Deprecated: Not used, will be removed in the future

    token str
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    autoRenew Boolean
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expiresOn String
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The domain state.

    Deprecated: Not used, will be removed in the future

    token String
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    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,
            auto_renew: Optional[bool] = None,
            expires_on: Optional[str] = None,
            name: Optional[str] = None,
            state: Optional[str] = None,
            token: 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:
    AutoRenew bool
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    ExpiresOn string
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    Name string
    ❗ The DNS domain name.
    State string
    The domain state.

    Deprecated: Not used, will be removed in the future

    Token string
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    AutoRenew bool
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    ExpiresOn string
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    Name string
    ❗ The DNS domain name.
    State string
    The domain state.

    Deprecated: Not used, will be removed in the future

    Token string
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    autoRenew Boolean
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expiresOn String
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    name String
    ❗ The DNS domain name.
    state String
    The domain state.

    Deprecated: Not used, will be removed in the future

    token String
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    autoRenew boolean
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expiresOn string
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    name string
    ❗ The DNS domain name.
    state string
    The domain state.

    Deprecated: Not used, will be removed in the future

    token string
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    auto_renew bool
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expires_on str
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    name str
    ❗ The DNS domain name.
    state str
    The domain state.

    Deprecated: Not used, will be removed in the future

    token str
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    autoRenew Boolean
    Whether the DNS domain has automatic renewal enabled (boolean).

    Deprecated: Not used, will be removed in the future

    expiresOn String
    The domain expiration date, if known.

    Deprecated: Not used, will be removed in the future

    name String
    ❗ The DNS domain name.
    state String
    The domain state.

    Deprecated: Not used, will be removed in the future

    token String
    A security token that can be used as an alternative way to manage DNS domains via the Exoscale API.

    Deprecated: Not used, will be removed in the future

    Import

    An existing DNS domain may be imported by ID:

    $ pulumi import exoscale:index/domain:Domain \
    

    exoscale_domain.my_domain \

    89083a5c-b648-474a-0000-0000000f67bd

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    exoscale pulumiverse/pulumi-exoscale
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the exoscale Terraform Provider.
    exoscale logo
    Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse