UNPKG

48.1 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Route53Resolver extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Route53Resolver.Types.ClientConfiguration)
13 config: Config & Route53Resolver.Types.ClientConfiguration;
14 /**
15 * Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address. To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
16 */
17 associateResolverEndpointIpAddress(params: Route53Resolver.Types.AssociateResolverEndpointIpAddressRequest, callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverEndpointIpAddressResponse) => void): Request<Route53Resolver.Types.AssociateResolverEndpointIpAddressResponse, AWSError>;
18 /**
19 * Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address. To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
20 */
21 associateResolverEndpointIpAddress(callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverEndpointIpAddressResponse) => void): Request<Route53Resolver.Types.AssociateResolverEndpointIpAddressResponse, AWSError>;
22 /**
23 * Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.
24 */
25 associateResolverRule(params: Route53Resolver.Types.AssociateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverRuleResponse) => void): Request<Route53Resolver.Types.AssociateResolverRuleResponse, AWSError>;
26 /**
27 * Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.
28 */
29 associateResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverRuleResponse) => void): Request<Route53Resolver.Types.AssociateResolverRuleResponse, AWSError>;
30 /**
31 * Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC. An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.
32 */
33 createResolverEndpoint(params: Route53Resolver.Types.CreateResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverEndpointResponse) => void): Request<Route53Resolver.Types.CreateResolverEndpointResponse, AWSError>;
34 /**
35 * Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC. An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.
36 */
37 createResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverEndpointResponse) => void): Request<Route53Resolver.Types.CreateResolverEndpointResponse, AWSError>;
38 /**
39 * For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
40 */
41 createResolverRule(params: Route53Resolver.Types.CreateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverRuleResponse) => void): Request<Route53Resolver.Types.CreateResolverRuleResponse, AWSError>;
42 /**
43 * For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
44 */
45 createResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverRuleResponse) => void): Request<Route53Resolver.Types.CreateResolverRuleResponse, AWSError>;
46 /**
47 * Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint: Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC. Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.
48 */
49 deleteResolverEndpoint(params: Route53Resolver.Types.DeleteResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverEndpointResponse) => void): Request<Route53Resolver.Types.DeleteResolverEndpointResponse, AWSError>;
50 /**
51 * Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint: Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC. Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.
52 */
53 deleteResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverEndpointResponse) => void): Request<Route53Resolver.Types.DeleteResolverEndpointResponse, AWSError>;
54 /**
55 * Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule.
56 */
57 deleteResolverRule(params: Route53Resolver.Types.DeleteResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverRuleResponse) => void): Request<Route53Resolver.Types.DeleteResolverRuleResponse, AWSError>;
58 /**
59 * Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule.
60 */
61 deleteResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverRuleResponse) => void): Request<Route53Resolver.Types.DeleteResolverRuleResponse, AWSError>;
62 /**
63 * Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address. To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.
64 */
65 disassociateResolverEndpointIpAddress(params: Route53Resolver.Types.DisassociateResolverEndpointIpAddressRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverEndpointIpAddressResponse) => void): Request<Route53Resolver.Types.DisassociateResolverEndpointIpAddressResponse, AWSError>;
66 /**
67 * Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address. To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.
68 */
69 disassociateResolverEndpointIpAddress(callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverEndpointIpAddressResponse) => void): Request<Route53Resolver.Types.DisassociateResolverEndpointIpAddressResponse, AWSError>;
70 /**
71 * Removes the association between a specified resolver rule and a specified VPC. If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.
72 */
73 disassociateResolverRule(params: Route53Resolver.Types.DisassociateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverRuleResponse) => void): Request<Route53Resolver.Types.DisassociateResolverRuleResponse, AWSError>;
74 /**
75 * Removes the association between a specified resolver rule and a specified VPC. If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.
76 */
77 disassociateResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverRuleResponse) => void): Request<Route53Resolver.Types.DisassociateResolverRuleResponse, AWSError>;
78 /**
79 * Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.
80 */
81 getResolverEndpoint(params: Route53Resolver.Types.GetResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverEndpointResponse) => void): Request<Route53Resolver.Types.GetResolverEndpointResponse, AWSError>;
82 /**
83 * Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.
84 */
85 getResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverEndpointResponse) => void): Request<Route53Resolver.Types.GetResolverEndpointResponse, AWSError>;
86 /**
87 * Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.
88 */
89 getResolverRule(params: Route53Resolver.Types.GetResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleResponse) => void): Request<Route53Resolver.Types.GetResolverRuleResponse, AWSError>;
90 /**
91 * Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.
92 */
93 getResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleResponse) => void): Request<Route53Resolver.Types.GetResolverRuleResponse, AWSError>;
94 /**
95 * Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.
96 */
97 getResolverRuleAssociation(params: Route53Resolver.Types.GetResolverRuleAssociationRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleAssociationResponse) => void): Request<Route53Resolver.Types.GetResolverRuleAssociationResponse, AWSError>;
98 /**
99 * Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.
100 */
101 getResolverRuleAssociation(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleAssociationResponse) => void): Request<Route53Resolver.Types.GetResolverRuleAssociationResponse, AWSError>;
102 /**
103 * Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
104 */
105 getResolverRulePolicy(params: Route53Resolver.Types.GetResolverRulePolicyRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRulePolicyResponse) => void): Request<Route53Resolver.Types.GetResolverRulePolicyResponse, AWSError>;
106 /**
107 * Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
108 */
109 getResolverRulePolicy(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRulePolicyResponse) => void): Request<Route53Resolver.Types.GetResolverRulePolicyResponse, AWSError>;
110 /**
111 * Gets the IP addresses for a specified resolver endpoint.
112 */
113 listResolverEndpointIpAddresses(params: Route53Resolver.Types.ListResolverEndpointIpAddressesRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointIpAddressesResponse) => void): Request<Route53Resolver.Types.ListResolverEndpointIpAddressesResponse, AWSError>;
114 /**
115 * Gets the IP addresses for a specified resolver endpoint.
116 */
117 listResolverEndpointIpAddresses(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointIpAddressesResponse) => void): Request<Route53Resolver.Types.ListResolverEndpointIpAddressesResponse, AWSError>;
118 /**
119 * Lists all the resolver endpoints that were created using the current AWS account.
120 */
121 listResolverEndpoints(params: Route53Resolver.Types.ListResolverEndpointsRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointsResponse) => void): Request<Route53Resolver.Types.ListResolverEndpointsResponse, AWSError>;
122 /**
123 * Lists all the resolver endpoints that were created using the current AWS account.
124 */
125 listResolverEndpoints(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointsResponse) => void): Request<Route53Resolver.Types.ListResolverEndpointsResponse, AWSError>;
126 /**
127 * Lists the associations that were created between resolver rules and VPCs using the current AWS account.
128 */
129 listResolverRuleAssociations(params: Route53Resolver.Types.ListResolverRuleAssociationsRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRuleAssociationsResponse) => void): Request<Route53Resolver.Types.ListResolverRuleAssociationsResponse, AWSError>;
130 /**
131 * Lists the associations that were created between resolver rules and VPCs using the current AWS account.
132 */
133 listResolverRuleAssociations(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRuleAssociationsResponse) => void): Request<Route53Resolver.Types.ListResolverRuleAssociationsResponse, AWSError>;
134 /**
135 * Lists the resolver rules that were created using the current AWS account.
136 */
137 listResolverRules(params: Route53Resolver.Types.ListResolverRulesRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRulesResponse) => void): Request<Route53Resolver.Types.ListResolverRulesResponse, AWSError>;
138 /**
139 * Lists the resolver rules that were created using the current AWS account.
140 */
141 listResolverRules(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRulesResponse) => void): Request<Route53Resolver.Types.ListResolverRulesResponse, AWSError>;
142 /**
143 * Lists the tags that you associated with the specified resource.
144 */
145 listTagsForResource(params: Route53Resolver.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListTagsForResourceResponse) => void): Request<Route53Resolver.Types.ListTagsForResourceResponse, AWSError>;
146 /**
147 * Lists the tags that you associated with the specified resource.
148 */
149 listTagsForResource(callback?: (err: AWSError, data: Route53Resolver.Types.ListTagsForResourceResponse) => void): Request<Route53Resolver.Types.ListTagsForResourceResponse, AWSError>;
150 /**
151 * Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
152 */
153 putResolverRulePolicy(params: Route53Resolver.Types.PutResolverRulePolicyRequest, callback?: (err: AWSError, data: Route53Resolver.Types.PutResolverRulePolicyResponse) => void): Request<Route53Resolver.Types.PutResolverRulePolicyResponse, AWSError>;
154 /**
155 * Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
156 */
157 putResolverRulePolicy(callback?: (err: AWSError, data: Route53Resolver.Types.PutResolverRulePolicyResponse) => void): Request<Route53Resolver.Types.PutResolverRulePolicyResponse, AWSError>;
158 /**
159 * Adds one or more tags to a specified resource.
160 */
161 tagResource(params: Route53Resolver.Types.TagResourceRequest, callback?: (err: AWSError, data: Route53Resolver.Types.TagResourceResponse) => void): Request<Route53Resolver.Types.TagResourceResponse, AWSError>;
162 /**
163 * Adds one or more tags to a specified resource.
164 */
165 tagResource(callback?: (err: AWSError, data: Route53Resolver.Types.TagResourceResponse) => void): Request<Route53Resolver.Types.TagResourceResponse, AWSError>;
166 /**
167 * Removes one or more tags from a specified resource.
168 */
169 untagResource(params: Route53Resolver.Types.UntagResourceRequest, callback?: (err: AWSError, data: Route53Resolver.Types.UntagResourceResponse) => void): Request<Route53Resolver.Types.UntagResourceResponse, AWSError>;
170 /**
171 * Removes one or more tags from a specified resource.
172 */
173 untagResource(callback?: (err: AWSError, data: Route53Resolver.Types.UntagResourceResponse) => void): Request<Route53Resolver.Types.UntagResourceResponse, AWSError>;
174 /**
175 * Updates the name of an inbound or an outbound resolver endpoint.
176 */
177 updateResolverEndpoint(params: Route53Resolver.Types.UpdateResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverEndpointResponse) => void): Request<Route53Resolver.Types.UpdateResolverEndpointResponse, AWSError>;
178 /**
179 * Updates the name of an inbound or an outbound resolver endpoint.
180 */
181 updateResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverEndpointResponse) => void): Request<Route53Resolver.Types.UpdateResolverEndpointResponse, AWSError>;
182 /**
183 * Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.
184 */
185 updateResolverRule(params: Route53Resolver.Types.UpdateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverRuleResponse) => void): Request<Route53Resolver.Types.UpdateResolverRuleResponse, AWSError>;
186 /**
187 * Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.
188 */
189 updateResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverRuleResponse) => void): Request<Route53Resolver.Types.UpdateResolverRuleResponse, AWSError>;
190}
191declare namespace Route53Resolver {
192 export type AccountId = string;
193 export type Arn = string;
194 export interface AssociateResolverEndpointIpAddressRequest {
195 /**
196 * The ID of the resolver endpoint that you want to associate IP addresses with.
197 */
198 ResolverEndpointId: ResourceId;
199 /**
200 * Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.
201 */
202 IpAddress: IpAddressUpdate;
203 }
204 export interface AssociateResolverEndpointIpAddressResponse {
205 /**
206 * The response to an AssociateResolverEndpointIpAddress request.
207 */
208 ResolverEndpoint?: ResolverEndpoint;
209 }
210 export interface AssociateResolverRuleRequest {
211 /**
212 * The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules.
213 */
214 ResolverRuleId: ResourceId;
215 /**
216 * A name for the association that you're creating between a resolver rule and a VPC.
217 */
218 Name?: Name;
219 /**
220 * The ID of the VPC that you want to associate the resolver rule with.
221 */
222 VPCId: ResourceId;
223 }
224 export interface AssociateResolverRuleResponse {
225 /**
226 * Information about the AssociateResolverRule request, including the status of the request.
227 */
228 ResolverRuleAssociation?: ResolverRuleAssociation;
229 }
230 export type Boolean = boolean;
231 export interface CreateResolverEndpointRequest {
232 /**
233 * A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
234 */
235 CreatorRequestId: CreatorRequestId;
236 /**
237 * A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
238 */
239 Name?: Name;
240 /**
241 * The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints).
242 */
243 SecurityGroupIds: SecurityGroupIds;
244 /**
245 * Specify the applicable value: INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC
246 */
247 Direction: ResolverEndpointDirection;
248 /**
249 * The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints).
250 */
251 IpAddresses: IpAddressesRequest;
252 /**
253 * A list of the tag keys and values that you want to associate with the endpoint.
254 */
255 Tags?: TagList;
256 }
257 export interface CreateResolverEndpointResponse {
258 /**
259 * Information about the CreateResolverEndpoint request, including the status of the request.
260 */
261 ResolverEndpoint?: ResolverEndpoint;
262 }
263 export interface CreateResolverRuleRequest {
264 /**
265 * A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
266 */
267 CreatorRequestId: CreatorRequestId;
268 /**
269 * A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
270 */
271 Name?: Name;
272 /**
273 * Specify FORWARD. Other resolver rule types aren't supported.
274 */
275 RuleType: RuleTypeOption;
276 /**
277 * DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains the most specific domain name (www.example.com).
278 */
279 DomainName: DomainName;
280 /**
281 * The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.
282 */
283 TargetIps?: TargetList;
284 /**
285 * The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
286 */
287 ResolverEndpointId?: ResourceId;
288 /**
289 * A list of the tag keys and values that you want to associate with the endpoint.
290 */
291 Tags?: TagList;
292 }
293 export interface CreateResolverRuleResponse {
294 /**
295 * Information about the CreateResolverRule request, including the status of the request.
296 */
297 ResolverRule?: ResolverRule;
298 }
299 export type CreatorRequestId = string;
300 export interface DeleteResolverEndpointRequest {
301 /**
302 * The ID of the resolver endpoint that you want to delete.
303 */
304 ResolverEndpointId: ResourceId;
305 }
306 export interface DeleteResolverEndpointResponse {
307 /**
308 * Information about the DeleteResolverEndpoint request, including the status of the request.
309 */
310 ResolverEndpoint?: ResolverEndpoint;
311 }
312 export interface DeleteResolverRuleRequest {
313 /**
314 * The ID of the resolver rule that you want to delete.
315 */
316 ResolverRuleId: ResourceId;
317 }
318 export interface DeleteResolverRuleResponse {
319 /**
320 * Information about the DeleteResolverRule request, including the status of the request.
321 */
322 ResolverRule?: ResolverRule;
323 }
324 export interface DisassociateResolverEndpointIpAddressRequest {
325 /**
326 * The ID of the resolver endpoint that you want to disassociate an IP address from.
327 */
328 ResolverEndpointId: ResourceId;
329 /**
330 * The IPv4 address that you want to remove from a resolver endpoint.
331 */
332 IpAddress: IpAddressUpdate;
333 }
334 export interface DisassociateResolverEndpointIpAddressResponse {
335 /**
336 * The response to an DisassociateResolverEndpointIpAddress request.
337 */
338 ResolverEndpoint?: ResolverEndpoint;
339 }
340 export interface DisassociateResolverRuleRequest {
341 /**
342 * The ID of the VPC that you want to disassociate the resolver rule from.
343 */
344 VPCId: ResourceId;
345 /**
346 * The ID of the resolver rule that you want to disassociate from the specified VPC.
347 */
348 ResolverRuleId: ResourceId;
349 }
350 export interface DisassociateResolverRuleResponse {
351 /**
352 * Information about the DisassociateResolverRule request, including the status of the request.
353 */
354 ResolverRuleAssociation?: ResolverRuleAssociation;
355 }
356 export type DomainName = string;
357 export interface Filter {
358 /**
359 * When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name.
360 */
361 Name?: FilterName;
362 /**
363 * When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values.
364 */
365 Values?: FilterValues;
366 }
367 export type FilterName = string;
368 export type FilterValue = string;
369 export type FilterValues = FilterValue[];
370 export type Filters = Filter[];
371 export interface GetResolverEndpointRequest {
372 /**
373 * The ID of the resolver endpoint that you want to get information about.
374 */
375 ResolverEndpointId: ResourceId;
376 }
377 export interface GetResolverEndpointResponse {
378 /**
379 * Information about the resolver endpoint that you specified in a GetResolverEndpoint request.
380 */
381 ResolverEndpoint?: ResolverEndpoint;
382 }
383 export interface GetResolverRuleAssociationRequest {
384 /**
385 * The ID of the resolver rule association that you want to get information about.
386 */
387 ResolverRuleAssociationId: ResourceId;
388 }
389 export interface GetResolverRuleAssociationResponse {
390 /**
391 * Information about the resolver rule association that you specified in a GetResolverRuleAssociation request.
392 */
393 ResolverRuleAssociation?: ResolverRuleAssociation;
394 }
395 export interface GetResolverRulePolicyRequest {
396 /**
397 * The ID of the resolver rule policy that you want to get information about.
398 */
399 Arn: Arn;
400 }
401 export interface GetResolverRulePolicyResponse {
402 /**
403 * Information about the resolver rule policy that you specified in a GetResolverRulePolicy request.
404 */
405 ResolverRulePolicy?: ResolverRulePolicy;
406 }
407 export interface GetResolverRuleRequest {
408 /**
409 * The ID of the resolver rule that you want to get information about.
410 */
411 ResolverRuleId: ResourceId;
412 }
413 export interface GetResolverRuleResponse {
414 /**
415 * Information about the resolver rule that you specified in a GetResolverRule request.
416 */
417 ResolverRule?: ResolverRule;
418 }
419 export type Ip = string;
420 export type IpAddressCount = number;
421 export interface IpAddressRequest {
422 /**
423 * The subnet that contains the IP address.
424 */
425 SubnetId: SubnetId;
426 /**
427 * The IP address that you want to use for DNS queries.
428 */
429 Ip?: Ip;
430 }
431 export interface IpAddressResponse {
432 /**
433 * The ID of one IP address.
434 */
435 IpId?: ResourceId;
436 /**
437 * The ID of one subnet.
438 */
439 SubnetId?: SubnetId;
440 /**
441 * One IP address that the resolver endpoint uses for DNS queries.
442 */
443 Ip?: Ip;
444 /**
445 * A status code that gives the current status of the request.
446 */
447 Status?: IpAddressStatus;
448 /**
449 * A message that provides additional information about the status of the request.
450 */
451 StatusMessage?: StatusMessage;
452 /**
453 * The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).
454 */
455 CreationTime?: Rfc3339TimeString;
456 /**
457 * The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).
458 */
459 ModificationTime?: Rfc3339TimeString;
460 }
461 export type IpAddressStatus = "CREATING"|"FAILED_CREATION"|"ATTACHING"|"ATTACHED"|"REMAP_DETACHING"|"REMAP_ATTACHING"|"DETACHING"|"FAILED_RESOURCE_GONE"|"DELETING"|"DELETE_FAILED_FAS_EXPIRED"|string;
462 export interface IpAddressUpdate {
463 /**
464 * Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.
465 */
466 IpId?: ResourceId;
467 /**
468 * The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
469 */
470 SubnetId?: SubnetId;
471 /**
472 * The new IP address.
473 */
474 Ip?: Ip;
475 }
476 export type IpAddressesRequest = IpAddressRequest[];
477 export type IpAddressesResponse = IpAddressResponse[];
478 export interface ListResolverEndpointIpAddressesRequest {
479 /**
480 * The ID of the resolver endpoint that you want to get IP addresses for.
481 */
482 ResolverEndpointId: ResourceId;
483 /**
484 * The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses.
485 */
486 MaxResults?: MaxResults;
487 /**
488 * For the first ListResolverEndpointIpAddresses request, omit this value. If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
489 */
490 NextToken?: NextToken;
491 }
492 export interface ListResolverEndpointIpAddressesResponse {
493 /**
494 * If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
495 */
496 NextToken?: NextToken;
497 /**
498 * The value that you specified for MaxResults in the request.
499 */
500 MaxResults?: MaxResults;
501 /**
502 * The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to Resolver (inbound endpoint).
503 */
504 IpAddresses?: IpAddressesResponse;
505 }
506 export interface ListResolverEndpointsRequest {
507 /**
508 * The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver endpoints.
509 */
510 MaxResults?: MaxResults;
511 /**
512 * For the first ListResolverEndpoints request, omit this value. If you have more than MaxResults resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of resolver endpoints. In the next request, specify the value of NextToken from the previous response.
513 */
514 NextToken?: NextToken;
515 /**
516 * An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints. If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
517 */
518 Filters?: Filters;
519 }
520 export interface ListResolverEndpointsResponse {
521 /**
522 * If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
523 */
524 NextToken?: NextToken;
525 /**
526 * The value that you specified for MaxResults in the request.
527 */
528 MaxResults?: MaxResults;
529 /**
530 * The resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.
531 */
532 ResolverEndpoints?: ResolverEndpoints;
533 }
534 export interface ListResolverRuleAssociationsRequest {
535 /**
536 * The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.
537 */
538 MaxResults?: MaxResults;
539 /**
540 * For the first ListResolverRuleAssociation request, omit this value. If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.
541 */
542 NextToken?: NextToken;
543 /**
544 * An optional specification to return a subset of resolver rules, such as resolver rules that are associated with the same VPC ID. If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
545 */
546 Filters?: Filters;
547 }
548 export interface ListResolverRuleAssociationsResponse {
549 /**
550 * If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
551 */
552 NextToken?: NextToken;
553 /**
554 * The value that you specified for MaxResults in the request.
555 */
556 MaxResults?: MaxResults;
557 /**
558 * The associations that were created between resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.
559 */
560 ResolverRuleAssociations?: ResolverRuleAssociations;
561 }
562 export interface ListResolverRulesRequest {
563 /**
564 * The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver rules.
565 */
566 MaxResults?: MaxResults;
567 /**
568 * For the first ListResolverRules request, omit this value. If you have more than MaxResults resolver rules, you can submit another ListResolverRules request to get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response.
569 */
570 NextToken?: NextToken;
571 /**
572 * An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint. If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
573 */
574 Filters?: Filters;
575 }
576 export interface ListResolverRulesResponse {
577 /**
578 * If more than MaxResults resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
579 */
580 NextToken?: NextToken;
581 /**
582 * The value that you specified for MaxResults in the request.
583 */
584 MaxResults?: MaxResults;
585 /**
586 * The resolver rules that were created using the current AWS account and that match the specified filters, if any.
587 */
588 ResolverRules?: ResolverRules;
589 }
590 export interface ListTagsForResourceRequest {
591 /**
592 * The Amazon Resource Name (ARN) for the resource that you want to list tags for.
593 */
594 ResourceArn: Arn;
595 /**
596 * The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags.
597 */
598 MaxResults?: MaxResults;
599 /**
600 * For the first ListTagsForResource request, omit this value. If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.
601 */
602 NextToken?: NextToken;
603 }
604 export interface ListTagsForResourceResponse {
605 /**
606 * The tags that are associated with the resource that you specified in the ListTagsForResource request.
607 */
608 Tags?: TagList;
609 /**
610 * If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
611 */
612 NextToken?: NextToken;
613 }
614 export type MaxResults = number;
615 export type Name = string;
616 export type NextToken = string;
617 export type Port = number;
618 export interface PutResolverRulePolicyRequest {
619 /**
620 * The Amazon Resource Name (ARN) of the account that you want to grant permissions to.
621 */
622 Arn: Arn;
623 /**
624 * An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account.
625 */
626 ResolverRulePolicy: ResolverRulePolicy;
627 }
628 export interface PutResolverRulePolicyResponse {
629 /**
630 * Whether the PutResolverRulePolicy request was successful.
631 */
632 ReturnValue?: Boolean;
633 }
634 export interface ResolverEndpoint {
635 /**
636 * The ID of the resolver endpoint.
637 */
638 Id?: ResourceId;
639 /**
640 * A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.
641 */
642 CreatorRequestId?: CreatorRequestId;
643 /**
644 * The ARN (Amazon Resource Name) for the resolver endpoint.
645 */
646 Arn?: Arn;
647 /**
648 * The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.
649 */
650 Name?: Name;
651 /**
652 * The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.
653 */
654 SecurityGroupIds?: SecurityGroupIds;
655 /**
656 * Indicates whether the resolver endpoint allows inbound or outbound DNS queries: INBOUND: allows DNS queries to your VPC from your network or another VPC OUTBOUND: allows DNS queries from your VPC to your network or another VPC
657 */
658 Direction?: ResolverEndpointDirection;
659 /**
660 * The number of IP addresses that the resolver endpoint can use for DNS queries.
661 */
662 IpAddressCount?: IpAddressCount;
663 /**
664 * The ID of the VPC that you want to create the resolver endpoint in.
665 */
666 HostVPCId?: ResourceId;
667 /**
668 * A code that specifies the current status of the resolver endpoint.
669 */
670 Status?: ResolverEndpointStatus;
671 /**
672 * A detailed description of the status of the resolver endpoint.
673 */
674 StatusMessage?: StatusMessage;
675 /**
676 * The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
677 */
678 CreationTime?: Rfc3339TimeString;
679 /**
680 * The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
681 */
682 ModificationTime?: Rfc3339TimeString;
683 }
684 export type ResolverEndpointDirection = "INBOUND"|"OUTBOUND"|string;
685 export type ResolverEndpointStatus = "CREATING"|"OPERATIONAL"|"UPDATING"|"AUTO_RECOVERING"|"ACTION_NEEDED"|"DELETING"|string;
686 export type ResolverEndpoints = ResolverEndpoint[];
687 export interface ResolverRule {
688 /**
689 * The ID that Resolver assigned to the resolver rule when you created it.
690 */
691 Id?: ResourceId;
692 /**
693 * A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.
694 */
695 CreatorRequestId?: CreatorRequestId;
696 /**
697 * The ARN (Amazon Resource Name) for the resolver rule specified by Id.
698 */
699 Arn?: Arn;
700 /**
701 * DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name (www.example.com).
702 */
703 DomainName?: DomainName;
704 /**
705 * A code that specifies the current status of the resolver rule.
706 */
707 Status?: ResolverRuleStatus;
708 /**
709 * A detailed description of the status of a resolver rule.
710 */
711 StatusMessage?: StatusMessage;
712 /**
713 * This value is always FORWARD. Other resolver rule types aren't supported.
714 */
715 RuleType?: RuleTypeOption;
716 /**
717 * The name for the resolver rule, which you specified when you created the resolver rule.
718 */
719 Name?: Name;
720 /**
721 * An array that contains the IP addresses and ports that you want to forward
722 */
723 TargetIps?: TargetList;
724 /**
725 * The ID of the endpoint that the rule is associated with.
726 */
727 ResolverEndpointId?: ResourceId;
728 /**
729 * When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
730 */
731 OwnerId?: AccountId;
732 /**
733 * Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
734 */
735 ShareStatus?: ShareStatus;
736 }
737 export interface ResolverRuleAssociation {
738 /**
739 * The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.
740 */
741 Id?: ResourceId;
742 /**
743 * The ID of the resolver rule that you associated with the VPC that is specified by VPCId.
744 */
745 ResolverRuleId?: ResourceId;
746 /**
747 * The name of an association between a resolver rule and a VPC.
748 */
749 Name?: Name;
750 /**
751 * The ID of the VPC that you associated the resolver rule with.
752 */
753 VPCId?: ResourceId;
754 /**
755 * A code that specifies the current status of the association between a resolver rule and a VPC.
756 */
757 Status?: ResolverRuleAssociationStatus;
758 /**
759 * A detailed description of the status of the association between a resolver rule and a VPC.
760 */
761 StatusMessage?: StatusMessage;
762 }
763 export type ResolverRuleAssociationStatus = "CREATING"|"COMPLETE"|"DELETING"|"FAILED"|"OVERRIDDEN"|string;
764 export type ResolverRuleAssociations = ResolverRuleAssociation[];
765 export interface ResolverRuleConfig {
766 /**
767 * The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.
768 */
769 Name?: Name;
770 /**
771 * For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.
772 */
773 TargetIps?: TargetList;
774 /**
775 * The ID of the new outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
776 */
777 ResolverEndpointId?: ResourceId;
778 }
779 export type ResolverRulePolicy = string;
780 export type ResolverRuleStatus = "COMPLETE"|"DELETING"|"UPDATING"|"FAILED"|string;
781 export type ResolverRules = ResolverRule[];
782 export type ResourceId = string;
783 export type Rfc3339TimeString = string;
784 export type RuleTypeOption = "FORWARD"|"SYSTEM"|"RECURSIVE"|string;
785 export type SecurityGroupIds = ResourceId[];
786 export type ShareStatus = "NOT_SHARED"|"SHARED_WITH_ME"|"SHARED_BY_ME"|string;
787 export type StatusMessage = string;
788 export type SubnetId = string;
789 export interface Tag {
790 /**
791 * The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.
792 */
793 Key?: TagKey;
794 /**
795 * The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.
796 */
797 Value?: TagValue;
798 }
799 export type TagKey = string;
800 export type TagKeyList = TagKey[];
801 export type TagList = Tag[];
802 export interface TagResourceRequest {
803 /**
804 * The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command: GetResolverEndpoint GetResolverRule GetResolverRuleAssociation ListResolverEndpoints ListResolverRuleAssociations ListResolverRules
805 */
806 ResourceArn: Arn;
807 /**
808 * The tags that you want to add to the specified resource.
809 */
810 Tags: TagList;
811 }
812 export interface TagResourceResponse {
813 }
814 export type TagValue = string;
815 export interface TargetAddress {
816 /**
817 * One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
818 */
819 Ip: Ip;
820 /**
821 * The port at Ip that you want to forward DNS queries to.
822 */
823 Port?: Port;
824 }
825 export type TargetList = TargetAddress[];
826 export interface UntagResourceRequest {
827 /**
828 * The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command: GetResolverEndpoint GetResolverRule GetResolverRuleAssociation ListResolverEndpoints ListResolverRuleAssociations ListResolverRules
829 */
830 ResourceArn: Arn;
831 /**
832 * The tags that you want to remove to the specified resource.
833 */
834 TagKeys: TagKeyList;
835 }
836 export interface UntagResourceResponse {
837 }
838 export interface UpdateResolverEndpointRequest {
839 /**
840 * The ID of the resolver endpoint that you want to update.
841 */
842 ResolverEndpointId: ResourceId;
843 /**
844 * The name of the resolver endpoint that you want to update.
845 */
846 Name?: Name;
847 }
848 export interface UpdateResolverEndpointResponse {
849 /**
850 * The response to an UpdateResolverEndpoint request.
851 */
852 ResolverEndpoint?: ResolverEndpoint;
853 }
854 export interface UpdateResolverRuleRequest {
855 /**
856 * The ID of the resolver rule that you want to update.
857 */
858 ResolverRuleId: ResourceId;
859 /**
860 * The new settings for the resolver rule.
861 */
862 Config: ResolverRuleConfig;
863 }
864 export interface UpdateResolverRuleResponse {
865 /**
866 * The response to an UpdateResolverRule request.
867 */
868 ResolverRule?: ResolverRule;
869 }
870 /**
871 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
872 */
873 export type apiVersion = "2018-04-01"|"latest"|string;
874 export interface ClientApiVersions {
875 /**
876 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
877 */
878 apiVersion?: apiVersion;
879 }
880 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
881 /**
882 * Contains interfaces for use with the Route53Resolver client.
883 */
884 export import Types = Route53Resolver;
885}
886export = Route53Resolver;