AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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:
DelegationSetId
element.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
.
The CreateHostedZone
request requires the caller to have an ec2:DescribeVpcs
permission.
When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
aws
- Amazon Web Services Regionsaws-cn
- China Regionsaws-us-gov
- Amazon Web Services GovCloud (US) RegionFor more information, see Access Management in the Amazon Web Services General Reference .
See also: AWS API Documentation
create-hosted-zone
--name <value>
[--vpc <value>]
--caller-reference <value>
[--hosted-zone-config <value>]
[--delegation-set-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--name
(string)
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
thatCreateHostedZone
returns inDelegationSet
.
--vpc
(structure)
(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. If you are associating a VPC with a hosted zone with this request, the paramaters
VPCId
andVPCRegion
are also required.To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.
VPCRegion -> (string)
(Private hosted zones only) The region that an Amazon VPC was created in.VPCId -> (string)
(Private hosted zones only) The ID of an Amazon VPC.
Shorthand Syntax:
VPCRegion=string,VPCId=string
JSON Syntax:
{
"VPCRegion": "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"eu-central-2"|"ap-east-1"|"me-south-1"|"us-gov-west-1"|"us-gov-east-1"|"us-iso-east-1"|"us-iso-west-1"|"us-isob-east-1"|"me-central-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-southeast-3"|"ap-south-1"|"ap-south-2"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"eu-north-1"|"sa-east-1"|"ca-central-1"|"cn-north-1"|"af-south-1"|"eu-south-1"|"eu-south-2"|"ap-southeast-4"|"il-central-1"|"ca-west-1"|"ap-southeast-5",
"VPCId": "string"
}
--caller-reference
(string)
A unique string that identifies the request and that allows failedCreateHostedZone
requests to be retried without the risk of executing the operation twice. You must use a uniqueCallerReference
string every time you submit aCreateHostedZone
request.CallerReference
can be any unique string, for example, a date/time stamp.
--hosted-zone-config
(structure)
(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
elementIf you don't specify a comment or the
PrivateZone
element, omitHostedZoneConfig
and the other elements.Comment -> (string)
Any comments that you want to include about the hosted zone.PrivateZone -> (boolean)
A value that indicates whether this is a private hosted zone.
Note do not include PrivateZone
in this input structure. Its value is returned in the output to the command.
Shorthand Syntax:
Comment=string,PrivateZone=boolean
JSON Syntax:
{
"Comment": "string",
"PrivateZone": true|false
}
--delegation-set-id
(string)
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 .
If you are using a reusable delegation set to create a public hosted zone for a subdomain, make sure that the parent hosted zone doesn't use one or more of the same name servers. If you have overlapping nameservers, the operation will cause a
ConflictingDomainsExist
error.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a hosted zone
The following create-hosted-zone
command adds a hosted zone named example.com
using the caller reference 2014-04-01-18:47
. The optional comment includes a space, so it must be enclosed in quotation marks:
aws route53 create-hosted-zone --name example.com --caller-reference 2014-04-01-18:47 --hosted-zone-config Comment="command-line version"
For more information, see Working with Hosted Zones in the Amazon Route 53 Developer Guide.
HostedZone -> (structure)
A complex type that contains general information about the hosted zone.
Id -> (string)
The ID that Amazon Route 53 assigned to the hosted zone when you created it.Name -> (string)
The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
For information about how to specify characters other than
a-z
,0-9
, and-
(hyphen) and how to specify internationalized domain names, see CreateHostedZone .CallerReference -> (string)
The value that you specified forCallerReference
when you created the hosted zone.Config -> (structure)
A complex type that includes the
Comment
andPrivateZone
elements. If you omitted theHostedZoneConfig
andComment
elements from the request, theConfig
andComment
elements don't appear in the response.Comment -> (string)
Any comments that you want to include about the hosted zone.PrivateZone -> (boolean)
A value that indicates whether this is a private hosted zone.ResourceRecordSetCount -> (long)
The number of resource record sets in the hosted zone.LinkedService -> (structure)
If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.
ServicePrincipal -> (string)
If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.Description -> (string)
If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
ChangeInfo -> (structure)
A complex type that contains information about the
CreateHostedZone
request.Id -> (string)
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.Status -> (string)
The current state of the request.PENDING
indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.SubmittedAt -> (timestamp)
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value2017-03-27T17:48:16.751Z
represents March 27, 2017 at 17:48:16.751 UTC.Comment -> (string)
A comment you can provide.
DelegationSet -> (structure)
A complex type that describes the name servers for this hosted zone.
Id -> (string)
The ID that Amazon Route 53 assigns to a reusable delegation set.CallerReference -> (string)
The value that you specified forCallerReference
when you created the reusable delegation set.NameServers -> (list)
A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
(string)
VPC -> (structure)
A complex type that contains information about an Amazon VPC that you associated with this hosted zone.
VPCRegion -> (string)
(Private hosted zones only) The region that an Amazon VPC was created in.VPCId -> (string)
(Private hosted zones only) The ID of an Amazon VPC.
Location -> (string)
The unique URL representing the new hosted zone.