UNPKG

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