servicediscovery.d.ts
73.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class ServiceDiscovery extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ServiceDiscovery.Types.ClientConfiguration)
config: Config & ServiceDiscovery.Types.ClientConfiguration;
/**
* Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createHttpNamespace(params: ServiceDiscovery.Types.CreateHttpNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateHttpNamespaceResponse) => void): Request<ServiceDiscovery.Types.CreateHttpNamespaceResponse, AWSError>;
/**
* Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createHttpNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateHttpNamespaceResponse) => void): Request<ServiceDiscovery.Types.CreateHttpNamespaceResponse, AWSError>;
/**
* Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createPrivateDnsNamespace(params: ServiceDiscovery.Types.CreatePrivateDnsNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePrivateDnsNamespaceResponse) => void): Request<ServiceDiscovery.Types.CreatePrivateDnsNamespaceResponse, AWSError>;
/**
* Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createPrivateDnsNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePrivateDnsNamespaceResponse) => void): Request<ServiceDiscovery.Types.CreatePrivateDnsNamespaceResponse, AWSError>;
/**
* Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createPublicDnsNamespace(params: ServiceDiscovery.Types.CreatePublicDnsNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePublicDnsNamespaceResponse) => void): Request<ServiceDiscovery.Types.CreatePublicDnsNamespaceResponse, AWSError>;
/**
* Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createPublicDnsNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePublicDnsNamespaceResponse) => void): Request<ServiceDiscovery.Types.CreatePublicDnsNamespaceResponse, AWSError>;
/**
* Creates a service, which defines the configuration for the following entities: For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: A AAAA A and AAAA SRV CNAME Optionally, a health check After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities. For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createService(params: ServiceDiscovery.Types.CreateServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateServiceResponse) => void): Request<ServiceDiscovery.Types.CreateServiceResponse, AWSError>;
/**
* Creates a service, which defines the configuration for the following entities: For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: A AAAA A and AAAA SRV CNAME Optionally, a health check After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities. For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
createService(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateServiceResponse) => void): Request<ServiceDiscovery.Types.CreateServiceResponse, AWSError>;
/**
* Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
*/
deleteNamespace(params: ServiceDiscovery.Types.DeleteNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteNamespaceResponse) => void): Request<ServiceDiscovery.Types.DeleteNamespaceResponse, AWSError>;
/**
* Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
*/
deleteNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteNamespaceResponse) => void): Request<ServiceDiscovery.Types.DeleteNamespaceResponse, AWSError>;
/**
* Deletes a specified service. If the service still contains one or more registered instances, the request fails.
*/
deleteService(params: ServiceDiscovery.Types.DeleteServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteServiceResponse) => void): Request<ServiceDiscovery.Types.DeleteServiceResponse, AWSError>;
/**
* Deletes a specified service. If the service still contains one or more registered instances, the request fails.
*/
deleteService(callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteServiceResponse) => void): Request<ServiceDiscovery.Types.DeleteServiceResponse, AWSError>;
/**
* Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
*/
deregisterInstance(params: ServiceDiscovery.Types.DeregisterInstanceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DeregisterInstanceResponse) => void): Request<ServiceDiscovery.Types.DeregisterInstanceResponse, AWSError>;
/**
* Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
*/
deregisterInstance(callback?: (err: AWSError, data: ServiceDiscovery.Types.DeregisterInstanceResponse) => void): Request<ServiceDiscovery.Types.DeregisterInstanceResponse, AWSError>;
/**
* Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.
*/
discoverInstances(params: ServiceDiscovery.Types.DiscoverInstancesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DiscoverInstancesResponse) => void): Request<ServiceDiscovery.Types.DiscoverInstancesResponse, AWSError>;
/**
* Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.
*/
discoverInstances(callback?: (err: AWSError, data: ServiceDiscovery.Types.DiscoverInstancesResponse) => void): Request<ServiceDiscovery.Types.DiscoverInstancesResponse, AWSError>;
/**
* Gets information about a specified instance.
*/
getInstance(params: ServiceDiscovery.Types.GetInstanceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstanceResponse) => void): Request<ServiceDiscovery.Types.GetInstanceResponse, AWSError>;
/**
* Gets information about a specified instance.
*/
getInstance(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstanceResponse) => void): Request<ServiceDiscovery.Types.GetInstanceResponse, AWSError>;
/**
* Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service. There is a brief delay between when you register an instance and when the health status for the instance is available.
*/
getInstancesHealthStatus(params: ServiceDiscovery.Types.GetInstancesHealthStatusRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstancesHealthStatusResponse) => void): Request<ServiceDiscovery.Types.GetInstancesHealthStatusResponse, AWSError>;
/**
* Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service. There is a brief delay between when you register an instance and when the health status for the instance is available.
*/
getInstancesHealthStatus(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstancesHealthStatusResponse) => void): Request<ServiceDiscovery.Types.GetInstancesHealthStatusResponse, AWSError>;
/**
* Gets information about a namespace.
*/
getNamespace(params: ServiceDiscovery.Types.GetNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetNamespaceResponse) => void): Request<ServiceDiscovery.Types.GetNamespaceResponse, AWSError>;
/**
* Gets information about a namespace.
*/
getNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetNamespaceResponse) => void): Request<ServiceDiscovery.Types.GetNamespaceResponse, AWSError>;
/**
* Gets information about any operation that returns an operation ID in the response, such as a CreateService request. To get a list of operations that match specified criteria, see ListOperations.
*/
getOperation(params: ServiceDiscovery.Types.GetOperationRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetOperationResponse) => void): Request<ServiceDiscovery.Types.GetOperationResponse, AWSError>;
/**
* Gets information about any operation that returns an operation ID in the response, such as a CreateService request. To get a list of operations that match specified criteria, see ListOperations.
*/
getOperation(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetOperationResponse) => void): Request<ServiceDiscovery.Types.GetOperationResponse, AWSError>;
/**
* Gets the settings for a specified service.
*/
getService(params: ServiceDiscovery.Types.GetServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetServiceResponse) => void): Request<ServiceDiscovery.Types.GetServiceResponse, AWSError>;
/**
* Gets the settings for a specified service.
*/
getService(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetServiceResponse) => void): Request<ServiceDiscovery.Types.GetServiceResponse, AWSError>;
/**
* Lists summary information about the instances that you registered by using a specified service.
*/
listInstances(params: ServiceDiscovery.Types.ListInstancesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListInstancesResponse) => void): Request<ServiceDiscovery.Types.ListInstancesResponse, AWSError>;
/**
* Lists summary information about the instances that you registered by using a specified service.
*/
listInstances(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListInstancesResponse) => void): Request<ServiceDiscovery.Types.ListInstancesResponse, AWSError>;
/**
* Lists summary information about the namespaces that were created by the current AWS account.
*/
listNamespaces(params: ServiceDiscovery.Types.ListNamespacesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListNamespacesResponse) => void): Request<ServiceDiscovery.Types.ListNamespacesResponse, AWSError>;
/**
* Lists summary information about the namespaces that were created by the current AWS account.
*/
listNamespaces(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListNamespacesResponse) => void): Request<ServiceDiscovery.Types.ListNamespacesResponse, AWSError>;
/**
* Lists operations that match the criteria that you specify.
*/
listOperations(params: ServiceDiscovery.Types.ListOperationsRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListOperationsResponse) => void): Request<ServiceDiscovery.Types.ListOperationsResponse, AWSError>;
/**
* Lists operations that match the criteria that you specify.
*/
listOperations(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListOperationsResponse) => void): Request<ServiceDiscovery.Types.ListOperationsResponse, AWSError>;
/**
* Lists summary information for all the services that are associated with one or more specified namespaces.
*/
listServices(params: ServiceDiscovery.Types.ListServicesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListServicesResponse) => void): Request<ServiceDiscovery.Types.ListServicesResponse, AWSError>;
/**
* Lists summary information for all the services that are associated with one or more specified namespaces.
*/
listServices(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListServicesResponse) => void): Request<ServiceDiscovery.Types.ListServicesResponse, AWSError>;
/**
* Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs: For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace. If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration. The health check, if any, is associated with each of the new or updated records. One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID. For more information, see CreateService. When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: If the health check is healthy: returns all the records If the health check is unhealthy: returns the applicable value for the last healthy instance If you didn't specify a health check configuration: returns all the records For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
registerInstance(params: ServiceDiscovery.Types.RegisterInstanceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.RegisterInstanceResponse) => void): Request<ServiceDiscovery.Types.RegisterInstanceResponse, AWSError>;
/**
* Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs: For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace. If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration. The health check, if any, is associated with each of the new or updated records. One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID. For more information, see CreateService. When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: If the health check is healthy: returns all the records If the health check is unhealthy: returns the applicable value for the last healthy instance If you didn't specify a health check configuration: returns all the records For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
*/
registerInstance(callback?: (err: AWSError, data: ServiceDiscovery.Types.RegisterInstanceResponse) => void): Request<ServiceDiscovery.Types.RegisterInstanceResponse, AWSError>;
/**
* Submits a request to change the health status of a custom health check to healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig. For more information, see HealthCheckCustomConfig.
*/
updateInstanceCustomHealthStatus(params: ServiceDiscovery.Types.UpdateInstanceCustomHealthStatusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Submits a request to change the health status of a custom health check to healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig. For more information, see HealthCheckCustomConfig.
*/
updateInstanceCustomHealthStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Submits a request to perform the following operations: Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a specified service You can't add, update, or delete a HealthCheckCustomConfig configuration. For public and private DNS namespaces, note the following: If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service. If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration is not deleted from the service. When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
*/
updateService(params: ServiceDiscovery.Types.UpdateServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.UpdateServiceResponse) => void): Request<ServiceDiscovery.Types.UpdateServiceResponse, AWSError>;
/**
* Submits a request to perform the following operations: Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a specified service You can't add, update, or delete a HealthCheckCustomConfig configuration. For public and private DNS namespaces, note the following: If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service. If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration is not deleted from the service. When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
*/
updateService(callback?: (err: AWSError, data: ServiceDiscovery.Types.UpdateServiceResponse) => void): Request<ServiceDiscovery.Types.UpdateServiceResponse, AWSError>;
}
declare namespace ServiceDiscovery {
export type Arn = string;
export type AttrKey = string;
export type AttrValue = string;
export type Attributes = {[key: string]: AttrValue};
export type Code = string;
export interface CreateHttpNamespaceRequest {
/**
* The name that you want to assign to this namespace.
*/
Name: NamespaceName;
/**
* A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
*/
CreatorRequestId?: ResourceId;
/**
* A description for the namespace.
*/
Description?: ResourceDescription;
}
export interface CreateHttpNamespaceResponse {
/**
* A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
*/
OperationId?: OperationId;
}
export interface CreatePrivateDnsNamespaceRequest {
/**
* The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
*/
Name: NamespaceName;
/**
* A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
*/
CreatorRequestId?: ResourceId;
/**
* A description for the namespace.
*/
Description?: ResourceDescription;
/**
* The ID of the Amazon VPC that you want to associate the namespace with.
*/
Vpc: ResourceId;
}
export interface CreatePrivateDnsNamespaceResponse {
/**
* A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
*/
OperationId?: OperationId;
}
export interface CreatePublicDnsNamespaceRequest {
/**
* The name that you want to assign to this namespace.
*/
Name: NamespaceName;
/**
* A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
*/
CreatorRequestId?: ResourceId;
/**
* A description for the namespace.
*/
Description?: ResourceDescription;
}
export interface CreatePublicDnsNamespaceResponse {
/**
* A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
*/
OperationId?: OperationId;
}
export interface CreateServiceRequest {
/**
* The name that you want to assign to the service. If you want AWS Cloud Map to create an SRV record when you register an instance, and if you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name: Start the name with an underscore (_), such as _exampleservice End the name with ._protocol, such as ._tcp When you register an instance, AWS Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name, for example: _exampleservice._tcp.example.com
*/
Name: ServiceName;
/**
* The ID of the namespace that you want to use to create the service.
*/
NamespaceId?: ResourceId;
/**
* A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
*/
CreatorRequestId?: ResourceId;
/**
* A description for the service.
*/
Description?: ResourceDescription;
/**
* A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.
*/
DnsConfig?: DnsConfig;
/**
* Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig. If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. For information about the charges for health checks, see AWS Cloud Map Pricing.
*/
HealthCheckConfig?: HealthCheckConfig;
/**
* A complex type that contains information about an optional custom health check. If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.
*/
HealthCheckCustomConfig?: HealthCheckCustomConfig;
}
export interface CreateServiceResponse {
/**
* A complex type that contains information about the new service.
*/
Service?: Service;
}
export type CustomHealthStatus = "HEALTHY"|"UNHEALTHY"|string;
export interface DeleteNamespaceRequest {
/**
* The ID of the namespace that you want to delete.
*/
Id: ResourceId;
}
export interface DeleteNamespaceResponse {
/**
* A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
*/
OperationId?: OperationId;
}
export interface DeleteServiceRequest {
/**
* The ID of the service that you want to delete.
*/
Id: ResourceId;
}
export interface DeleteServiceResponse {
}
export interface DeregisterInstanceRequest {
/**
* The ID of the service that the instance is associated with.
*/
ServiceId: ResourceId;
/**
* The value that you specified for Id in the RegisterInstance request.
*/
InstanceId: ResourceId;
}
export interface DeregisterInstanceResponse {
/**
* A value that you can use to determine whether the request completed successfully. For more information, see GetOperation.
*/
OperationId?: OperationId;
}
export interface DiscoverInstancesRequest {
/**
* The name of the namespace that you specified when you registered the instance.
*/
NamespaceName: NamespaceName;
/**
* The name of the service that you specified when you registered the instance.
*/
ServiceName: ServiceName;
/**
* The maximum number of instances that you want AWS Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.
*/
MaxResults?: MaxResults;
/**
* A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.
*/
QueryParameters?: Attributes;
/**
* The health status of the instances that you want to discover.
*/
HealthStatus?: HealthStatusFilter;
}
export interface DiscoverInstancesResponse {
/**
* A complex type that contains one HttpInstanceSummary for each registered instance.
*/
Instances?: HttpInstanceSummaryList;
}
export interface DnsConfig {
/**
* The ID of the namespace to use for DNS configuration.
*/
NamespaceId?: ResourceId;
/**
* The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service. If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy. You can specify the following values: MULTIVALUE If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances. For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances. If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances. For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide. WEIGHTED Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances. For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy. If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance. For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
*/
RoutingPolicy?: RoutingPolicy;
/**
* An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.
*/
DnsRecords: DnsRecordList;
}
export interface DnsConfigChange {
/**
* An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to create when you register an instance.
*/
DnsRecords: DnsRecordList;
}
export interface DnsProperties {
/**
* The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
*/
HostedZoneId?: ResourceId;
}
export interface DnsRecord {
/**
* The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations: A AAAA A and AAAA SRV CNAME If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type. You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance. The following values are supported: A Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44. AAAA Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345. CNAME Route 53 returns the domain name of the resource, such as www.example.com. Note the following: You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance. You must specify WEIGHTED for the value of RoutingPolicy. You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error. SRV Route 53 returns the value for an SRV record. The value for an SRV record uses the following values: priority weight port service-hostname Note the following about the values: The values of priority and weight are both set to 1 and can't be changed. The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request. The value of service-hostname is a concatenation of the following values: The value that you specify for InstanceId when you register an instance. The name of the service. The name of the namespace. For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is: test.backend.example.com If you specify settings for an SRV record, note the following: If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records. If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.
*/
Type: RecordType;
/**
* The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record. Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
*/
TTL: RecordTTL;
}
export type DnsRecordList = DnsRecord[];
export type FailureThreshold = number;
export type FilterCondition = "EQ"|"IN"|"BETWEEN"|string;
export type FilterValue = string;
export type FilterValues = FilterValue[];
export interface GetInstanceRequest {
/**
* The ID of the service that the instance is associated with.
*/
ServiceId: ResourceId;
/**
* The ID of the instance that you want to get information about.
*/
InstanceId: ResourceId;
}
export interface GetInstanceResponse {
/**
* A complex type that contains information about a specified instance.
*/
Instance?: Instance;
}
export interface GetInstancesHealthStatusRequest {
/**
* The ID of the service that the instance is associated with.
*/
ServiceId: ResourceId;
/**
* An array that contains the IDs of all the instances that you want to get the health status for. If you omit Instances, AWS Cloud Map returns the health status for all the instances that are associated with the specified service. To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
*/
Instances?: InstanceIdList;
/**
* The maximum number of instances that you want AWS Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.
*/
MaxResults?: MaxResults;
/**
* For the first GetInstancesHealthStatus request, omit this value. If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
*/
NextToken?: NextToken;
}
export interface GetInstancesHealthStatusResponse {
/**
* A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.
*/
Status?: InstanceHealthStatusMap;
/**
* If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
*/
NextToken?: NextToken;
}
export interface GetNamespaceRequest {
/**
* The ID of the namespace that you want to get information about.
*/
Id: ResourceId;
}
export interface GetNamespaceResponse {
/**
* A complex type that contains information about the specified namespace.
*/
Namespace?: Namespace;
}
export interface GetOperationRequest {
/**
* The ID of the operation that you want to get more information about.
*/
OperationId: ResourceId;
}
export interface GetOperationResponse {
/**
* A complex type that contains information about the operation.
*/
Operation?: Operation;
}
export interface GetServiceRequest {
/**
* The ID of the service that you want to get settings for.
*/
Id: ResourceId;
}
export interface GetServiceResponse {
/**
* A complex type that contains information about the service.
*/
Service?: Service;
}
export interface HealthCheckConfig {
/**
* The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. You can't change the value of Type after you create a health check. You can create the following types of health checks: HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later. TCP: Route 53 tries to establish a TCP connection. If you specify TCP for Type, don't specify a value for ResourcePath. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
*/
Type: HealthCheckType;
/**
* The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /. If you specify TCP for Type, you must not specify a value for ResourcePath.
*/
ResourcePath?: ResourcePath;
/**
* The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
*/
FailureThreshold?: FailureThreshold;
}
export interface HealthCheckCustomConfig {
/**
* The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. AWS Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request. Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.
*/
FailureThreshold?: FailureThreshold;
}
export type HealthCheckType = "HTTP"|"HTTPS"|"TCP"|string;
export type HealthStatus = "HEALTHY"|"UNHEALTHY"|"UNKNOWN"|string;
export type HealthStatusFilter = "HEALTHY"|"UNHEALTHY"|"ALL"|string;
export interface HttpInstanceSummary {
/**
* The ID of an instance that matches the values that you specified in the request.
*/
InstanceId?: ResourceId;
/**
* The name of the namespace that you specified when you registered the instance.
*/
NamespaceName?: NamespaceName;
/**
* The name of the service that you specified when you registered the instance.
*/
ServiceName?: ServiceName;
/**
* If you configured health checking in the service, the current health status of the service instance.
*/
HealthStatus?: HealthStatus;
/**
* If you included any attributes when you registered the instance, the values of those attributes.
*/
Attributes?: Attributes;
}
export type HttpInstanceSummaryList = HttpInstanceSummary[];
export interface HttpProperties {
/**
* The name of an HTTP namespace.
*/
HttpName?: NamespaceName;
}
export interface Instance {
/**
* An identifier that you want to associate with the instance. Note the following: If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord > Type. You can use this value to update an existing instance. To register a new instance, you must specify a value that is unique among instances that you register by using the same service. If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one. The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
*/
Id: ResourceId;
/**
* A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.
*/
CreatorRequestId?: ResourceId;
/**
* A string map that contains the following information for the service that you specify in ServiceId: The attributes that apply to the records that are defined in the service. For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget. Note the following: The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both. In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED. If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record. Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes. AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want Route 53 to return for the port. If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to. This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.
*/
Attributes?: Attributes;
}
export type InstanceHealthStatusMap = {[key: string]: HealthStatus};
export type InstanceIdList = ResourceId[];
export interface InstanceSummary {
/**
* The ID for an instance that you created by using a specified service.
*/
Id?: ResourceId;
/**
* A string map that contains the following information: The attributes that are associate with the instance. For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer. AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example, example.com. AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example, 192.0.2.44. AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*/
Attributes?: Attributes;
}
export type InstanceSummaryList = InstanceSummary[];
export interface ListInstancesRequest {
/**
* The ID of the service that you want to list instances for.
*/
ServiceId: ResourceId;
/**
* For the first ListInstances request, omit this value. If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
*/
NextToken?: NextToken;
/**
* The maximum number of instances that you want AWS Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.
*/
MaxResults?: MaxResults;
}
export interface ListInstancesResponse {
/**
* Summary information about the instances that are associated with the specified service.
*/
Instances?: InstanceSummaryList;
/**
* If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
*/
NextToken?: NextToken;
}
export interface ListNamespacesRequest {
/**
* For the first ListNamespaces request, omit this value. If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
*/
NextToken?: NextToken;
/**
* The maximum number of namespaces that you want AWS Cloud Map to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 namespaces.
*/
MaxResults?: MaxResults;
/**
* A complex type that contains specifications for the namespaces that you want to list. If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.
*/
Filters?: NamespaceFilters;
}
export interface ListNamespacesResponse {
/**
* An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.
*/
Namespaces?: NamespaceSummariesList;
/**
* If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
*/
NextToken?: NextToken;
}
export interface ListOperationsRequest {
/**
* For the first ListOperations request, omit this value. If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.
*/
NextToken?: NextToken;
/**
* The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations.
*/
MaxResults?: MaxResults;
/**
* A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date. If you specify more than one filter, an operation must match all filters to be returned by ListOperations.
*/
Filters?: OperationFilters;
}
export interface ListOperationsResponse {
/**
* Summary information about the operations that match the specified criteria.
*/
Operations?: OperationSummaryList;
/**
* If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.
*/
NextToken?: NextToken;
}
export interface ListServicesRequest {
/**
* For the first ListServices request, omit this value. If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.
*/
NextToken?: NextToken;
/**
* The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.
*/
MaxResults?: MaxResults;
/**
* A complex type that contains specifications for the namespaces that you want to list services for. If you specify more than one filter, an operation must match all filters to be returned by ListServices.
*/
Filters?: ServiceFilters;
}
export interface ListServicesResponse {
/**
* An array that contains one ServiceSummary object for each service that matches the specified filter criteria.
*/
Services?: ServiceSummariesList;
/**
* If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.
*/
NextToken?: NextToken;
}
export type MaxResults = number;
export type Message = string;
export interface Namespace {
/**
* The ID of a namespace.
*/
Id?: ResourceId;
/**
* The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
*/
Arn?: Arn;
/**
* The name of the namespace, such as example.com.
*/
Name?: NamespaceName;
/**
* The type of the namespace. The methods for discovering instances depends on the value that you specify: HTTP: Instances can be discovered only programmatically, using the AWS Cloud Map DiscoverInstances API. DNS_PUBLIC: Instances can be discovered using public DNS queries and using the DiscoverInstances API. DNS_PRIVATE: Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.
*/
Type?: NamespaceType;
/**
* The description that you specify for the namespace when you create it.
*/
Description?: ResourceDescription;
/**
* The number of services that are associated with the namespace.
*/
ServiceCount?: ResourceCount;
/**
* A complex type that contains information that's specific to the type of the namespace.
*/
Properties?: NamespaceProperties;
/**
* The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreateDate?: Timestamp;
/**
* A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.
*/
CreatorRequestId?: ResourceId;
}
export interface NamespaceFilter {
/**
* Specify TYPE.
*/
Name: NamespaceFilterName;
/**
* If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE. If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, or both.
*/
Values: FilterValues;
/**
* The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include: EQ: When you specify EQ for the condition, you can choose to list only public namespaces or private namespaces, but not both. EQ is the default condition and can be omitted. IN: When you specify IN for the condition, you can choose to list public namespaces, private namespaces, or both. BETWEEN: Not applicable
*/
Condition?: FilterCondition;
}
export type NamespaceFilterName = "TYPE"|string;
export type NamespaceFilters = NamespaceFilter[];
export type NamespaceName = string;
export interface NamespaceProperties {
/**
* A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
*/
DnsProperties?: DnsProperties;
/**
* A complex type that contains the name of an HTTP namespace.
*/
HttpProperties?: HttpProperties;
}
export type NamespaceSummariesList = NamespaceSummary[];
export interface NamespaceSummary {
/**
* The ID of the namespace.
*/
Id?: ResourceId;
/**
* The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
*/
Arn?: Arn;
/**
* The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.
*/
Name?: NamespaceName;
/**
* The type of the namespace, either public or private.
*/
Type?: NamespaceType;
/**
* A description for the namespace.
*/
Description?: ResourceDescription;
/**
* The number of services that were created using the namespace.
*/
ServiceCount?: ResourceCount;
Properties?: NamespaceProperties;
/**
* The date and time that the namespace was created.
*/
CreateDate?: Timestamp;
}
export type NamespaceType = "DNS_PUBLIC"|"DNS_PRIVATE"|"HTTP"|string;
export type NextToken = string;
export interface Operation {
/**
* The ID of the operation that you want to get information about.
*/
Id?: OperationId;
/**
* The name of the operation that is associated with the specified ID.
*/
Type?: OperationType;
/**
* The status of the operation. Values include the following: SUBMITTED: This is the initial state immediately after you submit a request. PENDING: AWS Cloud Map is performing the operation. SUCCESS: The operation succeeded. FAIL: The operation failed. For the failure reason, see ErrorMessage.
*/
Status?: OperationStatus;
/**
* If the value of Status is FAIL, the reason that the operation failed.
*/
ErrorMessage?: Message;
/**
* The code associated with ErrorMessage. Values for ErrorCode include the following: ACCESS_DENIED CANNOT_CREATE_HOSTED_ZONE EXPIRED_TOKEN HOSTED_ZONE_NOT_FOUND INTERNAL_FAILURE INVALID_CHANGE_BATCH THROTTLED_REQUEST
*/
ErrorCode?: Code;
/**
* The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreateDate?: Timestamp;
/**
* The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
UpdateDate?: Timestamp;
/**
* The name of the target entity that is associated with the operation: NAMESPACE: The namespace ID is returned in the ResourceId property. SERVICE: The service ID is returned in the ResourceId property. INSTANCE: The instance ID is returned in the ResourceId property.
*/
Targets?: OperationTargetsMap;
}
export interface OperationFilter {
/**
* Specify the operations that you want to get: NAMESPACE_ID: Gets operations related to specified namespaces. SERVICE_ID: Gets operations related to specified services. STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL. TYPE: Gets specified types of operation. UPDATE_DATE: Gets operations that changed status during a specified date/time range.
*/
Name: OperationFilterName;
/**
* Specify values that are applicable to the value that you specify for Name: NAMESPACE_ID: Specify one namespace ID. SERVICE_ID: Specify one service ID. STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL. TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE. UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
*/
Values: FilterValues;
/**
* The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include: EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted. IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response. BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.
*/
Condition?: FilterCondition;
}
export type OperationFilterName = "NAMESPACE_ID"|"SERVICE_ID"|"STATUS"|"TYPE"|"UPDATE_DATE"|string;
export type OperationFilters = OperationFilter[];
export type OperationId = string;
export type OperationStatus = "SUBMITTED"|"PENDING"|"SUCCESS"|"FAIL"|string;
export interface OperationSummary {
/**
* The ID for an operation.
*/
Id?: OperationId;
/**
* The status of the operation. Values include the following: SUBMITTED: This is the initial state immediately after you submit a request. PENDING: AWS Cloud Map is performing the operation. SUCCESS: The operation succeeded. FAIL: The operation failed. For the failure reason, see ErrorMessage.
*/
Status?: OperationStatus;
}
export type OperationSummaryList = OperationSummary[];
export type OperationTargetType = "NAMESPACE"|"SERVICE"|"INSTANCE"|string;
export type OperationTargetsMap = {[key: string]: ResourceId};
export type OperationType = "CREATE_NAMESPACE"|"DELETE_NAMESPACE"|"UPDATE_SERVICE"|"REGISTER_INSTANCE"|"DEREGISTER_INSTANCE"|string;
export type RecordTTL = number;
export type RecordType = "SRV"|"A"|"AAAA"|"CNAME"|string;
export interface RegisterInstanceRequest {
/**
* The ID of the service that you want to use for settings for the instance.
*/
ServiceId: ResourceId;
/**
* An identifier that you want to associate with the instance. Note the following: If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord > Type. You can use this value to update an existing instance. To register a new instance, you must specify a value that is unique among instances that you register by using the same service. If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one. The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
*/
InstanceId: ResourceId;
/**
* A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.
*/
CreatorRequestId?: ResourceId;
/**
* A string map that contains the following information for the service that you specify in ServiceId: The attributes that apply to the records that are defined in the service. For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference. Note the following: The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both. In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED. If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the Route 53 health check, but it won't associate the health check with the alias record. Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes. AWS_INIT_HEALTH_STATUS If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY. AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want Route 53 to return for the port. If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to. This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service. Custom attributes You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters.
*/
Attributes: Attributes;
}
export interface RegisterInstanceResponse {
/**
* A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
*/
OperationId?: OperationId;
}
export type ResourceCount = number;
export type ResourceDescription = string;
export type ResourceId = string;
export type ResourcePath = string;
export type RoutingPolicy = "MULTIVALUE"|"WEIGHTED"|string;
export interface Service {
/**
* The ID that AWS Cloud Map assigned to the service when you created it.
*/
Id?: ResourceId;
/**
* The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
*/
Arn?: Arn;
/**
* The name of the service.
*/
Name?: ServiceName;
/**
* The ID of the namespace that was used to create the service.
*/
NamespaceId?: ResourceId;
/**
* The description of the service.
*/
Description?: ResourceDescription;
/**
* The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
*/
InstanceCount?: ResourceCount;
/**
* A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
*/
DnsConfig?: DnsConfig;
/**
* Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. For information about the charges for health checks, see Amazon Route 53 Pricing.
*/
HealthCheckConfig?: HealthCheckConfig;
/**
* A complex type that contains information about an optional custom health check. If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
*/
HealthCheckCustomConfig?: HealthCheckCustomConfig;
/**
* The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreateDate?: Timestamp;
/**
* 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.
*/
CreatorRequestId?: ResourceId;
}
export interface ServiceChange {
/**
* A description for the service.
*/
Description?: ResourceDescription;
/**
* A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
*/
DnsConfig: DnsConfigChange;
HealthCheckConfig?: HealthCheckConfig;
}
export interface ServiceFilter {
/**
* Specify NAMESPACE_ID.
*/
Name: ServiceFilterName;
/**
* The values that are applicable to the value that you specify for Condition to filter the list of services.
*/
Values: FilterValues;
/**
* The operator that you want to use to determine whether a service is returned by ListServices. Valid values for Condition include the following: EQ: When you specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted. IN: When you specify IN, specify a list of the IDs for the namespaces that you want ListServices to return a list of services for. BETWEEN: Not applicable.
*/
Condition?: FilterCondition;
}
export type ServiceFilterName = "NAMESPACE_ID"|string;
export type ServiceFilters = ServiceFilter[];
export type ServiceName = string;
export type ServiceSummariesList = ServiceSummary[];
export interface ServiceSummary {
/**
* The ID that AWS Cloud Map assigned to the service when you created it.
*/
Id?: ResourceId;
/**
* The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
*/
Arn?: Arn;
/**
* The name of the service.
*/
Name?: ServiceName;
/**
* The description that you specify when you create the service.
*/
Description?: ResourceDescription;
/**
* The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
*/
InstanceCount?: ResourceCount;
DnsConfig?: DnsConfig;
HealthCheckConfig?: HealthCheckConfig;
HealthCheckCustomConfig?: HealthCheckCustomConfig;
/**
* The date and time that the service was created.
*/
CreateDate?: Timestamp;
}
export type Timestamp = Date;
export interface UpdateInstanceCustomHealthStatusRequest {
/**
* The ID of the service that includes the configuration for the custom health check that you want to change the status for.
*/
ServiceId: ResourceId;
/**
* The ID of the instance that you want to change the health status for.
*/
InstanceId: ResourceId;
/**
* The new status of the instance, HEALTHY or UNHEALTHY.
*/
Status: CustomHealthStatus;
}
export interface UpdateServiceRequest {
/**
* The ID of the service that you want to update.
*/
Id: ResourceId;
/**
* A complex type that contains the new settings for the service.
*/
Service: ServiceChange;
}
export interface UpdateServiceResponse {
/**
* A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
*/
OperationId?: OperationId;
}
/**
* 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.
*/
export type apiVersion = "2017-03-14"|"latest"|string;
export interface ClientApiVersions {
/**
* 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.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ServiceDiscovery client.
*/
export import Types = ServiceDiscovery;
}
export = ServiceDiscovery;