Class: Aws::Route53::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb
Overview
An API client for Route53. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Route53::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_key_signing_key(params = {}) ⇒ Types::ActivateKeySigningKeyResponse
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC.
-
#associate_vpc_with_hosted_zone(params = {}) ⇒ Types::AssociateVPCWithHostedZoneResponse
Associates an Amazon VPC with a private hosted zone.
-
#change_cidr_collection(params = {}) ⇒ Types::ChangeCidrCollectionResponse
Creates, changes, or deletes CIDR blocks within a collection.
-
#change_resource_record_sets(params = {}) ⇒ Types::ChangeResourceRecordSetsResponse
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name.
-
#change_tags_for_resource(params = {}) ⇒ Struct
Adds, edits, or deletes tags for a health check or a hosted zone.
-
#create_cidr_collection(params = {}) ⇒ Types::CreateCidrCollectionResponse
Creates a CIDR collection in the current Amazon Web Services account.
-
#create_health_check(params = {}) ⇒ Types::CreateHealthCheckResponse
Creates a new health check.
-
#create_hosted_zone(params = {}) ⇒ Types::CreateHostedZoneResponse
Creates a new public or private hosted zone.
-
#create_key_signing_key(params = {}) ⇒ Types::CreateKeySigningKeyResponse
Creates a new key-signing key (KSK) associated with a hosted zone.
-
#create_query_logging_config(params = {}) ⇒ Types::CreateQueryLoggingConfigResponse
Creates a configuration for DNS query logging.
-
#create_reusable_delegation_set(params = {}) ⇒ Types::CreateReusableDelegationSetResponse
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.
-
#create_traffic_policy(params = {}) ⇒ Types::CreateTrafficPolicyResponse
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
-
#create_traffic_policy_instance(params = {}) ⇒ Types::CreateTrafficPolicyInstanceResponse
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version.
-
#create_traffic_policy_version(params = {}) ⇒ Types::CreateTrafficPolicyVersionResponse
Creates a new version of an existing traffic policy.
-
#create_vpc_association_authorization(params = {}) ⇒ Types::CreateVPCAssociationAuthorizationResponse
Authorizes the Amazon Web Services account that created a specified VPC to submit an
AssociateVPCWithHostedZone
request to associate the VPC with a specified hosted zone that was created by a different account. -
#deactivate_key_signing_key(params = {}) ⇒ Types::DeactivateKeySigningKeyResponse
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.
-
#delete_cidr_collection(params = {}) ⇒ Struct
Deletes a CIDR collection in the current Amazon Web Services account.
-
#delete_health_check(params = {}) ⇒ Struct
Deletes a health check.
-
#delete_hosted_zone(params = {}) ⇒ Types::DeleteHostedZoneResponse
Deletes a hosted zone.
-
#delete_key_signing_key(params = {}) ⇒ Types::DeleteKeySigningKeyResponse
Deletes a key-signing key (KSK).
-
#delete_query_logging_config(params = {}) ⇒ Struct
Deletes a configuration for DNS query logging.
-
#delete_reusable_delegation_set(params = {}) ⇒ Struct
Deletes a reusable delegation set.
-
#delete_traffic_policy(params = {}) ⇒ Struct
Deletes a traffic policy.
-
#delete_traffic_policy_instance(params = {}) ⇒ Struct
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
-
#delete_vpc_association_authorization(params = {}) ⇒ Struct
Removes authorization to submit an
AssociateVPCWithHostedZone
request to associate a specified VPC with a hosted zone that was created by a different account. -
#disable_hosted_zone_dnssec(params = {}) ⇒ Types::DisableHostedZoneDNSSECResponse
Disables DNSSEC signing in a specific hosted zone.
-
#disassociate_vpc_from_hosted_zone(params = {}) ⇒ Types::DisassociateVPCFromHostedZoneResponse
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone.
-
#enable_hosted_zone_dnssec(params = {}) ⇒ Types::EnableHostedZoneDNSSECResponse
Enables DNSSEC signing in a specific hosted zone.
-
#get_account_limit(params = {}) ⇒ Types::GetAccountLimitResponse
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
-
#get_change(params = {}) ⇒ Types::GetChangeResponse
Returns the current status of a change batch request.
-
#get_checker_ip_ranges(params = {}) ⇒ Types::GetCheckerIpRangesResponse
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
-
#get_dnssec(params = {}) ⇒ Types::GetDNSSECResponse
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
-
#get_geo_location(params = {}) ⇒ Types::GetGeoLocationResponse
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
-
#get_health_check(params = {}) ⇒ Types::GetHealthCheckResponse
Gets information about a specified health check.
-
#get_health_check_count(params = {}) ⇒ Types::GetHealthCheckCountResponse
Retrieves the number of health checks that are associated with the current Amazon Web Services account.
-
#get_health_check_last_failure_reason(params = {}) ⇒ Types::GetHealthCheckLastFailureReasonResponse
Gets the reason that a specified health check failed most recently.
-
#get_health_check_status(params = {}) ⇒ Types::GetHealthCheckStatusResponse
Gets status of a specified health check.
-
#get_hosted_zone(params = {}) ⇒ Types::GetHostedZoneResponse
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
-
#get_hosted_zone_count(params = {}) ⇒ Types::GetHostedZoneCountResponse
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
-
#get_hosted_zone_limit(params = {}) ⇒ Types::GetHostedZoneLimitResponse
Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
-
#get_query_logging_config(params = {}) ⇒ Types::GetQueryLoggingConfigResponse
Gets information about a specified configuration for DNS query logging.
-
#get_reusable_delegation_set(params = {}) ⇒ Types::GetReusableDelegationSetResponse
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
-
#get_reusable_delegation_set_limit(params = {}) ⇒ Types::GetReusableDelegationSetLimitResponse
Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
-
#get_traffic_policy(params = {}) ⇒ Types::GetTrafficPolicyResponse
Gets information about a specific traffic policy version.
-
#get_traffic_policy_instance(params = {}) ⇒ Types::GetTrafficPolicyInstanceResponse
Gets information about a specified traffic policy instance.
-
#get_traffic_policy_instance_count(params = {}) ⇒ Types::GetTrafficPolicyInstanceCountResponse
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
-
#list_cidr_blocks(params = {}) ⇒ Types::ListCidrBlocksResponse
Returns a paginated list of location objects and their CIDR blocks.
-
#list_cidr_collections(params = {}) ⇒ Types::ListCidrCollectionsResponse
Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
-
#list_cidr_locations(params = {}) ⇒ Types::ListCidrLocationsResponse
Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
-
#list_geo_locations(params = {}) ⇒ Types::ListGeoLocationsResponse
Retrieves a list of supported geographic locations.
-
#list_health_checks(params = {}) ⇒ Types::ListHealthChecksResponse
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
-
#list_hosted_zones(params = {}) ⇒ Types::ListHostedZonesResponse
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account.
-
#list_hosted_zones_by_name(params = {}) ⇒ Types::ListHostedZonesByNameResponse
Retrieves a list of your hosted zones in lexicographic order.
-
#list_hosted_zones_by_vpc(params = {}) ⇒ Types::ListHostedZonesByVPCResponse
Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones.
-
#list_query_logging_configs(params = {}) ⇒ Types::ListQueryLoggingConfigsResponse
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
-
#list_resource_record_sets(params = {}) ⇒ Types::ListResourceRecordSetsResponse
Lists the resource record sets in a specified hosted zone.
-
#list_reusable_delegation_sets(params = {}) ⇒ Types::ListReusableDelegationSetsResponse
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for one health check or hosted zone.
-
#list_tags_for_resources(params = {}) ⇒ Types::ListTagsForResourcesResponse
Lists tags for up to 10 health checks or hosted zones.
-
#list_traffic_policies(params = {}) ⇒ Types::ListTrafficPoliciesResponse
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account.
-
#list_traffic_policy_instances(params = {}) ⇒ Types::ListTrafficPolicyInstancesResponse
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
-
#list_traffic_policy_instances_by_hosted_zone(params = {}) ⇒ Types::ListTrafficPolicyInstancesByHostedZoneResponse
Gets information about the traffic policy instances that you created in a specified hosted zone.
-
#list_traffic_policy_instances_by_policy(params = {}) ⇒ Types::ListTrafficPolicyInstancesByPolicyResponse
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
-
#list_traffic_policy_versions(params = {}) ⇒ Types::ListTrafficPolicyVersionsResponse
Gets information about all of the versions for a specified traffic policy.
-
#list_vpc_association_authorizations(params = {}) ⇒ Types::ListVPCAssociationAuthorizationsResponse
Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more
CreateVPCAssociationAuthorization
requests. -
#test_dns_answer(params = {}) ⇒ Types::TestDNSAnswerResponse
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type.
-
#update_health_check(params = {}) ⇒ Types::UpdateHealthCheckResponse
Updates an existing health check.
-
#update_hosted_zone_comment(params = {}) ⇒ Types::UpdateHostedZoneCommentResponse
Updates the comment for a specified hosted zone.
-
#update_traffic_policy_comment(params = {}) ⇒ Types::UpdateTrafficPolicyCommentResponse
Updates the comment for a specified traffic policy version.
-
#update_traffic_policy_instance(params = {}) ⇒ Types::UpdateTrafficPolicyInstanceResponse
After you submit a UpdateTrafficPolicyInstance
request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#activate_key_signing_key(params = {}) ⇒ Types::ActivateKeySigningKeyResponse
Activates a key-signing key (KSK) so that it can be used for signing
by DNSSEC. This operation changes the KSK status to ACTIVE
.
485 486 487 488 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 485 def activate_key_signing_key(params = {}, = {}) req = build_request(:activate_key_signing_key, params) req.send_request() end |
#associate_vpc_with_hosted_zone(params = {}) ⇒ Types::AssociateVPCWithHostedZoneResponse
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
CreateVPCAssociationAuthorization
request. Then the account that
created the VPC must submit an AssociateVPCWithHostedZone
request.
The following are the supported partitions:
aws
- Amazon Web Services Regionsaws-cn
- China Regionsaws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
590 591 592 593 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 590 def associate_vpc_with_hosted_zone(params = {}, = {}) req = build_request(:associate_vpc_with_hosted_zone, params) req.send_request() end |
#change_cidr_collection(params = {}) ⇒ Types::ChangeCidrCollectionResponse
Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.
A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime.
Limits
The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls.
PUT and DELETE_IF_EXISTS
Use ChangeCidrCollection
to perform the following actions:
PUT
: Create a CIDR block within the specified collection.DELETE_IF_EXISTS
: Delete an existing CIDR block from the collection.
666 667 668 669 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 666 def change_cidr_collection(params = {}, = {}) req = build_request(:change_cidr_collection, params) req.send_request() end |
#change_resource_record_sets(params = {}) ⇒ Types::ChangeResourceRecordSetsResponse
Creates, changes, or deletes a resource record set, which contains
authoritative DNS information for a specified domain name or subdomain
name. For example, you can use ChangeResourceRecordSets
to create a
resource record set that routes traffic for test.example.com to a web
server that has an IP address of 192.0.2.44.
Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
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. Route 53 validates the changes in
the request and then either makes all or none of the changes in the
change batch request. This ensures that DNS routing isn't adversely
affected by partial changes to the resource record sets in a hosted
zone.
For example, suppose a change batch request contains two changes: it
deletes the CNAME
resource record set for www.example.com and
creates an alias resource record set for www.example.com. If
validation for both records succeeds, Route 53 deletes the first
resource record set and creates the second resource record set in a
single operation. If validation for either the DELETE
or the
CREATE
action fails, then the request is canceled, and the original
CNAME
record continues to exist.
InvalidChangeBatch
error.
Traffic Flow
To create resource record sets for complex routing configurations, use 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 in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest
to perform the following
actions:
CREATE
: Creates a resource record set that has the specified values.DELETE
: Deletes an existing resource record set that has the specified values.UPSERT
: If a resource set doesn't exist, Route 53 creates it. If a resource set exists 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, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see "Examples."
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 Route 53 DNS Servers
When you submit a ChangeResourceRecordSets
request, Route 53
propagates your changes to all of the Route 53 authoritative DNS
servers managing the hosted zone. 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 Route 53 name servers managing the hosted zone within
60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets
request, see Limits in the Amazon Route 53 Developer Guide.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 1431 def change_resource_record_sets(params = {}, = {}) req = build_request(:change_resource_record_sets, params) req.send_request() end |
#change_tags_for_resource(params = {}) ⇒ Struct
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 1515 def (params = {}, = {}) req = build_request(:change_tags_for_resource, params) req.send_request() end |
#create_cidr_collection(params = {}) ⇒ Types::CreateCidrCollectionResponse
Creates a CIDR collection in the current Amazon Web Services account.
1555 1556 1557 1558 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 1555 def create_cidr_collection(params = {}, = {}) req = build_request(:create_cidr_collection, params) req.send_request() end |
#create_health_check(params = {}) ⇒ Types::CreateHealthCheckResponse
Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2
StatusCheckFailed
metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 1709 def create_health_check(params = {}, = {}) req = build_request(:create_health_check, params) req.send_request() end |
#create_hosted_zone(params = {}) ⇒ Types::CreateHostedZoneResponse
Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
You can't create a hosted zone for a top-level domain (TLD) such as .com.
For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the
DelegationSetId
element.If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone
request, the initial status of
the hosted zone is PENDING
. For public hosted zones, this means that
the NS and SOA records are not yet available on all Route 53 DNS
servers. When the NS and SOA records are available, the status of the
zone changes to INSYNC
.
The CreateHostedZone
request requires the caller to have an
ec2:DescribeVpcs
permission.
The following are the supported partitions:
aws
- Amazon Web Services Regionsaws-cn
- China Regionsaws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
1896 1897 1898 1899 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 1896 def create_hosted_zone(params = {}, = {}) req = build_request(:create_hosted_zone, params) req.send_request() end |
#create_key_signing_key(params = {}) ⇒ Types::CreateKeySigningKeyResponse
Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
2009 2010 2011 2012 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2009 def create_key_signing_key(params = {}, = {}) req = build_request(:create_key_signing_key, params) req.send_request() end |
#create_query_logging_config(params = {}) ⇒ Types::CreateQueryLoggingConfigResponse
Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
Route 53 edge location that responded to the DNS query
Domain or subdomain that was requested
DNS record type, such as A or AAAA
DNS response code, such as
NoError
orServFail
- Log Group and Resource Policy
Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
You must create the log group in the us-east-1 region.
You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.
When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
/aws/route53/hosted zone name
In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of
Resource
, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with*
, for example:arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*
To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:
For
aws:SourceArn
, supply the hosted zone ARN used in creating the query logging configuration. For example,aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID
.For
aws:SourceAccount
, supply the account ID for the account that creates the query logging configuration. For example,aws:SourceAccount:111111111111
. For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide.
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.
- Log Streams and Edge Locations
When Route 53 finishes creating the configuration for DNS query logging, it does the following:
Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
Begins to send query logs to the applicable log stream.
The name of each log stream is in the following format:
hosted zone ID/edge location code
The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page.
- Queries That Are Logged
Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.
- Log File Format
For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.
- Pricing
For information about charges for query logs, see Amazon CloudWatch Pricing.
- How to Stop Logging
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2202 def create_query_logging_config(params = {}, = {}) req = build_request(:create_query_logging_config, params) req.send_request() end |
#create_reusable_delegation_set(params = {}) ⇒ Types::CreateReusableDelegationSetResponse
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.
You can also create a reusable delegation set that uses the four name
servers that are associated with an existing hosted zone. Specify the
hosted zone ID in the CreateReusableDelegationSet
request.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
2300 2301 2302 2303 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2300 def create_reusable_delegation_set(params = {}, = {}) req = build_request(:create_reusable_delegation_set, params) req.send_request() end |
#create_traffic_policy(params = {}) ⇒ Types::CreateTrafficPolicyResponse
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
2351 2352 2353 2354 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2351 def create_traffic_policy(params = {}, = {}) req = build_request(:create_traffic_policy, params) req.send_request() end |
#create_traffic_policy_instance(params = {}) ⇒ Types::CreateTrafficPolicyInstanceResponse
Creates resource record sets in a specified hosted zone based on the
settings in a specified traffic policy version. In addition,
CreateTrafficPolicyInstance
associates the resource record sets with
a specified domain name (such as example.com) or subdomain name (such
as www.example.com). Amazon Route 53 responds to DNS queries for the
domain or subdomain name by using the resource record sets that
CreateTrafficPolicyInstance
created.
CreateTrafficPolicyInstance
request, there's a
brief delay while Amazon Route 53 creates the resource record sets
that are specified in the traffic policy definition. Use
GetTrafficPolicyInstance
with the id
of new traffic policy
instance to confirm that the CreateTrafficPolicyInstance
request
completed successfully. For more information, see the State
response
element.
2429 2430 2431 2432 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2429 def create_traffic_policy_instance(params = {}, = {}) req = build_request(:create_traffic_policy_instance, params) req.send_request() end |
#create_traffic_policy_version(params = {}) ⇒ Types::CreateTrafficPolicyVersionResponse
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.
2488 2489 2490 2491 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2488 def create_traffic_policy_version(params = {}, = {}) req = build_request(:create_traffic_policy_version, params) req.send_request() end |
#create_vpc_association_authorization(params = {}) ⇒ Types::CreateVPCAssociationAuthorizationResponse
Authorizes the Amazon Web Services account that created a specified
VPC to submit an AssociateVPCWithHostedZone
request to associate the
VPC with a specified hosted zone that was created by a different
account. To submit a CreateVPCAssociationAuthorization
request, you
must use the account that created the hosted zone. After you authorize
the association, use the account that created the VPC to submit an
AssociateVPCWithHostedZone
request.
2540 2541 2542 2543 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2540 def (params = {}, = {}) req = build_request(:create_vpc_association_authorization, params) req.send_request() end |
#deactivate_key_signing_key(params = {}) ⇒ Types::DeactivateKeySigningKeyResponse
Deactivates a key-signing key (KSK) so that it will not be used for
signing by DNSSEC. This operation changes the KSK status to
INACTIVE
.
2577 2578 2579 2580 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2577 def deactivate_key_signing_key(params = {}, = {}) req = build_request(:deactivate_key_signing_key, params) req.send_request() end |
#delete_cidr_collection(params = {}) ⇒ Struct
Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.
2600 2601 2602 2603 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2600 def delete_cidr_collection(params = {}, = {}) req = build_request(:delete_cidr_collection, params) req.send_request() end |
#delete_health_check(params = {}) ⇒ Struct
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
If you're using Cloud Map and you configured Cloud Map to create a
Route 53 health check when you register an instance, you can't use
the Route 53 DeleteHealthCheck
command to delete the health check.
The health check is deleted automatically when you deregister the
instance; there can be a delay of several hours before the health
check is deleted from Route 53.
2642 2643 2644 2645 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2642 def delete_health_check(params = {}, = {}) req = build_request(:delete_health_check, params) req.send_request() end |
#delete_hosted_zone(params = {}) ⇒ Types::DeleteHostedZoneResponse
Deletes a hosted zone.
If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.)
If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.
If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.
If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on "free DNS service."
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 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:
Use the
GetHostedZone
action to request information about the hosted zone.Use the
ListHostedZones
action to get a list of the hosted zones associated with the current Amazon Web Services account.
2727 2728 2729 2730 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2727 def delete_hosted_zone(params = {}, = {}) req = build_request(:delete_hosted_zone, params) req.send_request() end |
#delete_key_signing_key(params = {}) ⇒ Types::DeleteKeySigningKeyResponse
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.
You can use DeactivateKeySigningKey to deactivate the key before you delete it.
Use GetDNSSEC to verify that the KSK is in an INACTIVE
status.
2774 2775 2776 2777 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2774 def delete_key_signing_key(params = {}, = {}) req = build_request(:delete_key_signing_key, params) req.send_request() end |
#delete_query_logging_config(params = {}) ⇒ Struct
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.
For more information about DNS query logs, see CreateQueryLoggingConfig.
2806 2807 2808 2809 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2806 def delete_query_logging_config(params = {}, = {}) req = build_request(:delete_query_logging_config, params) req.send_request() end |
#delete_reusable_delegation_set(params = {}) ⇒ Struct
Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
2839 2840 2841 2842 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2839 def delete_reusable_delegation_set(params = {}, = {}) req = build_request(:delete_reusable_delegation_set, params) req.send_request() end |
#delete_traffic_policy(params = {}) ⇒ Struct
Deletes a traffic policy.
When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following:
Deleted traffic policies aren't listed if you run ListTrafficPolicies.
There's no way to get a list of deleted policies.
If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running GetTrafficPolicy.
2883 2884 2885 2886 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2883 def delete_traffic_policy(params = {}, = {}) req = build_request(:delete_traffic_policy, params) req.send_request() end |
#delete_traffic_policy_instance(params = {}) ⇒ Struct
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
2915 2916 2917 2918 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2915 def delete_traffic_policy_instance(params = {}, = {}) req = build_request(:delete_traffic_policy_instance, params) req.send_request() end |
#delete_vpc_association_authorization(params = {}) ⇒ Struct
Removes authorization to submit an AssociateVPCWithHostedZone
request to associate a specified VPC with a hosted zone that was
created by a different account. You must use the account that created
the hosted zone to submit a DeleteVPCAssociationAuthorization
request.
Sending this request only prevents the Amazon Web Services account
that created the VPC from associating the VPC with the Amazon Route 53
hosted zone in the future. If the VPC is already associated with the
hosted zone, DeleteVPCAssociationAuthorization
won't disassociate
the VPC from the hosted zone. If you want to delete an existing
association, use DisassociateVPCFromHostedZone
.
2960 2961 2962 2963 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2960 def (params = {}, = {}) req = build_request(:delete_vpc_association_authorization, params) req.send_request() end |
#disable_hosted_zone_dnssec(params = {}) ⇒ Types::DisableHostedZoneDNSSECResponse
Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 2993 def disable_hosted_zone_dnssec(params = {}, = {}) req = build_request(:disable_hosted_zone_dnssec, params) req.send_request() end |
#disassociate_vpc_from_hosted_zone(params = {}) ⇒ Types::DisassociateVPCFromHostedZoneResponse
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:
You can't disassociate the last Amazon VPC from a private hosted zone.
You 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 Amazon VPC.Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.
When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for
OwningAccount
, you can useDisassociateVPCFromHostedZone
. If the hosted zone has a value forOwningService
, you can't useDisassociateVPCFromHostedZone
.
The following are the supported partitions:
aws
- Amazon Web Services Regionsaws-cn
- China Regionsaws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
3081 3082 3083 3084 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3081 def disassociate_vpc_from_hosted_zone(params = {}, = {}) req = build_request(:disassociate_vpc_from_hosted_zone, params) req.send_request() end |
#enable_hosted_zone_dnssec(params = {}) ⇒ Types::EnableHostedZoneDNSSECResponse
Enables DNSSEC signing in a specific hosted zone.
3112 3113 3114 3115 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3112 def enable_hosted_zone_dnssec(params = {}, = {}) req = build_request(:enable_hosted_zone_dnssec, params) req.send_request() end |
#get_account_limit(params = {}) ⇒ Types::GetAccountLimitResponse
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
3179 3180 3181 3182 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3179 def get_account_limit(params = {}, = {}) req = build_request(:get_account_limit, params) req.send_request() end |
#get_change(params = {}) ⇒ Types::GetChangeResponse
Returns the current status of a change batch request. The status is one of the following values:
PENDING
indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all change batch requests.INSYNC
indicates that the changes have propagated to all Route 53 DNS servers managing the hosted zone.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- resource_record_sets_changed
3225 3226 3227 3228 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3225 def get_change(params = {}, = {}) req = build_request(:get_change, params) req.send_request() end |
#get_checker_ip_ranges(params = {}) ⇒ Types::GetCheckerIpRangesResponse
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRanges
still works, but we recommend that you download
ip-ranges.json, which includes IP address ranges for all Amazon Web
Services services. For more information, see IP Address Ranges of
Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
3255 3256 3257 3258 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3255 def get_checker_ip_ranges(params = {}, = {}) req = build_request(:get_checker_ip_ranges, params) req.send_request() end |
#get_dnssec(params = {}) ⇒ Types::GetDNSSECResponse
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
3303 3304 3305 3306 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3303 def get_dnssec(params = {}, = {}) req = build_request(:get_dnssec, params) req.send_request() end |
#get_geo_location(params = {}) ⇒ Types::GetGeoLocationResponse
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
Use the following syntax to determine whether a continent is supported for geolocation:
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
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
3397 3398 3399 3400 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3397 def get_geo_location(params = {}, = {}) req = build_request(:get_geo_location, params) req.send_request() end |
#get_health_check(params = {}) ⇒ Types::GetHealthCheckResponse
Gets information about a specified health check.
3463 3464 3465 3466 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3463 def get_health_check(params = {}, = {}) req = build_request(:get_health_check, params) req.send_request() end |
#get_health_check_count(params = {}) ⇒ Types::GetHealthCheckCountResponse
Retrieves the number of health checks that are associated with the current Amazon Web Services account.
3483 3484 3485 3486 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3483 def get_health_check_count(params = {}, = {}) req = build_request(:get_health_check_count, params) req.send_request() end |
#get_health_check_last_failure_reason(params = {}) ⇒ Types::GetHealthCheckLastFailureReasonResponse
Gets the reason that a specified health check failed most recently.
3524 3525 3526 3527 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3524 def get_health_check_last_failure_reason(params = {}, = {}) req = build_request(:get_health_check_last_failure_reason, params) req.send_request() end |
#get_health_check_status(params = {}) ⇒ Types::GetHealthCheckStatusResponse
Gets status of a specified health check.
This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.
3569 3570 3571 3572 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3569 def get_health_check_status(params = {}, = {}) req = build_request(:get_health_check_status, params) req.send_request() end |
#get_hosted_zone(params = {}) ⇒ Types::GetHostedZoneResponse
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
`` returns the VPCs associated with the specified hosted zone and does not reflect the VPC associations by Route 53 Profiles. To get the associations to a Profile, call the ListProfileAssociations API.
3652 3653 3654 3655 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3652 def get_hosted_zone(params = {}, = {}) req = build_request(:get_hosted_zone, params) req.send_request() end |
#get_hosted_zone_count(params = {}) ⇒ Types::GetHostedZoneCountResponse
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
3672 3673 3674 3675 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3672 def get_hosted_zone_count(params = {}, = {}) req = build_request(:get_hosted_zone_count, params) req.send_request() end |
#get_hosted_zone_limit(params = {}) ⇒ Types::GetHostedZoneLimitResponse
Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
3722 3723 3724 3725 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3722 def get_hosted_zone_limit(params = {}, = {}) req = build_request(:get_hosted_zone_limit, params) req.send_request() end |
#get_query_logging_config(params = {}) ⇒ Types::GetQueryLoggingConfigResponse
Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
3762 3763 3764 3765 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3762 def get_query_logging_config(params = {}, = {}) req = build_request(:get_query_logging_config, params) req.send_request() end |
#get_reusable_delegation_set(params = {}) ⇒ Types::GetReusableDelegationSetResponse
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
3796 3797 3798 3799 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3796 def get_reusable_delegation_set(params = {}, = {}) req = build_request(:get_reusable_delegation_set, params) req.send_request() end |
#get_reusable_delegation_set_limit(params = {}) ⇒ Types::GetReusableDelegationSetLimitResponse
Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
3842 3843 3844 3845 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3842 def get_reusable_delegation_set_limit(params = {}, = {}) req = build_request(:get_reusable_delegation_set_limit, params) req.send_request() end |
#get_traffic_policy(params = {}) ⇒ Types::GetTrafficPolicyResponse
Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the
response from GetTrafficPolicy
, see DeleteTrafficPolicy.
3887 3888 3889 3890 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3887 def get_traffic_policy(params = {}, = {}) req = build_request(:get_traffic_policy, params) req.send_request() end |
#get_traffic_policy_instance(params = {}) ⇒ Types::GetTrafficPolicyInstanceResponse
Gets information about a specified traffic policy instance.
GetTrafficPolicyInstance
with the id
of new traffic policy
instance to confirm that the CreateTrafficPolicyInstance
or an
UpdateTrafficPolicyInstance
request completed successfully. For more
information, see the State
response element.
3936 3937 3938 3939 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3936 def get_traffic_policy_instance(params = {}, = {}) req = build_request(:get_traffic_policy_instance, params) req.send_request() end |
#get_traffic_policy_instance_count(params = {}) ⇒ Types::GetTrafficPolicyInstanceCountResponse
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
3956 3957 3958 3959 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 3956 def get_traffic_policy_instance_count(params = {}, = {}) req = build_request(:get_traffic_policy_instance_count, params) req.send_request() end |
#list_cidr_blocks(params = {}) ⇒ Types::ListCidrBlocksResponse
Returns a paginated list of location objects and their CIDR blocks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4003 def list_cidr_blocks(params = {}, = {}) req = build_request(:list_cidr_blocks, params) req.send_request() end |
#list_cidr_collections(params = {}) ⇒ Types::ListCidrCollectionsResponse
Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4048 4049 4050 4051 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4048 def list_cidr_collections(params = {}, = {}) req = build_request(:list_cidr_collections, params) req.send_request() end |
#list_cidr_locations(params = {}) ⇒ Types::ListCidrLocationsResponse
Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4095 4096 4097 4098 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4095 def list_cidr_locations(params = {}, = {}) req = build_request(:list_cidr_locations, params) req.send_request() end |
#list_geo_locations(params = {}) ⇒ Types::ListGeoLocationsResponse
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.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
For a list of supported geolocation codes, see the GeoLocation data type.
4191 4192 4193 4194 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4191 def list_geo_locations(params = {}, = {}) req = build_request(:list_geo_locations, params) req.send_request() end |
#list_health_checks(params = {}) ⇒ Types::ListHealthChecksResponse
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4282 4283 4284 4285 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4282 def list_health_checks(params = {}, = {}) req = build_request(:list_health_checks, params) req.send_request() end |
#list_hosted_zones(params = {}) ⇒ Types::ListHostedZonesResponse
Retrieves a list of the public and private hosted zones that are
associated with the current Amazon Web Services account. The response
includes a HostedZones
child element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If
you have a lot of hosted zones, you can use the maxitems
parameter
to list them in groups of up to 100.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4361 4362 4363 4364 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4361 def list_hosted_zones(params = {}, = {}) req = build_request(:list_hosted_zones, params) req.send_request() end |
#list_hosted_zones_by_name(params = {}) ⇒ Types::ListHostedZonesByNameResponse
Retrieves a list of your hosted zones in lexicographic order. The
response includes a HostedZones
child element for each hosted zone
created by the current Amazon Web Services account.
ListHostedZonesByName
sorts hosted zones by name with the labels
reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode,
ListHostedZonesByName
alphabetizes the domain name using the escaped
or Punycoded value, which is the format that Amazon Route 53 saves in
its database. For example, to create a hosted zone for exämple.com,
you specify ex\344mple.com for the domain name.
ListHostedZonesByName
alphabetizes it as:
com.ex\344mple.
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 in the Amazon Route 53 Developer Guide.
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
andHostedZoneId
elements in the response contain the values, if any, specified for thednsname
andhostedzoneid
parameters in the request that produced the current response.The
MaxItems
element in the response contains the value, if any, that you specified for themaxitems
parameter in the request that produced the current response.If the value of
IsTruncated
in the response is true, there are more hosted zones associated with the current Amazon Web Services account.If
IsTruncated
is false, this response includes the last hosted zone that is associated with the current account. TheNextDNSName
element andNextHostedZoneId
elements are omitted from the response.The
NextDNSName
andNextHostedZoneId
elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call toListHostedZonesByName
, and specify the value ofNextDNSName
andNextHostedZoneId
in thednsname
andhostedzoneid
parameters, respectively.
4495 4496 4497 4498 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4495 def list_hosted_zones_by_name(params = {}, = {}) req = build_request(:list_hosted_zones_by_name, params) req.send_request() end |
#list_hosted_zones_by_vpc(params = {}) ⇒ Types::ListHostedZonesByVPCResponse
Lists all the private hosted zones that a specified VPC is associated
with, regardless of which Amazon Web Services account or Amazon Web
Services service owns the hosted zones. The HostedZoneOwner
structure in the response contains one of the following values:
An
OwningAccount
element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account.An
OwningService
element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value ofOwner
isefs.amazonaws.com
.
ListHostedZonesByVPC
returns the hosted zones associated with the
specified VPC and does not reflect the hosted zone associations to
VPCs via Route 53 Profiles. To get the associations to a Profile, call
the ListProfileResourceAssociations API.
The following are the supported partitions:
aws
- Amazon Web Services Regionsaws-cn
- China Regionsaws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
4597 4598 4599 4600 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4597 def list_hosted_zones_by_vpc(params = {}, = {}) req = build_request(:list_hosted_zones_by_vpc, params) req.send_request() end |
#list_query_logging_configs(params = {}) ⇒ Types::ListQueryLoggingConfigsResponse
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4676 4677 4678 4679 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4676 def list_query_logging_configs(params = {}, = {}) req = build_request(:list_query_logging_configs, params) req.send_request() end |
#list_resource_record_sets(params = {}) ⇒ Types::ListResourceRecordSetsResponse
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets
returns up to 300 resource record sets at a
time in ASCII order, beginning at a position specified by the name
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 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, ListResourceRecordSets
sorts results by the record type.
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.
- If you specify Name but not Type
The results begin with the first resource record set in the list whose name is greater than or equal to
Name
.- If you specify Type but not Name
Amazon Route 53 returns the
InvalidInput
error.- If you specify both Name and Type
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 toType
.
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 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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4867 4868 4869 4870 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4867 def list_resource_record_sets(params = {}, = {}) req = build_request(:list_resource_record_sets, params) req.send_request() end |
#list_reusable_delegation_sets(params = {}) ⇒ Types::ListReusableDelegationSetsResponse
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
4924 4925 4926 4927 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4924 def list_reusable_delegation_sets(params = {}, = {}) req = build_request(:list_reusable_delegation_sets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
4971 4972 4973 4974 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 4971 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tags_for_resources(params = {}) ⇒ Types::ListTagsForResourcesResponse
Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
5020 5021 5022 5023 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5020 def (params = {}, = {}) req = build_request(:list_tags_for_resources, params) req.send_request() end |
#list_traffic_policies(params = {}) ⇒ Types::ListTrafficPoliciesResponse
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the
response from ListTrafficPolicies
, see DeleteTrafficPolicy.
5085 5086 5087 5088 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5085 def list_traffic_policies(params = {}, = {}) req = build_request(:list_traffic_policies, params) req.send_request() end |
#list_traffic_policy_instances(params = {}) ⇒ Types::ListTrafficPolicyInstancesResponse
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
UpdateTrafficPolicyInstance
request, there's a
brief delay while Amazon Route 53 creates the resource record sets
that are specified in the traffic policy definition. For more
information, see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have
a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
5189 5190 5191 5192 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5189 def list_traffic_policy_instances(params = {}, = {}) req = build_request(:list_traffic_policy_instances, params) req.send_request() end |
#list_traffic_policy_instances_by_hosted_zone(params = {}) ⇒ Types::ListTrafficPolicyInstancesByHostedZoneResponse
Gets information about the traffic policy instances that you created in a specified hosted zone.
CreateTrafficPolicyInstance
or an
UpdateTrafficPolicyInstance
request, there's a brief delay while
Amazon Route 53 creates the resource record sets that are specified in
the traffic policy definition. For more information, see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have
a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
5285 5286 5287 5288 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5285 def list_traffic_policy_instances_by_hosted_zone(params = {}, = {}) req = build_request(:list_traffic_policy_instances_by_hosted_zone, params) req.send_request() end |
#list_traffic_policy_instances_by_policy(params = {}) ⇒ Types::ListTrafficPolicyInstancesByPolicyResponse
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
CreateTrafficPolicyInstance
or an
UpdateTrafficPolicyInstance
request, there's a brief delay while
Amazon Route 53 creates the resource record sets that are specified in
the traffic policy definition. For more information, see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have
a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
5408 5409 5410 5411 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5408 def list_traffic_policy_instances_by_policy(params = {}, = {}) req = build_request(:list_traffic_policy_instances_by_policy, params) req.send_request() end |
#list_traffic_policy_versions(params = {}) ⇒ Types::ListTrafficPolicyVersionsResponse
Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by
VersionNumber
.
5474 5475 5476 5477 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5474 def list_traffic_policy_versions(params = {}, = {}) req = build_request(:list_traffic_policy_versions, params) req.send_request() end |
#list_vpc_association_authorizations(params = {}) ⇒ Types::ListVPCAssociationAuthorizationsResponse
Gets a list of the VPCs that were created by other accounts and that
can be associated with a specified hosted zone because you've
submitted one or more CreateVPCAssociationAuthorization
requests.
The response includes a VPCs
element with a VPC
child element for
each VPC that can be associated with the hosted zone.
5528 5529 5530 5531 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5528 def (params = {}, = {}) req = build_request(:list_vpc_association_authorizations, params) req.send_request() end |
#test_dns_answer(params = {}) ⇒ Types::TestDNSAnswerResponse
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
This call only supports querying public hosted zones.
TestDnsAnswer
returns information similar to what you would
expect from the answer section of the dig
command. Therefore, if you
query for the name servers of a subdomain that point to the parent
name servers, those will not be returned.
5619 5620 5621 5622 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 5619 def test_dns_answer(params = {}, = {}) req = build_request(:test_dns_answer, params) req.send_request() end |
#update_health_check(params = {}) ⇒ Types::UpdateHealthCheckResponse
Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
6035 6036 6037 6038 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 6035 def update_health_check(params = {}, = {}) req = build_request(:update_health_check, params) req.send_request() end |
#update_hosted_zone_comment(params = {}) ⇒ Types::UpdateHostedZoneCommentResponse
Updates the comment for a specified hosted zone.
6076 6077 6078 6079 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 6076 def update_hosted_zone_comment(params = {}, = {}) req = build_request(:update_hosted_zone_comment, params) req.send_request() end |
#update_traffic_policy_comment(params = {}) ⇒ Types::UpdateTrafficPolicyCommentResponse
Updates the comment for a specified traffic policy version.
6119 6120 6121 6122 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 6119 def update_traffic_policy_comment(params = {}, = {}) req = build_request(:update_traffic_policy_comment, params) req.send_request() end |
#update_traffic_policy_instance(params = {}) ⇒ Types::UpdateTrafficPolicyInstanceResponse
UpdateTrafficPolicyInstance
request, there's a
brief delay while Route 53 creates the resource record sets that are
specified in the traffic policy definition. Use
GetTrafficPolicyInstance
with the id
of updated traffic policy
instance confirm that the UpdateTrafficPolicyInstance
request
completed successfully. For more information, see the State
response
element.
Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
6200 6201 6202 6203 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 6200 def update_traffic_policy_instance(params = {}, = {}) req = build_request(:update_traffic_policy_instance, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
resource_record_sets_changed | #get_change | 30 | 60 |
6315 6316 6317 6318 6319 |
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/client.rb', line 6315 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |