String type
The limit that you requested. Valid values include the following:
MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)
Long value
The current value for the limit that is specified by Type.
String region
For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.
String name
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
Route 53 supports CloudWatch alarms with the following features:
Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
String hostedZoneId
Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using
the AWS CLI command describe
-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Elastic Load Balancing table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more
information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.
AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see
the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference.
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
String dNSName
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalDomainName.
For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the
associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
Enter the API endpoint for the interface endpoint, such as
vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For
edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value
of DnsName using the AWS CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment
in, you can create an alias record that routes traffic to the environment. For example, the domain name
my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.
For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute
for the environment. You can use the following methods to get the value of the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the
CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments command to get the value of the CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.
AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of
DNSName. For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
AWS CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example,
s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3)
Website Endpoints in the Amazon Web Services General Reference. For more information about using S3
buckets for websites, see Getting Started with Amazon
Route 53 in the Amazon Route 53 Developer Guide.
Specify the value of the Name element for a resource record set in the current hosted zone.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't
specify the domain name for a record for which the value of Type is CNAME. This is
because the alias record must have the same type as the record that you're routing traffic to, and creating a
CNAME record for the zone apex isn't supported even for an alias record.
Boolean evaluateTargetHealth
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record
sets: When EvaluateTargetHealth is true, an alias resource record set inherits the
health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted
zone.
Note the following:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load
balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with
the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one
Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2
instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available
resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
Health checking behavior depends on the type of load balancer:
Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load
Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If
you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the
load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you
set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on
the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
There are no special requirements for setting EvaluateTargetHealth to true when the
alias target is an S3 bucket.
If the AWS resource that you specify in DNSName is a record or a group of records (for example, a
group of weighted records) but is not another alias record, we recommend that you associate a health check with
all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
String hostedZoneId
The ID of the private hosted zone that you want to associate an Amazon VPC with.
Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.
VPC vPC
A complex type that contains information about the VPC that you want to associate with a private hosted zone.
String comment
Optional: A comment about the association request.
ChangeInfo changeInfo
A complex type that describes the changes made to your hosted zone.
String action
The action to perform:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes a existing resource record set.
To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you
delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically
delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.
UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record
set does exist, Route 53 updates it with the values in the request.
ResourceRecordSet resourceRecordSet
Information about the resource record set to create, delete, or update.
String comment
Optional: Any comments you want to include about a change batch request.
SdkInternalList<T> changes
Information about the changes to make to the record sets.
String id
The ID of the request.
String status
The current state of the request. PENDING indicates that this request has not yet been applied to
all Amazon Route 53 DNS servers.
Date submittedAt
The date and time that the change request was submitted in ISO
8601 format and Coordinated Universal Time (UTC). For example, the value
2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
String comment
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String hostedZoneId
The ID of the hosted zone that contains the resource record sets that you want to change.
ChangeBatch changeBatch
A complex type that contains an optional comment and the Changes element.
ChangeInfo changeInfo
A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String resourceType
The type of the resource.
The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
String resourceId
The ID of the resource for which you want to add, change, or delete tags.
SdkInternalList<T> addTags
A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone
and/or the tags that you want to edit Value for.
You can add a maximum of 10 tags to a health check or a hosted zone.
SdkInternalList<T> removeTagKeys
A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.
Integer evaluationPeriods
For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
Double threshold
For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
String comparisonOperator
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
Integer period
For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
String metricName
The name of the CloudWatch metric that the alarm is associated with.
String namespace
The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
String statistic
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
SdkInternalList<T> dimensions
For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
String callerReference
A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck
request without the risk of creating two identical health checks:
If you send a CreateHealthCheck request with the same CallerReference and settings as a
previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health
check does exist, Route 53 returns the settings for the existing health check.
If you send a CreateHealthCheck request with the same CallerReference as a deleted
health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same CallerReference as an existing
health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique CallerReference but settings
identical to an existing health check, Route 53 creates the health check.
HealthCheckConfig healthCheckConfig
A complex type that contains settings for a new health check.
HealthCheck healthCheck
A complex type that contains identifying information about the health check.
String location
The unique URL representing the new health check.
String 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.
VPC 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.
String 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.
HostedZoneConfig 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.
String 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.
HostedZone hostedZone
A complex type that contains general information about the hosted zone.
ChangeInfo changeInfo
A complex type that contains information about the CreateHostedZone request.
DelegationSet delegationSet
A complex type that describes the name servers for this hosted zone.
VPC vPC
A complex type that contains information about an Amazon VPC that you associated with this hosted zone.
String location
The unique URL representing the new hosted zone.
String hostedZoneId
The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.
String cloudWatchLogsLogGroupArn
The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:
arn:aws:logs:region:account-id:log-group:log_group_name
To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the AWS SDKs.
QueryLoggingConfig queryLoggingConfig
A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.
String location
The unique URL representing the new query logging configuration.
String callerReference
A unique string that identifies the request, and that allows you to retry failed
CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use
a unique CallerReference string every time you submit a CreateReusableDelegationSet
request. CallerReference can be any unique string, for example a date/time stamp.
String hostedZoneId
If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.
DelegationSet delegationSet
A complex type that contains name server information.
String location
The unique URL representing the new reusable delegation set.
String hostedZoneId
The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.
String name
The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance.
Long tTL
(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.
String trafficPolicyId
The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
Integer trafficPolicyVersion
The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the new traffic policy instance.
String location
A unique URL that represents a new traffic policy instance.
String name
The name of the traffic policy.
String document
The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.
String comment
(Optional) Any comments that you want to include about the traffic policy.
TrafficPolicy trafficPolicy
A complex type that contains settings for the new traffic policy.
String location
A unique URL that represents a new traffic policy.
String id
The ID of the traffic policy for which you want to create a new version.
String document
The definition of this version of the traffic policy, in JSON format. You specified the JSON in the
CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.
String comment
The comment that you specified in the CreateTrafficPolicyVersion request, if any.
TrafficPolicy trafficPolicy
A complex type that contains settings for the new version of the traffic policy.
String location
A unique URL that represents a new traffic policy version.
String id
The ID that Amazon Route 53 assigns to a reusable delegation set.
String callerReference
The value that you specified for CallerReference when you created the reusable delegation set.
SdkInternalList<T> nameServers
A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
String healthCheckId
The ID of the health check that you want to delete.
String id
The ID of the hosted zone you want to delete.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone.
String id
The ID of the configuration that you want to delete.
String id
The ID of the reusable delegation set that you want to delete.
String id
The ID of the traffic policy instance that you want to delete.
When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.
String hostedZoneId
When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone.
VPC vPC
When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC.
String hostedZoneId
The ID of the private hosted zone that you want to disassociate a VPC from.
VPC vPC
A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.
String comment
Optional: A comment about the disassociation request.
ChangeInfo changeInfo
A complex type that describes the changes made to the specified private hosted zone.
String continentCode
The two-letter code for the continent.
Valid values: AF | AN | AS | EU | OC |
NA | SA
Constraint: Specifying ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
String countryCode
The two-letter code for the country.
String subdivisionCode
The code for the subdivision. Route 53 currently supports only states in the United States.
String continentCode
The two-letter code for the continent.
String continentName
The full name of the continent.
String countryCode
The two-letter code for the country.
String countryName
The name of the country.
String subdivisionCode
The code for the subdivision. Route 53 currently supports only states in the United States.
String subdivisionName
The full name of the subdivision. Route 53 currently supports only states in the United States.
String type
The limit that you want to get. Valid values include the following:
MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)
AccountLimit limit
The current setting for the specified limit. For example, if you specified
MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of
Limit is the maximum number of health checks that you can create using the current account.
Long count
The current number of entities that you have created of the specified type. For example, if you specified
MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of
Count is the current number of health checks that you have created using the current account.
String id
The ID of the change batch request. The value that you specify here is the value that
ChangeResourceRecordSets returned in the Id element when you submitted the request.
ChangeInfo changeInfo
A complex type that contains information about the specified change batch.
SdkInternalList<T> checkerIpRanges
A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
String continentCode
Amazon Route 53 supports the following continent codes:
AF: Africa
AN: Antarctica
AS: Asia
EU: Europe
OC: Oceania
NA: North America
SA: South America
String countryCode
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
String subdivisionCode
Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in ISO standard 3166-1 alpha-2. Route 53 doesn't support
subdivision codes for all countries. If you specify subdivisioncode, you must also specify
countrycode.
GeoLocationDetails geoLocationDetails
A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.
Long healthCheckCount
The number of health checks associated with the current AWS account.
String healthCheckId
The ID for the health check for which you want the last failure reason. When you created the health check,
CreateHealthCheck returned the ID in the response, in the HealthCheckId element.
If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53
console or the CloudWatch console. You can't use GetHealthCheckLastFailureReason for a calculated
health check.
SdkInternalList<T> healthCheckObservations
A list that contains one Observation element for each Amazon Route 53 health checker that is
reporting a last failure reason.
String healthCheckId
The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
HealthCheck healthCheck
A complex type that contains information about one health check that is associated with the current AWS account.
String healthCheckId
The ID for the health check that you want the current status for. When you created the health check,
CreateHealthCheck returned the ID in the response, in the HealthCheckId element.
If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the
CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health
check.
SdkInternalList<T> healthCheckObservations
A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that
is reporting a status about the health check endpoint.
Long hostedZoneCount
The total number of public and private hosted zones that are associated with the current AWS account.
String type
The limit that you want to get. Valid values include the following:
MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.
String hostedZoneId
The ID of the hosted zone that you want to get a limit for.
HostedZoneLimit limit
The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for
the value of Type in the request, the value of Limit is the maximum number of records
that you can create in the specified hosted zone.
Long count
The current number of entities that you have created of the specified type. For example, if you specified
MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of
Count is the current number of records that you have created in the specified hosted zone.
String id
The ID of the hosted zone that you want to get information about.
HostedZone hostedZone
A complex type that contains general information about the specified hosted zone.
DelegationSet delegationSet
A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.
SdkInternalList<T> vPCs
A complex type that contains information about the VPCs that are associated with the specified hosted zone.
String id
The ID of the configuration for DNS query logging that you want to get information about.
QueryLoggingConfig queryLoggingConfig
A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request.
ReusableDelegationSetLimit limit
The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set.
Long count
The current number of hosted zones that you can associate with the specified reusable delegation set.
String id
The ID of the reusable delegation set that you want to get a list of name servers for.
DelegationSet delegationSet
A complex type that contains information about the reusable delegation set.
Integer trafficPolicyInstanceCount
The number of traffic policy instances that are associated with the current AWS account.
String id
The ID of the traffic policy instance that you want to get information about.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the traffic policy instance.
TrafficPolicy trafficPolicy
A complex type that contains settings for the specified traffic policy.
String id
The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
String callerReference
A unique string that you specified when you created the health check.
LinkedService linkedService
If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.
HealthCheckConfig healthCheckConfig
A complex type that contains detailed information about one health check.
Long healthCheckVersion
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck
to prevent overwriting another change to the health check.
CloudWatchAlarmConfiguration cloudWatchAlarmConfiguration
A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
String iPAddress
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you
don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that
you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the
endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC
5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your
EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of
your instance will never change.
For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
Integer port
The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for
Port only when you specify a value for IPAddress.
String type
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or
later.
HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP
request and searches the first 5,120 bytes of the response body for the string that you specify in
SearchString.
HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
HTTPS request and searches the first 5,120 bytes of the response body for the string that you
specify in SearchString.
TCP: Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is
OK, the health check is considered healthy. If the state is ALARM, the health check is
considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is
OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number
of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of
HealthThreshold.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
String resourcePath
The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any
value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for
example, the file /docs/route53-health-check.html. You can also include query string parameters, for example,
/welcome.html?language=jp&login=y.
String fullyQualifiedDomainName
Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP health
checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform
health checks.
When Route 53 checks the health of an endpoint, here is how it constructs the Host header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for Type,
Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.
If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of
IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the
interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then
checks the health of the endpoint.
If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the
endpoint. If there's no resource record set with a type of A for the name that you specify for
FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify
the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check
for each endpoint. For example, create a health check for each HTTP server that is serving content for
www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server
(such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
In this configuration, if you create a health check for which the value of FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with those resource record
sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value for
IPAddress. If the value of Type is TCP, Route 53 doesn't pass a
Host header.
String searchString
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the
response body, Route 53 considers the resource healthy.
Route 53 considers case when searching for SearchString in the response body.
Integer requestInterval
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30 seconds.
Integer failureThreshold
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
Boolean measureLatency
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
Boolean inverted
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
Boolean disabled
Stops Route 53 from performing health checks. When you disable a health check, here's what happens:
Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
Integer healthThreshold
The number of child health checks that are associated with a CALCULATED health check that Amazon
Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify
the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element.
Note the following:
If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
If you specify 0, Route 53 always considers this health check to be healthy.
SdkInternalList<T> childHealthChecks
(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check.
Boolean enableSNI
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to
HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the client_hello
message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the
error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint
responds to the client_hello message with a certificate that does not include the domain name that
you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second
attempt, the health checker will omit FullyQualifiedDomainName from the client_hello
message.
SdkInternalList<T> regions
A complex type that contains one Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint.
If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
AlarmIdentifier alarmIdentifier
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
String insufficientDataHealthStatus
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Route 53 considers the health check to be healthy.
Unhealthy: Route 53 considers the health check to be unhealthy.
LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had
sufficient data to determine the alarm state. For new health checks that have no last known status, the default
status for the health check is healthy.
String region
The region of the Amazon Route 53 health checker that provided the status in StatusReport.
String iPAddress
The IP address of the Amazon Route 53 health checker that provided the failure reason in
StatusReport.
StatusReport statusReport
A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.
String id
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
String name
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.
String callerReference
The value that you specified for CallerReference when you created the hosted zone.
HostedZoneConfig config
A complex type that includes the Comment and PrivateZone elements. If you omitted the
HostedZoneConfig and Comment elements from the request, the Config and
Comment elements don't appear in the response.
Long resourceRecordSetCount
The number of resource record sets in the hosted zone.
LinkedService linkedService
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.
String type
The limit that you requested. Valid values include the following:
MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.
Long value
The current value for the limit that is specified by Type.
SdkInternalList<T> messages
Descriptive message for the error response.
String servicePrincipal
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.
String description
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.
String startContinentCode
The code for the continent with which you want to start listing locations that Amazon Route 53 supports for
geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and
if NextContinentCode from the previous response has a value, enter that value in
startcontinentcode to return the next page of results.
Include startcontinentcode only if you want to list continents. Don't include
startcontinentcode when you're listing countries or countries with their subdivisions.
String startCountryCode
The code for the country with which you want to start listing locations that Amazon Route 53 supports for
geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is
true, and if NextCountryCode from the previous response has a value, enter that value
in startcountrycode to return the next page of results.
Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
String startSubdivisionCode
The code for the subdivision (for example, state or province) with which you want to start listing locations that
Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if
IsTruncated is true, and if NextSubdivisionCode from the previous response
has a value, enter that value in startsubdivisioncode to return the next page of results.
To list subdivisions of a country, you must include both startcountrycode and
startsubdivisioncode.
String maxItems
(Optional) The maximum number of geolocations to be included in the response body for this request. If more than
maxitems geolocations remain to be listed, then the value of the IsTruncated element in
the response is true.
SdkInternalList<T> geoLocationDetailsList
A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53
supports for geolocation.
Boolean isTruncated
A value that indicates whether more locations remain to be listed after the last location in this response. If
so, the value of IsTruncated is true. To get more values, submit another request and
include the values of NextContinentCode, NextCountryCode, and
NextSubdivisionCode in the startcontinentcode, startcountrycode, and
startsubdivisioncode, as applicable.
String nextContinentCode
If IsTruncated is true, you can make a follow-up request to display more locations.
Enter the value of NextContinentCode in the startcontinentcode parameter in another
ListGeoLocations request.
String nextCountryCode
If IsTruncated is true, you can make a follow-up request to display more locations.
Enter the value of NextCountryCode in the startcountrycode parameter in another
ListGeoLocations request.
String nextSubdivisionCode
If IsTruncated is true, you can make a follow-up request to display more locations.
Enter the value of NextSubdivisionCode in the startsubdivisioncode parameter in another
ListGeoLocations request.
String maxItems
The value that you specified for MaxItems in the request.
String marker
If the value of IsTruncated in the previous response was true, you have more health
checks. To get another group, submit another ListHealthChecks request.
For the value of marker, specify the value of NextMarker from the previous response,
which is the ID of the first health check that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more
health checks to get.
String maxItems
The maximum number of health checks that you want ListHealthChecks to return in response to the
current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value
greater than 100, Route 53 returns only the first 100 health checks.
SdkInternalList<T> healthChecks
A complex type that contains one HealthCheck element for each health check that is associated with
the current AWS account.
String marker
For the second and subsequent calls to ListHealthChecks, Marker is the value that you
specified for the marker parameter in the previous request.
Boolean isTruncated
A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can
get the next group of health checks by submitting another ListHealthChecks request and specifying
the value of NextMarker in the marker parameter.
String nextMarker
If IsTruncated is true, the value of NextMarker identifies the first
health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify
the value of NextMarker in the marker parameter.
String maxItems
The value that you specified for the maxitems parameter in the call to ListHealthChecks
that produced the current response.
String dNSName
(Optional) For your first request to ListHostedZonesByName, include the dnsname
parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the
dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current
AWS account, in ASCII order. For subsequent requests, include both dnsname and
hostedzoneid parameters. For dnsname, specify the value of NextDNSName
from the previous response.
String hostedZoneId
(Optional) For your first request to ListHostedZonesByName, do not include the
hostedzoneid parameter.
If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns
only the first maxitems hosted zones. To get the next group of maxitems hosted zones,
submit another request to ListHostedZonesByName and include both dnsname and
hostedzoneid parameters. For the value of hostedzoneid, specify the value of the
NextHostedZoneId element from the previous response.
String maxItems
The maximum number of hosted zones to be included in the response body for this request. If you have more than
maxitems hosted zones, then the value of the IsTruncated element in the response is
true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone
in the next group of maxitems hosted zones.
SdkInternalList<T> hostedZones
A complex type that contains general information about the hosted zone.
String dNSName
For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that
you specified for the dnsname parameter in the request that produced the current response.
String hostedZoneId
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
Boolean isTruncated
A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can
get the next group of maxitems hosted zones by calling ListHostedZonesByName again and
specifying the values of NextDNSName and NextHostedZoneId elements in the
dnsname and hostedzoneid parameters.
String nextDNSName
If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone
in the next group of maxitems hosted zones. Call ListHostedZonesByName again and
specify the value of NextDNSName and NextHostedZoneId in the dnsname and
hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
String nextHostedZoneId
If IsTruncated is true, the value of NextHostedZoneId identifies the first
hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName
again and specify the value of NextDNSName and NextHostedZoneId in the
dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
String maxItems
The value that you specified for the maxitems parameter in the call to
ListHostedZonesByName that produced the current response.
String marker
If the value of IsTruncated in the previous response was true, you have more hosted
zones. To get more hosted zones, submit another ListHostedZones request.
For the value of marker, specify the value of NextMarker from the previous response,
which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more
hosted zones to get.
String maxItems
(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than
maxitems hosted zones, the value of IsTruncated in the response is true,
and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return
if you submit another request.
String delegationSetId
If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.
SdkInternalList<T> hostedZones
A complex type that contains general information about the hosted zone.
String marker
For the second and subsequent calls to ListHostedZones, Marker is the value that you
specified for the marker parameter in the request that produced the current response.
Boolean isTruncated
A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get
more hosted zones by submitting another ListHostedZones request and specifying the value of
NextMarker in the marker parameter.
String nextMarker
If IsTruncated is true, the value of NextMarker identifies the first
hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify
the value of NextMarker from the response in the marker parameter.
This element is present only if IsTruncated is true.
String maxItems
The value that you specified for the maxitems parameter in the call to ListHostedZones
that produced the current response.
String hostedZoneId
(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the
ID in HostedZoneId.
If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations
that are associated with the current AWS account.
String nextToken
(Optional) If the current AWS account has more than MaxResults query logging configurations, use
NextToken to get the second and subsequent pages of results.
For the first ListQueryLoggingConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request.
String maxResults
(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response
to the current request. If the current AWS account has more than MaxResults configurations, use the
value of NextToken in the response to get the next page of results.
If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.
SdkInternalList<T> queryLoggingConfigs
An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current AWS account.
String nextToken
If a response includes the last of the query logging configurations that are associated with the current AWS
account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting
another
ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the
previous response and include it in NextToken in the next request.
String hostedZoneId
The ID of the hosted zone that contains the resource record sets that you want to list.
String startRecordName
The first name in the lexicographic ordering of resource record sets that you want to list.
String startRecordType
The type of resource record set to begin the record listing from.
Valid values for basic resource record sets: A | AAAA | CAA |
CNAME | MX | NAPTR | NS | PTR | SOA
| SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA
| CAA | CNAME | MX | NAPTR | PTR |
SPF | SRV | TXT
Values for alias resource record sets:
API Gateway custom regional API or edge-optimized API: A
CloudFront distribution: A or AAAA
Elastic Beanstalk environment that has a regionalized subdomain: A
Elastic Load Balancing load balancer: A | AAAA
Amazon S3 bucket: A
Amazon VPC interface VPC endpoint: A
Another resource record set in this hosted zone: The type of the resource record set that the alias references.
Constraint: Specifying type without specifying name returns an
InvalidInput error.
String startRecordIdentifier
Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the
value of NextRecordIdentifier from the previous response to get the next resource record set that
has the current DNS name and type.
String maxItems
(Optional) The maximum number of resource records sets to include in the response body for this request. If the
response includes more than maxitems resource record sets, the value of the IsTruncated
element in the response is true, and the values of the NextRecordName and
NextRecordType elements in the response identify the first resource record set in the next group of
maxitems resource record sets.
SdkInternalList<T> resourceRecordSets
Information about multiple resource record sets.
Boolean isTruncated
A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you
can make a follow-up pagination request by using the NextRecordName element.
String nextRecordName
If the results were truncated, the name of the next record in the list.
This element is present only if IsTruncated is true.
String nextRecordType
If the results were truncated, the type of the next record in the list.
This element is present only if IsTruncated is true.
String nextRecordIdentifier
Resource record sets that have a routing policy other than simple: If results were truncated for a given
DNS name and type, the value of SetIdentifier for the next resource record set that has the current
DNS name and type.
For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.
String maxItems
The maximum number of records you requested.
String marker
If the value of IsTruncated in the previous response was true, you have more reusable
delegation sets. To get another group, submit another ListReusableDelegationSets request.
For the value of marker, specify the value of NextMarker from the previous response,
which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another
request.
If the value of IsTruncated in the previous response was false, there are no more
reusable delegation sets to get.
String maxItems
The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.
SdkInternalList<T> delegationSets
A complex type that contains one DelegationSet element for each reusable delegation set that was
created by the current AWS account.
String marker
For the second and subsequent calls to ListReusableDelegationSets, Marker is the value
that you specified for the marker parameter in the request that produced the current response.
Boolean isTruncated
A flag that indicates whether there are more reusable delegation sets to be listed.
String nextMarker
If IsTruncated is true, the value of NextMarker identifies the next
reusable delegation set that Amazon Route 53 will return if you submit another
ListReusableDelegationSets request and specify the value of NextMarker in the
marker parameter.
String maxItems
The value that you specified for the maxitems parameter in the call to
ListReusableDelegationSets that produced the current response.
ResourceTagSet resourceTagSet
A ResourceTagSet containing tags associated with the specified resource.
String resourceType
The type of the resources.
The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
SdkInternalList<T> resourceIds
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
SdkInternalList<T> resourceTagSets
A list of ResourceTagSets containing tags associated with the specified resources.
String trafficPolicyIdMarker
(Conditional) For your first request to ListTrafficPolicies, don't include the
TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems, ListTrafficPolicies
returns only the first MaxItems traffic policies. To get the next group of policies, submit another
request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the
value of TrafficPolicyIdMarker that was returned in the previous response.
String maxItems
(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this
request. If you have more than MaxItems traffic policies, the value of IsTruncated in
the response is true, and the value of TrafficPolicyIdMarker is the ID of the first
traffic policy that Route 53 will return if you submit another request.
SdkInternalList<T> trafficPolicySummaries
A list that contains one TrafficPolicySummary element for each traffic policy that was created by
the current AWS account.
Boolean isTruncated
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you
can get the next group of traffic policies by submitting another ListTrafficPolicies request and
specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request
parameter.
String trafficPolicyIdMarker
If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of
the first traffic policy in the next group of MaxItems traffic policies.
String maxItems
The value that you specified for the MaxItems parameter in the ListTrafficPolicies
request that produced the current response.
String hostedZoneId
The ID of the hosted zone that you want to list traffic policy instances for.
String trafficPolicyInstanceNameMarker
If the value of IsTruncated in the previous response is true, you have more traffic policy
instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request.
For the value of trafficpolicyinstancename, specify the value of
TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic
policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String trafficPolicyInstanceTypeMarker
If the value of IsTruncated in the previous response is true, you have more traffic policy
instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request.
For the value of trafficpolicyinstancetype, specify the value of
TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic
policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String maxItems
The maximum number of traffic policy instances to be included in the response body for this request. If you have
more than MaxItems traffic policy instances, the value of the IsTruncated element in
the response is true, and the values of HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the
first traffic policy instance that Amazon Route 53 will return if you submit another request.
SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches
the elements in the request.
String trafficPolicyInstanceNameMarker
If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the
first traffic policy instance in the next group of traffic policy instances.
String trafficPolicyInstanceTypeMarker
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource
record sets that are associated with the first traffic policy instance in the next group of traffic policy
instances.
Boolean isTruncated
A flag that indicates whether there are more traffic policy instances to be listed. If the response was
truncated, you can get the next group of traffic policy instances by submitting another
ListTrafficPolicyInstancesByHostedZone request and specifying the values of
HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker in the corresponding request parameters.
String maxItems
The value that you specified for the MaxItems parameter in the
ListTrafficPolicyInstancesByHostedZone request that produced the current response.
String trafficPolicyId
The ID of the traffic policy for which you want to list traffic policy instances.
Integer trafficPolicyVersion
The version of the traffic policy for which you want to list traffic policy instances. The version must be
associated with the traffic policy that is specified by TrafficPolicyId.
String hostedZoneIdMarker
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get more traffic policy instances, submit another
ListTrafficPolicyInstancesByPolicy request.
For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the
previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String trafficPolicyInstanceNameMarker
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get more traffic policy instances, submit another
ListTrafficPolicyInstancesByPolicy request.
For the value of trafficpolicyinstancename, specify the value of
TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic
policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String trafficPolicyInstanceTypeMarker
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get more traffic policy instances, submit another
ListTrafficPolicyInstancesByPolicy request.
For the value of trafficpolicyinstancetype, specify the value of
TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic
policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String maxItems
The maximum number of traffic policy instances to be included in the response body for this request. If you have
more than MaxItems traffic policy instances, the value of the IsTruncated element in
the response is true, and the values of HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the
first traffic policy instance that Amazon Route 53 will return if you submit another request.
SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches
the elements in the request.
String hostedZoneIdMarker
If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of
the first traffic policy instance in the next group of traffic policy instances.
String trafficPolicyInstanceNameMarker
If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the
first traffic policy instance in the next group of MaxItems traffic policy instances.
String trafficPolicyInstanceTypeMarker
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of
the resource record sets that are associated with the first traffic policy instance in the next group of
MaxItems traffic policy instances.
Boolean isTruncated
A flag that indicates whether there are more traffic policy instances to be listed. If the response was
truncated, you can get the next group of traffic policy instances by calling
ListTrafficPolicyInstancesByPolicy again and specifying the values of the
HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
String maxItems
The value that you specified for the MaxItems parameter in the call to
ListTrafficPolicyInstancesByPolicy that produced the current response.
String hostedZoneIdMarker
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances
request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from
the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of
traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String trafficPolicyInstanceNameMarker
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances
request. For the value of trafficpolicyinstancename, specify the value of
TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic
policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String trafficPolicyInstanceTypeMarker
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances
request. For the value of trafficpolicyinstancetype, specify the value of
TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic
policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
String maxItems
The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a
ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy
instances, the value of the IsTruncated element in the response is true, and the values
of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of
MaxItems traffic policy instances.
SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches
the elements in the request.
String hostedZoneIdMarker
If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of
the first traffic policy instance that Route 53 will return if you submit another
ListTrafficPolicyInstances request.
String trafficPolicyInstanceNameMarker
If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the
first traffic policy instance that Route 53 will return if you submit another
ListTrafficPolicyInstances request.
String trafficPolicyInstanceTypeMarker
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of
the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will
return if you submit another ListTrafficPolicyInstances request.
Boolean isTruncated
A flag that indicates whether there are more traffic policy instances to be listed. If the response was
truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and
specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker in the corresponding request parameters.
String maxItems
The value that you specified for the MaxItems parameter in the call to
ListTrafficPolicyInstances that produced the current response.
String id
Specify the value of Id of the traffic policy for which you want to list all versions.
String trafficPolicyVersionMarker
For your first request to ListTrafficPolicyVersions, don't include the
TrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of MaxItems,
ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get
more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of
TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the
previous response.
String maxItems
The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for
this request. If the specified traffic policy has more than MaxItems versions, the value of
IsTruncated in the response is true, and the value of the
TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you
submit another request.
SdkInternalList<T> trafficPolicies
A list that contains one TrafficPolicy element for each traffic policy version that is associated
with the specified traffic policy.
Boolean isTruncated
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you
can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request
and specifying the value of NextMarker in the marker parameter.
String trafficPolicyVersionMarker
If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies
the first traffic policy that Amazon Route 53 will return if you submit another request. Call
ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in
the TrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is true.
String maxItems
The value that you specified for the maxitems parameter in the
ListTrafficPolicyVersions request that produced the current response.
String hostedZoneId
The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.
String nextToken
Optional: If a response includes a NextToken element, there are more VPCs that can be
associated with the specified hosted zone. To get the next page of results, submit another request, and include
the value of NextToken from the response in the nexttoken parameter in another
ListVPCAssociationAuthorizations request.
String maxResults
Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If
you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page.
String hostedZoneId
The ID of the hosted zone that you can associate the listed VPCs with.
String nextToken
When the response includes a NextToken element, there are more VPCs that can be associated with the
specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations
request, and include the value of the NextToken element from the response in the
nexttoken request parameter.
SdkInternalList<T> vPCs
The list of VPCs that are authorized to be associated with the specified hosted zone.
String id
The ID for a configuration for DNS query logging.
String hostedZoneId
The ID of the hosted zone that CloudWatch Logs is logging queries for.
String cloudWatchLogsLogGroupArn
The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
String value
The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action,
if the current value does not match the actual value, an error is returned. For descriptions about how to format
Value for different record types, see Supported DNS Resource
Record Types in the Amazon Route 53 Developer Guide.
You can specify more than one value for all record types except CNAME and SOA.
If you're creating an alias resource record set, omit Value.
String name
For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or
delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com. You can optionally include a
trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify 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.
For information about how to specify characters other than a-z, 0-9, and -
(hyphen) and how to specify internationalized domain names, see DNS Domain Name Format
in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example,
*.example.com. Note the following:
The * must replace the entire label. For example, you can't specify *prod.example.com or
prod*.example.com.
The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You
can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the
* must replace the entire label; for example, you can't specify prod*.example.com.
String type
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A | AAAA | CAA |
CNAME | MX | NAPTR | NS | PTR | SOA
| SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA
| CAA | CNAME | MX | NAPTR | PTR |
SPF | SRV | TXT. When creating a group of weighted, latency, geolocation,
or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets: A | AAAA | MX |
NAPTR | PTR | SPF | SRV | TXT
SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer
recommend that you create resource record sets for which the value of Type is SPF. RFC
7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated
to say,
"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it."
In RFC 7208, see section 14.1, The SPF DNS Record
Type.
Values for alias resource record sets:
Amazon API Gateway custom regional APIs and edge-optimized APIs: A
CloudFront distributions: A
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution,
one with a value of A and one with a value of AAAA.
AWS Elastic Beanstalk environment that has a regionalized subdomain: A
ELB load balancers: A | AAAA
Amazon S3 buckets: A
Amazon Virtual Private Cloud interface VPC endpoints A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're
creating the alias for. All values are supported except NS and SOA.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't
route traffic to a record for which the value of Type is CNAME. This is because the
alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the
zone apex isn't supported even for an alias record.
String setIdentifier
Resource record sets that have a routing policy other than simple: An identifier that differentiates among
multiple resource record sets that have the same combination of name and type, such as multiple weighted resource
record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same
name and type, the value of SetIdentifier must be unique for each resource record set.
For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.
Long weight
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
You must specify a value for the Weight element for every weighted resource record set.
You can only specify one ResourceRecord per weighted resource record set.
You can't create latency, failover, or geolocation resource record sets that have the same values for the
Name and Type elements as weighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the same values for the Name
and Type elements.
For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for
a resource record set, Route 53 never responds to queries with the applicable value for that resource record set.
However, if you set Weight to 0 for all resource record sets that have the same
combination of DNS name and type, traffic is routed to all resources with equal probability.
The effect of setting Weight to 0 is different when you associate health checks with
weighted resource record sets. For more information, see Options for
Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
String region
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Creating latency and latency alias resource record sets in private hosted zones is not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and
Type elements as latency resource record sets.
GeoLocation geoLocation
Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds
to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to
be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a
Type of A and a ContinentCode of AF.
Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic locations that aren't
specified in other geolocation resource record sets that have the same values for the Name and
Type elements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic
locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will
receive some DNS queries from locations that it can't identify. We recommend that you create a resource record
set for which the value of CountryCode is *, which handles both queries that come from
locations for which you haven't created geolocation resource record sets and queries from IP addresses that
aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a
"no answer" response for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for the Name and
Type elements as geolocation resource record sets.
String failover
Failover resource record sets only: To configure failover, you add the Failover element to
two resource record sets. For one resource record set, you specify PRIMARY as the value for
Failover; for the other resource record set, you specify SECONDARY. In addition, you
include the HealthCheckId element and specify the health check that you want Amazon Route 53 to
perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the HealthCheckId
element in both resource record sets:
When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
If you omit the HealthCheckId element for the secondary resource record set, and if the primary
resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the
secondary resource record set. This is true regardless of the health of the associated endpoint.
You can't create non-failover resource record sets that have the same values for the Name and
Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the EvaluateTargetHealth element and
set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:
Boolean multiValueAnswer
Multivalue answer resource record sets only: To route traffic approximately randomly to multiple
resources, such as web servers, create one multivalue answer record for each resource and specify
true for MultiValueAnswer. Note the following:
If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.
If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.
If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.
You can't create multivalue answer alias records.
Long tTL
The resource record cache time to live (TTL), in seconds. Note the following:
If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the
value of TTL for the alias target.
If you're associating this resource record set with a health check (if you're adding a HealthCheckId
element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to
changes in health status.
All of the resource record sets in a group of weighted resource record sets must have the same value for
TTL.
If a group of weighted resource record sets includes one or more weighted alias resource record sets for which
the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all
of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds
(the TTL for load balancers) will change the effect of the values that you specify for Weight.
SdkInternalList<T> resourceRecords
Information about the resource records to act upon.
If you're creating an alias resource record set, omit ResourceRecords.
AliasTarget aliasTarget
Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
String healthCheckId
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of
a health check is healthy, include the HealthCheckId element and specify the ID of the applicable
health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the
endpoint specified by the IP address in the Value element. When you add a HealthCheckId
element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health
check.
For more information, see the following topics in the Amazon Route 53 Developer Guide:
When to Specify HealthCheckId
Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more
resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of
a health check. Configuring health checks makes sense only in the following configurations:
Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
Alias resource record sets: You specify the following settings:
You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record
sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com
with a type of A).
You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
You specify a health check ID for the non-alias resource record set.
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
Geolocation Routing
For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for
the larger, associated geographic region. For example, suppose you have resource record sets for a state in the
United States, for the entire United States, for North America, and a resource record set that has *
for CountryCode is *, which applies to all locations. If the endpoint for the state
resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until
it finds a resource record set for which the endpoint is healthy:
The United States
North America
The default resource record set
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health
check for each endpoint. For example, create a health check for each HTTP server that is serving
content for www.example.com. For the value of FullyQualifiedDomainName, specify the
domain name of the server (such as us-east-2-www.example.com), not the name of the resource record
sets (www.example.com).
Health check results will be unpredictable if you do the following:
Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource
record set.
Associate that health check with the resource record set.
String trafficPolicyInstanceId
When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set.
TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource
record set for.
To delete the resource record set that is associated with a traffic policy instance, use
DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you
delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically
delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.
String resourceType
The type of the resource.
The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
String resourceId
The ID for the specified resource.
SdkInternalList<T> tags
The tags associated with the specified resource.
String status
A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.
Date checkedTime
The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For
example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
String key
The value of Key depends on the operation that you want to perform:
Add a tag to a health check or hosted zone: Key is the name that you want to give the new
tag.
Edit a tag: Key is the name of the tag that you want to change the Value for.
Delete a key: Key is the name of the tag you want to remove.
Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the
list of your health checks includes a Name column that lets you see the name that you've given to each
health check.
String value
The value of Value depends on the operation that you want to perform:
Add a tag to a health check or hosted zone: Value is the value that you want to give the new
tag.
Edit a tag: Value is the new value that you want to assign the tag.
String hostedZoneId
The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.
String recordName
The name of the resource record set that you want Amazon Route 53 to simulate a query for.
String recordType
The type of the resource record set.
String resolverIP
If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you
omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N.
Virginia) Region (us-east-1).
String eDNS0ClientSubnetIP
If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in
the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.
String eDNS0ClientSubnetMask
If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits
of the IP address that you want the checking tool to include in the DNS query. For example, if you specify
192.0.2.44 for edns0clientsubnetip and 24 for
edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default
value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.
The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:
IPv4: Specify a value between 0 and 32
IPv6: Specify a value between 0 and 128
String nameserver
The Amazon Route 53 name server used to respond to the request.
String recordName
The name of the resource record set that you submitted a request for.
String recordType
The type of the resource record set that you submitted a request for.
SdkInternalList<T> recordData
A list that contains values that Amazon Route 53 returned for this resource record set.
String responseCode
A code that indicates whether the request is valid or not. The most common response code is NOERROR,
meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that
describes the error. For a list of possible response codes, see DNS RCODES on the
IANA website.
String protocol
The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.
String id
The ID that Amazon Route 53 assigned to a traffic policy when you created it.
Integer version
The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of
Version is always 1.
String name
The name that you specified when you created the traffic policy.
String type
The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
String document
The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy
in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.
String comment
The comment that you specify in the CreateTrafficPolicy request, if any.
String id
The ID that Amazon Route 53 assigned to the new traffic policy instance.
String hostedZoneId
The ID of the hosted zone that Amazon Route 53 created resource record sets in.
String name
The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.
Long tTL
The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.
String state
The value of State is one of the following values:
Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.
Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the
CreateTrafficPolicyInstance request completed successfully.
Route 53 wasn't able to create or update the resource record sets. When the value of State is
Failed, see Message for an explanation of what caused the request to fail.
String message
If State is Failed, an explanation of the reason for the failure. If State
is another value, Message is empty.
String trafficPolicyId
The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.
Integer trafficPolicyVersion
The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.
String trafficPolicyType
The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.
String id
The ID that Amazon Route 53 assigned to the traffic policy when you created it.
String name
The name that you specified for the traffic policy when you created it.
String type
The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
Integer latestVersion
The version number of the latest version of the traffic policy.
Integer trafficPolicyCount
The number of traffic policies that are associated with the current AWS account.
String healthCheckId
The ID for the health check for which you want detailed information. When you created the health check,
CreateHealthCheck returned the ID in the response, in the HealthCheckId element.
Long healthCheckVersion
A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by
1 each time you update settings for the health check.
We recommend that you use GetHealthCheck or ListHealthChecks to get the current value
of HealthCheckVersion for the health check that you want to update, and that you include that value
in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:
If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion
in the health check, Route 53 updates the health check with the new settings.
If the value of HealthCheckVersion in the health check is greater, the health check was changed
after you got the version number. Route 53 does not update the health check, and it returns a
HealthCheckVersionMismatch error.
String iPAddress
The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you
don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that
you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the
endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC
5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your
EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of
your instance never changes. For more information, see the applicable documentation:
Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances
Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances
If a health check already has a value for IPAddress, you can change the value. However, you can't
update an existing health check to add or remove the value of IPAddress.
For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
Integer port
The port on the endpoint on which you want Amazon Route 53 to perform health checks.
String resourcePath
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for
which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the
file /docs/route53-health-check.html. You can also include query string parameters, for example,
/welcome.html?language=jp&login=y.
Specify this value only if you want to change it.
String fullyQualifiedDomainName
Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If a health check already has a value for IPAddress, you can change the value. However, you can't
update an existing health check to add or remove the value of IPAddress.
If you specify a value for IPAddress:
Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP health
checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform
health checks.
When Route 53 checks the health of an endpoint, here is how it constructs the Host header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for Type,
Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the
Host header.
If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of
IPAddress in the Host header in each of the above cases.
If you don't specify a value for IPAddress:
If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you
specify in FullyQualifiedDomainName at the interval you specify in RequestInterval.
Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the
endpoint. If there's no resource record set with a type of A for the name that you specify for
FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify
the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check
for each endpoint. For example, create a health check for each HTTP server that is serving content for
www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server
(such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource
record sets and you then associate the health check with those resource record sets, health check results will be
unpredictable.
In addition, if the value of Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value for
IPAddress. If the value of Type is TCP, Route 53 doesn't pass a
Host header.
String searchString
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that
you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in
the response body, Route 53 considers the resource healthy. (You can't change the value of Type when
you update a health check.)
Integer failureThreshold
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
Boolean inverted
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
Boolean disabled
Stops Route 53 from performing health checks. When you disable a health check, here's what happens:
Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
Integer healthThreshold
The number of child health checks that are associated with a CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. To specify the child
health checks that you want to associate with a CALCULATED health check, use the
ChildHealthChecks and ChildHealthCheck elements.
Note the following:
If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
If you specify 0, Route 53 always considers this health check to be healthy.
SdkInternalList<T> childHealthChecks
A complex type that contains one ChildHealthCheck element for each health check that you want to
associate with a CALCULATED health check.
Boolean enableSNI
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint
to respond to HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the client_hello message. If you
don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check
can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the
SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint
responds to the client_hello message with a certificate that does not include the domain name that
you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second
attempt, the health checker will omit FullyQualifiedDomainName from the client_hello
message.
SdkInternalList<T> regions
A complex type that contains one Region element for each region that you want Amazon Route 53 health
checkers to check the specified endpoint from.
AlarmIdentifier alarmIdentifier
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
String insufficientDataHealthStatus
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Route 53 considers the health check to be healthy.
Unhealthy: Route 53 considers the health check to be unhealthy.
LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had
sufficient data to determine the alarm state. For new health checks that have no last known status, the default
status for the health check is healthy.
SdkInternalList<T> resetElements
A complex type that contains one ResettableElementName element for each element that you want to
reset to the default value. Valid values for ResettableElementName include the following:
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null.
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null.
Regions: Route 53 resets the Regions list to the default set of regions.
ResourcePath: Route 53 resets ResourcePath to null.
HealthCheck healthCheck
A complex type that contains the response to an UpdateHealthCheck request.
HostedZone hostedZone
A complex type that contains the response to the UpdateHostedZoneComment request.
TrafficPolicy trafficPolicy
A complex type that contains settings for the specified traffic policy.
String id
The ID of the traffic policy instance that you want to update.
Long tTL
The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
String trafficPolicyId
The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
Integer trafficPolicyVersion
The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the updated traffic policy instance.
String domainName
The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guidezzz.
String operation
The operation that you were charged for.
String invoiceId
The ID of the invoice that is associated with the billing record.
Date billDate
The date that the operation was billed, in Unix format.
Double price
The price that you were charged for the operation, in US dollars.
Example value: 12.0
String domainName
The name of the domain that you want to get availability for.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
String idnLangCode
Reserved for future use.
String availability
Whether the domain name is available for registering.
You can register only domains designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
String domainName
The name of the domain that you want to transfer to Amazon Route 53.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
String authCode
If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain.
DomainTransferability transferability
A complex type that contains information about whether the specified domain can be transferred to Amazon Route 53.
String firstName
First name of contact.
String lastName
Last name of contact.
String contactType
Indicates whether the contact is a person, company, association, or public organization. If you choose an option
other than PERSON, you must enter an organization name, and you can't enable privacy protection for
the contact.
String organizationName
Name of the organization for contact types other than PERSON.
String addressLine1
First line of the contact's address.
String addressLine2
Second line of contact's address, if any.
String city
The city of the contact's address.
String state
The state or province of the contact's city.
String countryCode
Code for the country of the contact's address.
String zipCode
The zip or postal code of the contact's address.
String phoneNumber
The phone number of the contact.
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code>]". For example, a US phone number might appear as
"+1.1234567890".
String email
Email address of the contact.
String fax
Fax number of the contact.
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code]". For example, a US phone number might appear as
"+1.1234567890".
SdkInternalList<T> extraParams
A list of name-value pairs for parameters required by certain top-level domains.
String domainName
The domain for which you want to delete one or more tags.
SdkInternalList<T> tagsToDelete
A list of tag keys to delete.
String domainName
The name of the domain that you want to disable automatic renewal for.
String domainName
The name of the domain that you want to remove the transfer lock for.
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
A suggested domain name.
String availability
Whether the domain name is available for registering.
You can register only the domains that are designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
String domainName
The name of the domain that the summary information applies to.
Boolean autoRenew
Indicates whether the domain is automatically renewed upon expiration.
Boolean transferLock
Indicates whether a domain is locked from unauthorized transfer to another party.
Date expiry
Expiration date of the domain in Coordinated Universal Time (UTC).
String transferable
String domainName
The name of the domain that you want to enable automatic renewal for.
String domainName
The name of the domain that you want to set the transfer lock for.
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String name
Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:
.com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE
.ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE
.es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM
.fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER,
FI_NATIONALITY, and FI_ORGANIZATION_TYPE
.fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD,
BIRTH_COUNTRY, and BIRTH_CITY
.it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE
.ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA
.se: BIRTH_COUNTRY and SE_ID_NUMBER
.sg: SG_ID_NUMBER
.co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER
In addition, many TLDs require VAT_NUMBER.
String value
Values corresponding to the additional parameter names required by some top-level domains.
String domainName
The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.
String domainName
The domain name for which you requested the reachability status.
String status
Whether the registrant contact has responded. Values include the following:
We sent the confirmation email and haven't received a response yet.
We sent the email and got confirmation from the registrant contact.
The time limit expired before the registrant contact responded.
String domainName
The name of the domain that you want to get detailed information about.
String domainName
The name of a domain.
SdkInternalList<T> nameservers
The name of the domain.
Boolean autoRenew
Specifies whether the domain registration is set to renew automatically.
ContactDetail adminContact
Provides details about the domain administrative contact.
ContactDetail registrantContact
Provides details about the domain registrant.
ContactDetail techContact
Provides details about the domain technical contact.
Boolean adminPrivacy
Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return
the information that you entered for the admin contact.
Boolean registrantPrivacy
Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return
the information that you entered for the registrant contact (domain owner).
Boolean techPrivacy
Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return
the information that you entered for the technical contact.
String registrarName
Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are
registered by Amazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for
domains that are registered by Gandi is "GANDI SAS".
String whoIsServer
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
String registrarUrl
Web address of the registrar.
String abuseContactEmail
Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
String abuseContactPhone
Phone number for reporting abuse.
String registryDomainId
Reserved for future use.
Date creationDate
The date when the domain was created as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).
Date updatedDate
The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).
Date expirationDate
The date when the registration for the domain is set to expire. The date and time is in Coordinated Universal time (UTC).
String reseller
Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have
"Amazon" as the reseller.
String dnsSec
Reserved for future use.
SdkInternalList<T> statusList
An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the
ICANN website; web searches sometimes return an old version of the document.)
String domainName
A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Integer suggestionCount
The number of suggested domain names that you want Amazon Route 53 to return.
Boolean onlyAvailable
If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available.
If OnlyAvailable is false, Amazon Route 53 returns domain names without checking
whether they're available to be registered. To determine whether the domain is available, you can call
checkDomainAvailability for each suggestion.
SdkInternalList<T> suggestionsList
A list of possible domain names. If you specified true for OnlyAvailable in the
request, the list contains only domains that are available for registration.
String operationId
The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.
String operationId
The identifier for the operation.
String status
The current status of the requested operation in the system.
String message
Detailed information on the status including possible errors.
String domainName
The name of a domain.
String type
The type of operation that was requested.
Date submittedDate
The date when the request was submitted.
String marker
For an initial request for a list of domains, omit this element. If the number of domains that are associated
with the current AWS account is greater than the value that you specified for MaxItems, you can use
Marker to return additional domains. Get the value of NextPageMarker from the previous
response, and submit another request that includes the value of NextPageMarker in the
Marker element.
Constraints: The marker must match the value specified in the previous request.
Integer maxItems
Number of domains to be returned.
Default: 20
SdkInternalList<T> domains
A summary of domains.
String nextPageMarker
If there are more domains than you specified for MaxItems in the request, submit another request and
include the value of NextPageMarker in the value of Marker.
Date submittedSince
An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Coordinated Universal time (UTC).
String marker
For an initial request for a list of operations, omit this element. If the number of operations that are not yet
complete is greater than the value that you specified for MaxItems, you can use Marker
to return additional operations. Get the value of NextPageMarker from the previous response, and
submit another request that includes the value of NextPageMarker in the Marker element.
Integer maxItems
Number of domains to be returned.
Default: 20
SdkInternalList<T> operations
Lists summaries of the operations.
String nextPageMarker
If there are more operations than you specified for MaxItems in the request, submit another request
and include the value of NextPageMarker in the value of Marker.
String domainName
The domain for which you want to get a list of tags.
SdkInternalList<T> tagList
A list of the tags that are associated with the specified domain.
String name
The fully qualified host name of the name server.
Constraint: Maximum 255 characters
SdkInternalList<T> glueIps
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
Constraints: The list can contain only one IPv4 and one IPv6 address.
String domainName
The domain name that you want to register.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Default: 1
Boolean autoRenew
Indicates whether the domain will be automatically renewed (true) or not (false).
Autorenewal only takes effect after the account is charged.
Default: true
ContactDetail adminContact
Provides detailed contact information.
ContactDetail registrantContact
Provides detailed contact information.
ContactDetail techContact
Provides detailed contact information.
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the admin contact.
Default: true
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the registrant contact (the domain owner).
Default: true
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the technical contact.
Default: true
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
The name of the domain that you want to renew.
Integer durationInYears
The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Default: 1
Integer currentExpiryYear
The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.
String operationId
The identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.
String domainName
The domain name for which you requested a confirmation email.
String emailAddress
The email address for the registrant contact at the time that we sent the verification email.
Boolean isAlreadyVerified
True if the email address for the registrant contact has already been verified, and
false otherwise. If the email address has already been verified, we don't send another confirmation
email.
String domainName
The name of the domain that you want to get an authorization code for.
String authCode
The authorization code for the domain.
String domainName
The name of the domain that you want to transfer to Amazon Route 53.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Default: 1
SdkInternalList<T> nameservers
Contains details for the host and glue IP addresses.
String authCode
The authorization code for the domain. You get this value from the current registrar.
Boolean autoRenew
Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Default: true
ContactDetail adminContact
Provides detailed contact information.
ContactDetail registrantContact
Provides detailed contact information.
ContactDetail techContact
Provides detailed contact information.
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the admin contact.
Default: true
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the registrant contact (domain owner).
Default: true
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the technical contact.
Default: true
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
The name of the domain that you want to update the privacy setting for.
Boolean adminPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the admin contact.
Boolean registrantPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the registrant contact (domain owner).
Boolean techPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS
("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or
for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return
the information that you entered for the technical contact.
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
The name of the domain that you want to update contact information for.
ContactDetail adminContact
Provides detailed contact information.
ContactDetail registrantContact
Provides detailed contact information.
ContactDetail techContact
Provides detailed contact information.
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
The name of the domain that you want to change name servers for.
String fIAuthKey
The authorization key for .fi domains
SdkInternalList<T> nameservers
A list of new name servers for the domain.
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
String domainName
The domain for which you want to add or update tags.
SdkInternalList<T> tagsToUpdate
A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.
Date start
The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).
Date end
The end date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).
String marker
For an initial request for a list of billing records, omit this element. If the number of billing records that
are associated with the current AWS account during the specified period is greater than the value that you
specified for MaxItems, you can use Marker to return additional billing records. Get
the value of NextPageMarker from the previous response, and submit another request that includes the
value of NextPageMarker in the Marker element.
Constraints: The marker must match the value of NextPageMarker that was returned in the previous
response.
Integer maxItems
The number of billing records to be returned.
Default: 20
String nextPageMarker
If there are more billing records than you specified for MaxItems in the request, submit another
request and include the value of NextPageMarker in the value of Marker.
SdkInternalList<T> billingRecords
A summary of billing records.
Copyright © 2019. All rights reserved.