AwsRoute53ZoneArgs

interface AwsRoute53ZoneArgs extends Omit<aws.route53.ZoneArgs, 'name'> { comment?: Input<string | undefined>; delegationSetId?: Input<string | undefined>; enableAcceleratedRecovery?: Input<boolean | undefined>; forceDestroy?: Input<boolean | undefined>; name: string; tags?: Input<{ [key: string]: Input<string> } | undefined>; vpcId?: Input<string>; vpcName?: Input<string>; vpcs?: Input<Input<ZoneVpc>[] | undefined>; }

Input arguments for the hosted-zone capability of AwsRoute53.

Remarks

This type maps directly to aws.route53.ZoneArgs.

Example

CODE
const zoneArgs: AwsRoute53ZoneArgs = {
  name: 'example.com',
};

Hierarchy

  • ZoneArgs, "name">
  • AwsRoute53ZoneArgs

Properties

comment: Input<string | undefined>

Inherited from comment

A comment for the hosted zone. Defaults to 'Managed by Pulumi'.

delegationSetId: Input<string | undefined>

Inherited from delegationSetId

The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.

enableAcceleratedRecovery: Input<boolean | undefined>

Inherited from enableAcceleratedRecovery

Boolean to indicate whether to enable accelerated recovery for the hosted zone. Defaults to false. Once set, switching to false requires explicitly specifying false rather than removing the argument.

forceDestroy: Input<boolean | undefined>

Inherited from forceDestroy

Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.

name: string

Hosted zone domain name.

Remarks

Required synchronous plain-string value used as the Pulumi logical identity source. It drives ${env}-${projectHash}-${sanitiseNamePart(name)} for the hosted-zone child resource and ${env}-${projectHash}-route53-${sanitiseNamePart(name)} for the parent AwsRoute53 component logical name.

pulumi.Output, promises, and other asynchronous values are not accepted for this identity input.

The AWS provider hosted-zone/domain name remains a separate provider concern.

tags: Input<{ [key: string]: Input<string> } | undefined>

Inherited from tags

A mapping of tags to assign to the zone. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpcId: Input<string>

Private hosted zones only: VPC id to associate the zone with.

Remarks

Convenience alternative to providing vpcs.

Precedence: vpcs (explicit) -> vpcId -> vpcName.

vpcName: Input<string>

Private hosted zones only: VPC name to associate the zone with.

Remarks

Convenience alternative to providing vpcs. The VPC is resolved by the Name tag (tag:Name == vpcName) and the zone is created as a private hosted zone by setting vpcs automatically.

Precedence: vpcs (explicit) -> vpcId -> vpcName.

vpcs: Input<Input<ZoneVpc>[] | undefined>

Inherited from vpcs

Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegationSetId argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.