String region
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in 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.
String hostedZoneId
Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront cannot be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the AWS General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2; page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the DNS Name. See HostedZone$Name.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of
CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See
HostedZone$Name.
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID. Use the same process to get the
CanonicalHostedZoneName. See HostedZone$Name.
Specify the hosted zone ID for the Amazon S3 website endpoint in which you created the bucket. For more information about valid values, see the table Amazon S3 (S3) Website Endpoints in the Amazon Web Services General Reference.
Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot 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:
A CloudFront distribution: 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.
Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of the
CNAME attribute:
AWS Managment Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Load Balancing 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.
An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using
the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for
HostedZoneId and DNSName. If you get one value from the console and the other value
from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID. See HostedZone$Id.
Elastic Load Balancing API: Use
DescribeLoadBalancers
to get the value of CanonicalHostedZoneName. Use the same process to get the
CanonicalHostedZoneNameId. See HostedZone$Id.
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneName. Use the same process to get the
CanonicalHostedZoneNameId. See HostedZoneId.
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3
website endpoint in which you created the bucket; for example, s3-website-us-east-1.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
Amazon S3 buckets for websites, see Hosting a Static Website on Amazon
S3 in the Amazon Simple Storage Service Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name element for a
resource record set in the current hosted zone.
Boolean evaluateTargetHealth
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of EvaluateTargetHealth to true for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget is a resource record set or a group of resource
record sets (for example, a group of weighted resource record sets), but it is not another alias resource record
set, we recommend that you associate a health check with all of the resource record sets in the alias target.For
more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if 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, Amazon
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.
If you specify an ELB load balancer in AliasTarget , Elastic Load Balancing routes queries
only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances
are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the
corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a
load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53
health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon
EC2 instances that you register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to
handle the failure of one or more endpoints.
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 hosted zone you want to associate your VPC with.
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
VPC vPC
A complex type containing information about the Amazon VPC that you're associating with the specified 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 that has the specified values for Name,
Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record
sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS
resource that you're routing DNS queries to).
To delete the resource record set that is associated with a traffic policy instance, use
DeleteTrafficPolicyInstance . Amazon Route 53will delete the resource record set
automatically. If you delete the resource record set by using ChangeResourceRecordSets, Amazon 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 does not already exist, Amazon Route 53 creates it. If a resource
record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an
existing resource record set only when all of the following values match: Name, Type,
and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).
ResourceRecordSet resourceRecordSet
Information about the resource record set to create or delete.
String comment
Optional: Any comments you want to include about a change batch request.
com.amazonaws.internal.SdkInternalList<T> changes
Information about the changes to make to the record sets.
String id
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Date submittedAt
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the
ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time
is listed in Coordinated Universal Time (UTC).
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.
Valid Values: PENDING | INSYNC
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 submitter
The AWS account ID attached to the changes.
com.amazonaws.internal.SdkInternalList<T> changes
A list of changes made in the ChangeBatch.
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 the change request was submitted, in Coordinated Universal Time (UTC) format:
YYYY-MM-DDThh:mm:ssZ. For more information, see the Wikipedia entry ISO 8601.
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.
com.amazonaws.internal.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 for which you want to edit the Value element.
You can add a maximum of 10 tags to a health check or a hosted zone.
com.amazonaws.internal.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 Developer Guide.
String statistic
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
com.amazonaws.internal.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 Developer Guide.
String callerReference
A unique string that identifies the request and that allows failed CreateHealthCheck requests to be
retried without the risk of executing the operation twice. You must use a unique CallerReference
string every time you create a health check.
HealthCheckConfig healthCheckConfig
A complex type that contains the response to a CreateHealthCheck request.
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. For resource record types that include a domain name, 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 Amazon 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 Amazon Route 53, change the name servers for your domain to
the set of NameServers that CreateHostedZone returns in the DelegationSet element.
VPC vPC
The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
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 create a hosted zone. CallerReference can be any unique string, for example, a
date/time stamp.
HostedZoneConfig hostedZoneConfig
(Optional) A complex type that contains an optional comment about your hosted zone. If you don't want to specify
a comment, omit both the HostedZoneConfig and Comment 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.
String
None
CreatedHostedZoneRequest
HostedZone hostedZone
A complex type that contains general information about the hosted zone.
ChangeInfo changeInfo
A complex type that describes the changes made to your hosted zone.
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 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 in which you want Amazon Route 53 to create resource record sets 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 Amazon 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 in the Amazon Route 53 API Reference.
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
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.
com.amazonaws.internal.SdkInternalList<T> nameServers
A complex type that contains a list of the authoritative name servers for the hosted zone.
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 your delete request.
String id
The ID of the reusable delegation set 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
The ID of the VPC that you want to disassociate from an Amazon Route 53 hosted zone.
VPC vPC
A complex type containing information about the Amazon 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 your 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, for example, a state in the United States or a province in Canada.
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, for example, a state in the United States or a province in Canada.
String subdivisionName
The full name of the subdivision, for example, a state in the United States or a province in Canada.
String id
The ID of the change batch. This is the value that you specified in the change ID parameter when you
submitted the request.
ChangeBatchRecord changeBatchRecord
A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the contained changes.
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.
com.amazonaws.internal.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. Amazon 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.
com.amazonaws.internal.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
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health
check is passing, include the HealthCheckId element and specify the ID of the applicable health
check.
Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more
resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the
status of a health check. Configuring health checks only makes sense in the following configurations:
You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted
alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs
for all of the resource record sets that are referenced by the alias resource record sets. For more information
about this configuration, see EvaluateTargetHealth.
Amazon Route 53 doesn't check the health of the endpoint 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, Amazon Route 53 checks the health of the endpoint that you specified in the
health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon 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 United States, for North America, and for all locations. If the endpoint for the
state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States,
for North America, and for all locations (a resource record set for which the value of CountryCode is
*), in that order, until it finds a resource record set for which the endpoint is healthy.
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-1-www.example.com), not the name of the resource record sets (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 then associate the health check with those resource record sets,
health check results will be unpredictable.
com.amazonaws.internal.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 associated with the current AWS account.
String id
The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
HostedZone hostedZone
A complex type that contains general information about the hosted zone.
DelegationSet delegationSet
A complex type that describes the name servers for this hosted zone.
com.amazonaws.internal.SdkInternalList<T> vPCs
A complex type that contains information about VPCs associated with the specified hosted zone.
String id
The ID of the reusable delegation set for which you want to get a list of the name server.
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.
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 IP address of the endpoint on which you want Amazon Route 53 to perform health checks. If you don't
specify a value for IPAddress, Amazon 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 DNS returns, Amazon Route 53 then checks the health of the endpoint.
If the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with
your Amazon 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 HealthCheckConfig$FullyQualifiedDomainName.
Contraints: Amazon Route 53 cannot 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 cannot create health checks, see RFC 5735, Special Use IPv4 Addresses and RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space.
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: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon 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: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon 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: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon 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: Amazon 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, Amazon Route 53 adds up the
number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with
the value of HealthThreshold.
For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.
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.
String fullyQualifiedDomainName
Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify IPAddress:
The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP
health checks. This is typically the fully qualified DNS name of the website that you are attempting to health
check. When Amazon 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, Amazon 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, Amazon 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,
Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host
header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of
IPAddress in the Host header in each of the preceding cases.
If you don't specify IPAddress:
If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that
you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval.
Using an IP address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
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-1-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, Amazon 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, Amazon 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, Amazon Route 53 considers the resource healthy.
Amazon 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 Amazon Route 53 health checker makes requests at this interval.
You can't change the value of RequestInterval after you create 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.
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 Amazon 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.
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
HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
AlarmIdentifier alarmIdentifier
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this 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: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53uses 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.
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.
com.amazonaws.internal.SdkInternalList<T> messages
Descriptive message for the error response.
String hostedZoneId
The ID of the hosted zone that you want to see changes for.
String startDate
The start of the time period you want to see changes for.
String endDate
The end of the time period you want to see changes for.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
String maxItems
The value that you specified for the maxitems parameter in the call to ListHostedZones
that produced the current response.
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 that indicates if there are more change batches to list.
com.amazonaws.internal.SdkInternalList<T> changeBatchRecords
The change batches within the given hosted zone and time period.
String nextMarker
The next page marker.
String hostedZoneId
The ID of the hosted zone that you want to see changes for.
String name
The name of the RRSet that you want to see changes for.
String type
The type of the RRSet that you want to see changes for.
String setIdentifier
The identifier of the RRSet that you want to see changes for.
String startDate
The start of the time period you want to see changes for.
String endDate
The end of the time period you want to see changes for.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
Boolean isTruncated
A flag that indicates if there are more change batches to list.
com.amazonaws.internal.SdkInternalList<T> changeBatchRecords
The change batches within the given hosted zone and time period.
String nextMarker
The next page marker.
String startContinentCode
The code for the continent with which you want to start listing locations that Amazon Route 53 supports for
geolocation. If Amazon 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 Amazon 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.
Amazon 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 Amazon 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.
com.amazonaws.internal.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
GET 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
GET 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
GET ListGeoLocations request.
String maxItems
The value that you specified for MaxItems in the request.
String marker
If the response to a ListHealthChecks is more than one page, marker is the health check ID for the
first health check on the next page of results. For more information, see
ListHealthChecksResponse$MaxItems.
String maxItems
The maximum number of HealthCheck elements you want ListHealthChecks to return on each
page of the response body. If the AWS account includes more HealthCheck elements than the value of
maxitems, the response is broken into pages. Each page contains the number of
HealthCheck elements specified by maxitems.
For example, suppose you specify 10 for maxitems and the current AWS account has
51 health checks. In the response, ListHealthChecks sets
ListHealthChecksResponse$IsTruncated to true and includes the ListHealthChecksResponse$NextMarker
element. To access the second and subsequent pages, you resend the GET ListHealthChecks
request, add the ListHealthChecksResponse$Marker parameter to the request, and specify the value of the
ListHealthChecksResponse$NextMarker element from the previous response. On the last (sixth) page of the
response, which contains only one HealthCheck element:
The value of ListHealthChecksResponse$IsTruncated is false.
ListHealthChecksResponse$NextMarker is omitted.
com.amazonaws.internal.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 maxitems health checks by calling ListHealthChecks again and
specifying the value of the NextMarker element in the marker parameter.
Valid Values: true | false
String nextMarker
If IsTruncated is true, the value of NextMarker identifies the first
health check in the next group of maxitems health checks. Call ListHealthChecks again
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.
com.amazonaws.internal.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
(Optional) If you have more hosted zones than the value of maxitems, ListHostedZones
returns only the first maxitems hosted zones. To get the next group of maxitems hosted
zones, submit another request to ListHostedZones. For the value of marker, specify the value of the
NextMarker element that was returned in the previous response.
Hosted zones are listed in the order in which they were created.
String maxItems
(Optional) The maximum number of hosted zones to be included in the response body for this request. If you have
more than maxitems hosted zones, the value of the IsTruncated element in the response
is true, and the value of the NextMarker element is the hosted zone ID of the first
hosted zone in the next group of maxitems hosted zones.
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.
com.amazonaws.internal.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
the next group of maxitems hosted zones by calling ListHostedZones again and specifying
the value of the NextMarker element in the marker parameter.
String nextMarker
If IsTruncated is true, the value of NextMarker identifies the first
hosted zone in the next group of maxitems hosted zones. Call ListHostedZones again and
specify the value of NextMarker 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
The ID of the hosted zone that contains the resource record sets that you want to get.
String startRecordName
The first name in the lexicographic ordering of domain names that you want the
ListResourceRecordSets request 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 | CNAME |
MX | NAPTR | NS | PTR | SOA | SPF |
SRV | TXT
Values for weighted, latency, geo, and failover resource record sets: A | AAAA |
CNAME | MX | NAPTR | PTR | SPF |
SRV | TXT
Values for alias resource record sets:
CloudFront distribution: A
Elastic Beanstalk environment that has a regionalized subdomain: A
ELB load balancer: A | AAAA
Amazon S3 bucket: A
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.
com.amazonaws.internal.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
Weighted, latency, geolocation, and failover resource record sets only: 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.
String maxItems
The maximum number of records you requested.
String marker
If you're making the second or subsequent call to ListReusableDelegationSets, the
Marker element matches the value that you specified in the marker parameter in the
previous request.
String maxItems
The value that you specified for the maxitems parameter in the request that produced the current
response.
com.amazonaws.internal.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. If the response is truncated,
you can get the next group of maxitems reusable delegation sets by calling
ListReusableDelegationSets again and specifying the value of the NextMarker element in
the marker parameter.
String nextMarker
If IsTruncated is true, the value of NextMarker identifies the first
reusable delegation set in the next group of maxitems reusable delegation sets. Call
ListReusableDelegationSets again 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.
com.amazonaws.internal.SdkInternalList<T> resourceIds
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
com.amazonaws.internal.SdkInternalList<T> resourceTagSets
A list of ResourceTagSets containing tags associated with the specified resources.
String trafficPolicyIdMarker
(Conditional) For your first request to ListTrafficPolicies, do not 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 MaxItems
policies, submit another request to ListTrafficPolicies. For the value of
TrafficPolicyIdMarker, specify the value of the TrafficPolicyIdMarker element that was
returned in the previous response.
Policies are listed in the order in which they were created.
String maxItems
(Optional) The maximum number of traffic policies to be included in the response body for this request. If you
have more than MaxItems traffic policies, the value of the IsTruncated element in the
response is true, and the value of the TrafficPolicyIdMarker element is the ID of the
first traffic policy in the next group of MaxItems traffic policies.
com.amazonaws.internal.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 MaxItems traffic policies by calling ListTrafficPolicies
again and specifying the value of the TrafficPolicyIdMarker element in the
TrafficPolicyIdMarker request parameter.
Valid Values: true | false
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 call to
ListTrafficPolicies that produced the current response.
String hostedZoneId
The ID of the hosted zone for which you want to list traffic policy instances.
String trafficPolicyInstanceNameMarker
For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was true,
TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group
of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
String trafficPolicyInstanceTypeMarker
For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was true,
TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next
group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get for this hosted zone.
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 in the next group of MaxItems traffic policy instances.
com.amazonaws.internal.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 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 MaxItems traffic policy instances by calling
ListTrafficPolicyInstancesByHostedZone 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
ListTrafficPolicyInstancesByHostedZone 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
For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true,
HostedZoneIdMarker is the ID of the hosted zone for the first traffic policy instance in the next
group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
String trafficPolicyInstanceNameMarker
For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true,
TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group
of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
String trafficPolicyInstanceTypeMarker
For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true,
TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next
group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get for this hosted zone.
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 in the next group of MaxItems traffic policy instances.
com.amazonaws.internal.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 MaxItems 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 MaxItems 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
For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, you have more traffic
policy instances. To get the next group of MaxItems traffic policy instances, submit another
ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker, 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 MaxItems 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
For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true,
TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group
of MaxItems 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
For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true,
TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next
group of MaxItems 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 in the next group of MaxItems traffic policy instances.
com.amazonaws.internal.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 MaxItems 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 MaxItems traffic policy instances by calling
ListTrafficPolicyInstances 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
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, do not 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 the
next group of MaxItems traffic policy versions, submit another request to
ListTrafficPolicyVersions. For the value of TrafficPolicyVersionMarker, specify the
value of the TrafficPolicyVersionMarker element that was returned in the previous response.
Traffic policy versions are listed in sequential order.
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 the
IsTruncated element in the response is true, and the value of the
TrafficPolicyVersionMarker element is the ID of the first version in the next group of
MaxItems traffic policy versions.
com.amazonaws.internal.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 maxitems traffic policies by calling
ListTrafficPolicyVersions again and specifying the value of the NextMarker element in
the marker parameter.
String trafficPolicyVersionMarker
If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies
the first traffic policy in the next group of MaxItems traffic policies. 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 call to
ListTrafficPolicyVersions that produced the current response.
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 are creating an alias resource record set, omit Value.
String name
The name of the domain you want to perform the action on.
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 still assumes that the domain name that you specify
is fully qualified. This means that Amazon 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
cannot 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 | CNAME |
MX | NAPTR | NS | PTR | SOA | SPF |
SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA
| 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.
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:
CloudFront distributions: A
Elastic Beanstalk environment that has a regionalized subdomain: A
ELB load balancers: A | AAAA
Amazon S3 buckets: A
Another resource record set in this hosted zone: Specify the type of the resource record set for which
you're creating the alias. Specify any value except NS or SOA.
String setIdentifier
Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among
multiple resource record sets that have the same combination of DNS name and type. The value of
SetIdentifier must be unique for each resource record set that has the same combination of DNS name
and type. Omit SetIdentifier for any other types of record sets.
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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon 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 the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.
You cannot create non-latency resource record sets that have the same values for the Name and
Type elements as latency resource record sets.
GeoLocation geoLocation
Geo location 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 cannot 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, Amazon 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, Amazon Route 53
returns a "no answer" response for queries from those locations.
You cannot 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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:
Valid values: PRIMARY | SECONDARY
Long tTL
The resource record cache time to live (TTL), in seconds. Note the following:
If you're creating 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, latency, geolocation, or failover 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.
com.amazonaws.internal.SdkInternalList<T> resourceRecords
Information about the resource records to act upon.
If you are creating an alias resource record set, omit ResourceRecords.
AliasTarget aliasTarget
Alias resource record sets only: Information about the CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The Elastic Beanstalk environment must have a regionalized subdomain.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create alias resource record sets for CloudFront distributions in a private hosted zone.
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 a health
check is passing, include the HealthCheckId element and specify the ID of the applicable health
check.
Amazon 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)
For information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.
The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more
resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the
status of a health check. Configuring health checks only makes sense in the following configurations:
You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias,
latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all
of the resource record sets that are referenced by the alias resource record sets.
Amazon Route 53 doesn't check the health of the endpoint 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, Amazon Route 53 checks the health of the endpoint that you specified in the
health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon 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 United States, for North America, and for all locations. If the endpoint for the
state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States,
for North America, and for all locations (a resource record set for which the value of CountryCode
is *), in that order, until it finds a resource record set for which the endpoint is healthy.
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-1-www.example.com), not the name of the resource record
sets (example.com).
n this configuration, if you create a health check for which the value of FullyQualifiedDomainName
matches the name of the resource record sets and then associate the health check with those resource record sets,
health check results will be unpredictable.
For more information, see the following topics in the Amazon Route 53 Developer Guide:
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 Amazon Route 53 created this
resource record set for.
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, Amazon 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.
com.amazonaws.internal.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 time at which the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For
example, the value 2014-10-27T17:48:16.751Z represents October 27, 2014 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 whose Value element you want to remove.
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 region.
String eDNS0ClientSubnetIP
If the resolver that you specified for resolverip supports EDNS0, specify the IP address of a client in the applicable location.
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.
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.
com.amazonaws.internal.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 Amazon Route 53 edge locations.
Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that
the CreateTrafficPolicyInstance request completed successfully.
Amazon 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 Amazon Route 53 from overwriting an intervening
update:
f the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in
the health check, Amazon 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. Amazon Route 53 does not update the health check, and it returns a
HealthCheckVersionMismatch error.
String iPAddress
The IPv4 IP address of the endpoint on which you want Amazon Route 53 to perform health checks. If you don't
specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that
you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval.
Using an IP address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
f the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with
your Amazon 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 Elastic IP Addresses
(EIP) in the Amazon EC2 User Guide for Linux 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 UpdateHealthCheckRequest$FullyQualifiedDomainName.
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.
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 IPAddress:
The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP
health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53
to perform health checks. When Amazon 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, Amazon 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, Amazon 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,
Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the
Host header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of
IPAddress in the Host header in each of the above cases.
If you don't specify IPAddress:
If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that
you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval.
Using an IP address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
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-1-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, Amazon 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, Amazon 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, Amazon 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.
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.
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, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
AlarmIdentifier alarmIdentifier
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: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon 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.
HealthCheck healthCheck
HostedZone hostedZone
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 a domain.
Type: String
String operation
The operation that you were charged for.
Type: String
Valid values:
REGISTER_DOMAINTRANSFER_IN_DOMAINRENEW_DOMAINCHANGE_DOMAIN_OWNERString invoiceId
The ID of the invoice that is associated with the billing record.
Type: String
Date billDate
The date that the operation was billed, in Unix format.
Type: Double
Double price
The price that you were charged for the operation, in US dollars.
Type: Double
Example value: 12.0
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String idnLangCode
Reserved for future use.
String availability
Whether the domain name is available for registering.
You can only register domains designated as AVAILABLE.
Type: String
Valid values:
AVAILABLE – The domain name is available.AVAILABLE_RESERVED – The domain name is reserved under specific conditions.AVAILABLE_PREORDER – The domain name is available and can be preordered.UNAVAILABLE – The domain name is not available.UNAVAILABLE_PREMIUM – The domain name is not available.UNAVAILABLE_RESTRICTED – The domain name is forbidden.RESERVED – The domain name has been reserved for another person or organization.DONT_KNOW – 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.String firstName
First name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String lastName
Last name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
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.
Type: String
Default: None
Constraints: Maximum 255 characters.
Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String organizationName
Name of the organization for contact types other than PERSON.
Type: String
Default: None
Constraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
String addressLine1
First line of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String addressLine2
Second line of contact's address, if any.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
String city
The city of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String state
The state or province of the contact's city.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
String countryCode
Code for the country of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String zipCode
The zip or postal code of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
String phoneNumber
The phone number of the contact.
Type: String
Default: None
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".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String email
Email address of the contact.
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
String fax
Fax number of the contact.
Type: String
Default: None
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".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
com.amazonaws.internal.SdkInternalList<T> extraParams
A list of name-value pairs for parameters required by certain top-level domains.
Type: Complex
Default: None
Parents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
String domainName
The domain for which you want to delete one or more tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
com.amazonaws.internal.SdkInternalList<T> tagsToDelete
A list of tag keys to delete.
Type: A list that contains the keys of the tags that you want to delete.
Default: None
Required: No
'>String domainName
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Boolean autoRenew
Indicates whether the domain is automatically renewed upon expiration.
Type: Boolean
Valid values: True | False
Boolean transferLock
Indicates whether a domain is locked from unauthorized transfer to another party.
Type: Boolean
Valid values: True | False
Date expiry
Expiration date of the domain in Coordinated Universal Time (UTC).
Type: Long
String domainName
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String name
Name of the additional parameter required by the top-level domain.
Type: String
Default: None
Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |
BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |
DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |
CA_BUSINESS_ENTITY_TYPE |ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE |
ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN |
RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
String value
Values corresponding to the additional parameter names required by some top-level domains.
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent: ExtraParams
Required: Yes
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.
Type: String
Default: None
Required: Yes
String domainName
The domain name for which you requested the reachability status.
String status
Whether the registrant contact has responded. PENDING indicates that we sent the confirmation email
and haven't received a response yet, DONE indicates that we sent the email and got confirmation from
the registrant contact, and EXPIRED indicates that the time limit expired before the registrant
contact responded.
Type: String
Valid values: PENDING, DONE, EXPIRED
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String domainName
The name of a domain.
Type: String
com.amazonaws.internal.SdkInternalList<T> nameservers
The name of the domain.
Type: String
Boolean autoRenew
Specifies whether the domain registration is set to renew automatically.
Type: Boolean
ContactDetail adminContact
Provides details about the domain administrative contact.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
ContactDetail registrantContact
Provides details about the domain registrant.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
ContactDetail techContact
Provides details about the domain technical contact.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Boolean adminPrivacy
Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is
true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
Boolean registrantPrivacy
Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is
true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
Boolean techPrivacy
Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is
true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
String registrarName
Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by
registrar Gandi. The value is "GANDI SAS".
Type: String
String whoIsServer
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
Type: String
String registrarUrl
Web address of the registrar.
Type: String
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.
Type: String
String abuseContactPhone
Phone number for reporting abuse.
Type: String
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 format is Unix time.
Date updatedDate
The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
Date expirationDate
The date when the registration for the domain is set to expire. The date format is Unix time.
String reseller
Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have
"Amazon" as the reseller.
Type: String
String dnsSec
Reserved for future use.
com.amazonaws.internal.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.)
Type: Array of String
com.amazonaws.internal.SdkInternalList<T> suggestionsList
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.
Type: String
Default: None
Required: Yes
String operationId
The identifier for the operation.
Type: String
String status
The current status of the requested operation in the system.
Type: String
String message
Detailed information on the status including possible errors.
Type: String
String domainName
The name of a domain.
Type: String
String type
The type of operation that was requested.
Type: String
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.
Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
Integer maxItems
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
com.amazonaws.internal.SdkInternalList<T> domains
A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew, DomainName, Expiry, TransferLock
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.
Type: String
Parent: Operations
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.
Type: String
Default: None
Required: No
Integer maxItems
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
com.amazonaws.internal.SdkInternalList<T> operations
Lists summaries of the operations.
Type: Complex type containing a list of operation summaries
Children: OperationId, Status, SubmittedDate, Type
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.
Type: String
Parent: Operations
String domainName
The domain for which you want to get a list of tags.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of the tags that are associated with the specified domain.
Type: A complex type containing a list of tags
Each tag includes the following elements.
Key
The key (name) of a tag.
Type: String
Value
The value of a tag.
Type: String
String name
The fully qualified host name of the name server.
Type: String
Constraint: Maximum 255 characterss
Parent: Nameservers
com.amazonaws.internal.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.
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent: Nameservers
String operationId
Identifier returned to track the requested action.
Type: String
String status
The current status of the requested operation in the system.
Type: String
String type
Type of the action requested.
Type: String
Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN |
UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION |
DOMAIN_LOCK
Date submittedDate
The date when the request was submitted.
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Boolean autoRenew
Indicates whether the domain will be automatically renewed (true) or not (false).
Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
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 documentation.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: No
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.
Type: Integer
Default: None
Valid values: Integer
Required: Yes
String operationId
String domainName
The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.
Type: String
Default: None
Required: Yes
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 a domain.
Type: String
Default: None
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.
Required: Yes
String authCode
The authorization code for the domain.
Type: String
String key
The key (name) of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
String value
The value of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
com.amazonaws.internal.SdkInternalList<T> nameservers
Contains details for the host and glue IP addresses.
Type: Complex
Children: GlueIps, Name
Required: No
String authCode
The authorization code for the domain. You get this value from the current registrar.
Type: String
Required: Yes
Boolean autoRenew
Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
Boolean adminPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
Boolean registrantPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
Boolean techPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City,
State, CountryCode, ZipCode, PhoneNumber, Email,
Fax, ExtraParams
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
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.
Required: Yes
String fIAuthKey
The authorization key for .fi domains
com.amazonaws.internal.SdkInternalList<T> nameservers
A list of new name servers for the domain.
Type: Complex
Children: Name, GlueIps
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The domain for which you want to add or update tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
com.amazonaws.internal.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.
Type: A complex type containing a list of tags
Default: None
Required: No
'>Each tag includes the following elements:
Key
The key (name) of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
Value
The value of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
Date start
The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.
Type: Double
Default: None
Required: Yes
Date end
The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.
Type: Double
Default: None
Required: Yes
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.
Type: String
Default: None
Constraints: The marker must match the value of NextPageMarker that was returned in the previous
response.
Required: No
Integer maxItems
The number of billing records to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
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.
Type: String
Parent: BillingRecords
com.amazonaws.internal.SdkInternalList<T> billingRecords
A summary of billing records.
Type: Complex type containing a list of billing record summaries.
Children: DomainName, Operation, InvoiceId, BillDate and
Price
Copyright © 2016. All rights reserved.