aws-sdk-servicediscovery 1.20.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-servicediscovery.rb +1 -1
- data/lib/aws-sdk-servicediscovery/client.rb +402 -52
- data/lib/aws-sdk-servicediscovery/resource.rb +1 -7
- data/lib/aws-sdk-servicediscovery/types.rb +214 -100
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4e64ff7ce50ce56d23b15d666811fc167ea242e18c89c9a74514d1405f9d746e
|
4
|
+
data.tar.gz: 5cf8488e8935bc78f98ed8ddf44e0247bfa70bb7d35d881514bbc3a4cb19d8e2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4450d7cb912a3a16406c392052bff114878644d998a6145ccf30b0699e611c461a114136f31c03268a796b3f2d3d8eab47ef8d9bc4f9057d625ac9a7c1704db
|
7
|
+
data.tar.gz: dfd907bed860d514c492732e031d6a2cafb930bee0aed93891d78c567d4aac5301795b7065b2173a2954ab9b3962f2bad90281ddeea58767cd52210e525286a3
|
@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:servicediscovery)
|
|
32
32
|
module Aws::ServiceDiscovery
|
33
33
|
# An API client for ServiceDiscovery. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
34
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
35
|
+
# client = Aws::ServiceDiscovery::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
40
|
#
|
41
41
|
# For details on configuring region and credentials see
|
42
42
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -229,15 +229,19 @@ module Aws::ServiceDiscovery
|
|
229
229
|
#
|
230
230
|
# @option options [String] :retry_mode ("legacy")
|
231
231
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
241
245
|
#
|
242
246
|
# @option options [String] :secret_access_key
|
243
247
|
#
|
@@ -275,8 +279,7 @@ module Aws::ServiceDiscovery
|
|
275
279
|
#
|
276
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
277
281
|
# number of seconds to wait for response data. This value can
|
278
|
-
# safely be set
|
279
|
-
# per-request on the session yielded by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
280
283
|
#
|
281
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
282
285
|
# seconds a connection is allowed to sit idle before it is
|
@@ -288,7 +291,7 @@ module Aws::ServiceDiscovery
|
|
288
291
|
# request body. This option has no effect unless the request has
|
289
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
290
293
|
# disables this behaviour. This value can safely be set per
|
291
|
-
# request on the session
|
294
|
+
# request on the session.
|
292
295
|
#
|
293
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
294
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -325,7 +328,7 @@ module Aws::ServiceDiscovery
|
|
325
328
|
#
|
326
329
|
#
|
327
330
|
#
|
328
|
-
# [1]:
|
331
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
329
332
|
#
|
330
333
|
# @option params [required, String] :name
|
331
334
|
# The name that you want to assign to this namespace.
|
@@ -377,7 +380,7 @@ module Aws::ServiceDiscovery
|
|
377
380
|
#
|
378
381
|
#
|
379
382
|
#
|
380
|
-
# [1]:
|
383
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
381
384
|
#
|
382
385
|
# @option params [required, String] :name
|
383
386
|
# The name that you want to assign to this namespace. When you create a
|
@@ -404,6 +407,22 @@ module Aws::ServiceDiscovery
|
|
404
407
|
#
|
405
408
|
# * {Types::CreatePrivateDnsNamespaceResponse#operation_id #operation_id} => String
|
406
409
|
#
|
410
|
+
#
|
411
|
+
# @example Example: Example: Create private DNS namespace
|
412
|
+
#
|
413
|
+
# # Example: Create private DNS namespace
|
414
|
+
#
|
415
|
+
# resp = client.create_private_dns_namespace({
|
416
|
+
# creator_request_id: "eedd6892-50f3-41b2-8af9-611d6e1d1a8c",
|
417
|
+
# name: "example.com",
|
418
|
+
# vpc: "vpc-1c56417b",
|
419
|
+
# })
|
420
|
+
#
|
421
|
+
# resp.to_h outputs the following:
|
422
|
+
# {
|
423
|
+
# operation_id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
|
424
|
+
# }
|
425
|
+
#
|
407
426
|
# @example Request syntax with placeholder values
|
408
427
|
#
|
409
428
|
# resp = client.create_private_dns_namespace({
|
@@ -436,7 +455,7 @@ module Aws::ServiceDiscovery
|
|
436
455
|
#
|
437
456
|
#
|
438
457
|
#
|
439
|
-
# [1]:
|
458
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
440
459
|
#
|
441
460
|
# @option params [required, String] :name
|
442
461
|
# The name that you want to assign to this namespace.
|
@@ -496,21 +515,40 @@ module Aws::ServiceDiscovery
|
|
496
515
|
#
|
497
516
|
# * Optionally, a health check
|
498
517
|
#
|
499
|
-
# After you create the service, you can submit a RegisterInstance
|
518
|
+
# After you create the service, you can submit a [RegisterInstance][1]
|
500
519
|
# request, and AWS Cloud Map uses the values in the configuration to
|
501
520
|
# create the specified entities.
|
502
521
|
#
|
503
522
|
# For the current limit on the number of instances that you can register
|
504
523
|
# using the same namespace and using the same service, see [AWS Cloud
|
505
|
-
# Map Limits][
|
524
|
+
# Map Limits][2] in the *AWS Cloud Map Developer Guide*.
|
506
525
|
#
|
507
526
|
#
|
508
527
|
#
|
509
|
-
# [1]:
|
528
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
529
|
+
# [2]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
510
530
|
#
|
511
531
|
# @option params [required, String] :name
|
512
532
|
# The name that you want to assign to the service.
|
513
533
|
#
|
534
|
+
# If you want AWS Cloud Map to create an SRV record when you register an
|
535
|
+
# instance, and if you're using a system that requires a specific SRV
|
536
|
+
# format, such as [HAProxy][1], specify the following for `Name`\:
|
537
|
+
#
|
538
|
+
# * Start the name with an underscore (\_), such as `_exampleservice`
|
539
|
+
#
|
540
|
+
# * End the name with *.\_protocol*, such as `._tcp`
|
541
|
+
#
|
542
|
+
# When you register an instance, AWS Cloud Map creates an SRV record and
|
543
|
+
# assigns a name to the record by concatenating the service name and the
|
544
|
+
# namespace name, for example:
|
545
|
+
#
|
546
|
+
# `_exampleservice._tcp.example.com`
|
547
|
+
#
|
548
|
+
#
|
549
|
+
#
|
550
|
+
# [1]: http://www.haproxy.org/
|
551
|
+
#
|
514
552
|
# @option params [String] :namespace_id
|
515
553
|
# The ID of the namespace that you want to use to create the service.
|
516
554
|
#
|
@@ -532,10 +570,10 @@ module Aws::ServiceDiscovery
|
|
532
570
|
# instance.
|
533
571
|
#
|
534
572
|
# @option params [Types::HealthCheckConfig] :health_check_config
|
535
|
-
# *Public DNS namespaces only.* A complex type that contains
|
536
|
-
# for an optional Route 53 health check. If you specify
|
537
|
-
# health check, AWS Cloud Map associates the health check
|
538
|
-
# Route 53 DNS records that you specify in `DnsConfig`.
|
573
|
+
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
574
|
+
# settings for an optional Route 53 health check. If you specify
|
575
|
+
# settings for a health check, AWS Cloud Map associates the health check
|
576
|
+
# with all the Route 53 DNS records that you specify in `DnsConfig`.
|
539
577
|
#
|
540
578
|
# If you specify a health check configuration, you can specify either
|
541
579
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -554,10 +592,56 @@ module Aws::ServiceDiscovery
|
|
554
592
|
# If you specify a health check configuration, you can specify either
|
555
593
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
556
594
|
#
|
595
|
+
# You can't add, update, or delete a `HealthCheckCustomConfig`
|
596
|
+
# configuration from an existing service.
|
597
|
+
#
|
557
598
|
# @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
558
599
|
#
|
559
600
|
# * {Types::CreateServiceResponse#service #service} => Types::Service
|
560
601
|
#
|
602
|
+
#
|
603
|
+
# @example Example: Example: Create service
|
604
|
+
#
|
605
|
+
# # Example: Create service
|
606
|
+
#
|
607
|
+
# resp = client.create_service({
|
608
|
+
# creator_request_id: "567c1193-6b00-4308-bd57-ad38a8822d25",
|
609
|
+
# dns_config: {
|
610
|
+
# dns_records: [
|
611
|
+
# {
|
612
|
+
# ttl: 60,
|
613
|
+
# type: "A",
|
614
|
+
# },
|
615
|
+
# ],
|
616
|
+
# namespace_id: "ns-ylexjili4cdxy3xm",
|
617
|
+
# routing_policy: "MULTIVALUE",
|
618
|
+
# },
|
619
|
+
# name: "myservice",
|
620
|
+
# namespace_id: "ns-ylexjili4cdxy3xm",
|
621
|
+
# })
|
622
|
+
#
|
623
|
+
# resp.to_h outputs the following:
|
624
|
+
# {
|
625
|
+
# service: {
|
626
|
+
# arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
|
627
|
+
# create_date: Time.parse(1587081768.334),
|
628
|
+
# creator_request_id: "567c1193-6b00-4308-bd57-ad38a8822d25",
|
629
|
+
# dns_config: {
|
630
|
+
# dns_records: [
|
631
|
+
# {
|
632
|
+
# ttl: 60,
|
633
|
+
# type: "A",
|
634
|
+
# },
|
635
|
+
# ],
|
636
|
+
# namespace_id: "ns-ylexjili4cdxy3xm",
|
637
|
+
# routing_policy: "MULTIVALUE",
|
638
|
+
# },
|
639
|
+
# id: "srv-p5zdwlg5uvvzjita",
|
640
|
+
# name: "myservice",
|
641
|
+
# namespace_id: "ns-ylexjili4cdxy3xm",
|
642
|
+
# },
|
643
|
+
# }
|
644
|
+
#
|
561
645
|
# @example Request syntax with placeholder values
|
562
646
|
#
|
563
647
|
# resp = client.create_service({
|
@@ -624,6 +708,20 @@ module Aws::ServiceDiscovery
|
|
624
708
|
#
|
625
709
|
# * {Types::DeleteNamespaceResponse#operation_id #operation_id} => String
|
626
710
|
#
|
711
|
+
#
|
712
|
+
# @example Example: Example: Delete namespace
|
713
|
+
#
|
714
|
+
# # Example: Delete namespace
|
715
|
+
#
|
716
|
+
# resp = client.delete_namespace({
|
717
|
+
# id: "ns-ylexjili4cdxy3xm",
|
718
|
+
# })
|
719
|
+
#
|
720
|
+
# resp.to_h outputs the following:
|
721
|
+
# {
|
722
|
+
# operation_id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk",
|
723
|
+
# }
|
724
|
+
#
|
627
725
|
# @example Request syntax with placeholder values
|
628
726
|
#
|
629
727
|
# resp = client.delete_namespace({
|
@@ -651,6 +749,19 @@ module Aws::ServiceDiscovery
|
|
651
749
|
#
|
652
750
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
653
751
|
#
|
752
|
+
#
|
753
|
+
# @example Example: Example: Delete service
|
754
|
+
#
|
755
|
+
# # Example: Delete service
|
756
|
+
#
|
757
|
+
# resp = client.delete_service({
|
758
|
+
# id: "srv-p5zdwlg5uvvzjita",
|
759
|
+
# })
|
760
|
+
#
|
761
|
+
# resp.to_h outputs the following:
|
762
|
+
# {
|
763
|
+
# }
|
764
|
+
#
|
654
765
|
# @example Request syntax with placeholder values
|
655
766
|
#
|
656
767
|
# resp = client.delete_service({
|
@@ -673,12 +784,32 @@ module Aws::ServiceDiscovery
|
|
673
784
|
# The ID of the service that the instance is associated with.
|
674
785
|
#
|
675
786
|
# @option params [required, String] :instance_id
|
676
|
-
# The value that you specified for `Id` in the RegisterInstance
|
787
|
+
# The value that you specified for `Id` in the [RegisterInstance][1]
|
788
|
+
# request.
|
789
|
+
#
|
790
|
+
#
|
791
|
+
#
|
792
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
677
793
|
#
|
678
794
|
# @return [Types::DeregisterInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
679
795
|
#
|
680
796
|
# * {Types::DeregisterInstanceResponse#operation_id #operation_id} => String
|
681
797
|
#
|
798
|
+
#
|
799
|
+
# @example Example: Example: Deregister a service instance
|
800
|
+
#
|
801
|
+
# # Example: Deregister a service instance
|
802
|
+
#
|
803
|
+
# resp = client.deregister_instance({
|
804
|
+
# instance_id: "myservice-53",
|
805
|
+
# service_id: "srv-p5zdwlg5uvvzjita",
|
806
|
+
# })
|
807
|
+
#
|
808
|
+
# resp.to_h outputs the following:
|
809
|
+
# {
|
810
|
+
# operation_id: "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq",
|
811
|
+
# }
|
812
|
+
#
|
682
813
|
# @example Request syntax with placeholder values
|
683
814
|
#
|
684
815
|
# resp = client.deregister_instance({
|
@@ -700,6 +831,9 @@ module Aws::ServiceDiscovery
|
|
700
831
|
end
|
701
832
|
|
702
833
|
# Discovers registered instances for a specified namespace and service.
|
834
|
+
# You can use `DiscoverInstances` to discover instances for any type of
|
835
|
+
# namespace. For public and private DNS namespaces, you can also use DNS
|
836
|
+
# queries to discover instances.
|
703
837
|
#
|
704
838
|
# @option params [required, String] :namespace_name
|
705
839
|
# The name of the namespace that you specified when you registered the
|
@@ -710,9 +844,10 @@ module Aws::ServiceDiscovery
|
|
710
844
|
# instance.
|
711
845
|
#
|
712
846
|
# @option params [Integer] :max_results
|
713
|
-
# The maximum number of instances that you want Cloud Map to return
|
714
|
-
# the response to a `DiscoverInstances` request. If you don't
|
715
|
-
# value for `MaxResults`, Cloud Map returns up to 100
|
847
|
+
# The maximum number of instances that you want AWS Cloud Map to return
|
848
|
+
# in the response to a `DiscoverInstances` request. If you don't
|
849
|
+
# specify a value for `MaxResults`, AWS Cloud Map returns up to 100
|
850
|
+
# instances.
|
716
851
|
#
|
717
852
|
# @option params [Hash<String,String>] :query_parameters
|
718
853
|
# A string map that contains attributes with values that you can use to
|
@@ -727,6 +862,34 @@ module Aws::ServiceDiscovery
|
|
727
862
|
#
|
728
863
|
# * {Types::DiscoverInstancesResponse#instances #instances} => Array<Types::HttpInstanceSummary>
|
729
864
|
#
|
865
|
+
#
|
866
|
+
# @example Example: Example: Discover registered instances
|
867
|
+
#
|
868
|
+
# # Example: Discover registered instances
|
869
|
+
#
|
870
|
+
# resp = client.discover_instances({
|
871
|
+
# health_status: "ALL",
|
872
|
+
# max_results: 10,
|
873
|
+
# namespace_name: "example.com",
|
874
|
+
# service_name: "myservice",
|
875
|
+
# })
|
876
|
+
#
|
877
|
+
# resp.to_h outputs the following:
|
878
|
+
# {
|
879
|
+
# instances: [
|
880
|
+
# {
|
881
|
+
# attributes: {
|
882
|
+
# "AWS_INSTANCE_IPV4" => "172.2.1.3",
|
883
|
+
# "AWS_INSTANCE_PORT" => "808",
|
884
|
+
# },
|
885
|
+
# health_status: "UNKNOWN",
|
886
|
+
# instance_id: "myservice-53",
|
887
|
+
# namespace_name: "example.com",
|
888
|
+
# service_name: "myservice",
|
889
|
+
# },
|
890
|
+
# ],
|
891
|
+
# }
|
892
|
+
#
|
730
893
|
# @example Request syntax with placeholder values
|
731
894
|
#
|
732
895
|
# resp = client.discover_instances({
|
@@ -812,10 +975,14 @@ module Aws::ServiceDiscovery
|
|
812
975
|
# all the instances that are associated with the specified service.
|
813
976
|
#
|
814
977
|
# <note markdown="1"> To get the IDs for the instances that you've registered by using a
|
815
|
-
# specified service, submit a ListInstances request.
|
978
|
+
# specified service, submit a [ListInstances][1] request.
|
816
979
|
#
|
817
980
|
# </note>
|
818
981
|
#
|
982
|
+
#
|
983
|
+
#
|
984
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html
|
985
|
+
#
|
819
986
|
# @option params [Integer] :max_results
|
820
987
|
# The maximum number of instances that you want AWS Cloud Map to return
|
821
988
|
# in the response to a `GetInstancesHealthStatus` request. If you don't
|
@@ -835,6 +1002,8 @@ module Aws::ServiceDiscovery
|
|
835
1002
|
# * {Types::GetInstancesHealthStatusResponse#status #status} => Hash<String,String>
|
836
1003
|
# * {Types::GetInstancesHealthStatusResponse#next_token #next_token} => String
|
837
1004
|
#
|
1005
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1006
|
+
#
|
838
1007
|
# @example Request syntax with placeholder values
|
839
1008
|
#
|
840
1009
|
# resp = client.get_instances_health_status({
|
@@ -900,10 +1069,14 @@ module Aws::ServiceDiscovery
|
|
900
1069
|
# the response, such as a `CreateService` request.
|
901
1070
|
#
|
902
1071
|
# <note markdown="1"> To get a list of operations that match specified criteria, see
|
903
|
-
# ListOperations.
|
1072
|
+
# [ListOperations][1].
|
904
1073
|
#
|
905
1074
|
# </note>
|
906
1075
|
#
|
1076
|
+
#
|
1077
|
+
#
|
1078
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html
|
1079
|
+
#
|
907
1080
|
# @option params [required, String] :operation_id
|
908
1081
|
# The ID of the operation that you want to get more information about.
|
909
1082
|
#
|
@@ -911,6 +1084,29 @@ module Aws::ServiceDiscovery
|
|
911
1084
|
#
|
912
1085
|
# * {Types::GetOperationResponse#operation #operation} => Types::Operation
|
913
1086
|
#
|
1087
|
+
#
|
1088
|
+
# @example Example: Example: Get operation result
|
1089
|
+
#
|
1090
|
+
# # Example: Get operation result
|
1091
|
+
#
|
1092
|
+
# resp = client.get_operation({
|
1093
|
+
# operation_id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
|
1094
|
+
# })
|
1095
|
+
#
|
1096
|
+
# resp.to_h outputs the following:
|
1097
|
+
# {
|
1098
|
+
# operation: {
|
1099
|
+
# create_date: Time.parse(1587055860.121),
|
1100
|
+
# id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
|
1101
|
+
# status: "SUCCESS",
|
1102
|
+
# targets: {
|
1103
|
+
# "NAMESPACE" => "ns-ylexjili4cdxy3xm",
|
1104
|
+
# },
|
1105
|
+
# type: "CREATE_NAMESPACE",
|
1106
|
+
# update_date: Time.parse(1587055900.469),
|
1107
|
+
# },
|
1108
|
+
# }
|
1109
|
+
#
|
914
1110
|
# @example Request syntax with placeholder values
|
915
1111
|
#
|
916
1112
|
# resp = client.get_operation({
|
@@ -1006,6 +1202,30 @@ module Aws::ServiceDiscovery
|
|
1006
1202
|
# * {Types::ListInstancesResponse#instances #instances} => Array<Types::InstanceSummary>
|
1007
1203
|
# * {Types::ListInstancesResponse#next_token #next_token} => String
|
1008
1204
|
#
|
1205
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1206
|
+
#
|
1207
|
+
#
|
1208
|
+
# @example Example: Example: List service instances
|
1209
|
+
#
|
1210
|
+
# # Example: List service instances
|
1211
|
+
#
|
1212
|
+
# resp = client.list_instances({
|
1213
|
+
# service_id: "srv-qzpwvt2tfqcegapy",
|
1214
|
+
# })
|
1215
|
+
#
|
1216
|
+
# resp.to_h outputs the following:
|
1217
|
+
# {
|
1218
|
+
# instances: [
|
1219
|
+
# {
|
1220
|
+
# attributes: {
|
1221
|
+
# "AWS_INSTANCE_IPV4" => "172.2.1.3",
|
1222
|
+
# "AWS_INSTANCE_PORT" => "808",
|
1223
|
+
# },
|
1224
|
+
# id: "i-06bdabbae60f65a4e",
|
1225
|
+
# },
|
1226
|
+
# ],
|
1227
|
+
# }
|
1228
|
+
#
|
1009
1229
|
# @example Request syntax with placeholder values
|
1010
1230
|
#
|
1011
1231
|
# resp = client.list_instances({
|
@@ -1066,6 +1286,67 @@ module Aws::ServiceDiscovery
|
|
1066
1286
|
# * {Types::ListNamespacesResponse#namespaces #namespaces} => Array<Types::NamespaceSummary>
|
1067
1287
|
# * {Types::ListNamespacesResponse#next_token #next_token} => String
|
1068
1288
|
#
|
1289
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1290
|
+
#
|
1291
|
+
#
|
1292
|
+
# @example Example: Example: List namespaces
|
1293
|
+
#
|
1294
|
+
# # Example: List namespaces
|
1295
|
+
#
|
1296
|
+
# resp = client.list_namespaces({
|
1297
|
+
# })
|
1298
|
+
#
|
1299
|
+
# resp.to_h outputs the following:
|
1300
|
+
# {
|
1301
|
+
# namespaces: [
|
1302
|
+
# {
|
1303
|
+
# arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
|
1304
|
+
# create_date: Time.parse(1585354387.357),
|
1305
|
+
# id: "ns-a3ccy2e7e3a7rile",
|
1306
|
+
# name: "local",
|
1307
|
+
# properties: {
|
1308
|
+
# dns_properties: {
|
1309
|
+
# hosted_zone_id: "Z06752353VBUDTC32S84S",
|
1310
|
+
# },
|
1311
|
+
# http_properties: {
|
1312
|
+
# http_name: "local",
|
1313
|
+
# },
|
1314
|
+
# },
|
1315
|
+
# type: "DNS_PRIVATE",
|
1316
|
+
# },
|
1317
|
+
# {
|
1318
|
+
# arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
|
1319
|
+
# create_date: Time.parse(1586468974.698),
|
1320
|
+
# description: "My second namespace",
|
1321
|
+
# id: "ns-pocfyjtrsmwtvcxx",
|
1322
|
+
# name: "My-second-namespace",
|
1323
|
+
# properties: {
|
1324
|
+
# dns_properties: {
|
1325
|
+
# },
|
1326
|
+
# http_properties: {
|
1327
|
+
# http_name: "My-second-namespace",
|
1328
|
+
# },
|
1329
|
+
# },
|
1330
|
+
# type: "HTTP",
|
1331
|
+
# },
|
1332
|
+
# {
|
1333
|
+
# arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
|
1334
|
+
# create_date: Time.parse(1587055896.798),
|
1335
|
+
# id: "ns-ylexjili4cdxy3xm",
|
1336
|
+
# name: "example.com",
|
1337
|
+
# properties: {
|
1338
|
+
# dns_properties: {
|
1339
|
+
# hosted_zone_id: "Z09983722P0QME1B3KC8I",
|
1340
|
+
# },
|
1341
|
+
# http_properties: {
|
1342
|
+
# http_name: "example.com",
|
1343
|
+
# },
|
1344
|
+
# },
|
1345
|
+
# type: "DNS_PRIVATE",
|
1346
|
+
# },
|
1347
|
+
# ],
|
1348
|
+
# }
|
1349
|
+
#
|
1069
1350
|
# @example Request syntax with placeholder values
|
1070
1351
|
#
|
1071
1352
|
# resp = client.list_namespaces({
|
@@ -1138,6 +1419,8 @@ module Aws::ServiceDiscovery
|
|
1138
1419
|
# * {Types::ListOperationsResponse#operations #operations} => Array<Types::OperationSummary>
|
1139
1420
|
# * {Types::ListOperationsResponse#next_token #next_token} => String
|
1140
1421
|
#
|
1422
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1423
|
+
#
|
1141
1424
|
# @example Request syntax with placeholder values
|
1142
1425
|
#
|
1143
1426
|
# resp = client.list_operations({
|
@@ -1203,6 +1486,37 @@ module Aws::ServiceDiscovery
|
|
1203
1486
|
# * {Types::ListServicesResponse#services #services} => Array<Types::ServiceSummary>
|
1204
1487
|
# * {Types::ListServicesResponse#next_token #next_token} => String
|
1205
1488
|
#
|
1489
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1490
|
+
#
|
1491
|
+
#
|
1492
|
+
# @example Example: Example: List services
|
1493
|
+
#
|
1494
|
+
# # Example: List services
|
1495
|
+
#
|
1496
|
+
# resp = client.list_services({
|
1497
|
+
# })
|
1498
|
+
#
|
1499
|
+
# resp.to_h outputs the following:
|
1500
|
+
# {
|
1501
|
+
# services: [
|
1502
|
+
# {
|
1503
|
+
# arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
|
1504
|
+
# create_date: Time.parse(1587081768.334),
|
1505
|
+
# dns_config: {
|
1506
|
+
# dns_records: [
|
1507
|
+
# {
|
1508
|
+
# ttl: 60,
|
1509
|
+
# type: "A",
|
1510
|
+
# },
|
1511
|
+
# ],
|
1512
|
+
# routing_policy: "MULTIVALUE",
|
1513
|
+
# },
|
1514
|
+
# id: "srv-p5zdwlg5uvvzjita",
|
1515
|
+
# name: "myservice",
|
1516
|
+
# },
|
1517
|
+
# ],
|
1518
|
+
# }
|
1519
|
+
#
|
1206
1520
|
# @example Request syntax with placeholder values
|
1207
1521
|
#
|
1208
1522
|
# resp = client.list_services({
|
@@ -1263,7 +1577,7 @@ module Aws::ServiceDiscovery
|
|
1263
1577
|
# One `RegisterInstance` request must complete before you can submit
|
1264
1578
|
# another request and specify the same service ID and instance ID.
|
1265
1579
|
#
|
1266
|
-
# For more information, see CreateService.
|
1580
|
+
# For more information, see [CreateService][1].
|
1267
1581
|
#
|
1268
1582
|
# When AWS Cloud Map receives a DNS query for the specified DNS name, it
|
1269
1583
|
# returns the applicable value:
|
@@ -1278,11 +1592,12 @@ module Aws::ServiceDiscovery
|
|
1278
1592
|
#
|
1279
1593
|
# For the current limit on the number of instances that you can register
|
1280
1594
|
# using the same namespace and using the same service, see [AWS Cloud
|
1281
|
-
# Map Limits][
|
1595
|
+
# Map Limits][2] in the *AWS Cloud Map Developer Guide*.
|
1282
1596
|
#
|
1283
1597
|
#
|
1284
1598
|
#
|
1285
|
-
# [1]:
|
1599
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
|
1600
|
+
# [2]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html
|
1286
1601
|
#
|
1287
1602
|
# @option params [required, String] :service_id
|
1288
1603
|
# The ID of the service that you want to use for settings for the
|
@@ -1295,7 +1610,7 @@ module Aws::ServiceDiscovery
|
|
1295
1610
|
# * If the service that is specified by `ServiceId` includes settings
|
1296
1611
|
# for an SRV record, the value of `InstanceId` is automatically
|
1297
1612
|
# included as part of the value for the SRV record. For more
|
1298
|
-
# information, see DnsRecord
|
1613
|
+
# information, see [DnsRecord > Type][1].
|
1299
1614
|
#
|
1300
1615
|
# * You can use this value to update an existing instance.
|
1301
1616
|
#
|
@@ -1312,6 +1627,10 @@ module Aws::ServiceDiscovery
|
|
1312
1627
|
#
|
1313
1628
|
# </note>
|
1314
1629
|
#
|
1630
|
+
#
|
1631
|
+
#
|
1632
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type
|
1633
|
+
#
|
1315
1634
|
# @option params [String] :creator_request_id
|
1316
1635
|
# A unique string that identifies the request and that allows failed
|
1317
1636
|
# `RegisterInstance` requests to be retried without the risk of
|
@@ -1411,8 +1730,8 @@ module Aws::ServiceDiscovery
|
|
1411
1730
|
# If the service includes `HealthCheckConfig`, the port on the endpoint
|
1412
1731
|
# that you want Route 53 to send requests to.
|
1413
1732
|
#
|
1414
|
-
# This value is required if you specified settings for an SRV record
|
1415
|
-
# when you created the service.
|
1733
|
+
# This value is required if you specified settings for an SRV record or
|
1734
|
+
# a Route 53 health check when you created the service.
|
1416
1735
|
#
|
1417
1736
|
# **Custom attributes**
|
1418
1737
|
#
|
@@ -1422,12 +1741,32 @@ module Aws::ServiceDiscovery
|
|
1422
1741
|
#
|
1423
1742
|
#
|
1424
1743
|
#
|
1425
|
-
# [1]:
|
1744
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html
|
1426
1745
|
#
|
1427
1746
|
# @return [Types::RegisterInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1428
1747
|
#
|
1429
1748
|
# * {Types::RegisterInstanceResponse#operation_id #operation_id} => String
|
1430
1749
|
#
|
1750
|
+
#
|
1751
|
+
# @example Example: Example: Register Instance
|
1752
|
+
#
|
1753
|
+
# # Example: Register Instance
|
1754
|
+
#
|
1755
|
+
# resp = client.register_instance({
|
1756
|
+
# attributes: {
|
1757
|
+
# "AWS_INSTANCE_IPV4" => "172.2.1.3",
|
1758
|
+
# "AWS_INSTANCE_PORT" => "808",
|
1759
|
+
# },
|
1760
|
+
# creator_request_id: "7a48a98a-72e6-4849-bfa7-1a458e030d7b",
|
1761
|
+
# instance_id: "myservice-53",
|
1762
|
+
# service_id: "srv-p5zdwlg5uvvzjita",
|
1763
|
+
# })
|
1764
|
+
#
|
1765
|
+
# resp.to_h outputs the following:
|
1766
|
+
# {
|
1767
|
+
# operation_id: "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7",
|
1768
|
+
# }
|
1769
|
+
#
|
1431
1770
|
# @example Request syntax with placeholder values
|
1432
1771
|
#
|
1433
1772
|
# resp = client.register_instance({
|
@@ -1461,7 +1800,11 @@ module Aws::ServiceDiscovery
|
|
1461
1800
|
# to change the status for Route 53 health checks, which you define
|
1462
1801
|
# using `HealthCheckConfig`.
|
1463
1802
|
#
|
1464
|
-
# For more information, see HealthCheckCustomConfig.
|
1803
|
+
# For more information, see [HealthCheckCustomConfig][1].
|
1804
|
+
#
|
1805
|
+
#
|
1806
|
+
#
|
1807
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
|
1465
1808
|
#
|
1466
1809
|
# @option params [required, String] :service_id
|
1467
1810
|
# The ID of the service that includes the configuration for the custom
|
@@ -1494,21 +1837,28 @@ module Aws::ServiceDiscovery
|
|
1494
1837
|
|
1495
1838
|
# Submits a request to perform the following operations:
|
1496
1839
|
#
|
1497
|
-
# * Add or delete `DnsRecords` configurations
|
1498
|
-
#
|
1499
1840
|
# * Update the TTL setting for existing `DnsRecords` configurations
|
1500
1841
|
#
|
1501
1842
|
# * Add, update, or delete `HealthCheckConfig` for a specified service
|
1502
1843
|
#
|
1503
|
-
#
|
1504
|
-
#
|
1505
|
-
#
|
1506
|
-
#
|
1507
|
-
#
|
1844
|
+
# <note markdown="1"> You can't add, update, or delete a `HealthCheckCustomConfig`
|
1845
|
+
# configuration.
|
1846
|
+
#
|
1847
|
+
# </note>
|
1848
|
+
#
|
1849
|
+
# For public and private DNS namespaces, note the following:
|
1850
|
+
#
|
1851
|
+
# * If you omit any existing `DnsRecords` or `HealthCheckConfig`
|
1852
|
+
# configurations from an `UpdateService` request, the configurations
|
1853
|
+
# are deleted from the service.
|
1854
|
+
#
|
1855
|
+
# * If you omit an existing `HealthCheckCustomConfig` configuration from
|
1856
|
+
# an `UpdateService` request, the configuration is not deleted from
|
1857
|
+
# the service.
|
1508
1858
|
#
|
1509
|
-
# When you update
|
1510
|
-
#
|
1511
|
-
#
|
1859
|
+
# When you update settings for a service, AWS Cloud Map also updates the
|
1860
|
+
# corresponding settings in all the records and health checks that were
|
1861
|
+
# created by using the specified service.
|
1512
1862
|
#
|
1513
1863
|
# @option params [required, String] :id
|
1514
1864
|
# The ID of the service that you want to update.
|
@@ -1568,7 +1918,7 @@ module Aws::ServiceDiscovery
|
|
1568
1918
|
params: params,
|
1569
1919
|
config: config)
|
1570
1920
|
context[:gem_name] = 'aws-sdk-servicediscovery'
|
1571
|
-
context[:gem_version] = '1.
|
1921
|
+
context[:gem_version] = '1.21.0'
|
1572
1922
|
Seahorse::Client::Request.new(handlers, context)
|
1573
1923
|
end
|
1574
1924
|
|