AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Route53

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Route53.AmazonRoute53Client

Namespace: Amazon.Route53
Assembly: AWSSDK.Route53.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonRoute53Client : AmazonServiceClient
         IAmazonRoute53, IAmazonService, IDisposable

The AmazonRoute53Client type exposes the following members

Constructors

NameDescription
Public Method AmazonRoute53Client()

Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonRoute53Client(RegionEndpoint)

Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonRoute53Client(AmazonRoute53Config)

Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonRoute53Client(AWSCredentials)

Constructs AmazonRoute53Client with AWS Credentials

Public Method AmazonRoute53Client(AWSCredentials, RegionEndpoint)

Constructs AmazonRoute53Client with AWS Credentials

Public Method AmazonRoute53Client(AWSCredentials, AmazonRoute53Config)

Constructs AmazonRoute53Client with AWS Credentials and an AmazonRoute53Client Configuration object.

Public Method AmazonRoute53Client(string, string)

Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53Client(string, string, RegionEndpoint)

Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53Client(string, string, AmazonRoute53Config)

Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object.

Public Method AmazonRoute53Client(string, string, string)

Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53Client(string, string, string, RegionEndpoint)

Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53Client(string, string, string, AmazonRoute53Config)

Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateVPCWithHostedZone(AssociateVPCWithHostedZoneRequest)

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.

If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.

Public Method AssociateVPCWithHostedZoneAsync(AssociateVPCWithHostedZoneRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateVPCWithHostedZone operation.

Public Method ChangeResourceRecordSets(ChangeResourceRecordSetsRequest)

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.

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. When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of the changes in a change batch request. This ensures that Amazon Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.

For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.

Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Amazon Route 53 returns an InvalidChangeBatch error.

Traffic Flow

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic 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 record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request.

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 Amazon Route 53 DNS Servers

When you submit a ChangeResourceRecordSets request, Amazon Route 53 propagates your changes to all of the Amazon Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Amazon Route 53 name servers within 60 seconds. For more information, see GetChange.

Limits on ChangeResourceRecordSets Requests

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

Public Method ChangeResourceRecordSetsAsync(ChangeResourceRecordSetsRequest, CancellationToken)

Initiates the asynchronous execution of the ChangeResourceRecordSets operation.

Public Method ChangeTagsForResource(ChangeTagsForResourceRequest)

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 AWS Billing and Cost Management User Guide.

Public Method ChangeTagsForResourceAsync(ChangeTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ChangeTagsForResource operation.

Public Method CreateHealthCheck(CreateHealthCheckRequest)

Creates a new health check.

For information about adding health checks to resource record sets, see ResourceRecordSet$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 an Amazon Route 53 health check.

Private Hosted Zones

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

  • Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.

  • 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.

Public Method CreateHealthCheckAsync(CreateHealthCheckRequest, CancellationToken)

Initiates the asynchronous execution of the CreateHealthCheck operation.

Public Method CreateHostedZone(CreateHostedZoneRequest)

Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.

You can't convert a public hosted zones 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).

  • Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

    If you want to use the same name servers for multiple hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.

  • If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see Configuring Amazon Route 53 as your DNS Service in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. This means that the NS and SOA records are not yet available on all Amazon Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

Public Method CreateHostedZoneAsync(CreateHostedZoneRequest, CancellationToken)

Initiates the asynchronous execution of the CreateHostedZone operation.

Public Method CreateQueryLoggingConfig(CreateQueryLoggingConfigRequest)

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

DNS query logs contain information about the queries that Amazon Route 53 receives for a specified public hosted zone, such as the following:

  • Amazon Route 53 edge location that responded to the DNS query

  • Domain or subdomain that was requested

  • DNS record type, such as A or AAAA

  • DNS response code, such as NoError or ServFail

Log Group and Resource Policy

Before you create a query logging configuration, perform the following operations.

If you create a query logging configuration using the Amazon Route 53 console, Amazon Route 53 performs these operations automatically.

  1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

    • You must create the log group in the us-east-1 region.

    • You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.

    • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      /aws/route53/hosted zone name

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Amazon Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

  2. Create a CloudWatch Logs resource policy, and give it the permissions that Amazon Route 53 needs to create log streams and to to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

    arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI.

Log Streams and Edge Locations

When Amazon Route 53 finishes creating the configuration for DNS query logging, it does the following:

  • Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Amazon Route 53 responds to for that edge location.

  • 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 Amazon Route 53 Global Network" on the Amazon Route 53 Product Details page.

Queries That Are Logged

Query logs contain only the queries that DNS resolvers forward to Amazon Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Amazon Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application 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 Amazon Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

Public Method CreateQueryLoggingConfigAsync(CreateQueryLoggingConfigRequest, CancellationToken)

Initiates the asynchronous execution of the CreateQueryLoggingConfig operation.

Public Method CreateReusableDelegationSet(CreateReusableDelegationSetRequest)

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable

A reusable delegation set can't be associated with a private hosted zone.

For information on how to use a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.

Public Method CreateReusableDelegationSetAsync(CreateReusableDelegationSetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateReusableDelegationSet operation.

Public Method CreateTrafficPolicy(CreateTrafficPolicyRequest)

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).

Public Method CreateTrafficPolicyAsync(CreateTrafficPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTrafficPolicy operation.

Public Method CreateTrafficPolicyInstance(CreateTrafficPolicyInstanceRequest)

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.

Public Method CreateTrafficPolicyInstanceAsync(CreateTrafficPolicyInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTrafficPolicyInstance operation.

Public Method CreateTrafficPolicyVersion(CreateTrafficPolicyVersionRequest)

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.

Public Method CreateTrafficPolicyVersionAsync(CreateTrafficPolicyVersionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTrafficPolicyVersion operation.

Public Method CreateVPCAssociationAuthorization(CreateVPCAssociationAuthorizationRequest)

Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.

Public Method CreateVPCAssociationAuthorizationAsync(CreateVPCAssociationAuthorizationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateVPCAssociationAuthorization operation.

Public Method DeleteHealthCheck(DeleteHealthCheckRequest)

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.

Public Method DeleteHealthCheckAsync(DeleteHealthCheckRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteHealthCheck operation.

Public Method DeleteHostedZone(DeleteHostedZoneRequest)

Deletes a hosted zone.

If the name servers for the hosted zone are associated with a domain and if you want to make the domain unavailable on the Internet, we recommend that you delete the name servers from the domain to prevent future DNS queries from possibly being misrouted. If the domain is registered with Amazon Route 53, see UpdateDomainNameservers. If the domain is registered with another registrar, use the method provided by the registrar to delete name servers for the domain.

Some domain registries don't allow you to remove all of the name servers for a domain. If the registry for your domain requires one or more name servers, we recommend that you delete the hosted zone only if you transfer DNS service to another service provider, and you replace the name servers for the domain with name servers from the new provider.

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Amazon Route 53 returns a 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 AWS account.

Public Method DeleteHostedZoneAsync(DeleteHostedZoneRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteHostedZone operation.

Public Method DeleteQueryLoggingConfig(DeleteQueryLoggingConfigRequest)

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Amazon Route 53 doesn't delete any logs that are already in CloudWatch Logs.

For more information about DNS query logs, see CreateQueryLoggingConfig.

Public Method DeleteQueryLoggingConfigAsync(DeleteQueryLoggingConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteQueryLoggingConfig operation.

Public Method DeleteReusableDelegationSet(DeleteReusableDelegationSetRequest)

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.

Public Method DeleteReusableDelegationSetAsync(DeleteReusableDelegationSetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteReusableDelegationSet operation.

Public Method DeleteTrafficPolicy(DeleteTrafficPolicyRequest)

Deletes a traffic policy.

Public Method DeleteTrafficPolicyAsync(DeleteTrafficPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTrafficPolicy operation.

Public Method DeleteTrafficPolicyInstance(DeleteTrafficPolicyInstanceRequest)

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

In the Amazon Route 53 console, traffic policy instances are known as policy records.

Public Method DeleteTrafficPolicyInstanceAsync(DeleteTrafficPolicyInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTrafficPolicyInstance operation.

Public Method DeleteVPCAssociationAuthorization(DeleteVPCAssociationAuthorizationRequest)

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 AWS 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.

Public Method DeleteVPCAssociationAuthorizationAsync(DeleteVPCAssociationAuthorizationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteVPCAssociationAuthorization operation.

Public Method DisassociateVPCFromHostedZone(DisassociateVPCFromHostedZoneRequest)

Disassociates a VPC from a Amazon Route 53 private hosted zone.

You can't disassociate the last VPC from a private hosted zone.

You can't disassociate a VPC from a private hosted zone when only one VPC is associated with the hosted zone. You also can't convert a private hosted zone into a public hosted zone.

Public Method DisassociateVPCFromHostedZoneAsync(DisassociateVPCFromHostedZoneRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateVPCFromHostedZone operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetChange(GetChangeRequest)

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. This is the initial status of all change batch requests.

  • INSYNC indicates that the changes have propagated to all Amazon Route 53 DNS servers.

Public Method GetChangeAsync(GetChangeRequest, CancellationToken)

Initiates the asynchronous execution of the GetChange operation.

Public Method GetCheckerIpRanges(GetCheckerIpRangesRequest)

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

Public Method GetCheckerIpRangesAsync(GetCheckerIpRangesRequest, CancellationToken)

Initiates the asynchronous execution of the GetCheckerIpRanges operation.

Public Method GetGeoLocation(GetGeoLocationRequest)

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

Use the following syntax to determine whether a continent is supported for geolocation:

GET /2013-04-01/geolocation?ContinentCode=two-letter abbreviation for 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

Public Method GetGeoLocationAsync(GetGeoLocationRequest, CancellationToken)

Initiates the asynchronous execution of the GetGeoLocation operation.

Public Method GetHealthCheck(GetHealthCheckRequest)

Gets information about a specified health check.

Public Method GetHealthCheckAsync(GetHealthCheckRequest, CancellationToken)

Initiates the asynchronous execution of the GetHealthCheck operation.

Public Method GetHealthCheckCount(GetHealthCheckCountRequest)

Retrieves the number of health checks that are associated with the current AWS account.

Public Method GetHealthCheckCountAsync(GetHealthCheckCountRequest, CancellationToken)

Initiates the asynchronous execution of the GetHealthCheckCount operation.

Public Method GetHealthCheckLastFailureReason(GetHealthCheckLastFailureReasonRequest)

Gets the reason that a specified health check failed most recently.

Public Method GetHealthCheckLastFailureReasonAsync(GetHealthCheckLastFailureReasonRequest, CancellationToken)

Initiates the asynchronous execution of the GetHealthCheckLastFailureReason operation.

Public Method GetHealthCheckStatus(GetHealthCheckStatusRequest)

Gets status of a specified health check.

Public Method GetHealthCheckStatusAsync(GetHealthCheckStatusRequest, CancellationToken)

Initiates the asynchronous execution of the GetHealthCheckStatus operation.

Public Method GetHostedZone(GetHostedZoneRequest)

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

Public Method GetHostedZoneAsync(GetHostedZoneRequest, CancellationToken)

Initiates the asynchronous execution of the GetHostedZone operation.

Public Method GetHostedZoneCount()

Retrieves the number of hosted zones that are associated with the current AWS account.

Public Method GetHostedZoneCount(GetHostedZoneCountRequest)

Retrieves the number of hosted zones that are associated with the current AWS account.

Public Method GetHostedZoneCountAsync(CancellationToken)

Retrieves the number of hosted zones that are associated with the current AWS account.

Public Method GetHostedZoneCountAsync(GetHostedZoneCountRequest, CancellationToken)

Initiates the asynchronous execution of the GetHostedZoneCount operation.

Public Method GetQueryLoggingConfig(GetQueryLoggingConfigRequest)

Gets information about a specified configuration for DNS query logging.

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.

Public Method GetQueryLoggingConfigAsync(GetQueryLoggingConfigRequest, CancellationToken)

Initiates the asynchronous execution of the GetQueryLoggingConfig operation.

Public Method GetReusableDelegationSet(GetReusableDelegationSetRequest)

Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.

Public Method GetReusableDelegationSetAsync(GetReusableDelegationSetRequest, CancellationToken)

Initiates the asynchronous execution of the GetReusableDelegationSet operation.

Public Method GetTrafficPolicy(GetTrafficPolicyRequest)

Gets information about a specific traffic policy version.

Public Method GetTrafficPolicyAsync(GetTrafficPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetTrafficPolicy operation.

Public Method GetTrafficPolicyInstance(GetTrafficPolicyInstanceRequest)

Gets information about a specified traffic policy instance.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

In the Amazon Route 53 console, traffic policy instances are known as policy records.

Public Method GetTrafficPolicyInstanceAsync(GetTrafficPolicyInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the GetTrafficPolicyInstance operation.

Public Method GetTrafficPolicyInstanceCount(GetTrafficPolicyInstanceCountRequest)

Gets the number of traffic policy instances that are associated with the current AWS account.

Public Method GetTrafficPolicyInstanceCountAsync(GetTrafficPolicyInstanceCountRequest, CancellationToken)

Initiates the asynchronous execution of the GetTrafficPolicyInstanceCount operation.

Public Method ListGeoLocations()

Retrieves a list of supported geo 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.

Public Method ListGeoLocations(ListGeoLocationsRequest)

Retrieves a list of supported geo 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.

Public Method ListGeoLocationsAsync(CancellationToken)

Retrieves a list of supported geo 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.

Public Method ListGeoLocationsAsync(ListGeoLocationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListGeoLocations operation.

Public Method ListHealthChecks()

Retrieve a list of the health checks that are associated with the current AWS account.

Public Method ListHealthChecks(ListHealthChecksRequest)

Retrieve a list of the health checks that are associated with the current AWS account.

Public Method ListHealthChecksAsync(CancellationToken)

Retrieve a list of the health checks that are associated with the current AWS account.

Public Method ListHealthChecksAsync(ListHealthChecksRequest, CancellationToken)

Initiates the asynchronous execution of the ListHealthChecks operation.

Public Method ListHostedZones()

Retrieves a list of the public and private hosted zones that are associated with the current AWS 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.

Public Method ListHostedZones(ListHostedZonesRequest)

Retrieves a list of the public and private hosted zones that are associated with the current AWS 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.

Public Method ListHostedZonesAsync(CancellationToken)

Retrieves a list of the public and private hosted zones that are associated with the current AWS 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.

Public Method ListHostedZonesAsync(ListHostedZonesRequest, CancellationToken)

Initiates the asynchronous execution of the ListHostedZones operation.

Public Method ListHostedZonesByName(ListHostedZonesByNameRequest)

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 AWS 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.

Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

  • The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.

  • The MaxItems element in the response contains the value, if any, that you specified for the maxitems 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 AWS account.

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

  • The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

Public Method ListHostedZonesByNameAsync(ListHostedZonesByNameRequest, CancellationToken)

Initiates the asynchronous execution of the ListHostedZonesByName operation.

Public Method ListQueryLoggingConfigs(ListQueryLoggingConfigsRequest)

Lists the configurations for DNS query logging that are associated with the current AWS 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.

Public Method ListQueryLoggingConfigsAsync(ListQueryLoggingConfigsRequest, CancellationToken)

Initiates the asynchronous execution of the ListQueryLoggingConfigs operation.

Public Method ListResourceRecordSets(ListResourceRecordSetsRequest)

Lists the resource record sets in a specified hosted zone.

ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. The action sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

When multiple records have the same DNS name, the action sorts results by the record type.

You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:

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 to Type.

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Amazon Route 53 DNS servers.

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.

Public Method ListResourceRecordSetsAsync(ListResourceRecordSetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourceRecordSets operation.

Public Method ListReusableDelegationSets()

Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

Public Method ListReusableDelegationSets(ListReusableDelegationSetsRequest)

Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

Public Method ListReusableDelegationSetsAsync(CancellationToken)

Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

Public Method ListReusableDelegationSetsAsync(ListReusableDelegationSetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListReusableDelegationSets operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists tags for one health check or hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method ListTagsForResources(ListTagsForResourcesRequest)

Lists tags for up to 10 health checks or hosted zones.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Public Method ListTagsForResourcesAsync(ListTagsForResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResources operation.

Public Method ListTrafficPolicies(ListTrafficPoliciesRequest)

Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order in which they were created.

Public Method ListTrafficPoliciesAsync(ListTrafficPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrafficPolicies operation.

Public Method ListTrafficPolicyInstances(ListTrafficPolicyInstancesRequest)

Gets information about the traffic policy instances that you created by using the current AWS account.

After you submit 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.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Public Method ListTrafficPolicyInstancesAsync(ListTrafficPolicyInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrafficPolicyInstances operation.

Public Method ListTrafficPolicyInstancesByHostedZone(ListTrafficPolicyInstancesByHostedZoneRequest)

Gets information about the traffic policy instances that you created in a specified hosted zone.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Public Method ListTrafficPolicyInstancesByHostedZoneAsync(ListTrafficPolicyInstancesByHostedZoneRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrafficPolicyInstancesByHostedZone operation.

Public Method ListTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest)

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Public Method ListTrafficPolicyInstancesByPolicyAsync(ListTrafficPolicyInstancesByPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrafficPolicyInstancesByPolicy operation.

Public Method ListTrafficPolicyVersions(ListTrafficPolicyVersionsRequest)

Gets information about all of the versions for a specified traffic policy.

Traffic policy versions are listed in numerical order by VersionNumber.

Public Method ListTrafficPolicyVersionsAsync(ListTrafficPolicyVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrafficPolicyVersions operation.

Public Method ListVPCAssociationAuthorizations(ListVPCAssociationAuthorizationsRequest)

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.

Public Method ListVPCAssociationAuthorizationsAsync(ListVPCAssociationAuthorizationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListVPCAssociationAuthorizations operation.

Public Method TestDNSAnswer(TestDNSAnswerRequest)

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.

Public Method TestDNSAnswerAsync(TestDNSAnswerRequest, CancellationToken)

Initiates the asynchronous execution of the TestDNSAnswer operation.

Public Method UpdateHealthCheck(UpdateHealthCheckRequest)

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.

Public Method UpdateHealthCheckAsync(UpdateHealthCheckRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateHealthCheck operation.

Public Method UpdateHostedZoneComment(UpdateHostedZoneCommentRequest)

Updates the comment for a specified hosted zone.

Public Method UpdateHostedZoneCommentAsync(UpdateHostedZoneCommentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateHostedZoneComment operation.

Public Method UpdateTrafficPolicyComment(UpdateTrafficPolicyCommentRequest)

Updates the comment for a specified traffic policy version.

Public Method UpdateTrafficPolicyCommentAsync(UpdateTrafficPolicyCommentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTrafficPolicyComment operation.

Public Method UpdateTrafficPolicyInstance(UpdateTrafficPolicyInstanceRequest)

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. Amazon Route 53 performs the following operations:

  1. Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.

  2. When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.

  3. Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

Public Method UpdateTrafficPolicyInstanceAsync(UpdateTrafficPolicyInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTrafficPolicyInstance operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Examples

This example shows how to create an Amazon Route 53 hosted zone and add a resource record set to the zone.

Create a hosted zone and add a resource record set

string domainName = "www.example.org";

IAmazonRoute53 route53Client = new AmazonRoute53Client();

CreateHostedZoneRequest zoneRequest = new CreateHostedZoneRequest
{
  Name = domainName,
  CallerReference = "my_change_request"
};

CreateHostedZoneResponse zoneResponse = route53Client.CreateHostedZone(zoneRequest);

ResourceRecordSet recordSet = new ResourceRecordSet
{
  Name = domainName,
  TTL = 60,
  Type = RRType.A,
  ResourceRecords = new List { new ResourceRecord { Value = "192.0.2.235" } }
};

Change change1 = new Change
{
  ResourceRecordSet = recordSet,
  Action = ChangeAction.CREATE
};

ChangeBatch changeBatch = new ChangeBatch
{
  Changes = new List { change1 }
};

ChangeResourceRecordSetsRequest recordsetRequest = new ChangeResourceRecordSetsRequest
{
  HostedZoneId = zoneResponse.HostedZone.Id,
  ChangeBatch = changeBatch
};

ChangeResourceRecordSetsResponse recordsetResponse = route53Client.ChangeResourceRecordSets(recordsetRequest);

GetChangeRequest changeRequest = new GetChangeRequest
{
  Id = recordsetResponse.ChangeInfo.Id
};

while (route53Client.GetChange(changeRequest).ChangeInfo.Status == ChangeStatus.PENDING)
{
  Console.WriteLine("Change is pending.");
  Thread.Sleep(TimeSpan.FromSeconds(15));
}
      

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms