import type { AcceleratedRecoveryStatus, AccountLimitType, ChangeAction, ChangeStatus, CidrCollectionChangeAction, CloudWatchRegion, ComparisonOperator, HealthCheckRegion, HealthCheckType, HostedZoneLimitType, HostedZoneType, InsufficientDataHealthStatus, ResettableElementName, ResourceRecordSetFailover, ResourceRecordSetRegion, ReusableDelegationSetLimitType, RRType, Statistic, TagResourceType, VPCRegion } from "./enums"; /** *

A complex type that contains the type of limit that you specified in the request and * the current value for that limit.

* @public */ export interface AccountLimit { /** *

The limit that you requested. Valid values include the following:

* * @public */ Type: AccountLimitType | undefined; /** *

The current value for the limit that is specified by Type.

* @public */ Value: number | undefined; } /** * @public */ export interface ActivateKeySigningKeyRequest { /** *

A unique string used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

A string used to identify a key-signing key (KSK). Name can include * numbers, letters, and underscores (_). Name must be unique for each * key-signing key in the same hosted zone.

* @public */ Name: string | undefined; } /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ export interface ChangeInfo { /** *

This element contains an ID that you use when performing a GetChange action to get * detailed information about the change.

* @public */ Id: string | undefined; /** *

The current state of the request. PENDING indicates that this request has * not yet been applied to all Amazon Route 53 DNS servers.

* @public */ Status: ChangeStatus | undefined; /** *

The date and time that the change request was submitted in ISO 8601 format and Coordinated * Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z * represents March 27, 2017 at 17:48:16.751 UTC.

* @public */ SubmittedAt: Date | undefined; /** *

A comment you can provide.

* @public */ Comment?: string | undefined; } /** * @public */ export interface ActivateKeySigningKeyResponse { /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** *

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 * health checkers to use to determine whether the specified health check is * healthy.

* @public */ export interface AlarmIdentifier { /** *

For the CloudWatch alarm that you want Route 53 health checkers to use to determine * whether this health check is healthy, the region that the alarm was created in.

*

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and * quotas in the Amazon Web Services General * Reference.

* @public */ Region: CloudWatchRegion | undefined; /** *

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use * to determine whether this health check is healthy.

* *

Route 53 supports CloudWatch alarms with the following features:

* * * @public */ Name: string | undefined; } /** *

* Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that * you want to route traffic to.

*

When creating resource record sets for a private hosted zone, note the * following:

* * @public */ export interface AliasTarget { /** *

* Alias resource records sets only: The value used depends on where * you want to route traffic:

*
*
Amazon API Gateway custom regional APIs and edge-optimized APIs
*
*

Specify the hosted zone ID for your API. You can get the applicable value * using the CLI command get-domain-names:

* *
*
Amazon Virtual Private Cloud interface VPC endpoint
*
*

Specify the hosted zone ID for your interface endpoint. You can get the * value of HostedZoneId using the CLI command * describe-vpc-endpoints.

*
*
CloudFront distribution
*
*

Specify Z2FDTNDATAQYW2.

* *

Alias resource record sets for CloudFront can't be created in a * private zone.

* *
*
Elastic Beanstalk environment
*
*

Specify the hosted zone ID for the region that you created the environment in. The * environment must have a regionalized subdomain. For a list of regions and * the corresponding hosted zone IDs, see Elastic Beanstalk * endpoints and quotas in the Amazon Web Services * General Reference.

*
*
ELB load balancer
*
*

Specify the value of the hosted zone ID for the load balancer. Use the * following methods to get the hosted zone ID:

* *
*
Global Accelerator accelerator
*
*

Specify Z2BJ6XQ5FK7U4H.

*
*
An Amazon S3 bucket configured as a static website
*
*

Specify the hosted zone ID for the region that you created the bucket in. * For more information about valid values, see the table Amazon S3 * Website Endpoints in the Amazon Web Services General * Reference.

*
*
Another Route 53 resource record set in your hosted zone
*
*

Specify the hosted zone ID of your hosted zone. (An alias resource record * set can't reference a resource record set in a different hosted * zone.)

*
*
* @public */ HostedZoneId: string | undefined; /** *

* Alias resource record sets only: The value that you specify * depends on where you want to route queries:

*
*
Amazon API Gateway custom regional APIs and edge-optimized APIs
*
*

Specify the applicable domain name for your API. You can get the * applicable value using the CLI command get-domain-names:

* * *

The name of the record that you're creating must match a custom domain * name for your API, such as api.example.com.

* *
*
Amazon Virtual Private Cloud interface VPC endpoint
*
*

Enter the API endpoint for the interface endpoint, such as * vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. * For edge-optimized APIs, this is the domain name for the corresponding * CloudFront distribution. You can get the value of DnsName using * the CLI command describe-vpc-endpoints.

*
*
CloudFront distribution
*
*

Specify the domain name that CloudFront assigned when you created your * distribution.

*

Your CloudFront distribution must include an alternate domain name that * matches the name of the resource record set. For example, if the name of the * resource record set is acme.example.com, your * CloudFront distribution must include acme.example.com * as one of the alternate domain names. For more information, see Using Alternate * Domain Names (CNAMEs) in the Amazon CloudFront * Developer Guide.

*

You can't create a resource record set in a private hosted zone to route * traffic to a CloudFront distribution.

* *

For failover alias records, you can't specify a CloudFront * distribution for both the primary and secondary records. A distribution * must include an alternate domain name that matches the name of the * record. However, the primary and secondary records have the same name, * and you can't include the same alternate domain name in more than one * distribution.

* *
*
Elastic Beanstalk environment
*
*

If the domain name for your Elastic Beanstalk environment includes the * region that you deployed the environment in, you can create an alias record * that routes traffic to the environment. For example, the domain name * my-environment.us-west-2.elasticbeanstalk.com * is a regionalized domain name.

* *

For environments that were created before early 2016, the domain name * doesn't include the region. To route traffic to these environments, you * must create a CNAME record instead of an alias record. Note that you * can't create a CNAME record for the root domain name. For example, if * your domain name is example.com, you can create a record that routes * traffic for acme.example.com to your Elastic Beanstalk environment, but * you can't create a record that routes traffic for example.com to your * Elastic Beanstalk environment.

* *

For Elastic Beanstalk environments that have regionalized subdomains, * specify the CNAME attribute for the environment. You can use * the following methods to get the value of the CNAME attribute:

* *
*
ELB load balancer
*
*

Specify the DNS name that is associated with the load balancer. Get the * DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

* *
*
Global Accelerator accelerator
*
*

Specify the DNS name for your accelerator:

* *
*
Amazon S3 bucket that is configured as a static website
*
*

Specify the domain name of the Amazon S3 website endpoint that you created * the bucket in, for example, s3-website.us-east-2.amazonaws.com. * For more information about valid values, see the table Amazon S3 * Website Endpoints in the Amazon Web Services General * Reference. For more information about using S3 buckets for * websites, see Getting Started * with Amazon Route 53 in the Amazon Route 53 Developer * Guide. *

*
*
Another Route 53 resource record set
*
*

Specify the value of the Name element for a resource record * set in the current hosted zone.

* *

If you're creating an alias record that has the same name as the * hosted zone (known as the zone apex), you can't specify the domain name * for a record for which the value of Type is * CNAME. This is because the alias record must have the * same type as the record that you're routing traffic to, and creating a * CNAME record for the zone apex isn't supported even for an alias * record.

* *
*
* @public */ DNSName: string | undefined; /** *

* Applies only to alias, failover alias, geolocation alias, latency alias, and * weighted alias resource record sets: When * EvaluateTargetHealth is true, an alias resource record set * inherits the health of the referenced Amazon Web Services resource, such as an ELB load * balancer or another resource record set in the hosted zone.

*

Note the following:

*
*
CloudFront distributions
*
*

You can't set EvaluateTargetHealth to true when * the alias target is a CloudFront distribution.

*
*
Elastic Beanstalk environments that have regionalized subdomains
*
*

If you specify an Elastic Beanstalk environment in DNSName * and the environment contains an ELB load balancer, Elastic Load Balancing * routes queries only to the healthy Amazon EC2 instances that are registered * with the load balancer. (An environment automatically contains an ELB load * balancer if it includes more than one Amazon EC2 instance.) If you set * EvaluateTargetHealth to true and either no * Amazon EC2 instances are healthy or the load balancer itself is unhealthy, * Route 53 routes queries to other available resources that are healthy, if * any.

*

If the environment contains a single Amazon EC2 instance, there are no * special requirements.

*
*
ELB load balancers
*
*

Health checking behavior depends on the type of load balancer:

* * *

When you create a load balancer, you configure settings for Elastic * Load Balancing health checks; they're not Route 53 health checks, but * they perform a similar function. Do not create Route 53 health checks * for the EC2 instances that you register with an ELB load balancer. *

* *
*
API Gateway APIs
*
*

There are no special requirements for setting * EvaluateTargetHealth to true when the alias * target is an API Gateway API. However, because API Gateway is highly * available by design, EvaluateTargetHealth provides no * operational benefit and Route 53 health * checks are recommended instead for failover scenarios.

*
*
S3 buckets
*
*

There are no special requirements for setting * EvaluateTargetHealth to true when the alias * target is an S3 bucket. However, because S3 buckets are highly available by * design, EvaluateTargetHealth provides no operational benefit * and Route 53 health * checks are recommended instead for failover scenarios.

*
*
VPC interface endpoints
*
*

There are no special requirements for setting * EvaluateTargetHealth to true when the alias * target is a VPC interface endpoint. However, because VPC interface endpoints * are highly available by design, EvaluateTargetHealth provides * no operational benefit and Route 53 health * checks are recommended instead for failover scenarios.

*
*
Other records in the same hosted zone
*
*

If the Amazon Web Services resource that you specify in * DNSName is a record or a group of records (for example, a * group of weighted records) but is not another alias record, we recommend * that you associate a health check with all of the records in the alias * target. For more information, see What Happens When You Omit Health Checks? in the * Amazon Route 53 Developer Guide.

*
*
* *

While EvaluateTargetHealth can be set to true for highly * available Amazon Web Services services (such as S3 buckets, VPC interface endpoints, * and API Gateway), these services are designed for high availability and rarely * experience outages that would be detected by this feature. For failover scenarios * with these services, consider using Route 53 health * checks that monitor your application's ability to access the service * instead.

* *

For more information and examples, see Amazon Route 53 Health Checks * and DNS Failover in the Amazon Route 53 Developer * Guide.

* @public */ EvaluateTargetHealth: boolean | undefined; } /** *

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

*

If you associate a private hosted zone with an Amazon VPC when you make a * CreateHostedZone * request, the following parameters are also required.

* @public */ export interface VPC { /** *

(Private hosted zones only) The region that an Amazon VPC was created * in.

* @public */ VPCRegion?: VPCRegion | undefined; /** *

(Private hosted zones only) The ID of an Amazon VPC.

* @public */ VPCId?: string | undefined; } /** *

A complex type that contains information about the request to associate a VPC with a * private hosted zone.

* @public */ export interface AssociateVPCWithHostedZoneRequest { /** *

The ID of the private hosted zone that you want to associate an Amazon VPC * with.

*

Note that you can't associate a VPC with a hosted zone that doesn't have an existing * VPC association.

* @public */ HostedZoneId: string | undefined; /** *

A complex type that contains information about the VPC that you want to associate with * a private hosted zone.

* @public */ VPC: VPC | undefined; /** *

* Optional: A comment about the association request.

* @public */ Comment?: string | undefined; } /** *

A complex type that contains the response information for the * AssociateVPCWithHostedZone request.

* @public */ export interface AssociateVPCWithHostedZoneResponse { /** *

A complex type that describes the changes made to your hosted zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** *

A complex type that contains information about the CIDR collection change.

* @public */ export interface CidrCollectionChange { /** *

Name of the location that is associated with the CIDR collection.

* @public */ LocationName: string | undefined; /** *

CIDR collection change action.

* @public */ Action: CidrCollectionChangeAction | undefined; /** *

List of CIDR blocks.

* @public */ CidrList: string[] | undefined; } /** * @public */ export interface ChangeCidrCollectionRequest { /** *

The UUID of the CIDR collection to update.

* @public */ Id: string | undefined; /** *

A sequential counter that Amazon Route 53 sets to 1 when you create a * collection and increments it by 1 each time you update the collection.

*

We recommend that you use ListCidrCollection to get the current value of * CollectionVersion for the collection that you want to update, and then * include that value with the change request. This prevents Route 53 from * overwriting an intervening update:

* * @public */ CollectionVersion?: number | undefined; /** *

Information about changes to a CIDR collection.

* @public */ Changes: CidrCollectionChange[] | undefined; } /** * @public */ export interface ChangeCidrCollectionResponse { /** *

The ID that is returned by ChangeCidrCollection. You can use it as input to * GetChange to see if a CIDR collection change has propagated or * not.

* @public */ Id: string | undefined; } /** *

The object that is specified in resource record set object when you are linking a * resource record set to a CIDR location.

*

A LocationName with an asterisk “*” can be used to create a default CIDR * record. CollectionId is still required for default record.

* @public */ export interface CidrRoutingConfig { /** *

The CIDR collection ID.

* @public */ CollectionId: string | undefined; /** *

The CIDR collection location name.

* @public */ LocationName: string | undefined; } /** *

A complex type that contains information about a geographic location.

* @public */ export interface GeoLocation { /** *

The two-letter code for the continent.

*

Amazon Route 53 supports the following continent codes:

* *

Constraint: Specifying ContinentCode with either CountryCode * or SubdivisionCode returns an InvalidInput error.

* @public */ ContinentCode?: string | undefined; /** *

For geolocation resource record sets, the two-letter code for a country.

*

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 * alpha-2.

*

Route 53 also supports the country code UA for * Ukraine.

* @public */ CountryCode?: string | undefined; /** *

For geolocation resource record sets, the two-letter code for a state of the United * States. Route 53 doesn't support any other values for SubdivisionCode. For * a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United * States Postal Service website.

*

If you specify subdivisioncode, you must also specify US for * CountryCode.

* @public */ SubdivisionCode?: string | undefined; } /** *

* A complex type that lists the coordinates for a geoproximity resource record. *

* @public */ export interface Coordinates { /** *

Specifies a coordinate of the north–south position of a geographic point on the surface of * the Earth (-90 - 90).

* @public */ Latitude: string | undefined; /** *

Specifies a coordinate of the east–west position of a geographic point on the surface of * the Earth (-180 - 180).

* @public */ Longitude: string | undefined; } /** *

(Resource record sets only): A complex type that lets you specify where your resources are * located. Only one of LocalZoneGroup, Coordinates, or * Amazon Web ServicesRegion is allowed per request at a time.

*

For more information about geoproximity routing, see Geoproximity routing in the * Amazon Route 53 Developer Guide.

* @public */ export interface GeoProximityLocation { /** *

The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

* @public */ AWSRegion?: string | undefined; /** *

* Specifies an Amazon Web Services Local Zone Group. *

*

A local Zone Group is usually the Local Zone code without the ending character. For example, * if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

*

You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

*

This command returns: "GroupName": "us-west-2-den-1", specifying that the Local Zone us-west-2-den-1a * belongs to the Local Zone Group us-west-2-den-1.

* @public */ LocalZoneGroup?: string | undefined; /** *

Contains the longitude and latitude for a geographic region.

* @public */ Coordinates?: Coordinates | undefined; /** *

* The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. *

*

To use Bias to change the size of the geographic region, specify the * applicable value for the bias:

* * @public */ Bias?: number | undefined; } /** *

Information specific to the resource record.

* *

If you're creating an alias resource record set, omit * ResourceRecord.

* * @public */ export interface ResourceRecord { /** *

The current or new DNS record value, not to exceed 4,000 characters. In the case of a * DELETE action, if the current value does not match the actual value, an * error is returned. For descriptions about how to format Value for different * record types, see Supported DNS Resource * Record Types in the Amazon Route 53 Developer * Guide.

*

You can specify more than one value for all record types except CNAME and * SOA.

* *

If you're creating an alias resource record set, omit Value.

* * @public */ Value: string | undefined; } /** *

Information about the resource record set to create or delete.

* @public */ export interface ResourceRecordSet { /** *

For ChangeResourceRecordSets requests, the name of the record that you * want to create, update, or delete. For ListResourceRecordSets responses, * the name of a record in the specified hosted zone.

*

* ChangeResourceRecordSets Only *

*

Enter a fully qualified domain name, for example, www.example.com. You * can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 * assumes that the domain name that you specify is fully qualified. This means that Route * 53 treats www.example.com (without a trailing dot) and * www.example.com. (with a trailing dot) as identical.

*

For information about how to specify characters other than a-z, * 0-9, and - (hyphen) and how to specify internationalized * domain names, see DNS Domain Name * Format in the Amazon Route 53 Developer Guide.

*

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, * for example, *.example.com. Note the following:

* * @public */ Name: string | undefined; /** *

The DNS record type. For information about different record types and how data is * encoded for them, see Supported DNS Resource * Record Types in the Amazon Route 53 Developer * Guide.

*

Valid values for basic resource record sets: A | AAAA | * CAA | CNAME | DS |MX | * NAPTR | NS | PTR | SOA | * SPF | SRV | TXT| TLSA| SSHFP| SVCB| HTTPS *

*

Values for weighted, latency, geolocation, and failover resource record sets: A * | AAAA | CAA | CNAME | MX | * NAPTR | PTR | SPF | SRV | * TXT| TLSA| SSHFP| SVCB| * HTTPS. When creating a group of weighted, latency, geolocation, or * failover resource record sets, specify the same value for all of the resource record * sets in the group.

*

Valid values for multivalue answer resource record sets: A | * AAAA | MX | NAPTR | PTR | * SPF | SRV | TXT| CAA| TLSA| SSHFP| SVCB| HTTPS *

* *

SPF records were formerly used to verify the identity of the sender of email * messages. However, we no longer recommend that you create resource record sets for * which the value of Type is SPF. RFC 7208, Sender * Policy Framework (SPF) for Authorizing Use of Domains in Email, Version * 1, has been updated to say, "...[I]ts existence and mechanism defined * in [RFC4408] have led to some interoperability issues. Accordingly, its use is no * longer appropriate for SPF version 1; implementations are not to use it." In RFC * 7208, see section 14.1, The SPF DNS Record Type.

* *

Values for alias resource record sets:

* * @public */ Type: RRType | undefined; /** *

* Resource record sets that have a routing policy other than * simple: An identifier that differentiates among multiple resource record * sets that have the same combination of name and type, such as multiple weighted resource * record sets named acme.example.com that have a type of A. In a group of resource record * sets that have the same name and type, the value of SetIdentifier must be * unique for each resource record set.

*

For information about routing policies, see Choosing a Routing * Policy in the Amazon Route 53 Developer Guide.

* @public */ SetIdentifier?: string | undefined; /** *

* Weighted resource record sets only: Among resource record sets * that have the same combination of DNS name and type, a value that determines the * proportion of DNS queries that Amazon Route 53 responds to using the current resource * record set. Route 53 calculates the sum of the weights for the resource record sets that * have the same combination of DNS name and type. Route 53 then responds to queries based * on the ratio of a resource's weight to the total. Note the following:

* * @public */ Weight?: number | undefined; /** *

* Latency-based resource record sets only: The Amazon EC2 Region * where you created the resource that this resource record set refers to. The resource * typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load * balancer, and is referred to by an IP address or a DNS domain name, depending on the * record type.

*

When Amazon Route 53 receives a DNS query for a domain name and type for which you * have created latency resource record sets, Route 53 selects the latency resource record * set that has the lowest latency between the end user and the associated Amazon EC2 * Region. Route 53 then returns the value that is associated with the selected resource * record set.

*

Note the following:

* * @public */ Region?: ResourceRecordSetRegion | undefined; /** *

* Geolocation resource record sets only: A complex type that lets you * control how Amazon Route 53 responds to DNS queries based on the geographic origin of * the query. For example, if you want all queries from Africa to be routed to a web server * with an IP address of 192.0.2.111, create a resource record set with a * Type of A and a ContinentCode of * AF.

*

If you create separate resource record sets for overlapping geographic regions (for * example, one resource record set for a continent and one for a country on the same * continent), priority goes to the smallest geographic region. This allows you to route * most queries for a continent to one resource and to route queries for a country on that * continent to a different resource.

*

You can't create two geolocation resource record sets that specify the same geographic * location.

*

The value * in the CountryCode element matches all * geographic locations that aren't specified in other geolocation resource record sets * that have the same values for the Name and Type * elements.

* *

Geolocation works by mapping IP addresses to locations. However, some IP addresses * aren't mapped to geographic locations, so even if you create geolocation resource * record sets that cover all seven continents, Route 53 will receive some DNS queries * from locations that it can't identify. We recommend that you create a resource * record set for which the value of CountryCode is *. Two * groups of queries are routed to the resource that you specify in this record: * queries that come from locations for which you haven't created geolocation resource * record sets and queries from IP addresses that aren't mapped to a location. If you * don't create a * resource record set, Route 53 returns a "no answer" * response for queries from those locations.

* *

You can't create non-geolocation resource record sets that have the same values for * the Name and Type elements as geolocation resource record * sets.

* @public */ GeoLocation?: GeoLocation | undefined; /** *

* Failover resource record sets only: To configure failover, you * add the Failover element to two resource record sets. For one resource * record set, you specify PRIMARY as the value for Failover; for * the other resource record set, you specify SECONDARY. In addition, you * include the HealthCheckId element and specify the health check that you * want Amazon Route 53 to perform for each resource record set.

*

Except where noted, the following failover behaviors assume that you have included the * HealthCheckId element in both resource record sets:

* *

You can't create non-failover resource record sets that have the same values for the * Name and Type elements as failover resource record * sets.

*

For failover alias resource record sets, you must also include the * EvaluateTargetHealth element and set the value to true.

*

For more information about configuring failover for Route 53, see the following topics * in the Amazon Route 53 Developer Guide:

* * @public */ Failover?: ResourceRecordSetFailover | undefined; /** *

* Multivalue answer resource record sets only: To route traffic * approximately randomly to multiple resources, such as web servers, create one multivalue * answer record for each resource and specify true for * MultiValueAnswer. Note the following:

* *

You can't create multivalue answer alias records.

* @public */ MultiValueAnswer?: boolean | undefined; /** *

The resource record cache time to live (TTL), in seconds. Note the following:

* * @public */ TTL?: number | undefined; /** *

Information about the resource records to act upon.

* *

If you're creating an alias resource record set, omit * ResourceRecords.

* * @public */ ResourceRecords?: ResourceRecord[] | undefined; /** *

* Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that * you want to route traffic to.

*

If you're creating resource records sets for a private hosted zone, note the * following:

* * @public */ AliasTarget?: AliasTarget | undefined; /** *

If you want Amazon Route 53 to return this resource record set in response to a DNS * query only when the status of a health check is healthy, include the * HealthCheckId element and specify the ID of the applicable health * check.

*

Route 53 determines whether a resource record set is healthy based on one of the * following:

* * *

Route 53 doesn't check the health of the endpoint that is specified in the * resource record set, for example, the endpoint specified by the IP address in the * Value element. When you add a HealthCheckId element to * a resource record set, Route 53 checks the health of the endpoint that you specified * in the health check.

* *

For more information, see the following topics in the Amazon Route 53 * Developer Guide:

* *

* When to Specify HealthCheckId *

*

Specifying a value for HealthCheckId is useful only when Route 53 is * choosing between two or more resource record sets to respond to a DNS query, and you * want Route 53 to base the choice in part on the status of a health check. Configuring * health checks makes sense only in the following configurations:

* *

* Geolocation Routing *

*

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for * a resource record set for the larger, associated geographic region. For example, suppose * you have resource record sets for a state in the United States, for the entire United * States, for North America, and a resource record set that has * for * CountryCode is *, which applies to all locations. If the * endpoint for the state resource record set is unhealthy, Route 53 checks for healthy * resource record sets in the following order until it finds a resource record set for * which the endpoint is healthy:

* *

* Specifying the Health Check Endpoint by Domain * Name *

*

If your health checks specify the endpoint only by domain name, we recommend that you * create a separate health check for each endpoint. For example, create a health check for * each HTTP server that is serving content for www.example.com. * For the value of FullyQualifiedDomainName, specify the domain name of the * server (such as us-east-2-www.example.com), not the name of the resource * record sets (www.example.com).

* *

Health check results will be unpredictable if you do the following:

* * * @public */ HealthCheckId?: string | undefined; /** *

When you create a traffic policy instance, Amazon Route 53 automatically creates a * resource record set. TrafficPolicyInstanceId is the ID of the traffic * policy instance that Route 53 created this resource record set for.

* *

To delete the resource record set that is associated with a traffic policy * instance, use DeleteTrafficPolicyInstance. Route 53 will delete the * resource record set automatically. If you delete the resource record set by using * ChangeResourceRecordSets, Route 53 doesn't automatically delete the * traffic policy instance, and you'll continue to be charged for it even though it's * no longer in use.

* * @public */ TrafficPolicyInstanceId?: string | undefined; /** *

The object that is specified in resource record set object when you are linking a * resource record set to a CIDR location.

*

A LocationName with an asterisk “*” can be used to create a default CIDR * record. CollectionId is still required for default record.

* @public */ CidrRoutingConfig?: CidrRoutingConfig | undefined; /** *

* GeoproximityLocation resource record sets only: A complex type that lets you control how * Route 53 responds to DNS queries based on the geographic origin of the * query and your resources.

* @public */ GeoProximityLocation?: GeoProximityLocation | undefined; } /** *

The information for each resource record set that you want to change.

* @public */ export interface Change { /** *

The action to perform:

* * @public */ Action: ChangeAction | undefined; /** *

Information about the resource record set to create, delete, or update.

* @public */ ResourceRecordSet: ResourceRecordSet | undefined; } /** *

The information for a change request.

* @public */ export interface ChangeBatch { /** *

* Optional: Any comments you want to include about a change batch * request.

* @public */ Comment?: string | undefined; /** *

Information about the changes to make to the record sets.

* @public */ Changes: Change[] | undefined; } /** *

A complex type that contains change information for the resource record set.

* @public */ export interface ChangeResourceRecordSetsRequest { /** *

The ID of the hosted zone that contains the resource record sets that you want to * change.

* @public */ HostedZoneId: string | undefined; /** *

A complex type that contains an optional comment and the Changes * element.

* @public */ ChangeBatch: ChangeBatch | undefined; } /** *

A complex type containing the response for the request.

* @public */ export interface ChangeResourceRecordSetsResponse { /** *

A complex type that contains information about changes made to your hosted * zone.

*

This element contains an ID that you use when performing a GetChange action to get * detailed information about the change.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** *

A complex type that contains information about a tag that you want to add or edit for * the specified health check or hosted zone.

* @public */ export interface Tag { /** *

The value of Key depends on the operation that you want to * perform:

* * @public */ Key?: string | undefined; /** *

The value of Value depends on the operation that you want to * perform:

* * @public */ Value?: string | undefined; } /** *

A complex type that contains information about the tags that you want to add, edit, or * delete.

* @public */ export interface ChangeTagsForResourceRequest { /** *

The type of the resource.

* * @public */ ResourceType: TagResourceType | undefined; /** *

The ID of the resource for which you want to add, change, or delete tags.

* @public */ ResourceId: string | undefined; /** *

A complex type that contains a list of the tags that you want to add to the specified * health check or hosted zone and/or the tags that you want to edit Value * for.

*

You can add a maximum of 10 tags to a health check or a hosted zone.

* @public */ AddTags?: Tag[] | undefined; /** *

A complex type that contains a list of the tags that you want to delete from the * specified health check or hosted zone. You can specify up to 10 keys.

* @public */ RemoveTagKeys?: string[] | undefined; } /** *

Empty response for the request.

* @public */ export interface ChangeTagsForResourceResponse { } /** * @public */ export interface CreateCidrCollectionRequest { /** *

A unique identifier for the account that can be used to reference the collection from * other API calls.

* @public */ Name: string | undefined; /** *

A client-specific token that allows requests to be securely retried so that the * intended outcome will only occur once, retries receive a similar response, and there are * no additional edge cases to handle.

* @public */ CallerReference: string | undefined; } /** *

A complex * type that * identifies a CIDR collection.

* @public */ export interface CidrCollection { /** *

The ARN of the collection. Can be used to reference the collection in IAM policy or in * another Amazon Web Services account.

* @public */ Arn?: string | undefined; /** *

The unique ID of the CIDR collection.

* @public */ Id?: string | undefined; /** *

The name of a CIDR collection.

* @public */ Name?: string | undefined; /** *

A sequential counter that Route 53 sets to 1 when you create a CIDR * collection and increments by 1 each time you update settings for the CIDR * collection.

* @public */ Version?: number | undefined; } /** * @public */ export interface CreateCidrCollectionResponse { /** *

A complex type that contains information about the CIDR collection.

* @public */ Collection?: CidrCollection | undefined; /** *

A unique URL that represents the location for the CIDR collection.

* @public */ Location?: string | undefined; } /** *

A complex type that contains information about the health check.

* @public */ export interface HealthCheckConfig { /** *

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform * health checks on. If you don't specify a value for IPAddress, Route 53 * sends a DNS request to resolve the domain name that you specify in * FullyQualifiedDomainName at the interval that you specify in * RequestInterval. Using an IP address returned by DNS, Route 53 then * checks the health of the endpoint.

*

Use one of the following formats for the value of IPAddress:

* *

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP * address, associate it with your EC2 instance, and specify the Elastic IP address for * IPAddress. This ensures that the IP address of your instance will never * change.

*

For more information, see FullyQualifiedDomainName.

*

Constraints: Route 53 can't check the health of endpoints for which the IP address is * in local, private, non-routable, or multicast ranges. For more information about IP * addresses for which you can't create health checks, see the following documents:

* *

When the value of Type is CALCULATED or * CLOUDWATCH_METRIC, omit IPAddress.

* @public */ IPAddress?: string | undefined; /** *

The port on the endpoint that you want Amazon Route 53 to perform health checks * on.

* *

Don't specify a value for Port when you specify a value for * Type of CLOUDWATCH_METRIC or * CALCULATED.

* * @public */ Port?: number | undefined; /** *

The type of health check that you want to create, which indicates how Amazon Route 53 * determines whether an endpoint is healthy.

* *

You can't change the value of Type after you create a health * check.

* *

You can create the following types of health checks:

* *

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the * Amazon Route 53 Developer Guide.

* @public */ Type: HealthCheckType | undefined; /** *

The path, if any, that you want Amazon Route 53 to request when performing health * checks. The path can be any value for which your endpoint will return an HTTP status * code of 2xx or 3xx when the endpoint is healthy, for example, the file * /docs/route53-health-check.html. You can also include query string parameters, for * example, /welcome.html?language=jp&login=y.

* @public */ ResourcePath?: string | undefined; /** *

Amazon Route 53 behavior depends on whether you specify a value for * IPAddress.

*

* If you specify a value for * IPAddress:

*

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and * passes the value of FullyQualifiedDomainName in the Host * header for all health checks except TCP health checks. This is typically the fully * qualified DNS name of the endpoint on which you want Route 53 to perform health * checks.

*

When Route 53 checks the health of an endpoint, here is how it constructs the * Host header:

* *

If you don't specify a value for FullyQualifiedDomainName, Route 53 * substitutes the value of IPAddress in the Host header in each * of the preceding cases.

*

* If you don't specify a value for * IPAddress:

*

Route 53 sends a DNS request to the domain that you specify for * FullyQualifiedDomainName at the interval that you specify for * RequestInterval. Using an IPv4 address that DNS returns, Route 53 then * checks the health of the endpoint.

* *

If you don't specify a value for IPAddress, Route 53 uses only IPv4 * to send health checks to the endpoint. If there's no resource record set with a type * of A for the name that you specify for FullyQualifiedDomainName, the * health check fails with a "DNS resolution failed" error.

* *

If you want to check the health of weighted, latency, or failover resource record sets * and you choose to specify the endpoint only by FullyQualifiedDomainName, we * recommend that you create a separate health check for each endpoint. For example, create * a health check for each HTTP server that is serving content for www.example.com. For the * value of FullyQualifiedDomainName, specify the domain name of the server * (such as us-east-2-www.example.com), not the name of the resource record sets * (www.example.com).

* *

In this configuration, if you create a health check for which the value of * FullyQualifiedDomainName matches the name of the resource record * sets and you then associate the health check with those resource record sets, health * check results will be unpredictable.

* *

In addition, if the value that you specify for Type is HTTP, * HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, * Route 53 passes the value of FullyQualifiedDomainName in the * Host header, as it does when you specify a value for * IPAddress. If the value of Type is TCP, Route * 53 doesn't pass a Host header.

* @public */ FullyQualifiedDomainName?: string | undefined; /** *

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, * the string that you want Amazon Route 53 to search for in the response body from the * specified resource. If the string appears in the response body, Route 53 considers the * resource healthy.

*

Route 53 considers case when searching for SearchString in the response * body.

* @public */ SearchString?: string | undefined; /** *

The number of seconds between the time that Amazon Route 53 gets a response from your * endpoint and the time that it sends the next health check request. Each Route 53 health * checker makes requests at this interval.

*

* RequestInterval is not supported when you specify a value for * Type of RECOVERY_CONTROL.

* *

You can't change the value of RequestInterval after you create a * health check.

* *

If you don't specify a value for RequestInterval, the default value is * 30 seconds.

* @public */ RequestInterval?: number | undefined; /** *

The number of consecutive health checks that an endpoint must pass or fail for Amazon * Route 53 to change the current status of the endpoint from unhealthy to healthy or vice * versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the * Amazon Route 53 Developer Guide.

*

* FailureThreshold is not supported when you specify a value for * Type of RECOVERY_CONTROL.

*

Otherwise, if you don't specify a value for FailureThreshold, the default value is * three health checks.

* @public */ FailureThreshold?: number | undefined; /** *

Specify whether you want Amazon Route 53 to measure the latency between health * checkers in multiple Amazon Web Services regions and your endpoint, and to display * CloudWatch latency graphs on the Health Checks page in * the Route 53 console.

*

* MeasureLatency is not supported when you specify a value for * Type of RECOVERY_CONTROL.

* *

You can't change the value of MeasureLatency after you create a * health check.

* * @public */ MeasureLatency?: boolean | undefined; /** *

Specify whether you want Amazon Route 53 to invert the status of a health check, for * example, to consider a health check unhealthy when it otherwise would be considered * healthy.

* @public */ Inverted?: boolean | undefined; /** *

Stops Route 53 from performing health checks. When you disable a health check, here's * what happens:

* *

After you disable a health check, Route 53 considers the status of the health check to * always be healthy. If you configured DNS failover, Route 53 continues to route traffic * to the corresponding resources. If you want to stop routing traffic to a resource, * change the value of Inverted.

*

Charges for a health check still apply when the health check is disabled. For more * information, see Amazon Route 53 * Pricing.

* @public */ Disabled?: boolean | undefined; /** *

The number of child health checks that are associated with a CALCULATED * health check that Amazon Route 53 must consider healthy for the CALCULATED * health check to be considered healthy. To specify the child health checks that you want * to associate with a CALCULATED health check, use the ChildHealthChecks element.

*

Note the following:

* * @public */ HealthThreshold?: number | undefined; /** *

(CALCULATED Health Checks Only) A complex type that contains one * ChildHealthCheck element for each health check that you want to * associate with a CALCULATED health check.

* @public */ ChildHealthChecks?: string[] | undefined; /** *

Specify whether you want Amazon Route 53 to send the value of * FullyQualifiedDomainName to the endpoint in the * client_hello message during TLS negotiation. This allows the endpoint * to respond to HTTPS health check requests with the applicable SSL/TLS * certificate.

*

Some endpoints require that HTTPS requests include the host name in the * client_hello message. If you don't enable SNI, the status of the health * check will be SSL alert handshake_failure. A health check can also have * that status for other reasons. If SNI is enabled and you're still getting the error, * check the SSL/TLS configuration on your endpoint and confirm that your certificate is * valid.

*

The SSL/TLS certificate on your endpoint includes a domain name in the Common * Name field and possibly several more in the Subject Alternative * Names field. One of the domain names in the certificate should match the * value that you specify for FullyQualifiedDomainName. If the endpoint * responds to the client_hello message with a certificate that does not * include the domain name that you specified in FullyQualifiedDomainName, a * health checker will retry the handshake. In the second attempt, the health checker will * omit FullyQualifiedDomainName from the client_hello * message.

* @public */ EnableSNI?: boolean | undefined; /** *

A complex type that contains one Region element for each region from * which you want Amazon Route 53 health checkers to check the specified endpoint.

*

If you don't specify any regions, Route 53 health checkers automatically performs * checks from all of the regions that are listed under Valid * Values.

*

If you update a health check to remove a region that has been performing health * checks, Route 53 will briefly continue to perform checks from that region to ensure that * some health checkers are always checking the endpoint (for example, if you replace three * regions with four different regions).

* @public */ Regions?: HealthCheckRegion[] | undefined; /** *

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 * health checkers to use to determine whether the specified health check is * healthy.

* @public */ AlarmIdentifier?: AlarmIdentifier | undefined; /** *

When CloudWatch has insufficient data about the metric to determine the alarm state, * the status that you want Amazon Route 53 to assign to the health check:

* * @public */ InsufficientDataHealthStatus?: InsufficientDataHealthStatus | undefined; /** *

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller * routing control.

*

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

* @public */ RoutingControlArn?: string | undefined; } /** *

A complex type that contains the health check request information.

* @public */ export interface CreateHealthCheckRequest { /** *

A unique string that identifies the request and that allows you to retry a failed * CreateHealthCheck request without the risk of creating two identical * health checks:

* *

Route 53 does not store the CallerReference for a deleted health check indefinitely. * The CallerReference for a deleted health check will be deleted after a number of days.

* @public */ CallerReference: string | undefined; /** *

A complex type that contains settings for a new health check.

* @public */ HealthCheckConfig: HealthCheckConfig | undefined; } /** *

For the metric that the CloudWatch alarm is associated with, a complex type that * contains information about one dimension.

* @public */ export interface Dimension { /** *

For the metric that the CloudWatch alarm is associated with, the name of one * dimension.

* @public */ Name: string | undefined; /** *

For the metric that the CloudWatch alarm is associated with, the value of one * dimension.

* @public */ Value: string | undefined; } /** *

A complex type that contains information about the CloudWatch alarm that Amazon Route * 53 is monitoring for this health check.

* @public */ export interface CloudWatchAlarmConfiguration { /** *

For the metric that the CloudWatch alarm is associated with, the number of periods * that the metric is compared to the threshold.

* @public */ EvaluationPeriods: number | undefined; /** *

For the metric that the CloudWatch alarm is associated with, the value the metric is * compared with.

* @public */ Threshold: number | undefined; /** *

For the metric that the CloudWatch alarm is associated with, the arithmetic operation * that is used for the comparison.

* @public */ ComparisonOperator: ComparisonOperator | undefined; /** *

For the metric that the CloudWatch alarm is associated with, the duration of one * evaluation period in seconds.

* @public */ Period: number | undefined; /** *

The name of the CloudWatch metric that the alarm is associated with.

* @public */ MetricName: string | undefined; /** *

The namespace of the metric that the alarm is associated with. For more information, * see Amazon * CloudWatch Namespaces, Dimensions, and Metrics Reference in the * Amazon CloudWatch User Guide.

* @public */ Namespace: string | undefined; /** *

For the metric that the CloudWatch alarm is associated with, the statistic that is * applied to the metric.

* @public */ Statistic: Statistic | undefined; /** *

For the metric that the CloudWatch alarm is associated with, a complex type that * contains information about the dimensions for the metric. For information, see Amazon * CloudWatch Namespaces, Dimensions, and Metrics Reference in the * Amazon CloudWatch User Guide.

* @public */ Dimensions?: Dimension[] | undefined; } /** *

If a health check or hosted zone was created by another service, * LinkedService is a complex type that describes the service that created * the resource. When a resource is created by another service, you can't edit or delete it * using Amazon Route 53.

* @public */ export interface LinkedService { /** *

If the health check or hosted zone was created by another service, the service that * created the resource. When a resource is created by another service, you can't edit or * delete it using Amazon Route 53.

* @public */ ServicePrincipal?: string | undefined; /** *

If the health check or hosted zone was created by another service, an optional * description that can be provided by the other service. When a resource is created by * another service, you can't edit or delete it using Amazon Route 53.

* @public */ Description?: string | undefined; } /** *

A complex type that contains information about one health check that is associated * with the current Amazon Web Services account.

* @public */ export interface HealthCheck { /** *

The identifier that Amazon Route 53 assigned to the health check when you created it. * When you add or update a resource record set, you use this value to specify which health * check to use. The value can be up to 64 characters long.

* @public */ Id: string | undefined; /** *

A unique string that you specified when you created the health check.

* @public */ CallerReference: string | undefined; /** *

If the health check was created by another service, the service that created the * health check. When a health check is created by another service, you can't edit or * delete it using Amazon Route 53.

* @public */ LinkedService?: LinkedService | undefined; /** *

A complex type that contains detailed information about one health check.

* @public */ HealthCheckConfig: HealthCheckConfig | undefined; /** *

The version of the health check. You can optionally pass this value in a call to * UpdateHealthCheck to prevent overwriting another change to the health * check.

* @public */ HealthCheckVersion: number | undefined; /** *

A complex type that contains information about the CloudWatch alarm that Amazon Route * 53 is monitoring for this health check.

* @public */ CloudWatchAlarmConfiguration?: CloudWatchAlarmConfiguration | undefined; } /** *

A complex type containing the response information for the new health check.

* @public */ export interface CreateHealthCheckResponse { /** *

A complex type that contains identifying information about the health check.

* @public */ HealthCheck: HealthCheck | undefined; /** *

The unique URL representing the new health check.

* @public */ Location: string | undefined; } /** *

A complex type that contains an optional comment about your hosted zone. If you don't * want to specify a comment, omit both the HostedZoneConfig and * Comment elements.

* @public */ export interface HostedZoneConfig { /** *

Any comments that you want to include about the hosted zone.

* @public */ Comment?: string | undefined; /** *

A value that indicates whether this is a private hosted zone.

* @public */ PrivateZone?: boolean | undefined; } /** *

A complex type that contains information about the request to create a public or * private hosted zone.

* @public */ export interface CreateHostedZoneRequest { /** *

The name of the domain. Specify a fully qualified domain name, for example, * www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that * Route 53 treats www.example.com (without a trailing * dot) and www.example.com. (with a trailing dot) as * identical.

*

If you're creating a public hosted zone, this is the name you have registered with * your DNS registrar. If your domain name is registered with a registrar other than * Route 53, change the name servers for your domain to the set of * NameServers that CreateHostedZone returns in * DelegationSet.

* @public */ Name: string | undefined; /** *

(Private hosted zones only) A complex type that contains information about the Amazon * VPC that you're associating with this hosted zone.

*

You can specify only one Amazon VPC when you create a private hosted zone. If you are * associating a VPC with a hosted zone with this request, the paramaters * VPCId and VPCRegion are also required.

*

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

* @public */ VPC?: VPC | undefined; /** *

A unique string that identifies the request and that allows failed * CreateHostedZone requests to be retried without the risk of executing * the operation twice. You must use a unique CallerReference string every * time you submit a CreateHostedZone request. CallerReference * can be any unique string, for example, a date/time stamp.

* @public */ CallerReference: string | undefined; /** *

(Optional) A complex type that contains the following optional values:

* *

If you don't specify a comment or the PrivateZone element, omit * HostedZoneConfig and the other elements.

* @public */ HostedZoneConfig?: HostedZoneConfig | undefined; /** *

If you want to associate a reusable delegation set with this hosted zone, the ID that * Amazon Route 53 assigned to the reusable delegation set when you created it. * For more information about reusable delegation sets, see CreateReusableDelegationSet.

*

If you are using a reusable delegation set to create a public hosted zone for a subdomain, * make sure that the parent hosted zone doesn't use one or more of the same name servers. * If you have overlapping nameservers, the operation will cause a * ConflictingDomainsExist error.

* @public */ DelegationSetId?: string | undefined; } /** *

A complex type that lists the name servers in a delegation set, as well as the * CallerReference and the ID for the delegation set.

* @public */ export interface DelegationSet { /** *

The ID that Amazon Route 53 assigns to a reusable delegation set.

* @public */ Id?: string | undefined; /** *

The value that you specified for CallerReference when you created the * reusable delegation set.

* @public */ CallerReference?: string | undefined; /** *

A complex type that contains a list of the authoritative name servers for a hosted * zone or for a reusable delegation set.

* @public */ NameServers: string[] | undefined; } /** *

Contains information about why certain features failed to be enabled or configured for the hosted zone.

* @public */ export interface HostedZoneFailureReasons { /** *

The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.

* @public */ AcceleratedRecovery?: string | undefined; } /** *

Represents the features configuration for a hosted zone, including the status of various features and any associated failure reasons.

* @public */ export interface HostedZoneFeatures { /** *

The current status of accelerated recovery for the hosted zone.

* @public */ AcceleratedRecoveryStatus?: AcceleratedRecoveryStatus | undefined; /** *

Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

* @public */ FailureReasons?: HostedZoneFailureReasons | undefined; } /** *

A complex type that contains general information about the hosted zone.

* @public */ export interface HostedZone { /** *

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

* @public */ Id: string | undefined; /** *

The name of the domain. For public hosted zones, this is the name that you have * registered with your DNS registrar.

*

For information about how to specify characters other than a-z, * 0-9, and - (hyphen) and how to specify internationalized * domain names, see CreateHostedZone.

* @public */ Name: string | undefined; /** *

The value that you specified for CallerReference when you created the * hosted zone.

* @public */ CallerReference: string | undefined; /** *

A complex type that includes the Comment and PrivateZone * elements. If you omitted the HostedZoneConfig and Comment * elements from the request, the Config and Comment elements * don't appear in the response.

* @public */ Config?: HostedZoneConfig | undefined; /** *

The number of resource record sets in the hosted zone.

* @public */ ResourceRecordSetCount?: number | undefined; /** *

If the hosted zone was created by another service, the service that created the hosted * zone. When a hosted zone is created by another service, you can't edit or delete it * using Route 53.

* @public */ LinkedService?: LinkedService | undefined; /** *

The features configuration for the hosted zone, including accelerated recovery settings and status information.

* @public */ Features?: HostedZoneFeatures | undefined; } /** *

A complex type containing the response information for the hosted zone.

* @public */ export interface CreateHostedZoneResponse { /** *

A complex type that contains general information about the hosted zone.

* @public */ HostedZone: HostedZone | undefined; /** *

A complex type that contains information about the CreateHostedZone * request.

* @public */ ChangeInfo: ChangeInfo | undefined; /** *

A complex type that describes the name servers for this hosted zone.

* @public */ DelegationSet: DelegationSet | undefined; /** *

A complex type that contains information about an Amazon VPC that you associated with * this hosted zone.

* @public */ VPC?: VPC | undefined; /** *

The unique URL representing the new hosted zone.

* @public */ Location: string | undefined; } /** * @public */ export interface CreateKeySigningKeyRequest { /** *

A unique string that identifies the request.

* @public */ CallerReference: string | undefined; /** *

The unique string (ID) used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

The Amazon resource name (ARN) for a customer managed key in Key Management Service * (KMS). The KeyManagementServiceArn must be unique for * each key-signing key (KSK) in a single hosted zone. To see an example of * KeyManagementServiceArn that grants the correct permissions for DNSSEC, * scroll down to Example.

*

You must configure the customer managed customer managed key as follows:

*
*
Status
*
*

Enabled

*
*
Key spec
*
*

ECC_NIST_P256

*
*
Key usage
*
*

Sign and verify

*
*
Key policy
*
*

The key policy must give permission for the following actions:

* *

The key policy must also include the Amazon Route 53 service in the * principal for your account. Specify the following:

* *
*
*

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

* @public */ KeyManagementServiceArn: string | undefined; /** *

A string used to identify a key-signing key (KSK). Name can include * numbers, letters, and underscores (_). Name must be unique for each * key-signing key in the same hosted zone.

* @public */ Name: string | undefined; /** *

A string specifying the initial status of the key-signing key (KSK). You can set the * value to ACTIVE or INACTIVE.

* @public */ Status: string | undefined; } /** *

A key-signing key (KSK) is a complex type that represents a public/private key pair. * The private key is used to generate a digital signature for the zone signing key (ZSK). * The public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always * associated with a hosted zone; it cannot exist by itself.

* @public */ export interface KeySigningKey { /** *

A string used to identify a key-signing key (KSK). Name can include * numbers, letters, and underscores (_). Name must be unique for each * key-signing key in the same hosted zone.

* @public */ Name?: string | undefined; /** *

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each * key-signing key (KSK) in a single hosted zone.

*

You must configure the customer managed key as follows:

*
*
Status
*
*

Enabled

*
*
Key spec
*
*

ECC_NIST_P256

*
*
Key usage
*
*

Sign and verify

*
*
Key policy
*
*

The key policy must give permission for the following actions:

* *

The key policy must also include the Amazon Route 53 service in the * principal for your account. Specify the following:

* *
*
*

For more information about working with the customer managed key in KMS, see Key Management Service * concepts.

* @public */ KmsArn?: string | undefined; /** *

An integer that specifies how the key is used. For key-signing key (KSK), this value * is always 257.

* @public */ Flag?: number | undefined; /** *

A string used to represent the signing algorithm. This value must follow the * guidelines provided by RFC-8624 Section 3.1.

* @public */ SigningAlgorithmMnemonic?: string | undefined; /** *

An integer used to represent the signing algorithm. This value must follow the * guidelines provided by RFC-8624 Section 3.1.

* @public */ SigningAlgorithmType?: number | undefined; /** *

A string used to represent the delegation signer digest algorithm. This value must * follow the guidelines provided by RFC-8624 Section 3.3. *

* @public */ DigestAlgorithmMnemonic?: string | undefined; /** *

An integer used to represent the delegation signer digest algorithm. This value must * follow the guidelines provided by RFC-8624 Section * 3.3.

* @public */ DigestAlgorithmType?: number | undefined; /** *

An integer used to identify the DNSSEC record for the domain name. The process used to * calculate the value is described in RFC-4034 Appendix B.

* @public */ KeyTag?: number | undefined; /** *

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to * publish the public key that resolvers can use to verify DNSSEC signatures that are used * to secure certain kinds of information provided by the DNS system.

* @public */ DigestValue?: string | undefined; /** *

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

* @public */ PublicKey?: string | undefined; /** *

A string that represents a delegation signer (DS) record.

* @public */ DSRecord?: string | undefined; /** *

A string that represents a DNSKEY record.

* @public */ DNSKEYRecord?: string | undefined; /** *

A string that represents the current key-signing key (KSK) status.

*

Status can have one of the following values:

*
*
ACTIVE
*
*

The KSK is being used for signing.

*
*
INACTIVE
*
*

The KSK is not being used for signing.

*
*
DELETING
*
*

The KSK is in the process of being deleted.

*
*
ACTION_NEEDED
*
*

There is a problem with the KSK that requires you to take action to * resolve. For example, the customer managed key might have been deleted, * or the permissions for the customer managed key might have been * changed.

*
*
INTERNAL_FAILURE
*
*

There was an error during a request. Before you can continue to work with * DNSSEC signing, including actions that involve this KSK, you must correct * the problem. For example, you may need to activate or deactivate the * KSK.

*
*
* @public */ Status?: string | undefined; /** *

The status message provided for the following key-signing key (KSK) statuses: * ACTION_NEEDED or INTERNAL_FAILURE. The status message * includes information about what the problem might be and steps that you can take to * correct the issue.

* @public */ StatusMessage?: string | undefined; /** *

The date when the key-signing key (KSK) was created.

* @public */ CreatedDate?: Date | undefined; /** *

The last time that the key-signing key (KSK) was changed.

* @public */ LastModifiedDate?: Date | undefined; } /** * @public */ export interface CreateKeySigningKeyResponse { /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; /** *

The key-signing key (KSK) that the request creates.

* @public */ KeySigningKey: KeySigningKey | undefined; /** *

The unique URL representing the new key-signing key (KSK).

* @public */ Location: string | undefined; } /** * @public */ export interface CreateQueryLoggingConfigRequest { /** *

The ID of the hosted zone that you want to log queries for. You can log queries only * for public hosted zones.

* @public */ HostedZoneId: string | undefined; /** *

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to * send query logs to. This is the format of the ARN:

*

arn:aws:logs:region:account-id:log-group:log_group_name *

*

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups * command, or the applicable command in one of the Amazon Web Services SDKs.

* @public */ CloudWatchLogsLogGroupArn: string | undefined; } /** *

A complex type that contains information about a configuration for DNS query * logging.

* @public */ export interface QueryLoggingConfig { /** *

The ID for a configuration for DNS query logging.

* @public */ Id: string | undefined; /** *

The ID of the hosted zone that CloudWatch Logs is logging queries for.

* @public */ HostedZoneId: string | undefined; /** *

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 * is publishing logs to.

* @public */ CloudWatchLogsLogGroupArn: string | undefined; } /** * @public */ export interface CreateQueryLoggingConfigResponse { /** *

A complex type that contains the ID for a query logging configuration, the ID of the * hosted zone that you want to log queries for, and the ARN for the log group that you * want Amazon Route 53 to send query logs to.

* @public */ QueryLoggingConfig: QueryLoggingConfig | undefined; /** *

The unique URL representing the new query logging configuration.

* @public */ Location: string | undefined; } /** * @public */ export interface CreateReusableDelegationSetRequest { /** *

A unique string that identifies the request, and that allows you to retry failed * CreateReusableDelegationSet requests without the risk of executing the * operation twice. You must use a unique CallerReference string every time * you submit a CreateReusableDelegationSet request. * CallerReference can be any unique string, for example a date/time * stamp.

* @public */ CallerReference: string | undefined; /** *

If you want to mark the delegation set for an existing hosted zone as reusable, the ID * for that hosted zone.

* @public */ HostedZoneId?: string | undefined; } /** * @public */ export interface CreateReusableDelegationSetResponse { /** *

A complex type that contains name server information.

* @public */ DelegationSet: DelegationSet | undefined; /** *

The unique URL representing the new reusable delegation set.

* @public */ Location: string | undefined; } /** *

A complex type that contains information about the traffic policy that you want to * create.

* @public */ export interface CreateTrafficPolicyRequest { /** *

The name of the traffic policy.

* @public */ Name: string | undefined; /** *

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

* @public */ Document: string | undefined; /** *

(Optional) Any comments that you want to include about the traffic policy.

* @public */ Comment?: string | undefined; } /** *

A complex type that contains settings for a traffic policy.

* @public */ export interface TrafficPolicy { /** *

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

* @public */ Id: string | undefined; /** *

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic * policy, the value of Version is always 1.

* @public */ Version: number | undefined; /** *

The name that you specified when you created the traffic policy.

* @public */ Name: string | undefined; /** *

The DNS type of the resource record sets that Amazon Route 53 creates when you use a * traffic policy to create a traffic policy instance.

* @public */ Type: RRType | undefined; /** *

The definition of a traffic policy in JSON format. You specify the JSON document to * use for a new traffic policy in the CreateTrafficPolicy request. For more * information about the JSON format, see Traffic Policy Document Format.

* @public */ Document: string | undefined; /** *

The comment that you specify in the CreateTrafficPolicy request, if * any.

* @public */ Comment?: string | undefined; } /** *

A complex type that contains the response information for the * CreateTrafficPolicy request.

* @public */ export interface CreateTrafficPolicyResponse { /** *

A complex type that contains settings for the new traffic policy.

* @public */ TrafficPolicy: TrafficPolicy | undefined; /** *

A unique URL that represents a new traffic policy.

* @public */ Location: string | undefined; } /** *

A complex type that contains information about the resource record sets that you want * to create based on a specified traffic policy.

* @public */ export interface CreateTrafficPolicyInstanceRequest { /** *

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets * in by using the configuration in a traffic policy.

* @public */ HostedZoneId: string | undefined; /** *

The domain name (such as example.com) or subdomain name (such as www.example.com) for * which Amazon Route 53 responds to DNS queries by using the resource record sets that * Route 53 creates for this traffic policy instance.

* @public */ Name: string | undefined; /** *

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource * record sets that it creates in the specified hosted zone.

* @public */ TTL: number | undefined; /** *

The ID of the traffic policy that you want to use to create resource record sets in * the specified hosted zone.

* @public */ TrafficPolicyId: string | undefined; /** *

The version of the traffic policy that you want to use to create resource record sets * in the specified hosted zone.

* @public */ TrafficPolicyVersion: number | undefined; } /** *

A complex type that contains settings for the new traffic policy instance.

* @public */ export interface TrafficPolicyInstance { /** *

The ID that Amazon Route 53 assigned to the new traffic policy instance.

* @public */ Id: string | undefined; /** *

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

* @public */ HostedZoneId: string | undefined; /** *

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries * by using the resource record sets that are associated with this traffic policy instance. *

* @public */ Name: string | undefined; /** *

The TTL that Amazon Route 53 assigned to all of the resource record sets that it * created in the specified hosted zone.

* @public */ TTL: number | undefined; /** *

The value of State is one of the following values:

*
*
Applied
*
*

Amazon Route 53 has finished creating resource record sets, and changes * have propagated to all Route 53 edge locations.

*
*
Creating
*
*

Route 53 is creating the resource record sets. Use * GetTrafficPolicyInstance to confirm that the * CreateTrafficPolicyInstance request completed * successfully.

*
*
Failed
*
*

Route 53 wasn't able to create or update the resource record sets. When * the value of State is Failed, see * Message for an explanation of what caused the request to * fail.

*
*
* @public */ State: string | undefined; /** *

If State is Failed, an explanation of the reason for the * failure. If State is another value, Message is empty.

* @public */ Message: string | undefined; /** *

The ID of the traffic policy that Amazon Route 53 used to create resource record sets * in the specified hosted zone.

* @public */ TrafficPolicyId: string | undefined; /** *

The version of the traffic policy that Amazon Route 53 used to create resource record * sets in the specified hosted zone.

* @public */ TrafficPolicyVersion: number | undefined; /** *

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it * created for this traffic policy instance.

* @public */ TrafficPolicyType: RRType | undefined; } /** *

A complex type that contains the response information for the * CreateTrafficPolicyInstance request.

* @public */ export interface CreateTrafficPolicyInstanceResponse { /** *

A complex type that contains settings for the new traffic policy instance.

* @public */ TrafficPolicyInstance: TrafficPolicyInstance | undefined; /** *

A unique URL that represents a new traffic policy instance.

* @public */ Location: string | undefined; } /** *

A complex type that contains information about the traffic policy that you want to * create a new version for.

* @public */ export interface CreateTrafficPolicyVersionRequest { /** *

The ID of the traffic policy for which you want to create a new version.

* @public */ Id: string | undefined; /** *

The definition of this version of the traffic policy, in JSON format. You specified * the JSON in the CreateTrafficPolicyVersion request. For more information * about the JSON format, see CreateTrafficPolicy.

* @public */ Document: string | undefined; /** *

The comment that you specified in the CreateTrafficPolicyVersion request, * if any.

* @public */ Comment?: string | undefined; } /** *

A complex type that contains the response information for the * CreateTrafficPolicyVersion request.

* @public */ export interface CreateTrafficPolicyVersionResponse { /** *

A complex type that contains settings for the new version of the traffic * policy.

* @public */ TrafficPolicy: TrafficPolicy | undefined; /** *

A unique URL that represents a new traffic policy version.

* @public */ Location: string | undefined; } /** *

A complex type that contains information about the request to authorize associating a * VPC with your private hosted zone. Authorization is only required when a private hosted * zone and a VPC were created by using different accounts.

* @public */ export interface CreateVPCAssociationAuthorizationRequest { /** *

The ID of the private hosted zone that you want to authorize associating a VPC * with.

* @public */ HostedZoneId: string | undefined; /** *

A complex type that contains the VPC ID and region for the VPC that you want to * authorize associating with your hosted zone.

* @public */ VPC: VPC | undefined; } /** *

A complex type that contains the response information from a * CreateVPCAssociationAuthorization request.

* @public */ export interface CreateVPCAssociationAuthorizationResponse { /** *

The ID of the hosted zone that you authorized associating a VPC with.

* @public */ HostedZoneId: string | undefined; /** *

The VPC that you authorized associating with a hosted zone.

* @public */ VPC: VPC | undefined; } /** * @public */ export interface DeactivateKeySigningKeyRequest { /** *

A unique string used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

A string used to identify a key-signing key (KSK).

* @public */ Name: string | undefined; } /** * @public */ export interface DeactivateKeySigningKeyResponse { /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** * @public */ export interface DeleteCidrCollectionRequest { /** *

The UUID of the collection to delete.

* @public */ Id: string | undefined; } /** * @public */ export interface DeleteCidrCollectionResponse { } /** *

This action deletes a health check.

* @public */ export interface DeleteHealthCheckRequest { /** *

The ID of the health check that you want to delete.

* @public */ HealthCheckId: string | undefined; } /** *

An empty element.

* @public */ export interface DeleteHealthCheckResponse { } /** *

A request to delete a hosted zone.

* @public */ export interface DeleteHostedZoneRequest { /** *

The ID of the hosted zone you want to delete.

* @public */ Id: string | undefined; } /** *

A complex type that contains the response to a DeleteHostedZone * request.

* @public */ export interface DeleteHostedZoneResponse { /** *

A complex type that contains the ID, the status, and the date and time of a request to * delete a hosted zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** * @public */ export interface DeleteKeySigningKeyRequest { /** *

A unique string used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

A string used to identify a key-signing key (KSK).

* @public */ Name: string | undefined; } /** * @public */ export interface DeleteKeySigningKeyResponse { /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** * @public */ export interface DeleteQueryLoggingConfigRequest { /** *

The ID of the configuration that you want to delete.

* @public */ Id: string | undefined; } /** * @public */ export interface DeleteQueryLoggingConfigResponse { } /** *

A request to delete a reusable delegation set.

* @public */ export interface DeleteReusableDelegationSetRequest { /** *

The ID of the reusable delegation set that you want to delete.

* @public */ Id: string | undefined; } /** *

An empty element.

* @public */ export interface DeleteReusableDelegationSetResponse { } /** *

A request to delete a specified traffic policy version.

* @public */ export interface DeleteTrafficPolicyRequest { /** *

The ID of the traffic policy that you want to delete.

* @public */ Id: string | undefined; /** *

The version number of the traffic policy that you want to delete.

* @public */ Version: number | undefined; } /** *

An empty element.

* @public */ export interface DeleteTrafficPolicyResponse { } /** *

A request to delete a specified traffic policy instance.

* @public */ export interface DeleteTrafficPolicyInstanceRequest { /** *

The ID of the traffic policy instance that you want to delete.

* *

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the * resource record sets that were created when you created the traffic policy * instance.

* * @public */ Id: string | undefined; } /** *

An empty element.

* @public */ export interface DeleteTrafficPolicyInstanceResponse { } /** *

A complex type that contains information about the request to remove authorization to * associate a VPC that was created by one Amazon Web Services account with a hosted zone * that was created with a different Amazon Web Services account.

* @public */ export interface DeleteVPCAssociationAuthorizationRequest { /** *

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the * VPC.

* @public */ VPC: VPC | undefined; } /** *

Empty response for the request.

* @public */ export interface DeleteVPCAssociationAuthorizationResponse { } /** * @public */ export interface DisableHostedZoneDNSSECRequest { /** *

A unique string used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; } /** * @public */ export interface DisableHostedZoneDNSSECResponse { /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** *

A complex type that contains information about the VPC that you want to disassociate * from a specified private hosted zone.

* @public */ export interface DisassociateVPCFromHostedZoneRequest { /** *

The ID of the private hosted zone that you want to disassociate a VPC from.

* @public */ HostedZoneId: string | undefined; /** *

A complex type that contains information about the VPC that you're disassociating from * the specified hosted zone.

* @public */ VPC: VPC | undefined; /** *

* Optional: A comment about the disassociation request.

* @public */ Comment?: string | undefined; } /** *

A complex type that contains the response information for the disassociate * request.

* @public */ export interface DisassociateVPCFromHostedZoneResponse { /** *

A complex type that describes the changes made to the specified private hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** * @public */ export interface EnableHostedZoneDNSSECRequest { /** *

A unique string used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; } /** * @public */ export interface EnableHostedZoneDNSSECResponse { /** *

A complex type that describes change information about changes made to your hosted * zone.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** *

A complex type that contains information about the request to create a hosted * zone.

* @public */ export interface GetAccountLimitRequest { /** *

The limit that you want to get. Valid values include the following:

* * @public */ Type: AccountLimitType | undefined; } /** *

A complex type that contains the requested limit.

* @public */ export interface GetAccountLimitResponse { /** *

The current setting for the specified limit. For example, if you specified * MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the * request, the value of Limit is the maximum number of health checks that you * can create using the current account.

* @public */ Limit: AccountLimit | undefined; /** *

The current number of entities that you have created of the specified type. For * example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of * Type in the request, the value of Count is the current * number of health checks that you have created using the current account.

* @public */ Count: number | undefined; } /** *

The input for a GetChange request.

* @public */ export interface GetChangeRequest { /** *

The ID of the change batch request. The value that you specify here is the value that * ChangeResourceRecordSets returned in the Id element when * you submitted the request.

* @public */ Id: string | undefined; } /** *

A complex type that contains the ChangeInfo element.

* @public */ export interface GetChangeResponse { /** *

A complex type that contains information about the specified change batch.

* @public */ ChangeInfo: ChangeInfo | undefined; } /** *

Empty request.

* @public */ export interface GetCheckerIpRangesRequest { } /** *

A complex type that contains the CheckerIpRanges element.

* @public */ export interface GetCheckerIpRangesResponse { /** *

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route * 53 health checkers.

* @public */ CheckerIpRanges: string[] | undefined; } /** * @public */ export interface GetDNSSECRequest { /** *

A unique string used to identify a hosted zone.

* @public */ HostedZoneId: string | undefined; } /** *

A string representing the status of DNSSEC signing.

* @public */ export interface DNSSECStatus { /** *

A string that represents the current hosted zone signing status.

*

Status can have one of the following values:

*
*
SIGNING
*
*

DNSSEC signing is enabled for the hosted zone.

*
*
NOT_SIGNING
*
*

DNSSEC signing is not enabled for the hosted zone.

*
*
DELETING
*
*

DNSSEC signing is in the process of being removed for the hosted * zone.

*
*
ACTION_NEEDED
*
*

There is a problem with signing in the hosted zone that requires you to * take action to resolve. For example, the customer managed key might have * been deleted, or the permissions for the customer managed key might have * been changed.

*
*
INTERNAL_FAILURE
*
*

There was an error during a request. Before you can continue to work with * DNSSEC signing, including with key-signing keys (KSKs), you must correct the * problem by enabling or disabling DNSSEC signing for the hosted zone.

*
*
* @public */ ServeSignature?: string | undefined; /** *

The status message provided for the following DNSSEC signing status: * INTERNAL_FAILURE. The status message includes information about what * the problem might be and steps that you can take to correct the issue.

* @public */ StatusMessage?: string | undefined; } /** * @public */ export interface GetDNSSECResponse { /** *

A string representing the status of DNSSEC.

* @public */ Status: DNSSECStatus | undefined; /** *

The key-signing keys (KSKs) in your account.

* @public */ KeySigningKeys: KeySigningKey[] | undefined; } /** *

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

* @public */ export interface GetGeoLocationRequest { /** *

For geolocation resource record sets, a two-letter abbreviation that identifies a * continent. Amazon Route 53 supports the following continent codes:

* * @public */ ContinentCode?: string | undefined; /** *

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 * alpha-2.

*

Route 53 also supports the country code UA for * Ukraine.

* @public */ CountryCode?: string | undefined; /** *

The code for the subdivision, such as a particular state within the United States. For * a list of US state abbreviations, see Appendix B: Two–Letter State and * Possession Abbreviations on the United States Postal Service website. For a * list of all supported subdivision codes, use the ListGeoLocations * API.

* @public */ SubdivisionCode?: string | undefined; } /** *

A complex type that contains the codes and full continent, country, and subdivision * names for the specified geolocation code.

* @public */ export interface GeoLocationDetails { /** *

The two-letter code for the continent.

* @public */ ContinentCode?: string | undefined; /** *

The full name of the continent.

* @public */ ContinentName?: string | undefined; /** *

The two-letter code for the country.

* @public */ CountryCode?: string | undefined; /** *

The name of the country.

* @public */ CountryName?: string | undefined; /** *

The code for the subdivision, such as a particular state within the United States. For * a list of US state abbreviations, see Appendix B: Two–Letter State and * Possession Abbreviations on the United States Postal Service website. For a * list of all supported subdivision codes, use the ListGeoLocations * API.

* @public */ SubdivisionCode?: string | undefined; /** *

The full name of the subdivision. Route 53 currently supports only states in the * United States.

* @public */ SubdivisionName?: string | undefined; } /** *

A complex type that contains the response information for the specified geolocation * code.

* @public */ export interface GetGeoLocationResponse { /** *

A complex type that contains the codes and full continent, country, and subdivision * names for the specified geolocation code.

* @public */ GeoLocationDetails: GeoLocationDetails | undefined; } /** *

A request to get information about a specified health check.

* @public */ export interface GetHealthCheckRequest { /** *

The identifier that Amazon Route 53 assigned to the health check when you created it. * When you add or update a resource record set, you use this value to specify which health * check to use. The value can be up to 64 characters long.

* @public */ HealthCheckId: string | undefined; } /** *

A complex type that contains the response to a GetHealthCheck * request.

* @public */ export interface GetHealthCheckResponse { /** *

A complex type that contains information about one health check that is associated * with the current Amazon Web Services account.

* @public */ HealthCheck: HealthCheck | undefined; } /** *

A request for the number of health checks that are associated with the current Amazon Web Services account.

* @public */ export interface GetHealthCheckCountRequest { } /** *

A complex type that contains the response to a GetHealthCheckCount * request.

* @public */ export interface GetHealthCheckCountResponse { /** *

The number of health checks associated with the current Amazon Web Services account.

* @public */ HealthCheckCount: number | undefined; } /** *

A request for the reason that a health check failed most recently.

* @public */ export interface GetHealthCheckLastFailureReasonRequest { /** *

The ID for the health check for which you want the last failure reason. When you * created the health check, CreateHealthCheck returned the ID in the * response, in the HealthCheckId element.

* *

If you want to get the last failure reason for a calculated health check, you must * use the Amazon Route 53 console or the CloudWatch console. You can't use * GetHealthCheckLastFailureReason for a calculated health * check.

* * @public */ HealthCheckId: string | undefined; } /** *

A complex type that contains the status that one Amazon Route 53 health checker * reports and the time of the health check.

* @public */ export interface StatusReport { /** *

A description of the status of the health check endpoint as reported by one of the * Amazon Route 53 health checkers.

* @public */ Status?: string | undefined; /** *

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated * Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z * represents March 27, 2017 at 17:48:16.751 UTC.

* @public */ CheckedTime?: Date | undefined; } /** *

A complex type that contains the last failure reason as reported by one Amazon Route * 53 health checker.

* @public */ export interface HealthCheckObservation { /** *

The region of the Amazon Route 53 health checker that provided the status in * StatusReport.

* @public */ Region?: HealthCheckRegion | undefined; /** *

The IP address of the Amazon Route 53 health checker that provided the failure reason * in StatusReport.

* @public */ IPAddress?: string | undefined; /** *

A complex type that contains the last failure reason as reported by one Amazon Route * 53 health checker and the time of the failed health check.

* @public */ StatusReport?: StatusReport | undefined; } /** *

A complex type that contains the response to a * GetHealthCheckLastFailureReason request.

* @public */ export interface GetHealthCheckLastFailureReasonResponse { /** *

A list that contains one Observation element for each Amazon Route 53 * health checker that is reporting a last failure reason.

* @public */ HealthCheckObservations: HealthCheckObservation[] | undefined; } /** *

A request to get the status for a health check.

* @public */ export interface GetHealthCheckStatusRequest { /** *

The ID for the health check that you want the current status for. When you created the * health check, CreateHealthCheck returned the ID in the response, in the * HealthCheckId element.

* *

If you want to check the status of a calculated health check, you must use the * Amazon Route 53 console or the CloudWatch console. You can't use * GetHealthCheckStatus to get the status of a calculated health * check.

* * @public */ HealthCheckId: string | undefined; } /** *

A complex type that contains the response to a GetHealthCheck * request.

* @public */ export interface GetHealthCheckStatusResponse { /** *

A list that contains one HealthCheckObservation element for each Amazon * Route 53 health checker that is reporting a status about the health check * endpoint.

* @public */ HealthCheckObservations: HealthCheckObservation[] | undefined; } /** *

A request to get information about a specified hosted zone.

* @public */ export interface GetHostedZoneRequest { /** *

The ID of the hosted zone that you want to get information about.

* @public */ Id: string | undefined; } /** *

A complex type that contain the response to a GetHostedZone * request.

* @public */ export interface GetHostedZoneResponse { /** *

A complex type that contains general information about the specified hosted * zone.

* @public */ HostedZone: HostedZone | undefined; /** *

A complex type that lists the Amazon Route 53 name servers for the specified hosted * zone.

* @public */ DelegationSet?: DelegationSet | undefined; /** *

A complex type that contains information about the VPCs that are associated with the * specified hosted zone.

* @public */ VPCs?: VPC[] | undefined; } /** *

A request to retrieve a count of all the hosted zones that are associated with the * current Amazon Web Services account.

* @public */ export interface GetHostedZoneCountRequest { } /** *

A complex type that contains the response to a GetHostedZoneCount * request.

* @public */ export interface GetHostedZoneCountResponse { /** *

The total number of public and private hosted zones that are associated with the * current Amazon Web Services account.

* @public */ HostedZoneCount: number | undefined; } /** *

A complex type that contains information about the request to create a hosted * zone.

* @public */ export interface GetHostedZoneLimitRequest { /** *

The limit that you want to get. Valid values include the following:

* * @public */ Type: HostedZoneLimitType | undefined; /** *

The ID of the hosted zone that you want to get a limit for.

* @public */ HostedZoneId: string | undefined; } /** *

A complex type that contains the type of limit that you specified in the request and * the current value for that limit.

* @public */ export interface HostedZoneLimit { /** *

The limit that you requested. Valid values include the following:

* * @public */ Type: HostedZoneLimitType | undefined; /** *

The current value for the limit that is specified by Type.

* @public */ Value: number | undefined; } /** *

A complex type that contains the requested limit.

* @public */ export interface GetHostedZoneLimitResponse { /** *

The current setting for the specified limit. For example, if you specified * MAX_RRSETS_BY_ZONE for the value of Type in the request, * the value of Limit is the maximum number of records that you can create in * the specified hosted zone.

* @public */ Limit: HostedZoneLimit | undefined; /** *

The current number of entities that you have created of the specified type. For * example, if you specified MAX_RRSETS_BY_ZONE for the value of * Type in the request, the value of Count is the current * number of records that you have created in the specified hosted zone.

* @public */ Count: number | undefined; } /** * @public */ export interface GetQueryLoggingConfigRequest { /** *

The ID of the configuration for DNS query logging that you want to get information * about.

* @public */ Id: string | undefined; } /** * @public */ export interface GetQueryLoggingConfigResponse { /** *

A complex type that contains information about the query logging configuration that * you specified in a GetQueryLoggingConfig request.

* @public */ QueryLoggingConfig: QueryLoggingConfig | undefined; } /** *

A request to get information about a specified reusable delegation set.

* @public */ export interface GetReusableDelegationSetRequest { /** *

The ID of the reusable delegation set that you want to get a list of name servers * for.

* @public */ Id: string | undefined; } /** *

A complex type that contains the response to the GetReusableDelegationSet * request.

* @public */ export interface GetReusableDelegationSetResponse { /** *

A complex type that contains information about the reusable delegation set.

* @public */ DelegationSet: DelegationSet | undefined; } /** *

A complex type that contains information about the request to create a hosted * zone.

* @public */ export interface GetReusableDelegationSetLimitRequest { /** *

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of * hosted zones that you can associate with the specified reusable delegation set.

* @public */ Type: ReusableDelegationSetLimitType | undefined; /** *

The ID of the delegation set that you want to get the limit for.

* @public */ DelegationSetId: string | undefined; } /** *

A complex type that contains the type of limit that you specified in the request and * the current value for that limit.

* @public */ export interface ReusableDelegationSetLimit { /** *

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the * maximum number of hosted zones that you can associate with the specified reusable * delegation set.

* @public */ Type: ReusableDelegationSetLimitType | undefined; /** *

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET * limit.

* @public */ Value: number | undefined; } /** *

A complex type that contains the requested limit.

* @public */ export interface GetReusableDelegationSetLimitResponse { /** *

The current setting for the limit on hosted zones that you can associate with the * specified reusable delegation set.

* @public */ Limit: ReusableDelegationSetLimit | undefined; /** *

The current number of hosted zones that you can associate with the specified reusable * delegation set.

* @public */ Count: number | undefined; } /** *

Gets information about a specific traffic policy version.

* @public */ export interface GetTrafficPolicyRequest { /** *

The ID of the traffic policy that you want to get information about.

* @public */ Id: string | undefined; /** *

The version number of the traffic policy that you want to get information * about.

* @public */ Version: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface GetTrafficPolicyResponse { /** *

A complex type that contains settings for the specified traffic policy.

* @public */ TrafficPolicy: TrafficPolicy | undefined; } /** *

Gets information about a specified traffic policy instance.

* @public */ export interface GetTrafficPolicyInstanceRequest { /** *

The ID of the traffic policy instance that you want to get information about.

* @public */ Id: string | undefined; } /** *

A complex type that contains information about the resource record sets that Amazon * Route 53 created based on a specified traffic policy.

* @public */ export interface GetTrafficPolicyInstanceResponse { /** *

A complex type that contains settings for the traffic policy instance.

* @public */ TrafficPolicyInstance: TrafficPolicyInstance | undefined; } /** *

Request to get the number of traffic policy instances that are associated with the * current Amazon Web Services account.

* @public */ export interface GetTrafficPolicyInstanceCountRequest { } /** *

A complex type that contains information about the resource record sets that Amazon * Route 53 created based on a specified traffic policy.

* @public */ export interface GetTrafficPolicyInstanceCountResponse { /** *

The number of traffic policy instances that are associated with the current Amazon Web Services account.

* @public */ TrafficPolicyInstanceCount: number | undefined; } /** * @public */ export interface ListCidrBlocksRequest { /** *

The UUID of the CIDR collection.

* @public */ CollectionId: string | undefined; /** *

The name of the CIDR collection location.

* @public */ LocationName?: string | undefined; /** *

An opaque pagination token to indicate where the service is to begin enumerating * results.

* @public */ NextToken?: string | undefined; /** *

Maximum number of results you want returned.

* @public */ MaxResults?: number | undefined; } /** *

A complex type that lists the CIDR blocks.

* @public */ export interface CidrBlockSummary { /** *

Value for the CIDR block.

* @public */ CidrBlock?: string | undefined; /** *

The location name of the CIDR block.

* @public */ LocationName?: string | undefined; } /** * @public */ export interface ListCidrBlocksResponse { /** *

An opaque pagination token to indicate where the service is to begin enumerating * results.

*

If no value is provided, the listing of results starts from the beginning.

* @public */ NextToken?: string | undefined; /** *

A complex type that contains information about the CIDR blocks.

* @public */ CidrBlocks?: CidrBlockSummary[] | undefined; } /** * @public */ export interface ListCidrCollectionsRequest { /** *

An opaque pagination token to indicate where the service is to begin enumerating * results.

*

If no value is provided, the listing of results starts from the beginning.

* @public */ NextToken?: string | undefined; /** *

The maximum number of CIDR collections to return in the response.

* @public */ MaxResults?: number | undefined; } /** *

A complex type that is an entry in an CidrCollection * array.

* @public */ export interface CollectionSummary { /** *

The ARN of the collection summary. Can be used to reference the collection in IAM * policy or cross-account.

* @public */ Arn?: string | undefined; /** *

Unique ID for the CIDR collection.

* @public */ Id?: string | undefined; /** *

The name of a CIDR collection.

* @public */ Name?: string | undefined; /** *

A sequential counter that Route 53 sets to 1 when you create a CIDR * collection and increments by 1 each time you update settings for the CIDR * collection.

* @public */ Version?: number | undefined; } /** * @public */ export interface ListCidrCollectionsResponse { /** *

An opaque pagination token to indicate where the service is to begin enumerating * results.

*

If no value is provided, the listing of results starts from the beginning.

* @public */ NextToken?: string | undefined; /** *

A complex type with information about the CIDR collection.

* @public */ CidrCollections?: CollectionSummary[] | undefined; } /** * @public */ export interface ListCidrLocationsRequest { /** *

The CIDR collection ID.

* @public */ CollectionId: string | undefined; /** *

An opaque pagination token to indicate where the service is to begin enumerating * results.

*

If no value is provided, the listing of results starts from the beginning.

* @public */ NextToken?: string | undefined; /** *

The maximum number of CIDR collection locations to return in the response.

* @public */ MaxResults?: number | undefined; } /** *

A complex type that contains information about the CIDR location.

* @public */ export interface LocationSummary { /** *

A string that specifies a location name.

* @public */ LocationName?: string | undefined; } /** * @public */ export interface ListCidrLocationsResponse { /** *

An opaque pagination token to indicate where the service is to begin enumerating * results.

*

If no value is provided, the listing of results starts from the beginning.

* @public */ NextToken?: string | undefined; /** *

A complex type that contains information about the list of CIDR locations.

* @public */ CidrLocations?: LocationSummary[] | undefined; } /** *

A request to get a list of geographic locations that Amazon Route 53 supports for * geolocation resource record sets.

* @public */ export interface ListGeoLocationsRequest { /** *

The code for the continent with which you want to start listing locations that Amazon * Route 53 supports for geolocation. If Route 53 has already returned a page or more of * results, if IsTruncated is true, and if NextContinentCode from * the previous response has a value, enter that value in startcontinentcode * to return the next page of results.

*

Include startcontinentcode only if you want to list continents. Don't * include startcontinentcode when you're listing countries or countries with * their subdivisions.

* @public */ StartContinentCode?: string | undefined; /** *

The code for the country with which you want to start listing locations that Amazon * Route 53 supports for geolocation. If Route 53 has already returned a page or more of * results, if IsTruncated is true, and if * NextCountryCode from the previous response has a value, enter that * value in startcountrycode to return the next page of results.

* @public */ StartCountryCode?: string | undefined; /** *

The code for the state of the United States with which you want to start listing * locations that Amazon Route 53 supports for geolocation. If Route 53 has already * returned a page or more of results, if IsTruncated is true, * and if NextSubdivisionCode from the previous response has a value, enter * that value in startsubdivisioncode to return the next page of * results.

*

To list subdivisions (U.S. states), you must include both * startcountrycode and startsubdivisioncode.

* @public */ StartSubdivisionCode?: string | undefined; /** *

(Optional) The maximum number of geolocations to be included in the response body for this * request. If more than maxitems geolocations remain to be listed, then the * value of the IsTruncated element in the response is * true.

* @public */ MaxItems?: number | undefined; } /** *

A complex type containing the response information for the request.

* @public */ export interface ListGeoLocationsResponse { /** *

A complex type that contains one GeoLocationDetails element for each * location that Amazon Route 53 supports for geolocation.

* @public */ GeoLocationDetailsList: GeoLocationDetails[] | undefined; /** *

A value that indicates whether more locations remain to be listed after the last * location in this response. If so, the value of IsTruncated is * true. To get more values, submit another request and include the values * of NextContinentCode, NextCountryCode, and * NextSubdivisionCode in the startcontinentcode, * startcountrycode, and startsubdivisioncode, as * applicable.

* @public */ IsTruncated: boolean | undefined; /** *

If IsTruncated is true, you can make a follow-up request to * display more locations. Enter the value of NextContinentCode in the * startcontinentcode parameter in another ListGeoLocations * request.

* @public */ NextContinentCode?: string | undefined; /** *

If IsTruncated is true, you can make a follow-up request to * display more locations. Enter the value of NextCountryCode in the * startcountrycode parameter in another ListGeoLocations * request.

* @public */ NextCountryCode?: string | undefined; /** *

If IsTruncated is true, you can make a follow-up request to * display more locations. Enter the value of NextSubdivisionCode in the * startsubdivisioncode parameter in another ListGeoLocations * request.

* @public */ NextSubdivisionCode?: string | undefined; /** *

The value that you specified for MaxItems in the request.

* @public */ MaxItems: number | undefined; } /** *

A request to retrieve a list of the health checks that are associated with the current * Amazon Web Services account.

* @public */ export interface ListHealthChecksRequest { /** *

If the value of IsTruncated in the previous response was * true, you have more health checks. To get another group, submit another * ListHealthChecks request.

*

For the value of marker, specify the value of NextMarker * from the previous response, which is the ID of the first health check that Amazon Route * 53 will return if you submit another request.

*

If the value of IsTruncated in the previous response was * false, there are no more health checks to get.

* @public */ Marker?: string | undefined; /** *

The maximum number of health checks that you want ListHealthChecks to * return in response to the current request. Amazon Route 53 returns a maximum of 1000 * items. If you set MaxItems to a value greater than 1000, Route 53 returns * only the first 1000 health checks.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains the response to a ListHealthChecks * request.

* @public */ export interface ListHealthChecksResponse { /** *

A complex type that contains one HealthCheck element for each health * check that is associated with the current Amazon Web Services account.

* @public */ HealthChecks: HealthCheck[] | undefined; /** *

For the second and subsequent calls to ListHealthChecks, * Marker is the value that you specified for the marker * parameter in the previous request.

* @public */ Marker: string | undefined; /** *

A flag that indicates whether there are more health checks to be listed. If the * response was truncated, you can get the next group of health checks by submitting * another ListHealthChecks request and specifying the value of * NextMarker in the marker parameter.

* @public */ IsTruncated: boolean | undefined; /** *

If IsTruncated is true, the value of NextMarker * identifies the first health check that Amazon Route 53 returns if you submit another * ListHealthChecks request and specify the value of * NextMarker in the marker parameter.

* @public */ NextMarker?: string | undefined; /** *

The value that you specified for the maxitems parameter in the call to * ListHealthChecks that produced the current response.

* @public */ MaxItems: number | undefined; } /** *

A request to retrieve a list of the public and private hosted zones that are * associated with the current Amazon Web Services account.

* @public */ export interface ListHostedZonesRequest { /** *

If the value of IsTruncated in the previous response was * true, you have more hosted zones. To get more hosted zones, submit * another ListHostedZones request.

*

For the value of marker, specify the value of NextMarker * from the previous response, which is the ID of the first hosted zone that Amazon Route * 53 will return if you submit another request.

*

If the value of IsTruncated in the previous response was * false, there are no more hosted zones to get.

* @public */ Marker?: string | undefined; /** *

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. * If you have more than maxitems hosted zones, the value of * IsTruncated in the response is true, and the value of * NextMarker is the hosted zone ID of the first hosted zone that Route 53 * will return if you submit another request.

* @public */ MaxItems?: number | undefined; /** *

If you're using reusable delegation sets and you want to list all of the hosted zones * that are associated with a reusable delegation set, specify the ID of that reusable * delegation set.

* @public */ DelegationSetId?: string | undefined; /** *

* (Optional) Specifies if the hosted zone is private. *

* @public */ HostedZoneType?: HostedZoneType | undefined; } /** * @public */ export interface ListHostedZonesResponse { /** *

A complex type that contains general information about the hosted zone.

* @public */ HostedZones: HostedZone[] | undefined; /** *

For the second and subsequent calls to ListHostedZones, * Marker is the value that you specified for the marker * parameter in the request that produced the current response.

* @public */ Marker: string | undefined; /** *

A flag indicating whether there are more hosted zones to be listed. If the response * was truncated, you can get more hosted zones by submitting another * ListHostedZones request and specifying the value of * NextMarker in the marker parameter.

* @public */ IsTruncated: boolean | undefined; /** *

If IsTruncated is true, the value of NextMarker * identifies the first hosted zone in the next group of hosted zones. Submit another * ListHostedZones request, and specify the value of * NextMarker from the response in the marker * parameter.

*

This element is present only if IsTruncated is true.

* @public */ NextMarker?: string | undefined; /** *

The value that you specified for the maxitems parameter in the call to * ListHostedZones that produced the current response.

* @public */ MaxItems: number | undefined; } /** *

Retrieves a list of the public and private hosted zones that are associated with the * current Amazon Web Services account in ASCII order by domain name.

* @public */ export interface ListHostedZonesByNameRequest { /** *

(Optional) For your first request to ListHostedZonesByName, include the * dnsname parameter only if you want to specify the name of the first * hosted zone in the response. If you don't include the dnsname parameter, * Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both * dnsname and hostedzoneid parameters. For * dnsname, specify the value of NextDNSName from the * previous response.

* @public */ DNSName?: string | undefined; /** *

(Optional) For your first request to ListHostedZonesByName, do not * include the hostedzoneid parameter.

*

If you have more hosted zones than the value of maxitems, * ListHostedZonesByName returns only the first maxitems * hosted zones. To get the next group of maxitems hosted zones, submit * another request to ListHostedZonesByName and include both * dnsname and hostedzoneid parameters. For the value of * hostedzoneid, specify the value of the NextHostedZoneId * element from the previous response.

* @public */ HostedZoneId?: string | undefined; /** *

The maximum number of hosted zones to be included in the response body for this * request. If you have more than maxitems hosted zones, then the value of the * IsTruncated element in the response is true, and the values of * NextDNSName and NextHostedZoneId specify the first hosted * zone in the next group of maxitems hosted zones.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListHostedZonesByNameResponse { /** *

A complex type that contains general information about the hosted zone.

* @public */ HostedZones: HostedZone[] | undefined; /** *

For the second and subsequent calls to ListHostedZonesByName, * DNSName is the value that you specified for the dnsname * parameter in the request that produced the current response.

* @public */ DNSName?: string | undefined; /** *

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

* @public */ HostedZoneId?: string | undefined; /** *

A flag that indicates whether there are more hosted zones to be listed. If the * response was truncated, you can get the next group of maxitems hosted zones * by calling ListHostedZonesByName again and specifying the values of * NextDNSName and NextHostedZoneId elements in the * dnsname and hostedzoneid parameters.

* @public */ IsTruncated: boolean | undefined; /** *

If IsTruncated is true, the value of NextDNSName is the name * of the first hosted zone in the next group of maxitems hosted zones. Call * ListHostedZonesByName again and specify the value of * NextDNSName and NextHostedZoneId in the * dnsname and hostedzoneid parameters, respectively.

*

This element is present only if IsTruncated is true.

* @public */ NextDNSName?: string | undefined; /** *

If IsTruncated is true, the value of * NextHostedZoneId identifies the first hosted zone in the next group of * maxitems hosted zones. Call ListHostedZonesByName again * and specify the value of NextDNSName and NextHostedZoneId in * the dnsname and hostedzoneid parameters, respectively.

*

This element is present only if IsTruncated is true.

* @public */ NextHostedZoneId?: string | undefined; /** *

The value that you specified for the maxitems parameter in the call to * ListHostedZonesByName that produced the current response.

* @public */ MaxItems: number | undefined; } /** *

Lists all the private hosted zones that a specified VPC is associated with, regardless * of which Amazon Web Services account created the hosted zones.

* @public */ export interface ListHostedZonesByVPCRequest { /** *

The ID of the Amazon VPC that you want to list hosted zones for.

* @public */ VPCId: string | undefined; /** *

For the Amazon VPC that you specified for VPCId, the Amazon Web Services * Region that you created the VPC in.

* @public */ VPCRegion: VPCRegion | undefined; /** *

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. * If the specified VPC is associated with more than MaxItems hosted zones, * the response includes a NextToken element. NextToken contains * an encrypted token that identifies the first hosted zone that Route 53 will return if * you submit another request.

* @public */ MaxItems?: number | undefined; /** *

If the previous response included a NextToken element, the specified VPC * is associated with more hosted zones. To get more hosted zones, submit another * ListHostedZonesByVPC request.

*

For the value of NextToken, specify the value of NextToken * from the previous response.

*

If the previous response didn't include a NextToken element, there are no * more hosted zones to get.

* @public */ NextToken?: string | undefined; } /** *

A complex type that identifies a hosted zone that a specified Amazon VPC is associated * with and the owner of the hosted zone. If there is a value for * OwningAccount, there is no value for OwningService, and * vice versa.

* @public */ export interface HostedZoneOwner { /** *

If the hosted zone was created by an Amazon Web Services account, or was created by an * Amazon Web Services service that creates hosted zones using the current account, * OwningAccount contains the account ID of that account. For example, * when you use Cloud Map to create a hosted zone, Cloud Map creates the hosted * zone using the current Amazon Web Services account.

* @public */ OwningAccount?: string | undefined; /** *

If an Amazon Web Services service uses its own account to create a hosted zone and * associate the specified VPC with that hosted zone, OwningService contains * an abbreviation that identifies the service. For example, if Amazon Elastic File System * (Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value * of OwningService is efs.amazonaws.com.

* @public */ OwningService?: string | undefined; } /** *

In the response to a ListHostedZonesByVPC request, the * HostedZoneSummaries element contains one HostedZoneSummary * element for each hosted zone that the specified Amazon VPC is associated with. Each * HostedZoneSummary element contains the hosted zone name and ID, and * information about who owns the hosted zone.

* @public */ export interface HostedZoneSummary { /** *

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is * associated with.

* @public */ HostedZoneId: string | undefined; /** *

The name of the private hosted zone, such as example.com.

* @public */ Name: string | undefined; /** *

The owner of a private hosted zone that the specified VPC is associated with. The * owner can be either an Amazon Web Services account or an Amazon Web Services * service.

* @public */ Owner: HostedZoneOwner | undefined; } /** * @public */ export interface ListHostedZonesByVPCResponse { /** *

A list that contains one HostedZoneSummary element for each hosted zone * that the specified Amazon VPC is associated with. Each HostedZoneSummary * element contains the hosted zone name and ID, and information about who owns the hosted * zone.

* @public */ HostedZoneSummaries: HostedZoneSummary[] | undefined; /** *

The value that you specified for MaxItems in the most recent * ListHostedZonesByVPC request.

* @public */ MaxItems: number | undefined; /** *

The value that you will use for NextToken in the next * ListHostedZonesByVPC request.

* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListQueryLoggingConfigsRequest { /** *

(Optional) If you want to list the query logging configuration that is associated with * a hosted zone, specify the ID in HostedZoneId.

*

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns * all of the configurations that are associated with the current Amazon Web Services account.

* @public */ HostedZoneId?: string | undefined; /** *

(Optional) If the current Amazon Web Services account has more than * MaxResults query logging configurations, use NextToken to * get the second and subsequent pages of results.

*

For the first ListQueryLoggingConfigs request, omit this value.

*

For the second and subsequent requests, get the value of NextToken from * the previous response and specify that value for NextToken in the * request.

* @public */ NextToken?: string | undefined; /** *

(Optional) The maximum number of query logging configurations that you want Amazon * Route 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the * value of NextToken in the response to get the next page of results.

*

If you don't specify a value for MaxResults, Route 53 returns up to 100 * configurations.

* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListQueryLoggingConfigsResponse { /** *

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging * that is associated with the current Amazon Web Services account.

* @public */ QueryLoggingConfigs: QueryLoggingConfig[] | undefined; /** *

If a response includes the last of the query logging configurations that are * associated with the current Amazon Web Services account, NextToken doesn't * appear in the response.

*

If a response doesn't include the last of the configurations, you can get more * configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken * that Amazon Route 53 returned in the previous response and include it in * NextToken in the next request.

* @public */ NextToken?: string | undefined; } /** *

A request for the resource record sets that are associated with a specified hosted * zone.

* @public */ export interface ListResourceRecordSetsRequest { /** *

The ID of the hosted zone that contains the resource record sets that you want to * list.

* @public */ HostedZoneId: string | undefined; /** *

The first name in the lexicographic ordering of resource record sets that you want to * list. If the specified record name doesn't exist, the results begin with the first * resource record set that has a name greater than the value of name.

* @public */ StartRecordName?: string | undefined; /** *

The type of resource record set to begin the record listing from.

*

Valid values for basic resource record sets: A | AAAA | * CAA | CNAME | MX | NAPTR | * NS | PTR | SOA | SPF | * SRV | TXT *

*

Values for weighted, latency, geolocation, and failover resource record sets: * A | AAAA | CAA | CNAME | * MX | NAPTR | PTR | SPF | * SRV | TXT *

*

Values for alias resource record sets:

* *

Constraint: Specifying type without specifying name returns * an InvalidInput error.

* @public */ StartRecordType?: RRType | undefined; /** *

* Resource record sets that have a routing policy other than * simple: If results were truncated for a given DNS name and type, specify * the value of NextRecordIdentifier from the previous response to get the * next resource record set that has the current DNS name and type.

* @public */ StartRecordIdentifier?: string | undefined; /** *

(Optional) The maximum number of resource records sets to include in the response body * for this request. If the response includes more than maxitems resource * record sets, the value of the IsTruncated element in the response is * true, and the values of the NextRecordName and * NextRecordType elements in the response identify the first resource * record set in the next group of maxitems resource record sets.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains list information for the resource record set.

* @public */ export interface ListResourceRecordSetsResponse { /** *

Information about multiple resource record sets.

* @public */ ResourceRecordSets: ResourceRecordSet[] | undefined; /** *

A flag that indicates whether more resource record sets remain to be listed. If your * results were truncated, you can make a follow-up pagination request by using the * NextRecordName element.

* @public */ IsTruncated: boolean | undefined; /** *

If the results were truncated, the name of the next record in the list.

*

This element is present only if IsTruncated is true.

* @public */ NextRecordName?: string | undefined; /** *

If the results were truncated, the type of the next record in the list.

*

This element is present only if IsTruncated is true.

* @public */ NextRecordType?: RRType | undefined; /** *

* Resource record sets that have a routing policy other than * simple: If results were truncated for a given DNS name and type, the * value of SetIdentifier for the next resource record set that has the * current DNS name and type.

*

For information about routing policies, see Choosing a Routing * Policy in the Amazon Route 53 Developer Guide.

* @public */ NextRecordIdentifier?: string | undefined; /** *

The maximum number of records you requested.

* @public */ MaxItems: number | undefined; } /** *

A request to get a list of the reusable delegation sets that are associated with the * current Amazon Web Services account.

* @public */ export interface ListReusableDelegationSetsRequest { /** *

If the value of IsTruncated in the previous response was * true, you have more reusable delegation sets. To get another group, * submit another ListReusableDelegationSets request.

*

For the value of marker, specify the value of NextMarker * from the previous response, which is the ID of the first reusable delegation set that * Amazon Route 53 will return if you submit another request.

*

If the value of IsTruncated in the previous response was * false, there are no more reusable delegation sets to get.

* @public */ Marker?: string | undefined; /** *

The number of reusable delegation sets that you want Amazon Route 53 to return in the * response to this request. If you specify a value greater than 100, Route 53 returns only * the first 100 reusable delegation sets.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains information about the reusable delegation sets that are * associated with the current Amazon Web Services account.

* @public */ export interface ListReusableDelegationSetsResponse { /** *

A complex type that contains one DelegationSet element for each reusable * delegation set that was created by the current Amazon Web Services account.

* @public */ DelegationSets: DelegationSet[] | undefined; /** *

For the second and subsequent calls to ListReusableDelegationSets, * Marker is the value that you specified for the marker * parameter in the request that produced the current response.

* @public */ Marker: string | undefined; /** *

A flag that indicates whether there are more reusable delegation sets to be * listed.

* @public */ IsTruncated: boolean | undefined; /** *

If IsTruncated is true, the value of NextMarker * identifies the next reusable delegation set that Amazon Route 53 will return if you * submit another ListReusableDelegationSets request and specify the value of * NextMarker in the marker parameter.

* @public */ NextMarker?: string | undefined; /** *

The value that you specified for the maxitems parameter in the call to * ListReusableDelegationSets that produced the current response.

* @public */ MaxItems: number | undefined; } /** *

A complex type containing information about a request for a list of the tags that are * associated with an individual resource.

* @public */ export interface ListTagsForResourceRequest { /** *

The type of the resource.

* * @public */ ResourceType: TagResourceType | undefined; /** *

The ID of the resource for which you want to retrieve tags.

* @public */ ResourceId: string | undefined; } /** *

A complex type containing a resource and its associated tags.

* @public */ export interface ResourceTagSet { /** *

The type of the resource.

* * @public */ ResourceType?: TagResourceType | undefined; /** *

The ID for the specified resource.

* @public */ ResourceId?: string | undefined; /** *

The tags associated with the specified resource.

* @public */ Tags?: Tag[] | undefined; } /** *

A complex type that contains information about the health checks or hosted zones for * which you want to list tags.

* @public */ export interface ListTagsForResourceResponse { /** *

A ResourceTagSet containing tags associated with the specified * resource.

* @public */ ResourceTagSet: ResourceTagSet | undefined; } /** *

A complex type that contains information about the health checks or hosted zones for * which you want to list tags.

* @public */ export interface ListTagsForResourcesRequest { /** *

The type of the resources.

* * @public */ ResourceType: TagResourceType | undefined; /** *

A complex type that contains the ResourceId element for each resource for which you * want to get a list of tags.

* @public */ ResourceIds: string[] | undefined; } /** *

A complex type containing tags for the specified resources.

* @public */ export interface ListTagsForResourcesResponse { /** *

A list of ResourceTagSets containing tags associated with the specified * resources.

* @public */ ResourceTagSets: ResourceTagSet[] | undefined; } /** *

A complex type that contains the information about the request to list the traffic * policies that are associated with the current Amazon Web Services account.

* @public */ export interface ListTrafficPoliciesRequest { /** *

(Conditional) For your first request to ListTrafficPolicies, don't * include the TrafficPolicyIdMarker parameter.

*

If you have more traffic policies than the value of MaxItems, * ListTrafficPolicies returns only the first MaxItems * traffic policies. To get the next group of policies, submit another request to * ListTrafficPolicies. For the value of * TrafficPolicyIdMarker, specify the value of * TrafficPolicyIdMarker that was returned in the previous * response.

* @public */ TrafficPolicyIdMarker?: string | undefined; /** *

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to * return in response to this request. If you have more than MaxItems traffic * policies, the value of IsTruncated in the response is true, * and the value of TrafficPolicyIdMarker is the ID of the first traffic * policy that Route 53 will return if you submit another request.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains information about the latest version of one traffic * policy that is associated with the current Amazon Web Services account.

* @public */ export interface TrafficPolicySummary { /** *

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

* @public */ Id: string | undefined; /** *

The name that you specified for the traffic policy when you created it.

* @public */ Name: string | undefined; /** *

The DNS type of the resource record sets that Amazon Route 53 creates when you use a * traffic policy to create a traffic policy instance.

* @public */ Type: RRType | undefined; /** *

The version number of the latest version of the traffic policy.

* @public */ LatestVersion: number | undefined; /** *

The number of traffic policies that are associated with the current Amazon Web Services account.

* @public */ TrafficPolicyCount: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListTrafficPoliciesResponse { /** *

A list that contains one TrafficPolicySummary element for each traffic * policy that was created by the current Amazon Web Services account.

* @public */ TrafficPolicySummaries: TrafficPolicySummary[] | undefined; /** *

A flag that indicates whether there are more traffic policies to be listed. If the * response was truncated, you can get the next group of traffic policies by submitting * another ListTrafficPolicies request and specifying the value of * TrafficPolicyIdMarker in the TrafficPolicyIdMarker request * parameter.

* @public */ IsTruncated: boolean | undefined; /** *

If the value of IsTruncated is true, * TrafficPolicyIdMarker is the ID of the first traffic policy in the next * group of MaxItems traffic policies.

* @public */ TrafficPolicyIdMarker: string | undefined; /** *

The value that you specified for the MaxItems parameter in the * ListTrafficPolicies request that produced the current response.

* @public */ MaxItems: number | undefined; } /** *

A request to get information about the traffic policy instances that you created by * using the current Amazon Web Services account.

* @public */ export interface ListTrafficPolicyInstancesRequest { /** *

If the value of IsTruncated in the previous response was * true, you have more traffic policy instances. To get more traffic * policy instances, submit another ListTrafficPolicyInstances request. For * the value of HostedZoneId, specify the value of * HostedZoneIdMarker from the previous response, which is the hosted zone * ID of the first traffic policy instance in the next group of traffic policy * instances.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ HostedZoneIdMarker?: string | undefined; /** *

If the value of IsTruncated in the previous response was * true, you have more traffic policy instances. To get more traffic * policy instances, submit another ListTrafficPolicyInstances request. For * the value of trafficpolicyinstancename, specify the value of * TrafficPolicyInstanceNameMarker from the previous response, which is * the name of the first traffic policy instance in the next group of traffic policy * instances.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ TrafficPolicyInstanceNameMarker?: string | undefined; /** *

If the value of IsTruncated in the previous response was * true, you have more traffic policy instances. To get more traffic * policy instances, submit another ListTrafficPolicyInstances request. For * the value of trafficpolicyinstancetype, specify the value of * TrafficPolicyInstanceTypeMarker from the previous response, which is * the type of the first traffic policy instance in the next group of traffic policy * instances.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ TrafficPolicyInstanceTypeMarker?: RRType | undefined; /** *

The maximum number of traffic policy instances that you want Amazon Route 53 to return * in response to a ListTrafficPolicyInstances request. If you have more than * MaxItems traffic policy instances, the value of the * IsTruncated element in the response is true, and the * values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, * and TrafficPolicyInstanceTypeMarker represent the first traffic policy * instance in the next group of MaxItems traffic policy instances.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListTrafficPolicyInstancesResponse { /** *

A list that contains one TrafficPolicyInstance element for each traffic * policy instance that matches the elements in the request.

* @public */ TrafficPolicyInstances: TrafficPolicyInstance[] | undefined; /** *

If IsTruncated is true, HostedZoneIdMarker is * the ID of the hosted zone of the first traffic policy instance that Route 53 will return * if you submit another ListTrafficPolicyInstances request.

* @public */ HostedZoneIdMarker?: string | undefined; /** *

If IsTruncated is true, * TrafficPolicyInstanceNameMarker is the name of the first traffic policy * instance that Route 53 will return if you submit another * ListTrafficPolicyInstances request.

* @public */ TrafficPolicyInstanceNameMarker?: string | undefined; /** *

If IsTruncated is true, * TrafficPolicyInstanceTypeMarker is the DNS type of the resource record * sets that are associated with the first traffic policy instance that Amazon Route 53 * will return if you submit another ListTrafficPolicyInstances request. *

* @public */ TrafficPolicyInstanceTypeMarker?: RRType | undefined; /** *

A flag that indicates whether there are more traffic policy instances to be listed. If * the response was truncated, you can get more traffic policy instances by calling * ListTrafficPolicyInstances again and specifying the values of the * HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and * TrafficPolicyInstanceTypeMarker in the corresponding request * parameters.

* @public */ IsTruncated: boolean | undefined; /** *

The value that you specified for the MaxItems parameter in the call to * ListTrafficPolicyInstances that produced the current response.

* @public */ MaxItems: number | undefined; } /** *

A request for the traffic policy instances that you created in a specified hosted * zone.

* @public */ export interface ListTrafficPolicyInstancesByHostedZoneRequest { /** *

The ID of the hosted zone that you want to list traffic policy instances for.

* @public */ HostedZoneId: string | undefined; /** *

If the value of IsTruncated in the previous response is true, you have * more traffic policy instances. To get more traffic policy instances, submit another * ListTrafficPolicyInstances request. For the value of * trafficpolicyinstancename, specify the value of * TrafficPolicyInstanceNameMarker from the previous response, which is * the name of the first traffic policy instance in the next group of traffic policy * instances.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ TrafficPolicyInstanceNameMarker?: string | undefined; /** *

If the value of IsTruncated in the previous response is true, you have * more traffic policy instances. To get more traffic policy instances, submit another * ListTrafficPolicyInstances request. For the value of * trafficpolicyinstancetype, specify the value of * TrafficPolicyInstanceTypeMarker from the previous response, which is * the type of the first traffic policy instance in the next group of traffic policy * instances.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ TrafficPolicyInstanceTypeMarker?: RRType | undefined; /** *

The maximum number of traffic policy instances to be included in the response body for * this request. If you have more than MaxItems traffic policy instances, the * value of the IsTruncated element in the response is true, and * the values of HostedZoneIdMarker, * TrafficPolicyInstanceNameMarker, and * TrafficPolicyInstanceTypeMarker represent the first traffic policy * instance that Amazon Route 53 will return if you submit another request.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListTrafficPolicyInstancesByHostedZoneResponse { /** *

A list that contains one TrafficPolicyInstance element for each traffic * policy instance that matches the elements in the request.

* @public */ TrafficPolicyInstances: TrafficPolicyInstance[] | undefined; /** *

If IsTruncated is true, * TrafficPolicyInstanceNameMarker is the name of the first traffic policy * instance in the next group of traffic policy instances.

* @public */ TrafficPolicyInstanceNameMarker?: string | undefined; /** *

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is * the DNS type of the resource record sets that are associated with the first traffic * policy instance in the next group of traffic policy instances.

* @public */ TrafficPolicyInstanceTypeMarker?: RRType | undefined; /** *

A flag that indicates whether there are more traffic policy instances to be listed. If * the response was truncated, you can get the next group of traffic policy instances by * submitting another ListTrafficPolicyInstancesByHostedZone request and * specifying the values of HostedZoneIdMarker, * TrafficPolicyInstanceNameMarker, and * TrafficPolicyInstanceTypeMarker in the corresponding request * parameters.

* @public */ IsTruncated: boolean | undefined; /** *

The value that you specified for the MaxItems parameter in the * ListTrafficPolicyInstancesByHostedZone request that produced the * current response.

* @public */ MaxItems: number | undefined; } /** *

A complex type that contains the information about the request to list your traffic * policy instances.

* @public */ export interface ListTrafficPolicyInstancesByPolicyRequest { /** *

The ID of the traffic policy for which you want to list traffic policy * instances.

* @public */ TrafficPolicyId: string | undefined; /** *

The version of the traffic policy for which you want to list traffic policy instances. * The version must be associated with the traffic policy that is specified by * TrafficPolicyId.

* @public */ TrafficPolicyVersion: number | undefined; /** *

If the value of IsTruncated in the previous response was * true, you have more traffic policy instances. To get more traffic * policy instances, submit another ListTrafficPolicyInstancesByPolicy * request.

*

For the value of hostedzoneid, specify the value of * HostedZoneIdMarker from the previous response, which is the hosted zone * ID of the first traffic policy instance that Amazon Route 53 will return if you submit * another request.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ HostedZoneIdMarker?: string | undefined; /** *

If the value of IsTruncated in the previous response was * true, you have more traffic policy instances. To get more traffic * policy instances, submit another ListTrafficPolicyInstancesByPolicy * request.

*

For the value of trafficpolicyinstancename, specify the value of * TrafficPolicyInstanceNameMarker from the previous response, which is * the name of the first traffic policy instance that Amazon Route 53 will return if you * submit another request.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ TrafficPolicyInstanceNameMarker?: string | undefined; /** *

If the value of IsTruncated in the previous response was * true, you have more traffic policy instances. To get more traffic * policy instances, submit another ListTrafficPolicyInstancesByPolicy * request.

*

For the value of trafficpolicyinstancetype, specify the value of * TrafficPolicyInstanceTypeMarker from the previous response, which is * the name of the first traffic policy instance that Amazon Route 53 will return if you * submit another request.

*

If the value of IsTruncated in the previous response was * false, there are no more traffic policy instances to get.

* @public */ TrafficPolicyInstanceTypeMarker?: RRType | undefined; /** *

The maximum number of traffic policy instances to be included in the response body for * this request. If you have more than MaxItems traffic policy instances, the * value of the IsTruncated element in the response is true, and * the values of HostedZoneIdMarker, * TrafficPolicyInstanceNameMarker, and * TrafficPolicyInstanceTypeMarker represent the first traffic policy * instance that Amazon Route 53 will return if you submit another request.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListTrafficPolicyInstancesByPolicyResponse { /** *

A list that contains one TrafficPolicyInstance element for each traffic * policy instance that matches the elements in the request.

* @public */ TrafficPolicyInstances: TrafficPolicyInstance[] | undefined; /** *

If IsTruncated is true, HostedZoneIdMarker is * the ID of the hosted zone of the first traffic policy instance in the next group of * traffic policy instances.

* @public */ HostedZoneIdMarker?: string | undefined; /** *

If IsTruncated is true, * TrafficPolicyInstanceNameMarker is the name of the first traffic policy * instance in the next group of MaxItems traffic policy instances.

* @public */ TrafficPolicyInstanceNameMarker?: string | undefined; /** *

If IsTruncated is true, * TrafficPolicyInstanceTypeMarker is the DNS type of the resource record * sets that are associated with the first traffic policy instance in the next group of * MaxItems traffic policy instances.

* @public */ TrafficPolicyInstanceTypeMarker?: RRType | undefined; /** *

A flag that indicates whether there are more traffic policy instances to be listed. If * the response was truncated, you can get the next group of traffic policy instances by * calling ListTrafficPolicyInstancesByPolicy again and specifying the values * of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, * and TrafficPolicyInstanceTypeMarker elements in the corresponding request * parameters.

* @public */ IsTruncated: boolean | undefined; /** *

The value that you specified for the MaxItems parameter in the call to * ListTrafficPolicyInstancesByPolicy that produced the current * response.

* @public */ MaxItems: number | undefined; } /** *

A complex type that contains the information about the request to list your traffic * policies.

* @public */ export interface ListTrafficPolicyVersionsRequest { /** *

Specify the value of Id of the traffic policy for which you want to list * all versions.

* @public */ Id: string | undefined; /** *

For your first request to ListTrafficPolicyVersions, don't include the * TrafficPolicyVersionMarker parameter.

*

If you have more traffic policy versions than the value of MaxItems, * ListTrafficPolicyVersions returns only the first group of * MaxItems versions. To get more traffic policy versions, submit another * ListTrafficPolicyVersions request. For the value of * TrafficPolicyVersionMarker, specify the value of * TrafficPolicyVersionMarker in the previous response.

* @public */ TrafficPolicyVersionMarker?: string | undefined; /** *

The maximum number of traffic policy versions that you want Amazon Route 53 to include * in the response body for this request. If the specified traffic policy has more than * MaxItems versions, the value of IsTruncated in the * response is true, and the value of the * TrafficPolicyVersionMarker element is the ID of the first version that * Route 53 will return if you submit another request.

* @public */ MaxItems?: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListTrafficPolicyVersionsResponse { /** *

A list that contains one TrafficPolicy element for each traffic policy * version that is associated with the specified traffic policy.

* @public */ TrafficPolicies: TrafficPolicy[] | undefined; /** *

A flag that indicates whether there are more traffic policies to be listed. If the * response was truncated, you can get the next group of traffic policies by submitting * another ListTrafficPolicyVersions request and specifying the value of * NextMarker in the marker parameter.

* @public */ IsTruncated: boolean | undefined; /** *

If IsTruncated is true, the value of * TrafficPolicyVersionMarker identifies the first traffic policy that * Amazon Route 53 will return if you submit another request. Call * ListTrafficPolicyVersions again and specify the value of * TrafficPolicyVersionMarker in the * TrafficPolicyVersionMarker request parameter.

*

This element is present only if IsTruncated is true.

* @public */ TrafficPolicyVersionMarker: string | undefined; /** *

The value that you specified for the maxitems parameter in the * ListTrafficPolicyVersions request that produced the current * response.

* @public */ MaxItems: number | undefined; } /** *

A complex type that contains information about that can be associated with your hosted * zone.

* @public */ export interface ListVPCAssociationAuthorizationsRequest { /** *

The ID of the hosted zone for which you want a list of VPCs that can be associated * with the hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

* Optional: If a response includes a NextToken * element, there are more VPCs that can be associated with the specified hosted zone. To * get the next page of results, submit another request, and include the value of * NextToken from the response in the nexttoken parameter in * another ListVPCAssociationAuthorizations request.

* @public */ NextToken?: string | undefined; /** *

* Optional: An integer that specifies the maximum number of VPCs * that you want Amazon Route 53 to return. If you don't specify a value for * MaxResults, Route 53 returns up to 50 VPCs per page.

* @public */ MaxResults?: number | undefined; } /** *

A complex type that contains the response information for the request.

* @public */ export interface ListVPCAssociationAuthorizationsResponse { /** *

The ID of the hosted zone that you can associate the listed VPCs with.

* @public */ HostedZoneId: string | undefined; /** *

When the response includes a NextToken element, there are more VPCs that * can be associated with the specified hosted zone. To get the next page of VPCs, submit * another ListVPCAssociationAuthorizations request, and include the value of * the NextToken element from the response in the nexttoken * request parameter.

* @public */ NextToken?: string | undefined; /** *

The list of VPCs that are authorized to be associated with the specified hosted * zone.

* @public */ VPCs: VPC[] | undefined; } /** *

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 */ export interface TestDNSAnswerRequest { /** *

The ID of the hosted zone that you want Amazon Route 53 to simulate a query * for.

* @public */ HostedZoneId: string | undefined; /** *

The name of the resource record set that you want Amazon Route 53 to simulate a query * for.

* @public */ RecordName: string | undefined; /** *

The type of the resource record set.

* @public */ RecordType: RRType | undefined; /** *

If you want to simulate a request from a specific DNS resolver, specify the IP address * for that resolver. If you omit this value, TestDnsAnswer uses the IP * address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region * (us-east-1).

* @public */ ResolverIP?: string | undefined; /** *

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or * IPv6 address of a client in the applicable location, for example, * 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

* @public */ EDNS0ClientSubnetIP?: string | undefined; /** *

If you specify an IP address for edns0clientsubnetip, you can optionally * specify the number of bits of the IP address that you want the checking tool to include * in the DNS query. For example, if you specify 192.0.2.44 for * edns0clientsubnetip and 24 for * edns0clientsubnetmask, the checking tool will simulate a request from * 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 * addresses.

*

The range of valid values depends on whether edns0clientsubnetip is an * IPv4 or an IPv6 address:

* * @public */ EDNS0ClientSubnetMask?: string | undefined; } /** *

A complex type that contains the response to a TestDNSAnswer request. *

* @public */ export interface TestDNSAnswerResponse { /** *

The Amazon Route 53 name server used to respond to the request.

* @public */ Nameserver: string | undefined; /** *

The name of the resource record set that you submitted a request for.

* @public */ RecordName: string | undefined; /** *

The type of the resource record set that you submitted a request for.

* @public */ RecordType: RRType | undefined; /** *

A list that contains values that Amazon Route 53 returned for this resource record * set.

* @public */ RecordData: string[] | undefined; /** *

A code that indicates whether the request is valid or not. The most common response * code is NOERROR, meaning that the request is valid. If the response is not * valid, Amazon Route 53 returns a response code that describes the error. For a list of * possible response codes, see DNS RCODES on the IANA website.

* @public */ ResponseCode: string | undefined; /** *

The protocol that Amazon Route 53 used to respond to the request, either * UDP or TCP.

* @public */ Protocol: string | undefined; } /** *

A complex type that contains information about a request to update a health * check.

* @public */ export interface UpdateHealthCheckRequest { /** *

The ID for the health check for which you want detailed information. When you created * the health check, CreateHealthCheck returned the ID in the response, in the * HealthCheckId element.

* @public */ HealthCheckId: string | undefined; /** *

A sequential counter that Amazon Route 53 sets to 1 when you create a * health check and increments by 1 each time you update settings for the health * check.

*

We recommend that you use GetHealthCheck or ListHealthChecks * to get the current value of HealthCheckVersion for the health check that * you want to update, and that you include that value in your * UpdateHealthCheck request. This prevents Route 53 from overwriting an * intervening update:

* * @public */ HealthCheckVersion?: number | undefined; /** *

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform * health checks on. If you don't specify a value for IPAddress, Route 53 * sends a DNS request to resolve the domain name that you specify in * FullyQualifiedDomainName at the interval that you specify in * RequestInterval. Using an IP address that is returned by DNS, Route 53 * then checks the health of the endpoint.

*

Use one of the following formats for the value of IPAddress:

* *

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP * address, associate it with your EC2 instance, and specify the Elastic IP address for * IPAddress. This ensures that the IP address of your instance never * changes. For more information, see the applicable documentation:

* * *

If a health check already has a value for IPAddress, you can change * the value. However, you can't update an existing health check to add or remove the * value of IPAddress.

* *

For more information, see FullyQualifiedDomainName.

*

Constraints: Route 53 can't check the health of endpoints for which the IP address is * in local, private, non-routable, or multicast ranges. For more information about IP * addresses for which you can't create health checks, see the following documents:

* * @public */ IPAddress?: string | undefined; /** *

The port on the endpoint that you want Amazon Route 53 to perform health checks * on.

* *

Don't specify a value for Port when you specify a value for * Type of CLOUDWATCH_METRIC or * CALCULATED.

* * @public */ Port?: number | undefined; /** *

The path that you want Amazon Route 53 to request when performing health checks. The * path can be any value for which your endpoint will return an HTTP status code of 2xx or * 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. * You can also include query string parameters, for example, * /welcome.html?language=jp&login=y.

*

Specify this value only if you want to change it.

* @public */ ResourcePath?: string | undefined; /** *

Amazon Route 53 behavior depends on whether you specify a value for * IPAddress.

* *

If a health check already has a value for IPAddress, you can change * the value. However, you can't update an existing health check to add or remove the * value of IPAddress.

* *

* If you specify a value for * IPAddress:

*

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes * the value of FullyQualifiedDomainName in the Host header for * all health checks except TCP health checks. This is typically the fully qualified DNS * name of the endpoint on which you want Route 53 to perform health checks.

*

When Route 53 checks the health of an endpoint, here is how it constructs the * Host header:

* *

If you don't specify a value for FullyQualifiedDomainName, Route 53 * substitutes the value of IPAddress in the Host header in each * of the above cases.

*

* If you don't specify a value for * IPAddress:

*

If you don't specify a value for IPAddress, Route 53 sends a DNS request * to the domain that you specify in FullyQualifiedDomainName at the interval * you specify in RequestInterval. Using an IPv4 address that is returned by * DNS, Route 53 then checks the health of the endpoint.

*

If you don't specify a value for IPAddress, you can’t update the health check to remove the FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a * FullyQualifiedDomainName is required.

* *

If you don't specify a value for IPAddress, Route 53 uses only IPv4 * to send health checks to the endpoint. If there's no resource record set with a type * of A for the name that you specify for FullyQualifiedDomainName, the * health check fails with a "DNS resolution failed" error.

* *

If you want to check the health of weighted, latency, or failover resource record sets * and you choose to specify the endpoint only by FullyQualifiedDomainName, we * recommend that you create a separate health check for each endpoint. For example, create * a health check for each HTTP server that is serving content for www.example.com. For the * value of FullyQualifiedDomainName, specify the domain name of the server * (such as us-east-2-www.example.com), not the name of the resource record * sets (www.example.com).

* *

In this configuration, if the value of FullyQualifiedDomainName * matches the name of the resource record sets and you then associate the health check * with those resource record sets, health check results will be unpredictable.

* *

In addition, if the value of Type is HTTP, * HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, * Route 53 passes the value of FullyQualifiedDomainName in the * Host header, as it does when you specify a value for * IPAddress. If the value of Type is TCP, Route * 53 doesn't pass a Host header.

* @public */ FullyQualifiedDomainName?: string | undefined; /** *

If the value of Type is HTTP_STR_MATCH or * HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for * in the response body from the specified resource. If the string appears in the response * body, Route 53 considers the resource healthy. (You can't change the value of * Type when you update a health check.)

* @public */ SearchString?: string | undefined; /** *

The number of consecutive health checks that an endpoint must pass or fail for Amazon * Route 53 to change the current status of the endpoint from unhealthy to healthy or vice * versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the * Amazon Route 53 Developer Guide.

*

Otherwise, if you don't specify a value for FailureThreshold, the default value is * three health checks.

* @public */ FailureThreshold?: number | undefined; /** *

Specify whether you want Amazon Route 53 to invert the status of a health check, for * example, to consider a health check unhealthy when it otherwise would be considered * healthy.

* @public */ Inverted?: boolean | undefined; /** *

Stops Route 53 from performing health checks. When you disable a health check, here's * what happens:

* *

After you disable a health check, Route 53 considers the status of the health check to * always be healthy. If you configured DNS failover, Route 53 continues to route traffic * to the corresponding resources. Additionally, in disabled state, you can also invert the * status of the health check to route traffic differently. For more information, see * Inverted.

*

Charges for a health check still apply when the health check is disabled. For more * information, see Amazon Route 53 * Pricing.

* @public */ Disabled?: boolean | undefined; /** *

The number of child health checks that are associated with a CALCULATED * health that Amazon Route 53 must consider healthy for the CALCULATED health * check to be considered healthy. To specify the child health checks that you want to * associate with a CALCULATED health check, use the * ChildHealthChecks and ChildHealthCheck elements.

*

Note the following:

* * @public */ HealthThreshold?: number | undefined; /** *

A complex type that contains one ChildHealthCheck element for each health * check that you want to associate with a CALCULATED health check.

* @public */ ChildHealthChecks?: string[] | undefined; /** *

Specify whether you want Amazon Route 53 to send the value of * FullyQualifiedDomainName to the endpoint in the * client_hello message during TLS negotiation. This allows * the endpoint to respond to HTTPS health check requests with the applicable * SSL/TLS certificate.

*

Some endpoints require that HTTPS requests include the host name in the * client_hello message. If you don't enable SNI, the status of the health * check will be SSL alert handshake_failure. A health check can also have * that status for other reasons. If SNI is enabled and you're still getting the error, * check the SSL/TLS configuration on your endpoint and confirm that your certificate is * valid.

*

The SSL/TLS certificate on your endpoint includes a domain name in the Common * Name field and possibly several more in the Subject Alternative * Names field. One of the domain names in the certificate should match the * value that you specify for FullyQualifiedDomainName. If the endpoint * responds to the client_hello message with a certificate that does not * include the domain name that you specified in FullyQualifiedDomainName, a * health checker will retry the handshake. In the second attempt, the health checker will * omit FullyQualifiedDomainName from the client_hello * message.

* @public */ EnableSNI?: boolean | undefined; /** *

A complex type that contains one Region element for each region that you * want Amazon Route 53 health checkers to check the specified endpoint from.

* @public */ Regions?: HealthCheckRegion[] | undefined; /** *

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 * health checkers to use to determine whether the specified health check is * healthy.

* @public */ AlarmIdentifier?: AlarmIdentifier | undefined; /** *

When CloudWatch has insufficient data about the metric to determine the alarm state, * the status that you want Amazon Route 53 to assign to the health check:

* * @public */ InsufficientDataHealthStatus?: InsufficientDataHealthStatus | undefined; /** *

A complex type that contains one ResettableElementName element for each * element that you want to reset to the default value. Valid values for * ResettableElementName include the following:

* * @public */ ResetElements?: ResettableElementName[] | undefined; } /** *

A complex type that contains the response to the UpdateHealthCheck * request.

* @public */ export interface UpdateHealthCheckResponse { /** *

A complex type that contains the response to an UpdateHealthCheck * request.

* @public */ HealthCheck: HealthCheck | undefined; } /** *

A request to update the comment for a hosted zone.

* @public */ export interface UpdateHostedZoneCommentRequest { /** *

The ID for the hosted zone that you want to update the comment for.

* @public */ Id: string | undefined; /** *

The new comment for the hosted zone. If you don't specify a value for * Comment, Amazon Route 53 deletes the existing value of the * Comment element, if any.

* @public */ Comment?: string | undefined; } /** *

A complex type that contains the response to the UpdateHostedZoneComment * request.

* @public */ export interface UpdateHostedZoneCommentResponse { /** *

A complex type that contains the response to the UpdateHostedZoneComment * request.

* @public */ HostedZone: HostedZone | undefined; } /** * @public */ export interface UpdateHostedZoneFeaturesRequest { /** *

The ID of the hosted zone for which you want to update features. This is the unique identifier for your hosted zone.

* @public */ HostedZoneId: string | undefined; /** *

Specifies whether to enable accelerated recovery for the hosted zone. Set to true to enable accelerated recovery, or false to disable it.

* @public */ EnableAcceleratedRecovery?: boolean | undefined; } /** * @public */ export interface UpdateHostedZoneFeaturesResponse { } /** *

A complex type that contains information about the traffic policy that you want to * update the comment for.

* @public */ export interface UpdateTrafficPolicyCommentRequest { /** *

The value of Id for the traffic policy that you want to update the * comment for.

* @public */ Id: string | undefined; /** *

The value of Version for the traffic policy that you want to update the * comment for.

* @public */ Version: number | undefined; /** *

The new comment for the specified traffic policy and version.

* @public */ Comment: string | undefined; } /** *

A complex type that contains the response information for the traffic policy.

* @public */ export interface UpdateTrafficPolicyCommentResponse { /** *

A complex type that contains settings for the specified traffic policy.

* @public */ TrafficPolicy: TrafficPolicy | undefined; } /** *

A complex type that contains information about the resource record sets that you want * to update based on a specified traffic policy instance.

* @public */ export interface UpdateTrafficPolicyInstanceRequest { /** *

The ID of the traffic policy instance that you want to update.

* @public */ Id: string | undefined; /** *

The TTL that you want Amazon Route 53 to assign to all of the updated resource record * sets.

* @public */ TTL: number | undefined; /** *

The ID of the traffic policy that you want Amazon Route 53 to use to update resource * record sets for the specified traffic policy instance.

* @public */ TrafficPolicyId: string | undefined; /** *

The version of the traffic policy that you want Amazon Route 53 to use to update * resource record sets for the specified traffic policy instance.

* @public */ TrafficPolicyVersion: number | undefined; } /** *

A complex type that contains information about the resource record sets that Amazon * Route 53 created based on a specified traffic policy.

* @public */ export interface UpdateTrafficPolicyInstanceResponse { /** *

A complex type that contains settings for the updated traffic policy instance.

* @public */ TrafficPolicyInstance: TrafficPolicyInstance | undefined; }