RegisteredDomain class

Provides a resource to manage a domain that has been registered and associated with the current AWS account. To register, renew and deregister a domain use the aws.route53domains.Domain resource instead.

This is an advanced resource and has special caveats to be aware of when using it. Please read this document in its entirety before using this resource.

The aws.route53domains.RegisteredDomain resource behaves differently from normal resources in that if a domain has been registered, the provider does not register this domain, but instead "adopts" it into management. A destroy does not delete the domain but does remove the resource from state.

Example Usage

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

const example = new aws.route53domains.RegisteredDomain("example", {
    nameServers: [
        {
            name: "ns-195.awsdns-24.com",
        },
        {
            name: "ns-874.awsdns-45.net",
        },
    ],
    domainName: "example.com",
    tags: {
        Environment: "test",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.route53domains.RegisteredDomain("example",
    name_servers=[
        {
            "name": "ns-195.awsdns-24.com",
        },
        {
            "name": "ns-874.awsdns-45.net",
        },
    ],
    domain_name="example.com",
    tags={
        "Environment": "test",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Route53Domains.RegisteredDomain("example", new()
    {
        NameServers = new[]
        {
            new Aws.Route53Domains.Inputs.RegisteredDomainNameServerArgs
            {
                Name = "ns-195.awsdns-24.com",
            },
            new Aws.Route53Domains.Inputs.RegisteredDomainNameServerArgs
            {
                Name = "ns-874.awsdns-45.net",
            },
        },
        DomainName = "example.com",
        Tags =
        {
            { "Environment", "test" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53domains"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53domains.NewRegisteredDomain(ctx, "example", &route53domains.RegisteredDomainArgs{
			NameServers: route53domains.RegisteredDomainNameServerArray{
				&route53domains.RegisteredDomainNameServerArgs{
					Name: pulumi.String("ns-195.awsdns-24.com"),
				},
				&route53domains.RegisteredDomainNameServerArgs{
					Name: pulumi.String("ns-874.awsdns-45.net"),
				},
			},
			DomainName: pulumi.String("example.com"),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_route53domains_registereddomain" "example" {
  name_servers {
    name = "ns-195.awsdns-24.com"
  }
  name_servers {
    name = "ns-874.awsdns-45.net"
  }
  domain_name = "example.com"
  tags = {
    "Environment" = "test"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53domains.RegisteredDomain;
import com.pulumi.aws.route53domains.RegisteredDomainArgs;
import com.pulumi.aws.route53domains.inputs.RegisteredDomainNameServerArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new RegisteredDomain("example", RegisteredDomainArgs.builder()
            .nameServers(
                RegisteredDomainNameServerArgs.builder()
                    .name("ns-195.awsdns-24.com")
                    .build(),
                RegisteredDomainNameServerArgs.builder()
                    .name("ns-874.awsdns-45.net")
                    .build())
            .domainName("example.com")
            .tags(Map.of("Environment", "test"))
            .build());

    }
}
resources:
  example:
    type: aws:route53domains:RegisteredDomain
    properties:
      nameServers:
        - name: ns-195.awsdns-24.com
        - name: ns-874.awsdns-45.net
      domainName: example.com
      tags:
        Environment: test

Import

Using pulumi import, import domains using the domain name. For example:

$ pulumi import aws:route53domains/registeredDomain:RegisteredDomain example example.com

Constructors

RegisteredDomain(String name, {RegisteredDomainArgs? args, CustomResourceOptions? options})
Creates a new RegisteredDomain. name The Pulumi resource name. args Arguments used to configure this RegisteredDomain. The set of arguments for RegisteredDomain. options Resource options controlling this resource's behavior.
RegisteredDomain.reference(String urn)
Creates a typed reference to an existing RegisteredDomain resource.

Properties

abuseContactEmail ↔ Output<String>
Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
latefinal
abuseContactPhone ↔ Output<String>
Phone number for reporting abuse.
latefinal
adminContact ↔ Output<RegisteredDomainAdminContact>
Details about the domain administrative contact. See Contact Blocks for more details.
latefinal
adminPrivacy ↔ Output<bool?>
Whether domain administrative contact information is concealed from WHOIS queries. Default: true.
latefinal
autoRenew ↔ Output<bool?>
Whether the domain registration is set to renew automatically. Default: true.
latefinal
billingContact ↔ Output<RegisteredDomainBillingContact>
Details about the domain billing contact. See Contact Blocks for more details.
latefinal
billingPrivacy ↔ Output<bool?>
Whether domain billing contact information is concealed from WHOIS queries. Default: true.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationDate ↔ Output<String>
The date when the domain was created as found in the response to a WHOIS query.
latefinal
domainName ↔ Output<String>
The name of the registered domain.
latefinal
expirationDate ↔ Output<String>
The date when the registration for the domain is set to expire.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
nameServers ↔ Output<List<RegisteredDomainNameServer>>
The list of nameservers for the domain. See nameServer Blocks for more details.
latefinal
registrantContact ↔ Output<RegisteredDomainRegistrantContact>
Details about the domain registrant. See Contact Blocks for more details.
latefinal
registrantPrivacy ↔ Output<bool?>
Whether domain registrant contact information is concealed from WHOIS queries. Default: true.
latefinal
registrarName ↔ Output<String>
Name of the registrar of the domain as identified in the registry.
latefinal
registrarUrl ↔ Output<String>
Web address of the registrar.
latefinal
reseller ↔ Output<String>
Reseller of the domain.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
statusLists ↔ Output<List<String>>
List of domain name status codes.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
techContact ↔ Output<RegisteredDomainTechContact>
Details about the domain technical contact. See Contact Blocks for more details.
latefinal
techPrivacy ↔ Output<bool?>
Whether domain technical contact information is concealed from WHOIS queries. Default: true.
latefinal
transferLock ↔ Output<bool?>
Whether the domain is locked for transfer. Default: true.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updatedDate ↔ Output<String>
The last updated date of the domain as found in the response to a WHOIS query.
latefinal
urn ↔ Output<String>
latefinalinherited
whoisServer ↔ Output<String>
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RegisteredDomainState? state, CustomResourceOptions? options}) → RegisteredDomain
Gets an existing RegisteredDomain resource's state with the given name and id.