AwsRoute53Domains

Service-level AWS Route53 Domains component.

Remarks

Naming:

• Root type token: ${namespace}:aws:AwsRoute53Domains; capability literal: route53-domains. The root is ${env}-${projectHash}-route53-domains-${sanitiseNamePart(args.registration.domainName)}. args.registration.domainName is a synchronous, semantic external DNS identifier shared with the provider field.
• AwsRoute53Domains → aws:route53domains/domain:Domain child candidate tuple: [args.registration.domainName]; final logical name: ${env}-${projectHash}-${sanitiseNamePart(args.registration.domainName)}.
• The Route53 Domains domainName is forwarded unchanged. Its DNS and TLD constraints are provider-owned, so the AWS six-style naming standard does not apply.
• WHOIS privacy is always enabled and cannot be disabled through this component. Transfer lock is always enabled except for .ch, .de, .eu, and .it, whose registries reject the post-registration lock operation. This exception prevents a failed deployment after the domain has been registered.
• Removing this resource deregisters the domain and AWS deletes the public hosted zone that it created. Keep this component while DNS records in that hosted zone remain required. Set options.protect to true when consumer policy must prevent an intentional deregistration.

Example

const contact: AwsRoute53DomainsContactArgs = {
  addressLine1: '101 Main Street', city: 'Zurich', contactType: 'COMPANY', countryCode: 'CH',
  email: 'domains@example.com', firstName: 'Domain', lastName: 'Owner', phoneNumber: '+41.441234567',
};

const domain = new AwsRoute53Domains({
  registration: {
    domainName: 'example.com', adminContact: contact, registrantContact: contact, techContact: contact,
  },
});

Constructors

new AwsRoute53Domains( args: AwsRoute53DomainsArgs, options?: ComponentResourceOptions, ): AwsRoute53Domains

Parameters

• args (AwsRoute53DomainsArgs) — Registration capability inputs.
• options (ComponentResourceOptions, optional) — Optional Pulumi resource options.

Returns

AwsRoute53Domains

Hierarchy

• ComponentResource
• AwsRoute53Domains

Properties

creationDate: Output<string>

Registration creation date.

domainId: Output<string>

Underlying Route53 Domains provider resource ID. Removing this component deregisters the domain.

domainName: Output<string>

Registered domain name.

expirationDate: Output<string>

Registration expiration date.

hostedZoneId: Output<string>

Public hosted-zone ID created by Route53 Domains. AWS deletes it when the domain is deregistered.

registrarName: Output<string>

Registrar name.

registrarUrl: Output<string>

Registrar URL.

statusLists: Output<string[]>

ICANN domain status codes.

urn: Output<string>

Inherited from urn

The stable logical URN used to distinctly address a resource, both before and after deployments.

Methods

getData(): Promise<any>

Inherited from getData

Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

• Promise<any>

getProvider(moduleMember: string): ProviderResource | undefined

Inherited from getProvider

Returns the provider for the given module member, if one exists.

Parameters

• moduleMember (string)

Returns

• ProviderResource | undefined

initialize( args: Inputs, opts?: ComponentResourceOptions, name?: string, type?: string, ): Promise<any>

Inherited from initialize

Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

Parameters

• args (Inputs)
• opts (ComponentResourceOptions, optional)
• name (string, optional)
• type (string, optional)

Returns

• Promise<any>

registerOutputs( outputs?: Inputs | Promise<Inputs> | Output<Inputs>, ): void

Inherited from registerOutputs

Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

• outputs (Inputs | Promise<Inputs> | Output<Inputs>, optional)

Returns

• void

Static Methods

isInstance(obj: any): obj is ComponentResource<any>

Inherited from isInstance

Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

Parameters

• obj (any)

Returns

• obj is ComponentResource<any>