AWS SDK for .NET Documentation
AmazonRoute53Client Class
AmazonAmazon.Route53AmazonRoute53Client Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing AmazonRoute53.
Implementation for accessing AmazonRoute53.
Declaration Syntax
C#
public class AmazonRoute53Client : AmazonWebServiceClient, 
	AmazonRoute53, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
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.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

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.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

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.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonRoute53Client(AWSCredentials)
Constructs AmazonRoute53Client with AWS Credentials

AmazonRoute53Client(AWSCredentials, RegionEndpoint)
Constructs AmazonRoute53Client with AWS Credentials

AmazonRoute53Client(AWSCredentials, AmazonRoute53Config)
Constructs AmazonRoute53Client with AWS Credentials and an AmazonRoute53Client Configuration object.

AmazonRoute53Client(String, String)
Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

AmazonRoute53Client(String, String, RegionEndpoint)
Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

AmazonRoute53Client(String, String, AmazonRoute53Config)
Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AmazonRoute53Client(String, String, String)
Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

AmazonRoute53Client(String, String, String, RegionEndpoint)
Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key

AmazonRoute53Client(String, String, String, AmazonRoute53Config)
Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginChangeResourceRecordSets(ChangeResourceRecordSetsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ChangeResourceRecordSets operation.

BeginCreateHealthCheck(CreateHealthCheckRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateHealthCheck operation.

BeginCreateHostedZone(CreateHostedZoneRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateHostedZone operation.

BeginDeleteHealthCheck(DeleteHealthCheckRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteHealthCheck operation.

BeginDeleteHostedZone(DeleteHostedZoneRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteHostedZone operation.

BeginGetChange(GetChangeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetChange operation.

BeginGetHealthCheck(GetHealthCheckRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetHealthCheck operation.

BeginGetHostedZone(GetHostedZoneRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetHostedZone operation.

BeginListHealthChecks(ListHealthChecksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListHealthChecks operation.

BeginListHostedZones(ListHostedZonesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListHostedZones operation.

BeginListResourceRecordSets(ListResourceRecordSetsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListResourceRecordSets operation.

ChangeResourceRecordSets(ChangeResourceRecordSetsRequest)

Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the 2013-04-01/hostedzone/hosted Zone ID/rrset resource. The request body must include an XML document with a ChangeResourceRecordSetsRequest element.

Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide .

IMPORTANT:Due to the nature of transactional changes, you cannot 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, Route 53 returns an InvalidChangeBatch error.

In response to a ChangeResourceRecordSets request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is PENDING . This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC .

Note the following limitations on a ChangeResourceRecordSets request:

- A request cannot contain more than 100 Change elements.

- A request cannot contain more than 1000 ResourceRecord elements.

The sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.


CreateHealthCheck(CreateHealthCheckRequest)

This action creates a new health check.

To create a new health check, send a POST request to the 2013-04-01/healthcheck resource. The request body must include an XML document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.


CreateHostedZone(CreateHostedZoneRequest)

This action creates a new hosted zone.

To create a new hosted zone, send a POST request to the 2013-04-01/hostedzone resource. The request body must include an XML document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.

Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. 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 .

When you create a zone, its initial status is PENDING . This means that it is not yet available on all DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on all Route 53 DNS servers.


DeleteHealthCheck(DeleteHealthCheckRequest)

This action deletes a health check. To delete a health check, send a DELETE request to the 2013-04-01/healthcheck/health check ID resource.

IMPORTANT: You can delete a health check only if there are no resource record sets associated with this health check. If resource record sets are associated with this health check, you must disassociate them before you can delete your health check. If you try to delete a health check that is associated with resource record sets, Route 53 will deny your request with a HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.


DeleteHostedZone(DeleteHostedZoneRequest)

This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the 2013-04-01/hostedzone/hosted zone ID resource.

For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide .

IMPORTANT: You can delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If your hosted zone contains other resource record sets, you must delete them before you can delete your hosted zone. If you try to delete a hosted zone that contains other resource record sets, Route 53 will deny your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndChangeResourceRecordSets(IAsyncResult)
Finishes the asynchronous execution of the ChangeResourceRecordSets operation.

EndCreateHealthCheck(IAsyncResult)
Finishes the asynchronous execution of the CreateHealthCheck operation.

EndCreateHostedZone(IAsyncResult)
Finishes the asynchronous execution of the CreateHostedZone operation.

EndDeleteHealthCheck(IAsyncResult)
Finishes the asynchronous execution of the DeleteHealthCheck operation.

EndDeleteHostedZone(IAsyncResult)
Finishes the asynchronous execution of the DeleteHostedZone operation.

EndGetChange(IAsyncResult)
Finishes the asynchronous execution of the GetChange operation.

EndGetHealthCheck(IAsyncResult)
Finishes the asynchronous execution of the GetHealthCheck operation.

EndGetHostedZone(IAsyncResult)
Finishes the asynchronous execution of the GetHostedZone operation.

EndListHealthChecks(IAsyncResult)
Finishes the asynchronous execution of the ListHealthChecks operation.

EndListHostedZones(IAsyncResult)
Finishes the asynchronous execution of the ListHostedZones operation.

EndListResourceRecordSets(IAsyncResult)
Finishes the asynchronous execution of the ListResourceRecordSets operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetChange(GetChangeRequest)

This action 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 replicated to all Route 53 DNS servers. This is the initial status of all change batch requests.

- INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.


GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetHealthCheck(GetHealthCheckRequest)

To retrieve the health check, send a GET request to the 2013-04-01/healthcheck/health check ID resource.


GetHostedZone(GetHostedZoneRequest)

To retrieve the delegation set for a hosted zone, send a GET request to the 2013-04-01/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.


GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ListHealthChecks(ListHealthChecksRequest)

To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

NOTE: Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.


ListHealthChecks()()()()

To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

NOTE: Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.


ListHostedZones(ListHostedZonesRequest)

To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.

NOTE: Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.


ListHostedZones()()()()

To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.

NOTE: Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.


ListResourceRecordSets(ListResourceRecordSetsRequest)

Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like "com.amazon.www" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments:

  • If both Name and Type are omitted, this means start the results at the first RRSET in the HostedZone.
  • If Name is specified but Type is omitted, this means start the results at the first RRSET in the list whose name is greater than or equal to Name.
  • If both Name and Type are specified, this means start the results at the first RRSET in the list whose name is greater than or equal to Name and whose type is greater than or equal to Type.
  • It is an error to specify the Type but not the Name.

Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1

To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response.

In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress.

However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic)

The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonRoute53Client

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)