You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::Route53::Client::V20130401

Inherits:
AWS::Route53::Client show all
Defined in:
lib/aws/route_53/client.rb

Constant Summary

Constant Summary

Constants inherited from AWS::Route53::Client

API_VERSION

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#associate_vpc_with_hosted_zone(options = {}) ⇒ Core::Response

Calls the POST AssociateVPCWithHostedZone API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :hosted_zone_id - required - (String) The ID of the hosted zone you want to associate your VPC with. Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
    • :vpc - required - (Hash) The VPC that you want your hosted zone to be associated with.
      • :vpc_region - (String) Valid values include:
        • us-east-1
        • us-west-1
        • us-west-2
        • eu-west-1
        • eu-central-1
        • ap-southeast-1
        • ap-southeast-2
        • ap-northeast-1
        • sa-east-1
        • cn-north-1
      • :vpc_id - (String)
    • :comment - (String) Optional: Any comments you want to include about a AssociateVPCWithHostedZoneRequest.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :change_info - (Hash)
      • :id - (String)
      • :status - (String)
      • :submitted_at - (Time)
      • :comment - (String)

#change_resource_record_sets(options = {}) ⇒ Core::Response

Calls the POST ChangeResourceRecordSets API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :hosted_zone_id - required - (String) The ID of the hosted zone that contains the resource record sets that you want to change.
    • :change_batch - required - (Hash) A complex type that contains an optional comment and the Changes element.
      • :comment - (String) Optional: Any comments you want to include about a change batch request.
      • :changes - required - (Array<Hash>) A complex type that contains one Change element for each resource record set that you want to create or delete.
      • :Change - (Hash)
        • :action - required - (String) The action to perform. Valid values: CREATE | DELETE | UPSERT Valid values include:
          • CREATE
          • DELETE
          • UPSERT
        • :resource_record_set - required - (Hash) Information about the resource record set to create or delete.
          • :name - required - (String) The domain name of the current resource record set.
          • :type - required - (String) The type of the current resource record set. Valid values include:
            • SOA
            • A
            • TXT
            • NS
            • CNAME
            • MX
            • PTR
            • SRV
            • SPF
            • AAAA
          • :set_identifier - (String) Weighted resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
          • :weight - (Integer) Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.
          • :region - (String) Regional resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set. Valid values include:
            • us-east-1
            • us-west-1
            • us-west-2
            • eu-west-1
            • eu-central-1
            • ap-southeast-1
            • ap-southeast-2
            • ap-northeast-1
            • sa-east-1
            • cn-north-1
          • :geo_location - (Hash) Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
            • :continent_code - (String) The code for a continent geo location. Note: only continent locations have a continent code. Valid values: AF | AN | AS | EU | OC | NA | SA Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
            • :country_code - (String) The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location. The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
            • :subdivision_code - (String) The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code. Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
          • :failover - (String) Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true : (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set. Valid values: PRIMARY | SECONDARY Valid values include:
            • PRIMARY
            • SECONDARY
          • :ttl - (Integer) The cache time to live for the current resource record set.
          • :resource_records - (Array<Hash>) A complex type that contains the resource records for the current resource record set.
          • :ResourceRecord - (Hash)
            • :value - required - (String) The value of the Value element for the current resource record set.
          • :alias_target - (Hash) Alias resource record sets only: Information about the Elastic Load Balancing LoadBalancer to which you are redirecting traffic.
            • :hosted_zone_id - required - (String) Alias resource record sets only: The value of the hosted zone ID, CanonicalHostedZoneNameId, for the LoadBalancer. Currently, Route 53 supports alias resource record sets only for Elastic Load Balancing. For more information, an example, and several ways to get the hosted zone ID for the LoadBalancer, see Creating Alias Resource Record Sets for Elastic Load Balancing in the Amazon Route 53 Developer Guide.
            • :dns_name - required - (String) Alias resource record sets only: The external DNS name associated with the LoadBalancer. Currently, Route 53 supports alias resource record sets only for Elastic Load Balancing. For more information, an example, and several ways to get the hosted zone ID for the LoadBalancer, see Creating Alias Resource Record Sets for Elastic Load Balancing in the Amazon Route 53 Developer Guide.
            • :evaluate_target_health - required - (Boolean) Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to. Currently, Route 53 supports health checks only for Elastic Load Balancing. For more information, an example, see Creating Alias Resource Record Sets for Elastic Load Balancing in the Amazon Route 53 Developer Guide.
          • :health_check_id - (String) Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :change_info - (Hash)
      • :id - (String)
      • :status - (String)
      • :submitted_at - (Time)
      • :comment - (String)

#change_tags_for_resource(options = {}) ⇒ Core::Response

Calls the POST ChangeTagsForResource API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :resource_type - required - (String) The type of the resource. The resource type for health checks is healthcheck. Valid values include:
      • healthcheck
    • :resource_id - required - (String) The ID of the resource for which you want to add, change, or delete tags.
    • :add_tags - (Array<Hash>) A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.
    • :Tag - (Hash)
      • :key - (String) The key for a Tag.
      • :value - (String) The value for a Tag.
    • :remove_tag_keys - (Array<String>) A list of Tag keys that you want to remove from the specified resource.
    • :Key - (String)

Returns:

#create_health_check(options = {}) ⇒ Core::Response

Calls the POST CreateHealthCheck API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :caller_reference - required - (String) A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
    • :health_check_config - required - (Hash) A complex type that contains health check configuration.
      • :ip_address - (String) IP Address of the instance being checked.
      • :port - (Integer) Port on which connection will be opened to the instance to health check. For HTTP this defaults to 80 if the port is not specified. For HTTPS this defaults to 443 if the port is not specified.
      • :type - required - (String) The type of health check to be performed. Currently supported protocols are TCP, HTTP, and HTTPS. Valid values include:
        • HTTP
        • HTTPS
        • HTTP_STR_MATCH
        • HTTPS_STR_MATCH
        • TCP
      • :resource_path - (String) Path to ping on the instance to check the health. Required for HTTP and HTTPS health checks, HTTP request is issued to the instance on the given port and path.
      • :fully_qualified_domain_name - (String) Fully qualified domain name of the instance to be health checked.
      • :search_string - (String) A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
      • :request_interval - (Integer) The number of seconds between the time that 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. Valid values are 10 and 30. The default value is 30.
      • :failure_threshold - (Integer) The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_check - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :health_check_config - (Hash)
        • :ip_address - (String)
        • :port - (Integer)
        • :type - (String)
        • :resource_path - (String)
        • :fully_qualified_domain_name - (String)
        • :search_string - (String)
        • :request_interval - (Integer)
        • :failure_threshold - (Integer)
      • :health_check_version - (Integer)

#create_hosted_zone(options = {}) ⇒ Core::Response

Calls the POST CreateHostedZone API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :name - required - (String) The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; 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. This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
    • :vpc - (Hash) The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
      • :vpc_region - (String) Valid values include:
        • us-east-1
        • us-west-1
        • us-west-2
        • eu-west-1
        • eu-central-1
        • ap-southeast-1
        • ap-southeast-2
        • ap-northeast-1
        • sa-east-1
        • cn-north-1
      • :vpc_id - (String)
    • :caller_reference - required - (String) A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
    • :hosted_zone_config - (Hash) A complex type that contains an optional comment about your hosted zone.
      • :comment - (String) An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
      • :private_zone - (Boolean)
    • :delegation_set_id - (String) The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :hosted_zone - (Hash)
      • :id - (String)
      • :name - (String)
      • :caller_reference - (String)
      • :config - (Hash)
        • :comment - (String)
        • :private_zone - (Boolean)
      • :resource_record_set_count - (Integer)
    • :change_info - (Hash)
      • :id - (String)
      • :status - (String)
      • :submitted_at - (Time)
      • :comment - (String)
    • :delegation_set - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :name_servers - (Array)
    • :vpc - (Hash)
      • :vpc_region - (String)
      • :vpc_id - (String)

#create_reusable_delegation_set(options = {}) ⇒ Core::Response

Calls the POST CreateReusableDelegationSet API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :caller_reference - required - (String) A unique string that identifies the request and that allows failed CreateReusableDelegationSet requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a reusable delegation set. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
    • :hosted_zone_id - (String) The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :delegation_set - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :name_servers - (Array)

#delete_health_check(options = {}) ⇒ Core::Response

Calls the DELETE DeleteHealthCheck API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :health_check_id - required - (String) The ID of the health check to delete.

Returns:

#delete_hosted_zone(options = {}) ⇒ Core::Response

Calls the DELETE DeleteHostedZone API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :id - required - (String) The ID of the request. Include this ID in a call to GetChange to track when the change has propagated to all Route 53 DNS servers.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :change_info - (Hash)
      • :id - (String)
      • :status - (String)
      • :submitted_at - (Time)
      • :comment - (String)

#delete_reusable_delegation_set(options = {}) ⇒ Core::Response

Calls the DELETE DeleteReusableDelegationSet API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :id - required - (String) The ID of the reusable delegation set you want to delete.

Returns:

#disassociate_vpc_from_hosted_zone(options = {}) ⇒ Core::Response

Calls the POST DisassociateVPCFromHostedZone API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :hosted_zone_id - required - (String) The ID of the hosted zone you want to disassociate your VPC from. Note that you cannot disassociate the last VPC from a hosted zone.
    • :vpc - required - (Hash) The VPC that you want your hosted zone to be disassociated from.
      • :vpc_region - (String) Valid values include:
        • us-east-1
        • us-west-1
        • us-west-2
        • eu-west-1
        • eu-central-1
        • ap-southeast-1
        • ap-southeast-2
        • ap-northeast-1
        • sa-east-1
        • cn-north-1
      • :vpc_id - (String)
    • :comment - (String) Optional: Any comments you want to include about a DisassociateVPCFromHostedZoneRequest.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :change_info - (Hash)
      • :id - (String)
      • :status - (String)
      • :submitted_at - (Time)
      • :comment - (String)

#get_change(options = {}) ⇒ Core::Response

Calls the GET GetChange API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :id - required - (String) 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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :change_info - (Hash)
      • :id - (String)
      • :status - (String)
      • :submitted_at - (Time)
      • :comment - (String)

#get_checker_ip_ranges(options = {}) ⇒ Core::Response

Calls the GET GetCheckerIpRanges API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :checker_ip_ranges - (Array)

#get_geo_location(options = {}) ⇒ Core::Response

Calls the GET GetGeoLocation API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :continent_code - (String) The code for a continent geo location. Note: only continent locations have a continent code. Valid values: AF | AN | AS | EU | OC | NA | SA Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
    • :country_code - (String) The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location. The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
    • :subdivision_code - (String) The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code. Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :geo_location_details - (Hash)
      • :continent_code - (String)
      • :continent_name - (String)
      • :country_code - (String)
      • :country_name - (String)
      • :subdivision_code - (String)
      • :subdivision_name - (String)

#get_health_check(options = {}) ⇒ Core::Response

Calls the GET GetHealthCheck API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :health_check_id - required - (String) The ID of the health check to retrieve.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_check - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :health_check_config - (Hash)
        • :ip_address - (String)
        • :port - (Integer)
        • :type - (String)
        • :resource_path - (String)
        • :fully_qualified_domain_name - (String)
        • :search_string - (String)
        • :request_interval - (Integer)
        • :failure_threshold - (Integer)
      • :health_check_version - (Integer)

#get_health_check_count(options = {}) ⇒ Core::Response

Calls the GET GetHealthCheckCount API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_check_count - (Integer)

#get_health_check_last_failure_reason(options = {}) ⇒ Core::Response

Calls the GET GetHealthCheckLastFailureReason API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :health_check_id - required - (String) The ID of the health check for which you want to retrieve the reason for the most recent failure.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_check_observations - (Array)
      • :ip_address - (String)
      • :status_report - (Hash)
        • :status - (String)
        • :checked_time - (Time)

#get_health_check_status(options = {}) ⇒ Core::Response

Calls the GET GetHealthCheckStatus API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :health_check_id - required - (String) The ID of the health check for which you want to retrieve the most recent status.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_check_observations - (Array)
      • :ip_address - (String)
      • :status_report - (Hash)
        • :status - (String)
        • :checked_time - (Time)

#get_hosted_zone(options = {}) ⇒ Core::Response

Calls the GET GetHostedZone API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :id - required - (String) The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :hosted_zone - (Hash)
      • :id - (String)
      • :name - (String)
      • :caller_reference - (String)
      • :config - (Hash)
        • :comment - (String)
        • :private_zone - (Boolean)
      • :resource_record_set_count - (Integer)
    • :delegation_set - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :name_servers - (Array)
    • :vp_cs - (Array)
      • :vpc_region - (String)
      • :vpc_id - (String)

#get_reusable_delegation_set(options = {}) ⇒ Core::Response

Calls the GET GetReusableDelegationSet API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :id - required - (String) The ID of the reusable delegation set for which you want to get a list of the name server.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :delegation_set - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :name_servers - (Array)

#list_geo_locations(options = {}) ⇒ Core::Response

Calls the GET ListGeoLocations API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :start_continent_code - (String) The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null. Valid values: AF | AN | AS | EU | OC | NA | SA Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
    • :start_country_code - (String) The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
    • :start_subdivision_code - (String) The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
    • :max_items - (Integer) The maximum number of geo locations you want in the response body.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :geo_location_details_list - (Array)
      • :continent_code - (String)
      • :continent_name - (String)
      • :country_code - (String)
      • :country_name - (String)
      • :subdivision_code - (String)
      • :subdivision_name - (String)
    • :is_truncated - (Boolean)
    • :next_continent_code - (String)
    • :next_country_code - (String)
    • :next_subdivision_code - (String)
    • :max_items - (String)

#list_health_checks(options = {}) ⇒ Core::Response

Calls the GET ListHealthChecks API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :marker - (String) If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
    • :max_items - (Integer) Specify the maximum number of health checks to return per page of results.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_checks - (Array)
      • :id - (String)
      • :caller_reference - (String)
      • :health_check_config - (Hash)
        • :ip_address - (String)
        • :port - (Integer)
        • :type - (String)
        • :resource_path - (String)
        • :fully_qualified_domain_name - (String)
        • :search_string - (String)
        • :request_interval - (Integer)
        • :failure_threshold - (Integer)
      • :health_check_version - (Integer)
    • :marker - (String)
    • :is_truncated - (Boolean)
    • :next_marker - (String)
    • :max_items - (String)

#list_hosted_zones(options = {}) ⇒ Core::Response

Calls the GET ListHostedZones API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :marker - (String) If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
    • :max_items - (Integer) Specify the maximum number of hosted zones to return per page of results.
    • :delegation_set_id - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :hosted_zones - (Array)
      • :id - (String)
      • :name - (String)
      • :caller_reference - (String)
      • :config - (Hash)
        • :comment - (String)
        • :private_zone - (Boolean)
      • :resource_record_set_count - (Integer)
    • :marker - (String)
    • :is_truncated - (Boolean)
    • :next_marker - (String)
    • :max_items - (Integer)

#list_resource_record_sets(options = {}) ⇒ Core::Response

Calls the GET ListResourceRecordSets API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :hosted_zone_id - required - (String) The ID of the hosted zone that contains the resource record sets that you want to get.
    • :start_record_name - (String) The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
    • :start_record_type - (String) The DNS type at which to begin the listing of resource record sets. Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT Values for Alias Resource Record Sets: A | AAAA Constraint: Specifying type without specifying name returns an InvalidInput error. Valid values include:
      • SOA
      • A
      • TXT
      • NS
      • CNAME
      • MX
      • PTR
      • SRV
      • SPF
      • AAAA
    • :start_record_identifier - (String) Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
    • :max_items - (Integer) The maximum number of records you want in the response body.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :resource_record_sets - (Array)
      • :name - (String)
      • :type - (String)
      • :set_identifier - (String)
      • :weight - (Integer)
      • :region - (String)
      • :geo_location - (Hash)
        • :continent_code - (String)
        • :country_code - (String)
        • :subdivision_code - (String)
      • :failover - (String)
      • :ttl - (Integer)
      • :resource_records - (Array)
        • :value - (String)
      • :alias_target - (Hash)
        • :hosted_zone_id - (String)
        • :dns_name - (String)
        • :evaluate_target_health - (Boolean)
      • :health_check_id - (String)
    • :is_truncated - (Boolean)
    • :next_record_name - (String)
    • :next_record_type - (String)
    • :next_record_identifier - (String)
    • :max_items - (Integer)

#list_reusable_delegation_sets(options = {}) ⇒ Core::Response

Calls the GET ListReusableDelegationSets API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :marker - (String) If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
    • :max_items - (Integer) Specify the maximum number of reusable delegation sets to return per page of results.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :delegation_sets - (Array)
      • :id - (String)
      • :caller_reference - (String)
      • :name_servers - (Array)
    • :marker - (String)
    • :is_truncated - (Boolean)
    • :next_marker - (String)
    • :max_items - (String)

#list_tags_for_resource(options = {}) ⇒ Core::Response

Calls the GET ListTagsForResource API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :resource_type - required - (String) The type of the resource. The resource type for health checks is healthcheck. Valid values include:
      • healthcheck
    • :resource_id - required - (String) The ID of the resource for which you want to retrieve tags.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :resource_tag_set - (Hash)
      • :resource_type - (String)
      • :resource_id - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#list_tags_for_resources(options = {}) ⇒ Core::Response

Calls the POST ListTagsForResources API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :resource_type - required - (String) The type of the resources. The resource type for health checks is healthcheck. Valid values include:
      • healthcheck
    • :resource_ids - required - (Array<String>) A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
    • :ResourceId - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :resource_tag_sets - (Array)
      • :resource_type - (String)
      • :resource_id - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#update_health_check(options = {}) ⇒ Core::Response

Calls the POST UpdateHealthCheck API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :health_check_id - required - (String) The ID of the health check to update.
    • :health_check_version - (Integer) Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
    • :ip_address - (String) The IP address of the resource that you want to check. Specify this value only if you want to change it.
    • :port - (Integer) The port on which you want Route 53 to open a connection to perform health checks. Specify this value only if you want to change it.
    • :resource_path - (String) The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. Specify this value only if you want to change it.
    • :fully_qualified_domain_name - (String) Fully qualified domain name of the instance to be health checked. Specify this value only if you want to change it.
    • :search_string - (String) If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want 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. Specify this value only if you want to change it.
    • :failure_threshold - (Integer) The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide. Specify this value only if you want to change it.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :health_check - (Hash)
      • :id - (String)
      • :caller_reference - (String)
      • :health_check_config - (Hash)
        • :ip_address - (String)
        • :port - (Integer)
        • :type - (String)
        • :resource_path - (String)
        • :fully_qualified_domain_name - (String)
        • :search_string - (String)
        • :request_interval - (Integer)
        • :failure_threshold - (Integer)
      • :health_check_version - (Integer)