aws-sdk-servicediscovery 1.18.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -6,6 +6,39 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::ServiceDiscovery
|
9
|
+
|
10
|
+
# When ServiceDiscovery returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::ServiceDiscovery::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all ServiceDiscovery errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::ServiceDiscovery::Errors::ServiceError
|
18
|
+
# # rescues all ServiceDiscovery API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {CustomHealthNotFound}
|
29
|
+
# * {DuplicateRequest}
|
30
|
+
# * {InstanceNotFound}
|
31
|
+
# * {InvalidInput}
|
32
|
+
# * {NamespaceAlreadyExists}
|
33
|
+
# * {NamespaceNotFound}
|
34
|
+
# * {OperationNotFound}
|
35
|
+
# * {ResourceInUse}
|
36
|
+
# * {ResourceLimitExceeded}
|
37
|
+
# * {ServiceAlreadyExists}
|
38
|
+
# * {ServiceNotFound}
|
39
|
+
#
|
40
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
41
|
+
# if they are not defined above.
|
9
42
|
module Errors
|
10
43
|
|
11
44
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +56,6 @@ module Aws::ServiceDiscovery
|
|
23
56
|
def message
|
24
57
|
@message || @data[:message]
|
25
58
|
end
|
26
|
-
|
27
59
|
end
|
28
60
|
|
29
61
|
class DuplicateRequest < ServiceError
|
@@ -44,7 +76,6 @@ module Aws::ServiceDiscovery
|
|
44
76
|
def duplicate_operation_id
|
45
77
|
@data[:duplicate_operation_id]
|
46
78
|
end
|
47
|
-
|
48
79
|
end
|
49
80
|
|
50
81
|
class InstanceNotFound < ServiceError
|
@@ -60,7 +91,6 @@ module Aws::ServiceDiscovery
|
|
60
91
|
def message
|
61
92
|
@message || @data[:message]
|
62
93
|
end
|
63
|
-
|
64
94
|
end
|
65
95
|
|
66
96
|
class InvalidInput < ServiceError
|
@@ -76,7 +106,6 @@ module Aws::ServiceDiscovery
|
|
76
106
|
def message
|
77
107
|
@message || @data[:message]
|
78
108
|
end
|
79
|
-
|
80
109
|
end
|
81
110
|
|
82
111
|
class NamespaceAlreadyExists < ServiceError
|
@@ -102,7 +131,6 @@ module Aws::ServiceDiscovery
|
|
102
131
|
def namespace_id
|
103
132
|
@data[:namespace_id]
|
104
133
|
end
|
105
|
-
|
106
134
|
end
|
107
135
|
|
108
136
|
class NamespaceNotFound < ServiceError
|
@@ -118,7 +146,6 @@ module Aws::ServiceDiscovery
|
|
118
146
|
def message
|
119
147
|
@message || @data[:message]
|
120
148
|
end
|
121
|
-
|
122
149
|
end
|
123
150
|
|
124
151
|
class OperationNotFound < ServiceError
|
@@ -134,7 +161,6 @@ module Aws::ServiceDiscovery
|
|
134
161
|
def message
|
135
162
|
@message || @data[:message]
|
136
163
|
end
|
137
|
-
|
138
164
|
end
|
139
165
|
|
140
166
|
class ResourceInUse < ServiceError
|
@@ -150,7 +176,6 @@ module Aws::ServiceDiscovery
|
|
150
176
|
def message
|
151
177
|
@message || @data[:message]
|
152
178
|
end
|
153
|
-
|
154
179
|
end
|
155
180
|
|
156
181
|
class ResourceLimitExceeded < ServiceError
|
@@ -166,7 +191,6 @@ module Aws::ServiceDiscovery
|
|
166
191
|
def message
|
167
192
|
@message || @data[:message]
|
168
193
|
end
|
169
|
-
|
170
194
|
end
|
171
195
|
|
172
196
|
class ServiceAlreadyExists < ServiceError
|
@@ -192,7 +216,6 @@ module Aws::ServiceDiscovery
|
|
192
216
|
def service_id
|
193
217
|
@data[:service_id]
|
194
218
|
end
|
195
|
-
|
196
219
|
end
|
197
220
|
|
198
221
|
class ServiceNotFound < ServiceError
|
@@ -208,7 +231,6 @@ module Aws::ServiceDiscovery
|
|
208
231
|
def message
|
209
232
|
@message || @data[:message]
|
210
233
|
end
|
211
|
-
|
212
234
|
end
|
213
235
|
|
214
236
|
end
|
@@ -46,7 +46,12 @@ module Aws::ServiceDiscovery
|
|
46
46
|
|
47
47
|
# @!attribute [rw] operation_id
|
48
48
|
# A value that you can use to determine whether the request completed
|
49
|
-
# successfully. To get the status of the operation, see
|
49
|
+
# successfully. To get the status of the operation, see
|
50
|
+
# [GetOperation][1].
|
51
|
+
#
|
52
|
+
#
|
53
|
+
#
|
54
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
50
55
|
# @return [String]
|
51
56
|
#
|
52
57
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespaceResponse AWS API Documentation
|
@@ -104,7 +109,12 @@ module Aws::ServiceDiscovery
|
|
104
109
|
|
105
110
|
# @!attribute [rw] operation_id
|
106
111
|
# A value that you can use to determine whether the request completed
|
107
|
-
# successfully. To get the status of the operation, see
|
112
|
+
# successfully. To get the status of the operation, see
|
113
|
+
# [GetOperation][1].
|
114
|
+
#
|
115
|
+
#
|
116
|
+
#
|
117
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
108
118
|
# @return [String]
|
109
119
|
#
|
110
120
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespaceResponse AWS API Documentation
|
@@ -152,7 +162,12 @@ module Aws::ServiceDiscovery
|
|
152
162
|
|
153
163
|
# @!attribute [rw] operation_id
|
154
164
|
# A value that you can use to determine whether the request completed
|
155
|
-
# successfully. To get the status of the operation, see
|
165
|
+
# successfully. To get the status of the operation, see
|
166
|
+
# [GetOperation][1].
|
167
|
+
#
|
168
|
+
#
|
169
|
+
#
|
170
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
156
171
|
# @return [String]
|
157
172
|
#
|
158
173
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespaceResponse AWS API Documentation
|
@@ -192,6 +207,24 @@ module Aws::ServiceDiscovery
|
|
192
207
|
#
|
193
208
|
# @!attribute [rw] name
|
194
209
|
# The name that you want to assign to the service.
|
210
|
+
#
|
211
|
+
# If you want AWS Cloud Map to create an SRV record when you register
|
212
|
+
# an instance, and if you're using a system that requires a specific
|
213
|
+
# SRV format, such as [HAProxy][1], specify the following for `Name`\:
|
214
|
+
#
|
215
|
+
# * Start the name with an underscore (\_), such as `_exampleservice`
|
216
|
+
#
|
217
|
+
# * End the name with *.\_protocol*, such as `._tcp`
|
218
|
+
#
|
219
|
+
# When you register an instance, AWS Cloud Map creates an SRV record
|
220
|
+
# and assigns a name to the record by concatenating the service name
|
221
|
+
# and the namespace name, for example:
|
222
|
+
#
|
223
|
+
# `_exampleservice._tcp.example.com`
|
224
|
+
#
|
225
|
+
#
|
226
|
+
#
|
227
|
+
# [1]: http://www.haproxy.org/
|
195
228
|
# @return [String]
|
196
229
|
#
|
197
230
|
# @!attribute [rw] namespace_id
|
@@ -219,10 +252,11 @@ module Aws::ServiceDiscovery
|
|
219
252
|
# @return [Types::DnsConfig]
|
220
253
|
#
|
221
254
|
# @!attribute [rw] health_check_config
|
222
|
-
# *Public DNS namespaces only.* A complex type that contains
|
223
|
-
# for an optional Route 53 health check. If you specify
|
224
|
-
# health check, AWS Cloud Map associates the health
|
225
|
-
# Route 53 DNS records that you specify in
|
255
|
+
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
256
|
+
# settings for an optional Route 53 health check. If you specify
|
257
|
+
# settings for a health check, AWS Cloud Map associates the health
|
258
|
+
# check with all the Route 53 DNS records that you specify in
|
259
|
+
# `DnsConfig`.
|
226
260
|
#
|
227
261
|
# If you specify a health check configuration, you can specify either
|
228
262
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -241,6 +275,9 @@ module Aws::ServiceDiscovery
|
|
241
275
|
#
|
242
276
|
# If you specify a health check configuration, you can specify either
|
243
277
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
278
|
+
#
|
279
|
+
# You can't add, update, or delete a `HealthCheckCustomConfig`
|
280
|
+
# configuration from an existing service.
|
244
281
|
# @return [Types::HealthCheckCustomConfig]
|
245
282
|
#
|
246
283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateServiceRequest AWS API Documentation
|
@@ -300,7 +337,12 @@ module Aws::ServiceDiscovery
|
|
300
337
|
|
301
338
|
# @!attribute [rw] operation_id
|
302
339
|
# A value that you can use to determine whether the request completed
|
303
|
-
# successfully. To get the status of the operation, see
|
340
|
+
# successfully. To get the status of the operation, see
|
341
|
+
# [GetOperation][1].
|
342
|
+
#
|
343
|
+
#
|
344
|
+
#
|
345
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
304
346
|
# @return [String]
|
305
347
|
#
|
306
348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespaceResponse AWS API Documentation
|
@@ -345,8 +387,12 @@ module Aws::ServiceDiscovery
|
|
345
387
|
# @return [String]
|
346
388
|
#
|
347
389
|
# @!attribute [rw] instance_id
|
348
|
-
# The value that you specified for `Id` in the RegisterInstance
|
390
|
+
# The value that you specified for `Id` in the [RegisterInstance][1]
|
349
391
|
# request.
|
392
|
+
#
|
393
|
+
#
|
394
|
+
#
|
395
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
350
396
|
# @return [String]
|
351
397
|
#
|
352
398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstanceRequest AWS API Documentation
|
@@ -359,7 +405,11 @@ module Aws::ServiceDiscovery
|
|
359
405
|
|
360
406
|
# @!attribute [rw] operation_id
|
361
407
|
# A value that you can use to determine whether the request completed
|
362
|
-
# successfully. For more information, see GetOperation.
|
408
|
+
# successfully. For more information, see [GetOperation][1].
|
409
|
+
#
|
410
|
+
#
|
411
|
+
#
|
412
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
363
413
|
# @return [String]
|
364
414
|
#
|
365
415
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstanceResponse AWS API Documentation
|
@@ -393,9 +443,10 @@ module Aws::ServiceDiscovery
|
|
393
443
|
# @return [String]
|
394
444
|
#
|
395
445
|
# @!attribute [rw] max_results
|
396
|
-
# The maximum number of instances that you want Cloud Map to
|
397
|
-
# the response to a `DiscoverInstances` request. If you
|
398
|
-
# a value for `MaxResults`, Cloud Map returns up to
|
446
|
+
# The maximum number of instances that you want AWS Cloud Map to
|
447
|
+
# return in the response to a `DiscoverInstances` request. If you
|
448
|
+
# don't specify a value for `MaxResults`, AWS Cloud Map returns up to
|
449
|
+
# 100 instances.
|
399
450
|
# @return [Integer]
|
400
451
|
#
|
401
452
|
# @!attribute [rw] query_parameters
|
@@ -509,8 +560,8 @@ module Aws::ServiceDiscovery
|
|
509
560
|
#
|
510
561
|
#
|
511
562
|
#
|
512
|
-
# [1]:
|
513
|
-
# [2]:
|
563
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue
|
564
|
+
# [2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted
|
514
565
|
# @return [String]
|
515
566
|
#
|
516
567
|
# @!attribute [rw] dns_records
|
@@ -585,25 +636,25 @@ module Aws::ServiceDiscovery
|
|
585
636
|
#
|
586
637
|
# @!attribute [rw] type
|
587
638
|
# The type of the resource, which indicates the type of value that
|
588
|
-
# Route 53 returns in response to DNS queries.
|
639
|
+
# Route 53 returns in response to DNS queries. You can specify values
|
640
|
+
# for `Type` in the following combinations:
|
589
641
|
#
|
590
|
-
#
|
642
|
+
# * A
|
643
|
+
#
|
644
|
+
# * AAAA
|
591
645
|
#
|
592
|
-
# *
|
593
|
-
# maximum of one A, one AAAA, and one SRV record. You can specify
|
594
|
-
# them in any combination.
|
646
|
+
# * A and AAAA
|
595
647
|
#
|
596
|
-
# *
|
597
|
-
# define any other records. This is a limitation of DNS: you can't
|
598
|
-
# create a CNAME record and any other type of record that has the
|
599
|
-
# same name as a CNAME record.
|
648
|
+
# * SRV
|
600
649
|
#
|
601
|
-
# *
|
602
|
-
# alias record when you register an instance, specify `A` or `AAAA`
|
603
|
-
# for `Type`.
|
650
|
+
# * CNAME
|
604
651
|
#
|
605
|
-
#
|
606
|
-
#
|
652
|
+
# If you want AWS Cloud Map to create a Route 53 alias record when you
|
653
|
+
# register an instance, specify `A` or `AAAA` for `Type`.
|
654
|
+
#
|
655
|
+
# You specify other settings, such as the IP address for A and AAAA
|
656
|
+
# records, when you register an instance. For more information, see
|
657
|
+
# [RegisterInstance][1].
|
607
658
|
#
|
608
659
|
# The following values are supported:
|
609
660
|
#
|
@@ -624,7 +675,7 @@ module Aws::ServiceDiscovery
|
|
624
675
|
#
|
625
676
|
# * You specify the domain name that you want to route traffic to when
|
626
677
|
# you register an instance. For more information, see
|
627
|
-
#
|
678
|
+
# [Attributes][2] in the topic [RegisterInstance][1].
|
628
679
|
#
|
629
680
|
# * You must specify `WEIGHTED` for the value of `RoutingPolicy`.
|
630
681
|
#
|
@@ -645,8 +696,8 @@ module Aws::ServiceDiscovery
|
|
645
696
|
# can't be changed.
|
646
697
|
#
|
647
698
|
# * The value of `port` comes from the value that you specify for the
|
648
|
-
# `AWS_INSTANCE_PORT` attribute when you submit a
|
649
|
-
# request.
|
699
|
+
# `AWS_INSTANCE_PORT` attribute when you submit a
|
700
|
+
# [RegisterInstance][1] request.
|
650
701
|
#
|
651
702
|
# * The value of `service-hostname` is a concatenation of the
|
652
703
|
# following values:
|
@@ -664,11 +715,24 @@ module Aws::ServiceDiscovery
|
|
664
715
|
#
|
665
716
|
# `test.backend.example.com`
|
666
717
|
#
|
667
|
-
# If you specify settings for an SRV record
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
718
|
+
# If you specify settings for an SRV record, note the following:
|
719
|
+
#
|
720
|
+
# * If you specify values for `AWS_INSTANCE_IPV4`,
|
721
|
+
# `AWS_INSTANCE_IPV6`, or both in the `RegisterInstance` request,
|
722
|
+
# AWS Cloud Map automatically creates `A` and/or `AAAA` records that
|
723
|
+
# have the same name as the value of `service-hostname` in the SRV
|
724
|
+
# record. You can ignore these records.
|
725
|
+
#
|
726
|
+
# * If you're using a system that requires a specific SRV format,
|
727
|
+
# such as HAProxy, see the [Name][3] element in the documentation
|
728
|
+
# about `CreateService` for information about how to specify the
|
729
|
+
# correct name format.
|
730
|
+
#
|
731
|
+
#
|
732
|
+
#
|
733
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
734
|
+
# [2]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes
|
735
|
+
# [3]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name
|
672
736
|
# @return [String]
|
673
737
|
#
|
674
738
|
# @!attribute [rw] ttl
|
@@ -678,11 +742,15 @@ module Aws::ServiceDiscovery
|
|
678
742
|
# <note markdown="1"> Alias records don't include a TTL because Route 53 uses the TTL for
|
679
743
|
# the AWS resource that an alias record routes traffic to. If you
|
680
744
|
# include the `AWS_ALIAS_DNS_NAME` attribute when you submit a
|
681
|
-
# RegisterInstance request, the `TTL` value is ignored. Always
|
682
|
-
# a TTL for the service; you can use a service to register
|
683
|
-
# that create either alias or non-alias records.
|
745
|
+
# [RegisterInstance][1] request, the `TTL` value is ignored. Always
|
746
|
+
# specify a TTL for the service; you can use a service to register
|
747
|
+
# instances that create either alias or non-alias records.
|
684
748
|
#
|
685
749
|
# </note>
|
750
|
+
#
|
751
|
+
#
|
752
|
+
#
|
753
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
686
754
|
# @return [Integer]
|
687
755
|
#
|
688
756
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DnsRecord AWS API Documentation
|
@@ -767,9 +835,13 @@ module Aws::ServiceDiscovery
|
|
767
835
|
# all the instances that are associated with the specified service.
|
768
836
|
#
|
769
837
|
# <note markdown="1"> To get the IDs for the instances that you've registered by using a
|
770
|
-
# specified service, submit a ListInstances request.
|
838
|
+
# specified service, submit a [ListInstances][1] request.
|
771
839
|
#
|
772
840
|
# </note>
|
841
|
+
#
|
842
|
+
#
|
843
|
+
#
|
844
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html
|
773
845
|
# @return [Array<String>]
|
774
846
|
#
|
775
847
|
# @!attribute [rw] max_results
|
@@ -907,10 +979,10 @@ module Aws::ServiceDiscovery
|
|
907
979
|
include Aws::Structure
|
908
980
|
end
|
909
981
|
|
910
|
-
# *Public DNS namespaces only.* A complex type that contains
|
911
|
-
# for an optional health check. If you specify settings for a
|
912
|
-
# check, AWS Cloud Map associates the health check with the
|
913
|
-
# you specify in `DnsConfig`.
|
982
|
+
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
983
|
+
# settings for an optional health check. If you specify settings for a
|
984
|
+
# health check, AWS Cloud Map associates the health check with the
|
985
|
+
# records that you specify in `DnsConfig`.
|
914
986
|
#
|
915
987
|
# If you specify a health check configuration, you can specify either
|
916
988
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -973,8 +1045,8 @@ module Aws::ServiceDiscovery
|
|
973
1045
|
#
|
974
1046
|
#
|
975
1047
|
# [1]: http://aws.amazon.com/route53/pricing/
|
976
|
-
# [2]:
|
977
|
-
# [3]:
|
1048
|
+
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
1049
|
+
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
978
1050
|
#
|
979
1051
|
# @note When making an API call, you may pass HealthCheckConfig
|
980
1052
|
# data as a hash:
|
@@ -1015,7 +1087,7 @@ module Aws::ServiceDiscovery
|
|
1015
1087
|
#
|
1016
1088
|
#
|
1017
1089
|
#
|
1018
|
-
# [1]:
|
1090
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html
|
1019
1091
|
# @return [String]
|
1020
1092
|
#
|
1021
1093
|
# @!attribute [rw] resource_path
|
@@ -1039,7 +1111,7 @@ module Aws::ServiceDiscovery
|
|
1039
1111
|
#
|
1040
1112
|
#
|
1041
1113
|
#
|
1042
|
-
# [1]:
|
1114
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html
|
1043
1115
|
# @return [Integer]
|
1044
1116
|
#
|
1045
1117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/HealthCheckConfig AWS API Documentation
|
@@ -1069,9 +1141,9 @@ module Aws::ServiceDiscovery
|
|
1069
1141
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
1070
1142
|
#
|
1071
1143
|
# To change the status of a custom health check, submit an
|
1072
|
-
# `UpdateInstanceCustomHealthStatus` request. Cloud Map doesn't
|
1073
|
-
# the status of the resource, it just keeps a record of the
|
1074
|
-
# specified in the most recent `UpdateInstanceCustomHealthStatus`
|
1144
|
+
# `UpdateInstanceCustomHealthStatus` request. AWS Cloud Map doesn't
|
1145
|
+
# monitor the status of the resource, it just keeps a record of the
|
1146
|
+
# status specified in the most recent `UpdateInstanceCustomHealthStatus`
|
1075
1147
|
# request.
|
1076
1148
|
#
|
1077
1149
|
# Here's how custom health checks work:
|
@@ -1080,9 +1152,9 @@ module Aws::ServiceDiscovery
|
|
1080
1152
|
#
|
1081
1153
|
# The failure threshold indicates the number of 30-second intervals
|
1082
1154
|
# you want AWS Cloud Map to wait between the time that your
|
1083
|
-
# application sends an UpdateInstanceCustomHealthStatus request
|
1084
|
-
# the time that AWS Cloud Map stops routing internet traffic to
|
1085
|
-
# corresponding resource.
|
1155
|
+
# application sends an [UpdateInstanceCustomHealthStatus][1] request
|
1156
|
+
# and the time that AWS Cloud Map stops routing internet traffic to
|
1157
|
+
# the corresponding resource.
|
1086
1158
|
#
|
1087
1159
|
# 2. You register an instance.
|
1088
1160
|
#
|
@@ -1105,7 +1177,9 @@ module Aws::ServiceDiscovery
|
|
1105
1177
|
# arrive during that time to change the status back to healthy, AWS
|
1106
1178
|
# Cloud Map stops routing traffic to the resource.
|
1107
1179
|
#
|
1108
|
-
#
|
1180
|
+
#
|
1181
|
+
#
|
1182
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html
|
1109
1183
|
#
|
1110
1184
|
# @note When making an API call, you may pass HealthCheckCustomConfig
|
1111
1185
|
# data as a hash:
|
@@ -1115,18 +1189,18 @@ module Aws::ServiceDiscovery
|
|
1115
1189
|
# }
|
1116
1190
|
#
|
1117
1191
|
# @!attribute [rw] failure_threshold
|
1118
|
-
# The number of 30-second intervals that you want Cloud Map to
|
1119
|
-
# after receiving an `UpdateInstanceCustomHealthStatus` request
|
1120
|
-
# it changes the health status of a service instance. For
|
1121
|
-
# suppose you specify a value of `2` for `FailureTheshold`,
|
1122
|
-
# your application sends an
|
1123
|
-
# request. Cloud Map waits for
|
1124
|
-
# before changing the status of the
|
1125
|
-
# request.
|
1192
|
+
# The number of 30-second intervals that you want AWS Cloud Map to
|
1193
|
+
# wait after receiving an `UpdateInstanceCustomHealthStatus` request
|
1194
|
+
# before it changes the health status of a service instance. For
|
1195
|
+
# example, suppose you specify a value of `2` for `FailureTheshold`,
|
1196
|
+
# and then your application sends an
|
1197
|
+
# `UpdateInstanceCustomHealthStatus` request. AWS Cloud Map waits for
|
1198
|
+
# approximately 60 seconds (2 x 30) before changing the status of the
|
1199
|
+
# service instance based on that request.
|
1126
1200
|
#
|
1127
1201
|
# Sending a second or subsequent `UpdateInstanceCustomHealthStatus`
|
1128
1202
|
# request with the same value before `FailureThreshold x 30` seconds
|
1129
|
-
# has passed doesn't accelerate the change. Cloud Map still waits
|
1203
|
+
# has passed doesn't accelerate the change. AWS Cloud Map still waits
|
1130
1204
|
# `FailureThreshold x 30` seconds after the first request to make the
|
1131
1205
|
# change.
|
1132
1206
|
# @return [Integer]
|
@@ -1138,9 +1212,13 @@ module Aws::ServiceDiscovery
|
|
1138
1212
|
include Aws::Structure
|
1139
1213
|
end
|
1140
1214
|
|
1141
|
-
# In a response to a
|
1142
|
-
# contains information about one instance that
|
1143
|
-
# you specified in the request.
|
1215
|
+
# In a response to a [DiscoverInstances][1] request,
|
1216
|
+
# `HttpInstanceSummary` contains information about one instance that
|
1217
|
+
# matches the values that you specified in the request.
|
1218
|
+
#
|
1219
|
+
#
|
1220
|
+
#
|
1221
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html
|
1144
1222
|
#
|
1145
1223
|
# @!attribute [rw] instance_id
|
1146
1224
|
# The ID of an instance that matches the values that you specified in
|
@@ -1201,7 +1279,7 @@ module Aws::ServiceDiscovery
|
|
1201
1279
|
# * If the service that is specified by `ServiceId` includes settings
|
1202
1280
|
# for an SRV record, the value of `InstanceId` is automatically
|
1203
1281
|
# included as part of the value for the SRV record. For more
|
1204
|
-
# information, see DnsRecord
|
1282
|
+
# information, see [DnsRecord > Type][1].
|
1205
1283
|
#
|
1206
1284
|
# * You can use this value to update an existing instance.
|
1207
1285
|
#
|
@@ -1219,6 +1297,10 @@ module Aws::ServiceDiscovery
|
|
1219
1297
|
# example.
|
1220
1298
|
#
|
1221
1299
|
# </note>
|
1300
|
+
#
|
1301
|
+
#
|
1302
|
+
#
|
1303
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type
|
1222
1304
|
# @return [String]
|
1223
1305
|
#
|
1224
1306
|
# @!attribute [rw] creator_request_id
|
@@ -1311,11 +1393,11 @@ module Aws::ServiceDiscovery
|
|
1311
1393
|
# endpoint that you want Route 53 to send requests to.
|
1312
1394
|
#
|
1313
1395
|
# This value is required if you specified settings for an SRV record
|
1314
|
-
# when you created the service.
|
1396
|
+
# or a Route 53 health check when you created the service.
|
1315
1397
|
#
|
1316
1398
|
#
|
1317
1399
|
#
|
1318
|
-
# [1]:
|
1400
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html
|
1319
1401
|
# @return [Hash<String,String>]
|
1320
1402
|
#
|
1321
1403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Instance AWS API Documentation
|
@@ -1723,8 +1805,17 @@ module Aws::ServiceDiscovery
|
|
1723
1805
|
# @return [String]
|
1724
1806
|
#
|
1725
1807
|
# @!attribute [rw] type
|
1726
|
-
# The type of the namespace.
|
1727
|
-
#
|
1808
|
+
# The type of the namespace. The methods for discovering instances
|
1809
|
+
# depends on the value that you specify:
|
1810
|
+
#
|
1811
|
+
# * `HTTP`\: Instances can be discovered only programmatically, using
|
1812
|
+
# the AWS Cloud Map `DiscoverInstances` API.
|
1813
|
+
#
|
1814
|
+
# * `DNS_PUBLIC`\: Instances can be discovered using public DNS
|
1815
|
+
# queries and using the `DiscoverInstances` API.
|
1816
|
+
#
|
1817
|
+
# * `DNS_PRIVATE`\: Instances can be discovered using DNS queries in
|
1818
|
+
# VPCs and using the `DiscoverInstances` API.
|
1728
1819
|
# @return [String]
|
1729
1820
|
#
|
1730
1821
|
# @!attribute [rw] description
|
@@ -2104,7 +2195,12 @@ module Aws::ServiceDiscovery
|
|
2104
2195
|
end
|
2105
2196
|
|
2106
2197
|
# A complex type that contains information about an operation that
|
2107
|
-
# matches the criteria that you specified in a ListOperations
|
2198
|
+
# matches the criteria that you specified in a [ListOperations][1]
|
2199
|
+
# request.
|
2200
|
+
#
|
2201
|
+
#
|
2202
|
+
#
|
2203
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html
|
2108
2204
|
#
|
2109
2205
|
# @!attribute [rw] id
|
2110
2206
|
# The ID for an operation.
|
@@ -2156,7 +2252,7 @@ module Aws::ServiceDiscovery
|
|
2156
2252
|
# * If the service that is specified by `ServiceId` includes settings
|
2157
2253
|
# for an SRV record, the value of `InstanceId` is automatically
|
2158
2254
|
# included as part of the value for the SRV record. For more
|
2159
|
-
# information, see DnsRecord
|
2255
|
+
# information, see [DnsRecord > Type][1].
|
2160
2256
|
#
|
2161
2257
|
# * You can use this value to update an existing instance.
|
2162
2258
|
#
|
@@ -2174,6 +2270,10 @@ module Aws::ServiceDiscovery
|
|
2174
2270
|
# example.
|
2175
2271
|
#
|
2176
2272
|
# </note>
|
2273
|
+
#
|
2274
|
+
#
|
2275
|
+
#
|
2276
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type
|
2177
2277
|
# @return [String]
|
2178
2278
|
#
|
2179
2279
|
# @!attribute [rw] creator_request_id
|
@@ -2277,7 +2377,7 @@ module Aws::ServiceDiscovery
|
|
2277
2377
|
# endpoint that you want Route 53 to send requests to.
|
2278
2378
|
#
|
2279
2379
|
# This value is required if you specified settings for an SRV record
|
2280
|
-
# when you created the service.
|
2380
|
+
# or a Route 53 health check when you created the service.
|
2281
2381
|
#
|
2282
2382
|
# **Custom attributes**
|
2283
2383
|
#
|
@@ -2287,7 +2387,7 @@ module Aws::ServiceDiscovery
|
|
2287
2387
|
#
|
2288
2388
|
#
|
2289
2389
|
#
|
2290
|
-
# [1]:
|
2390
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html
|
2291
2391
|
# @return [Hash<String,String>]
|
2292
2392
|
#
|
2293
2393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstanceRequest AWS API Documentation
|
@@ -2302,7 +2402,12 @@ module Aws::ServiceDiscovery
|
|
2302
2402
|
|
2303
2403
|
# @!attribute [rw] operation_id
|
2304
2404
|
# A value that you can use to determine whether the request completed
|
2305
|
-
# successfully. To get the status of the operation, see
|
2405
|
+
# successfully. To get the status of the operation, see
|
2406
|
+
# [GetOperation][1].
|
2407
|
+
#
|
2408
|
+
#
|
2409
|
+
#
|
2410
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
2306
2411
|
# @return [String]
|
2307
2412
|
#
|
2308
2413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstanceResponse AWS API Documentation
|
@@ -2366,7 +2471,8 @@ module Aws::ServiceDiscovery
|
|
2366
2471
|
# @!attribute [rw] instance_count
|
2367
2472
|
# The number of instances that are currently associated with the
|
2368
2473
|
# service. Instances that were previously associated with the service
|
2369
|
-
# but that have been deleted are not included in the count.
|
2474
|
+
# but that have been deleted are not included in the count. The count
|
2475
|
+
# might not reflect pending registrations and deregistrations.
|
2370
2476
|
# @return [Integer]
|
2371
2477
|
#
|
2372
2478
|
# @!attribute [rw] dns_config
|
@@ -2376,10 +2482,10 @@ module Aws::ServiceDiscovery
|
|
2376
2482
|
# @return [Types::DnsConfig]
|
2377
2483
|
#
|
2378
2484
|
# @!attribute [rw] health_check_config
|
2379
|
-
# *Public DNS namespaces only.* A complex type that contains
|
2380
|
-
# for an optional health check. If you specify settings for a
|
2381
|
-
# check, AWS Cloud Map associates the health check with the
|
2382
|
-
# that you specify in `DnsConfig`.
|
2485
|
+
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
2486
|
+
# settings for an optional health check. If you specify settings for a
|
2487
|
+
# health check, AWS Cloud Map associates the health check with the
|
2488
|
+
# records that you specify in `DnsConfig`.
|
2383
2489
|
#
|
2384
2490
|
# For information about the charges for health checks, see [Amazon
|
2385
2491
|
# Route 53 Pricing][1].
|
@@ -2484,10 +2590,10 @@ module Aws::ServiceDiscovery
|
|
2484
2590
|
# @return [Types::DnsConfigChange]
|
2485
2591
|
#
|
2486
2592
|
# @!attribute [rw] health_check_config
|
2487
|
-
# *Public DNS namespaces only.* A complex type that contains
|
2488
|
-
# for an optional health check. If you specify settings for a
|
2489
|
-
# check, AWS Cloud Map associates the health check with the
|
2490
|
-
# that you specify in `DnsConfig`.
|
2593
|
+
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
2594
|
+
# settings for an optional health check. If you specify settings for a
|
2595
|
+
# health check, AWS Cloud Map associates the health check with the
|
2596
|
+
# records that you specify in `DnsConfig`.
|
2491
2597
|
#
|
2492
2598
|
# If you specify a health check configuration, you can specify either
|
2493
2599
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -2551,8 +2657,8 @@ module Aws::ServiceDiscovery
|
|
2551
2657
|
#
|
2552
2658
|
#
|
2553
2659
|
# [1]: http://aws.amazon.com/route53/pricing/
|
2554
|
-
# [2]:
|
2555
|
-
# [3]:
|
2660
|
+
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
2661
|
+
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
2556
2662
|
# @return [Types::HealthCheckConfig]
|
2557
2663
|
#
|
2558
2664
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ServiceChange AWS API Documentation
|
@@ -2644,7 +2750,8 @@ module Aws::ServiceDiscovery
|
|
2644
2750
|
# @!attribute [rw] instance_count
|
2645
2751
|
# The number of instances that are currently associated with the
|
2646
2752
|
# service. Instances that were previously associated with the service
|
2647
|
-
# but that have been deleted are not included in the count.
|
2753
|
+
# but that have been deleted are not included in the count. The count
|
2754
|
+
# might not reflect pending registrations and deregistrations.
|
2648
2755
|
# @return [Integer]
|
2649
2756
|
#
|
2650
2757
|
# @!attribute [rw] dns_config
|
@@ -2654,10 +2761,10 @@ module Aws::ServiceDiscovery
|
|
2654
2761
|
# @return [Types::DnsConfig]
|
2655
2762
|
#
|
2656
2763
|
# @!attribute [rw] health_check_config
|
2657
|
-
# *Public DNS namespaces only.* A complex type that contains
|
2658
|
-
# for an optional health check. If you specify settings for a
|
2659
|
-
# check, AWS Cloud Map associates the health check with the
|
2660
|
-
# that you specify in `DnsConfig`.
|
2764
|
+
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
2765
|
+
# settings for an optional health check. If you specify settings for a
|
2766
|
+
# health check, AWS Cloud Map associates the health check with the
|
2767
|
+
# records that you specify in `DnsConfig`.
|
2661
2768
|
#
|
2662
2769
|
# If you specify a health check configuration, you can specify either
|
2663
2770
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -2721,8 +2828,8 @@ module Aws::ServiceDiscovery
|
|
2721
2828
|
#
|
2722
2829
|
#
|
2723
2830
|
# [1]: http://aws.amazon.com/route53/pricing/
|
2724
|
-
# [2]:
|
2725
|
-
# [3]:
|
2831
|
+
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
2832
|
+
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
2726
2833
|
# @return [Types::HealthCheckConfig]
|
2727
2834
|
#
|
2728
2835
|
# @!attribute [rw] health_check_custom_config
|
@@ -2744,7 +2851,7 @@ module Aws::ServiceDiscovery
|
|
2744
2851
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
2745
2852
|
#
|
2746
2853
|
# To change the status of a custom health check, submit an
|
2747
|
-
# `UpdateInstanceCustomHealthStatus` request. Cloud Map doesn't
|
2854
|
+
# `UpdateInstanceCustomHealthStatus` request. AWS Cloud Map doesn't
|
2748
2855
|
# monitor the status of the resource, it just keeps a record of the
|
2749
2856
|
# status specified in the most recent
|
2750
2857
|
# `UpdateInstanceCustomHealthStatus` request.
|
@@ -2755,7 +2862,7 @@ module Aws::ServiceDiscovery
|
|
2755
2862
|
#
|
2756
2863
|
# The failure threshold indicates the number of 30-second
|
2757
2864
|
# intervals you want AWS Cloud Map to wait between the time that
|
2758
|
-
# your application sends an UpdateInstanceCustomHealthStatus
|
2865
|
+
# your application sends an [UpdateInstanceCustomHealthStatus][1]
|
2759
2866
|
# request and the time that AWS Cloud Map stops routing internet
|
2760
2867
|
# traffic to the corresponding resource.
|
2761
2868
|
#
|
@@ -2781,7 +2888,9 @@ module Aws::ServiceDiscovery
|
|
2781
2888
|
# arrive during that time to change the status back to healthy,
|
2782
2889
|
# AWS Cloud Map stops routing traffic to the resource.
|
2783
2890
|
#
|
2784
|
-
#
|
2891
|
+
#
|
2892
|
+
#
|
2893
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html
|
2785
2894
|
# @return [Types::HealthCheckCustomConfig]
|
2786
2895
|
#
|
2787
2896
|
# @!attribute [rw] create_date
|
@@ -2876,7 +2985,12 @@ module Aws::ServiceDiscovery
|
|
2876
2985
|
|
2877
2986
|
# @!attribute [rw] operation_id
|
2878
2987
|
# A value that you can use to determine whether the request completed
|
2879
|
-
# successfully. To get the status of the operation, see
|
2988
|
+
# successfully. To get the status of the operation, see
|
2989
|
+
# [GetOperation][1].
|
2990
|
+
#
|
2991
|
+
#
|
2992
|
+
#
|
2993
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html
|
2880
2994
|
# @return [String]
|
2881
2995
|
#
|
2882
2996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateServiceResponse AWS API Documentation
|