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.

Classes

NameDescription
Class CreatePrivateDnsNamespaceRequest

Container for the parameters to the CreatePrivateDnsNamespace operation. Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see Limits on Auto Naming in the Route 53 Developer Guide.

Class CreatePrivateDnsNamespaceResponse

This is the response object from the CreatePrivateDnsNamespace operation.

Class CreatePublicDnsNamespaceRequest

Container for the parameters to the CreatePublicDnsNamespace operation. Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see Limits on Auto Naming in the Route 53 Developer Guide.

Class CreatePublicDnsNamespaceResponse

This is the response object from the CreatePublicDnsNamespace operation.

Class CreateServiceRequest

Container for the parameters to the CreateService operation. Creates a service, which defines the configuration for the following entities:

  • Up to three records (A, AAAA, and SRV) or one CNAME record

  • Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and Amazon Route 53 uses the values in the configuration to create the specified entities.

For the current limit on the number of instances that you can register using the same namespace and using the same service, see Limits on Auto Naming in the Route 53 Developer Guide.

Class CreateServiceResponse

This is the response object from the CreateService operation.

Class CustomHealthNotFoundException

ServiceDiscovery exception

Class DeleteNamespaceRequest

Container for the parameters to the DeleteNamespace operation. Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

Class DeleteNamespaceResponse

This is the response object from the DeleteNamespace operation.

Class DeleteServiceRequest

Container for the parameters to the DeleteService operation. Deletes a specified service. If the service still contains one or more registered instances, the request fails.

Class DeleteServiceResponse

This is the response object from the DeleteService operation.

Class DeregisterInstanceRequest

Container for the parameters to the DeregisterInstance operation. Deletes the records and the health check, if any, that Amazon Route 53 created for the specified instance.

Class DeregisterInstanceResponse

This is the response object from the DeregisterInstance operation.

Class DnsConfig

A complex type that contains information about the records that you want Amazon Route 53 to create when you register an instance.

Class DnsConfigChange

A complex type that contains information about changes to the records that Route 53 creates when you register an instance.

Class DnsProperties

A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.

Class DnsRecord

A complex type that contains information about the records that you want Route 53 to create when you register an instance.

Class DuplicateRequestException

ServiceDiscovery exception

Class GetInstanceRequest

Container for the parameters to the GetInstance operation. Gets information about a specified instance.

Class GetInstanceResponse

This is the response object from the GetInstance operation.

Class GetInstancesHealthStatusRequest

Container for the parameters to the GetInstancesHealthStatus operation. Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There is a brief delay between when you register an instance and when the health status for the instance is available.

Class GetInstancesHealthStatusResponse

This is the response object from the GetInstancesHealthStatus operation.

Class GetNamespaceRequest

Container for the parameters to the GetNamespace operation. Gets information about a namespace.

Class GetNamespaceResponse

This is the response object from the GetNamespace operation.

Class GetOperationRequest

Container for the parameters to the GetOperation operation. Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

To get a list of operations that match specified criteria, see ListOperations.

Class GetOperationResponse

This is the response object from the GetOperation operation.

Class GetServiceRequest

Container for the parameters to the GetService operation. Gets the settings for a specified service.

Class GetServiceResponse

This is the response object from the GetService operation.

Class HealthCheckConfig

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in DnsConfig.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

CNAME records

You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

Request interval

The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

Health checking regions

Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions.

Alias records

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Route 53 creates an alias record. Note the following:

  • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

  • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

For information about the charges for health checks, see Route 53 Pricing.

Class HealthCheckCustomConfig

Class Instance

A complex type that contains information about an instance that Amazon Route 53 creates when you submit a RegisterInstance request.

Class InstanceNotFoundException

ServiceDiscovery exception

Class InstanceSummary

A complex type that contains information about the instances that you registered by using a specified service.

Class InvalidInputException

ServiceDiscovery exception

Class ListInstancesRequest

Container for the parameters to the ListInstances operation. Lists summary information about the instances that you registered by using a specified service.

Class ListInstancesResponse

This is the response object from the ListInstances operation.

Class ListNamespacesRequest

Container for the parameters to the ListNamespaces operation. Lists summary information about the namespaces that were created by the current AWS account.

Class ListNamespacesResponse

This is the response object from the ListNamespaces operation.

Class ListOperationsRequest

Container for the parameters to the ListOperations operation. Lists operations that match the criteria that you specify.

Class ListOperationsResponse

This is the response object from the ListOperations operation.

Class ListServicesRequest

Container for the parameters to the ListServices operation. Lists summary information for all the services that are associated with one or more specified namespaces.

Class ListServicesResponse

This is the response object from the ListServices operation.

Class Namespace

A complex type that contains information about a specified namespace.

Class NamespaceAlreadyExistsException

ServiceDiscovery exception

Class NamespaceFilter

A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

Class NamespaceNotFoundException

ServiceDiscovery exception

Class NamespaceProperties

A complex type that contains information that is specific to the namespace type.

Class NamespaceSummary

A complex type that contains information about a namespace.

Class Operation

A complex type that contains information about a specified operation.

Class OperationFilter

A complex type that lets you select the operations that you want to list.

Class OperationNotFoundException

ServiceDiscovery exception

Class OperationSummary

A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.

Class RegisterInstanceRequest

Container for the parameters to the RegisterInstance operation. Creates or updates one or more records and optionally a health check based on the settings in a specified service. When you submit a RegisterInstance request, Amazon Route 53 does the following:

  • For each DNS record that you define in the service specified by ServiceId, creates or updates a record in the hosted zone that is associated with the corresponding namespace

  • If the service includes HealthCheckConfig, creates or updates a health check based on the settings in the health check configuration

  • Associates the health check, if any, with each of the records

One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

For more information, see CreateService.

When Route 53 receives a DNS query for the specified DNS name, it returns the applicable value:

  • If the health check is healthy: returns all the records

  • If the health check is unhealthy: returns the applicable value for the last healthy instance

  • If you didn't specify a health check configuration: returns all the records

For the current limit on the number of instances that you can register using the same namespace and using the same service, see Limits on Auto Naming in the Route 53 Developer Guide.

Class RegisterInstanceResponse

This is the response object from the RegisterInstance operation.

Class ResourceInUseException

ServiceDiscovery exception

Class ResourceLimitExceededException

ServiceDiscovery exception

Class Service

A complex type that contains information about the specified service.

Class ServiceAlreadyExistsException

ServiceDiscovery exception

Class ServiceChange

A complex type that contains changes to an existing service.

Class ServiceFilter

A complex type that lets you specify the namespaces that you want to list services for.

Class ServiceNotFoundException

ServiceDiscovery exception

Class ServiceSummary

A complex type that contains information about a specified service.

Class UpdateInstanceCustomHealthStatusRequest

Container for the parameters to the UpdateInstanceCustomHealthStatus operation.

Class UpdateInstanceCustomHealthStatusResponse

This is the response object from the UpdateInstanceCustomHealthStatus operation.

Class UpdateServiceRequest

Container for the parameters to the UpdateService operation. Submits a request to perform the following operations:

  • Add or delete DnsRecords configurations

  • Update the TTL setting for existing DnsRecords configurations

  • Add, update, or delete HealthCheckConfig for a specified service

You must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the records and health checks that were created by using the specified service.

Class UpdateServiceResponse

This is the response object from the UpdateService operation.