@aws-sdk/client-route-53

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { Route53ServiceException as __BaseException } from "./Route53ServiceException"; /** * @public * @enum */ export declare const AccountLimitType: { readonly MAX_HEALTH_CHECKS_BY_OWNER: "MAX_HEALTH_CHECKS_BY_OWNER"; readonly MAX_HOSTED_ZONES_BY_OWNER: "MAX_HOSTED_ZONES_BY_OWNER"; readonly MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER"; readonly MAX_TRAFFIC_POLICIES_BY_OWNER: "MAX_TRAFFIC_POLICIES_BY_OWNER"; readonly MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER"; }; /** * @public */ export type AccountLimitType = (typeof AccountLimitType)[keyof typeof AccountLimitType]; /** * 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: * <ul> * <li> * * MAX_HEALTH_CHECKS_BY_OWNER: The maximum * number of health checks that you can create using the current account. * </li> * <li> * * MAX_HOSTED_ZONES_BY_OWNER: The maximum number * of hosted zones that you can create using the current account. * </li> * <li> * * MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The * maximum number of reusable delegation sets that you can create using the current * account. * </li> * <li> * * MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum * number of traffic policies that you can create using the current account. * </li> * <li> * * 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.) * </li> * </ul> * @public */ Type: AccountLimitType | undefined; /** * The current value for the limit that is specified by <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type">Type</a>. * @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). <code>Name</code> can include * numbers, letters, and underscores (_). <code>Name</code> must be unique for each * key-signing key in the same hosted zone. * @public */ Name: string | undefined; } /** * @public * @enum */ export declare const ChangeStatus: { readonly INSYNC: "INSYNC"; readonly PENDING: "PENDING"; }; /** * @public */ export type ChangeStatus = (typeof ChangeStatus)[keyof typeof ChangeStatus]; /** * 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 <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html">GetChange</a> action to get * detailed information about the change. * @public */ Id: string | undefined; /** * The current state of the request. <code>PENDING</code> indicates that this request has * not yet been applied to all Amazon Route 53 DNS servers. * @public */ Status: ChangeStatus | undefined; /** * The date and time that the change request was submitted in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601 format</a> and Coordinated * Universal Time (UTC). For example, the value <code>2017-03-27T17:48:16.751Z</code> * represents March 27, 2017 at 17:48:16.751 UTC. * @public */ SubmittedAt: Date | undefined; /** * A comment you can provide. * @public */ Comment?: string | undefined; } /** * @public */ export interface ActivateKeySigningKeyResponse { /** * A complex type that describes change information about changes made to your hosted * zone. * @public */ ChangeInfo: ChangeInfo | undefined; } /** * 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: __ExceptionOptionType<ConcurrentModification, __BaseException>); } /** * The input is not valid. * @public */ export declare class InvalidInput extends __BaseException { readonly name: "InvalidInput"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidInput, __BaseException>); } /** * The key-signing key (KSK) status isn't valid or another KSK has the status * <code>INTERNAL_FAILURE</code>. * @public */ export declare class InvalidKeySigningKeyStatus extends __BaseException { readonly name: "InvalidKeySigningKeyStatus"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidKeySigningKeyStatus, __BaseException>); } /** * 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: __ExceptionOptionType<InvalidKMSArn, __BaseException>); } /** * Your hosted zone status isn't valid for this operation. In the hosted zone, change the * status to enable <code>DNSSEC</code> or disable <code>DNSSEC</code>. * @public */ export declare class InvalidSigningStatus extends __BaseException { readonly name: "InvalidSigningStatus"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidSigningStatus, __BaseException>); } /** * 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: __ExceptionOptionType<NoSuchKeySigningKey, __BaseException>); } /** * @public * @enum */ export declare const CloudWatchRegion: { 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 CloudWatchRegion = (typeof CloudWatchRegion)[keyof typeof CloudWatchRegion]; /** * A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 * health checkers to use to determine whether the specified health check is * healthy. * @public */ export interface AlarmIdentifier { /** * For the CloudWatch alarm that you want Route 53 health checkers to use to determine * whether this health check is healthy, the region that the alarm was created in. * For the current list of CloudWatch regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/cw_region.html">Amazon CloudWatch endpoints and * quotas</a> 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. * <note> * Route 53 supports CloudWatch alarms with the following features: * <ul> * <li> * Standard-resolution metrics. High-resolution metrics aren't supported. For * more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics">High-Resolution Metrics</a> in the Amazon CloudWatch User * Guide. * </li> * <li> * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended * statistics aren't supported. * </li> * </ul> * </note> * @public */ Name: string | undefined; } /** * * Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that * you want to route traffic to. * When creating resource record sets for a private hosted zone, note the * following: * <ul> * <li> * For information about creating failover resource record sets in a private * hosted zone, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html">Configuring Failover in a Private Hosted Zone</a>. * </li> * </ul> * @public */ export interface AliasTarget { /** * * Alias resource records sets only: The value used depends on where * you want to route traffic: * <dl> * <dt>Amazon API Gateway custom regional APIs and edge-optimized APIs</dt> * <dd> * Specify the hosted zone ID for your API. You can get the applicable value * using the CLI command <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html">get-domain-names</a>: * <ul> * <li> * For regional APIs, specify the value of * <code>regionalHostedZoneId</code>. * </li> * <li> * For edge-optimized APIs, specify the value of * <code>distributionHostedZoneId</code>. * </li> * </ul> * </dd> * <dt>Amazon Virtual Private Cloud interface VPC endpoint</dt> * <dd> * Specify the hosted zone ID for your interface endpoint. You can get the * value of <code>HostedZoneId</code> using the CLI command * <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html">describe-vpc-endpoints</a>. * </dd> * <dt>CloudFront distribution</dt> * <dd> * Specify <code>Z2FDTNDATAQYW2</code>. * <note> * Alias resource record sets for CloudFront can't be created in a * private zone. * </note> * </dd> * <dt>Elastic Beanstalk environment</dt> * <dd> * 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 <a href="https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html">Elastic Beanstalk * endpoints and quotas</a> in the Amazon Web Services * General Reference. * </dd> * <dt>ELB load balancer</dt> * <dd> * Specify the value of the hosted zone ID for the load balancer. Use the * following methods to get the hosted zone ID: * <ul> * <li> * * <a href="https://docs.aws.amazon.com/general/latest/gr/elb.html">Elastic Load Balancing endpoints and quotas</a> 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. * </li> * <li> * * 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. * </li> * <li> * * Elastic Load Balancing API: Use * <code>DescribeLoadBalancers</code> to get the applicable value. * For more information, see the applicable guide: * <ul> * <li> * Classic Load Balancers: Use <a href="https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> to get the value of * <code>CanonicalHostedZoneNameId</code>. * </li> * <li> * Application and Network Load Balancers: Use <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> to get the value of * <code>CanonicalHostedZoneId</code>. * </li> * </ul> * </li> * <li> * * CLI: Use * <code>describe-load-balancers</code> to get the applicable * value. For more information, see the applicable guide: * <ul> * <li> * Classic Load Balancers: Use <a href="http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html">describe-load-balancers</a> to get the value of * <code>CanonicalHostedZoneNameId</code>. * </li> * <li> * Application and Network Load Balancers: Use <a href="http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html">describe-load-balancers</a> to get the value of * <code>CanonicalHostedZoneId</code>. * </li> * </ul> * </li> * </ul> * </dd> * <dt>Global Accelerator accelerator</dt> * <dd> * Specify <code>Z2BJ6XQ5FK7U4H</code>. * </dd> * <dt>An Amazon S3 bucket configured as a static website</dt> * <dd> * Specify the hosted zone ID for the region that you created the bucket in. * For more information about valid values, see the table <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints">Amazon S3 * Website Endpoints</a> in the Amazon Web Services General * Reference. * </dd> * <dt>Another Route 53 resource record set in your hosted zone</dt> * <dd> * 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.) * </dd> * </dl> * @public */ HostedZoneId: string | undefined; /** * * Alias resource record sets only: The value that you specify * depends on where you want to route queries: * <dl> * <dt>Amazon API Gateway custom regional APIs and edge-optimized APIs</dt> * <dd> * Specify the applicable domain name for your API. You can get the * applicable value using the CLI command <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html">get-domain-names</a>: * <ul> * <li> * For regional APIs, specify the value of * <code>regionalDomainName</code>. * </li> * <li> * For edge-optimized APIs, specify the value of * <code>distributionDomainName</code>. This is the name of the * associated CloudFront distribution, such as * <code>da1b2c3d4e5.cloudfront.net</code>. * </li> * </ul> * <note> * The name of the record that you're creating must match a custom domain * name for your API, such as <code>api.example.com</code>. * </note> * </dd> * <dt>Amazon Virtual Private Cloud interface VPC endpoint</dt> * <dd> * Enter the API endpoint for the interface endpoint, such as * <code>vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com</code>. * For edge-optimized APIs, this is the domain name for the corresponding * CloudFront distribution. You can get the value of <code>DnsName</code> using * the CLI command <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html">describe-vpc-endpoints</a>. * </dd> * <dt>CloudFront distribution</dt> * <dd> * 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 <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html">Using Alternate * Domain Names (CNAMEs)</a> 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. * <note> * 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. * </note> * </dd> * <dt>Elastic Beanstalk environment</dt> * <dd> * 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 * <code>my-environment.us-west-2.elasticbeanstalk.com</code> * is a regionalized domain name. * <important> * 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. * </important> * For Elastic Beanstalk environments that have regionalized subdomains, * specify the <code>CNAME</code> attribute for the environment. You can use * the following methods to get the value of the CNAME attribute: * <ul> * <li> * * Amazon Web Services Management Console: For information about * how to get the value by using the console, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html">Using Custom * Domains with Elastic Beanstalk</a> in the * Elastic Beanstalk Developer * Guide. * </li> * <li> * * Elastic Beanstalk API: Use the * <code>DescribeEnvironments</code> action to get the value of the * <code>CNAME</code> attribute. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html">DescribeEnvironments</a> in the Elastic Beanstalk API Reference. * </li> * <li> * * CLI: Use the * <code>describe-environments</code> command to get the value of * the <code>CNAME</code> attribute. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html">describe-environments</a> in the CLI Command Reference. * </li> * </ul> * </dd> * <dt>ELB load balancer</dt> * <dd> * 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. * <ul> * <li> * * 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. * </li> * <li> * * Elastic Load Balancing API: Use * <code>DescribeLoadBalancers</code> to get the value of * <code>DNSName</code>. For more information, see the applicable * guide: * <ul> * <li> * Classic Load Balancers: <a href="https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> * * </li> * <li> * Application and Network Load Balancers: <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> * * </li> * </ul> * </li> * <li> * * CLI: Use * <code>describe-load-balancers</code> to get the value of * <code>DNSName</code>. For more information, see the applicable * guide: * <ul> * <li> * Classic Load Balancers: <a href="http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html">describe-load-balancers</a> * * </li> * <li> * Application and Network Load Balancers: <a href="http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html">describe-load-balancers</a> * * </li> * </ul> * </li> * </ul> * </dd> * <dt>Global Accelerator accelerator</dt> * <dd> * Specify the DNS name for your accelerator: * <ul> * <li> * * Global Accelerator API: To get * the DNS name, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html">DescribeAccelerator</a>. * </li> * <li> * * CLI: To get the * DNS name, use <a href="https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html">describe-accelerator</a>. * </li> * </ul> * </dd> * <dt>Amazon S3 bucket that is configured as a static website</dt> * <dd> * Specify the domain name of the Amazon S3 website endpoint that you created * the bucket in, for example, <code>s3-website.us-east-2.amazonaws.com</code>. * For more information about valid values, see the table <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints">Amazon S3 * Website Endpoints</a> in the Amazon Web Services General * Reference. For more information about using S3 buckets for * websites, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html">Getting Started * with Amazon Route 53</a> in the Amazon Route 53 Developer * Guide. * * </dd> * <dt>Another Route 53 resource record set</dt> * <dd> * Specify the value of the <code>Name</code> element for a resource record * set in the current hosted zone. * <note> * 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 <code>Type</code> is * <code>CNAME</code>. 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. * </note> * </dd> * </dl> * @public */ DNSName: string | undefined; /** * * Applies only to alias, failover alias, geolocation alias, latency alias, and * weighted alias resource record sets: When * <code>EvaluateTargetHealth</code> is <code>true</code>, 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: * <dl> * <dt>CloudFront distributions</dt> * <dd> * You can't set <code>EvaluateTargetHealth</code> to <code>true</code> when * the alias target is a CloudFront distribution. * </dd> * <dt>Elastic Beanstalk environments that have regionalized subdomains</dt> * <dd> * If you specify an Elastic Beanstalk environment in <code>DNSName</code> * 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 * <code>EvaluateTargetHealth</code> to <code>true</code> 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. * </dd> * <dt>ELB load balancers</dt> * <dd> * Health checking behavior depends on the type of load balancer: * <ul> * <li> * * Classic Load Balancers: If you * specify an ELB Classic Load Balancer in <code>DNSName</code>, * Elastic Load Balancing routes queries only to the healthy Amazon EC2 * instances that are registered with the load balancer. If you set * <code>EvaluateTargetHealth</code> to <code>true</code> and * either no EC2 instances are healthy or the load balancer itself is * unhealthy, Route 53 routes queries to other resources. * </li> * <li> * * Application and Network Load * Balancers: If you specify an ELB Application or * Network Load Balancer and you set <code>EvaluateTargetHealth</code> * to <code>true</code>, Route 53 routes queries to the load balancer * based on the health of the target groups that are associated with * the load balancer: * <ul> * <li> * 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. * </li> * <li> * A target group that has no registered targets is * considered unhealthy. * </li> * </ul> * </li> * </ul> * <note> * 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. * * </note> * </dd> * <dt>S3 buckets</dt> * <dd> * There are no special requirements for setting * <code>EvaluateTargetHealth</code> to <code>true</code> when the alias * target is an S3 bucket. * </dd> * <dt>Other records in the same hosted zone</dt> * <dd> * If the Amazon Web Services resource that you specify in * <code>DNSName</code> 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 <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting">What Happens When You Omit Health Checks?</a> in the * Amazon Route 53 Developer Guide. * </dd> * </dl> * For more information and examples, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html">Amazon Route 53 Health Checks * and DNS Failover</a> 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 * <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html">CreateHostedZone</a> * 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 * <code>AssociateVPCWithHostedZone</code> request. * @public */ export interface AssociateVPCWithHostedZoneResponse { /** * 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: * <ul> * <li> * * 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 <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html">CreateReusableDelegationSet</a>. * </li> * <li> * * 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. * </li> * <li> * * Associate VPCs with a private hosted zone: * The VPC that you specified is already associated with another hosted zone that * has the same name. * </li> * </ul> * @public */ export declare class ConflictingDomainExists extends __BaseException { readonly name: "ConflictingDomainExists"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ConflictingDomainExists, __BaseException>); } /** * 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: __ExceptionOptionType<InvalidVPCId, __BaseException>); } /** * This 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, <a href="http://aws.amazon.com/route53-request">create a case</a> with the Amazon Web Services Support * Center. * @public */ export declare class LimitsExceeded extends __BaseException { readonly name: "LimitsExceeded"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<LimitsExceeded, __BaseException>); } /** * No 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: __ExceptionOptionType<NoSuchHostedZone, __BaseException>); } /** * Associating 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: __ExceptionOptionType<NotAuthorizedException, __BaseException>); } /** * If 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 <code>HTTP 400 * error</code> (<code>Bad request</code>). 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. * @public */ export declare class PriorRequestNotComplete extends __BaseException { readonly name: "PriorRequestNotComplete"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<PriorRequestNotComplete, __BaseException>); } /** * 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: __ExceptionOptionType<PublicZoneVPCAssociation, __BaseException>); } /** * @public * @enum */ export declare const CidrCollectionChangeAction: { readonly DELETE_IF_EXISTS: "DELETE_IF_EXISTS"; readonly PUT: "PUT"; }; /** * @public */ export type CidrCollectionChangeAction = (typeof CidrCollectionChangeAction)[keyof typeof CidrCollectionChangeAction]; /** * A complex type that contains information about the CIDR collection change. * @public */ export interface CidrCollectionChange { /** * Name of the location that is associated with the CIDR collection. * @public */ LocationName: string | undefined; /** * CIDR collection change action. * @public */ Action: CidrCollectionChangeAction | undefined; /** * List of CIDR blocks. * @public */ CidrList: string[] | undefined; } /** * @public */ export interface ChangeCidrCollectionRequest { /** * The UUID of the CIDR collection to update. * @public */ Id: string | undefined; /** * A sequential counter that Amazon Route 53 sets to 1 when you create a * collection and increments it by 1 each time you update the collection. * We recommend that you use <code>ListCidrCollection</code> to get the current value of * <code>CollectionVersion</code> 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: * <ul> * <li> * If the value in the request matches the value of * <code>CollectionVersion</code> in the collection, Route 53 updates * the collection. * </li> * <li> * If the value of <code>CollectionVersion</code> 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 <code>CidrCollectionVersionMismatch</code> error. * </li> * </ul> * @public */ CollectionVersion?: number | undefined; /** * Information about changes to a CIDR collection. * @public */ Changes: CidrCollectionChange[] | undefined; } /** * @public */ export interface ChangeCidrCollectionResponse { /** * The ID that is returned by <code>ChangeCidrCollection</code>. You can use it as input to * <code>GetChange</code> to see if a CIDR collection change has propagated or * not. * @public */ Id: string | undefined; } /** * 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: __ExceptionOptionType<CidrBlockInUseException, __BaseException>); } /** * The CIDR collection version you provided, doesn't match the one in the * <code>ListCidrCollections</code> operation. * @public */ export declare class CidrCollectionVersionMismatchException extends __BaseException { readonly name: "CidrCollectionVersionMismatchException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<CidrCollectionVersionMismatchException, __BaseException>); } /** * 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: __ExceptionOptionType<NoSuchCidrCollectionException, __BaseException>); } /** * @public * @enum */ export declare const ChangeAction: { readonly CREATE: "CREATE"; readonly DELETE: "DELETE"; readonly UPSERT: "UPSERT"; }; /** * @public */ export type ChangeAction = (typeof ChangeAction)[keyof typeof ChangeAction]; /** * The object that is specified in resource record set object when you are linking a * resource record set to a CIDR location. * A <code>LocationName</code> with an asterisk “*” can be used to create a default CIDR * record. <code>CollectionId</code> is still required for default record. * @public */ export interface CidrRoutingConfig { /** * The CIDR collection ID. * @public */ CollectionId: string | undefined; /** * The CIDR collection location name. * @public */ LocationName: string | undefined; } /** * @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.