AwsRoute53

Service-level AWS Route53 component.

Remarks

This is the primary component resource for the package. It orchestrates either hosted-zone creation or record creation within a single capability-oriented component boundary.

Naming:

• Root type token: ${namespace}:aws:AwsRoute53; capability literal: route53. The root is ${env}-${projectHash}-route53-${sanitiseNamePart(identity)}, where identity is the active args.zone.name or args.record.name. It is shared with the semantic provider DNS name.
• aws:route53/zone:Zone child candidate tuple: [args.zone.name]; final logical name: ${env}-${projectHash}-${sanitiseNamePart(args.zone.name)}.
• aws:route53/record:Record scalar child candidate tuple: [args.record.name, args.record.type]; final logical name: ${env}-${projectHash}-${sanitiseNamePart(args.record.name)}-${sanitiseNamePart(args.record.type)}. Keyed-map children use [args.record.name, <args.record.type map key>] and the same final formula.
• Hosted-zone name and record name are semantic/external DNS identifiers. They are forwarded byte-for-byte from args.zone.name and args.record.name; Route53/provider validation owns their DNS constraints. The AWS six-style naming standard does not apply.

Example

const hostedZone = new AwsRoute53({
  zone: {
    name: 'example.com',
  },
});

const apiRecord = new AwsRoute53({
  record: {
    zoneId: hostedZone.zone!.zoneId,
    name: 'api.example.com',
    type: 'A',
    aliases: [
      {
        name: 'dualstack.alb-123.eu-central-1.elb.amazonaws.com',
        zoneId: 'Z35SXDOTRQ7X7K',
        evaluateTargetHealth: false,
      },
    ],
  },
});

Constructors

new AwsRoute53( args: AwsRoute53Args, options?: ComponentResourceOptions, ): AwsRoute53

Parameters

• args (AwsRoute53Args) — Service-level Route53 capability inputs.The component logical name is derived from args.zone.name or args.record.name.
• options (ComponentResourceOptions, optional) — Optional settings controlling resource behaviour.

Returns

AwsRoute53

Hierarchy

• ComponentResource
• AwsRoute53

Properties

record: AwsRoute53Record

Optional record capability created by this component.

urn: Output<string>

Inherited from urn

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

zone: AwsRoute53Zone

Optional hosted-zone capability created by this component.

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>