aws-sdk-appconfig 1.11.0 → 1.67.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 +4 -4
- data/CHANGELOG.md +350 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-appconfig/client.rb +2189 -260
- data/lib/aws-sdk-appconfig/client_api.rb +412 -22
- data/lib/aws-sdk-appconfig/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-appconfig/endpoint_provider.rb +56 -0
- data/lib/aws-sdk-appconfig/endpoints.rb +20 -0
- data/lib/aws-sdk-appconfig/errors.rb +11 -1
- data/lib/aws-sdk-appconfig/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-appconfig/resource.rb +1 -1
- data/lib/aws-sdk-appconfig/types.rb +1214 -474
- data/lib/aws-sdk-appconfig/waiters.rb +177 -0
- data/lib/aws-sdk-appconfig.rb +17 -8
- data/sig/client.rbs +848 -0
- data/sig/errors.rbs +40 -0
- data/sig/resource.rbs +84 -0
- data/sig/types.rbs +679 -0
- data/sig/waiters.rbs +36 -0
- metadata +24 -15
@@ -3,13 +3,141 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
10
|
module Aws::AppConfig
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# @!attribute [rw] deletion_protection
|
14
|
+
# A parameter to configure deletion protection. Deletion protection
|
15
|
+
# prevents a user from deleting a configuration profile or an
|
16
|
+
# environment if AppConfig has called either
|
17
|
+
# [GetLatestConfiguration][1] or for the configuration profile or from
|
18
|
+
# the environment during the specified interval. The default interval
|
19
|
+
# for `ProtectionPeriodInMinutes` is 60.
|
20
|
+
#
|
21
|
+
#
|
22
|
+
#
|
23
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
|
24
|
+
# @return [Types::DeletionProtectionSettings]
|
25
|
+
#
|
26
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/AccountSettings AWS API Documentation
|
27
|
+
#
|
28
|
+
class AccountSettings < Struct.new(
|
29
|
+
:deletion_protection)
|
30
|
+
SENSITIVE = []
|
31
|
+
include Aws::Structure
|
32
|
+
end
|
33
|
+
|
34
|
+
# An action defines the tasks that the extension performs during the
|
35
|
+
# AppConfig workflow. Each action includes an action point, as shown in
|
36
|
+
# the following list:
|
37
|
+
#
|
38
|
+
# * `PRE_CREATE_HOSTED_CONFIGURATION_VERSION`
|
39
|
+
#
|
40
|
+
# * `PRE_START_DEPLOYMENT`
|
41
|
+
#
|
42
|
+
# * `AT_DEPLOYMENT_TICK`
|
43
|
+
#
|
44
|
+
# * `ON_DEPLOYMENT_START`
|
45
|
+
#
|
46
|
+
# * `ON_DEPLOYMENT_STEP`
|
47
|
+
#
|
48
|
+
# * `ON_DEPLOYMENT_BAKING`
|
49
|
+
#
|
50
|
+
# * `ON_DEPLOYMENT_COMPLETE`
|
51
|
+
#
|
52
|
+
# * `ON_DEPLOYMENT_ROLLED_BACK`
|
53
|
+
#
|
54
|
+
# Each action also includes a name, a URI to an Lambda function, and an
|
55
|
+
# Amazon Resource Name (ARN) for an Identity and Access Management
|
56
|
+
# assume role. You specify the name, URI, and ARN for each *action
|
57
|
+
# point* defined in the extension.
|
58
|
+
#
|
59
|
+
# @!attribute [rw] name
|
60
|
+
# The action name.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] description
|
64
|
+
# Information about the action.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] uri
|
68
|
+
# The extension URI associated to the action point in the extension
|
69
|
+
# definition. The URI can be an Amazon Resource Name (ARN) for one of
|
70
|
+
# the following: an Lambda function, an Amazon Simple Queue Service
|
71
|
+
# queue, an Amazon Simple Notification Service topic, or the Amazon
|
72
|
+
# EventBridge default event bus.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] role_arn
|
76
|
+
# An Amazon Resource Name (ARN) for an Identity and Access Management
|
77
|
+
# assume role.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Action AWS API Documentation
|
81
|
+
#
|
82
|
+
class Action < Struct.new(
|
83
|
+
:name,
|
84
|
+
:description,
|
85
|
+
:uri,
|
86
|
+
:role_arn)
|
87
|
+
SENSITIVE = []
|
88
|
+
include Aws::Structure
|
89
|
+
end
|
90
|
+
|
91
|
+
# An extension that was invoked as part of a deployment event.
|
92
|
+
#
|
93
|
+
# @!attribute [rw] extension_identifier
|
94
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
95
|
+
# extension.
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] action_name
|
99
|
+
# The name of the action.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @!attribute [rw] uri
|
103
|
+
# The extension URI associated to the action point in the extension
|
104
|
+
# definition. The URI can be an Amazon Resource Name (ARN) for one of
|
105
|
+
# the following: an Lambda function, an Amazon Simple Queue Service
|
106
|
+
# queue, an Amazon Simple Notification Service topic, or the Amazon
|
107
|
+
# EventBridge default event bus.
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @!attribute [rw] role_arn
|
111
|
+
# An Amazon Resource Name (ARN) for an Identity and Access Management
|
112
|
+
# assume role.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] error_message
|
116
|
+
# The error message when an extension invocation fails.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] error_code
|
120
|
+
# The error code when an extension invocation fails.
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] invocation_id
|
124
|
+
# A system-generated ID for this invocation.
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ActionInvocation AWS API Documentation
|
128
|
+
#
|
129
|
+
class ActionInvocation < Struct.new(
|
130
|
+
:extension_identifier,
|
131
|
+
:action_name,
|
132
|
+
:uri,
|
133
|
+
:role_arn,
|
134
|
+
:error_message,
|
135
|
+
:error_code,
|
136
|
+
:invocation_id)
|
137
|
+
SENSITIVE = []
|
138
|
+
include Aws::Structure
|
139
|
+
end
|
140
|
+
|
13
141
|
# @!attribute [rw] id
|
14
142
|
# The application ID.
|
15
143
|
# @return [String]
|
@@ -50,22 +178,88 @@ module Aws::AppConfig
|
|
50
178
|
include Aws::Structure
|
51
179
|
end
|
52
180
|
|
53
|
-
#
|
54
|
-
#
|
181
|
+
# An extension that was invoked during a deployment.
|
182
|
+
#
|
183
|
+
# @!attribute [rw] extension_id
|
184
|
+
# The system-generated ID of the extension.
|
185
|
+
# @return [String]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] extension_association_id
|
188
|
+
# The system-generated ID for the association.
|
189
|
+
# @return [String]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] version_number
|
192
|
+
# The extension version number.
|
193
|
+
# @return [Integer]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] parameters
|
196
|
+
# One or more parameters for the actions called by the extension.
|
197
|
+
# @return [Hash<String,String>]
|
198
|
+
#
|
199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/AppliedExtension AWS API Documentation
|
200
|
+
#
|
201
|
+
class AppliedExtension < Struct.new(
|
202
|
+
:extension_id,
|
203
|
+
:extension_association_id,
|
204
|
+
:version_number,
|
205
|
+
:parameters)
|
206
|
+
SENSITIVE = []
|
207
|
+
include Aws::Structure
|
208
|
+
end
|
209
|
+
|
210
|
+
# Detailed information about the input that failed to satisfy the
|
211
|
+
# constraints specified by a call.
|
212
|
+
#
|
213
|
+
# @!attribute [rw] invalid_configuration
|
214
|
+
# Detailed information about the bad request exception error when
|
215
|
+
# creating a hosted configuration version.
|
216
|
+
# @return [Array<Types::InvalidConfigurationDetail>]
|
217
|
+
#
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/BadRequestDetails AWS API Documentation
|
219
|
+
#
|
220
|
+
class BadRequestDetails < Struct.new(
|
221
|
+
:invalid_configuration,
|
222
|
+
:unknown)
|
223
|
+
SENSITIVE = []
|
224
|
+
include Aws::Structure
|
225
|
+
include Aws::Structure::Union
|
226
|
+
|
227
|
+
class InvalidConfiguration < BadRequestDetails; end
|
228
|
+
class Unknown < BadRequestDetails; end
|
229
|
+
end
|
230
|
+
|
231
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
232
|
+
# Services service.
|
55
233
|
#
|
56
234
|
# @!attribute [rw] message
|
57
235
|
# @return [String]
|
58
236
|
#
|
237
|
+
# @!attribute [rw] reason
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] details
|
241
|
+
# Detailed information about the input that failed to satisfy the
|
242
|
+
# constraints specified by a call.
|
243
|
+
# @return [Types::BadRequestDetails]
|
244
|
+
#
|
59
245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/BadRequestException AWS API Documentation
|
60
246
|
#
|
61
247
|
class BadRequestException < Struct.new(
|
62
|
-
:message
|
248
|
+
:message,
|
249
|
+
:reason,
|
250
|
+
:details)
|
63
251
|
SENSITIVE = []
|
64
252
|
include Aws::Structure
|
65
253
|
end
|
66
254
|
|
67
255
|
# @!attribute [rw] content
|
68
256
|
# The content of the configuration or the configuration data.
|
257
|
+
#
|
258
|
+
# The `Content` attribute only contains data if the system finds new
|
259
|
+
# or updated configuration data. If there is no new or updated data
|
260
|
+
# and `ClientConfigurationVersion` matches the version of the current
|
261
|
+
# configuration, AppConfig returns a `204 No Content` HTTP response
|
262
|
+
# code and the `Content` value will be empty.
|
69
263
|
# @return [String]
|
70
264
|
#
|
71
265
|
# @!attribute [rw] configuration_version
|
@@ -113,13 +307,40 @@ module Aws::AppConfig
|
|
113
307
|
#
|
114
308
|
# @!attribute [rw] retrieval_role_arn
|
115
309
|
# The ARN of an IAM role with permission to access the configuration
|
116
|
-
# at the specified LocationUri
|
310
|
+
# at the specified `LocationUri`.
|
117
311
|
# @return [String]
|
118
312
|
#
|
119
313
|
# @!attribute [rw] validators
|
120
314
|
# A list of methods for validating the configuration.
|
121
315
|
# @return [Array<Types::Validator>]
|
122
316
|
#
|
317
|
+
# @!attribute [rw] type
|
318
|
+
# The type of configurations contained in the profile. AppConfig
|
319
|
+
# supports `feature flags` and `freeform` configurations. We recommend
|
320
|
+
# you create feature flag configurations to enable or disable new
|
321
|
+
# features and freeform configurations to distribute configurations to
|
322
|
+
# an application. When calling this API, enter one of the following
|
323
|
+
# values for `Type`:
|
324
|
+
#
|
325
|
+
# `AWS.AppConfig.FeatureFlags`
|
326
|
+
#
|
327
|
+
# `AWS.Freeform`
|
328
|
+
# @return [String]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] kms_key_arn
|
331
|
+
# The Amazon Resource Name of the Key Management Service key to
|
332
|
+
# encrypt new configuration data versions in the AppConfig hosted
|
333
|
+
# configuration store. This attribute is only used for `hosted`
|
334
|
+
# configuration types. To encrypt data managed in other configuration
|
335
|
+
# stores, see the documentation for how to specify an KMS key for that
|
336
|
+
# particular service.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] kms_key_identifier
|
340
|
+
# The Key Management Service key identifier (key ID, key alias, or key
|
341
|
+
# ARN) provided when the resource was created or updated.
|
342
|
+
# @return [String]
|
343
|
+
#
|
123
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ConfigurationProfile AWS API Documentation
|
124
345
|
#
|
125
346
|
class ConfigurationProfile < Struct.new(
|
@@ -129,7 +350,10 @@ module Aws::AppConfig
|
|
129
350
|
:description,
|
130
351
|
:location_uri,
|
131
352
|
:retrieval_role_arn,
|
132
|
-
:validators
|
353
|
+
:validators,
|
354
|
+
:type,
|
355
|
+
:kms_key_arn,
|
356
|
+
:kms_key_identifier)
|
133
357
|
SENSITIVE = []
|
134
358
|
include Aws::Structure
|
135
359
|
end
|
@@ -156,6 +380,19 @@ module Aws::AppConfig
|
|
156
380
|
# The types of validators in the configuration profile.
|
157
381
|
# @return [Array<String>]
|
158
382
|
#
|
383
|
+
# @!attribute [rw] type
|
384
|
+
# The type of configurations contained in the profile. AppConfig
|
385
|
+
# supports `feature flags` and `freeform` configurations. We recommend
|
386
|
+
# you create feature flag configurations to enable or disable new
|
387
|
+
# features and freeform configurations to distribute configurations to
|
388
|
+
# an application. When calling this API, enter one of the following
|
389
|
+
# values for `Type`:
|
390
|
+
#
|
391
|
+
# `AWS.AppConfig.FeatureFlags`
|
392
|
+
#
|
393
|
+
# `AWS.Freeform`
|
394
|
+
# @return [String]
|
395
|
+
#
|
159
396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ConfigurationProfileSummary AWS API Documentation
|
160
397
|
#
|
161
398
|
class ConfigurationProfileSummary < Struct.new(
|
@@ -163,7 +400,8 @@ module Aws::AppConfig
|
|
163
400
|
:id,
|
164
401
|
:name,
|
165
402
|
:location_uri,
|
166
|
-
:validator_types
|
403
|
+
:validator_types,
|
404
|
+
:type)
|
167
405
|
SENSITIVE = []
|
168
406
|
include Aws::Structure
|
169
407
|
end
|
@@ -200,17 +438,6 @@ module Aws::AppConfig
|
|
200
438
|
include Aws::Structure
|
201
439
|
end
|
202
440
|
|
203
|
-
# @note When making an API call, you may pass CreateApplicationRequest
|
204
|
-
# data as a hash:
|
205
|
-
#
|
206
|
-
# {
|
207
|
-
# name: "Name", # required
|
208
|
-
# description: "Description",
|
209
|
-
# tags: {
|
210
|
-
# "TagKey" => "TagValue",
|
211
|
-
# },
|
212
|
-
# }
|
213
|
-
#
|
214
441
|
# @!attribute [rw] name
|
215
442
|
# A name for the application.
|
216
443
|
# @return [String]
|
@@ -235,26 +462,6 @@ module Aws::AppConfig
|
|
235
462
|
include Aws::Structure
|
236
463
|
end
|
237
464
|
|
238
|
-
# @note When making an API call, you may pass CreateConfigurationProfileRequest
|
239
|
-
# data as a hash:
|
240
|
-
#
|
241
|
-
# {
|
242
|
-
# application_id: "Id", # required
|
243
|
-
# name: "Name", # required
|
244
|
-
# description: "Description",
|
245
|
-
# location_uri: "Uri", # required
|
246
|
-
# retrieval_role_arn: "RoleArn",
|
247
|
-
# validators: [
|
248
|
-
# {
|
249
|
-
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
250
|
-
# content: "StringWithLengthBetween0And32768", # required
|
251
|
-
# },
|
252
|
-
# ],
|
253
|
-
# tags: {
|
254
|
-
# "TagKey" => "TagValue",
|
255
|
-
# },
|
256
|
-
# }
|
257
|
-
#
|
258
465
|
# @!attribute [rw] application_id
|
259
466
|
# The application ID.
|
260
467
|
# @return [String]
|
@@ -268,20 +475,37 @@ module Aws::AppConfig
|
|
268
475
|
# @return [String]
|
269
476
|
#
|
270
477
|
# @!attribute [rw] location_uri
|
271
|
-
# A URI to locate the configuration. You can specify
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
478
|
+
# A URI to locate the configuration. You can specify the following:
|
479
|
+
#
|
480
|
+
# * For the AppConfig hosted configuration store and for feature
|
481
|
+
# flags, specify `hosted`.
|
482
|
+
#
|
483
|
+
# * For an Amazon Web Services Systems Manager Parameter Store
|
484
|
+
# parameter, specify either the parameter name in the format
|
485
|
+
# `ssm-parameter://<parameter name>` or the ARN.
|
486
|
+
#
|
487
|
+
# * For an Amazon Web Services CodePipeline pipeline, specify the URI
|
488
|
+
# in the following format: `codepipeline`://<pipeline name>.
|
489
|
+
#
|
490
|
+
# * For an Secrets Manager secret, specify the URI in the following
|
491
|
+
# format: `secretsmanager`://<secret name>.
|
492
|
+
#
|
493
|
+
# * For an Amazon S3 object, specify the URI in the following format:
|
494
|
+
# `s3://<bucket>/<objectKey> `. Here is an example:
|
495
|
+
# `s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json`
|
496
|
+
#
|
497
|
+
# * For an SSM document, specify either the document name in the
|
498
|
+
# format `ssm-document://<document name>` or the Amazon Resource
|
499
|
+
# Name (ARN).
|
280
500
|
# @return [String]
|
281
501
|
#
|
282
502
|
# @!attribute [rw] retrieval_role_arn
|
283
503
|
# The ARN of an IAM role with permission to access the configuration
|
284
|
-
# at the specified LocationUri
|
504
|
+
# at the specified `LocationUri`.
|
505
|
+
#
|
506
|
+
# A retrieval role ARN is not required for configurations stored in
|
507
|
+
# CodePipeline or the AppConfig hosted configuration store. It is
|
508
|
+
# required for all other sources that store your configuration.
|
285
509
|
# @return [String]
|
286
510
|
#
|
287
511
|
# @!attribute [rw] validators
|
@@ -294,6 +518,29 @@ module Aws::AppConfig
|
|
294
518
|
# and an optional value, both of which you define.
|
295
519
|
# @return [Hash<String,String>]
|
296
520
|
#
|
521
|
+
# @!attribute [rw] type
|
522
|
+
# The type of configurations contained in the profile. AppConfig
|
523
|
+
# supports `feature flags` and `freeform` configurations. We recommend
|
524
|
+
# you create feature flag configurations to enable or disable new
|
525
|
+
# features and freeform configurations to distribute configurations to
|
526
|
+
# an application. When calling this API, enter one of the following
|
527
|
+
# values for `Type`:
|
528
|
+
#
|
529
|
+
# `AWS.AppConfig.FeatureFlags`
|
530
|
+
#
|
531
|
+
# `AWS.Freeform`
|
532
|
+
# @return [String]
|
533
|
+
#
|
534
|
+
# @!attribute [rw] kms_key_identifier
|
535
|
+
# The identifier for an Key Management Service key to encrypt new
|
536
|
+
# configuration data versions in the AppConfig hosted configuration
|
537
|
+
# store. This attribute is only used for `hosted` configuration types.
|
538
|
+
# The identifier can be an KMS key ID, alias, or the Amazon Resource
|
539
|
+
# Name (ARN) of the key ID or alias. To encrypt data managed in other
|
540
|
+
# configuration stores, see the documentation for how to specify an
|
541
|
+
# KMS key for that particular service.
|
542
|
+
# @return [String]
|
543
|
+
#
|
297
544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateConfigurationProfileRequest AWS API Documentation
|
298
545
|
#
|
299
546
|
class CreateConfigurationProfileRequest < Struct.new(
|
@@ -303,27 +550,13 @@ module Aws::AppConfig
|
|
303
550
|
:location_uri,
|
304
551
|
:retrieval_role_arn,
|
305
552
|
:validators,
|
306
|
-
:tags
|
553
|
+
:tags,
|
554
|
+
:type,
|
555
|
+
:kms_key_identifier)
|
307
556
|
SENSITIVE = []
|
308
557
|
include Aws::Structure
|
309
558
|
end
|
310
559
|
|
311
|
-
# @note When making an API call, you may pass CreateDeploymentStrategyRequest
|
312
|
-
# data as a hash:
|
313
|
-
#
|
314
|
-
# {
|
315
|
-
# name: "Name", # required
|
316
|
-
# description: "Description",
|
317
|
-
# deployment_duration_in_minutes: 1, # required
|
318
|
-
# final_bake_time_in_minutes: 1,
|
319
|
-
# growth_factor: 1.0, # required
|
320
|
-
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
321
|
-
# replicate_to: "NONE", # required, accepts NONE, SSM_DOCUMENT
|
322
|
-
# tags: {
|
323
|
-
# "TagKey" => "TagValue",
|
324
|
-
# },
|
325
|
-
# }
|
326
|
-
#
|
327
560
|
# @!attribute [rw] name
|
328
561
|
# A name for the deployment strategy.
|
329
562
|
# @return [String]
|
@@ -337,9 +570,18 @@ module Aws::AppConfig
|
|
337
570
|
# @return [Integer]
|
338
571
|
#
|
339
572
|
# @!attribute [rw] final_bake_time_in_minutes
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
573
|
+
# Specifies the amount of time AppConfig monitors for Amazon
|
574
|
+
# CloudWatch alarms after the configuration has been deployed to 100%
|
575
|
+
# of its targets, before considering the deployment to be complete. If
|
576
|
+
# an alarm is triggered during this time, AppConfig rolls back the
|
577
|
+
# deployment. You must configure permissions for AppConfig to roll
|
578
|
+
# back based on CloudWatch alarms. For more information, see
|
579
|
+
# [Configuring permissions for rollback based on Amazon CloudWatch
|
580
|
+
# alarms][1] in the *AppConfig User Guide*.
|
581
|
+
#
|
582
|
+
#
|
583
|
+
#
|
584
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html
|
343
585
|
# @return [Integer]
|
344
586
|
#
|
345
587
|
# @!attribute [rw] growth_factor
|
@@ -348,10 +590,10 @@ module Aws::AppConfig
|
|
348
590
|
# @return [Float]
|
349
591
|
#
|
350
592
|
# @!attribute [rw] growth_type
|
351
|
-
# The algorithm used to define how percentage grows over time.
|
593
|
+
# The algorithm used to define how percentage grows over time.
|
352
594
|
# AppConfig supports the following growth types:
|
353
595
|
#
|
354
|
-
# **Linear
|
596
|
+
# **Linear**: For this type, AppConfig processes the deployment by
|
355
597
|
# dividing the total number of targets by the value specified for
|
356
598
|
# `Step percentage`. For example, a linear deployment that uses a
|
357
599
|
# `Step percentage` of 10 deploys the configuration to 10 percent of
|
@@ -359,7 +601,7 @@ module Aws::AppConfig
|
|
359
601
|
# the configuration to the next 10 percent. This continues until 100%
|
360
602
|
# of the targets have successfully received the configuration.
|
361
603
|
#
|
362
|
-
# **Exponential
|
604
|
+
# **Exponential**: For this type, AppConfig processes the deployment
|
363
605
|
# exponentially using the following formula: `G*(2^N)`. In this
|
364
606
|
# formula, `G` is the growth factor specified by the user and `N` is
|
365
607
|
# the number of steps until the configuration is deployed to all
|
@@ -402,24 +644,6 @@ module Aws::AppConfig
|
|
402
644
|
include Aws::Structure
|
403
645
|
end
|
404
646
|
|
405
|
-
# @note When making an API call, you may pass CreateEnvironmentRequest
|
406
|
-
# data as a hash:
|
407
|
-
#
|
408
|
-
# {
|
409
|
-
# application_id: "Id", # required
|
410
|
-
# name: "Name", # required
|
411
|
-
# description: "Description",
|
412
|
-
# monitors: [
|
413
|
-
# {
|
414
|
-
# alarm_arn: "Arn",
|
415
|
-
# alarm_role_arn: "RoleArn",
|
416
|
-
# },
|
417
|
-
# ],
|
418
|
-
# tags: {
|
419
|
-
# "TagKey" => "TagValue",
|
420
|
-
# },
|
421
|
-
# }
|
422
|
-
#
|
423
647
|
# @!attribute [rw] application_id
|
424
648
|
# The application ID.
|
425
649
|
# @return [String]
|
@@ -454,18 +678,91 @@ module Aws::AppConfig
|
|
454
678
|
include Aws::Structure
|
455
679
|
end
|
456
680
|
|
457
|
-
#
|
458
|
-
#
|
681
|
+
# @!attribute [rw] extension_identifier
|
682
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
683
|
+
# extension.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] extension_version_number
|
687
|
+
# The version number of the extension. If not specified, AppConfig
|
688
|
+
# uses the maximum version of the extension.
|
689
|
+
# @return [Integer]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] resource_identifier
|
692
|
+
# The ARN of an application, configuration profile, or environment.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] parameters
|
696
|
+
# The parameter names and values defined in the extensions. Extension
|
697
|
+
# parameters marked `Required` must be entered for this field.
|
698
|
+
# @return [Hash<String,String>]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] tags
|
701
|
+
# Adds one or more tags for the specified extension association. Tags
|
702
|
+
# are metadata that help you categorize resources in different ways,
|
703
|
+
# for example, by purpose, owner, or environment. Each tag consists of
|
704
|
+
# a key and an optional value, both of which you define.
|
705
|
+
# @return [Hash<String,String>]
|
706
|
+
#
|
707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateExtensionAssociationRequest AWS API Documentation
|
708
|
+
#
|
709
|
+
class CreateExtensionAssociationRequest < Struct.new(
|
710
|
+
:extension_identifier,
|
711
|
+
:extension_version_number,
|
712
|
+
:resource_identifier,
|
713
|
+
:parameters,
|
714
|
+
:tags)
|
715
|
+
SENSITIVE = []
|
716
|
+
include Aws::Structure
|
717
|
+
end
|
718
|
+
|
719
|
+
# @!attribute [rw] name
|
720
|
+
# A name for the extension. Each extension name in your account must
|
721
|
+
# be unique. Extension versions use the same name.
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] description
|
725
|
+
# Information about the extension.
|
726
|
+
# @return [String]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] actions
|
729
|
+
# The actions defined in the extension.
|
730
|
+
# @return [Hash<String,Array<Types::Action>>]
|
459
731
|
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
# }
|
732
|
+
# @!attribute [rw] parameters
|
733
|
+
# The parameters accepted by the extension. You specify parameter
|
734
|
+
# values when you associate the extension to an AppConfig resource by
|
735
|
+
# using the `CreateExtensionAssociation` API action. For Lambda
|
736
|
+
# extension actions, these parameters are included in the Lambda
|
737
|
+
# request object.
|
738
|
+
# @return [Hash<String,Types::Parameter>]
|
468
739
|
#
|
740
|
+
# @!attribute [rw] tags
|
741
|
+
# Adds one or more tags for the specified extension. Tags are metadata
|
742
|
+
# that help you categorize resources in different ways, for example,
|
743
|
+
# by purpose, owner, or environment. Each tag consists of a key and an
|
744
|
+
# optional value, both of which you define.
|
745
|
+
# @return [Hash<String,String>]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] latest_version_number
|
748
|
+
# You can omit this field when you create an extension. When you
|
749
|
+
# create a new version, specify the most recent current version
|
750
|
+
# number. For example, you create version 3, enter 2 for this field.
|
751
|
+
# @return [Integer]
|
752
|
+
#
|
753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateExtensionRequest AWS API Documentation
|
754
|
+
#
|
755
|
+
class CreateExtensionRequest < Struct.new(
|
756
|
+
:name,
|
757
|
+
:description,
|
758
|
+
:actions,
|
759
|
+
:parameters,
|
760
|
+
:tags,
|
761
|
+
:latest_version_number)
|
762
|
+
SENSITIVE = []
|
763
|
+
include Aws::Structure
|
764
|
+
end
|
765
|
+
|
469
766
|
# @!attribute [rw] application_id
|
470
767
|
# The application ID.
|
471
768
|
# @return [String]
|
@@ -479,7 +776,12 @@ module Aws::AppConfig
|
|
479
776
|
# @return [String]
|
480
777
|
#
|
481
778
|
# @!attribute [rw] content
|
482
|
-
# The
|
779
|
+
# The configuration data, as bytes.
|
780
|
+
#
|
781
|
+
# <note markdown="1"> AppConfig accepts any type of data, including text formats like JSON
|
782
|
+
# or TOML, or binary formats like protocol buffers or compressed data.
|
783
|
+
#
|
784
|
+
# </note>
|
483
785
|
# @return [String]
|
484
786
|
#
|
485
787
|
# @!attribute [rw] content_type
|
@@ -488,17 +790,23 @@ module Aws::AppConfig
|
|
488
790
|
#
|
489
791
|
#
|
490
792
|
#
|
491
|
-
# [1]: https://
|
793
|
+
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
492
794
|
# @return [String]
|
493
795
|
#
|
494
796
|
# @!attribute [rw] latest_version_number
|
495
797
|
# An optional locking token used to prevent race conditions from
|
496
798
|
# overwriting configuration updates when creating a new version. To
|
497
799
|
# ensure your data is not overwritten when creating multiple hosted
|
498
|
-
# configuration versions in rapid succession, specify the version
|
499
|
-
# the latest hosted configuration version.
|
800
|
+
# configuration versions in rapid succession, specify the version
|
801
|
+
# number of the latest hosted configuration version.
|
500
802
|
# @return [Integer]
|
501
803
|
#
|
804
|
+
# @!attribute [rw] version_label
|
805
|
+
# An optional, user-defined label for the AppConfig hosted
|
806
|
+
# configuration version. This value must contain at least one
|
807
|
+
# non-numeric character. For example, "v2.2.0".
|
808
|
+
# @return [String]
|
809
|
+
#
|
502
810
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateHostedConfigurationVersionRequest AWS API Documentation
|
503
811
|
#
|
504
812
|
class CreateHostedConfigurationVersionRequest < Struct.new(
|
@@ -507,18 +815,12 @@ module Aws::AppConfig
|
|
507
815
|
:description,
|
508
816
|
:content,
|
509
817
|
:content_type,
|
510
|
-
:latest_version_number
|
818
|
+
:latest_version_number,
|
819
|
+
:version_label)
|
511
820
|
SENSITIVE = [:content]
|
512
821
|
include Aws::Structure
|
513
822
|
end
|
514
823
|
|
515
|
-
# @note When making an API call, you may pass DeleteApplicationRequest
|
516
|
-
# data as a hash:
|
517
|
-
#
|
518
|
-
# {
|
519
|
-
# application_id: "Id", # required
|
520
|
-
# }
|
521
|
-
#
|
522
824
|
# @!attribute [rw] application_id
|
523
825
|
# The ID of the application to delete.
|
524
826
|
# @return [String]
|
@@ -531,14 +833,6 @@ module Aws::AppConfig
|
|
531
833
|
include Aws::Structure
|
532
834
|
end
|
533
835
|
|
534
|
-
# @note When making an API call, you may pass DeleteConfigurationProfileRequest
|
535
|
-
# data as a hash:
|
536
|
-
#
|
537
|
-
# {
|
538
|
-
# application_id: "Id", # required
|
539
|
-
# configuration_profile_id: "Id", # required
|
540
|
-
# }
|
541
|
-
#
|
542
836
|
# @!attribute [rw] application_id
|
543
837
|
# The application ID that includes the configuration profile you want
|
544
838
|
# to delete.
|
@@ -548,22 +842,43 @@ module Aws::AppConfig
|
|
548
842
|
# The ID of the configuration profile you want to delete.
|
549
843
|
# @return [String]
|
550
844
|
#
|
845
|
+
# @!attribute [rw] deletion_protection_check
|
846
|
+
# A parameter to configure deletion protection. Deletion protection
|
847
|
+
# prevents a user from deleting a configuration profile if your
|
848
|
+
# application has called either [GetLatestConfiguration][1] or for the
|
849
|
+
# configuration profile during the specified interval.
|
850
|
+
#
|
851
|
+
# This parameter supports the following values:
|
852
|
+
#
|
853
|
+
# * `BYPASS`: Instructs AppConfig to bypass the deletion protection
|
854
|
+
# check and delete a configuration profile even if deletion
|
855
|
+
# protection would have otherwise prevented it.
|
856
|
+
#
|
857
|
+
# * `APPLY`: Instructs the deletion protection check to run, even if
|
858
|
+
# deletion protection is disabled at the account level. `APPLY` also
|
859
|
+
# forces the deletion protection check to run against resources
|
860
|
+
# created in the past hour, which are normally excluded from
|
861
|
+
# deletion protection checks.
|
862
|
+
#
|
863
|
+
# * `ACCOUNT_DEFAULT`: The default setting, which instructs AppConfig
|
864
|
+
# to implement the deletion protection value specified in the
|
865
|
+
# `UpdateAccountSettings` API.
|
866
|
+
#
|
867
|
+
#
|
868
|
+
#
|
869
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
|
870
|
+
# @return [String]
|
871
|
+
#
|
551
872
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteConfigurationProfileRequest AWS API Documentation
|
552
873
|
#
|
553
874
|
class DeleteConfigurationProfileRequest < Struct.new(
|
554
875
|
:application_id,
|
555
|
-
:configuration_profile_id
|
876
|
+
:configuration_profile_id,
|
877
|
+
:deletion_protection_check)
|
556
878
|
SENSITIVE = []
|
557
879
|
include Aws::Structure
|
558
880
|
end
|
559
881
|
|
560
|
-
# @note When making an API call, you may pass DeleteDeploymentStrategyRequest
|
561
|
-
# data as a hash:
|
562
|
-
#
|
563
|
-
# {
|
564
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
565
|
-
# }
|
566
|
-
#
|
567
882
|
# @!attribute [rw] deployment_strategy_id
|
568
883
|
# The ID of the deployment strategy you want to delete.
|
569
884
|
# @return [String]
|
@@ -576,40 +891,83 @@ module Aws::AppConfig
|
|
576
891
|
include Aws::Structure
|
577
892
|
end
|
578
893
|
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
# {
|
583
|
-
# application_id: "Id", # required
|
584
|
-
# environment_id: "Id", # required
|
585
|
-
# }
|
894
|
+
# @!attribute [rw] environment_id
|
895
|
+
# The ID of the environment that you want to delete.
|
896
|
+
# @return [String]
|
586
897
|
#
|
587
898
|
# @!attribute [rw] application_id
|
588
|
-
# The application ID that includes the environment you want to
|
899
|
+
# The application ID that includes the environment that you want to
|
900
|
+
# delete.
|
589
901
|
# @return [String]
|
590
902
|
#
|
591
|
-
# @!attribute [rw]
|
592
|
-
#
|
903
|
+
# @!attribute [rw] deletion_protection_check
|
904
|
+
# A parameter to configure deletion protection. Deletion protection
|
905
|
+
# prevents a user from deleting an environment if your application
|
906
|
+
# called either [GetLatestConfiguration][1] or in the environment
|
907
|
+
# during the specified interval.
|
908
|
+
#
|
909
|
+
# This parameter supports the following values:
|
910
|
+
#
|
911
|
+
# * `BYPASS`: Instructs AppConfig to bypass the deletion protection
|
912
|
+
# check and delete a configuration profile even if deletion
|
913
|
+
# protection would have otherwise prevented it.
|
914
|
+
#
|
915
|
+
# * `APPLY`: Instructs the deletion protection check to run, even if
|
916
|
+
# deletion protection is disabled at the account level. `APPLY` also
|
917
|
+
# forces the deletion protection check to run against resources
|
918
|
+
# created in the past hour, which are normally excluded from
|
919
|
+
# deletion protection checks.
|
920
|
+
#
|
921
|
+
# * `ACCOUNT_DEFAULT`: The default setting, which instructs AppConfig
|
922
|
+
# to implement the deletion protection value specified in the
|
923
|
+
# `UpdateAccountSettings` API.
|
924
|
+
#
|
925
|
+
#
|
926
|
+
#
|
927
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
|
593
928
|
# @return [String]
|
594
929
|
#
|
595
930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteEnvironmentRequest AWS API Documentation
|
596
931
|
#
|
597
932
|
class DeleteEnvironmentRequest < Struct.new(
|
933
|
+
:environment_id,
|
598
934
|
:application_id,
|
599
|
-
:
|
935
|
+
:deletion_protection_check)
|
600
936
|
SENSITIVE = []
|
601
937
|
include Aws::Structure
|
602
938
|
end
|
603
939
|
|
604
|
-
#
|
605
|
-
#
|
940
|
+
# @!attribute [rw] extension_association_id
|
941
|
+
# The ID of the extension association to delete.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteExtensionAssociationRequest AWS API Documentation
|
606
945
|
#
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
946
|
+
class DeleteExtensionAssociationRequest < Struct.new(
|
947
|
+
:extension_association_id)
|
948
|
+
SENSITIVE = []
|
949
|
+
include Aws::Structure
|
950
|
+
end
|
951
|
+
|
952
|
+
# @!attribute [rw] extension_identifier
|
953
|
+
# The name, ID, or Amazon Resource Name (ARN) of the extension you
|
954
|
+
# want to delete.
|
955
|
+
# @return [String]
|
612
956
|
#
|
957
|
+
# @!attribute [rw] version_number
|
958
|
+
# A specific version of an extension to delete. If omitted, the
|
959
|
+
# highest version is deleted.
|
960
|
+
# @return [Integer]
|
961
|
+
#
|
962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteExtensionRequest AWS API Documentation
|
963
|
+
#
|
964
|
+
class DeleteExtensionRequest < Struct.new(
|
965
|
+
:extension_identifier,
|
966
|
+
:version_number)
|
967
|
+
SENSITIVE = []
|
968
|
+
include Aws::Structure
|
969
|
+
end
|
970
|
+
|
613
971
|
# @!attribute [rw] application_id
|
614
972
|
# The application ID.
|
615
973
|
# @return [String]
|
@@ -632,6 +990,46 @@ module Aws::AppConfig
|
|
632
990
|
include Aws::Structure
|
633
991
|
end
|
634
992
|
|
993
|
+
# A parameter to configure deletion protection. Deletion protection
|
994
|
+
# prevents a user from deleting a configuration profile or an
|
995
|
+
# environment if AppConfig has called either [GetLatestConfiguration][1]
|
996
|
+
# or for the configuration profile or from the environment during the
|
997
|
+
# specified interval.
|
998
|
+
#
|
999
|
+
# The default interval specified by `ProtectionPeriodInMinutes` is 60.
|
1000
|
+
# `DeletionProtectionCheck` skips configuration profiles and
|
1001
|
+
# environments that were created in the past hour.
|
1002
|
+
#
|
1003
|
+
#
|
1004
|
+
#
|
1005
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] enabled
|
1008
|
+
# A parameter that indicates if deletion protection is enabled or not.
|
1009
|
+
# @return [Boolean]
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] protection_period_in_minutes
|
1012
|
+
# The time interval during which AppConfig monitors for calls to
|
1013
|
+
# [GetLatestConfiguration][1] or for a configuration profile or from
|
1014
|
+
# an environment. AppConfig returns an error if a user calls or for
|
1015
|
+
# the designated configuration profile or environment. To bypass the
|
1016
|
+
# error and delete a configuration profile or an environment, specify
|
1017
|
+
# `BYPASS` for the `DeletionProtectionCheck` parameter for either or .
|
1018
|
+
#
|
1019
|
+
#
|
1020
|
+
#
|
1021
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
|
1022
|
+
# @return [Integer]
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeletionProtectionSettings AWS API Documentation
|
1025
|
+
#
|
1026
|
+
class DeletionProtectionSettings < Struct.new(
|
1027
|
+
:enabled,
|
1028
|
+
:protection_period_in_minutes)
|
1029
|
+
SENSITIVE = []
|
1030
|
+
include Aws::Structure
|
1031
|
+
end
|
1032
|
+
|
635
1033
|
# @!attribute [rw] application_id
|
636
1034
|
# The ID of the application that was deployed.
|
637
1035
|
# @return [String]
|
@@ -682,9 +1080,9 @@ module Aws::AppConfig
|
|
682
1080
|
# @return [Float]
|
683
1081
|
#
|
684
1082
|
# @!attribute [rw] final_bake_time_in_minutes
|
685
|
-
# The amount of time AppConfig monitored for alarms before
|
686
|
-
# the deployment to be complete and no longer eligible for
|
687
|
-
#
|
1083
|
+
# The amount of time that AppConfig monitored for alarms before
|
1084
|
+
# considering the deployment to be complete and no longer eligible for
|
1085
|
+
# automatic rollback.
|
688
1086
|
# @return [Integer]
|
689
1087
|
#
|
690
1088
|
# @!attribute [rw] state
|
@@ -708,6 +1106,30 @@ module Aws::AppConfig
|
|
708
1106
|
# The time the deployment completed.
|
709
1107
|
# @return [Time]
|
710
1108
|
#
|
1109
|
+
# @!attribute [rw] applied_extensions
|
1110
|
+
# A list of extensions that were processed as part of the deployment.
|
1111
|
+
# The extensions that were previously associated to the configuration
|
1112
|
+
# profile, environment, or the application when `StartDeployment` was
|
1113
|
+
# called.
|
1114
|
+
# @return [Array<Types::AppliedExtension>]
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] kms_key_arn
|
1117
|
+
# The Amazon Resource Name of the Key Management Service key used to
|
1118
|
+
# encrypt configuration data. You can encrypt secrets stored in
|
1119
|
+
# Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects
|
1120
|
+
# encrypted with SSE-KMS, or secure string parameters stored in Amazon
|
1121
|
+
# Web Services Systems Manager Parameter Store.
|
1122
|
+
# @return [String]
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] kms_key_identifier
|
1125
|
+
# The Key Management Service key identifier (key ID, key alias, or key
|
1126
|
+
# ARN) provided when the resource was created or updated.
|
1127
|
+
# @return [String]
|
1128
|
+
#
|
1129
|
+
# @!attribute [rw] version_label
|
1130
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1131
|
+
# @return [String]
|
1132
|
+
#
|
711
1133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Deployment AWS API Documentation
|
712
1134
|
#
|
713
1135
|
class Deployment < Struct.new(
|
@@ -728,7 +1150,11 @@ module Aws::AppConfig
|
|
728
1150
|
:event_log,
|
729
1151
|
:percentage_complete,
|
730
1152
|
:started_at,
|
731
|
-
:completed_at
|
1153
|
+
:completed_at,
|
1154
|
+
:applied_extensions,
|
1155
|
+
:kms_key_arn,
|
1156
|
+
:kms_key_identifier,
|
1157
|
+
:version_label)
|
732
1158
|
SENSITIVE = []
|
733
1159
|
include Aws::Structure
|
734
1160
|
end
|
@@ -738,24 +1164,33 @@ module Aws::AppConfig
|
|
738
1164
|
# @!attribute [rw] event_type
|
739
1165
|
# The type of deployment event. Deployment event types include the
|
740
1166
|
# start, stop, or completion of a deployment; a percentage update; the
|
741
|
-
# start or stop of a bake period; the start or completion of a
|
1167
|
+
# start or stop of a bake period; and the start or completion of a
|
742
1168
|
# rollback.
|
743
1169
|
# @return [String]
|
744
1170
|
#
|
745
1171
|
# @!attribute [rw] triggered_by
|
746
1172
|
# The entity that triggered the deployment event. Events can be
|
747
|
-
# triggered by a user,
|
748
|
-
#
|
1173
|
+
# triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an
|
1174
|
+
# internal error.
|
749
1175
|
# @return [String]
|
750
1176
|
#
|
751
1177
|
# @!attribute [rw] description
|
752
1178
|
# A description of the deployment event. Descriptions include, but are
|
753
|
-
# not limited to, the
|
754
|
-
#
|
755
|
-
#
|
756
|
-
#
|
1179
|
+
# not limited to, the following:
|
1180
|
+
#
|
1181
|
+
# * The Amazon Web Services account or the Amazon CloudWatch alarm ARN
|
1182
|
+
# that initiated a rollback.
|
1183
|
+
#
|
1184
|
+
# * The percentage of hosts that received the deployment.
|
1185
|
+
#
|
1186
|
+
# * A recommendation to attempt a new deployment (in the case of an
|
1187
|
+
# internal error).
|
757
1188
|
# @return [String]
|
758
1189
|
#
|
1190
|
+
# @!attribute [rw] action_invocations
|
1191
|
+
# The list of extensions that were invoked as part of the deployment.
|
1192
|
+
# @return [Array<Types::ActionInvocation>]
|
1193
|
+
#
|
759
1194
|
# @!attribute [rw] occurred_at
|
760
1195
|
# The date and time the event occurred.
|
761
1196
|
# @return [Time]
|
@@ -766,6 +1201,7 @@ module Aws::AppConfig
|
|
766
1201
|
:event_type,
|
767
1202
|
:triggered_by,
|
768
1203
|
:description,
|
1204
|
+
:action_invocations,
|
769
1205
|
:occurred_at)
|
770
1206
|
SENSITIVE = []
|
771
1207
|
include Aws::Structure
|
@@ -815,9 +1251,9 @@ module Aws::AppConfig
|
|
815
1251
|
# @return [Float]
|
816
1252
|
#
|
817
1253
|
# @!attribute [rw] final_bake_time_in_minutes
|
818
|
-
# The amount of time AppConfig monitored for alarms before
|
819
|
-
# the deployment to be complete and no longer eligible for
|
820
|
-
#
|
1254
|
+
# The amount of time that AppConfig monitored for alarms before
|
1255
|
+
# considering the deployment to be complete and no longer eligible for
|
1256
|
+
# automatic rollback.
|
821
1257
|
# @return [Integer]
|
822
1258
|
#
|
823
1259
|
# @!attribute [rw] replicate_to
|
@@ -867,9 +1303,9 @@ module Aws::AppConfig
|
|
867
1303
|
# @return [Float]
|
868
1304
|
#
|
869
1305
|
# @!attribute [rw] final_bake_time_in_minutes
|
870
|
-
# The amount of time AppConfig monitors for alarms before
|
871
|
-
# the deployment to be complete and no longer eligible for
|
872
|
-
#
|
1306
|
+
# The amount of time that AppConfig monitors for alarms before
|
1307
|
+
# considering the deployment to be complete and no longer eligible for
|
1308
|
+
# automatic rollback.
|
873
1309
|
# @return [Integer]
|
874
1310
|
#
|
875
1311
|
# @!attribute [rw] state
|
@@ -888,6 +1324,10 @@ module Aws::AppConfig
|
|
888
1324
|
# Time the deployment completed.
|
889
1325
|
# @return [Time]
|
890
1326
|
#
|
1327
|
+
# @!attribute [rw] version_label
|
1328
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1329
|
+
# @return [String]
|
1330
|
+
#
|
891
1331
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeploymentSummary AWS API Documentation
|
892
1332
|
#
|
893
1333
|
class DeploymentSummary < Struct.new(
|
@@ -901,93 +1341,275 @@ module Aws::AppConfig
|
|
901
1341
|
:state,
|
902
1342
|
:percentage_complete,
|
903
1343
|
:started_at,
|
904
|
-
:completed_at
|
1344
|
+
:completed_at,
|
1345
|
+
:version_label)
|
1346
|
+
SENSITIVE = []
|
1347
|
+
include Aws::Structure
|
1348
|
+
end
|
1349
|
+
|
1350
|
+
# @!attribute [rw] items
|
1351
|
+
# The elements from this collection.
|
1352
|
+
# @return [Array<Types::DeploymentSummary>]
|
1353
|
+
#
|
1354
|
+
# @!attribute [rw] next_token
|
1355
|
+
# The token for the next set of items to return. Use this token to get
|
1356
|
+
# the next set of results.
|
1357
|
+
# @return [String]
|
1358
|
+
#
|
1359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Deployments AWS API Documentation
|
1360
|
+
#
|
1361
|
+
class Deployments < Struct.new(
|
1362
|
+
:items,
|
1363
|
+
:next_token)
|
1364
|
+
SENSITIVE = []
|
1365
|
+
include Aws::Structure
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# @!attribute [rw] application_id
|
1369
|
+
# The application ID.
|
1370
|
+
# @return [String]
|
1371
|
+
#
|
1372
|
+
# @!attribute [rw] id
|
1373
|
+
# The environment ID.
|
1374
|
+
# @return [String]
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] name
|
1377
|
+
# The name of the environment.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] description
|
1381
|
+
# The description of the environment.
|
1382
|
+
# @return [String]
|
1383
|
+
#
|
1384
|
+
# @!attribute [rw] state
|
1385
|
+
# The state of the environment. An environment can be in one of the
|
1386
|
+
# following states: `READY_FOR_DEPLOYMENT`, `DEPLOYING`,
|
1387
|
+
# `ROLLING_BACK`, or `ROLLED_BACK`
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] monitors
|
1391
|
+
# Amazon CloudWatch alarms monitored during the deployment.
|
1392
|
+
# @return [Array<Types::Monitor>]
|
1393
|
+
#
|
1394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Environment AWS API Documentation
|
1395
|
+
#
|
1396
|
+
class Environment < Struct.new(
|
1397
|
+
:application_id,
|
1398
|
+
:id,
|
1399
|
+
:name,
|
1400
|
+
:description,
|
1401
|
+
:state,
|
1402
|
+
:monitors)
|
1403
|
+
SENSITIVE = []
|
1404
|
+
include Aws::Structure
|
1405
|
+
end
|
1406
|
+
|
1407
|
+
# @!attribute [rw] items
|
1408
|
+
# The elements from this collection.
|
1409
|
+
# @return [Array<Types::Environment>]
|
1410
|
+
#
|
1411
|
+
# @!attribute [rw] next_token
|
1412
|
+
# The token for the next set of items to return. Use this token to get
|
1413
|
+
# the next set of results.
|
1414
|
+
# @return [String]
|
1415
|
+
#
|
1416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Environments AWS API Documentation
|
1417
|
+
#
|
1418
|
+
class Environments < Struct.new(
|
1419
|
+
:items,
|
1420
|
+
:next_token)
|
1421
|
+
SENSITIVE = []
|
1422
|
+
include Aws::Structure
|
1423
|
+
end
|
1424
|
+
|
1425
|
+
# @!attribute [rw] id
|
1426
|
+
# The system-generated ID of the extension.
|
1427
|
+
# @return [String]
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] name
|
1430
|
+
# The extension name.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] version_number
|
1434
|
+
# The extension version number.
|
1435
|
+
# @return [Integer]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] arn
|
1438
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1439
|
+
# @return [String]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] description
|
1442
|
+
# Information about the extension.
|
1443
|
+
# @return [String]
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] actions
|
1446
|
+
# The actions defined in the extension.
|
1447
|
+
# @return [Hash<String,Array<Types::Action>>]
|
1448
|
+
#
|
1449
|
+
# @!attribute [rw] parameters
|
1450
|
+
# The parameters accepted by the extension. You specify parameter
|
1451
|
+
# values when you associate the extension to an AppConfig resource by
|
1452
|
+
# using the `CreateExtensionAssociation` API action. For Lambda
|
1453
|
+
# extension actions, these parameters are included in the Lambda
|
1454
|
+
# request object.
|
1455
|
+
# @return [Hash<String,Types::Parameter>]
|
1456
|
+
#
|
1457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Extension AWS API Documentation
|
1458
|
+
#
|
1459
|
+
class Extension < Struct.new(
|
1460
|
+
:id,
|
1461
|
+
:name,
|
1462
|
+
:version_number,
|
1463
|
+
:arn,
|
1464
|
+
:description,
|
1465
|
+
:actions,
|
1466
|
+
:parameters)
|
1467
|
+
SENSITIVE = []
|
1468
|
+
include Aws::Structure
|
1469
|
+
end
|
1470
|
+
|
1471
|
+
# @!attribute [rw] id
|
1472
|
+
# The system-generated ID for the association.
|
1473
|
+
# @return [String]
|
1474
|
+
#
|
1475
|
+
# @!attribute [rw] extension_arn
|
1476
|
+
# The ARN of the extension defined in the association.
|
1477
|
+
# @return [String]
|
1478
|
+
#
|
1479
|
+
# @!attribute [rw] resource_arn
|
1480
|
+
# The ARNs of applications, configuration profiles, or environments
|
1481
|
+
# defined in the association.
|
1482
|
+
# @return [String]
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] arn
|
1485
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1486
|
+
# @return [String]
|
1487
|
+
#
|
1488
|
+
# @!attribute [rw] parameters
|
1489
|
+
# The parameter names and values defined in the association.
|
1490
|
+
# @return [Hash<String,String>]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] extension_version_number
|
1493
|
+
# The version number for the extension defined in the association.
|
1494
|
+
# @return [Integer]
|
1495
|
+
#
|
1496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociation AWS API Documentation
|
1497
|
+
#
|
1498
|
+
class ExtensionAssociation < Struct.new(
|
1499
|
+
:id,
|
1500
|
+
:extension_arn,
|
1501
|
+
:resource_arn,
|
1502
|
+
:arn,
|
1503
|
+
:parameters,
|
1504
|
+
:extension_version_number)
|
1505
|
+
SENSITIVE = []
|
1506
|
+
include Aws::Structure
|
1507
|
+
end
|
1508
|
+
|
1509
|
+
# Information about an association between an extension and an AppConfig
|
1510
|
+
# resource such as an application, environment, or configuration
|
1511
|
+
# profile. Call `GetExtensionAssociation` to get more information about
|
1512
|
+
# an association.
|
1513
|
+
#
|
1514
|
+
# @!attribute [rw] id
|
1515
|
+
# The extension association ID. This ID is used to call other
|
1516
|
+
# `ExtensionAssociation` API actions such as `GetExtensionAssociation`
|
1517
|
+
# or `DeleteExtensionAssociation`.
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] extension_arn
|
1521
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1522
|
+
# @return [String]
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] resource_arn
|
1525
|
+
# The ARNs of applications, configuration profiles, or environments
|
1526
|
+
# defined in the association.
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociationSummary AWS API Documentation
|
1530
|
+
#
|
1531
|
+
class ExtensionAssociationSummary < Struct.new(
|
1532
|
+
:id,
|
1533
|
+
:extension_arn,
|
1534
|
+
:resource_arn)
|
905
1535
|
SENSITIVE = []
|
906
1536
|
include Aws::Structure
|
907
1537
|
end
|
908
1538
|
|
909
1539
|
# @!attribute [rw] items
|
910
|
-
# The
|
911
|
-
#
|
1540
|
+
# The list of extension associations. Each item represents an
|
1541
|
+
# extension association to an application, environment, or
|
1542
|
+
# configuration profile.
|
1543
|
+
# @return [Array<Types::ExtensionAssociationSummary>]
|
912
1544
|
#
|
913
1545
|
# @!attribute [rw] next_token
|
914
1546
|
# The token for the next set of items to return. Use this token to get
|
915
1547
|
# the next set of results.
|
916
1548
|
# @return [String]
|
917
1549
|
#
|
918
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/
|
1550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociations AWS API Documentation
|
919
1551
|
#
|
920
|
-
class
|
1552
|
+
class ExtensionAssociations < Struct.new(
|
921
1553
|
:items,
|
922
1554
|
:next_token)
|
923
1555
|
SENSITIVE = []
|
924
1556
|
include Aws::Structure
|
925
1557
|
end
|
926
1558
|
|
927
|
-
#
|
928
|
-
#
|
929
|
-
# @return [String]
|
1559
|
+
# Information about an extension. Call `GetExtension` to get more
|
1560
|
+
# information about an extension.
|
930
1561
|
#
|
931
1562
|
# @!attribute [rw] id
|
932
|
-
# The
|
1563
|
+
# The system-generated ID of the extension.
|
933
1564
|
# @return [String]
|
934
1565
|
#
|
935
1566
|
# @!attribute [rw] name
|
936
|
-
# The name
|
1567
|
+
# The extension name.
|
937
1568
|
# @return [String]
|
938
1569
|
#
|
939
|
-
# @!attribute [rw]
|
940
|
-
# The
|
941
|
-
# @return [
|
1570
|
+
# @!attribute [rw] version_number
|
1571
|
+
# The extension version number.
|
1572
|
+
# @return [Integer]
|
942
1573
|
#
|
943
|
-
# @!attribute [rw]
|
944
|
-
# The
|
945
|
-
# following states: `READY_FOR_DEPLOYMENT`, `DEPLOYING`,
|
946
|
-
# `ROLLING_BACK`, or `ROLLED_BACK`
|
1574
|
+
# @!attribute [rw] arn
|
1575
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
947
1576
|
# @return [String]
|
948
1577
|
#
|
949
|
-
# @!attribute [rw]
|
950
|
-
#
|
951
|
-
# @return [
|
1578
|
+
# @!attribute [rw] description
|
1579
|
+
# Information about the extension.
|
1580
|
+
# @return [String]
|
952
1581
|
#
|
953
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionSummary AWS API Documentation
|
954
1583
|
#
|
955
|
-
class
|
956
|
-
:application_id,
|
1584
|
+
class ExtensionSummary < Struct.new(
|
957
1585
|
:id,
|
958
1586
|
:name,
|
959
|
-
:
|
960
|
-
:
|
961
|
-
:
|
1587
|
+
:version_number,
|
1588
|
+
:arn,
|
1589
|
+
:description)
|
962
1590
|
SENSITIVE = []
|
963
1591
|
include Aws::Structure
|
964
1592
|
end
|
965
1593
|
|
966
1594
|
# @!attribute [rw] items
|
967
|
-
# The
|
968
|
-
#
|
1595
|
+
# The list of available extensions. The list includes Amazon Web
|
1596
|
+
# Services authored and user-created extensions.
|
1597
|
+
# @return [Array<Types::ExtensionSummary>]
|
969
1598
|
#
|
970
1599
|
# @!attribute [rw] next_token
|
971
1600
|
# The token for the next set of items to return. Use this token to get
|
972
1601
|
# the next set of results.
|
973
1602
|
# @return [String]
|
974
1603
|
#
|
975
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/
|
1604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Extensions AWS API Documentation
|
976
1605
|
#
|
977
|
-
class
|
1606
|
+
class Extensions < Struct.new(
|
978
1607
|
:items,
|
979
1608
|
:next_token)
|
980
1609
|
SENSITIVE = []
|
981
1610
|
include Aws::Structure
|
982
1611
|
end
|
983
1612
|
|
984
|
-
# @note When making an API call, you may pass GetApplicationRequest
|
985
|
-
# data as a hash:
|
986
|
-
#
|
987
|
-
# {
|
988
|
-
# application_id: "Id", # required
|
989
|
-
# }
|
990
|
-
#
|
991
1613
|
# @!attribute [rw] application_id
|
992
1614
|
# The ID of the application you want to get.
|
993
1615
|
# @return [String]
|
@@ -1000,21 +1622,13 @@ module Aws::AppConfig
|
|
1000
1622
|
include Aws::Structure
|
1001
1623
|
end
|
1002
1624
|
|
1003
|
-
# @note When making an API call, you may pass GetConfigurationProfileRequest
|
1004
|
-
# data as a hash:
|
1005
|
-
#
|
1006
|
-
# {
|
1007
|
-
# application_id: "Id", # required
|
1008
|
-
# configuration_profile_id: "Id", # required
|
1009
|
-
# }
|
1010
|
-
#
|
1011
1625
|
# @!attribute [rw] application_id
|
1012
1626
|
# The ID of the application that includes the configuration profile
|
1013
1627
|
# you want to get.
|
1014
1628
|
# @return [String]
|
1015
1629
|
#
|
1016
1630
|
# @!attribute [rw] configuration_profile_id
|
1017
|
-
# The ID of the configuration profile you want to get.
|
1631
|
+
# The ID of the configuration profile that you want to get.
|
1018
1632
|
# @return [String]
|
1019
1633
|
#
|
1020
1634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfigurationProfileRequest AWS API Documentation
|
@@ -1026,17 +1640,6 @@ module Aws::AppConfig
|
|
1026
1640
|
include Aws::Structure
|
1027
1641
|
end
|
1028
1642
|
|
1029
|
-
# @note When making an API call, you may pass GetConfigurationRequest
|
1030
|
-
# data as a hash:
|
1031
|
-
#
|
1032
|
-
# {
|
1033
|
-
# application: "StringWithLengthBetween1And64", # required
|
1034
|
-
# environment: "StringWithLengthBetween1And64", # required
|
1035
|
-
# configuration: "StringWithLengthBetween1And64", # required
|
1036
|
-
# client_id: "StringWithLengthBetween1And64", # required
|
1037
|
-
# client_configuration_version: "Version",
|
1038
|
-
# }
|
1039
|
-
#
|
1040
1643
|
# @!attribute [rw] application
|
1041
1644
|
# The application to get. Specify either the application name or the
|
1042
1645
|
# application ID.
|
@@ -1053,33 +1656,41 @@ module Aws::AppConfig
|
|
1053
1656
|
# @return [String]
|
1054
1657
|
#
|
1055
1658
|
# @!attribute [rw] client_id
|
1056
|
-
#
|
1057
|
-
#
|
1659
|
+
# The clientId parameter in the following command is a unique,
|
1660
|
+
# user-specified ID to identify the client for the configuration. This
|
1661
|
+
# ID enables AppConfig to deploy the configuration in intervals, as
|
1058
1662
|
# defined in the deployment strategy.
|
1059
1663
|
# @return [String]
|
1060
1664
|
#
|
1061
1665
|
# @!attribute [rw] client_configuration_version
|
1062
1666
|
# The configuration version returned in the most recent
|
1063
|
-
#
|
1667
|
+
# GetConfiguration response.
|
1064
1668
|
#
|
1065
|
-
#
|
1669
|
+
# AppConfig uses the value of the `ClientConfigurationVersion`
|
1066
1670
|
# parameter to identify the configuration version on your clients. If
|
1067
1671
|
# you don’t send `ClientConfigurationVersion` with each call to
|
1068
|
-
#
|
1672
|
+
# GetConfiguration, your clients receive the current configuration.
|
1069
1673
|
# You are charged each time your clients receive a configuration.
|
1070
1674
|
#
|
1071
|
-
# To avoid excess charges, we recommend
|
1072
|
-
#
|
1073
|
-
#
|
1074
|
-
#
|
1075
|
-
# the `ClientConfigurationVersion`
|
1675
|
+
# To avoid excess charges, we recommend you use the
|
1676
|
+
# [StartConfigurationSession][1] and [GetLatestConfiguration][2] APIs,
|
1677
|
+
# which track the client configuration version on your behalf. If you
|
1678
|
+
# choose to continue using GetConfiguration, we recommend that you
|
1679
|
+
# include the `ClientConfigurationVersion` value with every call to
|
1680
|
+
# GetConfiguration. The value to use for `ClientConfigurationVersion`
|
1681
|
+
# comes from the `ConfigurationVersion` attribute returned by
|
1682
|
+
# GetConfiguration when there is new or updated data, and should be
|
1683
|
+
# saved for subsequent calls to GetConfiguration.
|
1076
1684
|
#
|
1077
1685
|
# For more information about working with configurations, see
|
1078
|
-
# [Retrieving
|
1686
|
+
# [Retrieving feature flags and configuration data in AppConfig][3] in
|
1687
|
+
# the *AppConfig User Guide*.
|
1079
1688
|
#
|
1080
1689
|
#
|
1081
1690
|
#
|
1082
|
-
# [1]: https://docs.aws.amazon.com/
|
1691
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html
|
1692
|
+
# [2]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html
|
1693
|
+
# [3]: http://docs.aws.amazon.com/appconfig/latest/userguide/retrieving-feature-flags.html
|
1083
1694
|
# @return [String]
|
1084
1695
|
#
|
1085
1696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfigurationRequest AWS API Documentation
|
@@ -1094,15 +1705,6 @@ module Aws::AppConfig
|
|
1094
1705
|
include Aws::Structure
|
1095
1706
|
end
|
1096
1707
|
|
1097
|
-
# @note When making an API call, you may pass GetDeploymentRequest
|
1098
|
-
# data as a hash:
|
1099
|
-
#
|
1100
|
-
# {
|
1101
|
-
# application_id: "Id", # required
|
1102
|
-
# environment_id: "Id", # required
|
1103
|
-
# deployment_number: 1, # required
|
1104
|
-
# }
|
1105
|
-
#
|
1106
1708
|
# @!attribute [rw] application_id
|
1107
1709
|
# The ID of the application that includes the deployment you want to
|
1108
1710
|
# get.
|
@@ -1127,13 +1729,6 @@ module Aws::AppConfig
|
|
1127
1729
|
include Aws::Structure
|
1128
1730
|
end
|
1129
1731
|
|
1130
|
-
# @note When making an API call, you may pass GetDeploymentStrategyRequest
|
1131
|
-
# data as a hash:
|
1132
|
-
#
|
1133
|
-
# {
|
1134
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
1135
|
-
# }
|
1136
|
-
#
|
1137
1732
|
# @!attribute [rw] deployment_strategy_id
|
1138
1733
|
# The ID of the deployment strategy to get.
|
1139
1734
|
# @return [String]
|
@@ -1146,21 +1741,13 @@ module Aws::AppConfig
|
|
1146
1741
|
include Aws::Structure
|
1147
1742
|
end
|
1148
1743
|
|
1149
|
-
# @note When making an API call, you may pass GetEnvironmentRequest
|
1150
|
-
# data as a hash:
|
1151
|
-
#
|
1152
|
-
# {
|
1153
|
-
# application_id: "Id", # required
|
1154
|
-
# environment_id: "Id", # required
|
1155
|
-
# }
|
1156
|
-
#
|
1157
1744
|
# @!attribute [rw] application_id
|
1158
1745
|
# The ID of the application that includes the environment you want to
|
1159
1746
|
# get.
|
1160
1747
|
# @return [String]
|
1161
1748
|
#
|
1162
1749
|
# @!attribute [rw] environment_id
|
1163
|
-
# The ID of the environment you
|
1750
|
+
# The ID of the environment that you want to get.
|
1164
1751
|
# @return [String]
|
1165
1752
|
#
|
1166
1753
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetEnvironmentRequest AWS API Documentation
|
@@ -1172,15 +1759,37 @@ module Aws::AppConfig
|
|
1172
1759
|
include Aws::Structure
|
1173
1760
|
end
|
1174
1761
|
|
1175
|
-
#
|
1176
|
-
#
|
1762
|
+
# @!attribute [rw] extension_association_id
|
1763
|
+
# The extension association ID to get.
|
1764
|
+
# @return [String]
|
1765
|
+
#
|
1766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetExtensionAssociationRequest AWS API Documentation
|
1767
|
+
#
|
1768
|
+
class GetExtensionAssociationRequest < Struct.new(
|
1769
|
+
:extension_association_id)
|
1770
|
+
SENSITIVE = []
|
1771
|
+
include Aws::Structure
|
1772
|
+
end
|
1773
|
+
|
1774
|
+
# @!attribute [rw] extension_identifier
|
1775
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
1776
|
+
# extension.
|
1777
|
+
# @return [String]
|
1778
|
+
#
|
1779
|
+
# @!attribute [rw] version_number
|
1780
|
+
# The extension version number. If no version number was defined,
|
1781
|
+
# AppConfig uses the highest version.
|
1782
|
+
# @return [Integer]
|
1177
1783
|
#
|
1178
|
-
#
|
1179
|
-
# application_id: "Id", # required
|
1180
|
-
# configuration_profile_id: "Id", # required
|
1181
|
-
# version_number: 1, # required
|
1182
|
-
# }
|
1784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetExtensionRequest AWS API Documentation
|
1183
1785
|
#
|
1786
|
+
class GetExtensionRequest < Struct.new(
|
1787
|
+
:extension_identifier,
|
1788
|
+
:version_number)
|
1789
|
+
SENSITIVE = []
|
1790
|
+
include Aws::Structure
|
1791
|
+
end
|
1792
|
+
|
1184
1793
|
# @!attribute [rw] application_id
|
1185
1794
|
# The application ID.
|
1186
1795
|
# @return [String]
|
@@ -1229,7 +1838,17 @@ module Aws::AppConfig
|
|
1229
1838
|
#
|
1230
1839
|
#
|
1231
1840
|
#
|
1232
|
-
# [1]: https://
|
1841
|
+
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
1842
|
+
# @return [String]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] version_label
|
1845
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1846
|
+
# @return [String]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] kms_key_arn
|
1849
|
+
# The Amazon Resource Name of the Key Management Service key that was
|
1850
|
+
# used to encrypt this specific version of the configuration data in
|
1851
|
+
# the AppConfig hosted configuration store.
|
1233
1852
|
# @return [String]
|
1234
1853
|
#
|
1235
1854
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/HostedConfigurationVersion AWS API Documentation
|
@@ -1240,7 +1859,9 @@ module Aws::AppConfig
|
|
1240
1859
|
:version_number,
|
1241
1860
|
:description,
|
1242
1861
|
:content,
|
1243
|
-
:content_type
|
1862
|
+
:content_type,
|
1863
|
+
:version_label,
|
1864
|
+
:kms_key_arn)
|
1244
1865
|
SENSITIVE = [:content]
|
1245
1866
|
include Aws::Structure
|
1246
1867
|
end
|
@@ -1269,7 +1890,17 @@ module Aws::AppConfig
|
|
1269
1890
|
#
|
1270
1891
|
#
|
1271
1892
|
#
|
1272
|
-
# [1]: https://
|
1893
|
+
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
1894
|
+
# @return [String]
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] version_label
|
1897
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1898
|
+
# @return [String]
|
1899
|
+
#
|
1900
|
+
# @!attribute [rw] kms_key_arn
|
1901
|
+
# The Amazon Resource Name of the Key Management Service key that was
|
1902
|
+
# used to encrypt this specific version of the configuration data in
|
1903
|
+
# the AppConfig hosted configuration store.
|
1273
1904
|
# @return [String]
|
1274
1905
|
#
|
1275
1906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/HostedConfigurationVersionSummary AWS API Documentation
|
@@ -1279,7 +1910,9 @@ module Aws::AppConfig
|
|
1279
1910
|
:configuration_profile_id,
|
1280
1911
|
:version_number,
|
1281
1912
|
:description,
|
1282
|
-
:content_type
|
1913
|
+
:content_type,
|
1914
|
+
:version_label,
|
1915
|
+
:kms_key_arn)
|
1283
1916
|
SENSITIVE = []
|
1284
1917
|
include Aws::Structure
|
1285
1918
|
end
|
@@ -1315,14 +1948,44 @@ module Aws::AppConfig
|
|
1315
1948
|
include Aws::Structure
|
1316
1949
|
end
|
1317
1950
|
|
1318
|
-
#
|
1319
|
-
#
|
1951
|
+
# Detailed information about the bad request exception error when
|
1952
|
+
# creating a hosted configuration version.
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] constraint
|
1955
|
+
# The invalid or out-of-range validation constraint in your JSON
|
1956
|
+
# schema that failed validation.
|
1957
|
+
# @return [String]
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] location
|
1960
|
+
# Location of the validation constraint in the configuration JSON
|
1961
|
+
# schema that failed validation.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] reason
|
1965
|
+
# The reason for an invalid configuration error.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] type
|
1969
|
+
# The type of error for an invalid configuration.
|
1970
|
+
# @return [String]
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] value
|
1973
|
+
# Details about an error with Lambda when a synchronous extension
|
1974
|
+
# experiences an error during an invocation.
|
1975
|
+
# @return [String]
|
1320
1976
|
#
|
1321
|
-
#
|
1322
|
-
# max_results: 1,
|
1323
|
-
# next_token: "NextToken",
|
1324
|
-
# }
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/InvalidConfigurationDetail AWS API Documentation
|
1325
1978
|
#
|
1979
|
+
class InvalidConfigurationDetail < Struct.new(
|
1980
|
+
:constraint,
|
1981
|
+
:location,
|
1982
|
+
:reason,
|
1983
|
+
:type,
|
1984
|
+
:value)
|
1985
|
+
SENSITIVE = []
|
1986
|
+
include Aws::Structure
|
1987
|
+
end
|
1988
|
+
|
1326
1989
|
# @!attribute [rw] max_results
|
1327
1990
|
# The maximum number of items to return for this call. The call also
|
1328
1991
|
# returns a token that you can specify in a subsequent call to get the
|
@@ -1330,8 +1993,12 @@ module Aws::AppConfig
|
|
1330
1993
|
# @return [Integer]
|
1331
1994
|
#
|
1332
1995
|
# @!attribute [rw] next_token
|
1333
|
-
# A token to start the list.
|
1334
|
-
#
|
1996
|
+
# A token to start the list. Next token is a pagination token
|
1997
|
+
# generated by AppConfig to describe what page the previous List call
|
1998
|
+
# ended on. For the first List request, the nextToken should not be
|
1999
|
+
# set. On subsequent calls, the nextToken parameter should be set to
|
2000
|
+
# the previous responses nextToken value. Use this token to get the
|
2001
|
+
# next set of results.
|
1335
2002
|
# @return [String]
|
1336
2003
|
#
|
1337
2004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListApplicationsRequest AWS API Documentation
|
@@ -1343,15 +2010,6 @@ module Aws::AppConfig
|
|
1343
2010
|
include Aws::Structure
|
1344
2011
|
end
|
1345
2012
|
|
1346
|
-
# @note When making an API call, you may pass ListConfigurationProfilesRequest
|
1347
|
-
# data as a hash:
|
1348
|
-
#
|
1349
|
-
# {
|
1350
|
-
# application_id: "Id", # required
|
1351
|
-
# max_results: 1,
|
1352
|
-
# next_token: "NextToken",
|
1353
|
-
# }
|
1354
|
-
#
|
1355
2013
|
# @!attribute [rw] application_id
|
1356
2014
|
# The application ID.
|
1357
2015
|
# @return [String]
|
@@ -1367,24 +2025,23 @@ module Aws::AppConfig
|
|
1367
2025
|
# results.
|
1368
2026
|
# @return [String]
|
1369
2027
|
#
|
2028
|
+
# @!attribute [rw] type
|
2029
|
+
# A filter based on the type of configurations that the configuration
|
2030
|
+
# profile contains. A configuration can be a feature flag or a
|
2031
|
+
# freeform configuration.
|
2032
|
+
# @return [String]
|
2033
|
+
#
|
1370
2034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListConfigurationProfilesRequest AWS API Documentation
|
1371
2035
|
#
|
1372
2036
|
class ListConfigurationProfilesRequest < Struct.new(
|
1373
2037
|
:application_id,
|
1374
2038
|
:max_results,
|
1375
|
-
:next_token
|
2039
|
+
:next_token,
|
2040
|
+
:type)
|
1376
2041
|
SENSITIVE = []
|
1377
2042
|
include Aws::Structure
|
1378
2043
|
end
|
1379
2044
|
|
1380
|
-
# @note When making an API call, you may pass ListDeploymentStrategiesRequest
|
1381
|
-
# data as a hash:
|
1382
|
-
#
|
1383
|
-
# {
|
1384
|
-
# max_results: 1,
|
1385
|
-
# next_token: "NextToken",
|
1386
|
-
# }
|
1387
|
-
#
|
1388
2045
|
# @!attribute [rw] max_results
|
1389
2046
|
# The maximum number of items to return for this call. The call also
|
1390
2047
|
# returns a token that you can specify in a subsequent call to get the
|
@@ -1405,16 +2062,6 @@ module Aws::AppConfig
|
|
1405
2062
|
include Aws::Structure
|
1406
2063
|
end
|
1407
2064
|
|
1408
|
-
# @note When making an API call, you may pass ListDeploymentsRequest
|
1409
|
-
# data as a hash:
|
1410
|
-
#
|
1411
|
-
# {
|
1412
|
-
# application_id: "Id", # required
|
1413
|
-
# environment_id: "Id", # required
|
1414
|
-
# max_results: 1,
|
1415
|
-
# next_token: "NextToken",
|
1416
|
-
# }
|
1417
|
-
#
|
1418
2065
|
# @!attribute [rw] application_id
|
1419
2066
|
# The application ID.
|
1420
2067
|
# @return [String]
|
@@ -1424,14 +2071,16 @@ module Aws::AppConfig
|
|
1424
2071
|
# @return [String]
|
1425
2072
|
#
|
1426
2073
|
# @!attribute [rw] max_results
|
1427
|
-
# The maximum number of items
|
1428
|
-
#
|
1429
|
-
#
|
2074
|
+
# The maximum number of items that may be returned for this call. If
|
2075
|
+
# there are items that have not yet been returned, the response will
|
2076
|
+
# include a non-null `NextToken` that you can provide in a subsequent
|
2077
|
+
# call to get the next set of results.
|
1430
2078
|
# @return [Integer]
|
1431
2079
|
#
|
1432
2080
|
# @!attribute [rw] next_token
|
1433
|
-
#
|
1434
|
-
# results.
|
2081
|
+
# The token returned by a prior call to this operation indicating the
|
2082
|
+
# next set of results to be returned. If not specified, the operation
|
2083
|
+
# will return the first set of results.
|
1435
2084
|
# @return [String]
|
1436
2085
|
#
|
1437
2086
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeploymentsRequest AWS API Documentation
|
@@ -1445,15 +2094,6 @@ module Aws::AppConfig
|
|
1445
2094
|
include Aws::Structure
|
1446
2095
|
end
|
1447
2096
|
|
1448
|
-
# @note When making an API call, you may pass ListEnvironmentsRequest
|
1449
|
-
# data as a hash:
|
1450
|
-
#
|
1451
|
-
# {
|
1452
|
-
# application_id: "Id", # required
|
1453
|
-
# max_results: 1,
|
1454
|
-
# next_token: "NextToken",
|
1455
|
-
# }
|
1456
|
-
#
|
1457
2097
|
# @!attribute [rw] application_id
|
1458
2098
|
# The application ID.
|
1459
2099
|
# @return [String]
|
@@ -1479,16 +2119,67 @@ module Aws::AppConfig
|
|
1479
2119
|
include Aws::Structure
|
1480
2120
|
end
|
1481
2121
|
|
1482
|
-
#
|
1483
|
-
#
|
2122
|
+
# @!attribute [rw] resource_identifier
|
2123
|
+
# The ARN of an application, configuration profile, or environment.
|
2124
|
+
# @return [String]
|
2125
|
+
#
|
2126
|
+
# @!attribute [rw] extension_identifier
|
2127
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
2128
|
+
# extension.
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] extension_version_number
|
2132
|
+
# The version number for the extension defined in the association.
|
2133
|
+
# @return [Integer]
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] max_results
|
2136
|
+
# The maximum number of items to return for this call. The call also
|
2137
|
+
# returns a token that you can specify in a subsequent call to get the
|
2138
|
+
# next set of results.
|
2139
|
+
# @return [Integer]
|
2140
|
+
#
|
2141
|
+
# @!attribute [rw] next_token
|
2142
|
+
# A token to start the list. Use this token to get the next set of
|
2143
|
+
# results or pass null to get the first set of results.
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListExtensionAssociationsRequest AWS API Documentation
|
2147
|
+
#
|
2148
|
+
class ListExtensionAssociationsRequest < Struct.new(
|
2149
|
+
:resource_identifier,
|
2150
|
+
:extension_identifier,
|
2151
|
+
:extension_version_number,
|
2152
|
+
:max_results,
|
2153
|
+
:next_token)
|
2154
|
+
SENSITIVE = []
|
2155
|
+
include Aws::Structure
|
2156
|
+
end
|
2157
|
+
|
2158
|
+
# @!attribute [rw] max_results
|
2159
|
+
# The maximum number of items to return for this call. The call also
|
2160
|
+
# returns a token that you can specify in a subsequent call to get the
|
2161
|
+
# next set of results.
|
2162
|
+
# @return [Integer]
|
2163
|
+
#
|
2164
|
+
# @!attribute [rw] next_token
|
2165
|
+
# A token to start the list. Use this token to get the next set of
|
2166
|
+
# results.
|
2167
|
+
# @return [String]
|
2168
|
+
#
|
2169
|
+
# @!attribute [rw] name
|
2170
|
+
# The extension name.
|
2171
|
+
# @return [String]
|
1484
2172
|
#
|
1485
|
-
#
|
1486
|
-
# application_id: "Id", # required
|
1487
|
-
# configuration_profile_id: "Id", # required
|
1488
|
-
# max_results: 1,
|
1489
|
-
# next_token: "NextToken",
|
1490
|
-
# }
|
2173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListExtensionsRequest AWS API Documentation
|
1491
2174
|
#
|
2175
|
+
class ListExtensionsRequest < Struct.new(
|
2176
|
+
:max_results,
|
2177
|
+
:next_token,
|
2178
|
+
:name)
|
2179
|
+
SENSITIVE = []
|
2180
|
+
include Aws::Structure
|
2181
|
+
end
|
2182
|
+
|
1492
2183
|
# @!attribute [rw] application_id
|
1493
2184
|
# The application ID.
|
1494
2185
|
# @return [String]
|
@@ -1498,9 +2189,10 @@ module Aws::AppConfig
|
|
1498
2189
|
# @return [String]
|
1499
2190
|
#
|
1500
2191
|
# @!attribute [rw] max_results
|
1501
|
-
# The maximum number of items to return for this call.
|
1502
|
-
#
|
1503
|
-
#
|
2192
|
+
# The maximum number of items to return for this call. If `MaxResults`
|
2193
|
+
# is not provided in the call, AppConfig returns the maximum of 50.
|
2194
|
+
# The call also returns a token that you can specify in a subsequent
|
2195
|
+
# call to get the next set of results.
|
1504
2196
|
# @return [Integer]
|
1505
2197
|
#
|
1506
2198
|
# @!attribute [rw] next_token
|
@@ -1508,24 +2200,26 @@ module Aws::AppConfig
|
|
1508
2200
|
# results.
|
1509
2201
|
# @return [String]
|
1510
2202
|
#
|
2203
|
+
# @!attribute [rw] version_label
|
2204
|
+
# An optional filter that can be used to specify the version label of
|
2205
|
+
# an AppConfig hosted configuration version. This parameter supports
|
2206
|
+
# filtering by prefix using a wildcard, for example "v2*". If you
|
2207
|
+
# don't specify an asterisk at the end of the value, only an exact
|
2208
|
+
# match is returned.
|
2209
|
+
# @return [String]
|
2210
|
+
#
|
1511
2211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListHostedConfigurationVersionsRequest AWS API Documentation
|
1512
2212
|
#
|
1513
2213
|
class ListHostedConfigurationVersionsRequest < Struct.new(
|
1514
2214
|
:application_id,
|
1515
2215
|
:configuration_profile_id,
|
1516
2216
|
:max_results,
|
1517
|
-
:next_token
|
2217
|
+
:next_token,
|
2218
|
+
:version_label)
|
1518
2219
|
SENSITIVE = []
|
1519
2220
|
include Aws::Structure
|
1520
2221
|
end
|
1521
2222
|
|
1522
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1523
|
-
# data as a hash:
|
1524
|
-
#
|
1525
|
-
# {
|
1526
|
-
# resource_arn: "Arn", # required
|
1527
|
-
# }
|
1528
|
-
#
|
1529
2223
|
# @!attribute [rw] resource_arn
|
1530
2224
|
# The resource ARN.
|
1531
2225
|
# @return [String]
|
@@ -1540,20 +2234,13 @@ module Aws::AppConfig
|
|
1540
2234
|
|
1541
2235
|
# Amazon CloudWatch alarms to monitor during the deployment process.
|
1542
2236
|
#
|
1543
|
-
# @note When making an API call, you may pass Monitor
|
1544
|
-
# data as a hash:
|
1545
|
-
#
|
1546
|
-
# {
|
1547
|
-
# alarm_arn: "Arn",
|
1548
|
-
# alarm_role_arn: "RoleArn",
|
1549
|
-
# }
|
1550
|
-
#
|
1551
2237
|
# @!attribute [rw] alarm_arn
|
1552
|
-
# ARN of the Amazon CloudWatch alarm.
|
2238
|
+
# Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
|
1553
2239
|
# @return [String]
|
1554
2240
|
#
|
1555
2241
|
# @!attribute [rw] alarm_role_arn
|
1556
|
-
# ARN of an IAM role for AppConfig to
|
2242
|
+
# ARN of an Identity and Access Management (IAM) role for AppConfig to
|
2243
|
+
# monitor `AlarmArn`.
|
1557
2244
|
# @return [String]
|
1558
2245
|
#
|
1559
2246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Monitor AWS API Documentation
|
@@ -1565,6 +2252,40 @@ module Aws::AppConfig
|
|
1565
2252
|
include Aws::Structure
|
1566
2253
|
end
|
1567
2254
|
|
2255
|
+
# A value such as an Amazon Resource Name (ARN) or an Amazon Simple
|
2256
|
+
# Notification Service topic entered in an extension when invoked.
|
2257
|
+
# Parameter values are specified in an extension association. For more
|
2258
|
+
# information about extensions, see [Extending workflows][1] in the
|
2259
|
+
# *AppConfig User Guide*.
|
2260
|
+
#
|
2261
|
+
#
|
2262
|
+
#
|
2263
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] description
|
2266
|
+
# Information about the parameter.
|
2267
|
+
# @return [String]
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] required
|
2270
|
+
# A parameter value must be specified in the extension association.
|
2271
|
+
# @return [Boolean]
|
2272
|
+
#
|
2273
|
+
# @!attribute [rw] dynamic
|
2274
|
+
# Indicates whether this parameter's value can be supplied at the
|
2275
|
+
# extension's action point instead of during extension association.
|
2276
|
+
# Dynamic parameters can't be marked `Required`.
|
2277
|
+
# @return [Boolean]
|
2278
|
+
#
|
2279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Parameter AWS API Documentation
|
2280
|
+
#
|
2281
|
+
class Parameter < Struct.new(
|
2282
|
+
:description,
|
2283
|
+
:required,
|
2284
|
+
:dynamic)
|
2285
|
+
SENSITIVE = []
|
2286
|
+
include Aws::Structure
|
2287
|
+
end
|
2288
|
+
|
1568
2289
|
# The configuration size is too large.
|
1569
2290
|
#
|
1570
2291
|
# @!attribute [rw] message
|
@@ -1621,9 +2342,26 @@ module Aws::AppConfig
|
|
1621
2342
|
include Aws::Structure
|
1622
2343
|
end
|
1623
2344
|
|
1624
|
-
# The number of
|
1625
|
-
#
|
1626
|
-
#
|
2345
|
+
# The number of one more AppConfig resources exceeds the maximum
|
2346
|
+
# allowed. Verify that your environment doesn't exceed the following
|
2347
|
+
# service quotas:
|
2348
|
+
#
|
2349
|
+
# Applications: 100 max
|
2350
|
+
#
|
2351
|
+
# Deployment strategies: 20 max
|
2352
|
+
#
|
2353
|
+
# Configuration profiles: 100 max per application
|
2354
|
+
#
|
2355
|
+
# Environments: 20 max per application
|
2356
|
+
#
|
2357
|
+
# To resolve this issue, you can delete one or more resources and try
|
2358
|
+
# again. Or, you can request a quota increase. For more information
|
2359
|
+
# about quotas and to request an increase, see [Service quotas for
|
2360
|
+
# AppConfig][1] in the Amazon Web Services General Reference.
|
2361
|
+
#
|
2362
|
+
#
|
2363
|
+
#
|
2364
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig
|
1627
2365
|
#
|
1628
2366
|
# @!attribute [rw] message
|
1629
2367
|
# @return [String]
|
@@ -1636,21 +2374,6 @@ module Aws::AppConfig
|
|
1636
2374
|
include Aws::Structure
|
1637
2375
|
end
|
1638
2376
|
|
1639
|
-
# @note When making an API call, you may pass StartDeploymentRequest
|
1640
|
-
# data as a hash:
|
1641
|
-
#
|
1642
|
-
# {
|
1643
|
-
# application_id: "Id", # required
|
1644
|
-
# environment_id: "Id", # required
|
1645
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
1646
|
-
# configuration_profile_id: "Id", # required
|
1647
|
-
# configuration_version: "Version", # required
|
1648
|
-
# description: "Description",
|
1649
|
-
# tags: {
|
1650
|
-
# "TagKey" => "TagValue",
|
1651
|
-
# },
|
1652
|
-
# }
|
1653
|
-
#
|
1654
2377
|
# @!attribute [rw] application_id
|
1655
2378
|
# The application ID.
|
1656
2379
|
# @return [String]
|
@@ -1668,7 +2391,10 @@ module Aws::AppConfig
|
|
1668
2391
|
# @return [String]
|
1669
2392
|
#
|
1670
2393
|
# @!attribute [rw] configuration_version
|
1671
|
-
# The configuration version to deploy.
|
2394
|
+
# The configuration version to deploy. If deploying an AppConfig
|
2395
|
+
# hosted configuration version, you can specify either the version
|
2396
|
+
# number or version label. For all other configurations, you must
|
2397
|
+
# specify the version number.
|
1672
2398
|
# @return [String]
|
1673
2399
|
#
|
1674
2400
|
# @!attribute [rw] description
|
@@ -1681,6 +2407,17 @@ module Aws::AppConfig
|
|
1681
2407
|
# an optional value, both of which you define.
|
1682
2408
|
# @return [Hash<String,String>]
|
1683
2409
|
#
|
2410
|
+
# @!attribute [rw] kms_key_identifier
|
2411
|
+
# The KMS key identifier (key ID, key alias, or key ARN). AppConfig
|
2412
|
+
# uses this ID to encrypt the configuration data using a customer
|
2413
|
+
# managed key.
|
2414
|
+
# @return [String]
|
2415
|
+
#
|
2416
|
+
# @!attribute [rw] dynamic_extension_parameters
|
2417
|
+
# A map of dynamic extension parameter names to values to pass to
|
2418
|
+
# associated extensions with `PRE_START_DEPLOYMENT` actions.
|
2419
|
+
# @return [Hash<String,String>]
|
2420
|
+
#
|
1684
2421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/StartDeploymentRequest AWS API Documentation
|
1685
2422
|
#
|
1686
2423
|
class StartDeploymentRequest < Struct.new(
|
@@ -1690,20 +2427,13 @@ module Aws::AppConfig
|
|
1690
2427
|
:configuration_profile_id,
|
1691
2428
|
:configuration_version,
|
1692
2429
|
:description,
|
1693
|
-
:tags
|
1694
|
-
|
2430
|
+
:tags,
|
2431
|
+
:kms_key_identifier,
|
2432
|
+
:dynamic_extension_parameters)
|
2433
|
+
SENSITIVE = [:dynamic_extension_parameters]
|
1695
2434
|
include Aws::Structure
|
1696
2435
|
end
|
1697
2436
|
|
1698
|
-
# @note When making an API call, you may pass StopDeploymentRequest
|
1699
|
-
# data as a hash:
|
1700
|
-
#
|
1701
|
-
# {
|
1702
|
-
# application_id: "Id", # required
|
1703
|
-
# environment_id: "Id", # required
|
1704
|
-
# deployment_number: 1, # required
|
1705
|
-
# }
|
1706
|
-
#
|
1707
2437
|
# @!attribute [rw] application_id
|
1708
2438
|
# The application ID.
|
1709
2439
|
# @return [String]
|
@@ -1716,26 +2446,23 @@ module Aws::AppConfig
|
|
1716
2446
|
# The sequence number of the deployment.
|
1717
2447
|
# @return [Integer]
|
1718
2448
|
#
|
2449
|
+
# @!attribute [rw] allow_revert
|
2450
|
+
# A Boolean that enables AppConfig to rollback a `COMPLETED`
|
2451
|
+
# deployment to the previous configuration version. This action moves
|
2452
|
+
# the deployment to a status of `REVERTED`.
|
2453
|
+
# @return [Boolean]
|
2454
|
+
#
|
1719
2455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/StopDeploymentRequest AWS API Documentation
|
1720
2456
|
#
|
1721
2457
|
class StopDeploymentRequest < Struct.new(
|
1722
2458
|
:application_id,
|
1723
2459
|
:environment_id,
|
1724
|
-
:deployment_number
|
2460
|
+
:deployment_number,
|
2461
|
+
:allow_revert)
|
1725
2462
|
SENSITIVE = []
|
1726
2463
|
include Aws::Structure
|
1727
2464
|
end
|
1728
2465
|
|
1729
|
-
# @note When making an API call, you may pass TagResourceRequest
|
1730
|
-
# data as a hash:
|
1731
|
-
#
|
1732
|
-
# {
|
1733
|
-
# resource_arn: "Arn", # required
|
1734
|
-
# tags: { # required
|
1735
|
-
# "TagKey" => "TagValue",
|
1736
|
-
# },
|
1737
|
-
# }
|
1738
|
-
#
|
1739
2466
|
# @!attribute [rw] resource_arn
|
1740
2467
|
# The ARN of the resource for which to retrieve tags.
|
1741
2468
|
# @return [String]
|
@@ -1755,14 +2482,6 @@ module Aws::AppConfig
|
|
1755
2482
|
include Aws::Structure
|
1756
2483
|
end
|
1757
2484
|
|
1758
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
1759
|
-
# data as a hash:
|
1760
|
-
#
|
1761
|
-
# {
|
1762
|
-
# resource_arn: "Arn", # required
|
1763
|
-
# tag_keys: ["TagKey"], # required
|
1764
|
-
# }
|
1765
|
-
#
|
1766
2485
|
# @!attribute [rw] resource_arn
|
1767
2486
|
# The ARN of the resource for which to remove tags.
|
1768
2487
|
# @return [String]
|
@@ -1780,15 +2499,27 @@ module Aws::AppConfig
|
|
1780
2499
|
include Aws::Structure
|
1781
2500
|
end
|
1782
2501
|
|
1783
|
-
#
|
1784
|
-
#
|
2502
|
+
# @!attribute [rw] deletion_protection
|
2503
|
+
# A parameter to configure deletion protection. Deletion protection
|
2504
|
+
# prevents a user from deleting a configuration profile or an
|
2505
|
+
# environment if AppConfig has called either
|
2506
|
+
# [GetLatestConfiguration][1] or for the configuration profile or from
|
2507
|
+
# the environment during the specified interval. The default interval
|
2508
|
+
# for `ProtectionPeriodInMinutes` is 60.
|
1785
2509
|
#
|
1786
|
-
# {
|
1787
|
-
# application_id: "Id", # required
|
1788
|
-
# name: "Name",
|
1789
|
-
# description: "Description",
|
1790
|
-
# }
|
1791
2510
|
#
|
2511
|
+
#
|
2512
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
|
2513
|
+
# @return [Types::DeletionProtectionSettings]
|
2514
|
+
#
|
2515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateAccountSettingsRequest AWS API Documentation
|
2516
|
+
#
|
2517
|
+
class UpdateAccountSettingsRequest < Struct.new(
|
2518
|
+
:deletion_protection)
|
2519
|
+
SENSITIVE = []
|
2520
|
+
include Aws::Structure
|
2521
|
+
end
|
2522
|
+
|
1792
2523
|
# @!attribute [rw] application_id
|
1793
2524
|
# The application ID.
|
1794
2525
|
# @return [String]
|
@@ -1811,23 +2542,6 @@ module Aws::AppConfig
|
|
1811
2542
|
include Aws::Structure
|
1812
2543
|
end
|
1813
2544
|
|
1814
|
-
# @note When making an API call, you may pass UpdateConfigurationProfileRequest
|
1815
|
-
# data as a hash:
|
1816
|
-
#
|
1817
|
-
# {
|
1818
|
-
# application_id: "Id", # required
|
1819
|
-
# configuration_profile_id: "Id", # required
|
1820
|
-
# name: "Name",
|
1821
|
-
# description: "Description",
|
1822
|
-
# retrieval_role_arn: "RoleArn",
|
1823
|
-
# validators: [
|
1824
|
-
# {
|
1825
|
-
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
1826
|
-
# content: "StringWithLengthBetween0And32768", # required
|
1827
|
-
# },
|
1828
|
-
# ],
|
1829
|
-
# }
|
1830
|
-
#
|
1831
2545
|
# @!attribute [rw] application_id
|
1832
2546
|
# The application ID.
|
1833
2547
|
# @return [String]
|
@@ -1846,13 +2560,27 @@ module Aws::AppConfig
|
|
1846
2560
|
#
|
1847
2561
|
# @!attribute [rw] retrieval_role_arn
|
1848
2562
|
# The ARN of an IAM role with permission to access the configuration
|
1849
|
-
# at the specified LocationUri
|
2563
|
+
# at the specified `LocationUri`.
|
2564
|
+
#
|
2565
|
+
# A retrieval role ARN is not required for configurations stored in
|
2566
|
+
# CodePipeline or the AppConfig hosted configuration store. It is
|
2567
|
+
# required for all other sources that store your configuration.
|
1850
2568
|
# @return [String]
|
1851
2569
|
#
|
1852
2570
|
# @!attribute [rw] validators
|
1853
2571
|
# A list of methods for validating the configuration.
|
1854
2572
|
# @return [Array<Types::Validator>]
|
1855
2573
|
#
|
2574
|
+
# @!attribute [rw] kms_key_identifier
|
2575
|
+
# The identifier for a Key Management Service key to encrypt new
|
2576
|
+
# configuration data versions in the AppConfig hosted configuration
|
2577
|
+
# store. This attribute is only used for `hosted` configuration types.
|
2578
|
+
# The identifier can be an KMS key ID, alias, or the Amazon Resource
|
2579
|
+
# Name (ARN) of the key ID or alias. To encrypt data managed in other
|
2580
|
+
# configuration stores, see the documentation for how to specify an
|
2581
|
+
# KMS key for that particular service.
|
2582
|
+
# @return [String]
|
2583
|
+
#
|
1856
2584
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateConfigurationProfileRequest AWS API Documentation
|
1857
2585
|
#
|
1858
2586
|
class UpdateConfigurationProfileRequest < Struct.new(
|
@@ -1861,23 +2589,12 @@ module Aws::AppConfig
|
|
1861
2589
|
:name,
|
1862
2590
|
:description,
|
1863
2591
|
:retrieval_role_arn,
|
1864
|
-
:validators
|
2592
|
+
:validators,
|
2593
|
+
:kms_key_identifier)
|
1865
2594
|
SENSITIVE = []
|
1866
2595
|
include Aws::Structure
|
1867
2596
|
end
|
1868
2597
|
|
1869
|
-
# @note When making an API call, you may pass UpdateDeploymentStrategyRequest
|
1870
|
-
# data as a hash:
|
1871
|
-
#
|
1872
|
-
# {
|
1873
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
1874
|
-
# description: "Description",
|
1875
|
-
# deployment_duration_in_minutes: 1,
|
1876
|
-
# final_bake_time_in_minutes: 1,
|
1877
|
-
# growth_factor: 1.0,
|
1878
|
-
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
1879
|
-
# }
|
1880
|
-
#
|
1881
2598
|
# @!attribute [rw] deployment_strategy_id
|
1882
2599
|
# The deployment strategy ID.
|
1883
2600
|
# @return [String]
|
@@ -1891,9 +2608,9 @@ module Aws::AppConfig
|
|
1891
2608
|
# @return [Integer]
|
1892
2609
|
#
|
1893
2610
|
# @!attribute [rw] final_bake_time_in_minutes
|
1894
|
-
# The amount of time AppConfig monitors for alarms before
|
1895
|
-
# the deployment to be complete and no longer eligible for
|
1896
|
-
#
|
2611
|
+
# The amount of time that AppConfig monitors for alarms before
|
2612
|
+
# considering the deployment to be complete and no longer eligible for
|
2613
|
+
# automatic rollback.
|
1897
2614
|
# @return [Integer]
|
1898
2615
|
#
|
1899
2616
|
# @!attribute [rw] growth_factor
|
@@ -1902,10 +2619,10 @@ module Aws::AppConfig
|
|
1902
2619
|
# @return [Float]
|
1903
2620
|
#
|
1904
2621
|
# @!attribute [rw] growth_type
|
1905
|
-
# The algorithm used to define how percentage grows over time.
|
2622
|
+
# The algorithm used to define how percentage grows over time.
|
1906
2623
|
# AppConfig supports the following growth types:
|
1907
2624
|
#
|
1908
|
-
# **Linear
|
2625
|
+
# **Linear**: For this type, AppConfig processes the deployment by
|
1909
2626
|
# increments of the growth factor evenly distributed over the
|
1910
2627
|
# deployment time. For example, a linear deployment that uses a growth
|
1911
2628
|
# factor of 20 initially makes the configuration available to 20
|
@@ -1914,7 +2631,7 @@ module Aws::AppConfig
|
|
1914
2631
|
# continues until 100% of the targets are set to receive the deployed
|
1915
2632
|
# configuration.
|
1916
2633
|
#
|
1917
|
-
# **Exponential
|
2634
|
+
# **Exponential**: For this type, AppConfig processes the deployment
|
1918
2635
|
# exponentially using the following formula: `G*(2^N)`. In this
|
1919
2636
|
# formula, `G` is the growth factor specified by the user and `N` is
|
1920
2637
|
# the number of steps until the configuration is deployed to all
|
@@ -1945,22 +2662,6 @@ module Aws::AppConfig
|
|
1945
2662
|
include Aws::Structure
|
1946
2663
|
end
|
1947
2664
|
|
1948
|
-
# @note When making an API call, you may pass UpdateEnvironmentRequest
|
1949
|
-
# data as a hash:
|
1950
|
-
#
|
1951
|
-
# {
|
1952
|
-
# application_id: "Id", # required
|
1953
|
-
# environment_id: "Id", # required
|
1954
|
-
# name: "Name",
|
1955
|
-
# description: "Description",
|
1956
|
-
# monitors: [
|
1957
|
-
# {
|
1958
|
-
# alarm_arn: "Arn",
|
1959
|
-
# alarm_role_arn: "RoleArn",
|
1960
|
-
# },
|
1961
|
-
# ],
|
1962
|
-
# }
|
1963
|
-
#
|
1964
2665
|
# @!attribute [rw] application_id
|
1965
2666
|
# The application ID.
|
1966
2667
|
# @return [String]
|
@@ -1993,15 +2694,56 @@ module Aws::AppConfig
|
|
1993
2694
|
include Aws::Structure
|
1994
2695
|
end
|
1995
2696
|
|
1996
|
-
#
|
1997
|
-
#
|
2697
|
+
# @!attribute [rw] extension_association_id
|
2698
|
+
# The system-generated ID for the association.
|
2699
|
+
# @return [String]
|
2700
|
+
#
|
2701
|
+
# @!attribute [rw] parameters
|
2702
|
+
# The parameter names and values defined in the extension.
|
2703
|
+
# @return [Hash<String,String>]
|
2704
|
+
#
|
2705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateExtensionAssociationRequest AWS API Documentation
|
2706
|
+
#
|
2707
|
+
class UpdateExtensionAssociationRequest < Struct.new(
|
2708
|
+
:extension_association_id,
|
2709
|
+
:parameters)
|
2710
|
+
SENSITIVE = []
|
2711
|
+
include Aws::Structure
|
2712
|
+
end
|
2713
|
+
|
2714
|
+
# @!attribute [rw] extension_identifier
|
2715
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
2716
|
+
# extension.
|
2717
|
+
# @return [String]
|
1998
2718
|
#
|
1999
|
-
#
|
2000
|
-
#
|
2001
|
-
#
|
2002
|
-
#
|
2003
|
-
#
|
2719
|
+
# @!attribute [rw] description
|
2720
|
+
# Information about the extension.
|
2721
|
+
# @return [String]
|
2722
|
+
#
|
2723
|
+
# @!attribute [rw] actions
|
2724
|
+
# The actions defined in the extension.
|
2725
|
+
# @return [Hash<String,Array<Types::Action>>]
|
2726
|
+
#
|
2727
|
+
# @!attribute [rw] parameters
|
2728
|
+
# One or more parameters for the actions called by the extension.
|
2729
|
+
# @return [Hash<String,Types::Parameter>]
|
2730
|
+
#
|
2731
|
+
# @!attribute [rw] version_number
|
2732
|
+
# The extension version number.
|
2733
|
+
# @return [Integer]
|
2734
|
+
#
|
2735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateExtensionRequest AWS API Documentation
|
2004
2736
|
#
|
2737
|
+
class UpdateExtensionRequest < Struct.new(
|
2738
|
+
:extension_identifier,
|
2739
|
+
:description,
|
2740
|
+
:actions,
|
2741
|
+
:parameters,
|
2742
|
+
:version_number)
|
2743
|
+
SENSITIVE = []
|
2744
|
+
include Aws::Structure
|
2745
|
+
end
|
2746
|
+
|
2005
2747
|
# @!attribute [rw] application_id
|
2006
2748
|
# The application ID.
|
2007
2749
|
# @return [String]
|
@@ -2025,19 +2767,16 @@ module Aws::AppConfig
|
|
2025
2767
|
end
|
2026
2768
|
|
2027
2769
|
# A validator provides a syntactic or semantic check to ensure the
|
2028
|
-
# configuration you want to deploy functions as intended. To
|
2029
|
-
# your application configuration data, you provide a schema or
|
2030
|
-
# function that runs against the
|
2031
|
-
# deployment or update can only proceed
|
2032
|
-
# valid.
|
2770
|
+
# configuration that you want to deploy functions as intended. To
|
2771
|
+
# validate your application configuration data, you provide a schema or
|
2772
|
+
# an Amazon Web Services Lambda function that runs against the
|
2773
|
+
# configuration. The configuration deployment or update can only proceed
|
2774
|
+
# when the configuration data is valid. For more information, see [About
|
2775
|
+
# validators][1] in the *AppConfig User Guide*.
|
2033
2776
|
#
|
2034
|
-
# @note When making an API call, you may pass Validator
|
2035
|
-
# data as a hash:
|
2036
2777
|
#
|
2037
|
-
#
|
2038
|
-
#
|
2039
|
-
# content: "StringWithLengthBetween0And32768", # required
|
2040
|
-
# }
|
2778
|
+
#
|
2779
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-profile.html#appconfig-creating-configuration-and-profile-validators
|
2041
2780
|
#
|
2042
2781
|
# @!attribute [rw] type
|
2043
2782
|
# AppConfig supports validators of type `JSON_SCHEMA` and `LAMBDA`
|
@@ -2045,7 +2784,7 @@ module Aws::AppConfig
|
|
2045
2784
|
#
|
2046
2785
|
# @!attribute [rw] content
|
2047
2786
|
# Either the JSON Schema content or the Amazon Resource Name (ARN) of
|
2048
|
-
# an
|
2787
|
+
# an Lambda function.
|
2049
2788
|
# @return [String]
|
2050
2789
|
#
|
2051
2790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Validator AWS API Documentation
|
@@ -2059,3 +2798,4 @@ module Aws::AppConfig
|
|
2059
2798
|
|
2060
2799
|
end
|
2061
2800
|
end
|
2801
|
+
|