aws-sdk-appconfig 1.0.0 → 1.6.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-appconfig.rb +7 -4
- data/lib/aws-sdk-appconfig/client.rb +219 -41
- data/lib/aws-sdk-appconfig/client_api.rb +13 -0
- data/lib/aws-sdk-appconfig/errors.rb +26 -4
- data/lib/aws-sdk-appconfig/resource.rb +1 -0
- data/lib/aws-sdk-appconfig/types.rb +137 -15
- 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: 368082eb797e7e268c65ad1f3d0168eb50298aa80487cd8ecda9c7899a6abc3d
|
4
|
+
data.tar.gz: dc1e4ca3c9ccf632856b033ad247dd8b63c91b011956f2df11e610b33d06bf96
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d7d8ea4e91f72d3d40e62a9bf0161dc29c4fc257f0fdda32df1ba98aa7eaa5d183916e1e5ea320715a8700cfc37fee7fdc5ed633cd20929bbf35f5a43996dade
|
7
|
+
data.tar.gz: 20900ec8c3a060cee2684484a25f8af2a34765cb2640ba4cba15f2a9af6b27065038c5d19dca4254a52d9f6dc9e089a4c2eee6e0576ca60f23ca7f05e75a1b03
|
data/lib/aws-sdk-appconfig.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-appconfig/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# app_config = Aws::AppConfig::Client.new
|
28
|
+
# resp = app_config.create_application(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon AppConfig
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon AppConfig are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::AppConfig::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon AppConfig API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-appconfig/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::AppConfig
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.6.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:appconfig)
|
31
31
|
|
32
32
|
module Aws::AppConfig
|
33
|
+
# An API client for AppConfig. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::AppConfig::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::AppConfig
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::AppConfig
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
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
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::AppConfig
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
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
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::AppConfig
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::AppConfig
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::AppConfig
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
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
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
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
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# 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.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
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.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::AppConfig
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# 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.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
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
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::AppConfig
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::AppConfig
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -303,9 +357,9 @@ module Aws::AppConfig
|
|
303
357
|
end
|
304
358
|
|
305
359
|
# Information that enables AppConfig to access the configuration source.
|
306
|
-
# Valid configuration sources include Systems Manager (SSM) documents
|
307
|
-
#
|
308
|
-
# the following information.
|
360
|
+
# Valid configuration sources include Systems Manager (SSM) documents,
|
361
|
+
# SSM Parameter Store parameters, and Amazon S3 objects. A configuration
|
362
|
+
# profile includes the following information.
|
309
363
|
#
|
310
364
|
# * The Uri location of the configuration data.
|
311
365
|
#
|
@@ -315,6 +369,13 @@ module Aws::AppConfig
|
|
315
369
|
# * A validator for the configuration data. Available validators include
|
316
370
|
# either a JSON Schema or an AWS Lambda function.
|
317
371
|
#
|
372
|
+
# For more information, see [Create a Configuration and a Configuration
|
373
|
+
# Profile][1] in the *AWS AppConfig User Guide*.
|
374
|
+
#
|
375
|
+
#
|
376
|
+
#
|
377
|
+
# [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html
|
378
|
+
#
|
318
379
|
# @option params [required, String] :application_id
|
319
380
|
# The application ID.
|
320
381
|
#
|
@@ -325,12 +386,15 @@ module Aws::AppConfig
|
|
325
386
|
# A description of the configuration profile.
|
326
387
|
#
|
327
388
|
# @option params [required, String] :location_uri
|
328
|
-
# A URI to locate the configuration. You can specify
|
329
|
-
#
|
330
|
-
# document, specify either the document name in the
|
331
|
-
# `ssm-document://<
|
332
|
-
# For a parameter, specify either the parameter name in the
|
333
|
-
# `ssm-parameter://<
|
389
|
+
# A URI to locate the configuration. You can specify a Systems Manager
|
390
|
+
# (SSM) document, an SSM Parameter Store parameter, or an Amazon S3
|
391
|
+
# object. For an SSM document, specify either the document name in the
|
392
|
+
# format `ssm-document://<Document_name>` or the Amazon Resource Name
|
393
|
+
# (ARN). For a parameter, specify either the parameter name in the
|
394
|
+
# format `ssm-parameter://<Parameter_name>` or the ARN. For an Amazon S3
|
395
|
+
# object, specify the URI in the following format:
|
396
|
+
# `s3://<bucket>/<objectKey> `. Here is an example:
|
397
|
+
# s3://my-bucket/my-app/us-east-1/my-config.json
|
334
398
|
#
|
335
399
|
# @option params [required, String] :retrieval_role_arn
|
336
400
|
# The ARN of an IAM role with permission to access the configuration at
|
@@ -419,7 +483,33 @@ module Aws::AppConfig
|
|
419
483
|
# each interval.
|
420
484
|
#
|
421
485
|
# @option params [String] :growth_type
|
422
|
-
# The algorithm used to define how percentage grows over time.
|
486
|
+
# The algorithm used to define how percentage grows over time. AWS
|
487
|
+
# AppConfig supports the following growth types:
|
488
|
+
#
|
489
|
+
# **Linear**\: For this type, AppConfig processes the deployment by
|
490
|
+
# dividing the total number of targets by the value specified for `Step
|
491
|
+
# percentage`. For example, a linear deployment that uses a `Step
|
492
|
+
# percentage` of 10 deploys the configuration to 10 percent of the
|
493
|
+
# hosts. After those deployments are complete, the system deploys the
|
494
|
+
# configuration to the next 10 percent. This continues until 100% of the
|
495
|
+
# targets have successfully received the configuration.
|
496
|
+
#
|
497
|
+
# **Exponential**\: For this type, AppConfig processes the deployment
|
498
|
+
# exponentially using the following formula: `G*(2^N)`. In this formula,
|
499
|
+
# `G` is the growth factor specified by the user and `N` is the number
|
500
|
+
# of steps until the configuration is deployed to all targets. For
|
501
|
+
# example, if you specify a growth factor of 2, then the system rolls
|
502
|
+
# out the configuration as follows:
|
503
|
+
#
|
504
|
+
# `2*(2^0)`
|
505
|
+
#
|
506
|
+
# `2*(2^1)`
|
507
|
+
#
|
508
|
+
# `2*(2^2)`
|
509
|
+
#
|
510
|
+
# Expressed numerically, the deployment rolls out as follows: 2% of the
|
511
|
+
# targets, 4% of the targets, 8% of the targets, and continues until the
|
512
|
+
# configuration has been deployed to all targets.
|
423
513
|
#
|
424
514
|
# @option params [required, String] :replicate_to
|
425
515
|
# Save the deployment strategy to a Systems Manager (SSM) document.
|
@@ -448,7 +538,7 @@ module Aws::AppConfig
|
|
448
538
|
# deployment_duration_in_minutes: 1, # required
|
449
539
|
# final_bake_time_in_minutes: 1,
|
450
540
|
# growth_factor: 1.0, # required
|
451
|
-
# growth_type: "LINEAR", # accepts LINEAR
|
541
|
+
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
452
542
|
# replicate_to: "NONE", # required, accepts NONE, SSM_DOCUMENT
|
453
543
|
# tags: {
|
454
544
|
# "TagKey" => "TagValue",
|
@@ -461,7 +551,7 @@ module Aws::AppConfig
|
|
461
551
|
# resp.name #=> String
|
462
552
|
# resp.description #=> String
|
463
553
|
# resp.deployment_duration_in_minutes #=> Integer
|
464
|
-
# resp.growth_type #=> String, one of "LINEAR"
|
554
|
+
# resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
465
555
|
# resp.growth_factor #=> Float
|
466
556
|
# resp.final_bake_time_in_minutes #=> Integer
|
467
557
|
# resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
@@ -680,16 +770,31 @@ module Aws::AppConfig
|
|
680
770
|
req.send_request(options)
|
681
771
|
end
|
682
772
|
|
683
|
-
#
|
773
|
+
# Receive information about a configuration.
|
774
|
+
#
|
775
|
+
# AWS AppConfig uses the value of the `ClientConfigurationVersion`
|
776
|
+
# parameter to identify the configuration version on your clients. If
|
777
|
+
# you don’t send `ClientConfigurationVersion` with each call to
|
778
|
+
# `GetConfiguration`, your clients receive the current configuration.
|
779
|
+
# You are charged each time your clients receive a configuration.
|
780
|
+
#
|
781
|
+
# To avoid excess charges, we recommend that you include the
|
782
|
+
# `ClientConfigurationVersion` value with every call to
|
783
|
+
# `GetConfiguration`. This value must be saved on your client.
|
784
|
+
# Subsequent calls to `GetConfiguration` must pass this value by using
|
785
|
+
# the `ClientConfigurationVersion` parameter.
|
684
786
|
#
|
685
787
|
# @option params [required, String] :application
|
686
|
-
# The application to get.
|
788
|
+
# The application to get. Specify either the application name or the
|
789
|
+
# application ID.
|
687
790
|
#
|
688
791
|
# @option params [required, String] :environment
|
689
|
-
# The environment to get.
|
792
|
+
# The environment to get. Specify either the environment name or the
|
793
|
+
# environment ID.
|
690
794
|
#
|
691
795
|
# @option params [required, String] :configuration
|
692
|
-
# The configuration to get.
|
796
|
+
# The configuration to get. Specify either the configuration name or the
|
797
|
+
# configuration ID.
|
693
798
|
#
|
694
799
|
# @option params [required, String] :client_id
|
695
800
|
# A unique ID to identify the client for the configuration. This ID
|
@@ -697,8 +802,27 @@ module Aws::AppConfig
|
|
697
802
|
# in the deployment strategy.
|
698
803
|
#
|
699
804
|
# @option params [String] :client_configuration_version
|
700
|
-
# The configuration version returned in the most recent
|
701
|
-
# response.
|
805
|
+
# The configuration version returned in the most recent
|
806
|
+
# `GetConfiguration` response.
|
807
|
+
#
|
808
|
+
# AWS AppConfig uses the value of the `ClientConfigurationVersion`
|
809
|
+
# parameter to identify the configuration version on your clients. If
|
810
|
+
# you don’t send `ClientConfigurationVersion` with each call to
|
811
|
+
# `GetConfiguration`, your clients receive the current configuration.
|
812
|
+
# You are charged each time your clients receive a configuration.
|
813
|
+
#
|
814
|
+
# To avoid excess charges, we recommend that you include the
|
815
|
+
# `ClientConfigurationVersion` value with every call to
|
816
|
+
# `GetConfiguration`. This value must be saved on your client.
|
817
|
+
# Subsequent calls to `GetConfiguration` must pass this value by using
|
818
|
+
# the `ClientConfigurationVersion` parameter.
|
819
|
+
#
|
820
|
+
# For more information about working with configurations, see
|
821
|
+
# [Retrieving the Configuration][1] in the *AWS AppConfig User Guide*.
|
822
|
+
#
|
823
|
+
#
|
824
|
+
#
|
825
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-retrieving-the-configuration.html
|
702
826
|
#
|
703
827
|
# @return [Types::Configuration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
704
828
|
#
|
@@ -807,6 +931,7 @@ module Aws::AppConfig
|
|
807
931
|
# * {Types::Deployment#growth_factor #growth_factor} => Float
|
808
932
|
# * {Types::Deployment#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
809
933
|
# * {Types::Deployment#state #state} => String
|
934
|
+
# * {Types::Deployment#event_log #event_log} => Array<Types::DeploymentEvent>
|
810
935
|
# * {Types::Deployment#percentage_complete #percentage_complete} => Float
|
811
936
|
# * {Types::Deployment#started_at #started_at} => Time
|
812
937
|
# * {Types::Deployment#completed_at #completed_at} => Time
|
@@ -831,10 +956,15 @@ module Aws::AppConfig
|
|
831
956
|
# resp.configuration_version #=> String
|
832
957
|
# resp.description #=> String
|
833
958
|
# resp.deployment_duration_in_minutes #=> Integer
|
834
|
-
# resp.growth_type #=> String, one of "LINEAR"
|
959
|
+
# resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
835
960
|
# resp.growth_factor #=> Float
|
836
961
|
# resp.final_bake_time_in_minutes #=> Integer
|
837
962
|
# resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
963
|
+
# resp.event_log #=> Array
|
964
|
+
# resp.event_log[0].event_type #=> String, one of "PERCENTAGE_UPDATED", "ROLLBACK_STARTED", "ROLLBACK_COMPLETED", "BAKE_TIME_STARTED", "DEPLOYMENT_STARTED", "DEPLOYMENT_COMPLETED"
|
965
|
+
# resp.event_log[0].triggered_by #=> String, one of "USER", "APPCONFIG", "CLOUDWATCH_ALARM", "INTERNAL_ERROR"
|
966
|
+
# resp.event_log[0].description #=> String
|
967
|
+
# resp.event_log[0].occurred_at #=> Time
|
838
968
|
# resp.percentage_complete #=> Float
|
839
969
|
# resp.started_at #=> Time
|
840
970
|
# resp.completed_at #=> Time
|
@@ -881,7 +1011,7 @@ module Aws::AppConfig
|
|
881
1011
|
# resp.name #=> String
|
882
1012
|
# resp.description #=> String
|
883
1013
|
# resp.deployment_duration_in_minutes #=> Integer
|
884
|
-
# resp.growth_type #=> String, one of "LINEAR"
|
1014
|
+
# resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
885
1015
|
# resp.growth_factor #=> Float
|
886
1016
|
# resp.final_bake_time_in_minutes #=> Integer
|
887
1017
|
# resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
@@ -961,6 +1091,8 @@ module Aws::AppConfig
|
|
961
1091
|
# * {Types::Applications#items #items} => Array<Types::Application>
|
962
1092
|
# * {Types::Applications#next_token #next_token} => String
|
963
1093
|
#
|
1094
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1095
|
+
#
|
964
1096
|
# @example Request syntax with placeholder values
|
965
1097
|
#
|
966
1098
|
# resp = client.list_applications({
|
@@ -1004,6 +1136,8 @@ module Aws::AppConfig
|
|
1004
1136
|
# * {Types::ConfigurationProfiles#items #items} => Array<Types::ConfigurationProfileSummary>
|
1005
1137
|
# * {Types::ConfigurationProfiles#next_token #next_token} => String
|
1006
1138
|
#
|
1139
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1140
|
+
#
|
1007
1141
|
# @example Request syntax with placeholder values
|
1008
1142
|
#
|
1009
1143
|
# resp = client.list_configuration_profiles({
|
@@ -1048,6 +1182,8 @@ module Aws::AppConfig
|
|
1048
1182
|
# * {Types::DeploymentStrategies#items #items} => Array<Types::DeploymentStrategy>
|
1049
1183
|
# * {Types::DeploymentStrategies#next_token #next_token} => String
|
1050
1184
|
#
|
1185
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1186
|
+
#
|
1051
1187
|
# @example Request syntax with placeholder values
|
1052
1188
|
#
|
1053
1189
|
# resp = client.list_deployment_strategies({
|
@@ -1062,7 +1198,7 @@ module Aws::AppConfig
|
|
1062
1198
|
# resp.items[0].name #=> String
|
1063
1199
|
# resp.items[0].description #=> String
|
1064
1200
|
# resp.items[0].deployment_duration_in_minutes #=> Integer
|
1065
|
-
# resp.items[0].growth_type #=> String, one of "LINEAR"
|
1201
|
+
# resp.items[0].growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
1066
1202
|
# resp.items[0].growth_factor #=> Float
|
1067
1203
|
# resp.items[0].final_bake_time_in_minutes #=> Integer
|
1068
1204
|
# resp.items[0].replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
@@ -1099,6 +1235,8 @@ module Aws::AppConfig
|
|
1099
1235
|
# * {Types::Deployments#items #items} => Array<Types::DeploymentSummary>
|
1100
1236
|
# * {Types::Deployments#next_token #next_token} => String
|
1101
1237
|
#
|
1238
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1239
|
+
#
|
1102
1240
|
# @example Request syntax with placeholder values
|
1103
1241
|
#
|
1104
1242
|
# resp = client.list_deployments({
|
@@ -1115,7 +1253,7 @@ module Aws::AppConfig
|
|
1115
1253
|
# resp.items[0].configuration_name #=> String
|
1116
1254
|
# resp.items[0].configuration_version #=> String
|
1117
1255
|
# resp.items[0].deployment_duration_in_minutes #=> Integer
|
1118
|
-
# resp.items[0].growth_type #=> String, one of "LINEAR"
|
1256
|
+
# resp.items[0].growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
1119
1257
|
# resp.items[0].growth_factor #=> Float
|
1120
1258
|
# resp.items[0].final_bake_time_in_minutes #=> Integer
|
1121
1259
|
# resp.items[0].state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
@@ -1152,6 +1290,8 @@ module Aws::AppConfig
|
|
1152
1290
|
# * {Types::Environments#items #items} => Array<Types::Environment>
|
1153
1291
|
# * {Types::Environments#next_token #next_token} => String
|
1154
1292
|
#
|
1293
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1294
|
+
#
|
1155
1295
|
# @example Request syntax with placeholder values
|
1156
1296
|
#
|
1157
1297
|
# resp = client.list_environments({
|
@@ -1252,6 +1392,7 @@ module Aws::AppConfig
|
|
1252
1392
|
# * {Types::Deployment#growth_factor #growth_factor} => Float
|
1253
1393
|
# * {Types::Deployment#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
1254
1394
|
# * {Types::Deployment#state #state} => String
|
1395
|
+
# * {Types::Deployment#event_log #event_log} => Array<Types::DeploymentEvent>
|
1255
1396
|
# * {Types::Deployment#percentage_complete #percentage_complete} => Float
|
1256
1397
|
# * {Types::Deployment#started_at #started_at} => Time
|
1257
1398
|
# * {Types::Deployment#completed_at #completed_at} => Time
|
@@ -1282,10 +1423,15 @@ module Aws::AppConfig
|
|
1282
1423
|
# resp.configuration_version #=> String
|
1283
1424
|
# resp.description #=> String
|
1284
1425
|
# resp.deployment_duration_in_minutes #=> Integer
|
1285
|
-
# resp.growth_type #=> String, one of "LINEAR"
|
1426
|
+
# resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
1286
1427
|
# resp.growth_factor #=> Float
|
1287
1428
|
# resp.final_bake_time_in_minutes #=> Integer
|
1288
1429
|
# resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
1430
|
+
# resp.event_log #=> Array
|
1431
|
+
# resp.event_log[0].event_type #=> String, one of "PERCENTAGE_UPDATED", "ROLLBACK_STARTED", "ROLLBACK_COMPLETED", "BAKE_TIME_STARTED", "DEPLOYMENT_STARTED", "DEPLOYMENT_COMPLETED"
|
1432
|
+
# resp.event_log[0].triggered_by #=> String, one of "USER", "APPCONFIG", "CLOUDWATCH_ALARM", "INTERNAL_ERROR"
|
1433
|
+
# resp.event_log[0].description #=> String
|
1434
|
+
# resp.event_log[0].occurred_at #=> Time
|
1289
1435
|
# resp.percentage_complete #=> Float
|
1290
1436
|
# resp.started_at #=> Time
|
1291
1437
|
# resp.completed_at #=> Time
|
@@ -1328,6 +1474,7 @@ module Aws::AppConfig
|
|
1328
1474
|
# * {Types::Deployment#growth_factor #growth_factor} => Float
|
1329
1475
|
# * {Types::Deployment#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
1330
1476
|
# * {Types::Deployment#state #state} => String
|
1477
|
+
# * {Types::Deployment#event_log #event_log} => Array<Types::DeploymentEvent>
|
1331
1478
|
# * {Types::Deployment#percentage_complete #percentage_complete} => Float
|
1332
1479
|
# * {Types::Deployment#started_at #started_at} => Time
|
1333
1480
|
# * {Types::Deployment#completed_at #completed_at} => Time
|
@@ -1352,10 +1499,15 @@ module Aws::AppConfig
|
|
1352
1499
|
# resp.configuration_version #=> String
|
1353
1500
|
# resp.description #=> String
|
1354
1501
|
# resp.deployment_duration_in_minutes #=> Integer
|
1355
|
-
# resp.growth_type #=> String, one of "LINEAR"
|
1502
|
+
# resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
1356
1503
|
# resp.growth_factor #=> Float
|
1357
1504
|
# resp.final_bake_time_in_minutes #=> Integer
|
1358
1505
|
# resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
1506
|
+
# resp.event_log #=> Array
|
1507
|
+
# resp.event_log[0].event_type #=> String, one of "PERCENTAGE_UPDATED", "ROLLBACK_STARTED", "ROLLBACK_COMPLETED", "BAKE_TIME_STARTED", "DEPLOYMENT_STARTED", "DEPLOYMENT_COMPLETED"
|
1508
|
+
# resp.event_log[0].triggered_by #=> String, one of "USER", "APPCONFIG", "CLOUDWATCH_ALARM", "INTERNAL_ERROR"
|
1509
|
+
# resp.event_log[0].description #=> String
|
1510
|
+
# resp.event_log[0].occurred_at #=> Time
|
1359
1511
|
# resp.percentage_complete #=> Float
|
1360
1512
|
# resp.started_at #=> Time
|
1361
1513
|
# resp.completed_at #=> Time
|
@@ -1557,7 +1709,33 @@ module Aws::AppConfig
|
|
1557
1709
|
# each interval.
|
1558
1710
|
#
|
1559
1711
|
# @option params [String] :growth_type
|
1560
|
-
# The algorithm used to define how percentage grows over time.
|
1712
|
+
# The algorithm used to define how percentage grows over time. AWS
|
1713
|
+
# AppConfig supports the following growth types:
|
1714
|
+
#
|
1715
|
+
# **Linear**\: For this type, AppConfig processes the deployment by
|
1716
|
+
# increments of the growth factor evenly distributed over the deployment
|
1717
|
+
# time. For example, a linear deployment that uses a growth factor of 20
|
1718
|
+
# initially makes the configuration available to 20 percent of the
|
1719
|
+
# targets. After 1/5th of the deployment time has passed, the system
|
1720
|
+
# updates the percentage to 40 percent. This continues until 100% of the
|
1721
|
+
# targets are set to receive the deployed configuration.
|
1722
|
+
#
|
1723
|
+
# **Exponential**\: For this type, AppConfig processes the deployment
|
1724
|
+
# exponentially using the following formula: `G*(2^N)`. In this formula,
|
1725
|
+
# `G` is the growth factor specified by the user and `N` is the number
|
1726
|
+
# of steps until the configuration is deployed to all targets. For
|
1727
|
+
# example, if you specify a growth factor of 2, then the system rolls
|
1728
|
+
# out the configuration as follows:
|
1729
|
+
#
|
1730
|
+
# `2*(2^0)`
|
1731
|
+
#
|
1732
|
+
# `2*(2^1)`
|
1733
|
+
#
|
1734
|
+
# `2*(2^2)`
|
1735
|
+
#
|
1736
|
+
# Expressed numerically, the deployment rolls out as follows: 2% of the
|
1737
|
+
# targets, 4% of the targets, 8% of the targets, and continues until the
|
1738
|
+
# configuration has been deployed to all targets.
|
1561
1739
|
#
|
1562
1740
|
# @return [Types::DeploymentStrategy] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1563
1741
|
#
|
@@ -1578,7 +1756,7 @@ module Aws::AppConfig
|
|
1578
1756
|
# deployment_duration_in_minutes: 1,
|
1579
1757
|
# final_bake_time_in_minutes: 1,
|
1580
1758
|
# growth_factor: 1.0,
|
1581
|
-
# growth_type: "LINEAR", # accepts LINEAR
|
1759
|
+
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
1582
1760
|
# })
|
1583
1761
|
#
|
1584
1762
|
# @example Response structure
|
@@ -1587,7 +1765,7 @@ module Aws::AppConfig
|
|
1587
1765
|
# resp.name #=> String
|
1588
1766
|
# resp.description #=> String
|
1589
1767
|
# resp.deployment_duration_in_minutes #=> Integer
|
1590
|
-
# resp.growth_type #=> String, one of "LINEAR"
|
1768
|
+
# resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
|
1591
1769
|
# resp.growth_factor #=> Float
|
1592
1770
|
# resp.final_bake_time_in_minutes #=> Integer
|
1593
1771
|
# resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
@@ -1706,7 +1884,7 @@ module Aws::AppConfig
|
|
1706
1884
|
params: params,
|
1707
1885
|
config: config)
|
1708
1886
|
context[:gem_name] = 'aws-sdk-appconfig'
|
1709
|
-
context[:gem_version] = '1.
|
1887
|
+
context[:gem_version] = '1.6.0'
|
1710
1888
|
Seahorse::Client::Request.new(handlers, context)
|
1711
1889
|
end
|
1712
1890
|
|
@@ -32,6 +32,9 @@ module Aws::AppConfig
|
|
32
32
|
DeleteDeploymentStrategyRequest = Shapes::StructureShape.new(name: 'DeleteDeploymentStrategyRequest')
|
33
33
|
DeleteEnvironmentRequest = Shapes::StructureShape.new(name: 'DeleteEnvironmentRequest')
|
34
34
|
Deployment = Shapes::StructureShape.new(name: 'Deployment')
|
35
|
+
DeploymentEvent = Shapes::StructureShape.new(name: 'DeploymentEvent')
|
36
|
+
DeploymentEventType = Shapes::StringShape.new(name: 'DeploymentEventType')
|
37
|
+
DeploymentEvents = Shapes::ListShape.new(name: 'DeploymentEvents')
|
35
38
|
DeploymentList = Shapes::ListShape.new(name: 'DeploymentList')
|
36
39
|
DeploymentState = Shapes::StringShape.new(name: 'DeploymentState')
|
37
40
|
DeploymentStrategies = Shapes::StructureShape.new(name: 'DeploymentStrategies')
|
@@ -83,6 +86,7 @@ module Aws::AppConfig
|
|
83
86
|
TagMap = Shapes::MapShape.new(name: 'TagMap')
|
84
87
|
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
85
88
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
89
|
+
TriggeredBy = Shapes::StringShape.new(name: 'TriggeredBy')
|
86
90
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
87
91
|
UpdateApplicationRequest = Shapes::StructureShape.new(name: 'UpdateApplicationRequest')
|
88
92
|
UpdateConfigurationProfileRequest = Shapes::StructureShape.new(name: 'UpdateConfigurationProfileRequest')
|
@@ -201,11 +205,20 @@ module Aws::AppConfig
|
|
201
205
|
Deployment.add_member(:growth_factor, Shapes::ShapeRef.new(shape: Percentage, location_name: "GrowthFactor"))
|
202
206
|
Deployment.add_member(:final_bake_time_in_minutes, Shapes::ShapeRef.new(shape: MinutesBetween0And24Hours, location_name: "FinalBakeTimeInMinutes"))
|
203
207
|
Deployment.add_member(:state, Shapes::ShapeRef.new(shape: DeploymentState, location_name: "State"))
|
208
|
+
Deployment.add_member(:event_log, Shapes::ShapeRef.new(shape: DeploymentEvents, location_name: "EventLog"))
|
204
209
|
Deployment.add_member(:percentage_complete, Shapes::ShapeRef.new(shape: Percentage, location_name: "PercentageComplete"))
|
205
210
|
Deployment.add_member(:started_at, Shapes::ShapeRef.new(shape: Iso8601DateTime, location_name: "StartedAt"))
|
206
211
|
Deployment.add_member(:completed_at, Shapes::ShapeRef.new(shape: Iso8601DateTime, location_name: "CompletedAt"))
|
207
212
|
Deployment.struct_class = Types::Deployment
|
208
213
|
|
214
|
+
DeploymentEvent.add_member(:event_type, Shapes::ShapeRef.new(shape: DeploymentEventType, location_name: "EventType"))
|
215
|
+
DeploymentEvent.add_member(:triggered_by, Shapes::ShapeRef.new(shape: TriggeredBy, location_name: "TriggeredBy"))
|
216
|
+
DeploymentEvent.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
217
|
+
DeploymentEvent.add_member(:occurred_at, Shapes::ShapeRef.new(shape: Iso8601DateTime, location_name: "OccurredAt"))
|
218
|
+
DeploymentEvent.struct_class = Types::DeploymentEvent
|
219
|
+
|
220
|
+
DeploymentEvents.member = Shapes::ShapeRef.new(shape: DeploymentEvent)
|
221
|
+
|
209
222
|
DeploymentList.member = Shapes::ShapeRef.new(shape: DeploymentSummary)
|
210
223
|
|
211
224
|
DeploymentStrategies.add_member(:items, Shapes::ShapeRef.new(shape: DeploymentStrategyList, location_name: "Items"))
|
@@ -6,6 +6,32 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::AppConfig
|
9
|
+
|
10
|
+
# When AppConfig returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::AppConfig::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all AppConfig errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::AppConfig::Errors::ServiceError
|
18
|
+
# # rescues all AppConfig API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {BadRequestException}
|
29
|
+
# * {ConflictException}
|
30
|
+
# * {InternalServerException}
|
31
|
+
# * {ResourceNotFoundException}
|
32
|
+
#
|
33
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
34
|
+
# if they are not defined above.
|
9
35
|
module Errors
|
10
36
|
|
11
37
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +49,6 @@ module Aws::AppConfig
|
|
23
49
|
def message
|
24
50
|
@message || @data[:message]
|
25
51
|
end
|
26
|
-
|
27
52
|
end
|
28
53
|
|
29
54
|
class ConflictException < ServiceError
|
@@ -39,7 +64,6 @@ module Aws::AppConfig
|
|
39
64
|
def message
|
40
65
|
@message || @data[:message]
|
41
66
|
end
|
42
|
-
|
43
67
|
end
|
44
68
|
|
45
69
|
class InternalServerException < ServiceError
|
@@ -55,7 +79,6 @@ module Aws::AppConfig
|
|
55
79
|
def message
|
56
80
|
@message || @data[:message]
|
57
81
|
end
|
58
|
-
|
59
82
|
end
|
60
83
|
|
61
84
|
class ResourceNotFoundException < ServiceError
|
@@ -76,7 +99,6 @@ module Aws::AppConfig
|
|
76
99
|
def resource_name
|
77
100
|
@data[:resource_name]
|
78
101
|
end
|
79
|
-
|
80
102
|
end
|
81
103
|
|
82
104
|
end
|
@@ -257,12 +257,15 @@ module Aws::AppConfig
|
|
257
257
|
# @return [String]
|
258
258
|
#
|
259
259
|
# @!attribute [rw] location_uri
|
260
|
-
# A URI to locate the configuration. You can specify
|
261
|
-
#
|
262
|
-
# SSM document, specify either the document name in the
|
263
|
-
# `ssm-document://<
|
264
|
-
# For a parameter, specify either the parameter name in the
|
265
|
-
# `ssm-parameter://<
|
260
|
+
# A URI to locate the configuration. You can specify a Systems Manager
|
261
|
+
# (SSM) document, an SSM Parameter Store parameter, or an Amazon S3
|
262
|
+
# object. For an SSM document, specify either the document name in the
|
263
|
+
# format `ssm-document://<Document_name>` or the Amazon Resource Name
|
264
|
+
# (ARN). For a parameter, specify either the parameter name in the
|
265
|
+
# format `ssm-parameter://<Parameter_name>` or the ARN. For an Amazon
|
266
|
+
# S3 object, specify the URI in the following format:
|
267
|
+
# `s3://<bucket>/<objectKey> `. Here is an example:
|
268
|
+
# s3://my-bucket/my-app/us-east-1/my-config.json
|
266
269
|
# @return [String]
|
267
270
|
#
|
268
271
|
# @!attribute [rw] retrieval_role_arn
|
@@ -302,7 +305,7 @@ module Aws::AppConfig
|
|
302
305
|
# deployment_duration_in_minutes: 1, # required
|
303
306
|
# final_bake_time_in_minutes: 1,
|
304
307
|
# growth_factor: 1.0, # required
|
305
|
-
# growth_type: "LINEAR", # accepts LINEAR
|
308
|
+
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
306
309
|
# replicate_to: "NONE", # required, accepts NONE, SSM_DOCUMENT
|
307
310
|
# tags: {
|
308
311
|
# "TagKey" => "TagValue",
|
@@ -333,7 +336,33 @@ module Aws::AppConfig
|
|
333
336
|
# @return [Float]
|
334
337
|
#
|
335
338
|
# @!attribute [rw] growth_type
|
336
|
-
# The algorithm used to define how percentage grows over time.
|
339
|
+
# The algorithm used to define how percentage grows over time. AWS
|
340
|
+
# AppConfig supports the following growth types:
|
341
|
+
#
|
342
|
+
# **Linear**\: For this type, AppConfig processes the deployment by
|
343
|
+
# dividing the total number of targets by the value specified for
|
344
|
+
# `Step percentage`. For example, a linear deployment that uses a
|
345
|
+
# `Step percentage` of 10 deploys the configuration to 10 percent of
|
346
|
+
# the hosts. After those deployments are complete, the system deploys
|
347
|
+
# the configuration to the next 10 percent. This continues until 100%
|
348
|
+
# of the targets have successfully received the configuration.
|
349
|
+
#
|
350
|
+
# **Exponential**\: For this type, AppConfig processes the deployment
|
351
|
+
# exponentially using the following formula: `G*(2^N)`. In this
|
352
|
+
# formula, `G` is the growth factor specified by the user and `N` is
|
353
|
+
# the number of steps until the configuration is deployed to all
|
354
|
+
# targets. For example, if you specify a growth factor of 2, then the
|
355
|
+
# system rolls out the configuration as follows:
|
356
|
+
#
|
357
|
+
# `2*(2^0)`
|
358
|
+
#
|
359
|
+
# `2*(2^1)`
|
360
|
+
#
|
361
|
+
# `2*(2^2)`
|
362
|
+
#
|
363
|
+
# Expressed numerically, the deployment rolls out as follows: 2% of
|
364
|
+
# the targets, 4% of the targets, 8% of the targets, and continues
|
365
|
+
# until the configuration has been deployed to all targets.
|
337
366
|
# @return [String]
|
338
367
|
#
|
339
368
|
# @!attribute [rw] replicate_to
|
@@ -555,6 +584,11 @@ module Aws::AppConfig
|
|
555
584
|
# The state of the deployment.
|
556
585
|
# @return [String]
|
557
586
|
#
|
587
|
+
# @!attribute [rw] event_log
|
588
|
+
# A list containing all events related to a deployment. The most
|
589
|
+
# recent events are displayed first.
|
590
|
+
# @return [Array<Types::DeploymentEvent>]
|
591
|
+
#
|
558
592
|
# @!attribute [rw] percentage_complete
|
559
593
|
# The percentage of targets for which the deployment is available.
|
560
594
|
# @return [Float]
|
@@ -584,12 +618,50 @@ module Aws::AppConfig
|
|
584
618
|
:growth_factor,
|
585
619
|
:final_bake_time_in_minutes,
|
586
620
|
:state,
|
621
|
+
:event_log,
|
587
622
|
:percentage_complete,
|
588
623
|
:started_at,
|
589
624
|
:completed_at)
|
590
625
|
include Aws::Structure
|
591
626
|
end
|
592
627
|
|
628
|
+
# An object that describes a deployment event.
|
629
|
+
#
|
630
|
+
# @!attribute [rw] event_type
|
631
|
+
# The type of deployment event. Deployment event types include the
|
632
|
+
# start, stop, or completion of a deployment; a percentage update; the
|
633
|
+
# start or stop of a bake period; the start or completion of a
|
634
|
+
# rollback.
|
635
|
+
# @return [String]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] triggered_by
|
638
|
+
# The entity that triggered the deployment event. Events can be
|
639
|
+
# triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or
|
640
|
+
# an internal error.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] description
|
644
|
+
# A description of the deployment event. Descriptions include, but are
|
645
|
+
# not limited to, the user account or the CloudWatch alarm ARN that
|
646
|
+
# initiated a rollback, the percentage of hosts that received the
|
647
|
+
# deployment, or in the case of an internal error, a recommendation to
|
648
|
+
# attempt a new deployment.
|
649
|
+
# @return [String]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] occurred_at
|
652
|
+
# The date and time the event occurred.
|
653
|
+
# @return [Time]
|
654
|
+
#
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeploymentEvent AWS API Documentation
|
656
|
+
#
|
657
|
+
class DeploymentEvent < Struct.new(
|
658
|
+
:event_type,
|
659
|
+
:triggered_by,
|
660
|
+
:description,
|
661
|
+
:occurred_at)
|
662
|
+
include Aws::Structure
|
663
|
+
end
|
664
|
+
|
593
665
|
# @!attribute [rw] items
|
594
666
|
# The elements from this collection.
|
595
667
|
# @return [Array<Types::DeploymentStrategy>]
|
@@ -849,15 +921,18 @@ module Aws::AppConfig
|
|
849
921
|
# }
|
850
922
|
#
|
851
923
|
# @!attribute [rw] application
|
852
|
-
# The application to get.
|
924
|
+
# The application to get. Specify either the application name or the
|
925
|
+
# application ID.
|
853
926
|
# @return [String]
|
854
927
|
#
|
855
928
|
# @!attribute [rw] environment
|
856
|
-
# The environment to get.
|
929
|
+
# The environment to get. Specify either the environment name or the
|
930
|
+
# environment ID.
|
857
931
|
# @return [String]
|
858
932
|
#
|
859
933
|
# @!attribute [rw] configuration
|
860
|
-
# The configuration to get.
|
934
|
+
# The configuration to get. Specify either the configuration name or
|
935
|
+
# the configuration ID.
|
861
936
|
# @return [String]
|
862
937
|
#
|
863
938
|
# @!attribute [rw] client_id
|
@@ -868,7 +943,26 @@ module Aws::AppConfig
|
|
868
943
|
#
|
869
944
|
# @!attribute [rw] client_configuration_version
|
870
945
|
# The configuration version returned in the most recent
|
871
|
-
# GetConfiguration response.
|
946
|
+
# `GetConfiguration` response.
|
947
|
+
#
|
948
|
+
# AWS AppConfig uses the value of the `ClientConfigurationVersion`
|
949
|
+
# parameter to identify the configuration version on your clients. If
|
950
|
+
# you don’t send `ClientConfigurationVersion` with each call to
|
951
|
+
# `GetConfiguration`, your clients receive the current configuration.
|
952
|
+
# You are charged each time your clients receive a configuration.
|
953
|
+
#
|
954
|
+
# To avoid excess charges, we recommend that you include the
|
955
|
+
# `ClientConfigurationVersion` value with every call to
|
956
|
+
# `GetConfiguration`. This value must be saved on your client.
|
957
|
+
# Subsequent calls to `GetConfiguration` must pass this value by using
|
958
|
+
# the `ClientConfigurationVersion` parameter.
|
959
|
+
#
|
960
|
+
# For more information about working with configurations, see
|
961
|
+
# [Retrieving the Configuration][1] in the *AWS AppConfig User Guide*.
|
962
|
+
#
|
963
|
+
#
|
964
|
+
#
|
965
|
+
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-retrieving-the-configuration.html
|
872
966
|
# @return [String]
|
873
967
|
#
|
874
968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfigurationRequest AWS API Documentation
|
@@ -1434,7 +1528,7 @@ module Aws::AppConfig
|
|
1434
1528
|
# deployment_duration_in_minutes: 1,
|
1435
1529
|
# final_bake_time_in_minutes: 1,
|
1436
1530
|
# growth_factor: 1.0,
|
1437
|
-
# growth_type: "LINEAR", # accepts LINEAR
|
1531
|
+
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
1438
1532
|
# }
|
1439
1533
|
#
|
1440
1534
|
# @!attribute [rw] deployment_strategy_id
|
@@ -1461,7 +1555,34 @@ module Aws::AppConfig
|
|
1461
1555
|
# @return [Float]
|
1462
1556
|
#
|
1463
1557
|
# @!attribute [rw] growth_type
|
1464
|
-
# The algorithm used to define how percentage grows over time.
|
1558
|
+
# The algorithm used to define how percentage grows over time. AWS
|
1559
|
+
# AppConfig supports the following growth types:
|
1560
|
+
#
|
1561
|
+
# **Linear**\: For this type, AppConfig processes the deployment by
|
1562
|
+
# increments of the growth factor evenly distributed over the
|
1563
|
+
# deployment time. For example, a linear deployment that uses a growth
|
1564
|
+
# factor of 20 initially makes the configuration available to 20
|
1565
|
+
# percent of the targets. After 1/5th of the deployment time has
|
1566
|
+
# passed, the system updates the percentage to 40 percent. This
|
1567
|
+
# continues until 100% of the targets are set to receive the deployed
|
1568
|
+
# configuration.
|
1569
|
+
#
|
1570
|
+
# **Exponential**\: For this type, AppConfig processes the deployment
|
1571
|
+
# exponentially using the following formula: `G*(2^N)`. In this
|
1572
|
+
# formula, `G` is the growth factor specified by the user and `N` is
|
1573
|
+
# the number of steps until the configuration is deployed to all
|
1574
|
+
# targets. For example, if you specify a growth factor of 2, then the
|
1575
|
+
# system rolls out the configuration as follows:
|
1576
|
+
#
|
1577
|
+
# `2*(2^0)`
|
1578
|
+
#
|
1579
|
+
# `2*(2^1)`
|
1580
|
+
#
|
1581
|
+
# `2*(2^2)`
|
1582
|
+
#
|
1583
|
+
# Expressed numerically, the deployment rolls out as follows: 2% of
|
1584
|
+
# the targets, 4% of the targets, 8% of the targets, and continues
|
1585
|
+
# until the configuration has been deployed to all targets.
|
1465
1586
|
# @return [String]
|
1466
1587
|
#
|
1467
1588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateDeploymentStrategyRequest AWS API Documentation
|
@@ -1573,7 +1694,8 @@ module Aws::AppConfig
|
|
1573
1694
|
# @return [String]
|
1574
1695
|
#
|
1575
1696
|
# @!attribute [rw] content
|
1576
|
-
# Either the JSON Schema content or
|
1697
|
+
# Either the JSON Schema content or the Amazon Resource Name (ARN) of
|
1698
|
+
# an AWS Lambda function.
|
1577
1699
|
# @return [String]
|
1578
1700
|
#
|
1579
1701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Validator AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-appconfig
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.6.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:
|
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
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - AppConfig
|