aws-sdk-servicediscovery 1.31.0 → 1.36.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +193 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-servicediscovery.rb +2 -2
- data/lib/aws-sdk-servicediscovery/client.rb +174 -132
- data/lib/aws-sdk-servicediscovery/client_api.rb +16 -7
- data/lib/aws-sdk-servicediscovery/errors.rb +1 -1
- data/lib/aws-sdk-servicediscovery/resource.rb +1 -1
- data/lib/aws-sdk-servicediscovery/types.rb +544 -580
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -69,6 +69,7 @@ module Aws::ServiceDiscovery
|
|
69
69
|
HttpProperties = Shapes::StructureShape.new(name: 'HttpProperties')
|
70
70
|
Instance = Shapes::StructureShape.new(name: 'Instance')
|
71
71
|
InstanceHealthStatusMap = Shapes::MapShape.new(name: 'InstanceHealthStatusMap')
|
72
|
+
InstanceId = Shapes::StringShape.new(name: 'InstanceId')
|
72
73
|
InstanceIdList = Shapes::ListShape.new(name: 'InstanceIdList')
|
73
74
|
InstanceNotFound = Shapes::StructureShape.new(name: 'InstanceNotFound')
|
74
75
|
InstanceSummary = Shapes::StructureShape.new(name: 'InstanceSummary')
|
@@ -92,6 +93,9 @@ module Aws::ServiceDiscovery
|
|
92
93
|
NamespaceFilterName = Shapes::StringShape.new(name: 'NamespaceFilterName')
|
93
94
|
NamespaceFilters = Shapes::ListShape.new(name: 'NamespaceFilters')
|
94
95
|
NamespaceName = Shapes::StringShape.new(name: 'NamespaceName')
|
96
|
+
NamespaceNameHttp = Shapes::StringShape.new(name: 'NamespaceNameHttp')
|
97
|
+
NamespaceNamePrivate = Shapes::StringShape.new(name: 'NamespaceNamePrivate')
|
98
|
+
NamespaceNamePublic = Shapes::StringShape.new(name: 'NamespaceNamePublic')
|
95
99
|
NamespaceNotFound = Shapes::StructureShape.new(name: 'NamespaceNotFound')
|
96
100
|
NamespaceProperties = Shapes::StructureShape.new(name: 'NamespaceProperties')
|
97
101
|
NamespaceSummariesList = Shapes::ListShape.new(name: 'NamespaceSummariesList')
|
@@ -133,6 +137,8 @@ module Aws::ServiceDiscovery
|
|
133
137
|
ServiceNotFound = Shapes::StructureShape.new(name: 'ServiceNotFound')
|
134
138
|
ServiceSummariesList = Shapes::ListShape.new(name: 'ServiceSummariesList')
|
135
139
|
ServiceSummary = Shapes::StructureShape.new(name: 'ServiceSummary')
|
140
|
+
ServiceType = Shapes::StringShape.new(name: 'ServiceType')
|
141
|
+
ServiceTypeOption = Shapes::StringShape.new(name: 'ServiceTypeOption')
|
136
142
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
137
143
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
138
144
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
@@ -151,7 +157,7 @@ module Aws::ServiceDiscovery
|
|
151
157
|
Attributes.key = Shapes::ShapeRef.new(shape: AttrKey)
|
152
158
|
Attributes.value = Shapes::ShapeRef.new(shape: AttrValue)
|
153
159
|
|
154
|
-
CreateHttpNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape:
|
160
|
+
CreateHttpNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: NamespaceNameHttp, required: true, location_name: "Name"))
|
155
161
|
CreateHttpNamespaceRequest.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "CreatorRequestId", metadata: {"idempotencyToken"=>true}))
|
156
162
|
CreateHttpNamespaceRequest.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "Description"))
|
157
163
|
CreateHttpNamespaceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
@@ -160,7 +166,7 @@ module Aws::ServiceDiscovery
|
|
160
166
|
CreateHttpNamespaceResponse.add_member(:operation_id, Shapes::ShapeRef.new(shape: OperationId, location_name: "OperationId"))
|
161
167
|
CreateHttpNamespaceResponse.struct_class = Types::CreateHttpNamespaceResponse
|
162
168
|
|
163
|
-
CreatePrivateDnsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape:
|
169
|
+
CreatePrivateDnsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: NamespaceNamePrivate, required: true, location_name: "Name"))
|
164
170
|
CreatePrivateDnsNamespaceRequest.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "CreatorRequestId", metadata: {"idempotencyToken"=>true}))
|
165
171
|
CreatePrivateDnsNamespaceRequest.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "Description"))
|
166
172
|
CreatePrivateDnsNamespaceRequest.add_member(:vpc, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "Vpc"))
|
@@ -170,7 +176,7 @@ module Aws::ServiceDiscovery
|
|
170
176
|
CreatePrivateDnsNamespaceResponse.add_member(:operation_id, Shapes::ShapeRef.new(shape: OperationId, location_name: "OperationId"))
|
171
177
|
CreatePrivateDnsNamespaceResponse.struct_class = Types::CreatePrivateDnsNamespaceResponse
|
172
178
|
|
173
|
-
CreatePublicDnsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape:
|
179
|
+
CreatePublicDnsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: NamespaceNamePublic, required: true, location_name: "Name"))
|
174
180
|
CreatePublicDnsNamespaceRequest.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "CreatorRequestId", metadata: {"idempotencyToken"=>true}))
|
175
181
|
CreatePublicDnsNamespaceRequest.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "Description"))
|
176
182
|
CreatePublicDnsNamespaceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
@@ -187,6 +193,7 @@ module Aws::ServiceDiscovery
|
|
187
193
|
CreateServiceRequest.add_member(:health_check_config, Shapes::ShapeRef.new(shape: HealthCheckConfig, location_name: "HealthCheckConfig"))
|
188
194
|
CreateServiceRequest.add_member(:health_check_custom_config, Shapes::ShapeRef.new(shape: HealthCheckCustomConfig, location_name: "HealthCheckCustomConfig"))
|
189
195
|
CreateServiceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
196
|
+
CreateServiceRequest.add_member(:type, Shapes::ShapeRef.new(shape: ServiceTypeOption, location_name: "Type"))
|
190
197
|
CreateServiceRequest.struct_class = Types::CreateServiceRequest
|
191
198
|
|
192
199
|
CreateServiceResponse.add_member(:service, Shapes::ShapeRef.new(shape: Service, location_name: "Service"))
|
@@ -287,11 +294,11 @@ module Aws::ServiceDiscovery
|
|
287
294
|
HealthCheckConfig.add_member(:failure_threshold, Shapes::ShapeRef.new(shape: FailureThreshold, location_name: "FailureThreshold"))
|
288
295
|
HealthCheckConfig.struct_class = Types::HealthCheckConfig
|
289
296
|
|
290
|
-
HealthCheckCustomConfig.add_member(:failure_threshold, Shapes::ShapeRef.new(shape: FailureThreshold, location_name: "FailureThreshold"))
|
297
|
+
HealthCheckCustomConfig.add_member(:failure_threshold, Shapes::ShapeRef.new(shape: FailureThreshold, deprecated: true, location_name: "FailureThreshold", metadata: {"deprecatedMessage"=>"Configurable FailureThreshold of HealthCheckCustomConfig is deprecated. It will always have value 1."}))
|
291
298
|
HealthCheckCustomConfig.struct_class = Types::HealthCheckCustomConfig
|
292
299
|
|
293
300
|
HttpInstanceSummary.add_member(:instance_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "InstanceId"))
|
294
|
-
HttpInstanceSummary.add_member(:namespace_name, Shapes::ShapeRef.new(shape:
|
301
|
+
HttpInstanceSummary.add_member(:namespace_name, Shapes::ShapeRef.new(shape: NamespaceNameHttp, location_name: "NamespaceName"))
|
295
302
|
HttpInstanceSummary.add_member(:service_name, Shapes::ShapeRef.new(shape: ServiceName, location_name: "ServiceName"))
|
296
303
|
HttpInstanceSummary.add_member(:health_status, Shapes::ShapeRef.new(shape: HealthStatus, location_name: "HealthStatus"))
|
297
304
|
HttpInstanceSummary.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
@@ -438,7 +445,7 @@ module Aws::ServiceDiscovery
|
|
438
445
|
OperationTargetsMap.value = Shapes::ShapeRef.new(shape: ResourceId)
|
439
446
|
|
440
447
|
RegisterInstanceRequest.add_member(:service_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "ServiceId"))
|
441
|
-
RegisterInstanceRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape:
|
448
|
+
RegisterInstanceRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
442
449
|
RegisterInstanceRequest.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "CreatorRequestId", metadata: {"idempotencyToken"=>true}))
|
443
450
|
RegisterInstanceRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, required: true, location_name: "Attributes"))
|
444
451
|
RegisterInstanceRequest.struct_class = Types::RegisterInstanceRequest
|
@@ -465,6 +472,7 @@ module Aws::ServiceDiscovery
|
|
465
472
|
Service.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "Description"))
|
466
473
|
Service.add_member(:instance_count, Shapes::ShapeRef.new(shape: ResourceCount, location_name: "InstanceCount"))
|
467
474
|
Service.add_member(:dns_config, Shapes::ShapeRef.new(shape: DnsConfig, location_name: "DnsConfig"))
|
475
|
+
Service.add_member(:type, Shapes::ShapeRef.new(shape: ServiceType, location_name: "Type"))
|
468
476
|
Service.add_member(:health_check_config, Shapes::ShapeRef.new(shape: HealthCheckConfig, location_name: "HealthCheckConfig"))
|
469
477
|
Service.add_member(:health_check_custom_config, Shapes::ShapeRef.new(shape: HealthCheckCustomConfig, location_name: "HealthCheckCustomConfig"))
|
470
478
|
Service.add_member(:create_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreateDate"))
|
@@ -496,6 +504,7 @@ module Aws::ServiceDiscovery
|
|
496
504
|
ServiceSummary.add_member(:id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "Id"))
|
497
505
|
ServiceSummary.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
498
506
|
ServiceSummary.add_member(:name, Shapes::ShapeRef.new(shape: ServiceName, location_name: "Name"))
|
507
|
+
ServiceSummary.add_member(:type, Shapes::ShapeRef.new(shape: ServiceType, location_name: "Type"))
|
499
508
|
ServiceSummary.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "Description"))
|
500
509
|
ServiceSummary.add_member(:instance_count, Shapes::ShapeRef.new(shape: ResourceCount, location_name: "InstanceCount"))
|
501
510
|
ServiceSummary.add_member(:dns_config, Shapes::ShapeRef.new(shape: DnsConfig, location_name: "DnsConfig"))
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -14,7 +14,7 @@ module Aws::ServiceDiscovery
|
|
14
14
|
# data as a hash:
|
15
15
|
#
|
16
16
|
# {
|
17
|
-
# name: "
|
17
|
+
# name: "NamespaceNameHttp", # required
|
18
18
|
# creator_request_id: "ResourceId",
|
19
19
|
# description: "ResourceDescription",
|
20
20
|
# tags: [
|
@@ -32,8 +32,8 @@ module Aws::ServiceDiscovery
|
|
32
32
|
# @!attribute [rw] creator_request_id
|
33
33
|
# A unique string that identifies the request and that allows failed
|
34
34
|
# `CreateHttpNamespace` requests to be retried without the risk of
|
35
|
-
#
|
36
|
-
# string
|
35
|
+
# running the operation twice. `CreatorRequestId` can be any unique
|
36
|
+
# string (for example, a date/time stamp).
|
37
37
|
#
|
38
38
|
# **A suitable default value is auto-generated.** You should normally
|
39
39
|
# not need to pass this option.
|
@@ -45,9 +45,9 @@ module Aws::ServiceDiscovery
|
|
45
45
|
#
|
46
46
|
# @!attribute [rw] tags
|
47
47
|
# The tags to add to the namespace. Each tag consists of a key and an
|
48
|
-
# optional value
|
49
|
-
#
|
50
|
-
#
|
48
|
+
# optional value that you define. Tags keys can be up to 128
|
49
|
+
# characters in length, and tag values can be up to 256 characters in
|
50
|
+
# length.
|
51
51
|
# @return [Array<Types::Tag>]
|
52
52
|
#
|
53
53
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespaceRequest AWS API Documentation
|
@@ -83,7 +83,7 @@ module Aws::ServiceDiscovery
|
|
83
83
|
# data as a hash:
|
84
84
|
#
|
85
85
|
# {
|
86
|
-
# name: "
|
86
|
+
# name: "NamespaceNamePrivate", # required
|
87
87
|
# creator_request_id: "ResourceId",
|
88
88
|
# description: "ResourceDescription",
|
89
89
|
# vpc: "ResourceId", # required
|
@@ -105,8 +105,8 @@ module Aws::ServiceDiscovery
|
|
105
105
|
# @!attribute [rw] creator_request_id
|
106
106
|
# A unique string that identifies the request and that allows failed
|
107
107
|
# `CreatePrivateDnsNamespace` requests to be retried without the risk
|
108
|
-
# of
|
109
|
-
#
|
108
|
+
# of running the operation twice. `CreatorRequestId` can be any unique
|
109
|
+
# string (for example, a date/timestamp).
|
110
110
|
#
|
111
111
|
# **A suitable default value is auto-generated.** You should normally
|
112
112
|
# not need to pass this option.
|
@@ -123,9 +123,9 @@ module Aws::ServiceDiscovery
|
|
123
123
|
#
|
124
124
|
# @!attribute [rw] tags
|
125
125
|
# The tags to add to the namespace. Each tag consists of a key and an
|
126
|
-
# optional value
|
127
|
-
#
|
128
|
-
#
|
126
|
+
# optional value that you define. Tags keys can be up to 128
|
127
|
+
# characters in length, and tag values can be up to 256 characters in
|
128
|
+
# length.
|
129
129
|
# @return [Array<Types::Tag>]
|
130
130
|
#
|
131
131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespaceRequest AWS API Documentation
|
@@ -162,7 +162,7 @@ module Aws::ServiceDiscovery
|
|
162
162
|
# data as a hash:
|
163
163
|
#
|
164
164
|
# {
|
165
|
-
# name: "
|
165
|
+
# name: "NamespaceNamePublic", # required
|
166
166
|
# creator_request_id: "ResourceId",
|
167
167
|
# description: "ResourceDescription",
|
168
168
|
# tags: [
|
@@ -180,8 +180,8 @@ module Aws::ServiceDiscovery
|
|
180
180
|
# @!attribute [rw] creator_request_id
|
181
181
|
# A unique string that identifies the request and that allows failed
|
182
182
|
# `CreatePublicDnsNamespace` requests to be retried without the risk
|
183
|
-
# of
|
184
|
-
#
|
183
|
+
# of running the operation twice. `CreatorRequestId` can be any unique
|
184
|
+
# string (for example, a date/timestamp).
|
185
185
|
#
|
186
186
|
# **A suitable default value is auto-generated.** You should normally
|
187
187
|
# not need to pass this option.
|
@@ -193,9 +193,9 @@ module Aws::ServiceDiscovery
|
|
193
193
|
#
|
194
194
|
# @!attribute [rw] tags
|
195
195
|
# The tags to add to the namespace. Each tag consists of a key and an
|
196
|
-
# optional value
|
197
|
-
#
|
198
|
-
#
|
196
|
+
# optional value that you define. Tags keys can be up to 128
|
197
|
+
# characters in length, and tag values can be up to 256 characters in
|
198
|
+
# length.
|
199
199
|
# @return [Array<Types::Tag>]
|
200
200
|
#
|
201
201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespaceRequest AWS API Documentation
|
@@ -259,25 +259,35 @@ module Aws::ServiceDiscovery
|
|
259
259
|
# value: "TagValue", # required
|
260
260
|
# },
|
261
261
|
# ],
|
262
|
+
# type: "HTTP", # accepts HTTP
|
262
263
|
# }
|
263
264
|
#
|
264
265
|
# @!attribute [rw] name
|
265
266
|
# The name that you want to assign to the service.
|
266
267
|
#
|
267
268
|
# If you want AWS Cloud Map to create an `SRV` record when you
|
268
|
-
# register an instance
|
269
|
+
# register an instance and you're using a system that requires a
|
269
270
|
# specific `SRV` format, such as [HAProxy][1], specify the following
|
270
271
|
# for `Name`\:
|
271
272
|
#
|
272
|
-
# * Start the name with an underscore (\_), such as `_exampleservice
|
273
|
+
# * Start the name with an underscore (\_), such as `_exampleservice`.
|
273
274
|
#
|
274
|
-
# * End the name with *.\_protocol*, such as `._tcp
|
275
|
+
# * End the name with *.\_protocol*, such as `._tcp`.
|
275
276
|
#
|
276
277
|
# When you register an instance, AWS Cloud Map creates an `SRV` record
|
277
278
|
# and assigns a name to the record by concatenating the service name
|
278
|
-
# and the namespace name
|
279
|
+
# and the namespace name (for example,
|
279
280
|
#
|
280
|
-
# `_exampleservice._tcp.example.com`
|
281
|
+
# `_exampleservice._tcp.example.com`).
|
282
|
+
#
|
283
|
+
# <note markdown="1"> For services that are accessible by DNS queries, you can't create
|
284
|
+
# multiple services with names that differ only by case (such as
|
285
|
+
# EXAMPLE and example). Otherwise, these services have the same DNS
|
286
|
+
# name and can't be distinguished. However, if you use a namespace
|
287
|
+
# that's only accessible by API calls, then you can create services
|
288
|
+
# that with names that differ only by case.
|
289
|
+
#
|
290
|
+
# </note>
|
281
291
|
#
|
282
292
|
#
|
283
293
|
#
|
@@ -286,13 +296,15 @@ module Aws::ServiceDiscovery
|
|
286
296
|
#
|
287
297
|
# @!attribute [rw] namespace_id
|
288
298
|
# The ID of the namespace that you want to use to create the service.
|
299
|
+
# The namespace ID must be specified, but it can be specified either
|
300
|
+
# here or in the `DnsConfig` object.
|
289
301
|
# @return [String]
|
290
302
|
#
|
291
303
|
# @!attribute [rw] creator_request_id
|
292
304
|
# A unique string that identifies the request and that allows failed
|
293
|
-
# `CreateService` requests to be retried without the risk of
|
294
|
-
# the operation twice. `CreatorRequestId` can be any unique string
|
295
|
-
# for example, a date/
|
305
|
+
# `CreateService` requests to be retried without the risk of running
|
306
|
+
# the operation twice. `CreatorRequestId` can be any unique string
|
307
|
+
# (for example, a date/timestamp).
|
296
308
|
#
|
297
309
|
# **A suitable default value is auto-generated.** You should normally
|
298
310
|
# not need to pass this option.
|
@@ -339,11 +351,18 @@ module Aws::ServiceDiscovery
|
|
339
351
|
#
|
340
352
|
# @!attribute [rw] tags
|
341
353
|
# The tags to add to the service. Each tag consists of a key and an
|
342
|
-
# optional value
|
343
|
-
#
|
344
|
-
#
|
354
|
+
# optional value that you define. Tags keys can be up to 128
|
355
|
+
# characters in length, and tag values can be up to 256 characters in
|
356
|
+
# length.
|
345
357
|
# @return [Array<Types::Tag>]
|
346
358
|
#
|
359
|
+
# @!attribute [rw] type
|
360
|
+
# If present, specifies that the service instances are only
|
361
|
+
# discoverable using the `DiscoverInstances` API operation. No DNS
|
362
|
+
# records is registered for the service instances. The only valid
|
363
|
+
# value is `HTTP`.
|
364
|
+
# @return [String]
|
365
|
+
#
|
347
366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateServiceRequest AWS API Documentation
|
348
367
|
#
|
349
368
|
class CreateServiceRequest < Struct.new(
|
@@ -354,7 +373,8 @@ module Aws::ServiceDiscovery
|
|
354
373
|
:dns_config,
|
355
374
|
:health_check_config,
|
356
375
|
:health_check_custom_config,
|
357
|
-
:tags
|
376
|
+
:tags,
|
377
|
+
:type)
|
358
378
|
SENSITIVE = []
|
359
379
|
include Aws::Structure
|
360
380
|
end
|
@@ -371,8 +391,8 @@ module Aws::ServiceDiscovery
|
|
371
391
|
include Aws::Structure
|
372
392
|
end
|
373
393
|
|
374
|
-
# The health check for the instance that
|
375
|
-
# `InstanceId`
|
394
|
+
# The health check for the instance that's specified by `ServiceId` and
|
395
|
+
# `InstanceId` isn't a custom health check.
|
376
396
|
#
|
377
397
|
# @!attribute [rw] message
|
378
398
|
# @return [String]
|
@@ -505,12 +525,12 @@ module Aws::ServiceDiscovery
|
|
505
525
|
# optional_parameters: {
|
506
526
|
# "AttrKey" => "AttrValue",
|
507
527
|
# },
|
508
|
-
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
|
528
|
+
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL, HEALTHY_OR_ELSE_ALL
|
509
529
|
# }
|
510
530
|
#
|
511
531
|
# @!attribute [rw] namespace_name
|
512
|
-
# The name of the namespace
|
513
|
-
#
|
532
|
+
# The `HttpName` name of the namespace. It's found in the
|
533
|
+
# `HttpProperties` member of the `Properties` member of the namespace.
|
514
534
|
# @return [String]
|
515
535
|
#
|
516
536
|
# @!attribute [rw] service_name
|
@@ -527,21 +547,41 @@ module Aws::ServiceDiscovery
|
|
527
547
|
#
|
528
548
|
# @!attribute [rw] query_parameters
|
529
549
|
# Filters to scope the results based on custom attributes for the
|
530
|
-
# instance
|
531
|
-
# match all the specified key-value pairs
|
550
|
+
# instance (for example, `\{version=v1, az=1a\}`). Only instances that
|
551
|
+
# match all the specified key-value pairs are returned.
|
532
552
|
# @return [Hash<String,String>]
|
533
553
|
#
|
534
554
|
# @!attribute [rw] optional_parameters
|
535
555
|
# Opportunistic filters to scope the results based on custom
|
536
556
|
# attributes. If there are instances that match both the filters
|
537
557
|
# specified in both the `QueryParameters` parameter and this
|
538
|
-
# parameter,
|
539
|
-
# and only instances that match the filters
|
540
|
-
# `QueryParameters` parameter are returned.
|
558
|
+
# parameter, all of these instances are returned. Otherwise, the
|
559
|
+
# filters are ignored, and only instances that match the filters that
|
560
|
+
# are specified in the `QueryParameters` parameter are returned.
|
541
561
|
# @return [Hash<String,String>]
|
542
562
|
#
|
543
563
|
# @!attribute [rw] health_status
|
544
|
-
# The health status of the instances that you want to discover.
|
564
|
+
# The health status of the instances that you want to discover. This
|
565
|
+
# parameter is ignored for services that don't have a health check
|
566
|
+
# configured, and all instances are returned.
|
567
|
+
#
|
568
|
+
# HEALTHY
|
569
|
+
#
|
570
|
+
# : Returns healthy instances.
|
571
|
+
#
|
572
|
+
# UNHEALTHY
|
573
|
+
#
|
574
|
+
# : Returns unhealthy instances.
|
575
|
+
#
|
576
|
+
# ALL
|
577
|
+
#
|
578
|
+
# : Returns all instances.
|
579
|
+
#
|
580
|
+
# HEALTHY\_OR\_ELSE\_ALL
|
581
|
+
#
|
582
|
+
# : Returns healthy instances, unless none are reporting a healthy
|
583
|
+
# state. In that case, return all instances. This is also called
|
584
|
+
# failing open.
|
545
585
|
# @return [String]
|
546
586
|
#
|
547
587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstancesRequest AWS API Documentation
|
@@ -604,46 +644,46 @@ module Aws::ServiceDiscovery
|
|
604
644
|
#
|
605
645
|
# You can specify the following values:
|
606
646
|
#
|
607
|
-
#
|
647
|
+
# MULTIVALUE
|
608
648
|
#
|
609
|
-
# If you define a health check for the service and the health check
|
610
|
-
#
|
611
|
-
#
|
649
|
+
# : If you define a health check for the service and the health check
|
650
|
+
# is healthy, Route 53 returns the applicable value for up to eight
|
651
|
+
# instances.
|
612
652
|
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
653
|
+
# For example, suppose that the service includes configurations for
|
654
|
+
# one `A` record and a health check. You use the service to register
|
655
|
+
# 10 instances. Route 53 responds to DNS queries with IP addresses
|
656
|
+
# for up to eight healthy instances. If fewer than eight instances
|
657
|
+
# are healthy, Route 53 responds to every DNS query with the IP
|
658
|
+
# addresses for all of the healthy instances.
|
619
659
|
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
660
|
+
# If you don't define a health check for the service, Route 53
|
661
|
+
# assumes that all instances are healthy and returns the values for
|
662
|
+
# up to eight instances.
|
623
663
|
#
|
624
|
-
#
|
625
|
-
#
|
664
|
+
# For more information about the multivalue routing policy, see
|
665
|
+
# [Multivalue Answer Routing][1] in the *Route 53 Developer Guide*.
|
626
666
|
#
|
627
|
-
#
|
667
|
+
# WEIGHTED
|
628
668
|
#
|
629
|
-
# Route 53 returns the applicable value from one randomly selected
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
669
|
+
# : Route 53 returns the applicable value from one randomly selected
|
670
|
+
# instance from among the instances that you registered using the
|
671
|
+
# same service. Currently, all records have the same weight, so you
|
672
|
+
# can't route more or less traffic to any instances.
|
633
673
|
#
|
634
|
-
#
|
635
|
-
#
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
674
|
+
# For example, suppose that the service includes configurations for
|
675
|
+
# one `A` record and a health check. You use the service to register
|
676
|
+
# 10 instances. Route 53 responds to DNS queries with the IP address
|
677
|
+
# for one randomly selected instance from among the healthy
|
678
|
+
# instances. If no instances are healthy, Route 53 responds to DNS
|
679
|
+
# queries as if all of the instances were healthy.
|
640
680
|
#
|
641
|
-
#
|
642
|
-
#
|
643
|
-
#
|
681
|
+
# If you don't define a health check for the service, Route 53
|
682
|
+
# assumes that all instances are healthy and returns the applicable
|
683
|
+
# value for one randomly selected instance.
|
644
684
|
#
|
645
|
-
#
|
646
|
-
#
|
685
|
+
# For more information about the weighted routing policy, see
|
686
|
+
# [Weighted Routing][2] in the *Route 53 Developer Guide*.
|
647
687
|
#
|
648
688
|
#
|
649
689
|
#
|
@@ -729,15 +769,15 @@ module Aws::ServiceDiscovery
|
|
729
769
|
# Route 53 returns in response to DNS queries. You can specify values
|
730
770
|
# for `Type` in the following combinations:
|
731
771
|
#
|
732
|
-
# *
|
772
|
+
# * <b> <code>A</code> </b>
|
733
773
|
#
|
734
|
-
# *
|
774
|
+
# * <b> <code>AAAA</code> </b>
|
735
775
|
#
|
736
|
-
# *
|
776
|
+
# * <b> <code>A</code> </b> and <b> <code>AAAA</code> </b>
|
737
777
|
#
|
738
|
-
# *
|
778
|
+
# * <b> <code>SRV</code> </b>
|
739
779
|
#
|
740
|
-
# *
|
780
|
+
# * <b> <code>CNAME</code> </b>
|
741
781
|
#
|
742
782
|
# If you want AWS Cloud Map to create a Route 53 alias record when you
|
743
783
|
# register an instance, specify `A` or `AAAA` for `Type`.
|
@@ -748,62 +788,81 @@ module Aws::ServiceDiscovery
|
|
748
788
|
#
|
749
789
|
# The following values are supported:
|
750
790
|
#
|
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
|
-
#
|
791
|
+
# A
|
792
|
+
#
|
793
|
+
# : Route 53 returns the IP address of the resource in IPv4 format,
|
794
|
+
# such as 192.0.2.44.
|
795
|
+
#
|
796
|
+
# AAAA
|
797
|
+
#
|
798
|
+
# : Route 53 returns the IP address of the resource in IPv6 format,
|
799
|
+
# such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
|
800
|
+
#
|
801
|
+
# CNAME
|
802
|
+
#
|
803
|
+
# : Route 53 returns the domain name of the resource, such as
|
804
|
+
# www.example.com. Note the following:
|
805
|
+
#
|
806
|
+
# * You specify the domain name that you want to route traffic to
|
807
|
+
# when you register an instance. For more information, see
|
808
|
+
# [Attributes][2] in the topic [RegisterInstance][1].
|
809
|
+
#
|
810
|
+
# * You must specify `WEIGHTED` for the value of `RoutingPolicy`.
|
811
|
+
#
|
812
|
+
# * You can't specify both `CNAME` for `Type` and settings for
|
813
|
+
# `HealthCheckConfig`. If you do, the request will fail with an
|
814
|
+
# `InvalidInput` error.
|
815
|
+
#
|
816
|
+
# SRV
|
817
|
+
#
|
818
|
+
# : Route 53 returns the value for an `SRV` record. The value for an
|
819
|
+
# `SRV` record uses the following values:
|
820
|
+
#
|
821
|
+
# `priority weight port service-hostname`
|
822
|
+
#
|
823
|
+
# Note the following about the values:
|
824
|
+
#
|
825
|
+
# * The values of `priority` and `weight` are both set to `1` and
|
826
|
+
# can't be changed.
|
827
|
+
#
|
828
|
+
# * The value of `port` comes from the value that you specify for
|
829
|
+
# the `AWS_INSTANCE_PORT` attribute when you submit a
|
830
|
+
# [RegisterInstance][1] request.
|
831
|
+
#
|
832
|
+
# * The value of `service-hostname` is a concatenation of the
|
833
|
+
# following values:
|
834
|
+
#
|
835
|
+
# * The value that you specify for `InstanceId` when you register
|
836
|
+
# an instance.
|
837
|
+
#
|
838
|
+
# * The name of the service.
|
839
|
+
#
|
840
|
+
# * The name of the namespace.
|
841
|
+
#
|
842
|
+
# For example, if the value of `InstanceId` is `test`, the name of
|
843
|
+
# the service is `backend`, and the name of the namespace is
|
844
|
+
# `example.com`, the value of `service-hostname` is the following:
|
845
|
+
#
|
846
|
+
# `test.backend.example.com`
|
847
|
+
#
|
848
|
+
# If you specify settings for an `SRV` record, note the following:
|
849
|
+
#
|
850
|
+
# * If you specify values for `AWS_INSTANCE_IPV4`,
|
851
|
+
# `AWS_INSTANCE_IPV6`, or both in the `RegisterInstance` request,
|
852
|
+
# AWS Cloud Map automatically creates `A` and/or `AAAA` records
|
853
|
+
# that have the same name as the value of `service-hostname` in
|
854
|
+
# the `SRV` record. You can ignore these records.
|
855
|
+
#
|
856
|
+
# * If you're using a system that requires a specific `SRV` format,
|
857
|
+
# such as HAProxy, see the [Name][3] element in the documentation
|
858
|
+
# about `CreateService` for information about how to specify the
|
859
|
+
# correct name format.
|
803
860
|
#
|
804
861
|
#
|
805
862
|
#
|
806
863
|
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
864
|
+
# [2]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes
|
865
|
+
# [3]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name
|
807
866
|
# @return [String]
|
808
867
|
#
|
809
868
|
# @!attribute [rw] ttl
|
@@ -839,7 +898,7 @@ module Aws::ServiceDiscovery
|
|
839
898
|
# @return [String]
|
840
899
|
#
|
841
900
|
# @!attribute [rw] duplicate_operation_id
|
842
|
-
# The ID of the operation that
|
901
|
+
# The ID of the operation that's already in progress.
|
843
902
|
# @return [String]
|
844
903
|
#
|
845
904
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DuplicateRequest AWS API Documentation
|
@@ -1076,54 +1135,56 @@ module Aws::ServiceDiscovery
|
|
1076
1135
|
#
|
1077
1136
|
# Note the following about configuring health checks.
|
1078
1137
|
#
|
1079
|
-
#
|
1138
|
+
# A and AAAA records
|
1080
1139
|
#
|
1081
|
-
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
# specified by the IPv4 address is unhealthy, Route 53
|
1085
|
-
# the `A` and `AAAA` records to be unhealthy.
|
1140
|
+
# : If `DnsConfig` includes configurations for both `A` and `AAAA`
|
1141
|
+
# records, AWS Cloud Map creates a health check that uses the IPv4
|
1142
|
+
# address to check the health of the resource. If the endpoint
|
1143
|
+
# tthat's specified by the IPv4 address is unhealthy, Route 53
|
1144
|
+
# considers both the `A` and `AAAA` records to be unhealthy.
|
1086
1145
|
#
|
1087
|
-
#
|
1146
|
+
# CNAME records
|
1088
1147
|
#
|
1089
|
-
# You can't specify settings for `HealthCheckConfig` when the
|
1090
|
-
#
|
1091
|
-
#
|
1148
|
+
# : You can't specify settings for `HealthCheckConfig` when the
|
1149
|
+
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
1150
|
+
# `CreateService` request will fail with an `InvalidInput` error.
|
1092
1151
|
#
|
1093
|
-
#
|
1152
|
+
# Request interval
|
1094
1153
|
#
|
1095
|
-
# A Route 53 health checker in each health-checking
|
1096
|
-
#
|
1097
|
-
# endpoint receives a health check request about every two
|
1098
|
-
# However, health checkers don't coordinate with one
|
1099
|
-
# you
|
1100
|
-
# seconds with no health checks at
|
1154
|
+
# : A Route 53 health checker in each health-checking AWS Region sends a
|
1155
|
+
# health check request to an endpoint every 30 seconds. On average,
|
1156
|
+
# your endpoint receives a health check request about every two
|
1157
|
+
# seconds. However, health checkers don't coordinate with one
|
1158
|
+
# another. Therefore, you might sometimes see several requests in one
|
1159
|
+
# second that's followed by a few seconds with no health checks at
|
1160
|
+
# all.
|
1101
1161
|
#
|
1102
|
-
#
|
1162
|
+
# Health checking regions
|
1103
1163
|
#
|
1104
|
-
# Health checkers perform checks from all Route 53 health-checking
|
1105
|
-
#
|
1164
|
+
# : Health checkers perform checks from all Route 53 health-checking
|
1165
|
+
# Regions. For a list of the current Regions, see [Regions][2].
|
1106
1166
|
#
|
1107
|
-
#
|
1167
|
+
# Alias records
|
1108
1168
|
#
|
1109
|
-
# When you register an instance, if you include the
|
1110
|
-
# attribute, AWS Cloud Map creates a Route 53
|
1111
|
-
# following:
|
1169
|
+
# : When you register an instance, if you include the
|
1170
|
+
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
1171
|
+
# alias record. Note the following:
|
1112
1172
|
#
|
1113
|
-
#
|
1114
|
-
#
|
1115
|
-
#
|
1116
|
-
#
|
1173
|
+
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
1174
|
+
# alias records. When `EvaluateTargetHealth` is true, the alias
|
1175
|
+
# record inherits the health of the referenced AWS resource. such as
|
1176
|
+
# an ELB load balancer. For more information, see
|
1177
|
+
# [EvaluateTargetHealth][3].
|
1117
1178
|
#
|
1118
|
-
#
|
1119
|
-
#
|
1120
|
-
#
|
1179
|
+
# * If you include `HealthCheckConfig` and then use the service to
|
1180
|
+
# register an instance that creates an alias record, Route 53
|
1181
|
+
# doesn't create the health check.
|
1121
1182
|
#
|
1122
|
-
#
|
1183
|
+
# Charges for health checks
|
1123
1184
|
#
|
1124
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
1125
|
-
#
|
1126
|
-
# Route 53 Pricing][1].
|
1185
|
+
# : Health checks are basic Route 53 health checks that monitor an AWS
|
1186
|
+
# endpoint. For information about pricing for health checks, see
|
1187
|
+
# [Amazon Route 53 Pricing][1].
|
1127
1188
|
#
|
1128
1189
|
#
|
1129
1190
|
#
|
@@ -1175,11 +1236,11 @@ module Aws::ServiceDiscovery
|
|
1175
1236
|
#
|
1176
1237
|
# @!attribute [rw] resource_path
|
1177
1238
|
# The path that you want Route 53 to request when performing health
|
1178
|
-
# checks. The path can be any value
|
1179
|
-
#
|
1180
|
-
#
|
1181
|
-
#
|
1182
|
-
#
|
1239
|
+
# checks. The path can be any value that your endpoint returns an HTTP
|
1240
|
+
# status code of a 2xx or 3xx format for when the endpoint is healthy.
|
1241
|
+
# An example file is `/docs/route53-health-check.html`. Route 53
|
1242
|
+
# automatically adds the DNS name for the service. If you don't
|
1243
|
+
# specify a value for `ResourcePath`, the default value is `/`.
|
1183
1244
|
#
|
1184
1245
|
# If you specify `TCP` for `Type`, you must *not* specify a value for
|
1185
1246
|
# `ResourcePath`.
|
@@ -1188,9 +1249,9 @@ module Aws::ServiceDiscovery
|
|
1188
1249
|
# @!attribute [rw] failure_threshold
|
1189
1250
|
# The number of consecutive health checks that an endpoint must pass
|
1190
1251
|
# or fail for Route 53 to change the current status of the endpoint
|
1191
|
-
# from unhealthy to healthy or
|
1192
|
-
# [How Route 53 Determines Whether an Endpoint Is
|
1193
|
-
# *Route 53 Developer Guide*.
|
1252
|
+
# from unhealthy to healthy or the other way around. For more
|
1253
|
+
# information, see [How Route 53 Determines Whether an Endpoint Is
|
1254
|
+
# Healthy][1] in the *Route 53 Developer Guide*.
|
1194
1255
|
#
|
1195
1256
|
#
|
1196
1257
|
#
|
@@ -1212,14 +1273,14 @@ module Aws::ServiceDiscovery
|
|
1212
1273
|
# third-party health checker to evaluate the health of your resources,
|
1213
1274
|
# is useful in the following circumstances:
|
1214
1275
|
#
|
1215
|
-
# * You can't use a health check that
|
1276
|
+
# * You can't use a health check that's defined by `HealthCheckConfig`
|
1216
1277
|
# because the resource isn't available over the internet. For
|
1217
1278
|
# example, you can use a custom health check when the instance is in
|
1218
1279
|
# an Amazon VPC. (To check the health of resources in a VPC, the
|
1219
1280
|
# health checker must also be in the VPC.)
|
1220
1281
|
#
|
1221
1282
|
# * You want to use a third-party health checker regardless of where
|
1222
|
-
# your resources are.
|
1283
|
+
# your resources are located.
|
1223
1284
|
#
|
1224
1285
|
# If you specify a health check configuration, you can specify either
|
1225
1286
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -1232,18 +1293,12 @@ module Aws::ServiceDiscovery
|
|
1232
1293
|
#
|
1233
1294
|
# Here's how custom health checks work:
|
1234
1295
|
#
|
1235
|
-
# 1. You create a service
|
1236
|
-
#
|
1237
|
-
# The failure threshold indicates the number of 30-second intervals
|
1238
|
-
# you want AWS Cloud Map to wait between the time that your
|
1239
|
-
# application sends an [UpdateInstanceCustomHealthStatus][1] request
|
1240
|
-
# and the time that AWS Cloud Map stops routing internet traffic to
|
1241
|
-
# the corresponding resource.
|
1296
|
+
# 1. You create a service.
|
1242
1297
|
#
|
1243
1298
|
# 2. You register an instance.
|
1244
1299
|
#
|
1245
1300
|
# 3. You configure a third-party health checker to monitor the resource
|
1246
|
-
# that
|
1301
|
+
# that's associated with the new instance.
|
1247
1302
|
#
|
1248
1303
|
# <note markdown="1"> AWS Cloud Map doesn't check the health of the resource directly.
|
1249
1304
|
#
|
@@ -1255,16 +1310,12 @@ module Aws::ServiceDiscovery
|
|
1255
1310
|
# 5. Your application submits an `UpdateInstanceCustomHealthStatus`
|
1256
1311
|
# request.
|
1257
1312
|
#
|
1258
|
-
# 6. AWS Cloud Map waits for
|
1313
|
+
# 6. AWS Cloud Map waits for 30 seconds.
|
1259
1314
|
#
|
1260
1315
|
# 7. If another `UpdateInstanceCustomHealthStatus` request doesn't
|
1261
1316
|
# arrive during that time to change the status back to healthy, AWS
|
1262
1317
|
# Cloud Map stops routing traffic to the resource.
|
1263
1318
|
#
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html
|
1267
|
-
#
|
1268
1319
|
# @note When making an API call, you may pass HealthCheckCustomConfig
|
1269
1320
|
# data as a hash:
|
1270
1321
|
#
|
@@ -1273,8 +1324,8 @@ module Aws::ServiceDiscovery
|
|
1273
1324
|
# }
|
1274
1325
|
#
|
1275
1326
|
# @!attribute [rw] failure_threshold
|
1276
|
-
# This parameter
|
1277
|
-
# Map waits for approximately 30 seconds after receiving an
|
1327
|
+
# This parameter is no longer supported and is always set to 1. AWS
|
1328
|
+
# Cloud Map waits for approximately 30 seconds after receiving an
|
1278
1329
|
# `UpdateInstanceCustomHealthStatus` request before changing the
|
1279
1330
|
# status of the service instance.
|
1280
1331
|
#
|
@@ -1310,8 +1361,9 @@ module Aws::ServiceDiscovery
|
|
1310
1361
|
# @return [String]
|
1311
1362
|
#
|
1312
1363
|
# @!attribute [rw] namespace_name
|
1313
|
-
# The name of the namespace
|
1314
|
-
#
|
1364
|
+
# ` </p> The HttpName name of the namespace. It's found in the
|
1365
|
+
# HttpProperties member of the Properties member of the namespace.
|
1366
|
+
# `
|
1315
1367
|
# @return [String]
|
1316
1368
|
#
|
1317
1369
|
# @!attribute [rw] service_name
|
@@ -1362,14 +1414,14 @@ module Aws::ServiceDiscovery
|
|
1362
1414
|
# An identifier that you want to associate with the instance. Note the
|
1363
1415
|
# following:
|
1364
1416
|
#
|
1365
|
-
# * If the service that
|
1417
|
+
# * If the service that's specified by `ServiceId` includes settings
|
1366
1418
|
# for an `SRV` record, the value of `InstanceId` is automatically
|
1367
1419
|
# included as part of the value for the `SRV` record. For more
|
1368
1420
|
# information, see [DnsRecord > Type][1].
|
1369
1421
|
#
|
1370
1422
|
# * You can use this value to update an existing instance.
|
1371
1423
|
#
|
1372
|
-
# * To register a new instance, you must specify a value that
|
1424
|
+
# * To register a new instance, you must specify a value that's
|
1373
1425
|
# unique among instances that you register by using the same
|
1374
1426
|
# service.
|
1375
1427
|
#
|
@@ -1395,8 +1447,8 @@ module Aws::ServiceDiscovery
|
|
1395
1447
|
# executing the operation twice. You must use a unique
|
1396
1448
|
# `CreatorRequestId` string every time you submit a `RegisterInstance`
|
1397
1449
|
# request if you're registering additional instances for the same
|
1398
|
-
# namespace and service. `CreatorRequestId` can be any unique string
|
1399
|
-
# for example, a date/time stamp.
|
1450
|
+
# namespace and service. `CreatorRequestId` can be any unique string
|
1451
|
+
# (for example, a date/time stamp).
|
1400
1452
|
# @return [String]
|
1401
1453
|
#
|
1402
1454
|
# @!attribute [rw] attributes
|
@@ -1410,87 +1462,94 @@ module Aws::ServiceDiscovery
|
|
1410
1462
|
#
|
1411
1463
|
# Supported attribute keys include the following:
|
1412
1464
|
#
|
1413
|
-
#
|
1465
|
+
# AWS\_ALIAS\_DNS\_NAME
|
1414
1466
|
#
|
1415
|
-
#
|
1467
|
+
# : If you want AWS Cloud Map to create a Route 53 alias record that
|
1468
|
+
# routes traffic to an Elastic Load Balancing load balancer, specify
|
1469
|
+
# the DNS name that's associated with the load balancer. For
|
1470
|
+
# information about how to get the DNS name, see
|
1471
|
+
# [AliasTarget->DNSName][1] in the *Route 53 API Reference*.
|
1416
1472
|
#
|
1417
|
-
#
|
1418
|
-
# routes traffic to an Elastic Load Balancing load balancer, specify
|
1419
|
-
# the DNS name that is associated with the load balancer. For
|
1420
|
-
# information about how to get the DNS name, see "DNSName" in the
|
1421
|
-
# topic [AliasTarget][1].
|
1473
|
+
# Note the following:
|
1422
1474
|
#
|
1423
|
-
#
|
1475
|
+
# * The configuration for the service that's specified by
|
1476
|
+
# `ServiceId` must include settings for an `A` record, an `AAAA`
|
1477
|
+
# record, or both.
|
1424
1478
|
#
|
1425
|
-
#
|
1426
|
-
#
|
1427
|
-
# both.
|
1479
|
+
# * In the service that's specified by `ServiceId`, the value of
|
1480
|
+
# `RoutingPolicy` must be `WEIGHTED`.
|
1428
1481
|
#
|
1429
|
-
#
|
1430
|
-
#
|
1482
|
+
# * If the service that's specified by `ServiceId` includes
|
1483
|
+
# `HealthCheckConfig` settings, AWS Cloud Map creates the health
|
1484
|
+
# check, but it won't associate the health check with the alias
|
1485
|
+
# record.
|
1431
1486
|
#
|
1432
|
-
#
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
# record.
|
1487
|
+
# * Auto naming currently doesn't support creating alias records
|
1488
|
+
# that route traffic to AWS resources other than ELB load
|
1489
|
+
# balancers.
|
1436
1490
|
#
|
1437
|
-
#
|
1438
|
-
#
|
1491
|
+
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
1492
|
+
# values for any of the `AWS_INSTANCE` attributes.
|
1439
1493
|
#
|
1440
|
-
#
|
1441
|
-
# values for any of the `AWS_INSTANCE` attributes.
|
1494
|
+
# AWS\_EC2\_INSTANCE\_ID
|
1442
1495
|
#
|
1443
|
-
#
|
1496
|
+
# : *HTTP namespaces only.* The Amazon EC2 instance ID for the
|
1497
|
+
# instance. The `AWS_INSTANCE_IPV4` attribute contains the primary
|
1498
|
+
# private IPv4 address.
|
1444
1499
|
#
|
1445
|
-
#
|
1446
|
-
# The `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4
|
1447
|
-
# address.
|
1500
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
1448
1501
|
#
|
1449
|
-
#
|
1502
|
+
# : If the service configuration includes `HealthCheckCustomConfig`,
|
1503
|
+
# you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
|
1504
|
+
# initial status of the custom health check, `HEALTHY` or
|
1505
|
+
# `UNHEALTHY`. If you don't specify a value for
|
1506
|
+
# `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.
|
1450
1507
|
#
|
1451
|
-
#
|
1452
|
-
# name that you want Route 53 to return in response to DNS queries,
|
1453
|
-
# for example, `example.com`.
|
1508
|
+
# AWS\_INSTANCE\_CNAME
|
1454
1509
|
#
|
1455
|
-
#
|
1456
|
-
#
|
1510
|
+
# : If the service configuration includes a `CNAME` record, the domain
|
1511
|
+
# name that you want Route 53 to return in response to DNS queries
|
1512
|
+
# (for example, `example.com`).
|
1457
1513
|
#
|
1458
|
-
#
|
1514
|
+
# This value is required if the service specified by `ServiceId`
|
1515
|
+
# includes settings for an `CNAME` record.
|
1459
1516
|
#
|
1460
|
-
#
|
1461
|
-
# address that you want Route 53 to return in response to DNS queries,
|
1462
|
-
# for example, `192.0.2.44`.
|
1517
|
+
# AWS\_INSTANCE\_IPV4
|
1463
1518
|
#
|
1464
|
-
#
|
1465
|
-
#
|
1466
|
-
#
|
1467
|
-
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1519
|
+
# : If the service configuration includes an `A` record, the IPv4
|
1520
|
+
# address that you want Route 53 to return in response to DNS
|
1521
|
+
# queries (for example, `192.0.2.44`).
|
1468
1522
|
#
|
1469
|
-
#
|
1523
|
+
# This value is required if the service specified by `ServiceId`
|
1524
|
+
# includes settings for an `A` record. If the service includes
|
1525
|
+
# settings for an `SRV` record, you must specify a value for
|
1526
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1470
1527
|
#
|
1471
|
-
#
|
1472
|
-
# address that you want Route 53 to return in response to DNS queries,
|
1473
|
-
# for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1528
|
+
# AWS\_INSTANCE\_IPV6
|
1474
1529
|
#
|
1475
|
-
#
|
1476
|
-
#
|
1477
|
-
#
|
1478
|
-
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1530
|
+
# : If the service configuration includes an `AAAA` record, the IPv6
|
1531
|
+
# address that you want Route 53 to return in response to DNS
|
1532
|
+
# queries (for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
|
1479
1533
|
#
|
1480
|
-
#
|
1534
|
+
# This value is required if the service specified by `ServiceId`
|
1535
|
+
# includes settings for an `AAAA` record. If the service includes
|
1536
|
+
# settings for an `SRV` record, you must specify a value for
|
1537
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1481
1538
|
#
|
1482
|
-
#
|
1483
|
-
# Route 53 to return for the port.
|
1539
|
+
# AWS\_INSTANCE\_PORT
|
1484
1540
|
#
|
1485
|
-
# If the service includes `
|
1486
|
-
#
|
1541
|
+
# : If the service includes an `SRV` record, the value that you want
|
1542
|
+
# Route 53 to return for the port.
|
1487
1543
|
#
|
1488
|
-
#
|
1489
|
-
#
|
1544
|
+
# If the service includes `HealthCheckConfig`, the port on the
|
1545
|
+
# endpoint that you want Route 53 to send requests to.
|
1490
1546
|
#
|
1547
|
+
# This value is required if you specified settings for an `SRV`
|
1548
|
+
# record or a Route 53 health check when you created the service.
|
1491
1549
|
#
|
1492
1550
|
#
|
1493
|
-
#
|
1551
|
+
#
|
1552
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName
|
1494
1553
|
# @return [Hash<String,String>]
|
1495
1554
|
#
|
1496
1555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Instance AWS API Documentation
|
@@ -1528,37 +1587,54 @@ module Aws::ServiceDiscovery
|
|
1528
1587
|
# @!attribute [rw] attributes
|
1529
1588
|
# A string map that contains the following information:
|
1530
1589
|
#
|
1531
|
-
# * The attributes that are
|
1590
|
+
# * The attributes that are associated with the instance.
|
1532
1591
|
#
|
1533
1592
|
# * For each attribute, the applicable value.
|
1534
1593
|
#
|
1535
1594
|
# Supported attribute keys include the following:
|
1536
1595
|
#
|
1537
|
-
#
|
1538
|
-
#
|
1539
|
-
#
|
1596
|
+
# AWS\_ALIAS\_DNS\_NAME
|
1597
|
+
#
|
1598
|
+
# : For an alias record that routes traffic to an Elastic Load
|
1599
|
+
# Balancing load balancer, the DNS name that's associated with the
|
1600
|
+
# load balancer.
|
1601
|
+
#
|
1602
|
+
# AWS\_EC2\_INSTANCE\_ID (HTTP namespaces only)
|
1603
|
+
#
|
1604
|
+
# : The Amazon EC2 instance ID for the instance. When the
|
1605
|
+
# `AWS_EC2_INSTANCE_ID` attribute is specified, then the
|
1606
|
+
# `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4
|
1607
|
+
# address.
|
1608
|
+
#
|
1609
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
1610
|
+
#
|
1611
|
+
# : If the service configuration includes `HealthCheckCustomConfig`,
|
1612
|
+
# you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
|
1613
|
+
# initial status of the custom health check, `HEALTHY` or
|
1614
|
+
# `UNHEALTHY`. If you don't specify a value for
|
1615
|
+
# `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.
|
1616
|
+
#
|
1617
|
+
# AWS\_INSTANCE\_CNAME
|
1540
1618
|
#
|
1541
|
-
#
|
1542
|
-
#
|
1543
|
-
# attribute is specified, then the `AWS_INSTANCE_IPV4` attribute
|
1544
|
-
# contains the primary private IPv4 address.
|
1619
|
+
# : For a `CNAME` record, the domain name that Route 53 returns in
|
1620
|
+
# response to DNS queries (for example, `example.com`).
|
1545
1621
|
#
|
1546
|
-
#
|
1547
|
-
# Route 53 returns in response to DNS queries, for example,
|
1548
|
-
# `example.com`.
|
1622
|
+
# AWS\_INSTANCE\_IPV4
|
1549
1623
|
#
|
1550
|
-
#
|
1551
|
-
#
|
1552
|
-
# `192.0.2.44`.
|
1624
|
+
# : For an `A` record, the IPv4 address that Route 53 returns in
|
1625
|
+
# response to DNS queries (for example, `192.0.2.44`).
|
1553
1626
|
#
|
1554
|
-
#
|
1555
|
-
# Route 53 returns in response to DNS queries, for example,
|
1556
|
-
# `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1627
|
+
# AWS\_INSTANCE\_IPV6
|
1557
1628
|
#
|
1558
|
-
#
|
1559
|
-
#
|
1560
|
-
# `
|
1561
|
-
#
|
1629
|
+
# : For an `AAAA` record, the IPv6 address that Route 53 returns in
|
1630
|
+
# response to DNS queries (for example,
|
1631
|
+
# `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
|
1632
|
+
#
|
1633
|
+
# AWS\_INSTANCE\_PORT
|
1634
|
+
#
|
1635
|
+
# : For an `SRV` record, the value that Route 53 returns for the port.
|
1636
|
+
# In addition, if the service includes `HealthCheckConfig`, the port
|
1637
|
+
# on the endpoint that Route 53 sends requests to.
|
1562
1638
|
# @return [Hash<String,String>]
|
1563
1639
|
#
|
1564
1640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/InstanceSummary AWS API Documentation
|
@@ -1951,14 +2027,20 @@ module Aws::ServiceDiscovery
|
|
1951
2027
|
# The type of the namespace. The methods for discovering instances
|
1952
2028
|
# depends on the value that you specify:
|
1953
2029
|
#
|
1954
|
-
#
|
1955
|
-
#
|
2030
|
+
# HTTP
|
2031
|
+
#
|
2032
|
+
# : Instances can be discovered only programmatically, using the AWS
|
2033
|
+
# Cloud Map `DiscoverInstances` API.
|
2034
|
+
#
|
2035
|
+
# DNS\_PUBLIC
|
1956
2036
|
#
|
1957
|
-
#
|
1958
|
-
#
|
2037
|
+
# : Instances can be discovered using public DNS queries and using the
|
2038
|
+
# `DiscoverInstances` API.
|
1959
2039
|
#
|
1960
|
-
#
|
1961
|
-
#
|
2040
|
+
# DNS\_PRIVATE
|
2041
|
+
#
|
2042
|
+
# : Instances can be discovered using DNS queries in VPCs and using
|
2043
|
+
# the `DiscoverInstances` API.
|
1962
2044
|
# @return [String]
|
1963
2045
|
#
|
1964
2046
|
# @!attribute [rw] description
|
@@ -1984,7 +2066,7 @@ module Aws::ServiceDiscovery
|
|
1984
2066
|
#
|
1985
2067
|
# @!attribute [rw] creator_request_id
|
1986
2068
|
# A unique string that identifies the request and that allows failed
|
1987
|
-
# requests to be retried without the risk of
|
2069
|
+
# requests to be retried without the risk of running an operation
|
1988
2070
|
# twice.
|
1989
2071
|
# @return [String]
|
1990
2072
|
#
|
@@ -2056,14 +2138,20 @@ module Aws::ServiceDiscovery
|
|
2056
2138
|
# `ListNamespaces` returns a namespace. Valid values for `condition`
|
2057
2139
|
# include:
|
2058
2140
|
#
|
2059
|
-
#
|
2060
|
-
#
|
2061
|
-
#
|
2141
|
+
# EQ
|
2142
|
+
#
|
2143
|
+
# : When you specify `EQ` for the condition, you can choose to list
|
2144
|
+
# only public namespaces or private namespaces, but not both. `EQ`
|
2145
|
+
# is the default condition and can be omitted.
|
2146
|
+
#
|
2147
|
+
# IN
|
2062
2148
|
#
|
2063
|
-
#
|
2064
|
-
#
|
2149
|
+
# : When you specify `IN` for the condition, you can choose to list
|
2150
|
+
# public namespaces, private namespaces, or both.
|
2065
2151
|
#
|
2066
|
-
#
|
2152
|
+
# BETWEEN
|
2153
|
+
#
|
2154
|
+
# : Not applicable
|
2067
2155
|
# @return [String]
|
2068
2156
|
#
|
2069
2157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/NamespaceFilter AWS API Documentation
|
@@ -2089,7 +2177,7 @@ module Aws::ServiceDiscovery
|
|
2089
2177
|
include Aws::Structure
|
2090
2178
|
end
|
2091
2179
|
|
2092
|
-
# A complex type that contains information that
|
2180
|
+
# A complex type that contains information that's specific to the
|
2093
2181
|
# namespace type.
|
2094
2182
|
#
|
2095
2183
|
# @!attribute [rw] dns_properties
|
@@ -2140,8 +2228,7 @@ module Aws::ServiceDiscovery
|
|
2140
2228
|
# @return [Integer]
|
2141
2229
|
#
|
2142
2230
|
# @!attribute [rw] properties
|
2143
|
-
#
|
2144
|
-
# namespace type.
|
2231
|
+
# The properties of the namespace.
|
2145
2232
|
# @return [Types::NamespaceProperties]
|
2146
2233
|
#
|
2147
2234
|
# @!attribute [rw] create_date
|
@@ -2170,21 +2257,28 @@ module Aws::ServiceDiscovery
|
|
2170
2257
|
# @return [String]
|
2171
2258
|
#
|
2172
2259
|
# @!attribute [rw] type
|
2173
|
-
# The name of the operation that
|
2260
|
+
# The name of the operation that's associated with the specified ID.
|
2174
2261
|
# @return [String]
|
2175
2262
|
#
|
2176
2263
|
# @!attribute [rw] status
|
2177
2264
|
# The status of the operation. Values include the following:
|
2178
2265
|
#
|
2179
|
-
#
|
2180
|
-
# submit a request.
|
2266
|
+
# SUBMITTED
|
2181
2267
|
#
|
2182
|
-
#
|
2268
|
+
# : This is the initial state that occurs immediately after you submit
|
2269
|
+
# a request.
|
2183
2270
|
#
|
2184
|
-
#
|
2271
|
+
# PENDING
|
2185
2272
|
#
|
2186
|
-
#
|
2187
|
-
#
|
2273
|
+
# : AWS Cloud Map is performing the operation.
|
2274
|
+
#
|
2275
|
+
# SUCCESS
|
2276
|
+
#
|
2277
|
+
# : The operation succeeded.
|
2278
|
+
#
|
2279
|
+
# FAIL
|
2280
|
+
#
|
2281
|
+
# : The operation failed. For the failure reason, see `ErrorMessage`.
|
2188
2282
|
# @return [String]
|
2189
2283
|
#
|
2190
2284
|
# @!attribute [rw] error_message
|
@@ -2228,16 +2322,19 @@ module Aws::ServiceDiscovery
|
|
2228
2322
|
# @return [Time]
|
2229
2323
|
#
|
2230
2324
|
# @!attribute [rw] targets
|
2231
|
-
# The name of the target entity that
|
2325
|
+
# The name of the target entity that's associated with the operation:
|
2232
2326
|
#
|
2233
|
-
#
|
2234
|
-
# property.
|
2327
|
+
# NAMESPACE
|
2235
2328
|
#
|
2236
|
-
#
|
2237
|
-
# property.
|
2329
|
+
# : The namespace ID is returned in the `ResourceId` property.
|
2238
2330
|
#
|
2239
|
-
#
|
2240
|
-
#
|
2331
|
+
# SERVICE
|
2332
|
+
#
|
2333
|
+
# : The service ID is returned in the `ResourceId` property.
|
2334
|
+
#
|
2335
|
+
# INSTANCE
|
2336
|
+
#
|
2337
|
+
# : The instance ID is returned in the `ResourceId` property.
|
2241
2338
|
# @return [Hash<String,String>]
|
2242
2339
|
#
|
2243
2340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Operation AWS API Documentation
|
@@ -2386,7 +2483,7 @@ module Aws::ServiceDiscovery
|
|
2386
2483
|
#
|
2387
2484
|
# {
|
2388
2485
|
# service_id: "ResourceId", # required
|
2389
|
-
# instance_id: "
|
2486
|
+
# instance_id: "InstanceId", # required
|
2390
2487
|
# creator_request_id: "ResourceId",
|
2391
2488
|
# attributes: { # required
|
2392
2489
|
# "AttrKey" => "AttrValue",
|
@@ -2402,14 +2499,14 @@ module Aws::ServiceDiscovery
|
|
2402
2499
|
# An identifier that you want to associate with the instance. Note the
|
2403
2500
|
# following:
|
2404
2501
|
#
|
2405
|
-
# * If the service that
|
2502
|
+
# * If the service that's specified by `ServiceId` includes settings
|
2406
2503
|
# for an `SRV` record, the value of `InstanceId` is automatically
|
2407
2504
|
# included as part of the value for the `SRV` record. For more
|
2408
2505
|
# information, see [DnsRecord > Type][1].
|
2409
2506
|
#
|
2410
2507
|
# * You can use this value to update an existing instance.
|
2411
2508
|
#
|
2412
|
-
# * To register a new instance, you must specify a value that
|
2509
|
+
# * To register a new instance, you must specify a value that's
|
2413
2510
|
# unique among instances that you register by using the same
|
2414
2511
|
# service.
|
2415
2512
|
#
|
@@ -2435,8 +2532,8 @@ module Aws::ServiceDiscovery
|
|
2435
2532
|
# executing the operation twice. You must use a unique
|
2436
2533
|
# `CreatorRequestId` string every time you submit a `RegisterInstance`
|
2437
2534
|
# request if you're registering additional instances for the same
|
2438
|
-
# namespace and service. `CreatorRequestId` can be any unique string
|
2439
|
-
# for example, a date/time stamp.
|
2535
|
+
# namespace and service. `CreatorRequestId` can be any unique string
|
2536
|
+
# (for example, a date/time stamp).
|
2440
2537
|
#
|
2441
2538
|
# **A suitable default value is auto-generated.** You should normally
|
2442
2539
|
# not need to pass this option.
|
@@ -2453,101 +2550,102 @@ module Aws::ServiceDiscovery
|
|
2453
2550
|
#
|
2454
2551
|
# Supported attribute keys include the following:
|
2455
2552
|
#
|
2456
|
-
#
|
2553
|
+
# AWS\_ALIAS\_DNS\_NAME
|
2457
2554
|
#
|
2458
|
-
# If you want AWS Cloud Map to create an Amazon Route 53 alias
|
2459
|
-
#
|
2460
|
-
#
|
2461
|
-
#
|
2462
|
-
#
|
2555
|
+
# : If you want AWS Cloud Map to create an Amazon Route 53 alias
|
2556
|
+
# record that routes traffic to an Elastic Load Balancing load
|
2557
|
+
# balancer, specify the DNS name that's associated with the load
|
2558
|
+
# balancer. For information about how to get the DNS name, see
|
2559
|
+
# "DNSName" in the topic [AliasTarget][1] in the *Route 53 API
|
2560
|
+
# Reference*.
|
2463
2561
|
#
|
2464
|
-
#
|
2562
|
+
# Note the following:
|
2465
2563
|
#
|
2466
|
-
#
|
2467
|
-
#
|
2468
|
-
#
|
2564
|
+
# * The configuration for the service that's specified by
|
2565
|
+
# `ServiceId` must include settings for an `A` record, an `AAAA`
|
2566
|
+
# record, or both.
|
2469
2567
|
#
|
2470
|
-
#
|
2471
|
-
#
|
2568
|
+
# * In the service that's specified by `ServiceId`, the value of
|
2569
|
+
# `RoutingPolicy` must be `WEIGHTED`.
|
2472
2570
|
#
|
2473
|
-
#
|
2474
|
-
#
|
2475
|
-
#
|
2476
|
-
#
|
2571
|
+
# * If the service that's specified by `ServiceId` includes
|
2572
|
+
# `HealthCheckConfig` settings, AWS Cloud Map will create the
|
2573
|
+
# Route 53 health check, but it doesn't associate the health
|
2574
|
+
# check with the alias record.
|
2477
2575
|
#
|
2478
|
-
#
|
2479
|
-
#
|
2480
|
-
#
|
2576
|
+
# * Auto naming currently doesn't support creating alias records
|
2577
|
+
# that route traffic to AWS resources other than Elastic Load
|
2578
|
+
# Balancing load balancers.
|
2481
2579
|
#
|
2482
|
-
#
|
2483
|
-
#
|
2580
|
+
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
2581
|
+
# values for any of the `AWS_INSTANCE` attributes.
|
2484
2582
|
#
|
2485
|
-
#
|
2583
|
+
# AWS\_EC2\_INSTANCE\_ID
|
2486
2584
|
#
|
2487
|
-
# *HTTP namespaces only.* The Amazon EC2 instance ID for the
|
2488
|
-
#
|
2489
|
-
#
|
2490
|
-
#
|
2491
|
-
#
|
2492
|
-
#
|
2585
|
+
# : *HTTP namespaces only.* The Amazon EC2 instance ID for the
|
2586
|
+
# instance. If the `AWS_EC2_INSTANCE_ID` attribute is specified,
|
2587
|
+
# then the only other attribute that can be specified is
|
2588
|
+
# `AWS_INIT_HEALTH_STATUS`. When the `AWS_EC2_INSTANCE_ID` attribute
|
2589
|
+
# is specified, then the `AWS_INSTANCE_IPV4` attribute will be
|
2590
|
+
# filled out with the primary private IPv4 address.
|
2493
2591
|
#
|
2494
|
-
#
|
2592
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
2495
2593
|
#
|
2496
|
-
# If the service configuration includes `HealthCheckCustomConfig`,
|
2497
|
-
#
|
2498
|
-
#
|
2499
|
-
#
|
2500
|
-
#
|
2594
|
+
# : If the service configuration includes `HealthCheckCustomConfig`,
|
2595
|
+
# you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
|
2596
|
+
# initial status of the custom health check, `HEALTHY` or
|
2597
|
+
# `UNHEALTHY`. If you don't specify a value for
|
2598
|
+
# `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.
|
2501
2599
|
#
|
2502
|
-
#
|
2600
|
+
# AWS\_INSTANCE\_CNAME
|
2503
2601
|
#
|
2504
|
-
# If the service configuration includes a `CNAME` record, the domain
|
2505
|
-
#
|
2506
|
-
#
|
2602
|
+
# : If the service configuration includes a `CNAME` record, the domain
|
2603
|
+
# name that you want Route 53 to return in response to DNS queries
|
2604
|
+
# (for example, `example.com`).
|
2507
2605
|
#
|
2508
|
-
#
|
2509
|
-
#
|
2606
|
+
# This value is required if the service specified by `ServiceId`
|
2607
|
+
# includes settings for an `CNAME` record.
|
2510
2608
|
#
|
2511
|
-
#
|
2609
|
+
# AWS\_INSTANCE\_IPV4
|
2512
2610
|
#
|
2513
|
-
# If the service configuration includes an `A` record, the IPv4
|
2514
|
-
#
|
2515
|
-
#
|
2611
|
+
# : If the service configuration includes an `A` record, the IPv4
|
2612
|
+
# address that you want Route 53 to return in response to DNS
|
2613
|
+
# queries (for example, `192.0.2.44`).
|
2516
2614
|
#
|
2517
|
-
#
|
2518
|
-
#
|
2519
|
-
#
|
2520
|
-
#
|
2615
|
+
# This value is required if the service specified by `ServiceId`
|
2616
|
+
# includes settings for an `A` record. If the service includes
|
2617
|
+
# settings for an `SRV` record, you must specify a value for
|
2618
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2521
2619
|
#
|
2522
|
-
#
|
2620
|
+
# AWS\_INSTANCE\_IPV6
|
2523
2621
|
#
|
2524
|
-
# If the service configuration includes an `AAAA` record, the IPv6
|
2525
|
-
#
|
2526
|
-
#
|
2622
|
+
# : If the service configuration includes an `AAAA` record, the IPv6
|
2623
|
+
# address that you want Route 53 to return in response to DNS
|
2624
|
+
# queries (for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
|
2527
2625
|
#
|
2528
|
-
#
|
2529
|
-
#
|
2530
|
-
#
|
2531
|
-
#
|
2626
|
+
# This value is required if the service specified by `ServiceId`
|
2627
|
+
# includes settings for an `AAAA` record. If the service includes
|
2628
|
+
# settings for an `SRV` record, you must specify a value for
|
2629
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2532
2630
|
#
|
2533
|
-
#
|
2631
|
+
# AWS\_INSTANCE\_PORT
|
2534
2632
|
#
|
2535
|
-
# If the service includes an `SRV` record, the value that you want
|
2536
|
-
#
|
2633
|
+
# : If the service includes an `SRV` record, the value that you want
|
2634
|
+
# Route 53 to return for the port.
|
2537
2635
|
#
|
2538
|
-
#
|
2539
|
-
#
|
2636
|
+
# If the service includes `HealthCheckConfig`, the port on the
|
2637
|
+
# endpoint that you want Route 53 to send requests to.
|
2540
2638
|
#
|
2541
|
-
#
|
2542
|
-
#
|
2639
|
+
# This value is required if you specified settings for an `SRV`
|
2640
|
+
# record or a Route 53 health check when you created the service.
|
2543
2641
|
#
|
2544
|
-
#
|
2642
|
+
# Custom attributes
|
2545
2643
|
#
|
2546
|
-
# You can add up to 30 custom attributes. For each key-value pair,
|
2547
|
-
#
|
2548
|
-
#
|
2549
|
-
#
|
2550
|
-
#
|
2644
|
+
# : You can add up to 30 custom attributes. For each key-value pair,
|
2645
|
+
# the maximum length of the attribute name is 255 characters, and
|
2646
|
+
# the maximum length of the attribute value is 1,024 characters. The
|
2647
|
+
# total size of all provided attributes (sum of all keys and values)
|
2648
|
+
# must not exceed 5,000 characters.
|
2551
2649
|
#
|
2552
2650
|
#
|
2553
2651
|
#
|
@@ -2672,8 +2770,8 @@ module Aws::ServiceDiscovery
|
|
2672
2770
|
# @!attribute [rw] instance_count
|
2673
2771
|
# The number of instances that are currently associated with the
|
2674
2772
|
# service. Instances that were previously associated with the service
|
2675
|
-
# but that
|
2676
|
-
#
|
2773
|
+
# but that are deleted aren't included in the count. The count might
|
2774
|
+
# not reflect pending registrations and deregistrations.
|
2677
2775
|
# @return [Integer]
|
2678
2776
|
#
|
2679
2777
|
# @!attribute [rw] dns_config
|
@@ -2682,6 +2780,25 @@ module Aws::ServiceDiscovery
|
|
2682
2780
|
# instance.
|
2683
2781
|
# @return [Types::DnsConfig]
|
2684
2782
|
#
|
2783
|
+
# @!attribute [rw] type
|
2784
|
+
# Describes the systems that can be used to discover the service
|
2785
|
+
# instances.
|
2786
|
+
#
|
2787
|
+
# DNS\_HTTP
|
2788
|
+
#
|
2789
|
+
# : The service instances can be discovered using either DNS queries
|
2790
|
+
# or the `DiscoverInstances` API operation.
|
2791
|
+
#
|
2792
|
+
# HTTP
|
2793
|
+
#
|
2794
|
+
# : The service instances can only be discovered using the
|
2795
|
+
# `DiscoverInstances` API operation.
|
2796
|
+
#
|
2797
|
+
# DNS
|
2798
|
+
#
|
2799
|
+
# : Reserved.
|
2800
|
+
# @return [String]
|
2801
|
+
#
|
2685
2802
|
# @!attribute [rw] health_check_config
|
2686
2803
|
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
2687
2804
|
# settings for an optional health check. If you specify settings for a
|
@@ -2713,9 +2830,9 @@ module Aws::ServiceDiscovery
|
|
2713
2830
|
#
|
2714
2831
|
# @!attribute [rw] creator_request_id
|
2715
2832
|
# A unique string that identifies the request and that allows failed
|
2716
|
-
# requests to be retried without the risk of
|
2717
|
-
# twice. `CreatorRequestId` can be any unique string
|
2718
|
-
# date/
|
2833
|
+
# requests to be retried without the risk of running the operation
|
2834
|
+
# twice. `CreatorRequestId` can be any unique string (for example, a
|
2835
|
+
# date/timestamp).
|
2719
2836
|
# @return [String]
|
2720
2837
|
#
|
2721
2838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Service AWS API Documentation
|
@@ -2728,6 +2845,7 @@ module Aws::ServiceDiscovery
|
|
2728
2845
|
:description,
|
2729
2846
|
:instance_count,
|
2730
2847
|
:dns_config,
|
2848
|
+
:type,
|
2731
2849
|
:health_check_config,
|
2732
2850
|
:health_check_custom_config,
|
2733
2851
|
:create_date,
|
@@ -2787,81 +2905,15 @@ module Aws::ServiceDiscovery
|
|
2787
2905
|
# @return [String]
|
2788
2906
|
#
|
2789
2907
|
# @!attribute [rw] dns_config
|
2790
|
-
#
|
2791
|
-
#
|
2792
|
-
# instance.
|
2908
|
+
# Information about the Route 53 DNS records that you want AWS Cloud
|
2909
|
+
# Map to create when you register an instance.
|
2793
2910
|
# @return [Types::DnsConfigChange]
|
2794
2911
|
#
|
2795
2912
|
# @!attribute [rw] health_check_config
|
2796
|
-
# *Public DNS and HTTP namespaces only.*
|
2797
|
-
#
|
2798
|
-
#
|
2799
|
-
#
|
2800
|
-
#
|
2801
|
-
# If you specify a health check configuration, you can specify either
|
2802
|
-
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
2803
|
-
#
|
2804
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
2805
|
-
# endpoint. For information about pricing for health checks, see
|
2806
|
-
# [Amazon Route 53 Pricing][1].
|
2807
|
-
#
|
2808
|
-
# Note the following about configuring health checks.
|
2809
|
-
#
|
2810
|
-
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
2811
|
-
#
|
2812
|
-
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
2813
|
-
# records, AWS Cloud Map creates a health check that uses the IPv4
|
2814
|
-
# address to check the health of the resource. If the endpoint that is
|
2815
|
-
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
2816
|
-
# the `A` and `AAAA` records to be unhealthy.
|
2817
|
-
#
|
2818
|
-
# <b> <code>CNAME</code> records</b>
|
2819
|
-
#
|
2820
|
-
# You can't specify settings for `HealthCheckConfig` when the
|
2821
|
-
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
2822
|
-
# `CreateService` request will fail with an `InvalidInput` error.
|
2823
|
-
#
|
2824
|
-
# **Request interval**
|
2825
|
-
#
|
2826
|
-
# A Route 53 health checker in each health-checking region sends a
|
2827
|
-
# health check request to an endpoint every 30 seconds. On average,
|
2828
|
-
# your endpoint receives a health check request about every two
|
2829
|
-
# seconds. However, health checkers don't coordinate with one
|
2830
|
-
# another, so you'll sometimes see several requests per second
|
2831
|
-
# followed by a few seconds with no health checks at all.
|
2832
|
-
#
|
2833
|
-
# **Health checking regions**
|
2834
|
-
#
|
2835
|
-
# Health checkers perform checks from all Route 53 health-checking
|
2836
|
-
# regions. For a list of the current regions, see [Regions][2].
|
2837
|
-
#
|
2838
|
-
# **Alias records**
|
2839
|
-
#
|
2840
|
-
# When you register an instance, if you include the
|
2841
|
-
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
2842
|
-
# alias record. Note the following:
|
2843
|
-
#
|
2844
|
-
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
2845
|
-
# alias records. When `EvaluateTargetHealth` is true, the alias
|
2846
|
-
# record inherits the health of the referenced AWS resource. such as
|
2847
|
-
# an ELB load balancer. For more information, see
|
2848
|
-
# [EvaluateTargetHealth][3].
|
2849
|
-
#
|
2850
|
-
# * If you include `HealthCheckConfig` and then use the service to
|
2851
|
-
# register an instance that creates an alias record, Route 53
|
2852
|
-
# doesn't create the health check.
|
2853
|
-
#
|
2854
|
-
# **Charges for health checks**
|
2855
|
-
#
|
2856
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
2857
|
-
# endpoint. For information about pricing for health checks, see
|
2858
|
-
# [Amazon Route 53 Pricing][1].
|
2859
|
-
#
|
2860
|
-
#
|
2861
|
-
#
|
2862
|
-
# [1]: http://aws.amazon.com/route53/pricing/
|
2863
|
-
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
2864
|
-
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
2913
|
+
# *Public DNS and HTTP namespaces only.* Settings for an optional
|
2914
|
+
# health check. If you specify settings for a health check, AWS Cloud
|
2915
|
+
# Map associates the health check with the records that you specify in
|
2916
|
+
# `DnsConfig`.
|
2865
2917
|
# @return [Types::HealthCheckConfig]
|
2866
2918
|
#
|
2867
2919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ServiceChange AWS API Documentation
|
@@ -2949,6 +3001,25 @@ module Aws::ServiceDiscovery
|
|
2949
3001
|
# The name of the service.
|
2950
3002
|
# @return [String]
|
2951
3003
|
#
|
3004
|
+
# @!attribute [rw] type
|
3005
|
+
# Describes the systems that can be used to discover the service
|
3006
|
+
# instances.
|
3007
|
+
#
|
3008
|
+
# DNS\_HTTP
|
3009
|
+
#
|
3010
|
+
# : The service instances can be discovered using either DNS queries
|
3011
|
+
# or the `DiscoverInstances` API operation.
|
3012
|
+
#
|
3013
|
+
# HTTP
|
3014
|
+
#
|
3015
|
+
# : The service instances can only be discovered using the
|
3016
|
+
# `DiscoverInstances` API operation.
|
3017
|
+
#
|
3018
|
+
# DNS
|
3019
|
+
#
|
3020
|
+
# : Reserved.
|
3021
|
+
# @return [String]
|
3022
|
+
#
|
2952
3023
|
# @!attribute [rw] description
|
2953
3024
|
# The description that you specify when you create the service.
|
2954
3025
|
# @return [String]
|
@@ -2956,147 +3027,39 @@ module Aws::ServiceDiscovery
|
|
2956
3027
|
# @!attribute [rw] instance_count
|
2957
3028
|
# The number of instances that are currently associated with the
|
2958
3029
|
# service. Instances that were previously associated with the service
|
2959
|
-
# but that
|
2960
|
-
#
|
3030
|
+
# but that are deleted aren't included in the count. The count might
|
3031
|
+
# not reflect pending registrations and deregistrations.
|
2961
3032
|
# @return [Integer]
|
2962
3033
|
#
|
2963
3034
|
# @!attribute [rw] dns_config
|
2964
|
-
#
|
2965
|
-
#
|
2966
|
-
# an instance.
|
3035
|
+
# Information about the Route 53 DNS records that you want AWS Cloud
|
3036
|
+
# Map to create when you register an instance.
|
2967
3037
|
# @return [Types::DnsConfig]
|
2968
3038
|
#
|
2969
3039
|
# @!attribute [rw] health_check_config
|
2970
|
-
# *Public DNS and HTTP namespaces only.*
|
2971
|
-
#
|
2972
|
-
#
|
2973
|
-
#
|
2974
|
-
#
|
2975
|
-
# If you specify a health check configuration, you can specify either
|
2976
|
-
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
2977
|
-
#
|
2978
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
2979
|
-
# endpoint. For information about pricing for health checks, see
|
2980
|
-
# [Amazon Route 53 Pricing][1].
|
2981
|
-
#
|
2982
|
-
# Note the following about configuring health checks.
|
2983
|
-
#
|
2984
|
-
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
2985
|
-
#
|
2986
|
-
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
2987
|
-
# records, AWS Cloud Map creates a health check that uses the IPv4
|
2988
|
-
# address to check the health of the resource. If the endpoint that is
|
2989
|
-
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
2990
|
-
# the `A` and `AAAA` records to be unhealthy.
|
2991
|
-
#
|
2992
|
-
# <b> <code>CNAME</code> records</b>
|
2993
|
-
#
|
2994
|
-
# You can't specify settings for `HealthCheckConfig` when the
|
2995
|
-
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
2996
|
-
# `CreateService` request will fail with an `InvalidInput` error.
|
2997
|
-
#
|
2998
|
-
# **Request interval**
|
2999
|
-
#
|
3000
|
-
# A Route 53 health checker in each health-checking region sends a
|
3001
|
-
# health check request to an endpoint every 30 seconds. On average,
|
3002
|
-
# your endpoint receives a health check request about every two
|
3003
|
-
# seconds. However, health checkers don't coordinate with one
|
3004
|
-
# another, so you'll sometimes see several requests per second
|
3005
|
-
# followed by a few seconds with no health checks at all.
|
3006
|
-
#
|
3007
|
-
# **Health checking regions**
|
3008
|
-
#
|
3009
|
-
# Health checkers perform checks from all Route 53 health-checking
|
3010
|
-
# regions. For a list of the current regions, see [Regions][2].
|
3011
|
-
#
|
3012
|
-
# **Alias records**
|
3013
|
-
#
|
3014
|
-
# When you register an instance, if you include the
|
3015
|
-
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
3016
|
-
# alias record. Note the following:
|
3017
|
-
#
|
3018
|
-
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
3019
|
-
# alias records. When `EvaluateTargetHealth` is true, the alias
|
3020
|
-
# record inherits the health of the referenced AWS resource. such as
|
3021
|
-
# an ELB load balancer. For more information, see
|
3022
|
-
# [EvaluateTargetHealth][3].
|
3023
|
-
#
|
3024
|
-
# * If you include `HealthCheckConfig` and then use the service to
|
3025
|
-
# register an instance that creates an alias record, Route 53
|
3026
|
-
# doesn't create the health check.
|
3027
|
-
#
|
3028
|
-
# **Charges for health checks**
|
3029
|
-
#
|
3030
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
3031
|
-
# endpoint. For information about pricing for health checks, see
|
3032
|
-
# [Amazon Route 53 Pricing][1].
|
3033
|
-
#
|
3034
|
-
#
|
3035
|
-
#
|
3036
|
-
# [1]: http://aws.amazon.com/route53/pricing/
|
3037
|
-
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
3038
|
-
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
3040
|
+
# *Public DNS and HTTP namespaces only.* Settings for an optional
|
3041
|
+
# health check. If you specify settings for a health check, AWS Cloud
|
3042
|
+
# Map associates the health check with the records that you specify in
|
3043
|
+
# `DnsConfig`.
|
3039
3044
|
# @return [Types::HealthCheckConfig]
|
3040
3045
|
#
|
3041
3046
|
# @!attribute [rw] health_check_custom_config
|
3042
|
-
#
|
3043
|
-
#
|
3044
|
-
#
|
3045
|
-
#
|
3047
|
+
# Information about an optional custom health check. A custom health
|
3048
|
+
# check, which requires that you use a third-party health checker to
|
3049
|
+
# evaluate the health of your resources, is useful in the following
|
3050
|
+
# circumstances:
|
3046
3051
|
#
|
3047
|
-
# * You can't use a health check that
|
3052
|
+
# * You can't use a health check that's defined by
|
3048
3053
|
# `HealthCheckConfig` because the resource isn't available over the
|
3049
3054
|
# internet. For example, you can use a custom health check when the
|
3050
3055
|
# instance is in an Amazon VPC. (To check the health of resources in
|
3051
3056
|
# a VPC, the health checker must also be in the VPC.)
|
3052
3057
|
#
|
3053
3058
|
# * You want to use a third-party health checker regardless of where
|
3054
|
-
# your resources are.
|
3059
|
+
# your resources are located.
|
3055
3060
|
#
|
3056
3061
|
# If you specify a health check configuration, you can specify either
|
3057
3062
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
3058
|
-
#
|
3059
|
-
# To change the status of a custom health check, submit an
|
3060
|
-
# `UpdateInstanceCustomHealthStatus` request. AWS Cloud Map doesn't
|
3061
|
-
# monitor the status of the resource, it just keeps a record of the
|
3062
|
-
# status specified in the most recent
|
3063
|
-
# `UpdateInstanceCustomHealthStatus` request.
|
3064
|
-
#
|
3065
|
-
# Here's how custom health checks work:
|
3066
|
-
#
|
3067
|
-
# 1. You create a service and specify a value for `FailureThreshold`.
|
3068
|
-
#
|
3069
|
-
# The failure threshold indicates the number of 30-second
|
3070
|
-
# intervals you want AWS Cloud Map to wait between the time that
|
3071
|
-
# your application sends an [UpdateInstanceCustomHealthStatus][1]
|
3072
|
-
# request and the time that AWS Cloud Map stops routing internet
|
3073
|
-
# traffic to the corresponding resource.
|
3074
|
-
#
|
3075
|
-
# 2. You register an instance.
|
3076
|
-
#
|
3077
|
-
# 3. You configure a third-party health checker to monitor the
|
3078
|
-
# resource that is associated with the new instance.
|
3079
|
-
#
|
3080
|
-
# <note markdown="1"> AWS Cloud Map doesn't check the health of the resource
|
3081
|
-
# directly.
|
3082
|
-
#
|
3083
|
-
# </note>
|
3084
|
-
#
|
3085
|
-
# 4. The third-party health-checker determines that the resource is
|
3086
|
-
# unhealthy and notifies your application.
|
3087
|
-
#
|
3088
|
-
# 5. Your application submits an `UpdateInstanceCustomHealthStatus`
|
3089
|
-
# request.
|
3090
|
-
#
|
3091
|
-
# 6. AWS Cloud Map waits for (`FailureThreshold` x 30) seconds.
|
3092
|
-
#
|
3093
|
-
# 7. If another `UpdateInstanceCustomHealthStatus` request doesn't
|
3094
|
-
# arrive during that time to change the status back to healthy,
|
3095
|
-
# AWS Cloud Map stops routing traffic to the resource.
|
3096
|
-
#
|
3097
|
-
#
|
3098
|
-
#
|
3099
|
-
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html
|
3100
3063
|
# @return [Types::HealthCheckCustomConfig]
|
3101
3064
|
#
|
3102
3065
|
# @!attribute [rw] create_date
|
@@ -3109,6 +3072,7 @@ module Aws::ServiceDiscovery
|
|
3109
3072
|
:id,
|
3110
3073
|
:arn,
|
3111
3074
|
:name,
|
3075
|
+
:type,
|
3112
3076
|
:description,
|
3113
3077
|
:instance_count,
|
3114
3078
|
:dns_config,
|
@@ -3119,7 +3083,7 @@ module Aws::ServiceDiscovery
|
|
3119
3083
|
include Aws::Structure
|
3120
3084
|
end
|
3121
3085
|
|
3122
|
-
# A custom key-value pair associated with a resource.
|
3086
|
+
# A custom key-value pair that's associated with a resource.
|
3123
3087
|
#
|
3124
3088
|
# @note When making an API call, you may pass Tag
|
3125
3089
|
# data as a hash:
|
@@ -3134,9 +3098,9 @@ module Aws::ServiceDiscovery
|
|
3134
3098
|
# @return [String]
|
3135
3099
|
#
|
3136
3100
|
# @!attribute [rw] value
|
3137
|
-
# The string value associated with the key of the tag. You can
|
3138
|
-
# value of a tag to an empty string, but you can't set the
|
3139
|
-
# tag to null.
|
3101
|
+
# The string value that's associated with the key of the tag. You can
|
3102
|
+
# set the value of a tag to an empty string, but you can't set the
|
3103
|
+
# value of a tag to null.
|
3140
3104
|
# @return [String]
|
3141
3105
|
#
|
3142
3106
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Tag AWS API Documentation
|