lib/aws-sdk-route53/client.rb in aws-sdk-route53-1.12.0 vs lib/aws-sdk-route53/client.rb in aws-sdk-route53-1.13.0
- old
+ new
@@ -272,34 +272,34 @@
#
# The request body must include a document with a
# `ChangeResourceRecordSetsRequest` element. The request body contains a
# list of change items, known as a change batch. Change batches are
# considered transactional changes. When using the Amazon Route 53 API
- # to change resource record sets, Amazon Route 53 either makes all or
- # none of the changes in a change batch request. This ensures that
- # Amazon Route 53 never partially implements the intended changes to the
- # resource record sets in a hosted zone.
+ # to change resource record sets, Route 53 either makes all or none of
+ # the changes in a change batch request. This ensures that Route 53
+ # never partially implements the intended changes to the resource record
+ # sets in a hosted zone.
#
# For example, a change batch request that deletes the `CNAME` record
# for www.example.com and creates an alias resource record set for
- # www.example.com. Amazon Route 53 deletes the first resource record set
- # and creates the second resource record set in a single operation. If
+ # www.example.com. Route 53 deletes the first resource record set and
+ # creates the second resource record set in a single operation. If
# either the `DELETE` or the `CREATE` action fails, then both changes
# (plus any other changes in the batch) fail, and the original `CNAME`
# record continues to exist.
#
# Due to the nature of transactional changes, you can't delete the same
# resource record set more than once in a single change batch. If you
- # attempt to delete the same change batch more than once, Amazon Route
- # 53 returns an `InvalidChangeBatch` error.
+ # attempt to delete the same change batch more than once, Route 53
+ # returns an `InvalidChangeBatch` error.
#
# **Traffic Flow**
#
# To create resource record sets for complex routing configurations, use
- # either the traffic flow visual editor in the Amazon Route 53 console
- # or the API actions for traffic policies and traffic policy instances.
- # Save the configuration as a traffic policy, then associate the traffic
+ # either the traffic flow visual editor in the Route 53 console or the
+ # API actions for traffic policies and traffic policy instances. Save
+ # the configuration as a traffic policy, then associate the traffic
# policy with one or more domain names (such as example.com) or
# subdomain names (such as www.example.com), in the same hosted zone or
# in multiple hosted zones. You can roll back the updates if the new
# configuration isn't performing as expected. For more information, see
# [Using Traffic Flow to Route DNS Traffic][1] in the *Amazon Route 53
@@ -315,12 +315,12 @@
#
# * `DELETE`\: Deletes an existing resource record set that has the
# specified values.
#
# * `UPSERT`\: If a resource record set does not already exist, AWS
- # creates it. If a resource set does exist, Amazon Route 53 updates it
- # with the values in the request.
+ # creates it. If a resource set does exist, Route 53 updates it with
+ # the values in the request.
#
# **Syntaxes for Creating, Updating, and Deleting Resource Record Sets**
#
# The syntax for a request depends on the type of resource record set
# that you want to create, delete, or update, such as weighted, alias,
@@ -332,19 +332,18 @@
# Don't refer to the syntax in the "Parameter Syntax" section, which
# includes all of the elements for every kind of resource record set
# that you can create, delete, or update by using
# `ChangeResourceRecordSets`.
#
- # **Change Propagation to Amazon Route 53 DNS Servers**
+ # **Change Propagation to Route 53 DNS Servers**
#
- # When you submit a `ChangeResourceRecordSets` request, Amazon Route 53
- # propagates your changes to all of the Amazon Route 53 authoritative
- # DNS servers. While your changes are propagating, `GetChange` returns a
+ # When you submit a `ChangeResourceRecordSets` request, Route 53
+ # propagates your changes to all of the Route 53 authoritative DNS
+ # servers. While your changes are propagating, `GetChange` returns a
# status of `PENDING`. When propagation is complete, `GetChange` returns
- # a status of `INSYNC`. Changes generally propagate to all Amazon Route
- # 53 name servers within 60 seconds. For more information, see
- # GetChange.
+ # a status of `INSYNC`. Changes generally propagate to all Route 53 name
+ # servers within 60 seconds. For more information, see GetChange.
#
# **Limits on ChangeResourceRecordSets Requests**
#
# For information about the limits on a `ChangeResourceRecordSets`
# request, see [Limits][2] in the *Amazon Route 53 Developer Guide*.
@@ -1101,20 +1100,20 @@
#
# 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 an Amazon Route 53 health check.
+ # 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:
#
- # * Amazon 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.
+ # * 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.
#
@@ -1137,30 +1136,27 @@
# creating two identical health checks:
#
# * If you send a `CreateHealthCheck` request with the same
# `CallerReference` and settings as a previous request, and if the
# health check doesn't exist, Amazon Route 53 creates the health
- # check. If the health check does exist, Amazon Route 53 returns the
- # settings for the existing health check.
+ # check. If the health check does exist, Route 53 returns the settings
+ # for the existing health check.
#
# * If you send a `CreateHealthCheck` request with the same
# `CallerReference` as a deleted health check, regardless of the
- # settings, Amazon Route 53 returns a `HealthCheckAlreadyExists`
- # error.
+ # settings, Route 53 returns a `HealthCheckAlreadyExists` error.
#
# * If you send a `CreateHealthCheck` request with the same
# `CallerReference` as an existing health check but with different
- # settings, Amazon Route 53 returns a `HealthCheckAlreadyExists`
- # error.
+ # settings, Route 53 returns a `HealthCheckAlreadyExists` error.
#
# * If you send a `CreateHealthCheck` request with a unique
# `CallerReference` but settings identical to an existing health
- # check, Amazon Route 53 creates the health check.
+ # check, Route 53 creates the health check.
#
# @option params [required, Types::HealthCheckConfig] :health_check_config
- # A complex type that contains the response to a `CreateHealthCheck`
- # request.
+ # A complex type that contains settings for a new health check.
#
# @return [Types::CreateHealthCheckResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateHealthCheckResponse#health_check #health_check} => Types::HealthCheck
# * {Types::CreateHealthCheckResponse#location #location} => String
@@ -1178,10 +1174,11 @@
# search_string: "SearchString",
# request_interval: 1,
# failure_threshold: 1,
# measure_latency: false,
# inverted: false,
+ # disabled: false,
# health_threshold: 1,
# child_health_checks: ["HealthCheckId"],
# enable_sni: false,
# regions: ["us-east-1"], # accepts us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
# alarm_identifier: {
@@ -1206,10 +1203,11 @@
# resp.health_check.health_check_config.search_string #=> String
# resp.health_check.health_check_config.request_interval #=> Integer
# resp.health_check.health_check_config.failure_threshold #=> Integer
# resp.health_check.health_check_config.measure_latency #=> Boolean
# resp.health_check.health_check_config.inverted #=> Boolean
+ # resp.health_check.health_check_config.disabled #=> Boolean
# resp.health_check.health_check_config.health_threshold #=> Integer
# resp.health_check.health_check_config.child_health_checks #=> Array
# resp.health_check.health_check_config.child_health_checks[0] #=> String
# resp.health_check.health_check_config.enable_sni #=> Boolean
# resp.health_check.health_check_config.regions #=> Array
@@ -1237,65 +1235,70 @@
def create_health_check(params = {}, options = {})
req = build_request(:create_health_check, params)
req.send_request(options)
end
- # Creates a new public hosted zone, which you use to specify how the
- # Domain Name System (DNS) routes traffic on the Internet for a domain,
- # such as example.com, and its subdomains.
+ # 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 zones to a private hosted zone or
+ # 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][1].
#
# Note the following:
#
- # * You can't create a hosted zone for a top-level domain (TLD).
+ # * You can't create a hosted zone for a top-level domain (TLD) such as
+ # .com.
#
- # * 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 Amazon Route 53 Creates for a
- # Hosted Zone][2] in the *Amazon Route 53 Developer Guide*.
+ # * 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][2] in the *Amazon Route 53
+ # Developer Guide*.
#
- # If you want to use the same name servers for multiple hosted zones,
- # you can optionally associate a reusable delegation set with the
- # hosted zone. See the `DelegationSetId` element.
+ # 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 Amazon
- # Route 53, you must update the name servers with your registrar to
- # make Amazon Route 53 your DNS service. For more information, see
- # [Configuring Amazon Route 53 as your DNS Service][3] in the *Amazon
- # Route 53 Developer Guide*.
+ # * 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][3]
+ # in the *Amazon Route 53 Developer Guide*.
#
# When you submit a `CreateHostedZone` request, the initial status of
- # the hosted zone is `PENDING`. This means that the NS and SOA records
- # are not yet available on all Amazon Route 53 DNS servers. When the NS
- # and SOA records are available, the status of the zone changes to
- # `INSYNC`.
+ # 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`.
#
#
#
# [1]: http://aws.amazon.com/route53/pricing/
# [2]: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html
- # [3]: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/creating-migrating.html
+ # [3]: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html
#
# @option params [required, 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
+ # The name of the domain. Specify a fully qualified domain name, for
+ # example, *www.example.com*. The trailing dot is optional; Amazon Route
+ # 53 assumes that the domain name is fully qualified. This means that
+ # Route 53 treats *www.example.com* (without a trailing dot) and
# *www.example.com.* (with a trailing dot) as identical.
#
# If you're creating a public hosted zone, this is the name you have
# registered with your DNS registrar. If your domain name is registered
- # with a registrar other than Amazon Route 53, change the name servers
- # for your domain to the set of `NameServers` that `CreateHostedZone`
- # returns in `DelegationSet`.
+ # with a registrar other than Route 53, change the name servers for your
+ # domain to the set of `NameServers` that `CreateHostedZone` returns in
+ # `DelegationSet`.
#
# @option params [Types::VPC] :vpc
# (Private hosted zones only) A complex type that contains information
# about the Amazon VPC that you're associating with this hosted zone.
#
@@ -1384,14 +1387,14 @@
# 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 Amazon Route
- # 53 receives for a specified public hosted zone, such as the following:
+ # DNS query logs contain information about the queries that Route 53
+ # receives for a specified public hosted zone, such as the following:
#
- # * Amazon Route 53 edge location that responded to the DNS query
+ # * Route 53 edge location that responded to the DNS query
#
# * Domain or subdomain that was requested
#
# * DNS record type, such as A or AAAA
#
@@ -1400,12 +1403,12 @@
# Log Group and Resource Policy
#
# : Before you create a query logging configuration, perform the
# following operations.
#
- # <note markdown="1"> If you create a query logging configuration using the Amazon Route
- # 53 console, Amazon Route 53 performs these operations automatically.
+ # <note markdown="1"> If you create a query logging configuration using the Route 53
+ # console, Route 53 performs these operations automatically.
#
# </note>
#
# 1. Create a CloudWatch Logs log group, and make note of the ARN,
# which you specify when you create a query logging configuration.
@@ -1421,19 +1424,19 @@
#
# `/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 Amazon 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.
+ # 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.
#
# 2. Create a CloudWatch Logs resource policy, and give it the
- # permissions that Amazon Route 53 needs to create log streams and
- # to send query logs to log streams. For the value of `Resource`,
+ # 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:
@@ -1446,17 +1449,17 @@
#
# </note>
#
# Log Streams and Edge Locations
#
- # : When Amazon Route 53 finishes creating the configuration for DNS
- # query logging, it does the following:
+ # : 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 Amazon Route
- # 53 responds to for that edge location.
+ # 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:
#
@@ -1465,27 +1468,26 @@
# 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
- # Amazon Route 53 Global Network" on the [Amazon Route 53 Product
- # Details][1] page.
+ # Route 53 Global Network" on the [Route 53 Product Details][1] page.
#
# Queries That Are Logged
#
# : Query logs contain only the queries that DNS resolvers forward to
- # Amazon 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 Amazon 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][2] in the *Amazon Route 53 Developer Guide*.
+ # 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][2] 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][3] in the *Amazon Route 53
@@ -1496,13 +1498,13 @@
# : For information about charges for query logs, see [Amazon CloudWatch
# Pricing][4].
#
# How to Stop Logging
#
- # : If you want Amazon Route 53 to stop sending query logs to CloudWatch
- # Logs, delete the query logging configuration. For more information,
- # see DeleteQueryLoggingConfig.
+ # : If you want Route 53 to stop sending query logs to CloudWatch Logs,
+ # delete the query logging configuration. For more information, see
+ # DeleteQueryLoggingConfig.
#
#
#
# [1]: http://aws.amazon.com/route53/details/
# [2]: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html
@@ -1709,18 +1711,19 @@
# 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.
#
# @option params [required, String] :hosted_zone_id
- # 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.
+ # 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.
#
# @option params [required, 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.
+ # using the resource record sets that Route 53 creates for this traffic
+ # policy instance.
#
# @option params [required, Integer] :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.
#
@@ -1929,11 +1932,11 @@
#
# You can delete a hosted zone only if it contains only the default SOA
# record and NS resource record sets. If the hosted zone contains other
# resource record sets, you must delete them before you can delete the
# hosted zone. If you try to delete a hosted zone that contains other
- # resource record sets, the request fails, and Amazon Route 53 returns a
+ # resource record sets, the request fails, and Route 53 returns a
# `HostedZoneNotEmpty` error. For information about deleting records
# from your hosted zone, see ChangeResourceRecordSets.
#
# To verify that the hosted zone has been deleted, do one of the
# following:
@@ -1973,12 +1976,12 @@
req.send_request(options)
end
# Deletes a configuration for DNS query logging. If you delete a
# configuration, Amazon Route 53 stops sending query logs to CloudWatch
- # Logs. Amazon Route 53 doesn't delete any logs that are already in
- # CloudWatch Logs.
+ # Logs. Route 53 doesn't delete any logs that are already in CloudWatch
+ # Logs.
#
# For more information about DNS query logs, see
# CreateQueryLoggingConfig.
#
# @option params [required, String] :id
@@ -2057,12 +2060,12 @@
end
# Deletes a traffic policy instance and all of the resource record sets
# that Amazon Route 53 created when you created the instance.
#
- # <note markdown="1"> In the Amazon Route 53 console, traffic policy instances are known as
- # policy records.
+ # <note markdown="1"> In the Route 53 console, traffic policy instances are known as policy
+ # records.
#
# </note>
#
# @option params [required, String] :id
# The ID of the traffic policy instance that you want to delete.
@@ -2130,19 +2133,20 @@
def delete_vpc_association_authorization(params = {}, options = {})
req = build_request(:delete_vpc_association_authorization, params)
req.send_request(options)
end
- # Disassociates a VPC from a Amazon Route 53 private hosted zone.
+ # Disassociates a VPC from a Amazon Route 53 private hosted zone. Note
+ # the following:
#
- # <note markdown="1"> You can't disassociate the last VPC from a private hosted zone.
+ # * You can't disassociate the last VPC from a private hosted zone.
#
- # </note>
+ # * You can't convert a private hosted zone into a public hosted zone.
#
- # You can't disassociate a VPC from a private hosted zone when only one
- # VPC is associated with the hosted zone. You also can't convert a
- # private hosted zone into a public hosted zone.
+ # * You can submit a `DisassociateVPCFromHostedZone` request using
+ # either the account that created the hosted zone or the account that
+ # created the VPC.
#
# @option params [required, String] :hosted_zone_id
# The ID of the private hosted zone that you want to disassociate a VPC
# from.
#
@@ -2247,12 +2251,12 @@
#
# * `PENDING` indicates that the changes in this request have not
# propagated to all Amazon Route 53 DNS servers. This is the initial
# status of all change batch requests.
#
- # * `INSYNC` indicates that the changes have propagated to all Amazon
- # Route 53 DNS servers.
+ # * `INSYNC` indicates that the changes have propagated to all Route 53
+ # DNS servers.
#
# @option params [required, 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.
@@ -2314,23 +2318,23 @@
# supported for Amazon Route 53 geolocation resource record sets.
#
# Use the following syntax to determine whether a continent is supported
# for geolocation:
#
- # `GET /2013-04-01/geolocation?ContinentCode=two-letter abbreviation for
+ # `GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for
# a continent `
#
# Use the following syntax to determine whether a country is supported
# for geolocation:
#
- # `GET /2013-04-01/geolocation?CountryCode=two-character country code `
+ # `GET /2013-04-01/geolocation?countrycode=two-character country code `
#
# Use the following syntax to determine whether a subdivision of a
# country is supported for geolocation:
#
- # `GET /2013-04-01/geolocation?CountryCode=two-character country
- # code&SubdivisionCode=subdivision code `
+ # `GET /2013-04-01/geolocation?countrycode=two-character country
+ # code&subdivisioncode=subdivision code `
#
# @option params [String] :continent_code
# Amazon Route 53 supports the following continent codes:
#
# * **AF**\: Africa
@@ -2355,13 +2359,13 @@
#
# [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
#
# @option params [String] :subdivision_code
# Amazon Route 53 uses the one- to three-letter subdivision codes that
- # are specified in [ISO standard 3166-1 alpha-2][1]. Amazon Route 53
- # doesn't support subdivision codes for all countries. If you specify
- # `SubdivisionCode`, you must also specify `CountryCode`.
+ # are specified in [ISO standard 3166-1 alpha-2][1]. Route 53 doesn't
+ # support subdivision codes for all countries. If you specify
+ # `subdivisioncode`, you must also specify `countrycode`.
#
#
#
# [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
#
@@ -2427,10 +2431,11 @@
# resp.health_check.health_check_config.search_string #=> String
# resp.health_check.health_check_config.request_interval #=> Integer
# resp.health_check.health_check_config.failure_threshold #=> Integer
# resp.health_check.health_check_config.measure_latency #=> Boolean
# resp.health_check.health_check_config.inverted #=> Boolean
+ # resp.health_check.health_check_config.disabled #=> Boolean
# resp.health_check.health_check_config.health_threshold #=> Integer
# resp.health_check.health_check_config.child_health_checks #=> Array
# resp.health_check.health_check_config.child_health_checks[0] #=> String
# resp.health_check.health_check_config.enable_sni #=> Boolean
# resp.health_check.health_check_config.regions #=> Array
@@ -2871,12 +2876,12 @@
# the traffic policy definition. For more information, see the `State`
# response element.
#
# </note>
#
- # <note markdown="1"> In the Amazon Route 53 console, traffic policy instances are known as
- # policy records.
+ # <note markdown="1"> In the Route 53 console, traffic policy instances are known as policy
+ # records.
#
# </note>
#
# @option params [required, String] :id
# The ID of the traffic policy instance that you want to get information
@@ -2931,59 +2936,59 @@
def get_traffic_policy_instance_count(params = {}, options = {})
req = build_request(:get_traffic_policy_instance_count, params)
req.send_request(options)
end
- # Retrieves a list of supported geo locations.
+ # Retrieves a list of supported geographic locations.
#
# Countries are listed first, and continents are listed last. If Amazon
# Route 53 supports subdivisions for a country (for example, states or
# provinces), the subdivisions for that country are listed in
# alphabetical order immediately after the corresponding country.
#
# @option params [String] :start_continent_code
# 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.
+ # locations that Amazon Route 53 supports for geolocation. If Route 53
+ # has already returned a page or more of results, if `IsTruncated` is
+ # true, and if `NextContinentCode` from the previous response has a
+ # value, enter that value in `startcontinentcode` to return the next
+ # page of results.
#
- # Include `StartContinentCode` only if you want to list continents.
- # Don't include `StartContinentCode` when you're listing countries or
+ # Include `startcontinentcode` only if you want to list continents.
+ # Don't include `startcontinentcode` when you're listing countries or
# countries with their subdivisions.
#
# @option params [String] :start_country_code
# 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.
+ # locations that Amazon Route 53 supports for geolocation. If Route 53
+ # has already returned a page or more of results, if `IsTruncated` is
+ # `true`, and if `NextCountryCode` from the previous response has a
+ # value, enter that value in `startcountrycode` to return the next page
+ # of results.
#
- # Amazon Route 53 uses the two-letter country codes that are specified
- # in [ISO standard 3166-1 alpha-2][1].
+ # Route 53 uses the two-letter country codes that are specified in [ISO
+ # standard 3166-1 alpha-2][1].
#
#
#
# [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
#
# @option params [String] :start_subdivision_code
# 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
+ # supports for geolocation. If Route 53 has already returned a page or
+ # more of results, if `IsTruncated` is `true`, and if
# `NextSubdivisionCode` from the previous response has a value, enter
- # that value in `StartSubdivisionCode` to return the next page of
+ # that value in `startsubdivisioncode` to return the next page of
# results.
#
# To list subdivisions of a country, you must include both
- # `StartCountryCode` and `StartSubdivisionCode`.
+ # `startcountrycode` and `startsubdivisioncode`.
#
# @option params [Integer] :max_items
# (Optional) The maximum number of geolocations to be included in the
- # response body for this request. If more than `MaxItems` geolocations
+ # 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`.
#
# @return [Types::ListGeoLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -3044,11 +3049,11 @@
#
# @option params [Integer] :max_items
# The maximum number of health checks that you want `ListHealthChecks`
# to return in response to the current request. Amazon Route 53 returns
# a maximum of 100 items. If you set `MaxItems` to a value greater than
- # 100, Amazon Route 53 returns only the first 100 health checks.
+ # 100, Route 53 returns only the first 100 health checks.
#
# @return [Types::ListHealthChecksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListHealthChecksResponse#health_checks #health_checks} => Array<Types::HealthCheck>
# * {Types::ListHealthChecksResponse#marker #marker} => String
@@ -3078,10 +3083,11 @@
# resp.health_checks[0].health_check_config.search_string #=> String
# resp.health_checks[0].health_check_config.request_interval #=> Integer
# resp.health_checks[0].health_check_config.failure_threshold #=> Integer
# resp.health_checks[0].health_check_config.measure_latency #=> Boolean
# resp.health_checks[0].health_check_config.inverted #=> Boolean
+ # resp.health_checks[0].health_check_config.disabled #=> Boolean
# resp.health_checks[0].health_check_config.health_threshold #=> Integer
# resp.health_checks[0].health_check_config.child_health_checks #=> Array
# resp.health_checks[0].health_check_config.child_health_checks[0] #=> String
# resp.health_checks[0].health_check_config.enable_sni #=> Boolean
# resp.health_checks[0].health_check_config.regions #=> Array
@@ -3136,12 +3142,12 @@
#
# @option params [Integer] :max_items
# (Optional) The maximum number of hosted zones that you want Amazon
# Route 53 to return. If you have more than `maxitems` hosted zones, the
# value of `IsTruncated` in the response is `true`, and the value of
- # `NextMarker` is the hosted zone ID of the first hosted zone that
- # Amazon Route 53 will return if you submit another request.
+ # `NextMarker` is the hosted zone ID of the first hosted zone that Route
+ # 53 will return if you submit another request.
#
# @option params [String] :delegation_set_id
# 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.
@@ -3211,14 +3217,14 @@
# The labels are reversed and alphabetized using the escaped value. For
# more information about valid domain name formats, including
# internationalized domain names, see [DNS Domain Name Format][1] in the
# *Amazon Route 53 Developer Guide*.
#
- # Amazon Route 53 returns up to 100 items in each response. If you have
- # a lot of hosted zones, use the `MaxItems` parameter to list them in
- # groups of up to 100. The response includes values that help navigate
- # from one group of `MaxItems` hosted zones to the next:
+ # Route 53 returns up to 100 items in each response. If you have a lot
+ # of hosted zones, use the `MaxItems` parameter to list them in groups
+ # of up to 100. The response includes values that help navigate from one
+ # group of `MaxItems` hosted zones to the next:
#
# * The `DNSName` and `HostedZoneId` elements in the response contain
# the values, if any, specified for the `dnsname` and `hostedzoneid`
# parameters in the request that produced the current response.
#
@@ -3357,12 +3363,12 @@
# want Amazon Route 53 to return in response to the current request. If
# the current AWS account has more than `MaxResults` configurations, use
# the value of ListQueryLoggingConfigsResponse$NextToken in the response
# to get the next page of results.
#
- # If you don't specify a value for `MaxResults`, Amazon Route 53
- # returns up to 100 configurations.
+ # If you don't specify a value for `MaxResults`, Route 53 returns up to
+ # 100 configurations.
#
# @return [Types::ListQueryLoggingConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListQueryLoggingConfigsResponse#query_logging_configs #query_logging_configs} => Array<Types::QueryLoggingConfig>
# * {Types::ListQueryLoggingConfigsResponse#next_token #next_token} => String
@@ -3394,24 +3400,32 @@
# Lists the resource record sets in a specified hosted zone.
#
# `ListResourceRecordSets` returns up to 100 resource record sets at a
# time in ASCII order, beginning at a position specified by the `name`
- # and `type` elements. The action sorts results first by DNS name with
- # the labels reversed, for example:
+ # and `type` elements.
#
+ # **Sort order**
+ #
+ # `ListResourceRecordSets` sorts results first by DNS name with the
+ # labels reversed, for example:
+ #
# `com.example.www.`
#
- # Note the trailing dot, which can change the sort order in some
- # circumstances.
+ # Note the trailing dot, which can change the sort order when the record
+ # name contains characters that appear before `.` (decimal 46) in the
+ # ASCII table. These characters include the following: `! " # $ % & ' (
+ # ) * + , -`
#
- # When multiple records have the same DNS name, the action sorts results
- # by the record type.
+ # When multiple records have the same DNS name, `ListResourceRecordSets`
+ # sorts results by the record type.
#
- # You can use the name and type elements to adjust the beginning
- # position of the list of resource record sets returned:
+ # **Specifying where to start listing records**
#
+ # You can use the name and type elements to specify the resource record
+ # set that the list begins with:
+ #
# If you do not specify Name or Type
#
# : The results begin with the first resource record set that the hosted
# zone contains.
#
@@ -3428,21 +3442,34 @@
#
# : The results begin with the first resource record set in the list
# whose name is greater than or equal to `Name`, and whose type is
# greater than or equal to `Type`.
#
+ # **Resource record sets that are PENDING**
+ #
# This action returns the most current version of the records. This
# includes records that are `PENDING`, and that are not yet available on
- # all Amazon Route 53 DNS servers.
+ # all Route 53 DNS servers.
#
+ # **Changing resource record sets**
+ #
# To ensure that you get an accurate listing of the resource record sets
# for a hosted zone at a point in time, do not submit a
# `ChangeResourceRecordSets` request while you're paging through the
# results of a `ListResourceRecordSets` request. If you do, some pages
# may display results without the latest changes while other pages
# display results with the latest changes.
#
+ # **Displaying the next page of results**
+ #
+ # If a `ListResourceRecordSets` command returns more than one page of
+ # results, the value of `IsTruncated` is `true`. To display the next
+ # page of results, get the values of `NextRecordName`, `NextRecordType`,
+ # and `NextRecordIdentifier` (if any) from the response. Then submit
+ # another `ListResourceRecordSets` request, and specify those values for
+ # `StartRecordName`, `StartRecordType`, and `StartRecordIdentifier`.
+ #
# @option params [required, String] :hosted_zone_id
# The ID of the hosted zone that contains the resource record sets that
# you want to list.
#
# @option params [String] :start_record_name
@@ -3454,13 +3481,13 @@
#
# Valid values for basic resource record sets: `A` \| `AAAA` \| `CAA` \|
# `CNAME` \| `MX` \| `NAPTR` \| `NS` \| `PTR` \| `SOA` \| `SPF` \| `SRV`
# \| `TXT`
#
- # Values for weighted, latency, geo, and failover resource record sets:
- # `A` \| `AAAA` \| `CAA` \| `CNAME` \| `MX` \| `NAPTR` \| `PTR` \| `SPF`
- # \| `SRV` \| `TXT`
+ # Values for weighted, latency, geolocation, and failover resource
+ # record sets: `A` \| `AAAA` \| `CAA` \| `CNAME` \| `MX` \| `NAPTR` \|
+ # `PTR` \| `SPF` \| `SRV` \| `TXT`
#
# Values for alias resource record sets:
#
# * **CloudFront distribution**\: A or AAAA
#
@@ -3563,11 +3590,11 @@
# there are no more reusable delegation sets to get.
#
# @option params [Integer] :max_items
# The number of reusable delegation sets that you want Amazon Route 53
# to return in the response to this request. If you specify a value
- # greater than 100, Amazon Route 53 returns only the first 100 reusable
+ # greater than 100, Route 53 returns only the first 100 reusable
# delegation sets.
#
# @return [Types::ListReusableDelegationSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListReusableDelegationSetsResponse#delegation_sets #delegation_sets} => Array<Types::DelegationSet>
@@ -3702,11 +3729,11 @@
req.send_request(options)
end
# Gets information about the latest version for every traffic policy
# that is associated with the current AWS account. Policies are listed
- # in the order in which they were created.
+ # in the order that they were created in.
#
# @option params [String] :traffic_policy_id_marker
# (Conditional) For your first request to `ListTrafficPolicies`, don't
# include the `TrafficPolicyIdMarker` parameter.
#
@@ -3720,12 +3747,12 @@
# @option params [Integer] :max_items
# (Optional) The maximum number of traffic policies that you want Amazon
# Route 53 to return in response to this request. If you have more than
# `MaxItems` traffic policies, the value of `IsTruncated` in the
# response is `true`, and the value of `TrafficPolicyIdMarker` is the ID
- # of the first traffic policy that Amazon Route 53 will return if you
- # submit another request.
+ # of the first traffic policy that Route 53 will return if you submit
+ # another request.
#
# @return [Types::ListTrafficPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTrafficPoliciesResponse#traffic_policy_summaries #traffic_policy_summaries} => Array<Types::TrafficPolicySummary>
# * {Types::ListTrafficPoliciesResponse#is_truncated #is_truncated} => Boolean
@@ -3768,12 +3795,12 @@
# that are specified in the traffic policy definition. For more
# information, see the `State` response element.
#
# </note>
#
- # Amazon 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`
+ # 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.
#
# @option params [String] :hosted_zone_id_marker
# If the value of `IsTruncated` in the previous response was `true`, you
# have more traffic policy instances. To get more traffic policy
@@ -3873,12 +3900,12 @@
# the traffic policy definition. For more information, see the `State`
# response element.
#
# </note>
#
- # Amazon 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`
+ # 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.
#
# @option params [required, String] :hosted_zone_id
# The ID of the hosted zone that you want to list traffic policy
# instances for.
@@ -3969,12 +3996,12 @@
# the traffic policy definition. For more information, see the `State`
# response element.
#
# </note>
#
- # Amazon 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`
+ # 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.
#
# @option params [required, String] :traffic_policy_id
# The ID of the traffic policy for which you want to list traffic policy
# instances.
@@ -4108,11 +4135,11 @@
# The maximum number of traffic policy versions that you want Amazon
# Route 53 to include in the response body for this request. If the
# specified traffic policy has more than `MaxItems` versions, the value
# of `IsTruncated` in the response is `true`, and the value of the
# `TrafficPolicyVersionMarker` element is the ID of the first version
- # that Amazon Route 53 will return if you submit another request.
+ # that Route 53 will return if you submit another request.
#
# @return [Types::ListTrafficPolicyVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTrafficPolicyVersionsResponse#traffic_policies #traffic_policies} => Array<Types::TrafficPolicy>
# * {Types::ListTrafficPolicyVersionsResponse#is_truncated #is_truncated} => Boolean
@@ -4168,11 +4195,11 @@
# another `ListVPCAssociationAuthorizations` request.
#
# @option params [String] :max_results
# *Optional*\: An integer that specifies the maximum number of VPCs that
# you want Amazon Route 53 to return. If you don't specify a value for
- # `MaxResults`, Amazon Route 53 returns up to 50 VPCs per page.
+ # `MaxResults`, Route 53 returns up to 50 VPCs per page.
#
# @return [Types::ListVPCAssociationAuthorizationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListVPCAssociationAuthorizationsResponse#hosted_zone_id #hosted_zone_id} => String
# * {Types::ListVPCAssociationAuthorizationsResponse#next_token #next_token} => String
@@ -4237,10 +4264,17 @@
# specify `192.0.2.44` for `edns0clientsubnetip` and `24` for
# `edns0clientsubnetmask`, the checking tool will simulate a request
# from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and
# 64 bits for IPv6 addresses.
#
+ # The range of valid values depends on whether `edns0clientsubnetip` is
+ # an IPv4 or an IPv6 address:
+ #
+ # * **IPv4**\: Specify a value between 0 and 32
+ #
+ # * **IPv6**\: Specify a value between 0 and 128
+ #
# @return [Types::TestDNSAnswerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::TestDNSAnswerResponse#nameserver #nameserver} => String
# * {Types::TestDNSAnswerResponse#record_name #record_name} => String
# * {Types::TestDNSAnswerResponse#record_type #record_type} => String
@@ -4300,30 +4334,29 @@
# 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:
+ # `UpdateHealthCheck` request. This prevents Route 53 from overwriting
+ # an intervening update:
#
# * If the value in the `UpdateHealthCheck` request matches the value of
- # `HealthCheckVersion` in the health check, Amazon Route 53 updates
- # the health check with the new settings.
+ # `HealthCheckVersion` in the health check, Route 53 updates the
+ # health check with the new settings.
#
# * If the value of `HealthCheckVersion` in the health check is greater,
- # the health check was changed after you got the version number.
- # Amazon Route 53 does not update the health check, and it returns a
+ # 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.
#
# @option params [String] :ip_address
# 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`, 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 is returned by DNS, Amazon Route 53 then checks the health of the
- # endpoint.
+ # for `IPAddress`, Route 53 sends a DNS request to resolve the domain
+ # name that you specify in `FullyQualifiedDomainName` at the interval
+ # that you specify in `RequestInterval`. Using an IP address that is
+ # returned by DNS, Route 53 then checks the health of the endpoint.
#
# Use one of the following formats for the value of `IPAddress`\:
#
# * **IPv4 address**\: four values between 0 and 255, separated by
# periods (.), for example, `192.0.2.44`.
@@ -4353,12 +4386,12 @@
# </note>
#
# For more information, see
# UpdateHealthCheckRequest$FullyQualifiedDomainName.
#
- # Constraints: Amazon Route 53 can't check the health of endpoints for
- # which the IP address is in local, private, non-routable, or multicast
+ # Constraints: Route 53 can't check the health of endpoints for which
+ # the IP address is in local, private, non-routable, or multicast
# ranges. For more information about IP addresses for which you can't
# create health checks, see the following documents:
#
# * [RFC 5735, Special Use IPv4 Addresses][3]
#
@@ -4380,11 +4413,13 @@
#
# @option params [String] :resource_path
# 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.
+ # for example the file /docs/route53-health-check.html. You can also
+ # include query string parameters, for example,
+ # `/welcome.html?language=jp&login=y`.
#
# Specify this value only if you want to change it.
#
# @option params [String] :fully_qualified_domain_name
# Amazon Route 53 behavior depends on whether you specify a value for
@@ -4396,47 +4431,47 @@
#
# </note>
#
# **If you specify a value for** `IPAddress`\:
#
- # Amazon Route 53 sends health check requests to the specified IPv4 or
- # IPv6 address and passes the value of `FullyQualifiedDomainName` in the
+ # 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 Amazon Route 53 to perform health checks.
+ # want Route 53 to perform health checks.
#
- # When Amazon Route 53 checks the health of an endpoint, here is how it
+ # When Route 53 checks the health of an endpoint, here is how it
# constructs the `Host` header:
#
# * If you specify a value of `80` for `Port` and `HTTP` or
- # `HTTP_STR_MATCH` for `Type`, Amazon Route 53 passes the value of
+ # `HTTP_STR_MATCH` for `Type`, Route 53 passes the value of
# `FullyQualifiedDomainName` to the endpoint in the `Host` header.
#
# * If you specify a value of `443` for `Port` and `HTTPS` or
- # `HTTPS_STR_MATCH` for `Type`, Amazon Route 53 passes the value of
+ # `HTTPS_STR_MATCH` for `Type`, Route 53 passes the value of
# `FullyQualifiedDomainName` to the endpoint in the `Host` header.
#
# * If you specify another value for `Port` and any value except `TCP`
- # for `Type`, Amazon Route 53 passes <i>
+ # for `Type`, Route 53 passes <i>
# <code>FullyQualifiedDomainName</code>\:<code>Port</code> </i> 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 a value for `FullyQualifiedDomainName`, Route 53
+ # substitutes the value of `IPAddress` in the `Host` header in each of
+ # the above cases.
#
# **If you don't specify a value for** `IPAddress`\:
#
- # If you don't specify a value for `IPAddress`, Amazon 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,
- # Amazon Route 53 then checks the health of the endpoint.
+ # If you don't specify a value for `IPAddress`, Route 53 sends a DNS
+ # request to the domain that you specify in `FullyQualifiedDomainName`
+ # at the interval you specify in `RequestInterval`. Using an IPv4
+ # address that is returned by DNS, Route 53 then checks the health of
+ # the endpoint.
#
- # <note markdown="1"> If you don't specify a value for `IPAddress`, Amazon 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
+ # <note markdown="1"> If you don't specify a value for `IPAddress`, Route 53 uses only IPv4
+ # to send health checks to the endpoint. If there's no resource record
+ # set with a type of A for the name that you specify for
# `FullyQualifiedDomainName`, the health check fails with a "DNS
# resolution failed" error.
#
# </note>
#
@@ -4453,21 +4488,21 @@
# 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.
+ # `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.
#
# @option params [String] :search_string
# 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.)
+ # response body, Route 53 considers the resource healthy. (You can't
+ # change the value of `Type` when you update a health check.)
#
# @option params [Integer] :failure_threshold
# 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
@@ -4484,10 +4519,36 @@
# @option params [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.
#
+ # @option params [Boolean] :disabled
+ # Stops Route 53 from performing health checks. When you disable a
+ # health check, here's what happens:
+ #
+ # * **Health checks that check the health of endpoints:** Route 53 stops
+ # submitting requests to your application, server, or other resource.
+ #
+ # * **Calculated health checks:** Route 53 stops aggregating the status
+ # of the referenced health checks.
+ #
+ # * **Health checks that monitor CloudWatch alarms:** Route 53 stops
+ # monitoring the corresponding CloudWatch metrics.
+ #
+ # After you disable a health check, Route 53 considers the status of the
+ # health check to always be healthy. If you configured DNS failover,
+ # Route 53 continues to route traffic to the corresponding resources. If
+ # you want to stop routing traffic to a resource, change the value of
+ # UpdateHealthCheckRequest$Inverted.
+ #
+ # Charges for a health check still apply when the health check is
+ # disabled. For more information, see [Amazon Route 53 Pricing][1].
+ #
+ #
+ #
+ # [1]: http://aws.amazon.com/route53/pricing/
+ #
# @option params [Integer] :health_threshold
# 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`
@@ -4495,15 +4556,14 @@
# 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.
+ # checks, 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.
+ # * If you specify `0`, Route 53 always considers this health check to
+ # be healthy.
#
# @option params [Array<String>] :child_health_checks
# A complex type that contains one `ChildHealthCheck` element for each
# health check that you want to associate with a `CALCULATED` health
# check.
@@ -4538,45 +4598,43 @@
# you want Amazon Route 53 health checkers to check the specified
# endpoint from.
#
# @option params [Types::AlarmIdentifier] :alarm_identifier
# 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.
+ # Amazon Route 53 health checkers to use to determine whether the
+ # specified health check is healthy.
#
# @option params [String] :insufficient_data_health_status
# 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.
+ # * `Healthy`\: Route 53 considers the health check to be healthy.
#
- # * `Unhealthy`\: Amazon Route 53 considers the health check to be
- # unhealthy.
+ # * `Unhealthy`\: 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.
+ # * `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.
#
# @option params [Array<String>] :reset_elements
# A complex type that contains one `ResettableElementName` element for
# each element that you want to reset to the default value. Valid values
# for `ResettableElementName` include the following:
#
# * `ChildHealthChecks`\: Amazon Route 53 resets
# HealthCheckConfig$ChildHealthChecks to null.
#
- # * `FullyQualifiedDomainName`\: Amazon Route 53 resets
+ # * `FullyQualifiedDomainName`\: Route 53 resets
# HealthCheckConfig$FullyQualifiedDomainName to null.
#
- # * `Regions`\: Amazon Route 53 resets the HealthCheckConfig$Regions
- # list to the default set of regions.
+ # * `Regions`\: Route 53 resets the HealthCheckConfig$Regions list to
+ # the default set of regions.
#
- # * `ResourcePath`\: Amazon Route 53 resets
- # HealthCheckConfig$ResourcePath to null.
+ # * `ResourcePath`\: Route 53 resets HealthCheckConfig$ResourcePath to
+ # null.
#
# @return [Types::UpdateHealthCheckResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateHealthCheckResponse#health_check #health_check} => Types::HealthCheck
#
@@ -4590,10 +4648,11 @@
# resource_path: "ResourcePath",
# fully_qualified_domain_name: "FullyQualifiedDomainName",
# search_string: "SearchString",
# failure_threshold: 1,
# inverted: false,
+ # disabled: false,
# health_threshold: 1,
# child_health_checks: ["HealthCheckId"],
# enable_sni: false,
# regions: ["us-east-1"], # accepts us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
# alarm_identifier: {
@@ -4618,10 +4677,11 @@
# resp.health_check.health_check_config.search_string #=> String
# resp.health_check.health_check_config.request_interval #=> Integer
# resp.health_check.health_check_config.failure_threshold #=> Integer
# resp.health_check.health_check_config.measure_latency #=> Boolean
# resp.health_check.health_check_config.inverted #=> Boolean
+ # resp.health_check.health_check_config.disabled #=> Boolean
# resp.health_check.health_check_config.health_threshold #=> Integer
# resp.health_check.health_check_config.child_health_checks #=> Array
# resp.health_check.health_check_config.child_health_checks[0] #=> String
# resp.health_check.health_check_config.enable_sni #=> Boolean
# resp.health_check.health_check_config.regions #=> Array
@@ -4738,24 +4798,24 @@
# 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. Amazon Route 53 performs the following operations:
+ # with another. Route 53 performs the following operations:
#
- # 1. Amazon Route 53 creates a new group of resource record sets based
- # on the specified traffic policy. This is true regardless of how
+ # 1. 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.
#
- # 2. When all of the new resource record sets have been created, Amazon
- # 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.
+ # 2. 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.
#
- # 3. Amazon Route 53 deletes the old group of resource record sets that
- # are associated with the root resource record set name.
+ # 3. Route 53 deletes the old group of resource record sets that are
+ # associated with the root resource record set name.
#
# @option params [required, String] :id
# The ID of the traffic policy instance that you want to update.
#
# @option params [required, Integer] :ttl
@@ -4816,10 +4876,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-route53'
- context[:gem_version] = '1.12.0'
+ context[:gem_version] = '1.13.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#