UNPKG

203 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnCidrCollection`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html
10 */
11export interface CfnCidrCollectionProps {
12 /**
13 * The name of a CIDR collection.
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-name
16 */
17 readonly name: string;
18 /**
19 * A complex type that contains information about the list of CIDR locations.
20 *
21 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-locations
22 */
23 readonly locations?: Array<CfnCidrCollection.LocationProperty | cdk.IResolvable> | cdk.IResolvable;
24}
25/**
26 * A CloudFormation `AWS::Route53::CidrCollection`
27 *
28 * Creates a CIDR collection in the current AWS account.
29 *
30 * @cloudformationResource AWS::Route53::CidrCollection
31 * @stability external
32 *
33 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html
34 */
35export declare class CfnCidrCollection extends cdk.CfnResource implements cdk.IInspectable {
36 /**
37 * The CloudFormation resource type name for this resource class.
38 */
39 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::CidrCollection";
40 /**
41 * A factory method that creates a new instance of this class from an object
42 * containing the CloudFormation properties of this resource.
43 * Used in the @aws-cdk/cloudformation-include module.
44 *
45 * @internal
46 */
47 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCidrCollection;
48 /**
49 * "The Amazon resource name (ARN) to uniquely identify the AWS resource.
50 * @cloudformationAttribute Arn
51 */
52 readonly attrArn: string;
53 /**
54 * The UUID of the CIDR collection.
55 * @cloudformationAttribute Id
56 */
57 readonly attrId: string;
58 /**
59 * The name of a CIDR collection.
60 *
61 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-name
62 */
63 name: string;
64 /**
65 * A complex type that contains information about the list of CIDR locations.
66 *
67 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-locations
68 */
69 locations: Array<CfnCidrCollection.LocationProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
70 /**
71 * Create a new `AWS::Route53::CidrCollection`.
72 *
73 * @param scope - scope in which this resource is defined
74 * @param id - scoped id of the resource
75 * @param props - resource properties
76 */
77 constructor(scope: cdk.Construct, id: string, props: CfnCidrCollectionProps);
78 /**
79 * Examines the CloudFormation resource and discloses attributes.
80 *
81 * @param inspector - tree inspector to collect and process attributes
82 *
83 */
84 inspect(inspector: cdk.TreeInspector): void;
85 protected get cfnProperties(): {
86 [key: string]: any;
87 };
88 protected renderProperties(props: {
89 [key: string]: any;
90 }): {
91 [key: string]: any;
92 };
93}
94export declare namespace CfnCidrCollection {
95 /**
96 * Specifies the list of CIDR blocks for a CIDR location.
97 *
98 * @struct
99 * @stability external
100 *
101 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html
102 */
103 interface LocationProperty {
104 /**
105 * List of CIDR blocks.
106 *
107 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html#cfn-route53-cidrcollection-location-cidrlist
108 */
109 readonly cidrList: string[];
110 /**
111 * The CIDR collection location name.
112 *
113 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html#cfn-route53-cidrcollection-location-locationname
114 */
115 readonly locationName: string;
116 }
117}
118/**
119 * Properties for defining a `CfnDNSSEC`
120 *
121 * @struct
122 * @stability external
123 *
124 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html
125 */
126export interface CfnDNSSECProps {
127 /**
128 * A unique string (ID) that is used to identify a hosted zone. For example: `Z00001111A1ABCaaABC11` .
129 *
130 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html#cfn-route53-dnssec-hostedzoneid
131 */
132 readonly hostedZoneId: string;
133}
134/**
135 * A CloudFormation `AWS::Route53::DNSSEC`
136 *
137 * The `AWS::Route53::DNSSEC` resource is used to enable DNSSEC signing in a hosted zone.
138 *
139 * @cloudformationResource AWS::Route53::DNSSEC
140 * @stability external
141 *
142 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html
143 */
144export declare class CfnDNSSEC extends cdk.CfnResource implements cdk.IInspectable {
145 /**
146 * The CloudFormation resource type name for this resource class.
147 */
148 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::DNSSEC";
149 /**
150 * A factory method that creates a new instance of this class from an object
151 * containing the CloudFormation properties of this resource.
152 * Used in the @aws-cdk/cloudformation-include module.
153 *
154 * @internal
155 */
156 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDNSSEC;
157 /**
158 * A unique string (ID) that is used to identify a hosted zone. For example: `Z00001111A1ABCaaABC11` .
159 *
160 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html#cfn-route53-dnssec-hostedzoneid
161 */
162 hostedZoneId: string;
163 /**
164 * Create a new `AWS::Route53::DNSSEC`.
165 *
166 * @param scope - scope in which this resource is defined
167 * @param id - scoped id of the resource
168 * @param props - resource properties
169 */
170 constructor(scope: cdk.Construct, id: string, props: CfnDNSSECProps);
171 /**
172 * Examines the CloudFormation resource and discloses attributes.
173 *
174 * @param inspector - tree inspector to collect and process attributes
175 *
176 */
177 inspect(inspector: cdk.TreeInspector): void;
178 protected get cfnProperties(): {
179 [key: string]: any;
180 };
181 protected renderProperties(props: {
182 [key: string]: any;
183 }): {
184 [key: string]: any;
185 };
186}
187/**
188 * Properties for defining a `CfnHealthCheck`
189 *
190 * @struct
191 * @stability external
192 *
193 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html
194 */
195export interface CfnHealthCheckProps {
196 /**
197 * A complex type that contains detailed information about one health check.
198 *
199 * For the values to enter for `HealthCheckConfig` , see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
200 *
201 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig
202 */
203 readonly healthCheckConfig: CfnHealthCheck.HealthCheckConfigProperty | cdk.IResolvable;
204 /**
205 * The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.
206 *
207 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags
208 */
209 readonly healthCheckTags?: Array<CfnHealthCheck.HealthCheckTagProperty | cdk.IResolvable> | cdk.IResolvable;
210}
211/**
212 * A CloudFormation `AWS::Route53::HealthCheck`
213 *
214 * The `AWS::Route53::HealthCheck` resource is a Route 53 resource type that contains settings for a Route 53 health check.
215 *
216 * For information about associating health checks with records, see [HealthCheckId](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId) in [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) .
217 *
218 * > You can't create a health check with simple routing.
219 *
220 * *ELB Load Balancers*
221 *
222 * If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
223 *
224 * *Private Hosted Zones*
225 *
226 * You can associate health checks with failover records in a private hosted zone. Note the following:
227 *
228 * - Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
229 * - You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
230 * - You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 `StatusCheckFailed` metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html) .
231 *
232 * @cloudformationResource AWS::Route53::HealthCheck
233 * @stability external
234 *
235 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html
236 */
237export declare class CfnHealthCheck extends cdk.CfnResource implements cdk.IInspectable {
238 /**
239 * The CloudFormation resource type name for this resource class.
240 */
241 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::HealthCheck";
242 /**
243 * A factory method that creates a new instance of this class from an object
244 * containing the CloudFormation properties of this resource.
245 * Used in the @aws-cdk/cloudformation-include module.
246 *
247 * @internal
248 */
249 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnHealthCheck;
250 /**
251 * 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.
252 * @cloudformationAttribute HealthCheckId
253 */
254 readonly attrHealthCheckId: string;
255 /**
256 * A complex type that contains detailed information about one health check.
257 *
258 * For the values to enter for `HealthCheckConfig` , see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)
259 *
260 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig
261 */
262 healthCheckConfig: CfnHealthCheck.HealthCheckConfigProperty | cdk.IResolvable;
263 /**
264 * The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.
265 *
266 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags
267 */
268 healthCheckTags: Array<CfnHealthCheck.HealthCheckTagProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
269 /**
270 * Create a new `AWS::Route53::HealthCheck`.
271 *
272 * @param scope - scope in which this resource is defined
273 * @param id - scoped id of the resource
274 * @param props - resource properties
275 */
276 constructor(scope: cdk.Construct, id: string, props: CfnHealthCheckProps);
277 /**
278 * Examines the CloudFormation resource and discloses attributes.
279 *
280 * @param inspector - tree inspector to collect and process attributes
281 *
282 */
283 inspect(inspector: cdk.TreeInspector): void;
284 protected get cfnProperties(): {
285 [key: string]: any;
286 };
287 protected renderProperties(props: {
288 [key: string]: any;
289 }): {
290 [key: string]: any;
291 };
292}
293export declare namespace CfnHealthCheck {
294 /**
295 * 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.
296 *
297 * @struct
298 * @stability external
299 *
300 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html
301 */
302 interface AlarmIdentifierProperty {
303 /**
304 * The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
305 *
306 * > Route 53 supports CloudWatch alarms with the following features:
307 * >
308 * > - Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User Guide* .
309 * > - Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
310 *
311 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name
312 */
313 readonly name: string;
314 /**
315 * 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.
316 *
317 * For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web Services General Reference* .
318 *
319 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region
320 */
321 readonly region: string;
322 }
323}
324export declare namespace CfnHealthCheck {
325 /**
326 * A complex type that contains information about the health check.
327 *
328 * @struct
329 * @stability external
330 *
331 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html
332 */
333 interface HealthCheckConfigProperty {
334 /**
335 * 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.
336 *
337 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier
338 */
339 readonly alarmIdentifier?: CfnHealthCheck.AlarmIdentifierProperty | cdk.IResolvable;
340 /**
341 * (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.
342 *
343 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks
344 */
345 readonly childHealthChecks?: string[];
346 /**
347 * 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.
348 *
349 * 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.
350 *
351 * 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.
352 *
353 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni
354 */
355 readonly enableSni?: boolean | cdk.IResolvable;
356 /**
357 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide* .
358 *
359 * If you don't specify a value for `FailureThreshold` , the default value is three health checks.
360 *
361 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold
362 */
363 readonly failureThreshold?: number;
364 /**
365 * Amazon Route 53 behavior depends on whether you specify a value for `IPAddress` .
366 *
367 * *If you specify a value for* `IPAddress` :
368 *
369 * 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.
370 *
371 * When Route 53 checks the health of an endpoint, here is how it constructs the `Host` header:
372 *
373 * - 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.
374 * - 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.
375 * - 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.
376 *
377 * 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.
378 *
379 * *If you don't specify a value for `IPAddress`* :
380 *
381 * 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.
382 *
383 * > 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 record with a type of A for the name that you specify for `FullyQualifiedDomainName` , the health check fails with a "DNS resolution failed" error.
384 *
385 * If you want to check the health of multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).
386 *
387 * > In this configuration, if you create a health check for which the value of `FullyQualifiedDomainName` matches the name of the records and you then associate the health check with those records, health check results will be unpredictable.
388 *
389 * 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.
390 *
391 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname
392 */
393 readonly fullyQualifiedDomainName?: string;
394 /**
395 * 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](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) element.
396 *
397 * Note the following:
398 *
399 * - If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
400 * - If you specify `0` , Route 53 always considers this health check to be healthy.
401 *
402 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold
403 */
404 readonly healthThreshold?: number;
405 /**
406 * 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.
407 *
408 * Use one of the following formats for the value of `IPAddress` :
409 *
410 * - *IPv4 address* : four values between 0 and 255, separated by periods (.), for example, `192.0.2.44` .
411 * - *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` .
412 *
413 * 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.
414 *
415 * For more information, see [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName) .
416 *
417 * 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:
418 *
419 * - [RFC 5735, Special Use IPv4 Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5735)
420 * - [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6598)
421 * - [RFC 5156, Special-Use IPv6 Addresses](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5156)
422 *
423 * When the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC` , omit `IPAddress` .
424 *
425 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress
426 */
427 readonly ipAddress?: string;
428 /**
429 * 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:
430 *
431 * - `Healthy` : Route 53 considers the health check to be healthy.
432 * - `Unhealthy` : Route 53 considers the health check to be unhealthy.
433 * - `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.
434 *
435 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus
436 */
437 readonly insufficientDataHealthStatus?: string;
438 /**
439 * 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.
440 *
441 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted
442 */
443 readonly inverted?: boolean | cdk.IResolvable;
444 /**
445 * Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the *Health Checks* page in the Route 53 console.
446 *
447 * > You can't change the value of `MeasureLatency` after you create a health check.
448 *
449 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency
450 */
451 readonly measureLatency?: boolean | cdk.IResolvable;
452 /**
453 * The port on the endpoint that you want Amazon Route 53 to perform health checks on.
454 *
455 * > Don't specify a value for `Port` when you specify a value for [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type) of `CLOUDWATCH_METRIC` or `CALCULATED` .
456 *
457 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port
458 */
459 readonly port?: number;
460 /**
461 * 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.
462 *
463 * 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* .
464 *
465 * 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).
466 *
467 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions
468 */
469 readonly regions?: string[];
470 /**
471 * 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.
472 *
473 * > You can't change the value of `RequestInterval` after you create a health check.
474 *
475 * If you don't specify a value for `RequestInterval` , the default value is `30` seconds.
476 *
477 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval
478 */
479 readonly requestInterval?: number;
480 /**
481 * 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` .
482 *
483 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath
484 */
485 readonly resourcePath?: string;
486 /**
487 * The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.
488 *
489 * For more information about Route 53 Application Recovery Controller, see [Route 53 Application Recovery Controller Developer Guide.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html) .
490 *
491 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-routingcontrolarn
492 */
493 readonly routingControlArn?: string;
494 /**
495 * 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.
496 *
497 * Route 53 considers case when searching for `SearchString` in the response body.
498 *
499 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring
500 */
501 readonly searchString?: string;
502 /**
503 * The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
504 *
505 * > You can't change the value of `Type` after you create a health check.
506 *
507 * You can create the following types of health checks:
508 *
509 * - *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.
510 * - *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.
511 *
512 * > If you specify `HTTPS` for the value of `Type` , the endpoint must support TLS v1.0 or later.
513 * - *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` .
514 * - *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` .
515 * - *TCP* : Route 53 tries to establish a TCP connection.
516 * - *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` .
517 * - *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` .
518 * - *RECOVERY_CONTROL* : The health check is assocated 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.
519 *
520 * For more information, see [How Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide* .
521 *
522 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type
523 */
524 readonly type: string;
525 }
526}
527export declare namespace CfnHealthCheck {
528 /**
529 * The `HealthCheckTag` property describes one key-value pair that is associated with an `AWS::Route53::HealthCheck` resource.
530 *
531 * @struct
532 * @stability external
533 *
534 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html
535 */
536 interface HealthCheckTagProperty {
537 /**
538 * The value of `Key` depends on the operation that you want to perform:
539 *
540 * - *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give the new tag.
541 * - *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.
542 * - *Delete a key* : `Key` is the name of the tag you want to remove.
543 * - *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.
544 *
545 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-key
546 */
547 readonly key: string;
548 /**
549 * The value of `Value` depends on the operation that you want to perform:
550 *
551 * - *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give the new tag.
552 * - *Edit a tag* : `Value` is the new value that you want to assign the tag.
553 *
554 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-value
555 */
556 readonly value: string;
557 }
558}
559/**
560 * Properties for defining a `CfnHostedZone`
561 *
562 * @struct
563 * @stability external
564 *
565 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html
566 */
567export interface CfnHostedZoneProps {
568 /**
569 * A complex type that contains an optional comment.
570 *
571 * If you don't want to specify a comment, omit the `HostedZoneConfig` and `Comment` elements.
572 *
573 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig
574 */
575 readonly hostedZoneConfig?: CfnHostedZone.HostedZoneConfigProperty | cdk.IResolvable;
576 /**
577 * Adds, edits, or deletes tags for a health check or a hosted zone.
578 *
579 * For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing and Cost Management User Guide* .
580 *
581 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags
582 */
583 readonly hostedZoneTags?: CfnHostedZone.HostedZoneTagProperty[];
584 /**
585 * 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.
586 *
587 * 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 are returned by the `Fn::GetAtt` intrinsic function.
588 *
589 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name
590 */
591 readonly name?: string;
592 /**
593 * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
594 *
595 * DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
596 *
597 * - Route 53 edge location that responded to the DNS query
598 * - Domain or subdomain that was requested
599 * - DNS record type, such as A or AAAA
600 * - DNS response code, such as `NoError` or `ServFail`
601 *
602 * - **Log Group and Resource Policy** - Before you create a query logging configuration, perform the following operations.
603 *
604 * > If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
605 *
606 * - Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
607 *
608 * - You must create the log group in the us-east-1 region.
609 * - You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.
610 * - When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
611 *
612 * `/aws/route53/ *hosted zone name*`
613 *
614 * In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
615 * - Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of `Resource` , specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with `*` , for example:
616 *
617 * `arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*`
618 *
619 * To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:
620 *
621 * - For `aws:SourceArn` , supply the hosted zone ARN used in creating the query logging configuration. For example, `aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID` .
622 * - For `aws:SourceAccount` , supply the account ID for the account that creates the query logging configuration. For example, `aws:SourceAccount:111111111111` .
623 *
624 * For more information, see [The confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *AWS IAM User Guide* .
625 *
626 * > You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI .
627 * - **Log Streams and Edge Locations** - When Route 53 finishes creating the configuration for DNS query logging, it does the following:
628 *
629 * - Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
630 * - Begins to send query logs to the applicable log stream.
631 *
632 * The name of each log stream is in the following format:
633 *
634 * `*hosted zone ID* / *edge location code*`
635 *
636 * The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the [Route 53 Product Details](https://docs.aws.amazon.com/route53/details/) page.
637 * - **Queries That Are Logged** - Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see [Routing Internet Traffic to Your Website or Web Application](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) in the *Amazon Route 53 Developer Guide* .
638 * - **Log File Format** - For a list of the values in each query log and the format of each value, see [Logging DNS Queries](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer Guide* .
639 * - **Pricing** - For information about charges for query logs, see [Amazon CloudWatch Pricing](https://docs.aws.amazon.com/cloudwatch/pricing/) .
640 * - **How to Stop Logging** - If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html) .
641 *
642 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig
643 */
644 readonly queryLoggingConfig?: CfnHostedZone.QueryLoggingConfigProperty | cdk.IResolvable;
645 /**
646 * *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.
647 *
648 * > For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .
649 *
650 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs
651 */
652 readonly vpcs?: Array<CfnHostedZone.VPCProperty | cdk.IResolvable> | cdk.IResolvable;
653}
654/**
655 * A CloudFormation `AWS::Route53::HostedZone`
656 *
657 * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
658 *
659 * > You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
660 *
661 * For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/) .
662 *
663 * Note the following:
664 *
665 * - You can't create a hosted zone for a top-level domain (TLD) such as .com.
666 * - If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide* .
667 *
668 * When you submit a `CreateHostedZone` request, the initial status of the hosted zone is `PENDING` . For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to `INSYNC` .
669 *
670 * The `CreateHostedZone` request requires the caller to have an `ec2:DescribeVpcs` permission.
671 *
672 * > When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS Regions . Each AWS account is scoped to one partition.
673 * >
674 * > The following are the supported partitions:
675 * >
676 * > - `aws` - AWS Regions
677 * > - `aws-cn` - China Regions
678 * > - `aws-us-gov` - AWS GovCloud (US) Region
679 * >
680 * > For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference* .
681 *
682 * @cloudformationResource AWS::Route53::HostedZone
683 * @stability external
684 *
685 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html
686 */
687export declare class CfnHostedZone extends cdk.CfnResource implements cdk.IInspectable {
688 /**
689 * The CloudFormation resource type name for this resource class.
690 */
691 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::HostedZone";
692 /**
693 * A factory method that creates a new instance of this class from an object
694 * containing the CloudFormation properties of this resource.
695 * Used in the @aws-cdk/cloudformation-include module.
696 *
697 * @internal
698 */
699 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnHostedZone;
700 /**
701 * The ID that Amazon Route 53 assigned to the hosted zone when you created it.
702 * @cloudformationAttribute Id
703 */
704 readonly attrId: string;
705 /**
706 * Returns the set of name servers for the specific hosted zone. For example: `ns1.example.com` .
707 *
708 * This attribute is not supported for private hosted zones.
709 * @cloudformationAttribute NameServers
710 */
711 readonly attrNameServers: string[];
712 /**
713 * A complex type that contains an optional comment.
714 *
715 * If you don't want to specify a comment, omit the `HostedZoneConfig` and `Comment` elements.
716 *
717 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig
718 */
719 hostedZoneConfig: CfnHostedZone.HostedZoneConfigProperty | cdk.IResolvable | undefined;
720 /**
721 * Adds, edits, or deletes tags for a health check or a hosted zone.
722 *
723 * For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing and Cost Management User Guide* .
724 *
725 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags
726 */
727 readonly tags: cdk.TagManager;
728 /**
729 * 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.
730 *
731 * 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 are returned by the `Fn::GetAtt` intrinsic function.
732 *
733 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name
734 */
735 name: string | undefined;
736 /**
737 * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
738 *
739 * DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
740 *
741 * - Route 53 edge location that responded to the DNS query
742 * - Domain or subdomain that was requested
743 * - DNS record type, such as A or AAAA
744 * - DNS response code, such as `NoError` or `ServFail`
745 *
746 * - **Log Group and Resource Policy** - Before you create a query logging configuration, perform the following operations.
747 *
748 * > If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
749 *
750 * - Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
751 *
752 * - You must create the log group in the us-east-1 region.
753 * - You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.
754 * - When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
755 *
756 * `/aws/route53/ *hosted zone name*`
757 *
758 * In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
759 * - Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of `Resource` , specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with `*` , for example:
760 *
761 * `arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*`
762 *
763 * To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:
764 *
765 * - For `aws:SourceArn` , supply the hosted zone ARN used in creating the query logging configuration. For example, `aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID` .
766 * - For `aws:SourceAccount` , supply the account ID for the account that creates the query logging configuration. For example, `aws:SourceAccount:111111111111` .
767 *
768 * For more information, see [The confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *AWS IAM User Guide* .
769 *
770 * > You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI .
771 * - **Log Streams and Edge Locations** - When Route 53 finishes creating the configuration for DNS query logging, it does the following:
772 *
773 * - Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
774 * - Begins to send query logs to the applicable log stream.
775 *
776 * The name of each log stream is in the following format:
777 *
778 * `*hosted zone ID* / *edge location code*`
779 *
780 * The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the [Route 53 Product Details](https://docs.aws.amazon.com/route53/details/) page.
781 * - **Queries That Are Logged** - Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see [Routing Internet Traffic to Your Website or Web Application](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) in the *Amazon Route 53 Developer Guide* .
782 * - **Log File Format** - For a list of the values in each query log and the format of each value, see [Logging DNS Queries](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer Guide* .
783 * - **Pricing** - For information about charges for query logs, see [Amazon CloudWatch Pricing](https://docs.aws.amazon.com/cloudwatch/pricing/) .
784 * - **How to Stop Logging** - If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html) .
785 *
786 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig
787 */
788 queryLoggingConfig: CfnHostedZone.QueryLoggingConfigProperty | cdk.IResolvable | undefined;
789 /**
790 * *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.
791 *
792 * > For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .
793 *
794 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs
795 */
796 vpcs: Array<CfnHostedZone.VPCProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
797 /**
798 * Create a new `AWS::Route53::HostedZone`.
799 *
800 * @param scope - scope in which this resource is defined
801 * @param id - scoped id of the resource
802 * @param props - resource properties
803 */
804 constructor(scope: cdk.Construct, id: string, props?: CfnHostedZoneProps);
805 /**
806 * Examines the CloudFormation resource and discloses attributes.
807 *
808 * @param inspector - tree inspector to collect and process attributes
809 *
810 */
811 inspect(inspector: cdk.TreeInspector): void;
812 protected get cfnProperties(): {
813 [key: string]: any;
814 };
815 protected renderProperties(props: {
816 [key: string]: any;
817 }): {
818 [key: string]: any;
819 };
820}
821export declare namespace CfnHostedZone {
822 /**
823 * A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the `HostedZoneConfig` and `Comment` elements.
824 *
825 * @struct
826 * @stability external
827 *
828 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html
829 */
830 interface HostedZoneConfigProperty {
831 /**
832 * Any comments that you want to include about the hosted zone.
833 *
834 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment
835 */
836 readonly comment?: string;
837 }
838}
839export declare namespace CfnHostedZone {
840 /**
841 * A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.
842 *
843 * @struct
844 * @stability external
845 *
846 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html
847 */
848 interface HostedZoneTagProperty {
849 /**
850 * The value of `Key` depends on the operation that you want to perform:
851 *
852 * - *Add a tag to a health check or hosted zone* : `Key` is the name that you want to give the new tag.
853 * - *Edit a tag* : `Key` is the name of the tag that you want to change the `Value` for.
854 * - *Delete a key* : `Key` is the name of the tag you want to remove.
855 * - *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.
856 *
857 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html#cfn-route53-hostedzone-hostedzonetag-key
858 */
859 readonly key: string;
860 /**
861 * The value of `Value` depends on the operation that you want to perform:
862 *
863 * - *Add a tag to a health check or hosted zone* : `Value` is the value that you want to give the new tag.
864 * - *Edit a tag* : `Value` is the new value that you want to assign the tag.
865 *
866 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html#cfn-route53-hostedzone-hostedzonetag-value
867 */
868 readonly value: string;
869 }
870}
871export declare namespace CfnHostedZone {
872 /**
873 * A complex type that contains information about a configuration for DNS query logging.
874 *
875 * @struct
876 * @stability external
877 *
878 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html
879 */
880 interface QueryLoggingConfigProperty {
881 /**
882 * The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
883 *
884 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn
885 */
886 readonly cloudWatchLogsLogGroupArn: string;
887 }
888}
889export declare namespace CfnHostedZone {
890 /**
891 * *Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC.
892 *
893 * > For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .
894 *
895 * @struct
896 * @stability external
897 *
898 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html
899 */
900 interface VPCProperty {
901 /**
902 * *Private hosted zones only:* The ID of an Amazon VPC.
903 *
904 * > For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .
905 *
906 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html#cfn-route53-hostedzone-vpc-vpcid
907 */
908 readonly vpcId: string;
909 /**
910 * *Private hosted zones only:* The region that an Amazon VPC was created in.
911 *
912 * > For public hosted zones, omit `VPCs` , `VPCId` , and `VPCRegion` .
913 *
914 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html#cfn-route53-hostedzone-vpc-vpcregion
915 */
916 readonly vpcRegion: string;
917 }
918}
919/**
920 * Properties for defining a `CfnKeySigningKey`
921 *
922 * @struct
923 * @stability external
924 *
925 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html
926 */
927export interface CfnKeySigningKeyProps {
928 /**
929 * The unique string (ID) that is used to identify a hosted zone. For example: `Z00001111A1ABCaaABC11` .
930 *
931 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-hostedzoneid
932 */
933 readonly hostedZoneId: string;
934 /**
935 * The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS ). The `KeyManagementServiceArn` must be unique for each key-signing key (KSK) in a single hosted zone. For example: `arn:aws:kms:us-east-1:111122223333:key/111a2222-a11b-1ab1-2ab2-1ab21a2b3a111` .
936 *
937 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-keymanagementservicearn
938 */
939 readonly keyManagementServiceArn: string;
940 /**
941 * 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.
942 *
943 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-name
944 */
945 readonly name: string;
946 /**
947 * A string that represents the current key-signing key (KSK) status.
948 *
949 * Status can have one of the following values:
950 *
951 * - **ACTIVE** - The KSK is being used for signing.
952 * - **INACTIVE** - The KSK is not being used for signing.
953 * - **DELETING** - The KSK is in the process of being deleted.
954 * - **ACTION_NEEDED** - There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.
955 * - **INTERNAL_FAILURE** - There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
956 *
957 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-status
958 */
959 readonly status: string;
960}
961/**
962 * A CloudFormation `AWS::Route53::KeySigningKey`
963 *
964 * The `AWS::Route53::KeySigningKey` resource creates a new key-signing key (KSK) in a hosted zone. The hosted zone ID is passed as a parameter in the KSK properties. You can specify the properties of this KSK using the `Name` , `Status` , and `KeyManagementServiceArn` properties of the resource.
965 *
966 * @cloudformationResource AWS::Route53::KeySigningKey
967 * @stability external
968 *
969 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html
970 */
971export declare class CfnKeySigningKey extends cdk.CfnResource implements cdk.IInspectable {
972 /**
973 * The CloudFormation resource type name for this resource class.
974 */
975 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::KeySigningKey";
976 /**
977 * A factory method that creates a new instance of this class from an object
978 * containing the CloudFormation properties of this resource.
979 * Used in the @aws-cdk/cloudformation-include module.
980 *
981 * @internal
982 */
983 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnKeySigningKey;
984 /**
985 * The unique string (ID) that is used to identify a hosted zone. For example: `Z00001111A1ABCaaABC11` .
986 *
987 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-hostedzoneid
988 */
989 hostedZoneId: string;
990 /**
991 * The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS ). The `KeyManagementServiceArn` must be unique for each key-signing key (KSK) in a single hosted zone. For example: `arn:aws:kms:us-east-1:111122223333:key/111a2222-a11b-1ab1-2ab2-1ab21a2b3a111` .
992 *
993 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-keymanagementservicearn
994 */
995 keyManagementServiceArn: string;
996 /**
997 * 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.
998 *
999 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-name
1000 */
1001 name: string;
1002 /**
1003 * A string that represents the current key-signing key (KSK) status.
1004 *
1005 * Status can have one of the following values:
1006 *
1007 * - **ACTIVE** - The KSK is being used for signing.
1008 * - **INACTIVE** - The KSK is not being used for signing.
1009 * - **DELETING** - The KSK is in the process of being deleted.
1010 * - **ACTION_NEEDED** - There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.
1011 * - **INTERNAL_FAILURE** - There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
1012 *
1013 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-status
1014 */
1015 status: string;
1016 /**
1017 * Create a new `AWS::Route53::KeySigningKey`.
1018 *
1019 * @param scope - scope in which this resource is defined
1020 * @param id - scoped id of the resource
1021 * @param props - resource properties
1022 */
1023 constructor(scope: cdk.Construct, id: string, props: CfnKeySigningKeyProps);
1024 /**
1025 * Examines the CloudFormation resource and discloses attributes.
1026 *
1027 * @param inspector - tree inspector to collect and process attributes
1028 *
1029 */
1030 inspect(inspector: cdk.TreeInspector): void;
1031 protected get cfnProperties(): {
1032 [key: string]: any;
1033 };
1034 protected renderProperties(props: {
1035 [key: string]: any;
1036 }): {
1037 [key: string]: any;
1038 };
1039}
1040/**
1041 * Properties for defining a `CfnRecordSet`
1042 *
1043 * @struct
1044 * @stability external
1045 *
1046 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html
1047 */
1048export interface CfnRecordSetProps {
1049 /**
1050 * 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.
1051 *
1052 * *ChangeResourceRecordSets Only*
1053 *
1054 * 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.
1055 *
1056 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide* .
1057 *
1058 * You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, `*.example.com` . Note the following:
1059 *
1060 * - The * must replace the entire label. For example, you can't specify `*prod.example.com` or `prod*.example.com` .
1061 * - The * can't replace any of the middle labels, for example, marketing.*.example.com.
1062 * - 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.
1063 *
1064 * > You can't use the * wildcard for resource records sets that have a type of NS.
1065 *
1066 * You can use the * wildcard as the leftmost label in a domain name, for example, `*.example.com` . You can't use an * for one of the middle labels, for example, `marketing.*.example.com` . In addition, the * must replace the entire label; for example, you can't specify `prod*.example.com` .
1067 *
1068 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name
1069 */
1070 readonly name: string;
1071 /**
1072 * The DNS record type. For information about different record types and how data is encoded for them, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .
1073 *
1074 * Valid values for basic resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `DS` | `MX` | `NAPTR` | `NS` | `PTR` | `SOA` | `SPF` | `SRV` | `TXT`
1075 *
1076 * Values for weighted, latency, geolocation, and failover resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT` . 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.
1077 *
1078 * Valid values for multivalue answer resource record sets: `A` | `AAAA` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT`
1079 *
1080 * > 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](https://docs.aws.amazon.com/http://tools.ietf.org/html/rfc7208#section-14.1) .
1081 *
1082 * Values for alias resource record sets:
1083 *
1084 * - *Amazon API Gateway custom regional APIs and edge-optimized APIs:* `A`
1085 * - *CloudFront distributions:* `A`
1086 *
1087 * 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` .
1088 * - *Amazon API Gateway environment that has a regionalized subdomain* : `A`
1089 * - *ELB load balancers:* `A` | `AAAA`
1090 * - *Amazon S3 buckets:* `A`
1091 * - *Amazon Virtual Private Cloud interface VPC endpoints* `A`
1092 * - *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` .
1093 *
1094 * > 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.
1095 *
1096 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type
1097 */
1098 readonly type: string;
1099 /**
1100 * *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
1101 *
1102 * If you're creating resource records sets for a private hosted zone, note the following:
1103 *
1104 * - You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
1105 * - For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide* .
1106 *
1107 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget
1108 */
1109 readonly aliasTarget?: CfnRecordSet.AliasTargetProperty | cdk.IResolvable;
1110 /**
1111 * The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
1112 *
1113 * A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.
1114 *
1115 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig
1116 */
1117 readonly cidrRoutingConfig?: CfnRecordSet.CidrRoutingConfigProperty | cdk.IResolvable;
1118 /**
1119 * *Optional:* Any comments you want to include about a change batch request.
1120 *
1121 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment
1122 */
1123 readonly comment?: string;
1124 /**
1125 * *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.
1126 *
1127 * Except where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets:
1128 *
1129 * - 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.
1130 * - 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.
1131 * - 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.
1132 * - 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.
1133 *
1134 * 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.
1135 *
1136 * For failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true.
1137 *
1138 * For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide* :
1139 *
1140 * - [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)
1141 * - [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)
1142 *
1143 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover
1144 */
1145 readonly failover?: string;
1146 /**
1147 * *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` .
1148 *
1149 * > Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
1150 *
1151 * 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.
1152 *
1153 * You can't create two geolocation resource record sets that specify the same geographic location.
1154 *
1155 * 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.
1156 *
1157 * > 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.
1158 *
1159 * 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.
1160 *
1161 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation
1162 */
1163 readonly geoLocation?: CfnRecordSet.GeoLocationProperty | cdk.IResolvable;
1164 /**
1165 * 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.
1166 *
1167 * Route 53 determines whether a resource record set is healthy based on one of the following:
1168 *
1169 * - By periodically sending a request to the endpoint that is specified in the health check
1170 * - By aggregating the status of a specified group of health checks (calculated health checks)
1171 * - By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
1172 *
1173 * > 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.
1174 *
1175 * For more information, see the following topics in the *Amazon Route 53 Developer Guide* :
1176 *
1177 * - [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
1178 * - [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)
1179 * - [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)
1180 *
1181 * *When to Specify HealthCheckId*
1182 *
1183 * 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:
1184 *
1185 * - *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.
1186 *
1187 * 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.
1188 *
1189 * 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.
1190 *
1191 * 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.
1192 * - *Alias resource record sets* : You specify the following settings:
1193 *
1194 * - 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).
1195 * - You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
1196 * - You specify a health check ID for the non-alias resource record set.
1197 *
1198 * 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.
1199 *
1200 * If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
1201 *
1202 * > 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.
1203 *
1204 * *Geolocation Routing*
1205 *
1206 * 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:
1207 *
1208 * - The United States
1209 * - North America
1210 * - The default resource record set
1211 *
1212 * *Specifying the Health Check Endpoint by Domain Name*
1213 *
1214 * 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` ).
1215 *
1216 * > Health check results will be unpredictable if you do the following:
1217 * >
1218 * > - Create a health check that has the same value for `FullyQualifiedDomainName` as the name of a resource record set.
1219 * > - Associate that health check with the resource record set.
1220 *
1221 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid
1222 */
1223 readonly healthCheckId?: string;
1224 /**
1225 * The ID of the hosted zone that you want to create records in.
1226 *
1227 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1228 *
1229 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid
1230 */
1231 readonly hostedZoneId?: string;
1232 /**
1233 * The name of the hosted zone that you want to create records in. You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .
1234 *
1235 * When you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.
1236 *
1237 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1238 *
1239 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename
1240 */
1241 readonly hostedZoneName?: string;
1242 /**
1243 * *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:
1244 *
1245 * - 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.
1246 * - If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
1247 * - 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.
1248 * - If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
1249 * - When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
1250 * - If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.
1251 *
1252 * You can't create multivalue answer alias records.
1253 *
1254 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer
1255 */
1256 readonly multiValueAnswer?: boolean | cdk.IResolvable;
1257 /**
1258 * *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 AWS 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.
1259 *
1260 * 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.
1261 *
1262 * Note the following:
1263 *
1264 * - You can only specify one `ResourceRecord` per latency resource record set.
1265 * - You can only create one latency resource record set for each Amazon EC2 Region.
1266 * - 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.
1267 * - 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.
1268 *
1269 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region
1270 */
1271 readonly region?: string;
1272 /**
1273 * One or more values that correspond with the value that you specified for the `Type` property. For example, if you specified `A` for `Type` , you specify one or more IP addresses in IPv4 format for `ResourceRecords` . For information about the format of values for each record type, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .
1274 *
1275 * Note the following:
1276 *
1277 * - You can specify more than one value for all record types except CNAME and SOA.
1278 * - The maximum length of a value is 4000 characters.
1279 * - If you're creating an alias record, omit `ResourceRecords` .
1280 *
1281 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords
1282 */
1283 readonly resourceRecords?: string[];
1284 /**
1285 * *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.
1286 *
1287 * For information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide* .
1288 *
1289 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier
1290 */
1291 readonly setIdentifier?: string;
1292 /**
1293 * The resource record cache time to live (TTL), in seconds. Note the following:
1294 *
1295 * - 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.
1296 * - 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.
1297 * - All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL` .
1298 * - 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` .
1299 *
1300 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl
1301 */
1302 readonly ttl?: string;
1303 /**
1304 * *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:
1305 *
1306 * - You must specify a value for the `Weight` element for every weighted resource record set.
1307 * - You can only specify one `ResourceRecord` per weighted resource record set.
1308 * - 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.
1309 * - You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements.
1310 * - 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.
1311 *
1312 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer Guide* .
1313 *
1314 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight
1315 */
1316 readonly weight?: number;
1317}
1318/**
1319 * A CloudFormation `AWS::Route53::RecordSet`
1320 *
1321 * Information about the record that you want to create.
1322 *
1323 * The `AWS::Route53::RecordSet` type can be used as a standalone resource or as an embedded property in the `AWS::Route53::RecordSetGroup` type. Note that some `AWS::Route53::RecordSet` properties are valid only when used within `AWS::Route53::RecordSetGroup` .
1324 *
1325 * For more information, see [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) in the *Amazon Route 53 API Reference* .
1326 *
1327 * @cloudformationResource AWS::Route53::RecordSet
1328 * @stability external
1329 *
1330 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html
1331 */
1332export declare class CfnRecordSet extends cdk.CfnResource implements cdk.IInspectable {
1333 /**
1334 * The CloudFormation resource type name for this resource class.
1335 */
1336 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::RecordSet";
1337 /**
1338 * A factory method that creates a new instance of this class from an object
1339 * containing the CloudFormation properties of this resource.
1340 * Used in the @aws-cdk/cloudformation-include module.
1341 *
1342 * @internal
1343 */
1344 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRecordSet;
1345 /**
1346 * 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.
1347 *
1348 * *ChangeResourceRecordSets Only*
1349 *
1350 * 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.
1351 *
1352 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide* .
1353 *
1354 * You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, `*.example.com` . Note the following:
1355 *
1356 * - The * must replace the entire label. For example, you can't specify `*prod.example.com` or `prod*.example.com` .
1357 * - The * can't replace any of the middle labels, for example, marketing.*.example.com.
1358 * - 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.
1359 *
1360 * > You can't use the * wildcard for resource records sets that have a type of NS.
1361 *
1362 * You can use the * wildcard as the leftmost label in a domain name, for example, `*.example.com` . You can't use an * for one of the middle labels, for example, `marketing.*.example.com` . In addition, the * must replace the entire label; for example, you can't specify `prod*.example.com` .
1363 *
1364 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name
1365 */
1366 name: string;
1367 /**
1368 * The DNS record type. For information about different record types and how data is encoded for them, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .
1369 *
1370 * Valid values for basic resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `DS` | `MX` | `NAPTR` | `NS` | `PTR` | `SOA` | `SPF` | `SRV` | `TXT`
1371 *
1372 * Values for weighted, latency, geolocation, and failover resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT` . 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.
1373 *
1374 * Valid values for multivalue answer resource record sets: `A` | `AAAA` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT`
1375 *
1376 * > 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](https://docs.aws.amazon.com/http://tools.ietf.org/html/rfc7208#section-14.1) .
1377 *
1378 * Values for alias resource record sets:
1379 *
1380 * - *Amazon API Gateway custom regional APIs and edge-optimized APIs:* `A`
1381 * - *CloudFront distributions:* `A`
1382 *
1383 * 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` .
1384 * - *Amazon API Gateway environment that has a regionalized subdomain* : `A`
1385 * - *ELB load balancers:* `A` | `AAAA`
1386 * - *Amazon S3 buckets:* `A`
1387 * - *Amazon Virtual Private Cloud interface VPC endpoints* `A`
1388 * - *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` .
1389 *
1390 * > 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.
1391 *
1392 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type
1393 */
1394 type: string;
1395 /**
1396 * *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
1397 *
1398 * If you're creating resource records sets for a private hosted zone, note the following:
1399 *
1400 * - You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
1401 * - For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide* .
1402 *
1403 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget
1404 */
1405 aliasTarget: CfnRecordSet.AliasTargetProperty | cdk.IResolvable | undefined;
1406 /**
1407 * The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
1408 *
1409 * A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.
1410 *
1411 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig
1412 */
1413 cidrRoutingConfig: CfnRecordSet.CidrRoutingConfigProperty | cdk.IResolvable | undefined;
1414 /**
1415 * *Optional:* Any comments you want to include about a change batch request.
1416 *
1417 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment
1418 */
1419 comment: string | undefined;
1420 /**
1421 * *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.
1422 *
1423 * Except where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets:
1424 *
1425 * - 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.
1426 * - 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.
1427 * - 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.
1428 * - 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.
1429 *
1430 * 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.
1431 *
1432 * For failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true.
1433 *
1434 * For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide* :
1435 *
1436 * - [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)
1437 * - [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)
1438 *
1439 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover
1440 */
1441 failover: string | undefined;
1442 /**
1443 * *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` .
1444 *
1445 * > Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
1446 *
1447 * 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.
1448 *
1449 * You can't create two geolocation resource record sets that specify the same geographic location.
1450 *
1451 * 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.
1452 *
1453 * > 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.
1454 *
1455 * 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.
1456 *
1457 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation
1458 */
1459 geoLocation: CfnRecordSet.GeoLocationProperty | cdk.IResolvable | undefined;
1460 /**
1461 * 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.
1462 *
1463 * Route 53 determines whether a resource record set is healthy based on one of the following:
1464 *
1465 * - By periodically sending a request to the endpoint that is specified in the health check
1466 * - By aggregating the status of a specified group of health checks (calculated health checks)
1467 * - By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
1468 *
1469 * > 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.
1470 *
1471 * For more information, see the following topics in the *Amazon Route 53 Developer Guide* :
1472 *
1473 * - [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
1474 * - [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)
1475 * - [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)
1476 *
1477 * *When to Specify HealthCheckId*
1478 *
1479 * 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:
1480 *
1481 * - *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.
1482 *
1483 * 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.
1484 *
1485 * 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.
1486 *
1487 * 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.
1488 * - *Alias resource record sets* : You specify the following settings:
1489 *
1490 * - 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).
1491 * - You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
1492 * - You specify a health check ID for the non-alias resource record set.
1493 *
1494 * 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.
1495 *
1496 * If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
1497 *
1498 * > 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.
1499 *
1500 * *Geolocation Routing*
1501 *
1502 * 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:
1503 *
1504 * - The United States
1505 * - North America
1506 * - The default resource record set
1507 *
1508 * *Specifying the Health Check Endpoint by Domain Name*
1509 *
1510 * 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` ).
1511 *
1512 * > Health check results will be unpredictable if you do the following:
1513 * >
1514 * > - Create a health check that has the same value for `FullyQualifiedDomainName` as the name of a resource record set.
1515 * > - Associate that health check with the resource record set.
1516 *
1517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid
1518 */
1519 healthCheckId: string | undefined;
1520 /**
1521 * The ID of the hosted zone that you want to create records in.
1522 *
1523 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1524 *
1525 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid
1526 */
1527 hostedZoneId: string | undefined;
1528 /**
1529 * The name of the hosted zone that you want to create records in. You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .
1530 *
1531 * When you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.
1532 *
1533 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1534 *
1535 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename
1536 */
1537 hostedZoneName: string | undefined;
1538 /**
1539 * *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:
1540 *
1541 * - 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.
1542 * - If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
1543 * - 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.
1544 * - If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
1545 * - When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
1546 * - If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.
1547 *
1548 * You can't create multivalue answer alias records.
1549 *
1550 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer
1551 */
1552 multiValueAnswer: boolean | cdk.IResolvable | undefined;
1553 /**
1554 * *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 AWS 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.
1555 *
1556 * 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.
1557 *
1558 * Note the following:
1559 *
1560 * - You can only specify one `ResourceRecord` per latency resource record set.
1561 * - You can only create one latency resource record set for each Amazon EC2 Region.
1562 * - 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.
1563 * - 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.
1564 *
1565 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region
1566 */
1567 region: string | undefined;
1568 /**
1569 * One or more values that correspond with the value that you specified for the `Type` property. For example, if you specified `A` for `Type` , you specify one or more IP addresses in IPv4 format for `ResourceRecords` . For information about the format of values for each record type, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .
1570 *
1571 * Note the following:
1572 *
1573 * - You can specify more than one value for all record types except CNAME and SOA.
1574 * - The maximum length of a value is 4000 characters.
1575 * - If you're creating an alias record, omit `ResourceRecords` .
1576 *
1577 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords
1578 */
1579 resourceRecords: string[] | undefined;
1580 /**
1581 * *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.
1582 *
1583 * For information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide* .
1584 *
1585 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier
1586 */
1587 setIdentifier: string | undefined;
1588 /**
1589 * The resource record cache time to live (TTL), in seconds. Note the following:
1590 *
1591 * - 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.
1592 * - 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.
1593 * - All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL` .
1594 * - 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` .
1595 *
1596 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl
1597 */
1598 ttl: string | undefined;
1599 /**
1600 * *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:
1601 *
1602 * - You must specify a value for the `Weight` element for every weighted resource record set.
1603 * - You can only specify one `ResourceRecord` per weighted resource record set.
1604 * - 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.
1605 * - You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements.
1606 * - 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.
1607 *
1608 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer Guide* .
1609 *
1610 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight
1611 */
1612 weight: number | undefined;
1613 /**
1614 * Create a new `AWS::Route53::RecordSet`.
1615 *
1616 * @param scope - scope in which this resource is defined
1617 * @param id - scoped id of the resource
1618 * @param props - resource properties
1619 */
1620 constructor(scope: cdk.Construct, id: string, props: CfnRecordSetProps);
1621 /**
1622 * Examines the CloudFormation resource and discloses attributes.
1623 *
1624 * @param inspector - tree inspector to collect and process attributes
1625 *
1626 */
1627 inspect(inspector: cdk.TreeInspector): void;
1628 protected get cfnProperties(): {
1629 [key: string]: any;
1630 };
1631 protected renderProperties(props: {
1632 [key: string]: any;
1633 }): {
1634 [key: string]: any;
1635 };
1636}
1637export declare namespace CfnRecordSet {
1638 /**
1639 * *Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
1640 *
1641 * When creating records for a private hosted zone, note the following:
1642 *
1643 * - Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.
1644 * - For information about creating failover records in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) .
1645 *
1646 * @struct
1647 * @stability external
1648 *
1649 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html
1650 */
1651 interface AliasTargetProperty {
1652 /**
1653 * *Alias records only:* The value that you specify depends on where you want to route queries:
1654 *
1655 * - **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :
1656 *
1657 * - For regional APIs, specify the value of `regionalDomainName` .
1658 * - For edge-optimized APIs, specify the value of `distributionDomainName` . This is the name of the associated CloudFront distribution, such as `da1b2c3d4e5.cloudfront.net` .
1659 *
1660 * > The name of the record that you're creating must match a custom domain name for your API, such as `api.example.com` .
1661 * - **Amazon Virtual Private Cloud interface VPC endpoint** - Enter the API endpoint for the interface endpoint, such as `vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com` . For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of `DnsName` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .
1662 * - **CloudFront distribution** - Specify the domain name that CloudFront assigned when you created your distribution.
1663 *
1664 * Your CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record 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)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html) in the *Amazon CloudFront Developer Guide* .
1665 *
1666 * You can't create a record in a private hosted zone to route traffic to a CloudFront distribution.
1667 *
1668 * > 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.
1669 * - **Elastic Beanstalk environment** - If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name `my-environment. *us-west-2* .elasticbeanstalk.com` is a regionalized domain name.
1670 *
1671 * > 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.
1672 *
1673 * 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:
1674 *
1675 * - *AWS Management Console* : For information about how to get the value by using the console, see [Using Custom Domains with AWS Elastic Beanstalk](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html) in the *AWS Elastic Beanstalk Developer Guide* .
1676 * - *Elastic Beanstalk API* : Use the `DescribeEnvironments` action to get the value of the `CNAME` attribute. For more information, see [DescribeEnvironments](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html) in the *AWS Elastic Beanstalk API Reference* .
1677 * - *AWS CLI* : Use the `describe-environments` command to get the value of the `CNAME` attribute. For more information, see [describe-environments](https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html) in the *AWS CLI* .
1678 * - **ELB load balancer** - Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console , the ELB API, or the AWS CLI .
1679 *
1680 * - *AWS 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.
1681 *
1682 * 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.
1683 * - *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the value of `DNSName` . For more information, see the applicable guide:
1684 *
1685 * - Classic Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)
1686 * - Application and Network Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
1687 * - *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the value of `DNSName` :
1688 *
1689 * - [Classic Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .
1690 * - [Application and Network Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .
1691 * - *AWS CLI* : Use `describe-load-balancers` to get the value of `DNSName` . For more information, see the applicable guide:
1692 *
1693 * - Classic Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)
1694 * - Application and Network Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)
1695 * - **Global Accelerator accelerator** - Specify the DNS name for your accelerator:
1696 *
1697 * - *Global Accelerator API* : To get the DNS name, use [DescribeAccelerator](https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html) .
1698 * - *AWS CLI* : To get the DNS name, use [describe-accelerator](https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html) .
1699 * - **Amazon S3 bucket that is configured as a static website** - Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, `s3-website.us-east-2.amazonaws.com` . For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* . For more information about using S3 buckets for websites, see [Getting Started with Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) in the *Amazon Route 53 Developer Guide.*
1700 * - **Another Route 53 record** - Specify the value of the `Name` element for a record in the current hosted zone.
1701 *
1702 * > 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.
1703 *
1704 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname
1705 */
1706 readonly dnsName: string;
1707 /**
1708 * *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 AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
1709 *
1710 * Note the following:
1711 *
1712 * - **CloudFront distributions** - You can't set `EvaluateTargetHealth` to `true` when the alias target is a CloudFront distribution.
1713 * - **Elastic Beanstalk environments that have regionalized subdomains** - If you specify an Elastic Beanstalk environment in `DNSName` and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set `EvaluateTargetHealth` to `true` and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
1714 *
1715 * If the environment contains a single Amazon EC2 instance, there are no special requirements.
1716 * - **ELB load balancers** - Health checking behavior depends on the type of load balancer:
1717 *
1718 * - *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.
1719 * - *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:
1720 *
1721 * - 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.
1722 * - A target group that has no registered targets is considered unhealthy.
1723 *
1724 * > 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.
1725 * - **S3 buckets** - There are no special requirements for setting `EvaluateTargetHealth` to `true` when the alias target is an S3 bucket.
1726 * - **Other records in the same hosted zone** - If the AWS 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?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) in the *Amazon Route 53 Developer Guide* .
1727 *
1728 * For more information and examples, see [Amazon Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer Guide* .
1729 *
1730 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth
1731 */
1732 readonly evaluateTargetHealth?: boolean | cdk.IResolvable;
1733 /**
1734 * *Alias resource records sets only* : The value used depends on where you want to route traffic:
1735 *
1736 * - **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :
1737 *
1738 * - For regional APIs, specify the value of `regionalHostedZoneId` .
1739 * - For edge-optimized APIs, specify the value of `distributionHostedZoneId` .
1740 * - **Amazon Virtual Private Cloud interface VPC endpoint** - Specify the hosted zone ID for your interface endpoint. You can get the value of `HostedZoneId` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .
1741 * - **CloudFront distribution** - Specify `Z2FDTNDATAQYW2` . This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution.
1742 *
1743 * > Alias records for CloudFront can't be created in a private zone.
1744 * - **Elastic Beanstalk environment** - Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see [AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference* .
1745 * - **ELB load balancer** - Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
1746 *
1747 * - [Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/elb.html) table in the "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.
1748 * - *AWS 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.
1749 * - *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the applicable value. For more information, see the applicable guide:
1750 *
1751 * - Classic Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneNameID` .
1752 * - Application and Network Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneID` .
1753 * - *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the applicable value:
1754 *
1755 * - Classic Load Balancers: Get [CanonicalHostedZoneNameID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .
1756 * - Application and Network Load Balancers: Get [CanonicalHostedZoneID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .
1757 * - *AWS CLI* : Use `describe-load-balancers` to get the applicable value. For more information, see the applicable guide:
1758 *
1759 * - Classic Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) to get the value of `CanonicalHostedZoneNameID` .
1760 * - Application and Network Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) to get the value of `CanonicalHostedZoneID` .
1761 * - **Global Accelerator accelerator** - Specify `Z2BJ6XQ5FK7U4H` .
1762 * - **An Amazon S3 bucket configured as a static website** - Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* .
1763 * - **Another Route 53 record in your hosted zone** - Specify the hosted zone ID of your hosted zone. (An alias record can't reference a record in a different hosted zone.)
1764 *
1765 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid
1766 */
1767 readonly hostedZoneId: string;
1768 }
1769}
1770export declare namespace CfnRecordSet {
1771 /**
1772 * The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
1773 *
1774 * A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.
1775 *
1776 * @struct
1777 * @stability external
1778 *
1779 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html
1780 */
1781 interface CidrRoutingConfigProperty {
1782 /**
1783 * The CIDR collection ID.
1784 *
1785 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-collectionid
1786 */
1787 readonly collectionId: string;
1788 /**
1789 * The CIDR collection location name.
1790 *
1791 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-locationname
1792 */
1793 readonly locationName: string;
1794 }
1795}
1796export declare namespace CfnRecordSet {
1797 /**
1798 * A complex type that contains information about a geographic location.
1799 *
1800 * @struct
1801 * @stability external
1802 *
1803 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html
1804 */
1805 interface GeoLocationProperty {
1806 /**
1807 * For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes:
1808 *
1809 * - *AF* : Africa
1810 * - *AN* : Antarctica
1811 * - *AS* : Asia
1812 * - *EU* : Europe
1813 * - *OC* : Oceania
1814 * - *NA* : North America
1815 * - *SA* : South America
1816 *
1817 * Constraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` error.
1818 *
1819 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode
1820 */
1821 readonly continentCode?: string;
1822 /**
1823 * For geolocation resource record sets, the two-letter code for a country.
1824 *
1825 * Route 53 uses the two-letter country codes that are specified in [ISO standard 3166-1 alpha-2](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) .
1826 *
1827 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode
1828 */
1829 readonly countryCode?: string;
1830 /**
1831 * 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](https://docs.aws.amazon.com/https://pe.usps.com/text/pub28/28apb.htm) on the United States Postal Service website.
1832 *
1833 * If you specify `subdivisioncode` , you must also specify `US` for `CountryCode` .
1834 *
1835 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode
1836 */
1837 readonly subdivisionCode?: string;
1838 }
1839}
1840/**
1841 * Properties for defining a `CfnRecordSetGroup`
1842 *
1843 * @struct
1844 * @stability external
1845 *
1846 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html
1847 */
1848export interface CfnRecordSetGroupProps {
1849 /**
1850 * *Optional:* Any comments you want to include about a change batch request.
1851 *
1852 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment
1853 */
1854 readonly comment?: string;
1855 /**
1856 * The ID of the hosted zone that you want to create records in.
1857 *
1858 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1859 *
1860 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid
1861 */
1862 readonly hostedZoneId?: string;
1863 /**
1864 * The name of the hosted zone that you want to create records in. You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .
1865 *
1866 * When you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName` . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.
1867 *
1868 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1869 *
1870 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename
1871 */
1872 readonly hostedZoneName?: string;
1873 /**
1874 * A complex type that contains one `RecordSet` element for each record that you want to create.
1875 *
1876 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets
1877 */
1878 readonly recordSets?: Array<CfnRecordSetGroup.RecordSetProperty | cdk.IResolvable> | cdk.IResolvable;
1879}
1880/**
1881 * A CloudFormation `AWS::Route53::RecordSetGroup`
1882 *
1883 * A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the records that you want to create.
1884 *
1885 * @cloudformationResource AWS::Route53::RecordSetGroup
1886 * @stability external
1887 *
1888 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html
1889 */
1890export declare class CfnRecordSetGroup extends cdk.CfnResource implements cdk.IInspectable {
1891 /**
1892 * The CloudFormation resource type name for this resource class.
1893 */
1894 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Route53::RecordSetGroup";
1895 /**
1896 * A factory method that creates a new instance of this class from an object
1897 * containing the CloudFormation properties of this resource.
1898 * Used in the @aws-cdk/cloudformation-include module.
1899 *
1900 * @internal
1901 */
1902 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRecordSetGroup;
1903 /**
1904 * *Optional:* Any comments you want to include about a change batch request.
1905 *
1906 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment
1907 */
1908 comment: string | undefined;
1909 /**
1910 * The ID of the hosted zone that you want to create records in.
1911 *
1912 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1913 *
1914 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid
1915 */
1916 hostedZoneId: string | undefined;
1917 /**
1918 * The name of the hosted zone that you want to create records in. You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .
1919 *
1920 * When you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName` . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.
1921 *
1922 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
1923 *
1924 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename
1925 */
1926 hostedZoneName: string | undefined;
1927 /**
1928 * A complex type that contains one `RecordSet` element for each record that you want to create.
1929 *
1930 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets
1931 */
1932 recordSets: Array<CfnRecordSetGroup.RecordSetProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
1933 /**
1934 * Create a new `AWS::Route53::RecordSetGroup`.
1935 *
1936 * @param scope - scope in which this resource is defined
1937 * @param id - scoped id of the resource
1938 * @param props - resource properties
1939 */
1940 constructor(scope: cdk.Construct, id: string, props?: CfnRecordSetGroupProps);
1941 /**
1942 * Examines the CloudFormation resource and discloses attributes.
1943 *
1944 * @param inspector - tree inspector to collect and process attributes
1945 *
1946 */
1947 inspect(inspector: cdk.TreeInspector): void;
1948 protected get cfnProperties(): {
1949 [key: string]: any;
1950 };
1951 protected renderProperties(props: {
1952 [key: string]: any;
1953 }): {
1954 [key: string]: any;
1955 };
1956}
1957export declare namespace CfnRecordSetGroup {
1958 /**
1959 * *Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
1960 *
1961 * When creating records for a private hosted zone, note the following:
1962 *
1963 * - Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.
1964 * - For information about creating failover records in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) .
1965 *
1966 * @struct
1967 * @stability external
1968 *
1969 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html
1970 */
1971 interface AliasTargetProperty {
1972 /**
1973 * *Alias records only:* The value that you specify depends on where you want to route queries:
1974 *
1975 * - **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :
1976 *
1977 * - For regional APIs, specify the value of `regionalDomainName` .
1978 * - For edge-optimized APIs, specify the value of `distributionDomainName` . This is the name of the associated CloudFront distribution, such as `da1b2c3d4e5.cloudfront.net` .
1979 *
1980 * > The name of the record that you're creating must match a custom domain name for your API, such as `api.example.com` .
1981 * - **Amazon Virtual Private Cloud interface VPC endpoint** - Enter the API endpoint for the interface endpoint, such as `vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com` . For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of `DnsName` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .
1982 * - **CloudFront distribution** - Specify the domain name that CloudFront assigned when you created your distribution.
1983 *
1984 * Your CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record 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)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html) in the *Amazon CloudFront Developer Guide* .
1985 *
1986 * You can't create a record in a private hosted zone to route traffic to a CloudFront distribution.
1987 *
1988 * > 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.
1989 * - **Elastic Beanstalk environment** - If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name `my-environment. *us-west-2* .elasticbeanstalk.com` is a regionalized domain name.
1990 *
1991 * > 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.
1992 *
1993 * 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:
1994 *
1995 * - *AWS Management Console* : For information about how to get the value by using the console, see [Using Custom Domains with AWS Elastic Beanstalk](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html) in the *AWS Elastic Beanstalk Developer Guide* .
1996 * - *Elastic Beanstalk API* : Use the `DescribeEnvironments` action to get the value of the `CNAME` attribute. For more information, see [DescribeEnvironments](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html) in the *AWS Elastic Beanstalk API Reference* .
1997 * - *AWS CLI* : Use the `describe-environments` command to get the value of the `CNAME` attribute. For more information, see [describe-environments](https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html) in the *AWS CLI* .
1998 * - **ELB load balancer** - Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console , the ELB API, or the AWS CLI .
1999 *
2000 * - *AWS 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.
2001 *
2002 * 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.
2003 * - *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the value of `DNSName` . For more information, see the applicable guide:
2004 *
2005 * - Classic Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)
2006 * - Application and Network Load Balancers: [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
2007 * - *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the value of `DNSName` :
2008 *
2009 * - [Classic Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .
2010 * - [Application and Network Load Balancers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .
2011 * - *AWS CLI* : Use `describe-load-balancers` to get the value of `DNSName` . For more information, see the applicable guide:
2012 *
2013 * - Classic Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)
2014 * - Application and Network Load Balancers: [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)
2015 * - **Global Accelerator accelerator** - Specify the DNS name for your accelerator:
2016 *
2017 * - *Global Accelerator API* : To get the DNS name, use [DescribeAccelerator](https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html) .
2018 * - *AWS CLI* : To get the DNS name, use [describe-accelerator](https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html) .
2019 * - **Amazon S3 bucket that is configured as a static website** - Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, `s3-website.us-east-2.amazonaws.com` . For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* . For more information about using S3 buckets for websites, see [Getting Started with Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) in the *Amazon Route 53 Developer Guide.*
2020 * - **Another Route 53 record** - Specify the value of the `Name` element for a record in the current hosted zone.
2021 *
2022 * > 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.
2023 *
2024 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname
2025 */
2026 readonly dnsName: string;
2027 /**
2028 * *Applies only to alias records with any routing policy:* When `EvaluateTargetHealth` is `true` , an alias record inherits the health of the referenced AWS resource, such as an ELB load balancer or another record in the hosted zone.
2029 *
2030 * Note the following:
2031 *
2032 * - **CloudFront distributions** - You can't set `EvaluateTargetHealth` to `true` when the alias target is a CloudFront distribution.
2033 * - **Elastic Beanstalk environments that have regionalized subdomains** - If you specify an Elastic Beanstalk environment in `DNSName` and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set `EvaluateTargetHealth` to `true` and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
2034 *
2035 * If the environment contains a single Amazon EC2 instance, there are no special requirements.
2036 * - **ELB load balancers** - Health checking behavior depends on the type of load balancer:
2037 *
2038 * - *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.
2039 * - *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:
2040 *
2041 * - 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.
2042 * - A target group that has no registered targets is considered unhealthy.
2043 *
2044 * > 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.
2045 * - **S3 buckets** - There are no special requirements for setting `EvaluateTargetHealth` to `true` when the alias target is an S3 bucket.
2046 * - **Other records in the same hosted zone** - If the AWS 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?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) in the *Amazon Route 53 Developer Guide* .
2047 *
2048 * For more information and examples, see [Amazon Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer Guide* .
2049 *
2050 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth
2051 */
2052 readonly evaluateTargetHealth?: boolean | cdk.IResolvable;
2053 /**
2054 * *Alias resource records sets only* : The value used depends on where you want to route traffic:
2055 *
2056 * - **Amazon API Gateway custom regional APIs and edge-optimized APIs** - Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command [get-domain-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) :
2057 *
2058 * - For regional APIs, specify the value of `regionalHostedZoneId` .
2059 * - For edge-optimized APIs, specify the value of `distributionHostedZoneId` .
2060 * - **Amazon Virtual Private Cloud interface VPC endpoint** - Specify the hosted zone ID for your interface endpoint. You can get the value of `HostedZoneId` using the AWS CLI command [describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) .
2061 * - **CloudFront distribution** - Specify `Z2FDTNDATAQYW2` . This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution.
2062 *
2063 * > Alias records for CloudFront can't be created in a private zone.
2064 * - **Elastic Beanstalk environment** - Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see [AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference* .
2065 * - **ELB load balancer** - Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
2066 *
2067 * - [Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/elb.html) table in the "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.
2068 * - *AWS 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.
2069 * - *Elastic Load Balancing API* : Use `DescribeLoadBalancers` to get the applicable value. For more information, see the applicable guide:
2070 *
2071 * - Classic Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneNameID` .
2072 * - Application and Network Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneID` .
2073 * - *CloudFormation Fn::GetAtt intrinsic function* : Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the applicable value:
2074 *
2075 * - Classic Load Balancers: Get [CanonicalHostedZoneNameID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values) .
2076 * - Application and Network Load Balancers: Get [CanonicalHostedZoneID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values) .
2077 * - *AWS CLI* : Use `describe-load-balancers` to get the applicable value. For more information, see the applicable guide:
2078 *
2079 * - Classic Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) to get the value of `CanonicalHostedZoneNameID` .
2080 * - Application and Network Load Balancers: Use [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) to get the value of `CanonicalHostedZoneID` .
2081 * - **Global Accelerator accelerator** - Specify `Z2BJ6XQ5FK7U4H` .
2082 * - **An Amazon S3 bucket configured as a static website** - Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference* .
2083 * - **Another Route 53 record in your hosted zone** - Specify the hosted zone ID of your hosted zone. (An alias record can't reference a record in a different hosted zone.)
2084 *
2085 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid
2086 */
2087 readonly hostedZoneId: string;
2088 }
2089}
2090export declare namespace CfnRecordSetGroup {
2091 /**
2092 * The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
2093 *
2094 * A `LocationName` with an asterisk “*” can be used to create a default CIDR record. `CollectionId` is still required for default record.
2095 *
2096 * @struct
2097 * @stability external
2098 *
2099 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html
2100 */
2101 interface CidrRoutingConfigProperty {
2102 /**
2103 * The CIDR collection ID.
2104 *
2105 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-collectionid
2106 */
2107 readonly collectionId: string;
2108 /**
2109 * The CIDR collection location name.
2110 *
2111 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-locationname
2112 */
2113 readonly locationName: string;
2114 }
2115}
2116export declare namespace CfnRecordSetGroup {
2117 /**
2118 * A complex type that contains information about a geographic location.
2119 *
2120 * @struct
2121 * @stability external
2122 *
2123 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html
2124 */
2125 interface GeoLocationProperty {
2126 /**
2127 * For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes:
2128 *
2129 * - *AF* : Africa
2130 * - *AN* : Antarctica
2131 * - *AS* : Asia
2132 * - *EU* : Europe
2133 * - *OC* : Oceania
2134 * - *NA* : North America
2135 * - *SA* : South America
2136 *
2137 * Constraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` error.
2138 *
2139 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode
2140 */
2141 readonly continentCode?: string;
2142 /**
2143 * For geolocation resource record sets, the two-letter code for a country.
2144 *
2145 * Route 53 uses the two-letter country codes that are specified in [ISO standard 3166-1 alpha-2](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) .
2146 *
2147 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode
2148 */
2149 readonly countryCode?: string;
2150 /**
2151 * 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](https://docs.aws.amazon.com/https://pe.usps.com/text/pub28/28apb.htm) on the United States Postal Service website.
2152 *
2153 * If you specify `subdivisioncode` , you must also specify `US` for `CountryCode` .
2154 *
2155 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode
2156 */
2157 readonly subdivisionCode?: string;
2158 }
2159}
2160export declare namespace CfnRecordSetGroup {
2161 /**
2162 * Information about one record that you want to create.
2163 *
2164 * @struct
2165 * @stability external
2166 *
2167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html
2168 */
2169 interface RecordSetProperty {
2170 /**
2171 * *Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
2172 *
2173 * If you're creating resource records sets for a private hosted zone, note the following:
2174 *
2175 * - You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
2176 * - For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide* .
2177 *
2178 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget
2179 */
2180 readonly aliasTarget?: CfnRecordSetGroup.AliasTargetProperty | cdk.IResolvable;
2181 /**
2182 * `CfnRecordSetGroup.RecordSetProperty.CidrRoutingConfig`
2183 *
2184 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig
2185 */
2186 readonly cidrRoutingConfig?: CfnRecordSetGroup.CidrRoutingConfigProperty | cdk.IResolvable;
2187 /**
2188 * *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.
2189 *
2190 * Except where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets:
2191 *
2192 * - 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.
2193 * - 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.
2194 * - 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.
2195 * - 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.
2196 *
2197 * 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.
2198 *
2199 * For failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true.
2200 *
2201 * For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide* :
2202 *
2203 * - [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)
2204 * - [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)
2205 *
2206 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover
2207 */
2208 readonly failover?: string;
2209 /**
2210 * *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` .
2211 *
2212 * > Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
2213 *
2214 * 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.
2215 *
2216 * You can't create two geolocation resource record sets that specify the same geographic location.
2217 *
2218 * 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.
2219 *
2220 * > 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.
2221 *
2222 * 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.
2223 *
2224 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation
2225 */
2226 readonly geoLocation?: CfnRecordSetGroup.GeoLocationProperty | cdk.IResolvable;
2227 /**
2228 * 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.
2229 *
2230 * Route 53 determines whether a resource record set is healthy based on one of the following:
2231 *
2232 * - By periodically sending a request to the endpoint that is specified in the health check
2233 * - By aggregating the status of a specified group of health checks (calculated health checks)
2234 * - By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
2235 *
2236 * > 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.
2237 *
2238 * For more information, see the following topics in the *Amazon Route 53 Developer Guide* :
2239 *
2240 * - [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
2241 * - [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)
2242 * - [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)
2243 *
2244 * *When to Specify HealthCheckId*
2245 *
2246 * 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:
2247 *
2248 * - *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.
2249 *
2250 * 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.
2251 *
2252 * 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.
2253 *
2254 * 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.
2255 * - *Alias resource record sets* : You specify the following settings:
2256 *
2257 * - 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).
2258 * - You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
2259 * - You specify a health check ID for the non-alias resource record set.
2260 *
2261 * 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.
2262 *
2263 * If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
2264 *
2265 * > 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.
2266 *
2267 * *Geolocation Routing*
2268 *
2269 * 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:
2270 *
2271 * - The United States
2272 * - North America
2273 * - The default resource record set
2274 *
2275 * *Specifying the Health Check Endpoint by Domain Name*
2276 *
2277 * 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` ).
2278 *
2279 * > Health check results will be unpredictable if you do the following:
2280 * >
2281 * > - Create a health check that has the same value for `FullyQualifiedDomainName` as the name of a resource record set.
2282 * > - Associate that health check with the resource record set.
2283 *
2284 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid
2285 */
2286 readonly healthCheckId?: string;
2287 /**
2288 * The ID of the hosted zone that you want to create records in.
2289 *
2290 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
2291 *
2292 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid
2293 */
2294 readonly hostedZoneId?: string;
2295 /**
2296 * The name of the hosted zone that you want to create records in. You must include a trailing dot (for example, `www.example.com.` ) as part of the `HostedZoneName` .
2297 *
2298 * When you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName` , AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName` . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.
2299 *
2300 * Specify either `HostedZoneName` or `HostedZoneId` , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId` .
2301 *
2302 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename
2303 */
2304 readonly hostedZoneName?: string;
2305 /**
2306 * *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:
2307 *
2308 * - 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.
2309 * - If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
2310 * - 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.
2311 * - If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
2312 * - When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
2313 * - If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.
2314 *
2315 * You can't create multivalue answer alias records.
2316 *
2317 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer
2318 */
2319 readonly multiValueAnswer?: boolean | cdk.IResolvable;
2320 /**
2321 * 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.
2322 *
2323 * *ChangeResourceRecordSets Only*
2324 *
2325 * 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.
2326 *
2327 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide* .
2328 *
2329 * You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, `*.example.com` . Note the following:
2330 *
2331 * - The * must replace the entire label. For example, you can't specify `*prod.example.com` or `prod*.example.com` .
2332 * - The * can't replace any of the middle labels, for example, marketing.*.example.com.
2333 * - 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.
2334 *
2335 * > You can't use the * wildcard for resource records sets that have a type of NS.
2336 *
2337 * You can use the * wildcard as the leftmost label in a domain name, for example, `*.example.com` . You can't use an * for one of the middle labels, for example, `marketing.*.example.com` . In addition, the * must replace the entire label; for example, you can't specify `prod*.example.com` .
2338 *
2339 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name
2340 */
2341 readonly name: string;
2342 /**
2343 * *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 AWS 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.
2344 *
2345 * 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.
2346 *
2347 * Note the following:
2348 *
2349 * - You can only specify one `ResourceRecord` per latency resource record set.
2350 * - You can only create one latency resource record set for each Amazon EC2 Region.
2351 * - 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.
2352 * - 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.
2353 *
2354 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region
2355 */
2356 readonly region?: string;
2357 /**
2358 * Information about the records that you want to create. Each record should be in the format appropriate for the record type specified by the `Type` property. For information about different record types and their record formats, see [Values That You Specify When You Create or Edit Amazon Route 53 Records](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html) in the *Amazon Route 53 Developer Guide* .
2359 *
2360 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords
2361 */
2362 readonly resourceRecords?: string[];
2363 /**
2364 * *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.
2365 *
2366 * For information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide* .
2367 *
2368 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier
2369 */
2370 readonly setIdentifier?: string;
2371 /**
2372 * The resource record cache time to live (TTL), in seconds. Note the following:
2373 *
2374 * - 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.
2375 * - 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.
2376 * - All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL` .
2377 * - 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` .
2378 *
2379 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl
2380 */
2381 readonly ttl?: string;
2382 /**
2383 * The DNS record type. For information about different record types and how data is encoded for them, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide* .
2384 *
2385 * Valid values for basic resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `DS` | `MX` | `NAPTR` | `NS` | `PTR` | `SOA` | `SPF` | `SRV` | `TXT`
2386 *
2387 * Values for weighted, latency, geolocation, and failover resource record sets: `A` | `AAAA` | `CAA` | `CNAME` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT` . 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.
2388 *
2389 * Valid values for multivalue answer resource record sets: `A` | `AAAA` | `MX` | `NAPTR` | `PTR` | `SPF` | `SRV` | `TXT`
2390 *
2391 * > 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](https://docs.aws.amazon.com/http://tools.ietf.org/html/rfc7208#section-14.1) .
2392 *
2393 * Values for alias resource record sets:
2394 *
2395 * - *Amazon API Gateway custom regional APIs and edge-optimized APIs:* `A`
2396 * - *CloudFront distributions:* `A`
2397 *
2398 * 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` .
2399 * - *Amazon API Gateway environment that has a regionalized subdomain* : `A`
2400 * - *ELB load balancers:* `A` | `AAAA`
2401 * - *Amazon S3 buckets:* `A`
2402 * - *Amazon Virtual Private Cloud interface VPC endpoints* `A`
2403 * - *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` .
2404 *
2405 * > 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.
2406 *
2407 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type
2408 */
2409 readonly type: string;
2410 /**
2411 * *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:
2412 *
2413 * - You must specify a value for the `Weight` element for every weighted resource record set.
2414 * - You can only specify one `ResourceRecord` per weighted resource record set.
2415 * - 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.
2416 * - You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements.
2417 * - 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.
2418 *
2419 * 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer Guide* .
2420 *
2421 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight
2422 */
2423 readonly weight?: number;
2424 }
2425}