aws-sdk-servicediscovery 1.8.0 → 1.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-servicediscovery.rb +3 -3
- data/lib/aws-sdk-servicediscovery/client.rb +269 -84
- data/lib/aws-sdk-servicediscovery/client_api.rb +80 -4
- data/lib/aws-sdk-servicediscovery/types.rb +664 -180
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7a29a7b408fe7977c501ee056fa658c8ee82a12c
|
4
|
+
data.tar.gz: 3fa1efa99593a4dba163b779331959dd71494d3f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f3945914eb8bbdb4d4bc6c67392a2596478e8cfbc5ec88d1d1d8e4b049c45f1e5ec2fd972010e24b155b0d97a8db8fa65587782d3fa70497daca56cdcb5a97f
|
7
|
+
data.tar.gz: 317f439fcdbf6f2d80e94b45496558b126b157d8e3726dd3fcc217958e8e99f5b0a342da683ebafff959950bd3c992fb10a0b0198396c7310e221a3184cf70a0
|
@@ -15,7 +15,7 @@ require_relative 'aws-sdk-servicediscovery/errors'
|
|
15
15
|
require_relative 'aws-sdk-servicediscovery/resource'
|
16
16
|
require_relative 'aws-sdk-servicediscovery/customizations'
|
17
17
|
|
18
|
-
# This module provides support for
|
18
|
+
# This module provides support for AWS Cloud Map. This module is available in the
|
19
19
|
# `aws-sdk-servicediscovery` gem.
|
20
20
|
#
|
21
21
|
# # Client
|
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-servicediscovery/customizations'
|
|
28
28
|
#
|
29
29
|
# # Errors
|
30
30
|
#
|
31
|
-
# Errors returned from
|
31
|
+
# Errors returned from AWS Cloud Map all
|
32
32
|
# extend {Errors::ServiceError}.
|
33
33
|
#
|
34
34
|
# begin
|
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-servicediscovery/customizations'
|
|
42
42
|
# @service
|
43
43
|
module Aws::ServiceDiscovery
|
44
44
|
|
45
|
-
GEM_VERSION = '1.
|
45
|
+
GEM_VERSION = '1.9.0'
|
46
46
|
|
47
47
|
end
|
@@ -215,22 +215,74 @@ module Aws::ServiceDiscovery
|
|
215
215
|
|
216
216
|
# @!group API Operations
|
217
217
|
|
218
|
+
# Creates an HTTP namespace. Service instances that you register using
|
219
|
+
# an HTTP namespace can be discovered using a `DiscoverInstances`
|
220
|
+
# request but can't be discovered using DNS.
|
221
|
+
#
|
222
|
+
# For the current limit on the number of namespaces that you can create
|
223
|
+
# using the same AWS account, see [AWS Cloud Map Limits][1] in the *AWS
|
224
|
+
# Cloud Map Developer Guide*.
|
225
|
+
#
|
226
|
+
#
|
227
|
+
#
|
228
|
+
# [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
229
|
+
#
|
230
|
+
# @option params [required, String] :name
|
231
|
+
# The name that you want to assign to this namespace.
|
232
|
+
#
|
233
|
+
# @option params [String] :creator_request_id
|
234
|
+
# A unique string that identifies the request and that allows failed
|
235
|
+
# `CreateHttpNamespace` requests to be retried without the risk of
|
236
|
+
# executing the operation twice. `CreatorRequestId` can be any unique
|
237
|
+
# string, for example, a date/time stamp.
|
238
|
+
#
|
239
|
+
# **A suitable default value is auto-generated.** You should normally
|
240
|
+
# not need to pass this option.**
|
241
|
+
#
|
242
|
+
# @option params [String] :description
|
243
|
+
# A description for the namespace.
|
244
|
+
#
|
245
|
+
# @return [Types::CreateHttpNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
246
|
+
#
|
247
|
+
# * {Types::CreateHttpNamespaceResponse#operation_id #operation_id} => String
|
248
|
+
#
|
249
|
+
# @example Request syntax with placeholder values
|
250
|
+
#
|
251
|
+
# resp = client.create_http_namespace({
|
252
|
+
# name: "NamespaceName", # required
|
253
|
+
# creator_request_id: "ResourceId",
|
254
|
+
# description: "ResourceDescription",
|
255
|
+
# })
|
256
|
+
#
|
257
|
+
# @example Response structure
|
258
|
+
#
|
259
|
+
# resp.operation_id #=> String
|
260
|
+
#
|
261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespace AWS API Documentation
|
262
|
+
#
|
263
|
+
# @overload create_http_namespace(params = {})
|
264
|
+
# @param [Hash] params ({})
|
265
|
+
def create_http_namespace(params = {}, options = {})
|
266
|
+
req = build_request(:create_http_namespace, params)
|
267
|
+
req.send_request(options)
|
268
|
+
end
|
269
|
+
|
218
270
|
# Creates a private namespace based on DNS, which will be visible only
|
219
271
|
# inside a specified Amazon VPC. The namespace defines your service
|
220
272
|
# naming scheme. For example, if you name your namespace `example.com`
|
221
273
|
# and name your service `backend`, the resulting DNS name for the
|
222
274
|
# service will be `backend.example.com`. For the current limit on the
|
223
275
|
# number of namespaces that you can create using the same AWS account,
|
224
|
-
# see [
|
276
|
+
# see [AWS Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
225
277
|
#
|
226
278
|
#
|
227
279
|
#
|
228
|
-
# [1]: http://docs.aws.amazon.com/
|
280
|
+
# [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
229
281
|
#
|
230
282
|
# @option params [required, String] :name
|
231
283
|
# The name that you want to assign to this namespace. When you create a
|
232
|
-
# namespace,
|
233
|
-
# has the same name as the namespace.
|
284
|
+
# private DNS namespace, AWS Cloud Map automatically creates an Amazon
|
285
|
+
# Route 53 private hosted zone that has the same name as the namespace.
|
234
286
|
#
|
235
287
|
# @option params [String] :creator_request_id
|
236
288
|
# A unique string that identifies the request and that allows failed
|
@@ -279,12 +331,12 @@ module Aws::ServiceDiscovery
|
|
279
331
|
# example, if you name your namespace `example.com` and name your
|
280
332
|
# service `backend`, the resulting DNS name for the service will be
|
281
333
|
# `backend.example.com`. For the current limit on the number of
|
282
|
-
# namespaces that you can create using the same AWS account, see [
|
283
|
-
#
|
334
|
+
# namespaces that you can create using the same AWS account, see [AWS
|
335
|
+
# Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
284
336
|
#
|
285
337
|
#
|
286
338
|
#
|
287
|
-
# [1]: http://docs.aws.amazon.com/
|
339
|
+
# [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
288
340
|
#
|
289
341
|
# @option params [required, String] :name
|
290
342
|
# The name that you want to assign to this namespace.
|
@@ -329,25 +381,39 @@ module Aws::ServiceDiscovery
|
|
329
381
|
# Creates a service, which defines the configuration for the following
|
330
382
|
# entities:
|
331
383
|
#
|
332
|
-
# *
|
384
|
+
# * For public and private DNS namespaces, one of the following
|
385
|
+
# combinations of DNS records in Amazon Route 53:
|
386
|
+
#
|
387
|
+
# * A
|
388
|
+
#
|
389
|
+
# * AAAA
|
390
|
+
#
|
391
|
+
# * A and AAAA
|
392
|
+
#
|
393
|
+
# * SRV
|
394
|
+
#
|
395
|
+
# * CNAME
|
333
396
|
#
|
334
397
|
# * Optionally, a health check
|
335
398
|
#
|
336
399
|
# After you create the service, you can submit a RegisterInstance
|
337
|
-
# request, and
|
400
|
+
# request, and AWS Cloud Map uses the values in the configuration to
|
338
401
|
# create the specified entities.
|
339
402
|
#
|
340
403
|
# For the current limit on the number of instances that you can register
|
341
|
-
# using the same namespace and using the same service, see [
|
342
|
-
#
|
404
|
+
# using the same namespace and using the same service, see [AWS Cloud
|
405
|
+
# Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
343
406
|
#
|
344
407
|
#
|
345
408
|
#
|
346
|
-
# [1]: http://docs.aws.amazon.com/
|
409
|
+
# [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
347
410
|
#
|
348
411
|
# @option params [required, String] :name
|
349
412
|
# The name that you want to assign to the service.
|
350
413
|
#
|
414
|
+
# @option params [String] :namespace_id
|
415
|
+
# The ID of the namespace that you want to use to create the service.
|
416
|
+
#
|
351
417
|
# @option params [String] :creator_request_id
|
352
418
|
# A unique string that identifies the request and that allows failed
|
353
419
|
# `CreateService` requests to be retried without the risk of executing
|
@@ -360,24 +426,33 @@ module Aws::ServiceDiscovery
|
|
360
426
|
# @option params [String] :description
|
361
427
|
# A description for the service.
|
362
428
|
#
|
363
|
-
# @option params [
|
364
|
-
# A complex type that contains information about the
|
365
|
-
# want
|
429
|
+
# @option params [Types::DnsConfig] :dns_config
|
430
|
+
# A complex type that contains information about the Amazon Route 53
|
431
|
+
# records that you want AWS Cloud Map to create when you register an
|
432
|
+
# instance.
|
366
433
|
#
|
367
434
|
# @option params [Types::HealthCheckConfig] :health_check_config
|
368
435
|
# *Public DNS namespaces only.* A complex type that contains settings
|
369
|
-
# for an optional health check. If you specify settings for a
|
370
|
-
# check,
|
371
|
-
# you specify in `DnsConfig`.
|
436
|
+
# for an optional Route 53 health check. If you specify settings for a
|
437
|
+
# health check, AWS Cloud Map associates the health check with all the
|
438
|
+
# Route 53 DNS records that you specify in `DnsConfig`.
|
372
439
|
#
|
373
|
-
#
|
374
|
-
#
|
440
|
+
# If you specify a health check configuration, you can specify either
|
441
|
+
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
375
442
|
#
|
443
|
+
# For information about the charges for health checks, see [AWS Cloud
|
444
|
+
# Map Pricing][1].
|
376
445
|
#
|
377
446
|
#
|
378
|
-
#
|
447
|
+
#
|
448
|
+
# [1]: http://aws.amazon.com/cloud-map/pricing/
|
379
449
|
#
|
380
450
|
# @option params [Types::HealthCheckCustomConfig] :health_check_custom_config
|
451
|
+
# A complex type that contains information about an optional custom
|
452
|
+
# health check.
|
453
|
+
#
|
454
|
+
# If you specify a health check configuration, you can specify either
|
455
|
+
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
381
456
|
#
|
382
457
|
# @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
383
458
|
#
|
@@ -387,10 +462,11 @@ module Aws::ServiceDiscovery
|
|
387
462
|
#
|
388
463
|
# resp = client.create_service({
|
389
464
|
# name: "ServiceName", # required
|
465
|
+
# namespace_id: "ResourceId",
|
390
466
|
# creator_request_id: "ResourceId",
|
391
467
|
# description: "ResourceDescription",
|
392
|
-
# dns_config: {
|
393
|
-
# namespace_id: "ResourceId",
|
468
|
+
# dns_config: {
|
469
|
+
# namespace_id: "ResourceId",
|
394
470
|
# routing_policy: "MULTIVALUE", # accepts MULTIVALUE, WEIGHTED
|
395
471
|
# dns_records: [ # required
|
396
472
|
# {
|
@@ -400,7 +476,7 @@ module Aws::ServiceDiscovery
|
|
400
476
|
# ],
|
401
477
|
# },
|
402
478
|
# health_check_config: {
|
403
|
-
# type: "HTTP", # accepts HTTP, HTTPS, TCP
|
479
|
+
# type: "HTTP", # required, accepts HTTP, HTTPS, TCP
|
404
480
|
# resource_path: "ResourcePath",
|
405
481
|
# failure_threshold: 1,
|
406
482
|
# },
|
@@ -414,6 +490,7 @@ module Aws::ServiceDiscovery
|
|
414
490
|
# resp.service.id #=> String
|
415
491
|
# resp.service.arn #=> String
|
416
492
|
# resp.service.name #=> String
|
493
|
+
# resp.service.namespace_id #=> String
|
417
494
|
# resp.service.description #=> String
|
418
495
|
# resp.service.instance_count #=> Integer
|
419
496
|
# resp.service.dns_config.namespace_id #=> String
|
@@ -489,8 +566,8 @@ module Aws::ServiceDiscovery
|
|
489
566
|
req.send_request(options)
|
490
567
|
end
|
491
568
|
|
492
|
-
# Deletes the records and
|
493
|
-
# created for the specified instance.
|
569
|
+
# Deletes the Amazon Route 53 DNS records and health check, if any, that
|
570
|
+
# AWS Cloud Map created for the specified instance.
|
494
571
|
#
|
495
572
|
# @option params [required, String] :service_id
|
496
573
|
# The ID of the service that the instance is associated with.
|
@@ -522,6 +599,65 @@ module Aws::ServiceDiscovery
|
|
522
599
|
req.send_request(options)
|
523
600
|
end
|
524
601
|
|
602
|
+
# Discovers registered instances for a specified namespace and service.
|
603
|
+
#
|
604
|
+
# @option params [required, String] :namespace_name
|
605
|
+
# The name of the namespace that you specified when you registered the
|
606
|
+
# instance.
|
607
|
+
#
|
608
|
+
# @option params [required, String] :service_name
|
609
|
+
# The name of the service that you specified when you registered the
|
610
|
+
# instance.
|
611
|
+
#
|
612
|
+
# @option params [Integer] :max_results
|
613
|
+
# The maximum number of instances that you want Cloud Map to return in
|
614
|
+
# the response to a `DiscoverInstances` request. If you don't specify a
|
615
|
+
# value for `MaxResults`, Cloud Map returns up to 100 instances.
|
616
|
+
#
|
617
|
+
# @option params [Hash<String,String>] :query_parameters
|
618
|
+
# A string map that contains attributes with values that you can use to
|
619
|
+
# filter instances by any custom attribute that you specified when you
|
620
|
+
# registered the instance. Only instances that match all the specified
|
621
|
+
# key/value pairs will be returned.
|
622
|
+
#
|
623
|
+
# @option params [String] :health_status
|
624
|
+
# The health status of the instances that you want to discover.
|
625
|
+
#
|
626
|
+
# @return [Types::DiscoverInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
627
|
+
#
|
628
|
+
# * {Types::DiscoverInstancesResponse#instances #instances} => Array<Types::HttpInstanceSummary>
|
629
|
+
#
|
630
|
+
# @example Request syntax with placeholder values
|
631
|
+
#
|
632
|
+
# resp = client.discover_instances({
|
633
|
+
# namespace_name: "NamespaceName", # required
|
634
|
+
# service_name: "ServiceName", # required
|
635
|
+
# max_results: 1,
|
636
|
+
# query_parameters: {
|
637
|
+
# "AttrKey" => "AttrValue",
|
638
|
+
# },
|
639
|
+
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
|
640
|
+
# })
|
641
|
+
#
|
642
|
+
# @example Response structure
|
643
|
+
#
|
644
|
+
# resp.instances #=> Array
|
645
|
+
# resp.instances[0].instance_id #=> String
|
646
|
+
# resp.instances[0].namespace_name #=> String
|
647
|
+
# resp.instances[0].service_name #=> String
|
648
|
+
# resp.instances[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
|
649
|
+
# resp.instances[0].attributes #=> Hash
|
650
|
+
# resp.instances[0].attributes["AttrKey"] #=> String
|
651
|
+
#
|
652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstances AWS API Documentation
|
653
|
+
#
|
654
|
+
# @overload discover_instances(params = {})
|
655
|
+
# @param [Hash] params ({})
|
656
|
+
def discover_instances(params = {}, options = {})
|
657
|
+
req = build_request(:discover_instances, params)
|
658
|
+
req.send_request(options)
|
659
|
+
end
|
660
|
+
|
525
661
|
# Gets information about a specified instance.
|
526
662
|
#
|
527
663
|
# @option params [required, String] :service_id
|
@@ -572,7 +708,7 @@ module Aws::ServiceDiscovery
|
|
572
708
|
# An array that contains the IDs of all the instances that you want to
|
573
709
|
# get the health status for.
|
574
710
|
#
|
575
|
-
# If you omit `Instances`,
|
711
|
+
# If you omit `Instances`, AWS Cloud Map returns the health status for
|
576
712
|
# all the instances that are associated with the specified service.
|
577
713
|
#
|
578
714
|
# <note markdown="1"> To get the IDs for the instances that you've registered by using a
|
@@ -581,9 +717,9 @@ module Aws::ServiceDiscovery
|
|
581
717
|
# </note>
|
582
718
|
#
|
583
719
|
# @option params [Integer] :max_results
|
584
|
-
# The maximum number of instances that you want
|
585
|
-
# the response to a `GetInstancesHealthStatus` request. If you don't
|
586
|
-
# specify a value for `MaxResults`,
|
720
|
+
# The maximum number of instances that you want AWS Cloud Map to return
|
721
|
+
# in the response to a `GetInstancesHealthStatus` request. If you don't
|
722
|
+
# specify a value for `MaxResults`, AWS Cloud Map returns up to 100
|
587
723
|
# instances.
|
588
724
|
#
|
589
725
|
# @option params [String] :next_token
|
@@ -643,10 +779,11 @@ module Aws::ServiceDiscovery
|
|
643
779
|
# resp.namespace.id #=> String
|
644
780
|
# resp.namespace.arn #=> String
|
645
781
|
# resp.namespace.name #=> String
|
646
|
-
# resp.namespace.type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE"
|
782
|
+
# resp.namespace.type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE", "HTTP"
|
647
783
|
# resp.namespace.description #=> String
|
648
784
|
# resp.namespace.service_count #=> Integer
|
649
785
|
# resp.namespace.properties.dns_properties.hosted_zone_id #=> String
|
786
|
+
# resp.namespace.properties.http_properties.http_name #=> String
|
650
787
|
# resp.namespace.create_date #=> Time
|
651
788
|
# resp.namespace.creator_request_id #=> String
|
652
789
|
#
|
@@ -721,6 +858,7 @@ module Aws::ServiceDiscovery
|
|
721
858
|
# resp.service.id #=> String
|
722
859
|
# resp.service.arn #=> String
|
723
860
|
# resp.service.name #=> String
|
861
|
+
# resp.service.namespace_id #=> String
|
724
862
|
# resp.service.description #=> String
|
725
863
|
# resp.service.instance_count #=> Integer
|
726
864
|
# resp.service.dns_config.namespace_id #=> String
|
@@ -759,10 +897,9 @@ module Aws::ServiceDiscovery
|
|
759
897
|
# in the next request.
|
760
898
|
#
|
761
899
|
# @option params [Integer] :max_results
|
762
|
-
# The maximum number of instances that you want
|
763
|
-
#
|
764
|
-
#
|
765
|
-
# instances.
|
900
|
+
# The maximum number of instances that you want AWS Cloud Map to return
|
901
|
+
# in the response to a `ListInstances` request. If you don't specify a
|
902
|
+
# value for `MaxResults`, AWS Cloud Map returns up to 100 instances.
|
766
903
|
#
|
767
904
|
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
768
905
|
#
|
@@ -804,19 +941,18 @@ module Aws::ServiceDiscovery
|
|
804
941
|
# request to get the next group of results. Specify the value of
|
805
942
|
# `NextToken` from the previous response in the next request.
|
806
943
|
#
|
807
|
-
# <note markdown="1">
|
808
|
-
# the specified criteria. It's possible that no namespaces in the
|
809
|
-
# `MaxResults` namespaces matched the specified criteria but that
|
944
|
+
# <note markdown="1"> AWS Cloud Map gets `MaxResults` namespaces and then filters them based
|
945
|
+
# on the specified criteria. It's possible that no namespaces in the
|
946
|
+
# first `MaxResults` namespaces matched the specified criteria but that
|
810
947
|
# subsequent groups of `MaxResults` namespaces do contain namespaces
|
811
948
|
# that match the criteria.
|
812
949
|
#
|
813
950
|
# </note>
|
814
951
|
#
|
815
952
|
# @option params [Integer] :max_results
|
816
|
-
# The maximum number of namespaces that you want
|
817
|
-
#
|
818
|
-
#
|
819
|
-
# namespaces.
|
953
|
+
# The maximum number of namespaces that you want AWS Cloud Map to return
|
954
|
+
# in the response to a `ListNamespaces` request. If you don't specify a
|
955
|
+
# value for `MaxResults`, AWS Cloud Map returns up to 100 namespaces.
|
820
956
|
#
|
821
957
|
# @option params [Array<Types::NamespaceFilter>] :filters
|
822
958
|
# A complex type that contains specifications for the namespaces that
|
@@ -850,7 +986,12 @@ module Aws::ServiceDiscovery
|
|
850
986
|
# resp.namespaces[0].id #=> String
|
851
987
|
# resp.namespaces[0].arn #=> String
|
852
988
|
# resp.namespaces[0].name #=> String
|
853
|
-
# resp.namespaces[0].type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE"
|
989
|
+
# resp.namespaces[0].type #=> String, one of "DNS_PUBLIC", "DNS_PRIVATE", "HTTP"
|
990
|
+
# resp.namespaces[0].description #=> String
|
991
|
+
# resp.namespaces[0].service_count #=> Integer
|
992
|
+
# resp.namespaces[0].properties.dns_properties.hosted_zone_id #=> String
|
993
|
+
# resp.namespaces[0].properties.http_properties.http_name #=> String
|
994
|
+
# resp.namespaces[0].create_date #=> Time
|
854
995
|
# resp.next_token #=> String
|
855
996
|
#
|
856
997
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespaces AWS API Documentation
|
@@ -871,18 +1012,18 @@ module Aws::ServiceDiscovery
|
|
871
1012
|
# request to get the next group of results. Specify the value of
|
872
1013
|
# `NextToken` from the previous response in the next request.
|
873
1014
|
#
|
874
|
-
# <note markdown="1">
|
875
|
-
# the specified criteria. It's possible that no operations in the
|
876
|
-
# `MaxResults` operations matched the specified criteria but that
|
1015
|
+
# <note markdown="1"> AWS Cloud Map gets `MaxResults` operations and then filters them based
|
1016
|
+
# on the specified criteria. It's possible that no operations in the
|
1017
|
+
# first `MaxResults` operations matched the specified criteria but that
|
877
1018
|
# subsequent groups of `MaxResults` operations do contain operations
|
878
1019
|
# that match the criteria.
|
879
1020
|
#
|
880
1021
|
# </note>
|
881
1022
|
#
|
882
1023
|
# @option params [Integer] :max_results
|
883
|
-
# The maximum number of items that you want
|
1024
|
+
# The maximum number of items that you want AWS Cloud Map to return in
|
884
1025
|
# the response to a `ListOperations` request. If you don't specify a
|
885
|
-
# value for `MaxResults`,
|
1026
|
+
# value for `MaxResults`, AWS Cloud Map returns up to 100 operations.
|
886
1027
|
#
|
887
1028
|
# @option params [Array<Types::OperationFilter>] :filters
|
888
1029
|
# A complex type that contains specifications for the operations that
|
@@ -937,18 +1078,18 @@ module Aws::ServiceDiscovery
|
|
937
1078
|
# request to get the next group of results. Specify the value of
|
938
1079
|
# `NextToken` from the previous response in the next request.
|
939
1080
|
#
|
940
|
-
# <note markdown="1">
|
941
|
-
# specified criteria. It's possible that no services in the
|
942
|
-
# `MaxResults` services matched the specified criteria but that
|
1081
|
+
# <note markdown="1"> AWS Cloud Map gets `MaxResults` services and then filters them based
|
1082
|
+
# on the specified criteria. It's possible that no services in the
|
1083
|
+
# first `MaxResults` services matched the specified criteria but that
|
943
1084
|
# subsequent groups of `MaxResults` services do contain services that
|
944
1085
|
# match the criteria.
|
945
1086
|
#
|
946
1087
|
# </note>
|
947
1088
|
#
|
948
1089
|
# @option params [Integer] :max_results
|
949
|
-
# The maximum number of services that you want
|
1090
|
+
# The maximum number of services that you want AWS Cloud Map to return
|
950
1091
|
# in the response to a `ListServices` request. If you don't specify a
|
951
|
-
# value for `MaxResults`,
|
1092
|
+
# value for `MaxResults`, AWS Cloud Map returns up to 100 services.
|
952
1093
|
#
|
953
1094
|
# @option params [Array<Types::ServiceFilter>] :filters
|
954
1095
|
# A complex type that contains specifications for the namespaces that
|
@@ -984,6 +1125,16 @@ module Aws::ServiceDiscovery
|
|
984
1125
|
# resp.services[0].name #=> String
|
985
1126
|
# resp.services[0].description #=> String
|
986
1127
|
# resp.services[0].instance_count #=> Integer
|
1128
|
+
# resp.services[0].dns_config.namespace_id #=> String
|
1129
|
+
# resp.services[0].dns_config.routing_policy #=> String, one of "MULTIVALUE", "WEIGHTED"
|
1130
|
+
# resp.services[0].dns_config.dns_records #=> Array
|
1131
|
+
# resp.services[0].dns_config.dns_records[0].type #=> String, one of "SRV", "A", "AAAA", "CNAME"
|
1132
|
+
# resp.services[0].dns_config.dns_records[0].ttl #=> Integer
|
1133
|
+
# resp.services[0].health_check_config.type #=> String, one of "HTTP", "HTTPS", "TCP"
|
1134
|
+
# resp.services[0].health_check_config.resource_path #=> String
|
1135
|
+
# resp.services[0].health_check_config.failure_threshold #=> Integer
|
1136
|
+
# resp.services[0].health_check_custom_config.failure_threshold #=> Integer
|
1137
|
+
# resp.services[0].create_date #=> Time
|
987
1138
|
# resp.next_token #=> String
|
988
1139
|
#
|
989
1140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices AWS API Documentation
|
@@ -995,25 +1146,26 @@ module Aws::ServiceDiscovery
|
|
995
1146
|
req.send_request(options)
|
996
1147
|
end
|
997
1148
|
|
998
|
-
# Creates or updates one or more records and optionally a
|
999
|
-
# based on the settings in a specified service. When you
|
1000
|
-
# `RegisterInstance` request,
|
1149
|
+
# Creates or updates one or more records and, optionally, creates a
|
1150
|
+
# health check based on the settings in a specified service. When you
|
1151
|
+
# submit a `RegisterInstance` request, the following occurs:
|
1001
1152
|
#
|
1002
|
-
# * For each DNS record that you define in the service specified
|
1003
|
-
# `ServiceId`,
|
1004
|
-
# associated with the corresponding namespace
|
1153
|
+
# * For each DNS record that you define in the service that is specified
|
1154
|
+
# by `ServiceId`, a record is created or updated in the hosted zone
|
1155
|
+
# that is associated with the corresponding namespace.
|
1005
1156
|
#
|
1006
|
-
# * If the service includes `HealthCheckConfig`,
|
1007
|
-
#
|
1157
|
+
# * If the service includes `HealthCheckConfig`, a health check is
|
1158
|
+
# created based on the settings in the health check configuration.
|
1008
1159
|
#
|
1009
|
-
# *
|
1160
|
+
# * The health check, if any, is associated with each of the new or
|
1161
|
+
# updated records.
|
1010
1162
|
#
|
1011
1163
|
# One `RegisterInstance` request must complete before you can submit
|
1012
1164
|
# another request and specify the same service ID and instance ID.
|
1013
1165
|
#
|
1014
1166
|
# For more information, see CreateService.
|
1015
1167
|
#
|
1016
|
-
# When
|
1168
|
+
# When AWS Cloud Map receives a DNS query for the specified DNS name, it
|
1017
1169
|
# returns the applicable value:
|
1018
1170
|
#
|
1019
1171
|
# * **If the health check is healthy**\: returns all the records
|
@@ -1025,16 +1177,16 @@ module Aws::ServiceDiscovery
|
|
1025
1177
|
# all the records
|
1026
1178
|
#
|
1027
1179
|
# For the current limit on the number of instances that you can register
|
1028
|
-
# using the same namespace and using the same service, see [
|
1029
|
-
#
|
1180
|
+
# using the same namespace and using the same service, see [AWS Cloud
|
1181
|
+
# Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
1030
1182
|
#
|
1031
1183
|
#
|
1032
1184
|
#
|
1033
|
-
# [1]: http://docs.aws.amazon.com/
|
1185
|
+
# [1]: http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
1034
1186
|
#
|
1035
1187
|
# @option params [required, String] :service_id
|
1036
1188
|
# The ID of the service that you want to use for settings for the
|
1037
|
-
#
|
1189
|
+
# instance.
|
1038
1190
|
#
|
1039
1191
|
# @option params [required, String] :instance_id
|
1040
1192
|
# An identifier that you want to associate with the instance. Note the
|
@@ -1050,9 +1202,10 @@ module Aws::ServiceDiscovery
|
|
1050
1202
|
# * To register a new instance, you must specify a value that is unique
|
1051
1203
|
# among instances that you register by using the same service.
|
1052
1204
|
#
|
1053
|
-
# * If you specify an existing `InstanceId` and `ServiceId`,
|
1054
|
-
# updates the existing records. If there's also an
|
1055
|
-
# check,
|
1205
|
+
# * If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud
|
1206
|
+
# Map updates the existing DNS records, if any. If there's also an
|
1207
|
+
# existing health check, AWS Cloud Map deletes the old health check
|
1208
|
+
# and creates a new one.
|
1056
1209
|
#
|
1057
1210
|
# <note markdown="1"> The health check isn't deleted immediately, so it will still appear
|
1058
1211
|
# for a while if you submit a `ListHealthChecks` request, for example.
|
@@ -1086,10 +1239,11 @@ module Aws::ServiceDiscovery
|
|
1086
1239
|
#
|
1087
1240
|
# ****
|
1088
1241
|
#
|
1089
|
-
# If you want
|
1090
|
-
# an Elastic Load Balancing load balancer,
|
1091
|
-
# associated with the load balancer. For
|
1092
|
-
# the DNS name, see "DNSName" in the
|
1242
|
+
# If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
1243
|
+
# that routes traffic to an Elastic Load Balancing load balancer,
|
1244
|
+
# specify the DNS name that is associated with the load balancer. For
|
1245
|
+
# information about how to get the DNS name, see "DNSName" in the
|
1246
|
+
# topic [AliasTarget][1] in the *Route 53 API Reference*.
|
1093
1247
|
#
|
1094
1248
|
# Note the following:
|
1095
1249
|
#
|
@@ -1100,8 +1254,9 @@ module Aws::ServiceDiscovery
|
|
1100
1254
|
# `RoutingPolicy` must be `WEIGHTED`.
|
1101
1255
|
#
|
1102
1256
|
# * If the service that is specified by `ServiceId` includes
|
1103
|
-
# `HealthCheckConfig` settings,
|
1104
|
-
# but it won't associate the health check with the
|
1257
|
+
# `HealthCheckConfig` settings, AWS Cloud Map will create the Route 53
|
1258
|
+
# health check, but it won't associate the health check with the
|
1259
|
+
# alias record.
|
1105
1260
|
#
|
1106
1261
|
# * Auto naming currently doesn't support creating alias records that
|
1107
1262
|
# route traffic to AWS resources other than ELB load balancers.
|
@@ -1109,6 +1264,14 @@ module Aws::ServiceDiscovery
|
|
1109
1264
|
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
1110
1265
|
# values for any of the `AWS_INSTANCE` attributes.
|
1111
1266
|
#
|
1267
|
+
# **AWS\_INIT\_HEALTH\_STATUS**
|
1268
|
+
#
|
1269
|
+
# If the service configuration includes `HealthCheckCustomConfig`, you
|
1270
|
+
# can optionally use `AWS_INIT_HEALTH_STATUS` to specify the initial
|
1271
|
+
# status of the custom health check, `HEALTHY` or `UNHEALTHY`. If you
|
1272
|
+
# don't specify a value for `AWS_INIT_HEALTH_STATUS`, the initial
|
1273
|
+
# status is `HEALTHY`.
|
1274
|
+
#
|
1112
1275
|
# **AWS\_INSTANCE\_CNAME**
|
1113
1276
|
#
|
1114
1277
|
# If the service configuration includes a CNAME record, the domain name
|
@@ -1151,9 +1314,15 @@ module Aws::ServiceDiscovery
|
|
1151
1314
|
# This value is required if you specified settings for an SRV record
|
1152
1315
|
# when you created the service.
|
1153
1316
|
#
|
1317
|
+
# **Custom attributes**
|
1154
1318
|
#
|
1319
|
+
# You can add up to 30 custom attributes. For each key-value pair, the
|
1320
|
+
# maximum length of the attribute name is 255 characters, and the
|
1321
|
+
# maximum length of the attribute value is 1,024 characters.
|
1155
1322
|
#
|
1156
|
-
#
|
1323
|
+
#
|
1324
|
+
#
|
1325
|
+
# [1]: http://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html
|
1157
1326
|
#
|
1158
1327
|
# @return [Types::RegisterInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1159
1328
|
#
|
@@ -1183,11 +1352,26 @@ module Aws::ServiceDiscovery
|
|
1183
1352
|
req.send_request(options)
|
1184
1353
|
end
|
1185
1354
|
|
1355
|
+
# Submits a request to change the health status of a custom health check
|
1356
|
+
# to healthy or unhealthy.
|
1357
|
+
#
|
1358
|
+
# You can use `UpdateInstanceCustomHealthStatus` to change the status
|
1359
|
+
# only for custom health checks, which you define using
|
1360
|
+
# `HealthCheckCustomConfig` when you create a service. You can't use it
|
1361
|
+
# to change the status for Route 53 health checks, which you define
|
1362
|
+
# using `HealthCheckConfig`.
|
1363
|
+
#
|
1364
|
+
# For more information, see HealthCheckCustomConfig.
|
1365
|
+
#
|
1186
1366
|
# @option params [required, String] :service_id
|
1367
|
+
# The ID of the service that includes the configuration for the custom
|
1368
|
+
# health check that you want to change the status for.
|
1187
1369
|
#
|
1188
1370
|
# @option params [required, String] :instance_id
|
1371
|
+
# The ID of the instance that you want to change the health status for.
|
1189
1372
|
#
|
1190
1373
|
# @option params [required, String] :status
|
1374
|
+
# The new status of the instance, `HEALTHY` or `UNHEALTHY`.
|
1191
1375
|
#
|
1192
1376
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1193
1377
|
#
|
@@ -1216,12 +1400,13 @@ module Aws::ServiceDiscovery
|
|
1216
1400
|
#
|
1217
1401
|
# * Add, update, or delete `HealthCheckConfig` for a specified service
|
1218
1402
|
#
|
1219
|
-
#
|
1220
|
-
# `
|
1221
|
-
#
|
1222
|
-
# request are
|
1403
|
+
# For public and private DNS namespaces, you must specify all
|
1404
|
+
# `DnsRecords` configurations (and, optionally, `HealthCheckConfig`)
|
1405
|
+
# that you want to appear in the updated service. Any current
|
1406
|
+
# configurations that don't appear in an `UpdateService` request are
|
1407
|
+
# deleted.
|
1223
1408
|
#
|
1224
|
-
# When you update the TTL setting for a service,
|
1409
|
+
# When you update the TTL setting for a service, AWS Cloud Map also
|
1225
1410
|
# updates the corresponding settings in all the records and health
|
1226
1411
|
# checks that were created by using the specified service.
|
1227
1412
|
#
|
@@ -1250,7 +1435,7 @@ module Aws::ServiceDiscovery
|
|
1250
1435
|
# ],
|
1251
1436
|
# },
|
1252
1437
|
# health_check_config: {
|
1253
|
-
# type: "HTTP", # accepts HTTP, HTTPS, TCP
|
1438
|
+
# type: "HTTP", # required, accepts HTTP, HTTPS, TCP
|
1254
1439
|
# resource_path: "ResourcePath",
|
1255
1440
|
# failure_threshold: 1,
|
1256
1441
|
# },
|
@@ -1283,7 +1468,7 @@ module Aws::ServiceDiscovery
|
|
1283
1468
|
params: params,
|
1284
1469
|
config: config)
|
1285
1470
|
context[:gem_name] = 'aws-sdk-servicediscovery'
|
1286
|
-
context[:gem_version] = '1.
|
1471
|
+
context[:gem_version] = '1.9.0'
|
1287
1472
|
Seahorse::Client::Request.new(handlers, context)
|
1288
1473
|
end
|
1289
1474
|
|