Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. DnsDomain
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.DnsDomain

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a single DNS domain managed on IBM Cloud Classic Infrastructure (SoftLayer). Domains contain general information about the domain name, such as the name and serial number. For more information, about DNS services, see getting started with IBM Cloud DNS Services.

    Individual records, such as A, AAAA, CTYPE, and MX records, are stored in the domain’s associated resource records by using the ibm.DnsRecord resource).

    Example Usage

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

const dns_domain_test = new ibm.DnsDomain("dns-domain-test", {target: "127.0.0.10"});

    import pulumi
import pulumi_ibm as ibm

dns_domain_test = ibm.DnsDomain("dns-domain-test", target="127.0.0.10")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewDnsDomain(ctx, "dns-domain-test", &ibm.DnsDomainArgs{
			Target: pulumi.String("127.0.0.10"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dns_domain_test = new Ibm.DnsDomain("dns-domain-test", new()
    {
        Target = "127.0.0.10",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.DnsDomain;
import com.pulumi.ibm.DnsDomainArgs;
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 dns_domain_test = new DnsDomain("dns-domain-test", DnsDomainArgs.builder()
            .target("127.0.0.10")
            .build());

    }
}

    resources:
  dns-domain-test:
    type: ibm:DnsDomain
    properties:
      target: 127.0.0.10

    Create DnsDomain Resource

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

    Constructor syntax

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

@overload
def DnsDomain(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              dns_domain_id: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Sequence[str]] = None,
              target: Optional[str] = None)
    func NewDnsDomain(ctx *Context, name string, args *DnsDomainArgs, opts ...ResourceOption) (*DnsDomain, error)
    public DnsDomain(string name, DnsDomainArgs? args = null, CustomResourceOptions? opts = null)
    public DnsDomain(String name, DnsDomainArgs args)
public DnsDomain(String name, DnsDomainArgs args, CustomResourceOptions options)

    type: ibm:DnsDomain
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 DnsDomainArgs
    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 DnsDomainArgs
    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 DnsDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsDomainArgs
    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 dnsDomainResource = new Ibm.DnsDomain("dnsDomainResource", new()
{
    DnsDomainId = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    Target = "string",
});

    example, err := ibm.NewDnsDomain(ctx, "dnsDomainResource", &ibm.DnsDomainArgs{
	DnsDomainId: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Target: pulumi.String("string"),
})

    var dnsDomainResource = new DnsDomain("dnsDomainResource", DnsDomainArgs.builder()
    .dnsDomainId("string")
    .name("string")
    .tags("string")
    .target("string")
    .build());

    dns_domain_resource = ibm.DnsDomain("dnsDomainResource",
    dns_domain_id="string",
    name="string",
    tags=["string"],
    target="string")

    const dnsDomainResource = new ibm.DnsDomain("dnsDomainResource", {
    dnsDomainId: "string",
    name: "string",
    tags: ["string"],
    target: "string",
});

    type: ibm:DnsDomain
properties:
    dnsDomainId: string
    name: string
    tags:
        - string
    target: string

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

    DnsDomainId string
    (String) The unique internal identifier of the domain record.
    Name string
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    Tags List<string>
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Target string
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    DnsDomainId string
    (String) The unique internal identifier of the domain record.
    Name string
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    Tags []string
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Target string
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    dnsDomainId String
    (String) The unique internal identifier of the domain record.
    name String
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    tags List<String>
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target String
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    dnsDomainId string
    (String) The unique internal identifier of the domain record.
    name string
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    tags string[]
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target string
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    dns_domain_id str
    (String) The unique internal identifier of the domain record.
    name str
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    tags Sequence[str]
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target str
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    dnsDomainId String
    (String) The unique internal identifier of the domain record.
    name String
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    tags List<String>
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target String
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Serial string
    (String) A unique number denoting the latest revision of the domain.
    UpdateDate string
    (Timestamp) The date that the domain record was last updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Serial string
    (String) A unique number denoting the latest revision of the domain.
    UpdateDate string
    (Timestamp) The date that the domain record was last updated.
    id String
    The provider-assigned unique ID for this managed resource.
    serial String
    (String) A unique number denoting the latest revision of the domain.
    updateDate String
    (Timestamp) The date that the domain record was last updated.
    id string
    The provider-assigned unique ID for this managed resource.
    serial string
    (String) A unique number denoting the latest revision of the domain.
    updateDate string
    (Timestamp) The date that the domain record was last updated.
    id str
    The provider-assigned unique ID for this managed resource.
    serial str
    (String) A unique number denoting the latest revision of the domain.
    update_date str
    (Timestamp) The date that the domain record was last updated.
    id String
    The provider-assigned unique ID for this managed resource.
    serial String
    (String) A unique number denoting the latest revision of the domain.
    updateDate String
    (Timestamp) The date that the domain record was last updated.

    Look up Existing DnsDomain Resource

    Get an existing DnsDomain 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?: DnsDomainState, opts?: CustomResourceOptions): DnsDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_domain_id: Optional[str] = None,
        name: Optional[str] = None,
        serial: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target: Optional[str] = None,
        update_date: Optional[str] = None) -> DnsDomain
    func GetDnsDomain(ctx *Context, name string, id IDInput, state *DnsDomainState, opts ...ResourceOption) (*DnsDomain, error)
    public static DnsDomain Get(string name, Input<string> id, DnsDomainState? state, CustomResourceOptions? opts = null)
    public static DnsDomain get(String name, Output<String> id, DnsDomainState state, CustomResourceOptions options)
    resources:  _:    type: ibm:DnsDomain    get:      id: ${id}
    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:
    DnsDomainId string
    (String) The unique internal identifier of the domain record.
    Name string
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    Serial string
    (String) A unique number denoting the latest revision of the domain.
    Tags List<string>
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Target string
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    UpdateDate string
    (Timestamp) The date that the domain record was last updated.
    DnsDomainId string
    (String) The unique internal identifier of the domain record.
    Name string
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    Serial string
    (String) A unique number denoting the latest revision of the domain.
    Tags []string
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Target string
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    UpdateDate string
    (Timestamp) The date that the domain record was last updated.
    dnsDomainId String
    (String) The unique internal identifier of the domain record.
    name String
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    serial String
    (String) A unique number denoting the latest revision of the domain.
    tags List<String>
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target String
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    updateDate String
    (Timestamp) The date that the domain record was last updated.
    dnsDomainId string
    (String) The unique internal identifier of the domain record.
    name string
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    serial string
    (String) A unique number denoting the latest revision of the domain.
    tags string[]
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target string
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    updateDate string
    (Timestamp) The date that the domain record was last updated.
    dns_domain_id str
    (String) The unique internal identifier of the domain record.
    name str
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    serial str
    (String) A unique number denoting the latest revision of the domain.
    tags Sequence[str]
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target str
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    update_date str
    (Timestamp) The date that the domain record was last updated.
    dnsDomainId String
    (String) The unique internal identifier of the domain record.
    name String
    The name of the domain. For example, "example.com". When the domain is created, proper NS and SOA records are created automatically for the domain.
    serial String
    (String) A unique number denoting the latest revision of the domain.
    tags List<String>
    Tags associated with the DNS domain instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    target String
    The primary target IP address to which the domain resolves. When the domain is created, an A record with a host value of @ and a data-target value of the IP address are provided and associated with the new domain.
    updateDate String
    (Timestamp) The date that the domain record was last updated.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm