aws-sdk-opsworkscm 1.29.0 → 1.34.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 790188e08921971a8ae747c8f757bcd6497280eb
4
- data.tar.gz: 9b7cc81be9d1abb27d55b1ba8720bacee93c4d18
2
+ SHA256:
3
+ metadata.gz: 0f8a574bed43a7efeeaf9c5516454d5f7223fbe5d0635de52e7a72991e41adea
4
+ data.tar.gz: 626c3073290213f3fe4b8796a03196f3d91ba531e7b9ad134c20409544ce6cd9
5
5
  SHA512:
6
- metadata.gz: 91027c2bbfb30b49b7fee47e96f36841fb8c11a26f6b8721535d5b9454fc43c02f4d6ac38e681eea076dafb15eedfda0a6d1c97d986877fde8274e213edfc913
7
- data.tar.gz: 9943c328d77b47a15ca89b6768bcf6f066537a4b2c04181841d0e2aaccbff49d0c5985cc5704f239be9c7022e107aa7c457d436c18aa29f1b699edb2b423cbb2
6
+ metadata.gz: 60d6f5064ec8c52a606293aee355e3b2e55fd5e3fe0fb03d9ef0d8ffc09922f259e8500413e5e36a16e7d01e122376b8ec85c51c74f6ea58b5efffe87e1b4047
7
+ data.tar.gz: 56287e1d78f3c50a099babcaf6a220c85a006b65cb069d021cdf3aacb4377608617ffabb835ecf7cf42cf3db43e66c24e70a6254d6ded8791864557c998707bf
@@ -46,6 +46,6 @@ require_relative 'aws-sdk-opsworkscm/customizations'
46
46
  # @service
47
47
  module Aws::OpsWorksCM
48
48
 
49
- GEM_VERSION = '1.29.0'
49
+ GEM_VERSION = '1.34.0'
50
50
 
51
51
  end
@@ -30,14 +30,16 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:opsworkscm)
31
31
 
32
32
  module Aws::OpsWorksCM
33
- # An API client for OpsWorksCM. To construct a client, you need to configure a +:region+ and +:credentials+.
33
+ # An API client for OpsWorksCM. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
34
35
  # client = Aws::OpsWorksCM::Client.new(
35
36
  # region: region_name,
36
37
  # credentials: credentials,
37
38
  # # ...
38
39
  # )
40
+ #
39
41
  # For details on configuring region and credentials see
40
- # the {developer-guide}[https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html].
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
41
43
  #
42
44
  # See {#initialize} for a full list of supported configuration options.
43
45
  class Client < Seahorse::Client::Base
@@ -103,7 +105,7 @@ module Aws::OpsWorksCM
103
105
  # @option options [required, String] :region
104
106
  # The AWS region to connect to. The configured `:region` is
105
107
  # used to determine the service `:endpoint`. When not passed,
106
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
107
109
  #
108
110
  # * `Aws.config[:region]`
109
111
  # * `ENV['AWS_REGION']`
@@ -118,6 +120,12 @@ module Aws::OpsWorksCM
118
120
  # When set to `true`, a thread polling for endpoints will be running in
119
121
  # the background every 60 secs (default). Defaults to `false`.
120
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
121
129
  # @option options [Boolean] :client_side_monitoring (false)
122
130
  # When `true`, client-side metrics will be collected for all API requests from
123
131
  # this client.
@@ -142,6 +150,10 @@ module Aws::OpsWorksCM
142
150
  # When `true`, an attempt is made to coerce request parameters into
143
151
  # the required types.
144
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
145
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
146
158
  # Set to true to disable SDK automatically adding host prefix
147
159
  # to default service endpoint when available.
@@ -149,7 +161,7 @@ module Aws::OpsWorksCM
149
161
  # @option options [String] :endpoint
150
162
  # The client endpoint is normally constructed from the `:region`
151
163
  # option. You should only configure an `:endpoint` when connecting
152
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
153
165
  #
154
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
155
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -164,7 +176,7 @@ module Aws::OpsWorksCM
164
176
  # requests fetching endpoints information. Defaults to 60 sec.
165
177
  #
166
178
  # @option options [Boolean] :endpoint_discovery (false)
167
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
168
180
  #
169
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
170
182
  # The log formatter.
@@ -176,15 +188,29 @@ module Aws::OpsWorksCM
176
188
  # The Logger instance to send log messages to. If this option
177
189
  # is not set, logging will be disabled.
178
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
179
197
  # @option options [String] :profile ("default")
180
198
  # Used when loading credentials from the shared credentials file
181
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
182
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
183
205
  # @option options [Float] :retry_base_delay (0.3)
184
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
185
208
  #
186
209
  # @option options [Symbol] :retry_jitter (:none)
187
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
188
214
  #
189
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
190
216
  #
@@ -192,11 +218,30 @@ module Aws::OpsWorksCM
192
218
  # The maximum number of times to retry failed requests. Only
193
219
  # ~ 500 level server errors and certain ~ 400 level client errors
194
220
  # are retried. Generally, these are throttling errors, data
195
- # checksum errors, networking errors, timeout errors and auth
196
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
197
224
  #
198
225
  # @option options [Integer] :retry_max_delay (0)
199
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
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
+ #
200
245
  #
201
246
  # @option options [String] :secret_access_key
202
247
  #
@@ -234,8 +279,7 @@ module Aws::OpsWorksCM
234
279
  #
235
280
  # @option options [Integer] :http_read_timeout (60) The default
236
281
  # number of seconds to wait for response data. This value can
237
- # safely be set
238
- # per-request on the session yielded by {#session_for}.
282
+ # safely be set per-request on the session.
239
283
  #
240
284
  # @option options [Float] :http_idle_timeout (5) The number of
241
285
  # seconds a connection is allowed to sit idle before it is
@@ -247,7 +291,7 @@ module Aws::OpsWorksCM
247
291
  # request body. This option has no effect unless the request has
248
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
249
293
  # disables this behaviour. This value can safely be set per
250
- # request on the session yielded by {#session_for}.
294
+ # request on the session.
251
295
  #
252
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
253
297
  # HTTP debug output will be sent to the `:logger`.
@@ -494,22 +538,21 @@ module Aws::OpsWorksCM
494
538
  # Valid values are `true` or `false`. The default value is `true`.
495
539
  #
496
540
  # @option params [String] :custom_domain
497
- # Supported on servers running Chef Automate 2. An optional public
498
- # endpoint of a server, such as `https://aws.my-company.com`. To access
499
- # the server, create a CNAME DNS record in your preferred DNS service
500
- # that points the custom domain to the endpoint that is generated when
501
- # the server is created (the value of the CreateServer Endpoint
502
- # attribute). You cannot access the server by using the generated
503
- # `Endpoint` value if the server is using a custom domain. If you
504
- # specify a custom domain, you must also specify values for
505
- # `CustomCertificate` and `CustomPrivateKey`.
541
+ # An optional public endpoint of a server, such as
542
+ # `https://aws.my-company.com`. To access the server, create a CNAME DNS
543
+ # record in your preferred DNS service that points the custom domain to
544
+ # the endpoint that is generated when the server is created (the value
545
+ # of the CreateServer Endpoint attribute). You cannot access the server
546
+ # by using the generated `Endpoint` value if the server is using a
547
+ # custom domain. If you specify a custom domain, you must also specify
548
+ # values for `CustomCertificate` and `CustomPrivateKey`.
506
549
  #
507
550
  # @option params [String] :custom_certificate
508
- # Supported on servers running Chef Automate 2. A PEM-formatted HTTPS
509
- # certificate. The value can be be a single, self-signed certificate, or
510
- # a certificate chain. If you specify a custom certificate, you must
511
- # also specify values for `CustomDomain` and `CustomPrivateKey`. The
512
- # following are requirements for the `CustomCertificate` value:
551
+ # A PEM-formatted HTTPS certificate. The value can be be a single,
552
+ # self-signed certificate, or a certificate chain. If you specify a
553
+ # custom certificate, you must also specify values for `CustomDomain`
554
+ # and `CustomPrivateKey`. The following are requirements for the
555
+ # `CustomCertificate` value:
513
556
  #
514
557
  # * You can provide either a self-signed, custom certificate, or the
515
558
  # full certificate chain.
@@ -528,11 +571,10 @@ module Aws::OpsWorksCM
528
571
  # * The certificate must match the value of `CustomPrivateKey`.
529
572
  #
530
573
  # @option params [String] :custom_private_key
531
- # Supported on servers running Chef Automate 2. A private key in PEM
532
- # format for connecting to the server by using HTTPS. The private key
533
- # must not be encrypted; it cannot be protected by a password or
534
- # passphrase. If you specify a custom private key, you must also specify
535
- # values for `CustomDomain` and `CustomCertificate`.
574
+ # A private key in PEM format for connecting to the server by using
575
+ # HTTPS. The private key must not be encrypted; it cannot be protected
576
+ # by a password or passphrase. If you specify a custom private key, you
577
+ # must also specify values for `CustomDomain` and `CustomCertificate`.
536
578
  #
537
579
  # @option params [Boolean] :disable_automated_backup
538
580
  # Enable or disable scheduled backups. Valid values are `true` or
@@ -688,11 +730,11 @@ module Aws::OpsWorksCM
688
730
  #
689
731
  # * The key can be a maximum of 127 characters, and can contain only
690
732
  # Unicode letters, numbers, or separators, or the following special
691
- # characters: `+ - = . _ : /`
733
+ # characters: `+ - = . _ : / @`
692
734
  #
693
735
  # * The value can be a maximum 255 characters, and contain only Unicode
694
736
  # letters, numbers, or separators, or the following special
695
- # characters: `+ - = . _ : /`
737
+ # characters: `+ - = . _ : / @`
696
738
  #
697
739
  # * Leading and trailing white spaces are trimmed from both the key and
698
740
  # value.
@@ -898,6 +940,8 @@ module Aws::OpsWorksCM
898
940
  # * {Types::DescribeBackupsResponse#backups #backups} => Array&lt;Types::Backup&gt;
899
941
  # * {Types::DescribeBackupsResponse#next_token #next_token} => String
900
942
  #
943
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
944
+ #
901
945
  # @example Request syntax with placeholder values
902
946
  #
903
947
  # resp = client.describe_backups({
@@ -981,6 +1025,8 @@ module Aws::OpsWorksCM
981
1025
  # * {Types::DescribeEventsResponse#server_events #server_events} => Array&lt;Types::ServerEvent&gt;
982
1026
  # * {Types::DescribeEventsResponse#next_token #next_token} => String
983
1027
  #
1028
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1029
+ #
984
1030
  # @example Request syntax with placeholder values
985
1031
  #
986
1032
  # resp = client.describe_events({
@@ -1041,6 +1087,11 @@ module Aws::OpsWorksCM
1041
1087
  # resp.engine_attributes[0].name #=> String
1042
1088
  # resp.engine_attributes[0].value #=> String
1043
1089
  #
1090
+ #
1091
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1092
+ #
1093
+ # * node_associated
1094
+ #
1044
1095
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/DescribeNodeAssociationStatus AWS API Documentation
1045
1096
  #
1046
1097
  # @overload describe_node_association_status(params = {})
@@ -1074,6 +1125,8 @@ module Aws::OpsWorksCM
1074
1125
  # * {Types::DescribeServersResponse#servers #servers} => Array&lt;Types::Server&gt;
1075
1126
  # * {Types::DescribeServersResponse#next_token #next_token} => String
1076
1127
  #
1128
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1129
+ #
1077
1130
  # @example Request syntax with placeholder values
1078
1131
  #
1079
1132
  # resp = client.describe_servers({
@@ -1292,6 +1345,8 @@ module Aws::OpsWorksCM
1292
1345
  # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1293
1346
  # * {Types::ListTagsForResourceResponse#next_token #next_token} => String
1294
1347
  #
1348
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1349
+ #
1295
1350
  # @example Request syntax with placeholder values
1296
1351
  #
1297
1352
  # resp = client.list_tags_for_resource({
@@ -1710,7 +1765,7 @@ module Aws::OpsWorksCM
1710
1765
  params: params,
1711
1766
  config: config)
1712
1767
  context[:gem_name] = 'aws-sdk-opsworkscm'
1713
- context[:gem_version] = '1.29.0'
1768
+ context[:gem_version] = '1.34.0'
1714
1769
  Seahorse::Client::Request.new(handlers, context)
1715
1770
  end
1716
1771
 
@@ -1776,9 +1831,9 @@ module Aws::OpsWorksCM
1776
1831
  # The following table lists the valid waiter names, the operations they call,
1777
1832
  # and the default `:delay` and `:max_attempts` values.
1778
1833
  #
1779
- # | waiter_name | params | :delay | :max_attempts |
1780
- # | --------------- | ----------------------------------- | -------- | ------------- |
1781
- # | node_associated | {#describe_node_association_status} | 15 | 15 |
1834
+ # | waiter_name | params | :delay | :max_attempts |
1835
+ # | --------------- | ----------------------------------------- | -------- | ------------- |
1836
+ # | node_associated | {Client#describe_node_association_status} | 15 | 15 |
1782
1837
  #
1783
1838
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
1784
1839
  # because the waiter has entered a state that it will not transition
@@ -463,6 +463,12 @@ module Aws::OpsWorksCM
463
463
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
464
464
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
465
465
  o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
466
+ o[:pager] = Aws::Pager.new(
467
+ limit_key: "max_results",
468
+ tokens: {
469
+ "next_token" => "next_token"
470
+ }
471
+ )
466
472
  end)
467
473
 
468
474
  api.add_operation(:describe_events, Seahorse::Model::Operation.new.tap do |o|
@@ -474,6 +480,12 @@ module Aws::OpsWorksCM
474
480
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
475
481
  o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
476
482
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
483
+ o[:pager] = Aws::Pager.new(
484
+ limit_key: "max_results",
485
+ tokens: {
486
+ "next_token" => "next_token"
487
+ }
488
+ )
477
489
  end)
478
490
 
479
491
  api.add_operation(:describe_node_association_status, Seahorse::Model::Operation.new.tap do |o|
@@ -495,6 +507,12 @@ module Aws::OpsWorksCM
495
507
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
496
508
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
497
509
  o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
510
+ o[:pager] = Aws::Pager.new(
511
+ limit_key: "max_results",
512
+ tokens: {
513
+ "next_token" => "next_token"
514
+ }
515
+ )
498
516
  end)
499
517
 
500
518
  api.add_operation(:disassociate_node, Seahorse::Model::Operation.new.tap do |o|
@@ -527,6 +545,12 @@ module Aws::OpsWorksCM
527
545
  o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceResponse)
528
546
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
529
547
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
548
+ o[:pager] = Aws::Pager.new(
549
+ limit_key: "max_results",
550
+ tokens: {
551
+ "next_token" => "next_token"
552
+ }
553
+ )
530
554
  end)
531
555
 
532
556
  api.add_operation(:restore_server, Seahorse::Model::Operation.new.tap do |o|
@@ -11,22 +11,17 @@ module Aws::OpsWorksCM
11
11
  # These errors all extend Aws::OpsWorksCM::Errors::ServiceError < {Aws::Errors::ServiceError}
12
12
  #
13
13
  # You can rescue all OpsWorksCM errors using ServiceError:
14
+ #
14
15
  # begin
15
16
  # # do stuff
16
17
  # rescue Aws::OpsWorksCM::Errors::ServiceError
17
18
  # # rescues all OpsWorksCM API errors
18
19
  # end
19
20
  #
21
+ #
20
22
  # ## Request Context
21
23
  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
22
- # information about the request that generated the error, including:
23
- # *
24
- # * #params - The request params
25
- # * #operation_name - Name of the API operation invoked
26
- # * #http_request
27
- # * #http_response
28
- # * etc ...
29
- #
24
+ # information about the request that generated the error.
30
25
  # See {Seahorse::Client::RequestContext} for more information.
31
26
  #
32
27
  # ## Error Classes
@@ -36,6 +31,7 @@ module Aws::OpsWorksCM
36
31
  # * {ResourceAlreadyExistsException}
37
32
  # * {ResourceNotFoundException}
38
33
  # * {ValidationException}
34
+ #
39
35
  # Additionally, error classes are dynamically generated for service errors based on the error code
40
36
  # if they are not defined above.
41
37
  module Errors
@@ -55,7 +51,6 @@ module Aws::OpsWorksCM
55
51
  def message
56
52
  @message || @data[:message]
57
53
  end
58
-
59
54
  end
60
55
 
61
56
  class InvalidStateException < ServiceError
@@ -71,7 +66,6 @@ module Aws::OpsWorksCM
71
66
  def message
72
67
  @message || @data[:message]
73
68
  end
74
-
75
69
  end
76
70
 
77
71
  class LimitExceededException < ServiceError
@@ -87,7 +81,6 @@ module Aws::OpsWorksCM
87
81
  def message
88
82
  @message || @data[:message]
89
83
  end
90
-
91
84
  end
92
85
 
93
86
  class ResourceAlreadyExistsException < ServiceError
@@ -103,7 +96,6 @@ module Aws::OpsWorksCM
103
96
  def message
104
97
  @message || @data[:message]
105
98
  end
106
-
107
99
  end
108
100
 
109
101
  class ResourceNotFoundException < ServiceError
@@ -119,7 +111,6 @@ module Aws::OpsWorksCM
119
111
  def message
120
112
  @message || @data[:message]
121
113
  end
122
-
123
114
  end
124
115
 
125
116
  class ValidationException < ServiceError
@@ -135,7 +126,6 @@ module Aws::OpsWorksCM
135
126
  def message
136
127
  @message || @data[:message]
137
128
  end
138
-
139
129
  end
140
130
 
141
131
  end
@@ -6,13 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::OpsWorksCM
9
- # This class provides a resource oriented interface for OpsWorksCM.
10
- # To create a resource object:
11
- # resource = Aws::OpsWorksCM::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::OpsWorksCM::Client.new(region: 'us-west-2')
15
- # resource = Aws::OpsWorksCM::Resource.new(client: client)
9
+
16
10
  class Resource
17
11
 
18
12
  # @param options ({})
@@ -355,23 +355,23 @@ module Aws::OpsWorksCM
355
355
  # @return [Boolean]
356
356
  #
357
357
  # @!attribute [rw] custom_domain
358
- # Supported on servers running Chef Automate 2. An optional public
359
- # endpoint of a server, such as `https://aws.my-company.com`. To
360
- # access the server, create a CNAME DNS record in your preferred DNS
361
- # service that points the custom domain to the endpoint that is
362
- # generated when the server is created (the value of the CreateServer
363
- # Endpoint attribute). You cannot access the server by using the
364
- # generated `Endpoint` value if the server is using a custom domain.
365
- # If you specify a custom domain, you must also specify values for
366
- # `CustomCertificate` and `CustomPrivateKey`.
358
+ # An optional public endpoint of a server, such as
359
+ # `https://aws.my-company.com`. To access the server, create a CNAME
360
+ # DNS record in your preferred DNS service that points the custom
361
+ # domain to the endpoint that is generated when the server is created
362
+ # (the value of the CreateServer Endpoint attribute). You cannot
363
+ # access the server by using the generated `Endpoint` value if the
364
+ # server is using a custom domain. If you specify a custom domain, you
365
+ # must also specify values for `CustomCertificate` and
366
+ # `CustomPrivateKey`.
367
367
  # @return [String]
368
368
  #
369
369
  # @!attribute [rw] custom_certificate
370
- # Supported on servers running Chef Automate 2. A PEM-formatted HTTPS
371
- # certificate. The value can be be a single, self-signed certificate,
372
- # or a certificate chain. If you specify a custom certificate, you
373
- # must also specify values for `CustomDomain` and `CustomPrivateKey`.
374
- # The following are requirements for the `CustomCertificate` value:
370
+ # A PEM-formatted HTTPS certificate. The value can be be a single,
371
+ # self-signed certificate, or a certificate chain. If you specify a
372
+ # custom certificate, you must also specify values for `CustomDomain`
373
+ # and `CustomPrivateKey`. The following are requirements for the
374
+ # `CustomCertificate` value:
375
375
  #
376
376
  # * You can provide either a self-signed, custom certificate, or the
377
377
  # full certificate chain.
@@ -391,11 +391,11 @@ module Aws::OpsWorksCM
391
391
  # @return [String]
392
392
  #
393
393
  # @!attribute [rw] custom_private_key
394
- # Supported on servers running Chef Automate 2. A private key in PEM
395
- # format for connecting to the server by using HTTPS. The private key
396
- # must not be encrypted; it cannot be protected by a password or
397
- # passphrase. If you specify a custom private key, you must also
398
- # specify values for `CustomDomain` and `CustomCertificate`.
394
+ # A private key in PEM format for connecting to the server by using
395
+ # HTTPS. The private key must not be encrypted; it cannot be protected
396
+ # by a password or passphrase. If you specify a custom private key,
397
+ # you must also specify values for `CustomDomain` and
398
+ # `CustomCertificate`.
399
399
  # @return [String]
400
400
  #
401
401
  # @!attribute [rw] disable_automated_backup
@@ -568,11 +568,11 @@ module Aws::OpsWorksCM
568
568
  #
569
569
  # * The key can be a maximum of 127 characters, and can contain only
570
570
  # Unicode letters, numbers, or separators, or the following special
571
- # characters: `+ - = . _ : /`
571
+ # characters: `+ - = . _ : / @`
572
572
  #
573
573
  # * The value can be a maximum 255 characters, and contain only
574
574
  # Unicode letters, numbers, or separators, or the following special
575
- # characters: `+ - = . _ : /`
575
+ # characters: `+ - = . _ : / @`
576
576
  #
577
577
  # * Leading and trailing white spaces are trimmed from both the key
578
578
  # and value.
@@ -8,6 +8,67 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::OpsWorksCM
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | --------------- | ----------------------------------------- | -------- | ------------- |
70
+ # | node_associated | {Client#describe_node_association_status} | 15 | 15 |
71
+ #
11
72
  module Waiters
12
73
 
13
74
  # Wait until node is associated or disassociated.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-opsworkscm
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.29.0
4
+ version: 1.34.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-03-05 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
82
  version: '0'
83
83
  requirements: []
84
84
  rubyforge_project:
85
- rubygems_version: 2.5.2.3
85
+ rubygems_version: 2.7.6.2
86
86
  signing_key:
87
87
  specification_version: 4
88
88
  summary: AWS SDK for Ruby - OpsWorksCM