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:
** MAX_HEALTH_CHECKS_BY_OWNER: The maximum * number of health checks that you can create using the current account.
** MAX_HOSTED_ZONES_BY_OWNER: The maximum number * of hosted zones that you can create using the current account.
** MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The * maximum number of reusable delegation sets that you can create using the current * account.
** MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum * number of traffic policies that you can create using the current account.
** MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The * maximum number of traffic policy instances that you can create using the current * account. (Traffic policy instances are referred to as traffic flow policy * records in the Amazon Route 53 console.)
*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.
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.
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.
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; } /** *Another user submitted a request to create, update, or delete the object at the same * time that you did. Retry the request.
* @public */ export declare class ConcurrentModification extends __BaseException { readonly name: "ConcurrentModification"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe input is not valid.
* @public */ export declare class InvalidInput extends __BaseException { readonly name: "InvalidInput"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe key-signing key (KSK) status isn't valid or another KSK has the status
* INTERNAL_FAILURE.
The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC * signing.
* @public */ export declare class InvalidKMSArn extends __BaseException { readonly name: "InvalidKMSArn"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeYour hosted zone status isn't valid for this operation. In the hosted zone, change the
* status to enable DNSSEC or disable DNSSEC.
The specified key-signing key (KSK) doesn't exist.
* @public */ export declare class NoSuchKeySigningKey extends __BaseException { readonly name: "NoSuchKeySigningKey"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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:
*Standard-resolution metrics. High-resolution metrics aren't supported. For * more information, see High-Resolution Metrics in the Amazon CloudWatch User * Guide.
*Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended * statistics aren't supported.
** 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:
*For information about creating failover resource record sets in a private * hosted zone, see Configuring Failover in a Private Hosted Zone.
** Alias resource records sets only: The value used depends on where * you want to route traffic:
*Specify the hosted zone ID for your API. You can get the applicable value * using the CLI command get-domain-names:
*For regional APIs, specify the value of
* regionalHostedZoneId.
For edge-optimized APIs, specify the value of
* distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the
* value of HostedZoneId using the CLI command
* describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a * private zone.
*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.
*Specify the value of the hosted zone ID for the load balancer. Use the * following methods to get the hosted zone ID:
** Elastic Load Balancing endpoints and quotas topic in * the Amazon Web Services General Reference: Use * the value that corresponds with the region that you created your * load balancer in. Note that there are separate columns for * Application and Classic Load Balancers and for Network Load * Balancers.
** Amazon Web Services Management Console: Go to the * Amazon EC2 page, choose Load * Balancers in the navigation pane, select the load * balancer, and get the value of the Hosted * zone field on the Description tab.
*
* Elastic Load Balancing API: Use
* DescribeLoadBalancers to get the applicable value.
* For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of
* CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of
* CanonicalHostedZoneId.
* CLI: Use
* describe-load-balancers to get the applicable
* value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of
* CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of
* CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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.
*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.)
** Alias resource record sets only: The value that you specify * depends on where you want to route queries:
*Specify the applicable domain name for your API. You can get the * applicable value using the CLI command get-domain-names:
*For regional APIs, specify the value of
* regionalDomainName.
For edge-optimized APIs, specify the value of
* distributionDomainName. This is the name of the
* associated CloudFront distribution, such as
* da1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain
* name for your API, such as api.example.com.
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.
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.
*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:
* Amazon Web Services Management Console: For information about * how to get the value by using the console, see Using Custom * Domains with Elastic Beanstalk in the * Elastic Beanstalk Developer * Guide.
*
* Elastic Beanstalk API: Use the
* DescribeEnvironments action to get the value of the
* CNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.
* CLI: Use the
* describe-environments command to get the value of
* the CNAME attribute. For more information, see describe-environments in the CLI Command Reference.
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.
** Amazon Web Services Management Console: Go to the * EC2 page, choose Load Balancers in * the navigation pane, choose the load balancer, choose the Description tab, and get the value of the * DNS name field.
*If you're routing traffic to a Classic Load Balancer, get the * value that begins with dualstack. * If you're routing traffic to another type of load balancer, get the * value that applies to the record type, A or AAAA.
*
* Elastic Load Balancing API: Use
* DescribeLoadBalancers to get the value of
* DNSName. For more information, see the applicable
* guide:
Classic Load Balancers: DescribeLoadBalancers *
*Application and Network Load Balancers: DescribeLoadBalancers *
*
* CLI: Use
* describe-load-balancers to get the value of
* DNSName. For more information, see the applicable
* guide:
Classic Load Balancers: describe-load-balancers *
*Application and Network Load Balancers: describe-load-balancers *
*Specify the DNS name for your accelerator:
** Global Accelerator API: To get * the DNS name, use DescribeAccelerator.
** CLI: To get the * DNS name, use describe-accelerator.
*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.
*
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.
* 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:
*You can't set EvaluateTargetHealth to true when
* the alias target is a CloudFront distribution.
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.
*Health checking behavior depends on the type of load balancer:
*
* Classic Load Balancers: If you
* specify an ELB Classic Load Balancer in DNSName,
* Elastic Load Balancing routes queries only to the healthy Amazon EC2
* instances that are registered with the load balancer. If you set
* EvaluateTargetHealth to true and
* either no EC2 instances are healthy or the load balancer itself is
* unhealthy, Route 53 routes queries to other resources.
* Application and Network Load
* Balancers: If you specify an ELB Application or
* Network Load Balancer and you set EvaluateTargetHealth
* to true, Route 53 routes queries to the load balancer
* based on the health of the target groups that are associated with
* the load balancer:
For an Application or Network Load Balancer to be * considered healthy, every target group that contains targets * must contain at least one healthy target. If any target * group contains only unhealthy targets, the load balancer is * considered unhealthy, and Route 53 routes queries to other * resources.
*A target group that has no registered targets is * considered unhealthy.
*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. *
*There are no special requirements for setting
* EvaluateTargetHealth to true when the alias
* target is an S3 bucket.
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.
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; } /** * @public * @enum */ export declare const VPCRegion: { readonly af_south_1: "af-south-1"; readonly ap_east_1: "ap-east-1"; readonly ap_northeast_1: "ap-northeast-1"; readonly ap_northeast_2: "ap-northeast-2"; readonly ap_northeast_3: "ap-northeast-3"; readonly ap_south_1: "ap-south-1"; readonly ap_south_2: "ap-south-2"; readonly ap_southeast_1: "ap-southeast-1"; readonly ap_southeast_2: "ap-southeast-2"; readonly ap_southeast_3: "ap-southeast-3"; readonly ap_southeast_4: "ap-southeast-4"; readonly ap_southeast_5: "ap-southeast-5"; readonly ap_southeast_7: "ap-southeast-7"; readonly ca_central_1: "ca-central-1"; readonly ca_west_1: "ca-west-1"; readonly cn_north_1: "cn-north-1"; readonly cn_northwest_1: "cn-northwest-1"; readonly eu_central_1: "eu-central-1"; readonly eu_central_2: "eu-central-2"; readonly eu_north_1: "eu-north-1"; readonly eu_south_1: "eu-south-1"; readonly eu_south_2: "eu-south-2"; readonly eu_west_1: "eu-west-1"; readonly eu_west_2: "eu-west-2"; readonly eu_west_3: "eu-west-3"; readonly il_central_1: "il-central-1"; readonly me_central_1: "me-central-1"; readonly me_south_1: "me-south-1"; readonly mx_central_1: "mx-central-1"; readonly sa_east_1: "sa-east-1"; readonly us_east_1: "us-east-1"; readonly us_east_2: "us-east-2"; readonly us_gov_east_1: "us-gov-east-1"; readonly us_gov_west_1: "us-gov-west-1"; readonly us_iso_east_1: "us-iso-east-1"; readonly us_iso_west_1: "us-iso-west-1"; readonly us_isob_east_1: "us-isob-east-1"; readonly us_west_1: "us-west-1"; readonly us_west_2: "us-west-2"; }; /** * @public */ export type VPCRegion = (typeof VPCRegion)[keyof typeof VPCRegion]; /** *(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.
A complex type that describes the changes made to your hosted zone.
* @public */ ChangeInfo: ChangeInfo | undefined; } /** *The cause of this error depends on the operation that you're performing:
** Create a public hosted zone: Two hosted zones * that have the same name or that have a parent/child relationship (example.com * and test.example.com) can't have any common name servers. You tried to create a * hosted zone that has the same name as an existing hosted zone or that's the * parent or child of an existing hosted zone, and you specified a delegation set * that shares one or more name servers with the existing hosted zone. For more * information, see CreateReusableDelegationSet.
** Create a private hosted zone: A hosted zone * with the specified name already exists and is already associated with the Amazon * VPC that you specified.
** Associate VPCs with a private hosted zone: * The VPC that you specified is already associated with another hosted zone that * has the same name.
*The VPC ID that you specified either isn't a valid ID or the current account is not * authorized to access this VPC.
* @public */ export declare class InvalidVPCId extends __BaseException { readonly name: "InvalidVPCId"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis operation can't be completed because the current account has reached the * limit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support * Center.
* @public */ export declare class LimitsExceeded extends __BaseException { readonly name: "LimitsExceeded"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeNo hosted zone exists with the ID that you specified.
* @public */ export declare class NoSuchHostedZone extends __BaseException { readonly name: "NoSuchHostedZone"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeAssociating the specified VPC with the specified hosted zone has not been * authorized.
* @public */ export declare class NotAuthorizedException extends __BaseException { readonly name: "NotAuthorizedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeIf Amazon Route 53 can't process a request before the next request arrives, it will
* reject subsequent requests for the same hosted zone and return an HTTP 400
* error (Bad request). If Route 53 returns this error repeatedly
* for the same request, we recommend that you wait, in intervals of increasing duration,
* before you try the request again.
You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't * support associating a VPC with a public hosted zone.
* @public */ export declare class PublicZoneVPCAssociation extends __BaseException { readonly name: "PublicZoneVPCAssociation"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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:
If the value in the request matches the value of
* CollectionVersion in the collection, Route 53 updates
* the collection.
If the value of CollectionVersion in the collection is greater
* than the value in the request, the collection was changed after you got the
* version number. Route 53 does not update the collection, and it
* returns a CidrCollectionVersionMismatch error.
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.
This CIDR block is already in use.
* @public */ export declare class CidrBlockInUseException extends __BaseException { readonly name: "CidrBlockInUseException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe CIDR collection version you provided, doesn't match the one in the
* ListCidrCollections operation.
The CIDR collection you specified, doesn't exist.
* @public */ export declare class NoSuchCidrCollectionException extends __BaseException { readonly name: "NoSuchCidrCollectionException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
The CIDR collection ID.
* @public */ CollectionId: string | undefined; /** *The CIDR collection location name.
* @public */ LocationName: string | undefined; } /** * @public * @enum */ export declare const ResourceRecordSetFailover: { readonly PRIMARY: "PRIMARY"; readonly SECONDARY: "SECONDARY"; }; /** * @public */ export type ResourceRecordSetFailover = (typeof ResourceRecordSetFailover)[keyof typeof ResourceRecordSetFailover]; /** *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:
** AF: Africa
** AN: Antarctica
** AS: Asia
** EU: Europe
** OC: Oceania
** NA: North America
** SA: South America
*Constraint: Specifying ContinentCode with either CountryCode
* or SubdivisionCode returns an InvalidInput error.
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.
* 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.
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:
To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a * positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.
*To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a * negative bias of -1 to -99. Route 53 expands the size of adjacent regions.
*Information specific to the resource record.
*If you're creating an alias resource record set, omit
* 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.
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:
The * must replace the entire label. For example, you can't specify
* *prod.example.com or prod*.example.com.
The * can't replace any of the middle labels, for example, * marketing.*.example.com.
*If you include * in any position other than the leftmost label in a domain * name, DNS treats it as an * character (ASCII 42), not as a wildcard.
*You can't use the * wildcard for resource records sets that have a type of * NS.
*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:
*
* Amazon API Gateway custom regional APIs and
* edge-optimized APIs:
* A
*
* CloudFront distributions:
* A
*
If IPv6 is enabled for the distribution, create two resource record sets to
* route traffic to your distribution, one with a value of A and one
* with a value of AAAA.
* Amazon API Gateway environment that has a regionalized
* subdomain: A
*
* ELB load balancers:
* A | AAAA
*
* Amazon S3 buckets:
* A
*
* Amazon Virtual Private Cloud interface VPC
* endpoints
* A
*
* Another resource record set in this hosted
* zone: Specify the type of the resource record set that you're
* creating the alias for. All values are supported except NS and
* SOA.
If you're creating an alias record that has the same name as the hosted
* zone (known as the zone apex), you can't route traffic to a record for which
* the value of Type is CNAME. This is because the
* alias record must have the same type as the record you're routing traffic
* to, and creating a CNAME record for the zone apex isn't supported even for
* an alias record.
* 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:
*You must specify a value for the Weight element for every
* weighted resource record set.
You can only specify one ResourceRecord per weighted resource
* record set.
You can't create latency, failover, or geolocation resource record sets that
* have the same values for the Name and Type elements as
* weighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the
* same values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set
* Weight to 0 for a resource record set, Route 53
* never responds to queries with the applicable value for that resource record
* set. However, if you set Weight to 0 for all resource
* record sets that have the same combination of DNS name and type, traffic is
* routed to all resources with equal probability.
The effect of setting Weight to 0 is different when
* you associate health checks with weighted resource record sets. For more
* information, see Options for Configuring Route 53 Active-Active and Active-Passive
* Failover in the Amazon Route 53 Developer
* Guide.
* 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:
*You can only specify one ResourceRecord per latency resource
* record set.
You can only create one latency resource record set for each Amazon EC2 * Region.
*You aren't required to create latency resource record sets for all Amazon EC2 * Regions. Route 53 will choose the region with the best latency from among the * regions that you create latency resource record sets for.
*You can't create non-latency resource record sets that have the same values
* for the Name and Type elements as latency resource
* record sets.
* 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.
* 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:
When the primary resource record set is healthy, Route 53 responds to DNS * queries with the applicable value from the primary resource record set * regardless of the health of the secondary resource record set.
*When the primary resource record set is unhealthy and the secondary resource * record set is healthy, Route 53 responds to DNS queries with the applicable * value from the secondary resource record set.
*When the secondary resource record set is unhealthy, Route 53 responds to DNS * queries with the applicable value from the primary resource record set * regardless of the health of the primary resource record set.
*If you omit the HealthCheckId element for the secondary resource
* record set, and if the primary resource record set is unhealthy, Route 53 always
* responds to DNS queries with the applicable value from the secondary resource
* record set. This is true regardless of the health of the associated
* endpoint.
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:
*
* 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:
If you associate a health check with a multivalue answer resource record set, * Amazon Route 53 responds to DNS queries with the corresponding IP address only * when the health check is healthy.
*If you don't associate a health check with a multivalue answer record, Route * 53 always considers the record to be healthy.
*Route 53 responds to DNS queries with up to eight healthy records; if you have * eight or fewer healthy records, Route 53 responds to all DNS queries with all * the healthy records.
*If you have more than eight healthy records, Route 53 responds to different * DNS resolvers with different combinations of healthy records.
*When all records are unhealthy, Route 53 responds to DNS queries with up to * eight unhealthy records.
*If a resource becomes unavailable after a resolver caches a response, client * software typically tries another of the IP addresses in the response.
*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:
*If you're creating or updating an alias resource record set, omit
* TTL. Amazon Route 53 uses the value of TTL for the
* alias target.
If you're associating this resource record set with a health check (if you're
* adding a HealthCheckId element), we recommend that you specify a
* TTL of 60 seconds or less so clients respond quickly to changes
* in health status.
All of the resource record sets in a group of weighted resource record sets
* must have the same value for TTL.
If a group of weighted resource record sets includes one or more weighted
* alias resource record sets for which the alias target is an ELB load balancer,
* we recommend that you specify a TTL of 60 seconds for all of the
* non-alias weighted resource record sets that have the same name and type. Values
* other than 60 seconds (the TTL for load balancers) will change the effect of the
* values that you specify for Weight.
Information about the resource records to act upon.
*If you're creating an alias resource record set, omit
* ResourceRecords.
* 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:
*You can't create an alias resource record set in a private hosted zone to * route traffic to a CloudFront distribution.
*For information about creating failover resource record sets in a private * hosted zone, see Configuring Failover in a Private Hosted Zone in the * Amazon Route 53 Developer Guide.
*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:
*By periodically sending a request to the endpoint that is specified in the * health check
*By aggregating the status of a specified group of health checks (calculated * health checks)
*By determining the current state of a CloudWatch alarm (CloudWatch metric * health checks)
*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:
** How Amazon Route 53 Determines Whether an Endpoint Is * Healthy *
** 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:
* Non-alias resource record sets: You're * checking the health of a group of non-alias resource record sets that have the * same routing policy, name, and type (such as multiple weighted records named * www.example.com with a type of A) and you specify health check IDs for all the * resource record sets.
*If the health check status for a resource record set is healthy, Route 53 * includes the record among the records that it responds to DNS queries * with.
*If the health check status for a resource record set is unhealthy, Route 53 * stops responding to DNS queries using the value for that resource record * set.
*If the health check status for all resource record sets in the group is * unhealthy, Route 53 considers all resource record sets in the group healthy and * responds to DNS queries accordingly.
** Alias resource record sets: You specify the * following settings:
*You set EvaluateTargetHealth to true for an alias
* resource record set in a group of resource record sets that have the
* same routing policy, name, and type (such as multiple weighted records
* named www.example.com with a type of A).
You configure the alias resource record set to route traffic to a * non-alias resource record set in the same hosted zone.
*You specify a health check ID for the non-alias resource record set. *
*If the health check status is healthy, Route 53 considers the alias resource * record set to be healthy and includes the alias record among the records that it * responds to DNS queries with.
*If the health check status is unhealthy, Route 53 stops responding to DNS * queries using the alias resource record set.
*The alias resource record set can also route traffic to a * group of non-alias resource record sets that have * the same routing policy, name, and type. In that configuration, associate * health checks with all of the resource record sets in the group of non-alias * resource record sets.
** 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:
The United States
*North America
*The default resource record set
** 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:
*Create a health check that has the same value for
* FullyQualifiedDomainName as the name of a resource record
* set.
Associate that health check with the resource record set.
*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.
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.
* 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:
*
* CREATE: Creates a resource record set that has the specified
* values.
* DELETE: Deletes a existing resource record set.
To delete the resource record set that is associated with a traffic policy
* instance, use DeleteTrafficPolicyInstance. Amazon 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.
* UPSERT: If a resource record set doesn't already exist, Route 53
* creates it. If a resource record set does exist, Route 53 updates it with the
* values in the request.
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.
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; } /** *This exception contains a list of messages that might contain one or more error * messages. Each error message indicates one error in the change batch.
* @public */ export declare class InvalidChangeBatch extends __BaseException { readonly name: "InvalidChangeBatch"; readonly $fault: "client"; /** * * @public */ messages?: string[] | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeNo health check exists with the specified ID.
* @public */ export declare class NoSuchHealthCheck extends __BaseException { readonly name: "NoSuchHealthCheck"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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:
* Add a tag to a health check or hosted zone:
* Key is the name that you want to give the new tag.
* Edit a tag: Key is the name of
* the tag that you want to change the Value for.
* Delete a key: Key is the name
* of the tag you want to remove.
* Give a name to a health check: Edit the
* default Name tag. In the Amazon Route 53 console, the list of your
* health checks includes a Name column that lets
* you see the name that you've given to each health check.
The value of Value depends on the operation that you want to
* perform:
* Add a tag to a health check or hosted zone:
* Value is the value that you want to give the new tag.
* Edit a tag: Value is the new
* value that you want to assign the tag.
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.
*The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
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 { } /** *The limit on the number of requests per second was exceeded.
* @public */ export declare class ThrottlingException extends __BaseException { readonly name: "ThrottlingException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA CIDR collection with this name and a different caller reference already exists in this account.
* @public */ export declare class CidrCollectionAlreadyExistsException extends __BaseException { readonly name: "CidrCollectionAlreadyExistsException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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; } /** * @public * @enum */ export declare const InsufficientDataHealthStatus: { readonly Healthy: "Healthy"; readonly LastKnownStatus: "LastKnownStatus"; readonly Unhealthy: "Unhealthy"; }; /** * @public */ export type InsufficientDataHealthStatus = (typeof InsufficientDataHealthStatus)[keyof typeof InsufficientDataHealthStatus]; /** * @public * @enum */ export declare const HealthCheckRegion: { readonly ap_northeast_1: "ap-northeast-1"; readonly ap_southeast_1: "ap-southeast-1"; readonly ap_southeast_2: "ap-southeast-2"; readonly eu_west_1: "eu-west-1"; readonly sa_east_1: "sa-east-1"; readonly us_east_1: "us-east-1"; readonly us_west_1: "us-west-1"; readonly us_west_2: "us-west-2"; }; /** * @public */ export type HealthCheckRegion = (typeof HealthCheckRegion)[keyof typeof HealthCheckRegion]; /** * @public * @enum */ export declare const HealthCheckType: { readonly CALCULATED: "CALCULATED"; readonly CLOUDWATCH_METRIC: "CLOUDWATCH_METRIC"; readonly HTTP: "HTTP"; readonly HTTPS: "HTTPS"; readonly HTTPS_STR_MATCH: "HTTPS_STR_MATCH"; readonly HTTP_STR_MATCH: "HTTP_STR_MATCH"; readonly RECOVERY_CONTROL: "RECOVERY_CONTROL"; readonly TCP: "TCP"; }; /** * @public */ export type HealthCheckType = (typeof HealthCheckType)[keyof typeof HealthCheckType]; /** *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:
* IPv4 address: four values between 0 and 255,
* separated by periods (.), for example, 192.0.2.44.
* IPv6 address: eight groups of four
* hexadecimal values, separated by colons (:), for example,
* 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten
* IPv6 addresses as described in RFC 5952, for example,
* 2001:db8:85a3::abcd:1:2345.
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:
** RFC 6598, IANA-Reserved IPv4 * Prefix for Shared Address Space *
*When the value of Type is CALCULATED or
* CLOUDWATCH_METRIC, omit IPAddress.
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.
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:
** HTTP: Route 53 tries to establish a TCP * connection. If successful, Route 53 submits an HTTP request and waits for an * HTTP status code of 200 or greater and less than 400.
** HTTPS: Route 53 tries to establish a TCP * connection. If successful, Route 53 submits an HTTPS request and waits for an * HTTP status code of 200 or greater and less than 400.
*If you specify HTTPS for the value of Type, the endpoint must
* support TLS v1.0, v1.1, or v1.2.
* HTTP_STR_MATCH: Route 53 tries to establish a
* TCP connection. If successful, Route 53 submits an HTTP request and searches the
* first 5,120 bytes of the response body for the string that you specify in
* SearchString.
* HTTPS_STR_MATCH: Route 53 tries to establish
* a TCP connection. If successful, Route 53 submits an HTTPS request
* and searches the first 5,120 bytes of the response body for the string that you
* specify in SearchString.
* TCP: Route 53 tries to establish a TCP * connection.
*
* CLOUDWATCH_METRIC: The health check is
* associated with a CloudWatch alarm. If the state of the alarm is
* OK, the health check is considered healthy. If the state is
* ALARM, the health check is considered unhealthy. If CloudWatch
* doesn't have sufficient data to determine whether the state is OK
* or ALARM, the health check status depends on the setting for
* InsufficientDataHealthStatus: Healthy,
* Unhealthy, or LastKnownStatus.
* CALCULATED: For health checks that monitor
* the status of other health checks, Route 53 adds up the number of health checks
* that Route 53 health checkers consider to be healthy and compares that number
* with the value of HealthThreshold.
* RECOVERY_CONTROL: The health check is associated with a
* Route53 Application Recovery Controller routing control. If the routing control
* state is ON, the health check is considered healthy. If the state
* is OFF, the health check is considered unhealthy.
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.
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 specify a value of 80 for Port and
* HTTP or HTTP_STR_MATCH for Type,
* Route 53 passes the value of FullyQualifiedDomainName to the
* endpoint in the Host header.
If you specify a value of 443 for Port and
* HTTPS or HTTPS_STR_MATCH for Type,
* Route 53 passes the value of FullyQualifiedDomainName to the
* endpoint in the Host header.
If you specify another value for Port and any value except
* TCP for Type, Route 53 passes
* FullyQualifiedDomainName:Port to the endpoint in 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.
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.
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.
*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.
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.
*If you don't specify a value for FailureThreshold, the default value is
* three health checks.
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.
*You can't change the value of MeasureLatency after you create a
* health check.
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:
** Health checks that check the health of * endpoints: Route 53 stops submitting requests to your * application, server, or other resource.
** Calculated health checks: Route 53 stops * aggregating the status of the referenced health checks.
** Health checks that monitor CloudWatch alarms: * Route 53 stops monitoring the corresponding CloudWatch metrics.
*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:
*If you specify a number greater than the number of child health checks, Route * 53 always considers this health check to be unhealthy.
*If you specify 0, Route 53 always considers this health check to
* be healthy.
(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.
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.
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:
*
* Healthy: Route 53 considers the health check to be
* healthy.
* Unhealthy: Route 53 considers the health check to be
* unhealthy.
* LastKnownStatus: Route 53 uses the status of the health check
* from the last time that CloudWatch had sufficient data to determine the alarm
* state. For new health checks that have no last known status, the default status
* for the health check is healthy.
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:
If you send a CreateHealthCheck request with the same
* CallerReference and settings as a previous request, and if the
* health check doesn't exist, Amazon Route 53 creates the health check. If the
* health check does exist, Route 53 returns the settings for the existing health
* check.
If you send a CreateHealthCheck request with the same
* CallerReference as a deleted health check, regardless of the
* settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same
* CallerReference as an existing health check but with different
* settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique
* CallerReference but settings identical to an existing health
* check, Route 53 creates the health check.
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.
A complex type that contains settings for a new health check.
* @public */ HealthCheckConfig: HealthCheckConfig | undefined; } /** * @public * @enum */ export declare const ComparisonOperator: { readonly GreaterThanOrEqualToThreshold: "GreaterThanOrEqualToThreshold"; readonly GreaterThanThreshold: "GreaterThanThreshold"; readonly LessThanOrEqualToThreshold: "LessThanOrEqualToThreshold"; readonly LessThanThreshold: "LessThanThreshold"; }; /** * @public */ export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator]; /** *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; } /** * @public * @enum */ export declare const Statistic: { readonly Average: "Average"; readonly Maximum: "Maximum"; readonly Minimum: "Minimum"; readonly SampleCount: "SampleCount"; readonly Sum: "Sum"; }; /** * @public */ export type Statistic = (typeof Statistic)[keyof typeof Statistic]; /** *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.
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.
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; } /** *The health check you're attempting to create already exists. Amazon Route 53 returns * this error when you submit a request that has the following values:
*The same value for CallerReference as an existing health check,
* and one or more values that differ from the existing health check that has the
* same caller reference.
The same value for CallerReference as a health check that you
* created and later deleted, regardless of the other settings in the
* request.
This health check can't be created because the current account has reached the limit * on the number of active health checks.
*For information about default limits, see Limits in the * Amazon Route 53 Developer Guide.
*For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support * Center.
*You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support * Center.
* @public */ export declare class TooManyHealthChecks extends __BaseException { readonly name: "TooManyHealthChecks"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
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.
(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.
(Optional) A complex type that contains the following optional values:
*For public and private hosted zones, an optional comment
*For private hosted zones, an optional PrivateZone element
If you don't specify a comment or the PrivateZone element, omit
* HostedZoneConfig and the other elements.
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.
A complex type that lists the name servers in a delegation set, as well as the
* CallerReference and the ID for the delegation set.
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.
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; } /** *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.
The value that you specified for CallerReference when you created the
* hosted zone.
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.
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; } /** *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.
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; } /** *You can create a hosted zone that has the same name as an existing hosted zone * (example.com is common), but there is a limit to the number of hosted zones that have * the same name. If you get this error, Amazon Route 53 has reached that limit. If you own * the domain name and Route 53 generates this error, contact Customer Support.
* @public */ export declare class DelegationSetNotAvailable extends __BaseException { readonly name: "DelegationSetNotAvailable"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA reusable delegation set with the specified ID does not exist.
* @public */ export declare class DelegationSetNotReusable extends __BaseException { readonly name: "DelegationSetNotReusable"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe hosted zone you're trying to create already exists. Amazon Route 53 returns this
* error when a hosted zone has already been created with the specified
* CallerReference.
The specified domain name is not valid.
* @public */ export declare class InvalidDomainName extends __BaseException { readonly name: "InvalidDomainName"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA reusable delegation set with the specified ID does not exist.
* @public */ export declare class NoSuchDelegationSet extends __BaseException { readonly name: "NoSuchDelegationSet"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis operation can't be completed either because the current account has reached the * limit on the number of hosted zones or because you've reached the limit on the number of * hosted zones that can be associated with a reusable delegation set.
*For information about default limits, see Limits in the * Amazon Route 53 Developer Guide.
*To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.
*To get the current limit on hosted zones that can be associated with a reusable * delegation set, see GetReusableDelegationSetLimit.
*To request a higher limit, create a * case with the Amazon Web Services Support Center.
* @public */ export declare class TooManyHostedZones extends __BaseException { readonly name: "TooManyHostedZones"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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:
*Enabled
*ECC_NIST_P256
*Sign and verify
*The key policy must give permission for the following actions:
*DescribeKey
*GetPublicKey
*Sign
*The key policy must also include the Amazon Route 53 service in the * principal for your account. Specify the following:
*
* "Service": "dnssec-route53.amazonaws.com"
*
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.
A string specifying the initial status of the key-signing key (KSK). You can set the
* value to ACTIVE or INACTIVE.
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.
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:
*Enabled
*ECC_NIST_P256
*Sign and verify
*The key policy must give permission for the following actions:
*DescribeKey
*GetPublicKey
*Sign
*The key policy must also include the Amazon Route 53 service in the * principal for your account. Specify the following:
*
* "Service": "dnssec-route53.amazonaws.com"
*
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:
*The KSK is being used for signing.
*The KSK is not being used for signing.
*The KSK is in the process of being deleted.
*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.
*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.
*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.
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; } /** *Parameter name is not valid.
* @public */ export declare class InvalidArgument extends __BaseException { readonly name: "InvalidArgument"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe key-signing key (KSK) name that you specified isn't a valid name.
* @public */ export declare class InvalidKeySigningKeyName extends __BaseException { readonly name: "InvalidKeySigningKeyName"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeYou've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.
* @public */ export declare class KeySigningKeyAlreadyExists extends __BaseException { readonly name: "KeySigningKeyAlreadyExists"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeYou've reached the limit for the number of key-signing keys (KSKs). Remove at least * one KSK, and then try again.
* @public */ export declare class TooManyKeySigningKeys extends __BaseException { readonly name: "TooManyKeySigningKeys"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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; } /** *Amazon Route 53 doesn't have the permissions required to create log streams and send * query logs to log streams. Possible causes include the following:
*There is no resource policy that specifies the log group ARN in the value for
* Resource.
The resource policy that includes the log group ARN in the value for
* Resource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
*The Key management service (KMS) key you specified doesn’t exist or it can’t * be used with the log group associated with query log. Update or provide a * resource policy to grant permissions for the KMS key.
*The Key management service (KMS) key you specified is marked as * disabled for the log group associated with query log. Update or provide * a resource policy to grant permissions for the KMS key.
*There is no CloudWatch Logs log group with the specified ARN.
* @public */ export declare class NoSuchCloudWatchLogsLogGroup extends __BaseException { readonly name: "NoSuchCloudWatchLogsLogGroup"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeYou can create only one query logging configuration for a hosted zone, and a query * logging configuration already exists for this hosted zone.
* @public */ export declare class QueryLoggingConfigAlreadyExists extends __BaseException { readonly name: "QueryLoggingConfigAlreadyExists"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
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 delegation set with the same owner and caller reference combination has already been * created.
* @public */ export declare class DelegationSetAlreadyCreated extends __BaseException { readonly name: "DelegationSetAlreadyCreated"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe specified delegation set has already been marked as reusable.
* @public */ export declare class DelegationSetAlreadyReusable extends __BaseException { readonly name: "DelegationSetAlreadyReusable"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe specified HostedZone can't be found.
* @public */ export declare class HostedZoneNotFound extends __BaseException { readonly name: "HostedZoneNotFound"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
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.
The comment that you specify in the CreateTrafficPolicy request, if
* any.
A complex type that contains the response information for the
* CreateTrafficPolicy request.
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; } /** *The format of the traffic policy document that you specified in the
* Document element is not valid.
This traffic policy can't be created because the current account has reached the limit * on the number of traffic policies.
*For information about default limits, see Limits in the * Amazon Route 53 Developer Guide.
*To get the current limit for an account, see GetAccountLimit.
*To request a higher limit, create a * case with the Amazon Web Services Support Center.
* @public */ export declare class TooManyTrafficPolicies extends __BaseException { readonly name: "TooManyTrafficPolicies"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA traffic policy that has the same value for Name already exists.
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:
Amazon Route 53 has finished creating resource record sets, and changes * have propagated to all Route 53 edge locations.
*Route 53 is creating the resource record sets. Use
* GetTrafficPolicyInstance to confirm that the
* CreateTrafficPolicyInstance request completed
* successfully.
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.
If State is Failed, an explanation of the reason for the
* failure. If State is another value, Message is empty.
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.
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; } /** *No traffic policy exists with the specified ID.
* @public */ export declare class NoSuchTrafficPolicy extends __BaseException { readonly name: "NoSuchTrafficPolicy"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis traffic policy instance can't be created because the current account has reached * the limit on the number of traffic policy instances.
*For information about default limits, see Limits in the * Amazon Route 53 Developer Guide.
*For information about how to get the current limit for an account, see GetAccountLimit.
*To request a higher limit, create a * case with the Amazon Web Services Support Center.
* @public */ export declare class TooManyTrafficPolicyInstances extends __BaseException { readonly name: "TooManyTrafficPolicyInstances"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThere is already a traffic policy instance with the specified ID.
* @public */ export declare class TrafficPolicyInstanceAlreadyExists extends __BaseException { readonly name: "TrafficPolicyInstanceAlreadyExists"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
The comment that you specified in the CreateTrafficPolicyVersion request,
* if any.
A complex type that contains the response information for the
* CreateTrafficPolicyVersion request.
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; } /** *This traffic policy version can't be created because you've reached the limit of 1000 * on the number of versions that you can create for the current traffic policy.
*To create more traffic policy versions, you can use GetTrafficPolicy * to get the traffic policy document for a specified traffic policy version, and then use * CreateTrafficPolicy to create a new traffic policy using the traffic policy * document.
* @public */ export declare class TooManyTrafficPolicyVersionsForCurrentPolicy extends __BaseException { readonly name: "TooManyTrafficPolicyVersionsForCurrentPolicy"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
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; } /** *You've created the maximum number of authorizations that can be created for the
* specified hosted zone. To authorize another VPC to be associated with the hosted zone,
* submit a DeleteVPCAssociationAuthorization request to remove an existing
* authorization. To get a list of existing authorizations, submit a
* ListVPCAssociationAuthorizations request.
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; } /** *The key-signing key (KSK) is specified in a parent DS record.
* @public */ export declare class KeySigningKeyInParentDSRecord extends __BaseException { readonly name: "KeySigningKeyInParentDSRecord"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe key-signing key (KSK) that you specified can't be deactivated because it's the * only KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable * another KSK.
* @public */ export declare class KeySigningKeyInUse extends __BaseException { readonly name: "KeySigningKeyInUse"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis CIDR collection is in use, and isn't empty.
* @public */ export declare class CidrCollectionInUseException extends __BaseException { readonly name: "CidrCollectionInUseException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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 { } /** *This error code is not in use.
* * @deprecated * @public */ export declare class HealthCheckInUse extends __BaseException { readonly name: "HealthCheckInUse"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
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; } /** *The hosted zone contains resource records that are not SOA or NS records.
* @public */ export declare class HostedZoneNotEmpty extends __BaseException { readonly name: "HostedZoneNotEmpty"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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 { } /** *There is no DNS query logging configuration with the specified ID.
* @public */ export declare class NoSuchQueryLoggingConfig extends __BaseException { readonly name: "NoSuchQueryLoggingConfig"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe specified delegation contains associated hosted zones which must be deleted before * the reusable delegation set can be deleted.
* @public */ export declare class DelegationSetInUse extends __BaseException { readonly name: "DelegationSetInUse"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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 { } /** *One or more traffic policy instances were created by using the specified traffic * policy.
* @public */ export declare class TrafficPolicyInUse extends __BaseException { readonly name: "TrafficPolicyInUse"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
*An empty element.
* @public */ export interface DeleteTrafficPolicyInstanceResponse { } /** *No traffic policy instance exists with the specified ID.
* @public */ export declare class NoSuchTrafficPolicyInstance extends __BaseException { readonly name: "NoSuchTrafficPolicyInstance"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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 { } /** *The VPC that you specified is not authorized to be associated with the hosted * zone.
* @public */ export declare class VPCAssociationAuthorizationNotFound extends __BaseException { readonly name: "VPCAssociationAuthorizationNotFound"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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; } /** *The hosted zone doesn't have any DNSSEC resources.
* @public */ export declare class DNSSECNotFound extends __BaseException { readonly name: "DNSSECNotFound"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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; } /** *The VPC that you're trying to disassociate from the private hosted zone is the last * VPC that is associated with the hosted zone. Amazon Route 53 doesn't support * disassociating the last VPC from a hosted zone.
* @public */ export declare class LastVPCAssociation extends __BaseException { readonly name: "LastVPCAssociation"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe specified VPC and hosted zone are not currently associated.
* @public */ export declare class VPCAssociationNotFound extends __BaseException { readonly name: "VPCAssociationNotFound"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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; } /** *The hosted zone nameservers don't match the parent nameservers. The hosted zone and * parent must have the same nameservers.
* @public */ export declare class HostedZonePartiallyDelegated extends __BaseException { readonly name: "HostedZonePartiallyDelegated"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA key-signing key (KSK) with ACTIVE status wasn't found.
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:
** MAX_HEALTH_CHECKS_BY_OWNER: The maximum * number of health checks that you can create using the current account.
** MAX_HOSTED_ZONES_BY_OWNER: The maximum number * of hosted zones that you can create using the current account.
** MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The * maximum number of reusable delegation sets that you can create using the current * account.
** MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum * number of traffic policies that you can create using the current account.
** MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The * maximum number of traffic policy instances that you can create using the current * account. (Traffic policy instances are referred to as traffic flow policy * records in the Amazon Route 53 console.)
*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.
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.
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.
A complex type that contains the ChangeInfo element.
A complex type that contains information about the specified change batch.
* @public */ ChangeInfo: ChangeInfo | undefined; } /** *A change with the specified change ID does not exist.
* @public */ export declare class NoSuchChange extends __BaseException { readonly name: "NoSuchChange"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeEmpty request.
* @public */ export interface GetCheckerIpRangesRequest { } /** *A complex type that contains the CheckerIpRanges element.
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:
*DNSSEC signing is enabled for the hosted zone.
*DNSSEC signing is not enabled for the hosted zone.
*DNSSEC signing is in the process of being removed for the hosted * zone.
*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.
*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.
*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.
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:
** AF: Africa
** AN: Antarctica
** AS: Asia
** EU: Europe
** OC: Oceania
** NA: North America
** SA: South America
*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.
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; } /** *Amazon Route 53 doesn't support the specified geographic location. For a list of * supported geolocation codes, see the GeoLocation data * type.
* @public */ export declare class NoSuchGeoLocation extends __BaseException { readonly name: "NoSuchGeoLocation"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
A complex type that contains information about one health check that is associated * with the current Amazon Web Services account.
* @public */ HealthCheck: HealthCheck | undefined; } /** *The resource you're trying to access is unsupported on this Amazon Route 53 * endpoint.
* @public */ export declare class IncompatibleVersion extends __BaseException { readonly name: "IncompatibleVersion"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA 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.
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.
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.
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.
The IP address of the Amazon Route 53 health checker that provided the failure reason
* in StatusReport.
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.
A list that contains one Observation element for each Amazon Route 53
* health checker that is reporting a last failure reason.
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.
A complex type that contains the response to a GetHealthCheck
* request.
A list that contains one HealthCheckObservation element for each Amazon
* Route 53 health checker that is reporting a status about the health check
* endpoint.
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.
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.
The total number of public and private hosted zones that are associated with the * current Amazon Web Services account.
* @public */ HostedZoneCount: number | undefined; } /** * @public * @enum */ export declare const HostedZoneLimitType: { readonly MAX_RRSETS_BY_ZONE: "MAX_RRSETS_BY_ZONE"; readonly MAX_VPCS_ASSOCIATED_BY_ZONE: "MAX_VPCS_ASSOCIATED_BY_ZONE"; }; /** * @public */ export type HostedZoneLimitType = (typeof HostedZoneLimitType)[keyof typeof HostedZoneLimitType]; /** *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:
** MAX_RRSETS_BY_ZONE: The maximum number of * records that you can create in the specified hosted zone.
** MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum * number of Amazon VPCs that you can associate with the specified private hosted * zone.
*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:
** MAX_RRSETS_BY_ZONE: The maximum number of * records that you can create in the specified hosted zone.
** MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum * number of Amazon VPCs that you can associate with the specified private hosted * zone.
*The current value for the limit that is specified by Type.
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.
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.
The specified hosted zone is a public hosted zone, not a private hosted zone.
* @public */ export declare class HostedZoneNotPrivate extends __BaseException { readonly name: "HostedZoneNotPrivate"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
A complex type that contains information about the reusable delegation set.
* @public */ DelegationSet: DelegationSet | undefined; } /** * @public * @enum */ export declare const ReusableDelegationSetLimitType: { readonly MAX_ZONES_BY_REUSABLE_DELEGATION_SET: "MAX_ZONES_BY_REUSABLE_DELEGATION_SET"; }; /** * @public */ export type ReusableDelegationSetLimitType = (typeof ReusableDelegationSetLimitType)[keyof typeof ReusableDelegationSetLimitType]; /** *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.
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.
The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET
* limit.
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; } /** *The CIDR collection location doesn't match any locations in your account.
* @public */ export declare class NoSuchCidrLocationException extends __BaseException { readonly name: "NoSuchCidrLocationException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeAn 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.
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.
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.
(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.
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.
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.
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.
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.
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.
The value that you specified for MaxItems in the request.
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.
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.
A complex type that contains the response to a ListHealthChecks
* request.
A complex type that contains one HealthCheck element for each health
* check that is associated with the current Amazon Web Services account.
For the second and subsequent calls to ListHealthChecks,
* Marker is the value that you specified for the marker
* parameter in the previous request.
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.
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.
The value that you specified for the maxitems parameter in the call to
* ListHealthChecks that produced the current response.
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.
(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.
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.
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.
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.
The value that you specified for the maxitems parameter in the call to
* ListHostedZones that produced the current response.
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.
(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.
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.
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.
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.
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.
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.
The value that you specified for the maxitems parameter in the call to
* ListHostedZonesByName that produced the current response.
The value that you specified to get the second or subsequent page of results is * invalid.
* @public */ export declare class InvalidPaginationToken extends __BaseException { readonly name: "InvalidPaginationToken"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeLists 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.
(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.
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.
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.
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.
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.
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.
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.
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.
The value that you specified for MaxItems in the most recent
* ListHostedZonesByVPC request.
The value that you will use for NextToken in the next
* ListHostedZonesByVPC request.
(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.
(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.
(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.
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.
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.
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:
** API Gateway custom regional API or edge-optimized * API: A
** CloudFront distribution: A or AAAA
** Elastic Beanstalk environment that has a regionalized * subdomain: A
** Elastic Load Balancing load balancer: A | * AAAA
** S3 bucket: A
** VPC interface VPC endpoint: A
** Another resource record set in this hosted * zone: The type of the resource record set that the alias * references.
*Constraint: Specifying type without specifying name returns
* an InvalidInput error.
* 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.
(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.
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.
If the results were truncated, the name of the next record in the list.
*This element is present only if IsTruncated is true.
If the results were truncated, the type of the next record in the list.
*This element is present only if IsTruncated is true.
* 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.
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.
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.
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.
The value that you specified for the maxitems parameter in the call to
* ListReusableDelegationSets that produced the current response.
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.
*The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
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.
*The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
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.
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.
*The resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
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.
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.
(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.
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.
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.
If the value of IsTruncated is true,
* TrafficPolicyIdMarker is the ID of the first traffic policy in the next
* group of MaxItems traffic policies.
The value that you specified for the MaxItems parameter in the
* ListTrafficPolicies request that produced the current response.
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.
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.
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.
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.
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.
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.
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.
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.
*
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.
The value that you specified for the MaxItems parameter in the call to
* ListTrafficPolicyInstances that produced the current response.
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.
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.
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.
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.
If IsTruncated is true,
* TrafficPolicyInstanceNameMarker is the name of the first traffic policy
* instance in the next group of traffic policy instances.
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.
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.
The value that you specified for the MaxItems parameter in the
* ListTrafficPolicyInstancesByHostedZone request that produced the
* current response.
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.
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.
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.
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.
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.
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.
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.
If IsTruncated is true,
* TrafficPolicyInstanceNameMarker is the name of the first traffic policy
* instance in the next group of MaxItems traffic policy instances.
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.
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.
The value that you specified for the MaxItems parameter in the call to
* ListTrafficPolicyInstancesByPolicy that produced the current
* response.
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.
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.
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.
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.
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.
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.
The value that you specified for the maxitems parameter in the
* ListTrafficPolicyVersions request that produced the current
* response.
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.
* 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.
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.
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).
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.
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:
* IPv4: Specify a value between 0 and 32
** IPv6: Specify a value between 0 and * 128
*A complex type that contains the response to a TestDNSAnswer request.
*
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.
The protocol that Amazon Route 53 used to respond to the request, either
* UDP or TCP.
The value of HealthCheckVersion in the request doesn't match the value of
* HealthCheckVersion in the health check.
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.
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:
If the value in the UpdateHealthCheck request matches the value
* of HealthCheckVersion in the health check, Route 53 updates the
* health check with the new settings.
If the value of HealthCheckVersion in the health check is
* greater, the health check was changed after you got the version number. Route 53
* does not update the health check, and it returns a
* HealthCheckVersionMismatch error.
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:
* IPv4 address: four values between 0 and 255,
* separated by periods (.), for example, 192.0.2.44.
* IPv6 address: eight groups of four
* hexadecimal values, separated by colons (:), for example,
* 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten
* IPv6 addresses as described in RFC 5952, for example,
* 2001:db8:85a3::abcd:1:2345.
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:
Linux: Elastic IP * Addresses (EIP) in the Amazon EC2 User Guide for Linux * Instances *
*Windows: Elastic IP * Addresses (EIP) in the Amazon EC2 User Guide for Windows * Instances *
*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:
** RFC 6598, IANA-Reserved IPv4 * Prefix for Shared Address Space *
*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.
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 specify a value of 80 for Port and
* HTTP or HTTP_STR_MATCH for Type,
* Route 53 passes the value of FullyQualifiedDomainName to the
* endpoint in the Host header.
If you specify a value of 443 for Port and
* HTTPS or HTTPS_STR_MATCH for Type,
* Route 53 passes the value of FullyQualifiedDomainName to the
* endpoint in the Host header.
If you specify another value for Port and any value except
* TCP for Type, Route 53 passes
*
* FullyQualifiedDomainName:Port
*
* to the endpoint in 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.
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.)
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.
*If you don't specify a value for FailureThreshold, the default value is
* three health checks.
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:
** Health checks that check the health of * endpoints: Route 53 stops submitting requests to your * application, server, or other resource.
** Calculated health checks: Route 53 stops * aggregating the status of the referenced health checks.
** Health checks that monitor CloudWatch alarms: * Route 53 stops monitoring the corresponding CloudWatch metrics.
*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 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:
*If you specify a number greater than the number of child health checks, Route * 53 always considers this health check to be unhealthy.
*If you specify 0, Route 53 always considers this health check to
* be healthy.
A complex type that contains one ChildHealthCheck element for each health
* check that you want to associate with a CALCULATED health check.
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.
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.
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:
*
* Healthy: Route 53 considers the health check to be
* healthy.
* Unhealthy: Route 53 considers the health check to be
* unhealthy.
* LastKnownStatus: By default, Route 53 uses the status of the
* health check from the last time CloudWatch had sufficient data to determine the
* alarm state. For new health checks that have no last known status, the status
* for the health check is healthy.
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:
* ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null.
* FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null.
* Regions: Route 53 resets the Regions list to the default set of regions.
* ResourcePath: Route 53 resets ResourcePath to null.
A complex type that contains the response to the UpdateHealthCheck
* request.
A complex type that contains the response to an UpdateHealthCheck
* request.
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.
A complex type that contains the response to the UpdateHostedZoneComment
* request.
A complex type that contains the response to the UpdateHostedZoneComment
* request.
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.
The value of Version for the traffic policy that you want to update the
* comment for.
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; } /** *You tried to update a traffic policy instance by using a traffic policy version that
* has a different DNS type than the current type for the instance. You specified the type
* in the JSON document in the CreateTrafficPolicy or
* CreateTrafficPolicyVersionrequest.
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; }