Potential values: healthcheck, hostedzone

$body#

A complex type that contains information about the tags that you want to add, edit, or delete.

Type: object

{
  "ChangeTagsForResourceRequest" : {
    "RemoveTagKeys" : [ {
      "Key" : "string"
    } ],
    "AddTags" : [ {
      "Tag" : {
        "Value" : "The value of Value depends on the operation that you want to perform:  \n  Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.  \n  Edit a tag: Value is the new value that you want to assign the tag. ",
        "Key" : "The value of Key depends on the operation that you want to perform:  \n  Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.  \n  Edit a tag: Key is the name of the tag that you want to change the Value for.  \n   Delete a key: Key is the name of the tag you want to remove.  \n  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. "
      }
    } ]
  }
}

create_health_check#

Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.

Parameters

$body#

A complex type that contains the health check request information.

Type: object

{
  "CallerReference" : "A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:  \n If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.  \n If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.  \n If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.  \n If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check. ",
  "HealthCheckConfig" : {
    "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. \nSome 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. \nThe 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.",
    "ChildHealthChecks" : [ {
      "ChildHealthCheck" : "string"
    } ],
    "MeasureLatency" : "Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.  \nYou can't change the value of MeasureLatency after you create a health check.",
    "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.",
    "Regions" : [ {
      "Region" : "string. Possible values: us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1"
    } ],
    "SearchString" : "If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. \nRoute 53 considers case when searching for SearchString in the response body. ",
    "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:  \n  Healthy: Route 53 considers the health check to be healthy.  \n  Unhealthy: Route 53 considers the health check to be unhealthy.  \n  LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. ",
    "Type" : "The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.  \nYou can't change the value of Type after you create a health check.  \nYou can create the following types of health checks:  \n  HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.  \n  HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.  If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.   \n  HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.  \n  HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.  \n  TCP: Route 53 tries to establish a TCP connection.  \n  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.   \n  CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.    \nFor more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.",
    "ResourcePath" : "The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&amp;login=y. ",
    "FullyQualifiedDomainName" : "Amazon Route 53 behavior depends on whether you specify a value for IPAddress. \n If you specify a value for IPAddress: \nAmazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. \nWhen Route 53 checks the health of an endpoint, here is how it constructs the Host header:  \n If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.   \n If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.  \n If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.   \nIf you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases. \n If you don't specify a value for IPAddress : \nRoute 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.  \nIf you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \"DNS resolution failed\" error.  \nIf you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).  \nIn 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.  \nIn addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.",
    "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.",
    "RequestInterval" : "The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.  \nYou can't change the value of RequestInterval after you create a health check.  \nIf you don't specify a value for RequestInterval, the default value is 30 seconds.",
    "HealthThreshold" : "The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element. \nNote the following:  \n If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.  \n If you specify 0, Route 53 always considers this health check to be healthy. ",
    "AlarmIdentifier" : {
      "Region" : "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. \nFor the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.",
      "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.  \nRoute 53 supports CloudWatch alarms with the following features:  \n Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.  \n Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported. "
    },
    "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. \nIf you don't specify a value for FailureThreshold, the default value is three health checks.",
    "IPAddress" : "The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint. \nUse one of the following formats for the value of IPAddress:   \n  IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.  \n  IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.   \nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change. \nFor more information, see FullyQualifiedDomainName.  \nConstraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:  \n  RFC 5735, Special Use IPv4 Addresses   \n  RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space   \n  RFC 5156, Special-Use IPv6 Addresses    \nWhen the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.",
    "Disabled" : "Stops Route 53 from performing health checks. When you disable a health check, here's what happens:  \n  Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.  \n  Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.  \n  Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.   \nAfter you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.  \nCharges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing."
  }
}

create_hosted_zone#

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
You can't create a hosted zone for a top-level domain (TLD) such as .com.
For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide. If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.
If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

Parameters

$body#

A complex type that contains information about the request to create a public or private hosted zone.

Type: object

{
  "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.",
  "VPC" : {
    "VPCRegion" : "(Private hosted zones only) The region that an Amazon VPC was created in.",
    "VPCId" : "string"
  },
  "CallerReference" : "A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.",
  "HostedZoneConfig" : {
    "Comment" : "Any comments that you want to include about the hosted zone.",
    "PrivateZone" : "A value that indicates whether this is a private hosted zone."
  },
  "Name" : "The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. \nIf you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet."
}

create_query_logging_config#

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
Route 53 edge location that responded to the DNS query
Domain or subdomain that was requested
DNS record type, such as A or AAAA
DNS response code, such as NoError or ServFail Log Group and Resource Policy
Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with , for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/ You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI. Log Streams and Edge Locations
When Route 53 finishes creating the configuration for DNS query logging, it does the following:
Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
Begins to send query logs to the applicable log stream.
The name of each log stream is in the following format:
hosted zone ID/edge location code
The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. Queries That Are Logged
Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. Log File Format
For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. Pricing
For information about charges for query logs, see Amazon CloudWatch Pricing. How to Stop Logging
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

Parameters

$body#

Type: object

{
  "CloudWatchLogsLogGroupArn" : "The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN: \narn:aws:logs:region:account-id:log-group:log_group_name  \nTo get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the AWS SDKs.",
  "HostedZoneId" : "The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones."
}

create_reusable_delegation_set#

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.

Parameters

$body#

Type: object

{
  "HostedZoneId" : "If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.",
  "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."
}

create_traffic_policy#

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

Parameters

$body#

A complex type that contains information about the traffic policy that you want to create.

Type: object

{
  "Comment" : "(Optional) Any comments that you want to include about the traffic policy.",
  "Document" : "The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.",
  "Name" : "The name of the traffic policy."
}

create_traffic_policy_instance#

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

Parameters

$body#

A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.

Type: object

{
  "TrafficPolicyId" : "The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.",
  "HostedZoneId" : "The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.",
  "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.",
  "TrafficPolicyVersion" : "The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.",
  "Name" : "The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance."
}

create_traffic_policy_version#

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

Parameters

Id (required)#

The ID of the traffic policy for which you want to create a new version.

Type: string

$body#

A complex type that contains information about the traffic policy that you want to create a new version for.

Type: object

{
  "CreateTrafficPolicyVersionRequest" : {
    "Comment" : "The comment that you specified in the CreateTrafficPolicyVersion request, if any.",
    "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."
  }
}

create_vpc_association_authorization#

Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.
If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.

Parameters

Id (required)#

The ID of the private hosted zone that you want to authorize associating a VPC with.

Type: string

$body#

A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts.

Type: object

{
  "CreateVPCAssociationAuthorizationRequest" : {
    "VPC" : {
      "VPCRegion" : "(Private hosted zones only) The region that an Amazon VPC was created in.",
      "VPCId" : "string"
    }
  }
}

{
  "DeleteVPCAssociationAuthorizationRequest" : {
    "VPC" : {
      "VPCRegion" : "(Private hosted zones only) The region that an Amazon VPC was created in.",
      "VPCId" : "string"
    }
  }
}

disassociate_vpc_from_hosted_zone#

Type: string

get_checker_ip_ranges#

GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.

Parameters

$body#

Empty request.

Type: object

{ }

{ }

{ }

get_hosted_zone_limit#

Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

Parameters

Id (required)#

The ID of the hosted zone that you want to get a limit for.

Type: string

Type (required)#

The limit that you want to get. Valid values include the following:
MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

$body#

Request to get the number of traffic policy instances that are associated with the current AWS account.

Type: object

{ }

ResourceType (required)#

The type of the resource.
The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.

Type: string

Potential values: healthcheck, hostedzone

list_tags_for_resources#

Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Parameters

ResourceType (required)#

The type of the resources.
The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.

Type: string

Potential values: healthcheck, hostedzone

$body#

A complex type that contains information about the health checks or hosted zones for which you want to list tags.

Type: object

{
  "ListTagsForResourcesRequest" : {
    "ResourceIds" : [ {
      "ResourceId" : "string"
    } ]
  }
}

Potential values: SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA

list_traffic_policy_instances_by_hosted_zone#

Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Parameters

id (required)#

The ID of the hosted zone that you want to list traffic policy instances for.

Type: string

maxitems#

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

Type: string

trafficpolicyinstancename#

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Type: string

trafficpolicyinstancetype#

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Type: string

Potential values: SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA

list_traffic_policy_instances_by_policy#

Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Parameters

id (required)#

The ID of the traffic policy for which you want to list traffic policy instances.

Type: string

version (required)#

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.

Type: integer

hostedzoneid#

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Type: string

maxitems#

Type: string

trafficpolicyinstancename#

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Type: string

trafficpolicyinstancetype#

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

{
  "UpdateHealthCheckRequest" : {
    "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. \nSome 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. \nThe 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.",
    "ChildHealthChecks" : [ {
      "ChildHealthCheck" : "string"
    } ],
    "Port" : "The port on the endpoint on which you want Amazon Route 53 to perform health checks.",
    "ResetElements" : [ {
      "ResettableElementName" : "string. Possible values: FullyQualifiedDomainName | Regions | ResourcePath | ChildHealthChecks"
    } ],
    "Regions" : [ {
      "Region" : "string. Possible values: us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1"
    } ],
    "SearchString" : "If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)",
    "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:  \n  Healthy: Route 53 considers the health check to be healthy.  \n  Unhealthy: Route 53 considers the health check to be unhealthy.  \n  LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. ",
    "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. \nWe recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:  \n If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.  \n If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error. ",
    "ResourcePath" : "The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&amp;login=y.  \nSpecify this value only if you want to change it.",
    "FullyQualifiedDomainName" : "Amazon Route 53 behavior depends on whether you specify a value for IPAddress.  \nIf 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.   \n If you specify a value for IPAddress: \nRoute 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. \nWhen Route 53 checks the health of an endpoint, here is how it constructs the Host header:  \n If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.  \n If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.  \n If you specify another value for Port and any value except TCP for Type, Route 53 passes  FullyQualifiedDomainName:Port  to the endpoint in the Host header.   \nIf you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases. \n If you don't specify a value for IPAddress: \nIf you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.  \nIf you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \"DNS resolution failed\" error.  \nIf you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).  \nIn 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.  \nIn addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.",
    "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.",
    "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. \nNote the following:  \n If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.  \n If you specify 0, Route 53 always considers this health check to be healthy. ",
    "AlarmIdentifier" : {
      "Region" : "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. \nFor the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.",
      "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.  \nRoute 53 supports CloudWatch alarms with the following features:  \n Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.  \n Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported. "
    },
    "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. \nIf you don't specify a value for FailureThreshold, the default value is three health checks.",
    "IPAddress" : "The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint. \nUse one of the following formats for the value of IPAddress:   \n  IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.  \n  IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.   \nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:  \n Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances   \n Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances     \nIf 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.   \nFor more information, see FullyQualifiedDomainName.  \nConstraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:  \n  RFC 5735, Special Use IPv4 Addresses   \n  RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space   \n  RFC 5156, Special-Use IPv6 Addresses  ",
    "Disabled" : "Stops Route 53 from performing health checks. When you disable a health check, here's what happens:  \n  Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.  \n  Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.  \n  Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.   \nAfter you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.  \nCharges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing."
  }
}

update_hosted_zone_comment#

Updates the comment for a specified hosted zone.

Parameters

Id (required)#

The ID for the hosted zone that you want to update the comment for.

Type: string

$body#

A request to update the comment for a hosted zone.

Type: object

{
  "UpdateHostedZoneCommentRequest" : {
    "Comment" : "The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any."
  }
}

update_traffic_policy_comment#

Updates the comment for a specified traffic policy version.

Parameters

Id (required)#

The value of Id for the traffic policy that you want to update the comment for.

Type: string

Version (required)#

The value of Version for the traffic policy that you want to update the comment for.

Type: integer

$body#

A complex type that contains information about the traffic policy that you want to update the comment for.

Type: object

{
  "UpdateTrafficPolicyCommentRequest" : {
    "Comment" : "The new comment for the specified traffic policy and version."
  }
}

update_traffic_policy_instance#

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

Parameters

Id (required)#

The ID of the traffic policy instance that you want to update.

Type: string

$body#

A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.

Type: object

{
  "UpdateTrafficPolicyInstanceRequest" : {
    "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.",
    "TTL" : "The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.",
    "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."
  }
}