1. Packages
  2. Ibm Provider
  3. API Docs
  4. DnsDomainRegistrationNameservers
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.DnsDomainRegistrationNameservers

Explore with Pulumi AI

Configures the (custom) name servers associated with a DNS domain registration managed by the IBM Cloud DNS Registration Service. The default IBM Cloud name servers specified when the domain was initially registered are replaced with the values passed when this resource is created. For more information, about Domain Name Registration, see getting started with Domain Name Registration.

This resource is typically used in conjunction with IBM Cloud Internet Services to enable DNS services for the domain to be managed via IBM Cloud Internet Services. All further configuration of the domain is then performed by using the Cloud Internet Services resource instances. To transfer management control, the IBM Cloud DNS domain registration is updated with the Internet Services specific name servers. This step is required before the domain in Cloud Internet Services becomes active and start serving web traffic. Using interpolation syntax, the computed name servers of the CIS resource are passed into this resource.

Example Usage

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

const dnstestdomainDnsDomainRegistration = ibm.getDnsDomainRegistration({
    name: "dnstestdomain.com",
});
const dnstestdomainCisDomain = new ibm.CisDomain("dnstestdomainCisDomain", {});
const dnstestdomainDnsDomainRegistrationNameservers = new ibm.DnsDomainRegistrationNameservers("dnstestdomainDnsDomainRegistrationNameservers", {
    dnsRegistrationId: dnstestdomainDnsDomainRegistration.then(dnstestdomainDnsDomainRegistration => dnstestdomainDnsDomainRegistration.id),
    nameServers: dnstestdomainCisDomain.nameServers,
});
Copy
import pulumi
import pulumi_ibm as ibm

dnstestdomain_dns_domain_registration = ibm.get_dns_domain_registration(name="dnstestdomain.com")
dnstestdomain_cis_domain = ibm.CisDomain("dnstestdomainCisDomain")
dnstestdomain_dns_domain_registration_nameservers = ibm.DnsDomainRegistrationNameservers("dnstestdomainDnsDomainRegistrationNameservers",
    dns_registration_id=dnstestdomain_dns_domain_registration.id,
    name_servers=dnstestdomain_cis_domain.name_servers)
Copy
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 {
		dnstestdomainDnsDomainRegistration, err := ibm.GetDnsDomainRegistration(ctx, &ibm.GetDnsDomainRegistrationArgs{
			Name: "dnstestdomain.com",
		}, nil)
		if err != nil {
			return err
		}
		dnstestdomainCisDomain, err := ibm.NewCisDomain(ctx, "dnstestdomainCisDomain", nil)
		if err != nil {
			return err
		}
		_, err = ibm.NewDnsDomainRegistrationNameservers(ctx, "dnstestdomainDnsDomainRegistrationNameservers", &ibm.DnsDomainRegistrationNameserversArgs{
			DnsRegistrationId: pulumi.Float64(dnstestdomainDnsDomainRegistration.Id),
			NameServers:       dnstestdomainCisDomain.NameServers,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dnstestdomainDnsDomainRegistration = Ibm.GetDnsDomainRegistration.Invoke(new()
    {
        Name = "dnstestdomain.com",
    });

    var dnstestdomainCisDomain = new Ibm.CisDomain("dnstestdomainCisDomain");

    var dnstestdomainDnsDomainRegistrationNameservers = new Ibm.DnsDomainRegistrationNameservers("dnstestdomainDnsDomainRegistrationNameservers", new()
    {
        DnsRegistrationId = dnstestdomainDnsDomainRegistration.Apply(getDnsDomainRegistrationResult => getDnsDomainRegistrationResult.Id),
        NameServers = dnstestdomainCisDomain.NameServers,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDnsDomainRegistrationArgs;
import com.pulumi.ibm.CisDomain;
import com.pulumi.ibm.DnsDomainRegistrationNameservers;
import com.pulumi.ibm.DnsDomainRegistrationNameserversArgs;
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 dnstestdomainDnsDomainRegistration = IbmFunctions.getDnsDomainRegistration(GetDnsDomainRegistrationArgs.builder()
            .name("dnstestdomain.com")
            .build());

        var dnstestdomainCisDomain = new CisDomain("dnstestdomainCisDomain");

        var dnstestdomainDnsDomainRegistrationNameservers = new DnsDomainRegistrationNameservers("dnstestdomainDnsDomainRegistrationNameservers", DnsDomainRegistrationNameserversArgs.builder()
            .dnsRegistrationId(dnstestdomainDnsDomainRegistration.applyValue(getDnsDomainRegistrationResult -> getDnsDomainRegistrationResult.id()))
            .nameServers(dnstestdomainCisDomain.nameServers())
            .build());

    }
}
Copy
resources:
  dnstestdomainDnsDomainRegistrationNameservers:
    type: ibm:DnsDomainRegistrationNameservers
    properties:
      dnsRegistrationId: ${dnstestdomainDnsDomainRegistration.id}
      nameServers: ${dnstestdomainCisDomain.nameServers}
  dnstestdomainCisDomain:
    type: ibm:CisDomain
variables:
  dnstestdomainDnsDomainRegistration:
    fn::invoke:
      function: ibm:getDnsDomainRegistration
      arguments:
        name: dnstestdomain.com
Copy

Or

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

const dns_domain_testDnsDomainRegistration = ibm.getDnsDomainRegistration({
    name: "test-domain.com",
});
const dns_domain_testDnsDomainRegistrationNameservers = new ibm.DnsDomainRegistrationNameservers("dns-domain-testDnsDomainRegistrationNameservers", {
    dnsRegistrationId: dns_domain_testDnsDomainRegistration.then(dns_domain_testDnsDomainRegistration => dns_domain_testDnsDomainRegistration.id),
    nameServers: [
        "ns006.name.ibm.cloud.com",
        "ns017.name.ibm.cloud.com",
    ],
});
Copy
import pulumi
import pulumi_ibm as ibm

dns_domain_test_dns_domain_registration = ibm.get_dns_domain_registration(name="test-domain.com")
dns_domain_test_dns_domain_registration_nameservers = ibm.DnsDomainRegistrationNameservers("dns-domain-testDnsDomainRegistrationNameservers",
    dns_registration_id=dns_domain_test_dns_domain_registration.id,
    name_servers=[
        "ns006.name.ibm.cloud.com",
        "ns017.name.ibm.cloud.com",
    ])
Copy
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 {
		dns_domain_testDnsDomainRegistration, err := ibm.GetDnsDomainRegistration(ctx, &ibm.GetDnsDomainRegistrationArgs{
			Name: "test-domain.com",
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.NewDnsDomainRegistrationNameservers(ctx, "dns-domain-testDnsDomainRegistrationNameservers", &ibm.DnsDomainRegistrationNameserversArgs{
			DnsRegistrationId: pulumi.Float64(dns_domain_testDnsDomainRegistration.Id),
			NameServers: pulumi.StringArray{
				pulumi.String("ns006.name.ibm.cloud.com"),
				pulumi.String("ns017.name.ibm.cloud.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dns_domain_testDnsDomainRegistration = Ibm.GetDnsDomainRegistration.Invoke(new()
    {
        Name = "test-domain.com",
    });

    var dns_domain_testDnsDomainRegistrationNameservers = new Ibm.DnsDomainRegistrationNameservers("dns-domain-testDnsDomainRegistrationNameservers", new()
    {
        DnsRegistrationId = dns_domain_testDnsDomainRegistration.Apply(dns_domain_testDnsDomainRegistration => dns_domain_testDnsDomainRegistration.Apply(getDnsDomainRegistrationResult => getDnsDomainRegistrationResult.Id)),
        NameServers = new[]
        {
            "ns006.name.ibm.cloud.com",
            "ns017.name.ibm.cloud.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDnsDomainRegistrationArgs;
import com.pulumi.ibm.DnsDomainRegistrationNameservers;
import com.pulumi.ibm.DnsDomainRegistrationNameserversArgs;
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 dns-domain-testDnsDomainRegistration = IbmFunctions.getDnsDomainRegistration(GetDnsDomainRegistrationArgs.builder()
            .name("test-domain.com")
            .build());

        var dns_domain_testDnsDomainRegistrationNameservers = new DnsDomainRegistrationNameservers("dns-domain-testDnsDomainRegistrationNameservers", DnsDomainRegistrationNameserversArgs.builder()
            .dnsRegistrationId(dns_domain_testDnsDomainRegistration.id())
            .nameServers(            
                "ns006.name.ibm.cloud.com",
                "ns017.name.ibm.cloud.com")
            .build());

    }
}
Copy
resources:
  dns-domain-testDnsDomainRegistrationNameservers:
    type: ibm:DnsDomainRegistrationNameservers
    properties:
      dnsRegistrationId: ${["dns-domain-testDnsDomainRegistration"].id}
      nameServers:
        - ns006.name.ibm.cloud.com
        - ns017.name.ibm.cloud.com
variables:
  dns-domain-testDnsDomainRegistration:
    fn::invoke:
      function: ibm:getDnsDomainRegistration
      arguments:
        name: test-domain.com
Copy

Create DnsDomainRegistrationNameservers Resource

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

Constructor syntax

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

@overload
def DnsDomainRegistrationNameservers(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     dns_registration_id: Optional[str] = None,
                                     name_servers: Optional[Sequence[str]] = None,
                                     dns_domain_registration_nameservers_id: Optional[str] = None)
func NewDnsDomainRegistrationNameservers(ctx *Context, name string, args DnsDomainRegistrationNameserversArgs, opts ...ResourceOption) (*DnsDomainRegistrationNameservers, error)
public DnsDomainRegistrationNameservers(string name, DnsDomainRegistrationNameserversArgs args, CustomResourceOptions? opts = null)
public DnsDomainRegistrationNameservers(String name, DnsDomainRegistrationNameserversArgs args)
public DnsDomainRegistrationNameservers(String name, DnsDomainRegistrationNameserversArgs args, CustomResourceOptions options)
type: ibm:DnsDomainRegistrationNameservers
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DnsDomainRegistrationNameserversArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DnsDomainRegistrationNameserversArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DnsDomainRegistrationNameserversArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DnsDomainRegistrationNameserversArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DnsDomainRegistrationNameserversArgs
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 dnsDomainRegistrationNameserversResource = new Ibm.DnsDomainRegistrationNameservers("dnsDomainRegistrationNameserversResource", new()
{
    DnsRegistrationId = "string",
    NameServers = new[]
    {
        "string",
    },
    DnsDomainRegistrationNameserversId = "string",
});
Copy
example, err := ibm.NewDnsDomainRegistrationNameservers(ctx, "dnsDomainRegistrationNameserversResource", &ibm.DnsDomainRegistrationNameserversArgs{
DnsRegistrationId: pulumi.String("string"),
NameServers: pulumi.StringArray{
pulumi.String("string"),
},
DnsDomainRegistrationNameserversId: pulumi.String("string"),
})
Copy
var dnsDomainRegistrationNameserversResource = new DnsDomainRegistrationNameservers("dnsDomainRegistrationNameserversResource", DnsDomainRegistrationNameserversArgs.builder()
    .dnsRegistrationId("string")
    .nameServers("string")
    .dnsDomainRegistrationNameserversId("string")
    .build());
Copy
dns_domain_registration_nameservers_resource = ibm.DnsDomainRegistrationNameservers("dnsDomainRegistrationNameserversResource",
    dns_registration_id="string",
    name_servers=["string"],
    dns_domain_registration_nameservers_id="string")
Copy
const dnsDomainRegistrationNameserversResource = new ibm.DnsDomainRegistrationNameservers("dnsDomainRegistrationNameserversResource", {
    dnsRegistrationId: "string",
    nameServers: ["string"],
    dnsDomainRegistrationNameserversId: "string",
});
Copy
type: ibm:DnsDomainRegistrationNameservers
properties:
    dnsDomainRegistrationNameserversId: string
    dnsRegistrationId: string
    nameServers:
        - string
Copy

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

DnsRegistrationId This property is required. string
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
NameServers This property is required. List<string>
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
DnsDomainRegistrationNameserversId string
(String) The unique internal identifier of the domain registration record.
DnsRegistrationId This property is required. string
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
NameServers This property is required. []string
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
DnsDomainRegistrationNameserversId string
(String) The unique internal identifier of the domain registration record.
dnsRegistrationId This property is required. String
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
nameServers This property is required. List<String>
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
dnsDomainRegistrationNameserversId String
(String) The unique internal identifier of the domain registration record.
dnsRegistrationId This property is required. string
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
nameServers This property is required. string[]
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
dnsDomainRegistrationNameserversId string
(String) The unique internal identifier of the domain registration record.
dns_registration_id This property is required. str
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
name_servers This property is required. Sequence[str]
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
dns_domain_registration_nameservers_id str
(String) The unique internal identifier of the domain registration record.
dnsRegistrationId This property is required. String
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
nameServers This property is required. List<String>
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
dnsDomainRegistrationNameserversId String
(String) The unique internal identifier of the domain registration record.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
OriginalNameServers List<string>
(String) The original name servers configured at the time of domain registration.
Id string
The provider-assigned unique ID for this managed resource.
OriginalNameServers []string
(String) The original name servers configured at the time of domain registration.
id String
The provider-assigned unique ID for this managed resource.
originalNameServers List<String>
(String) The original name servers configured at the time of domain registration.
id string
The provider-assigned unique ID for this managed resource.
originalNameServers string[]
(String) The original name servers configured at the time of domain registration.
id str
The provider-assigned unique ID for this managed resource.
original_name_servers Sequence[str]
(String) The original name servers configured at the time of domain registration.
id String
The provider-assigned unique ID for this managed resource.
originalNameServers List<String>
(String) The original name servers configured at the time of domain registration.

Look up Existing DnsDomainRegistrationNameservers Resource

Get an existing DnsDomainRegistrationNameservers 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?: DnsDomainRegistrationNameserversState, opts?: CustomResourceOptions): DnsDomainRegistrationNameservers
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_domain_registration_nameservers_id: Optional[str] = None,
        dns_registration_id: Optional[str] = None,
        name_servers: Optional[Sequence[str]] = None,
        original_name_servers: Optional[Sequence[str]] = None) -> DnsDomainRegistrationNameservers
func GetDnsDomainRegistrationNameservers(ctx *Context, name string, id IDInput, state *DnsDomainRegistrationNameserversState, opts ...ResourceOption) (*DnsDomainRegistrationNameservers, error)
public static DnsDomainRegistrationNameservers Get(string name, Input<string> id, DnsDomainRegistrationNameserversState? state, CustomResourceOptions? opts = null)
public static DnsDomainRegistrationNameservers get(String name, Output<String> id, DnsDomainRegistrationNameserversState state, CustomResourceOptions options)
resources:  _:    type: ibm:DnsDomainRegistrationNameservers    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DnsDomainRegistrationNameserversId string
(String) The unique internal identifier of the domain registration record.
DnsRegistrationId string
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
NameServers List<string>
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
OriginalNameServers List<string>
(String) The original name servers configured at the time of domain registration.
DnsDomainRegistrationNameserversId string
(String) The unique internal identifier of the domain registration record.
DnsRegistrationId string
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
NameServers []string
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
OriginalNameServers []string
(String) The original name servers configured at the time of domain registration.
dnsDomainRegistrationNameserversId String
(String) The unique internal identifier of the domain registration record.
dnsRegistrationId String
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
nameServers List<String>
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
originalNameServers List<String>
(String) The original name servers configured at the time of domain registration.
dnsDomainRegistrationNameserversId string
(String) The unique internal identifier of the domain registration record.
dnsRegistrationId string
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
nameServers string[]
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
originalNameServers string[]
(String) The original name servers configured at the time of domain registration.
dns_domain_registration_nameservers_id str
(String) The unique internal identifier of the domain registration record.
dns_registration_id str
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
name_servers Sequence[str]
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
original_name_servers Sequence[str]
(String) The original name servers configured at the time of domain registration.
dnsDomainRegistrationNameserversId String
(String) The unique internal identifier of the domain registration record.
dnsRegistrationId String
The unique ID of the domain's registration. This is exported by the ibm.getDnsDomainRegistration data source.
nameServers List<String>
Example for an array of name servers returned from configuration of a domain on an instance of IBM Cloud Internet Services. This is of the format: [ns006.name.cloud.ibm.com, ns017.name.cloud.ibm.com].
originalNameServers List<String>
(String) The original name servers configured at the time of domain registration.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.