createHostedZone method

Future<CreateHostedZoneResponse> createHostedZone({ required String callerReference, required String name, String? delegationSetId, HostedZoneConfig? hostedZoneConfig, VPC? vpc, })

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). For more information about charges for hosted zones, see Amazon Route 53 Pricing.

Note the following:

• You can't create a hosted zone for a top-level domain (TLD) such as .com.
• For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

  If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.

• If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

May throw InvalidDomainName. May throw HostedZoneAlreadyExists. May throw TooManyHostedZones. May throw InvalidVPCId. May throw InvalidInput. May throw DelegationSetNotAvailable. May throw ConflictingDomainExists. May throw NoSuchDelegationSet. May throw DelegationSetNotReusable.

Parameter callerReference : A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

Parameter name : The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

Parameter delegationSetId : If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

Parameter hostedZoneConfig : (Optional) A complex type that contains the following optional values:

• For public and private hosted zones, an optional comment
• For private hosted zones, an optional PrivateZone element

If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

Parameter vpc : (Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

Implementation

Future<CreateHostedZoneResponse> createHostedZone({
  required String callerReference,
  required String name,
  String? delegationSetId,
  HostedZoneConfig? hostedZoneConfig,
  VPC? vpc,
}) async {
  ArgumentError.checkNotNull(callerReference, 'callerReference');
  _s.validateStringLength(
    'callerReference',
    callerReference,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    0,
    1024,
    isRequired: true,
  );
  _s.validateStringLength(
    'delegationSetId',
    delegationSetId,
    0,
    32,
  );
  final $result = await _protocol.sendRaw(
    method: 'POST',
    requestUri: '/2013-04-01/hostedzone',
    payload: CreateHostedZoneRequest(
            callerReference: callerReference,
            name: name,
            delegationSetId: delegationSetId,
            hostedZoneConfig: hostedZoneConfig,
            vpc: vpc)
        .toXml(
      'CreateHostedZoneRequest',
      attributes: [
        _s.XmlAttribute(_s.XmlName('xmlns'),
            'https://route53.amazonaws.com/doc/2013-04-01/'),
      ],
    ),
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return CreateHostedZoneResponse(
    changeInfo: ChangeInfo.fromXml(_s.extractXmlChild($elem, 'ChangeInfo')!),
    delegationSet:
        DelegationSet.fromXml(_s.extractXmlChild($elem, 'DelegationSet')!),
    hostedZone: HostedZone.fromXml(_s.extractXmlChild($elem, 'HostedZone')!),
    vpc: _s.extractXmlChild($elem, 'VPC')?.let((e) => VPC.fromXml(e)),
    location: _s.extractHeaderStringValue($result.headers, 'Location')!,
  );
}