1. Packages
  2. Linode
  3. API Docs
  4. getDomain
Linode v4.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

linode.getDomain

Explore with Pulumi AI

linode logo
Linode v4.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    Provides information about a Linode domain.

    Example Usage

    The following example shows how one might use this data source to access information about a Linode domain.

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const foo = linode.getDomain({
        id: 1234567,
    });
    const bar = linode.getDomain({
        domain: "bar.example.com",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    foo = linode.get_domain(id=1234567)
    bar = linode.get_domain(domain="bar.example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.LookupDomain(ctx, &linode.LookupDomainArgs{
    			Id: pulumi.IntRef(1234567),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = linode.LookupDomain(ctx, &linode.LookupDomainArgs{
    			Domain: pulumi.StringRef("bar.example.com"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Linode.GetDomain.Invoke(new()
        {
            Id = 1234567,
        });
    
        var bar = Linode.GetDomain.Invoke(new()
        {
            Domain = "bar.example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.LinodeFunctions;
    import com.pulumi.linode.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 foo = LinodeFunctions.getDomain(GetDomainArgs.builder()
                .id("1234567")
                .build());
    
            final var bar = LinodeFunctions.getDomain(GetDomainArgs.builder()
                .domain("bar.example.com")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: linode:getDomain
          Arguments:
            id: '1234567'
      bar:
        fn::invoke:
          Function: linode:getDomain
          Arguments:
            domain: bar.example.com
    

    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[int] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDomainResult
    def get_domain_output(domain: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[int]] = 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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getDomain:getDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Domain string
    The unique domain name of the Domain record to query.
    Id int
    The unique numeric ID of the Domain record to query.
    Domain string
    The unique domain name of the Domain record to query.
    Id int
    The unique numeric ID of the Domain record to query.
    domain String
    The unique domain name of the Domain record to query.
    id Integer
    The unique numeric ID of the Domain record to query.
    domain string
    The unique domain name of the Domain record to query.
    id number
    The unique numeric ID of the Domain record to query.
    domain str
    The unique domain name of the Domain record to query.
    id int
    The unique numeric ID of the Domain record to query.
    domain String
    The unique domain name of the Domain record to query.
    id Number
    The unique numeric ID of the Domain record to query.

    getDomain Result

    The following output properties are available:

    AxfrIps List<string>
    The list of IPs that may perform a zone transfer for this Domain.
    Description string
    A description for this Domain.
    ExpireSec int
    The amount of time in seconds that may pass before this Domain is no longer authoritative.
    Group string
    The group this Domain belongs to.
    MasterIps List<string>
    The IP addresses representing the master DNS for this Domain.
    RefreshSec int
    The amount of time in seconds before this Domain should be refreshed.
    RetrySec int
    The interval, in seconds, at which a failed refresh should be retried.
    SoaEmail string
    Start of Authority email address.
    Status string
    Used to control whether this Domain is currently being rendered. (disabled, active)
    Tags List<string>
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    TtlSec int
    'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
    Type string
    If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
    Domain string
    The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
    Id int
    The unique ID of this Domain.
    AxfrIps []string
    The list of IPs that may perform a zone transfer for this Domain.
    Description string
    A description for this Domain.
    ExpireSec int
    The amount of time in seconds that may pass before this Domain is no longer authoritative.
    Group string
    The group this Domain belongs to.
    MasterIps []string
    The IP addresses representing the master DNS for this Domain.
    RefreshSec int
    The amount of time in seconds before this Domain should be refreshed.
    RetrySec int
    The interval, in seconds, at which a failed refresh should be retried.
    SoaEmail string
    Start of Authority email address.
    Status string
    Used to control whether this Domain is currently being rendered. (disabled, active)
    Tags []string
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    TtlSec int
    'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
    Type string
    If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
    Domain string
    The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
    Id int
    The unique ID of this Domain.
    axfrIps List<String>
    The list of IPs that may perform a zone transfer for this Domain.
    description String
    A description for this Domain.
    expireSec Integer
    The amount of time in seconds that may pass before this Domain is no longer authoritative.
    group String
    The group this Domain belongs to.
    masterIps List<String>
    The IP addresses representing the master DNS for this Domain.
    refreshSec Integer
    The amount of time in seconds before this Domain should be refreshed.
    retrySec Integer
    The interval, in seconds, at which a failed refresh should be retried.
    soaEmail String
    Start of Authority email address.
    status String
    Used to control whether this Domain is currently being rendered. (disabled, active)
    tags List<String>
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    ttlSec Integer
    'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
    type String
    If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
    domain String
    The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
    id Integer
    The unique ID of this Domain.
    axfrIps string[]
    The list of IPs that may perform a zone transfer for this Domain.
    description string
    A description for this Domain.
    expireSec number
    The amount of time in seconds that may pass before this Domain is no longer authoritative.
    group string
    The group this Domain belongs to.
    masterIps string[]
    The IP addresses representing the master DNS for this Domain.
    refreshSec number
    The amount of time in seconds before this Domain should be refreshed.
    retrySec number
    The interval, in seconds, at which a failed refresh should be retried.
    soaEmail string
    Start of Authority email address.
    status string
    Used to control whether this Domain is currently being rendered. (disabled, active)
    tags string[]
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    ttlSec number
    'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
    type string
    If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
    domain string
    The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
    id number
    The unique ID of this Domain.
    axfr_ips Sequence[str]
    The list of IPs that may perform a zone transfer for this Domain.
    description str
    A description for this Domain.
    expire_sec int
    The amount of time in seconds that may pass before this Domain is no longer authoritative.
    group str
    The group this Domain belongs to.
    master_ips Sequence[str]
    The IP addresses representing the master DNS for this Domain.
    refresh_sec int
    The amount of time in seconds before this Domain should be refreshed.
    retry_sec int
    The interval, in seconds, at which a failed refresh should be retried.
    soa_email str
    Start of Authority email address.
    status str
    Used to control whether this Domain is currently being rendered. (disabled, active)
    tags Sequence[str]
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    ttl_sec int
    'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
    type str
    If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
    domain str
    The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
    id int
    The unique ID of this Domain.
    axfrIps List<String>
    The list of IPs that may perform a zone transfer for this Domain.
    description String
    A description for this Domain.
    expireSec Number
    The amount of time in seconds that may pass before this Domain is no longer authoritative.
    group String
    The group this Domain belongs to.
    masterIps List<String>
    The IP addresses representing the master DNS for this Domain.
    refreshSec Number
    The amount of time in seconds before this Domain should be refreshed.
    retrySec Number
    The interval, in seconds, at which a failed refresh should be retried.
    soaEmail String
    Start of Authority email address.
    status String
    Used to control whether this Domain is currently being rendered. (disabled, active)
    tags List<String>
    An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    ttlSec Number
    'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
    type String
    If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
    domain String
    The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
    id Number
    The unique ID of this Domain.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.18.0 published on Wednesday, Apr 10, 2024 by Pulumi