aws-sdk-appconfig 1.21.0 → 1.40.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 +98 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-appconfig/client.rb +904 -84
- data/lib/aws-sdk-appconfig/client_api.rb +320 -4
- data/lib/aws-sdk-appconfig/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-appconfig/endpoint_provider.rb +60 -0
- data/lib/aws-sdk-appconfig/endpoints.rb +618 -0
- data/lib/aws-sdk-appconfig/plugins/endpoints.rb +154 -0
- data/lib/aws-sdk-appconfig/types.rb +868 -421
- data/lib/aws-sdk-appconfig.rb +5 -1
- metadata +8 -4
@@ -10,6 +10,111 @@
|
|
10
10
|
module Aws::AppConfig
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# An action defines the tasks that the extension performs during the
|
14
|
+
# AppConfig workflow. Each action includes an action point such as
|
15
|
+
# `ON_CREATE_HOSTED_CONFIGURATION`, `PRE_DEPLOYMENT`, or
|
16
|
+
# `ON_DEPLOYMENT`. Each action also includes a name, a URI to an Lambda
|
17
|
+
# function, and an Amazon Resource Name (ARN) for an Identity and Access
|
18
|
+
# Management assume role. You specify the name, URI, and ARN for each
|
19
|
+
# *action point* defined in the extension. You can specify the following
|
20
|
+
# actions for an extension:
|
21
|
+
#
|
22
|
+
# * `PRE_CREATE_HOSTED_CONFIGURATION_VERSION`
|
23
|
+
#
|
24
|
+
# * `PRE_START_DEPLOYMENT`
|
25
|
+
#
|
26
|
+
# * `ON_DEPLOYMENT_START`
|
27
|
+
#
|
28
|
+
# * `ON_DEPLOYMENT_STEP`
|
29
|
+
#
|
30
|
+
# * `ON_DEPLOYMENT_BAKING`
|
31
|
+
#
|
32
|
+
# * `ON_DEPLOYMENT_COMPLETE`
|
33
|
+
#
|
34
|
+
# * `ON_DEPLOYMENT_ROLLED_BACK`
|
35
|
+
#
|
36
|
+
# @!attribute [rw] name
|
37
|
+
# The action name.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] description
|
41
|
+
# Information about the action.
|
42
|
+
# @return [String]
|
43
|
+
#
|
44
|
+
# @!attribute [rw] uri
|
45
|
+
# The extension URI associated to the action point in the extension
|
46
|
+
# definition. The URI can be an Amazon Resource Name (ARN) for one of
|
47
|
+
# the following: an Lambda function, an Amazon Simple Queue Service
|
48
|
+
# queue, an Amazon Simple Notification Service topic, or the Amazon
|
49
|
+
# EventBridge default event bus.
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] role_arn
|
53
|
+
# An Amazon Resource Name (ARN) for an Identity and Access Management
|
54
|
+
# assume role.
|
55
|
+
# @return [String]
|
56
|
+
#
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Action AWS API Documentation
|
58
|
+
#
|
59
|
+
class Action < Struct.new(
|
60
|
+
:name,
|
61
|
+
:description,
|
62
|
+
:uri,
|
63
|
+
:role_arn)
|
64
|
+
SENSITIVE = []
|
65
|
+
include Aws::Structure
|
66
|
+
end
|
67
|
+
|
68
|
+
# An extension that was invoked as part of a deployment event.
|
69
|
+
#
|
70
|
+
# @!attribute [rw] extension_identifier
|
71
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
72
|
+
# extension.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] action_name
|
76
|
+
# The name of the action.
|
77
|
+
# @return [String]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] uri
|
80
|
+
# The extension URI associated to the action point in the extension
|
81
|
+
# definition. The URI can be an Amazon Resource Name (ARN) for one of
|
82
|
+
# the following: an Lambda function, an Amazon Simple Queue Service
|
83
|
+
# queue, an Amazon Simple Notification Service topic, or the Amazon
|
84
|
+
# EventBridge default event bus.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] role_arn
|
88
|
+
# An Amazon Resource Name (ARN) for an Identity and Access Management
|
89
|
+
# assume role.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] error_message
|
93
|
+
# The error message when an extension invocation fails.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] error_code
|
97
|
+
# The error code when an extension invocation fails.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] invocation_id
|
101
|
+
# A system-generated ID for this invocation.
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ActionInvocation AWS API Documentation
|
105
|
+
#
|
106
|
+
class ActionInvocation < Struct.new(
|
107
|
+
:extension_identifier,
|
108
|
+
:action_name,
|
109
|
+
:uri,
|
110
|
+
:role_arn,
|
111
|
+
:error_message,
|
112
|
+
:error_code,
|
113
|
+
:invocation_id)
|
114
|
+
SENSITIVE = []
|
115
|
+
include Aws::Structure
|
116
|
+
end
|
117
|
+
|
13
118
|
# @!attribute [rw] id
|
14
119
|
# The application ID.
|
15
120
|
# @return [String]
|
@@ -50,8 +155,37 @@ module Aws::AppConfig
|
|
50
155
|
include Aws::Structure
|
51
156
|
end
|
52
157
|
|
158
|
+
# An extension that was invoked during a deployment.
|
159
|
+
#
|
160
|
+
# @!attribute [rw] extension_id
|
161
|
+
# The system-generated ID of the extension.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] extension_association_id
|
165
|
+
# The system-generated ID for the association.
|
166
|
+
# @return [String]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] version_number
|
169
|
+
# The extension version number.
|
170
|
+
# @return [Integer]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] parameters
|
173
|
+
# One or more parameters for the actions called by the extension.
|
174
|
+
# @return [Hash<String,String>]
|
175
|
+
#
|
176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/AppliedExtension AWS API Documentation
|
177
|
+
#
|
178
|
+
class AppliedExtension < Struct.new(
|
179
|
+
:extension_id,
|
180
|
+
:extension_association_id,
|
181
|
+
:version_number,
|
182
|
+
:parameters)
|
183
|
+
SENSITIVE = []
|
184
|
+
include Aws::Structure
|
185
|
+
end
|
186
|
+
|
53
187
|
# Detailed information about the input that failed to satisfy the
|
54
|
-
# constraints specified by
|
188
|
+
# constraints specified by a call.
|
55
189
|
#
|
56
190
|
# @!attribute [rw] invalid_configuration
|
57
191
|
# Detailed information about the bad request exception error when
|
@@ -82,7 +216,7 @@ module Aws::AppConfig
|
|
82
216
|
#
|
83
217
|
# @!attribute [rw] details
|
84
218
|
# Detailed information about the input that failed to satisfy the
|
85
|
-
# constraints specified by
|
219
|
+
# constraints specified by a call.
|
86
220
|
# @return [Types::BadRequestDetails]
|
87
221
|
#
|
88
222
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/BadRequestException AWS API Documentation
|
@@ -98,13 +232,11 @@ module Aws::AppConfig
|
|
98
232
|
# @!attribute [rw] content
|
99
233
|
# The content of the configuration or the configuration data.
|
100
234
|
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
# new or updated configuration data, then the `Content` section is not
|
107
|
-
# returned.
|
235
|
+
# The `Content` attribute only contains data if the system finds new
|
236
|
+
# or updated configuration data. If there is no new or updated data
|
237
|
+
# and `ClientConfigurationVersion` matches the version of the current
|
238
|
+
# configuration, AppConfig returns a `204 No Content` HTTP response
|
239
|
+
# code and the `Content` value will be empty.
|
108
240
|
# @return [String]
|
109
241
|
#
|
110
242
|
# @!attribute [rw] configuration_version
|
@@ -160,10 +292,30 @@ module Aws::AppConfig
|
|
160
292
|
# @return [Array<Types::Validator>]
|
161
293
|
#
|
162
294
|
# @!attribute [rw] type
|
163
|
-
# The type of configurations
|
164
|
-
#
|
165
|
-
#
|
166
|
-
# configurations to
|
295
|
+
# The type of configurations contained in the profile. AppConfig
|
296
|
+
# supports `feature flags` and `freeform` configurations. We recommend
|
297
|
+
# you create feature flag configurations to enable or disable new
|
298
|
+
# features and freeform configurations to distribute configurations to
|
299
|
+
# an application. When calling this API, enter one of the following
|
300
|
+
# values for `Type`:
|
301
|
+
#
|
302
|
+
# `AWS.AppConfig.FeatureFlags`
|
303
|
+
#
|
304
|
+
# `AWS.Freeform`
|
305
|
+
# @return [String]
|
306
|
+
#
|
307
|
+
# @!attribute [rw] kms_key_arn
|
308
|
+
# The Amazon Resource Name of the Key Management Service key to
|
309
|
+
# encrypt new configuration data versions in the AppConfig hosted
|
310
|
+
# configuration store. This attribute is only used for `hosted`
|
311
|
+
# configuration types. To encrypt data managed in other configuration
|
312
|
+
# stores, see the documentation for how to specify an KMS key for that
|
313
|
+
# particular service.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @!attribute [rw] kms_key_identifier
|
317
|
+
# The Key Management Service key identifier (key ID, key alias, or key
|
318
|
+
# ARN) provided when the resource was created or updated.
|
167
319
|
# @return [String]
|
168
320
|
#
|
169
321
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ConfigurationProfile AWS API Documentation
|
@@ -176,7 +328,9 @@ module Aws::AppConfig
|
|
176
328
|
:location_uri,
|
177
329
|
:retrieval_role_arn,
|
178
330
|
:validators,
|
179
|
-
:type
|
331
|
+
:type,
|
332
|
+
:kms_key_arn,
|
333
|
+
:kms_key_identifier)
|
180
334
|
SENSITIVE = []
|
181
335
|
include Aws::Structure
|
182
336
|
end
|
@@ -204,10 +358,16 @@ module Aws::AppConfig
|
|
204
358
|
# @return [Array<String>]
|
205
359
|
#
|
206
360
|
# @!attribute [rw] type
|
207
|
-
# The type of configurations
|
208
|
-
#
|
209
|
-
#
|
210
|
-
# to
|
361
|
+
# The type of configurations contained in the profile. AppConfig
|
362
|
+
# supports `feature flags` and `freeform` configurations. We recommend
|
363
|
+
# you create feature flag configurations to enable or disable new
|
364
|
+
# features and freeform configurations to distribute configurations to
|
365
|
+
# an application. When calling this API, enter one of the following
|
366
|
+
# values for `Type`:
|
367
|
+
#
|
368
|
+
# `AWS.AppConfig.FeatureFlags`
|
369
|
+
#
|
370
|
+
# `AWS.Freeform`
|
211
371
|
# @return [String]
|
212
372
|
#
|
213
373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ConfigurationProfileSummary AWS API Documentation
|
@@ -255,17 +415,6 @@ module Aws::AppConfig
|
|
255
415
|
include Aws::Structure
|
256
416
|
end
|
257
417
|
|
258
|
-
# @note When making an API call, you may pass CreateApplicationRequest
|
259
|
-
# data as a hash:
|
260
|
-
#
|
261
|
-
# {
|
262
|
-
# name: "Name", # required
|
263
|
-
# description: "Description",
|
264
|
-
# tags: {
|
265
|
-
# "TagKey" => "TagValue",
|
266
|
-
# },
|
267
|
-
# }
|
268
|
-
#
|
269
418
|
# @!attribute [rw] name
|
270
419
|
# A name for the application.
|
271
420
|
# @return [String]
|
@@ -290,27 +439,6 @@ module Aws::AppConfig
|
|
290
439
|
include Aws::Structure
|
291
440
|
end
|
292
441
|
|
293
|
-
# @note When making an API call, you may pass CreateConfigurationProfileRequest
|
294
|
-
# data as a hash:
|
295
|
-
#
|
296
|
-
# {
|
297
|
-
# application_id: "Id", # required
|
298
|
-
# name: "Name", # required
|
299
|
-
# description: "Description",
|
300
|
-
# location_uri: "Uri", # required
|
301
|
-
# retrieval_role_arn: "RoleArn",
|
302
|
-
# validators: [
|
303
|
-
# {
|
304
|
-
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
305
|
-
# content: "StringWithLengthBetween0And32768", # required
|
306
|
-
# },
|
307
|
-
# ],
|
308
|
-
# tags: {
|
309
|
-
# "TagKey" => "TagValue",
|
310
|
-
# },
|
311
|
-
# type: "ConfigurationProfileType",
|
312
|
-
# }
|
313
|
-
#
|
314
442
|
# @!attribute [rw] application_id
|
315
443
|
# The application ID.
|
316
444
|
# @return [String]
|
@@ -324,17 +452,28 @@ module Aws::AppConfig
|
|
324
452
|
# @return [String]
|
325
453
|
#
|
326
454
|
# @!attribute [rw] location_uri
|
327
|
-
# A URI to locate the configuration. You can specify the
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
455
|
+
# A URI to locate the configuration. You can specify the following:
|
456
|
+
#
|
457
|
+
# * For the AppConfig hosted configuration store and for feature
|
458
|
+
# flags, specify `hosted`.
|
459
|
+
#
|
460
|
+
# * For an Amazon Web Services Systems Manager Parameter Store
|
461
|
+
# parameter, specify either the parameter name in the format
|
462
|
+
# `ssm-parameter://<parameter name>` or the ARN.
|
463
|
+
#
|
464
|
+
# * For an Amazon Web Services CodePipeline pipeline, specify the URI
|
465
|
+
# in the following format: `codepipeline`://<pipeline name>.
|
466
|
+
#
|
467
|
+
# * For an Secrets Manager secret, specify the URI in the following
|
468
|
+
# format: `secretsmanager`://<secret name>.
|
469
|
+
#
|
470
|
+
# * For an Amazon S3 object, specify the URI in the following format:
|
471
|
+
# `s3://<bucket>/<objectKey> `. Here is an example:
|
472
|
+
# `s3://my-bucket/my-app/us-east-1/my-config.json`
|
473
|
+
#
|
474
|
+
# * For an SSM document, specify either the document name in the
|
475
|
+
# format `ssm-document://<document name>` or the Amazon Resource
|
476
|
+
# Name (ARN).
|
338
477
|
# @return [String]
|
339
478
|
#
|
340
479
|
# @!attribute [rw] retrieval_role_arn
|
@@ -357,10 +496,26 @@ module Aws::AppConfig
|
|
357
496
|
# @return [Hash<String,String>]
|
358
497
|
#
|
359
498
|
# @!attribute [rw] type
|
360
|
-
# The type of configurations
|
361
|
-
#
|
362
|
-
#
|
363
|
-
# configurations to
|
499
|
+
# The type of configurations contained in the profile. AppConfig
|
500
|
+
# supports `feature flags` and `freeform` configurations. We recommend
|
501
|
+
# you create feature flag configurations to enable or disable new
|
502
|
+
# features and freeform configurations to distribute configurations to
|
503
|
+
# an application. When calling this API, enter one of the following
|
504
|
+
# values for `Type`:
|
505
|
+
#
|
506
|
+
# `AWS.AppConfig.FeatureFlags`
|
507
|
+
#
|
508
|
+
# `AWS.Freeform`
|
509
|
+
# @return [String]
|
510
|
+
#
|
511
|
+
# @!attribute [rw] kms_key_identifier
|
512
|
+
# The identifier for an Key Management Service key to encrypt new
|
513
|
+
# configuration data versions in the AppConfig hosted configuration
|
514
|
+
# store. This attribute is only used for `hosted` configuration types.
|
515
|
+
# The identifier can be an KMS key ID, alias, or the Amazon Resource
|
516
|
+
# Name (ARN) of the key ID or alias. To encrypt data managed in other
|
517
|
+
# configuration stores, see the documentation for how to specify an
|
518
|
+
# KMS key for that particular service.
|
364
519
|
# @return [String]
|
365
520
|
#
|
366
521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateConfigurationProfileRequest AWS API Documentation
|
@@ -373,27 +528,12 @@ module Aws::AppConfig
|
|
373
528
|
:retrieval_role_arn,
|
374
529
|
:validators,
|
375
530
|
:tags,
|
376
|
-
:type
|
531
|
+
:type,
|
532
|
+
:kms_key_identifier)
|
377
533
|
SENSITIVE = []
|
378
534
|
include Aws::Structure
|
379
535
|
end
|
380
536
|
|
381
|
-
# @note When making an API call, you may pass CreateDeploymentStrategyRequest
|
382
|
-
# data as a hash:
|
383
|
-
#
|
384
|
-
# {
|
385
|
-
# name: "Name", # required
|
386
|
-
# description: "Description",
|
387
|
-
# deployment_duration_in_minutes: 1, # required
|
388
|
-
# final_bake_time_in_minutes: 1,
|
389
|
-
# growth_factor: 1.0, # required
|
390
|
-
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
391
|
-
# replicate_to: "NONE", # required, accepts NONE, SSM_DOCUMENT
|
392
|
-
# tags: {
|
393
|
-
# "TagKey" => "TagValue",
|
394
|
-
# },
|
395
|
-
# }
|
396
|
-
#
|
397
537
|
# @!attribute [rw] name
|
398
538
|
# A name for the deployment strategy.
|
399
539
|
# @return [String]
|
@@ -407,9 +547,18 @@ module Aws::AppConfig
|
|
407
547
|
# @return [Integer]
|
408
548
|
#
|
409
549
|
# @!attribute [rw] final_bake_time_in_minutes
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
550
|
+
# Specifies the amount of time AppConfig monitors for Amazon
|
551
|
+
# CloudWatch alarms after the configuration has been deployed to 100%
|
552
|
+
# of its targets, before considering the deployment to be complete. If
|
553
|
+
# an alarm is triggered during this time, AppConfig rolls back the
|
554
|
+
# deployment. You must configure permissions for AppConfig to roll
|
555
|
+
# back based on CloudWatch alarms. For more information, see
|
556
|
+
# [Configuring permissions for rollback based on Amazon CloudWatch
|
557
|
+
# alarms][1] in the *AppConfig User Guide*.
|
558
|
+
#
|
559
|
+
#
|
560
|
+
#
|
561
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html
|
413
562
|
# @return [Integer]
|
414
563
|
#
|
415
564
|
# @!attribute [rw] growth_factor
|
@@ -421,7 +570,7 @@ module Aws::AppConfig
|
|
421
570
|
# The algorithm used to define how percentage grows over time.
|
422
571
|
# AppConfig supports the following growth types:
|
423
572
|
#
|
424
|
-
# **Linear
|
573
|
+
# **Linear**: For this type, AppConfig processes the deployment by
|
425
574
|
# dividing the total number of targets by the value specified for
|
426
575
|
# `Step percentage`. For example, a linear deployment that uses a
|
427
576
|
# `Step percentage` of 10 deploys the configuration to 10 percent of
|
@@ -429,7 +578,7 @@ module Aws::AppConfig
|
|
429
578
|
# the configuration to the next 10 percent. This continues until 100%
|
430
579
|
# of the targets have successfully received the configuration.
|
431
580
|
#
|
432
|
-
# **Exponential
|
581
|
+
# **Exponential**: For this type, AppConfig processes the deployment
|
433
582
|
# exponentially using the following formula: `G*(2^N)`. In this
|
434
583
|
# formula, `G` is the growth factor specified by the user and `N` is
|
435
584
|
# the number of steps until the configuration is deployed to all
|
@@ -472,24 +621,6 @@ module Aws::AppConfig
|
|
472
621
|
include Aws::Structure
|
473
622
|
end
|
474
623
|
|
475
|
-
# @note When making an API call, you may pass CreateEnvironmentRequest
|
476
|
-
# data as a hash:
|
477
|
-
#
|
478
|
-
# {
|
479
|
-
# application_id: "Id", # required
|
480
|
-
# name: "Name", # required
|
481
|
-
# description: "Description",
|
482
|
-
# monitors: [
|
483
|
-
# {
|
484
|
-
# alarm_arn: "StringWithLengthBetween1And2048", # required
|
485
|
-
# alarm_role_arn: "RoleArn",
|
486
|
-
# },
|
487
|
-
# ],
|
488
|
-
# tags: {
|
489
|
-
# "TagKey" => "TagValue",
|
490
|
-
# },
|
491
|
-
# }
|
492
|
-
#
|
493
624
|
# @!attribute [rw] application_id
|
494
625
|
# The application ID.
|
495
626
|
# @return [String]
|
@@ -524,18 +655,91 @@ module Aws::AppConfig
|
|
524
655
|
include Aws::Structure
|
525
656
|
end
|
526
657
|
|
527
|
-
#
|
528
|
-
#
|
658
|
+
# @!attribute [rw] extension_identifier
|
659
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
660
|
+
# extension.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] extension_version_number
|
664
|
+
# The version number of the extension. If not specified, AppConfig
|
665
|
+
# uses the maximum version of the extension.
|
666
|
+
# @return [Integer]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] resource_identifier
|
669
|
+
# The ARN of an application, configuration profile, or environment.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] parameters
|
673
|
+
# The parameter names and values defined in the extensions. Extension
|
674
|
+
# parameters marked `Required` must be entered for this field.
|
675
|
+
# @return [Hash<String,String>]
|
676
|
+
#
|
677
|
+
# @!attribute [rw] tags
|
678
|
+
# Adds one or more tags for the specified extension association. Tags
|
679
|
+
# are metadata that help you categorize resources in different ways,
|
680
|
+
# for example, by purpose, owner, or environment. Each tag consists of
|
681
|
+
# a key and an optional value, both of which you define.
|
682
|
+
# @return [Hash<String,String>]
|
683
|
+
#
|
684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateExtensionAssociationRequest AWS API Documentation
|
685
|
+
#
|
686
|
+
class CreateExtensionAssociationRequest < Struct.new(
|
687
|
+
:extension_identifier,
|
688
|
+
:extension_version_number,
|
689
|
+
:resource_identifier,
|
690
|
+
:parameters,
|
691
|
+
:tags)
|
692
|
+
SENSITIVE = []
|
693
|
+
include Aws::Structure
|
694
|
+
end
|
695
|
+
|
696
|
+
# @!attribute [rw] name
|
697
|
+
# A name for the extension. Each extension name in your account must
|
698
|
+
# be unique. Extension versions use the same name.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @!attribute [rw] description
|
702
|
+
# Information about the extension.
|
703
|
+
# @return [String]
|
529
704
|
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
# description: "Description",
|
534
|
-
# content: "data", # required
|
535
|
-
# content_type: "StringWithLengthBetween1And255", # required
|
536
|
-
# latest_version_number: 1,
|
537
|
-
# }
|
705
|
+
# @!attribute [rw] actions
|
706
|
+
# The actions defined in the extension.
|
707
|
+
# @return [Hash<String,Array<Types::Action>>]
|
538
708
|
#
|
709
|
+
# @!attribute [rw] parameters
|
710
|
+
# The parameters accepted by the extension. You specify parameter
|
711
|
+
# values when you associate the extension to an AppConfig resource by
|
712
|
+
# using the `CreateExtensionAssociation` API action. For Lambda
|
713
|
+
# extension actions, these parameters are included in the Lambda
|
714
|
+
# request object.
|
715
|
+
# @return [Hash<String,Types::Parameter>]
|
716
|
+
#
|
717
|
+
# @!attribute [rw] tags
|
718
|
+
# Adds one or more tags for the specified extension. Tags are metadata
|
719
|
+
# that help you categorize resources in different ways, for example,
|
720
|
+
# by purpose, owner, or environment. Each tag consists of a key and an
|
721
|
+
# optional value, both of which you define.
|
722
|
+
# @return [Hash<String,String>]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] latest_version_number
|
725
|
+
# You can omit this field when you create an extension. When you
|
726
|
+
# create a new version, specify the most recent current version
|
727
|
+
# number. For example, you create version 3, enter 2 for this field.
|
728
|
+
# @return [Integer]
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateExtensionRequest AWS API Documentation
|
731
|
+
#
|
732
|
+
class CreateExtensionRequest < Struct.new(
|
733
|
+
:name,
|
734
|
+
:description,
|
735
|
+
:actions,
|
736
|
+
:parameters,
|
737
|
+
:tags,
|
738
|
+
:latest_version_number)
|
739
|
+
SENSITIVE = []
|
740
|
+
include Aws::Structure
|
741
|
+
end
|
742
|
+
|
539
743
|
# @!attribute [rw] application_id
|
540
744
|
# The application ID.
|
541
745
|
# @return [String]
|
@@ -569,6 +773,12 @@ module Aws::AppConfig
|
|
569
773
|
# number of the latest hosted configuration version.
|
570
774
|
# @return [Integer]
|
571
775
|
#
|
776
|
+
# @!attribute [rw] version_label
|
777
|
+
# An optional, user-defined label for the AppConfig hosted
|
778
|
+
# configuration version. This value must contain at least one
|
779
|
+
# non-numeric character. For example, "v2.2.0".
|
780
|
+
# @return [String]
|
781
|
+
#
|
572
782
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateHostedConfigurationVersionRequest AWS API Documentation
|
573
783
|
#
|
574
784
|
class CreateHostedConfigurationVersionRequest < Struct.new(
|
@@ -577,18 +787,12 @@ module Aws::AppConfig
|
|
577
787
|
:description,
|
578
788
|
:content,
|
579
789
|
:content_type,
|
580
|
-
:latest_version_number
|
790
|
+
:latest_version_number,
|
791
|
+
:version_label)
|
581
792
|
SENSITIVE = [:content]
|
582
793
|
include Aws::Structure
|
583
794
|
end
|
584
795
|
|
585
|
-
# @note When making an API call, you may pass DeleteApplicationRequest
|
586
|
-
# data as a hash:
|
587
|
-
#
|
588
|
-
# {
|
589
|
-
# application_id: "Id", # required
|
590
|
-
# }
|
591
|
-
#
|
592
796
|
# @!attribute [rw] application_id
|
593
797
|
# The ID of the application to delete.
|
594
798
|
# @return [String]
|
@@ -601,14 +805,6 @@ module Aws::AppConfig
|
|
601
805
|
include Aws::Structure
|
602
806
|
end
|
603
807
|
|
604
|
-
# @note When making an API call, you may pass DeleteConfigurationProfileRequest
|
605
|
-
# data as a hash:
|
606
|
-
#
|
607
|
-
# {
|
608
|
-
# application_id: "Id", # required
|
609
|
-
# configuration_profile_id: "Id", # required
|
610
|
-
# }
|
611
|
-
#
|
612
808
|
# @!attribute [rw] application_id
|
613
809
|
# The application ID that includes the configuration profile you want
|
614
810
|
# to delete.
|
@@ -627,13 +823,6 @@ module Aws::AppConfig
|
|
627
823
|
include Aws::Structure
|
628
824
|
end
|
629
825
|
|
630
|
-
# @note When making an API call, you may pass DeleteDeploymentStrategyRequest
|
631
|
-
# data as a hash:
|
632
|
-
#
|
633
|
-
# {
|
634
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
635
|
-
# }
|
636
|
-
#
|
637
826
|
# @!attribute [rw] deployment_strategy_id
|
638
827
|
# The ID of the deployment strategy you want to delete.
|
639
828
|
# @return [String]
|
@@ -646,14 +835,6 @@ module Aws::AppConfig
|
|
646
835
|
include Aws::Structure
|
647
836
|
end
|
648
837
|
|
649
|
-
# @note When making an API call, you may pass DeleteEnvironmentRequest
|
650
|
-
# data as a hash:
|
651
|
-
#
|
652
|
-
# {
|
653
|
-
# application_id: "Id", # required
|
654
|
-
# environment_id: "Id", # required
|
655
|
-
# }
|
656
|
-
#
|
657
838
|
# @!attribute [rw] application_id
|
658
839
|
# The application ID that includes the environment that you want to
|
659
840
|
# delete.
|
@@ -672,15 +853,37 @@ module Aws::AppConfig
|
|
672
853
|
include Aws::Structure
|
673
854
|
end
|
674
855
|
|
675
|
-
#
|
676
|
-
#
|
856
|
+
# @!attribute [rw] extension_association_id
|
857
|
+
# The ID of the extension association to delete.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteExtensionAssociationRequest AWS API Documentation
|
861
|
+
#
|
862
|
+
class DeleteExtensionAssociationRequest < Struct.new(
|
863
|
+
:extension_association_id)
|
864
|
+
SENSITIVE = []
|
865
|
+
include Aws::Structure
|
866
|
+
end
|
867
|
+
|
868
|
+
# @!attribute [rw] extension_identifier
|
869
|
+
# The name, ID, or Amazon Resource Name (ARN) of the extension you
|
870
|
+
# want to delete.
|
871
|
+
# @return [String]
|
677
872
|
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
# }
|
873
|
+
# @!attribute [rw] version_number
|
874
|
+
# A specific version of an extension to delete. If omitted, the
|
875
|
+
# highest version is deleted.
|
876
|
+
# @return [Integer]
|
683
877
|
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteExtensionRequest AWS API Documentation
|
879
|
+
#
|
880
|
+
class DeleteExtensionRequest < Struct.new(
|
881
|
+
:extension_identifier,
|
882
|
+
:version_number)
|
883
|
+
SENSITIVE = []
|
884
|
+
include Aws::Structure
|
885
|
+
end
|
886
|
+
|
684
887
|
# @!attribute [rw] application_id
|
685
888
|
# The application ID.
|
686
889
|
# @return [String]
|
@@ -779,6 +982,30 @@ module Aws::AppConfig
|
|
779
982
|
# The time the deployment completed.
|
780
983
|
# @return [Time]
|
781
984
|
#
|
985
|
+
# @!attribute [rw] applied_extensions
|
986
|
+
# A list of extensions that were processed as part of the deployment.
|
987
|
+
# The extensions that were previously associated to the configuration
|
988
|
+
# profile, environment, or the application when `StartDeployment` was
|
989
|
+
# called.
|
990
|
+
# @return [Array<Types::AppliedExtension>]
|
991
|
+
#
|
992
|
+
# @!attribute [rw] kms_key_arn
|
993
|
+
# The Amazon Resource Name of the Key Management Service key used to
|
994
|
+
# encrypt configuration data. You can encrypt secrets stored in
|
995
|
+
# Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects
|
996
|
+
# encrypted with SSE-KMS, or secure string parameters stored in Amazon
|
997
|
+
# Web Services Systems Manager Parameter Store.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] kms_key_identifier
|
1001
|
+
# The Key Management Service key identifier (key ID, key alias, or key
|
1002
|
+
# ARN) provided when the resource was created or updated.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] version_label
|
1006
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
782
1009
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Deployment AWS API Documentation
|
783
1010
|
#
|
784
1011
|
class Deployment < Struct.new(
|
@@ -799,7 +1026,11 @@ module Aws::AppConfig
|
|
799
1026
|
:event_log,
|
800
1027
|
:percentage_complete,
|
801
1028
|
:started_at,
|
802
|
-
:completed_at
|
1029
|
+
:completed_at,
|
1030
|
+
:applied_extensions,
|
1031
|
+
:kms_key_arn,
|
1032
|
+
:kms_key_identifier,
|
1033
|
+
:version_label)
|
803
1034
|
SENSITIVE = []
|
804
1035
|
include Aws::Structure
|
805
1036
|
end
|
@@ -821,12 +1052,21 @@ module Aws::AppConfig
|
|
821
1052
|
#
|
822
1053
|
# @!attribute [rw] description
|
823
1054
|
# A description of the deployment event. Descriptions include, but are
|
824
|
-
# not limited to, the
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
1055
|
+
# not limited to, the following:
|
1056
|
+
#
|
1057
|
+
# * The Amazon Web Services account or the Amazon CloudWatch alarm ARN
|
1058
|
+
# that initiated a rollback.
|
1059
|
+
#
|
1060
|
+
# * The percentage of hosts that received the deployment.
|
1061
|
+
#
|
1062
|
+
# * A recommendation to attempt a new deployment (in the case of an
|
1063
|
+
# internal error).
|
828
1064
|
# @return [String]
|
829
1065
|
#
|
1066
|
+
# @!attribute [rw] action_invocations
|
1067
|
+
# The list of extensions that were invoked as part of the deployment.
|
1068
|
+
# @return [Array<Types::ActionInvocation>]
|
1069
|
+
#
|
830
1070
|
# @!attribute [rw] occurred_at
|
831
1071
|
# The date and time the event occurred.
|
832
1072
|
# @return [Time]
|
@@ -837,6 +1077,7 @@ module Aws::AppConfig
|
|
837
1077
|
:event_type,
|
838
1078
|
:triggered_by,
|
839
1079
|
:description,
|
1080
|
+
:action_invocations,
|
840
1081
|
:occurred_at)
|
841
1082
|
SENSITIVE = []
|
842
1083
|
include Aws::Structure
|
@@ -959,6 +1200,10 @@ module Aws::AppConfig
|
|
959
1200
|
# Time the deployment completed.
|
960
1201
|
# @return [Time]
|
961
1202
|
#
|
1203
|
+
# @!attribute [rw] version_label
|
1204
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
962
1207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeploymentSummary AWS API Documentation
|
963
1208
|
#
|
964
1209
|
class DeploymentSummary < Struct.new(
|
@@ -972,7 +1217,8 @@ module Aws::AppConfig
|
|
972
1217
|
:state,
|
973
1218
|
:percentage_complete,
|
974
1219
|
:started_at,
|
975
|
-
:completed_at
|
1220
|
+
:completed_at,
|
1221
|
+
:version_label)
|
976
1222
|
SENSITIVE = []
|
977
1223
|
include Aws::Structure
|
978
1224
|
end
|
@@ -1052,13 +1298,194 @@ module Aws::AppConfig
|
|
1052
1298
|
include Aws::Structure
|
1053
1299
|
end
|
1054
1300
|
|
1055
|
-
#
|
1056
|
-
#
|
1301
|
+
# @!attribute [rw] id
|
1302
|
+
# The system-generated ID of the extension.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] name
|
1306
|
+
# The extension name.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] version_number
|
1310
|
+
# The extension version number.
|
1311
|
+
# @return [Integer]
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] arn
|
1314
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1315
|
+
# @return [String]
|
1316
|
+
#
|
1317
|
+
# @!attribute [rw] description
|
1318
|
+
# Information about the extension.
|
1319
|
+
# @return [String]
|
1320
|
+
#
|
1321
|
+
# @!attribute [rw] actions
|
1322
|
+
# The actions defined in the extension.
|
1323
|
+
# @return [Hash<String,Array<Types::Action>>]
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] parameters
|
1326
|
+
# The parameters accepted by the extension. You specify parameter
|
1327
|
+
# values when you associate the extension to an AppConfig resource by
|
1328
|
+
# using the `CreateExtensionAssociation` API action. For Lambda
|
1329
|
+
# extension actions, these parameters are included in the Lambda
|
1330
|
+
# request object.
|
1331
|
+
# @return [Hash<String,Types::Parameter>]
|
1332
|
+
#
|
1333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Extension AWS API Documentation
|
1334
|
+
#
|
1335
|
+
class Extension < Struct.new(
|
1336
|
+
:id,
|
1337
|
+
:name,
|
1338
|
+
:version_number,
|
1339
|
+
:arn,
|
1340
|
+
:description,
|
1341
|
+
:actions,
|
1342
|
+
:parameters)
|
1343
|
+
SENSITIVE = []
|
1344
|
+
include Aws::Structure
|
1345
|
+
end
|
1346
|
+
|
1347
|
+
# @!attribute [rw] id
|
1348
|
+
# The system-generated ID for the association.
|
1349
|
+
# @return [String]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] extension_arn
|
1352
|
+
# The ARN of the extension defined in the association.
|
1353
|
+
# @return [String]
|
1354
|
+
#
|
1355
|
+
# @!attribute [rw] resource_arn
|
1356
|
+
# The ARNs of applications, configuration profiles, or environments
|
1357
|
+
# defined in the association.
|
1358
|
+
# @return [String]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] arn
|
1361
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1362
|
+
# @return [String]
|
1363
|
+
#
|
1364
|
+
# @!attribute [rw] parameters
|
1365
|
+
# The parameter names and values defined in the association.
|
1366
|
+
# @return [Hash<String,String>]
|
1367
|
+
#
|
1368
|
+
# @!attribute [rw] extension_version_number
|
1369
|
+
# The version number for the extension defined in the association.
|
1370
|
+
# @return [Integer]
|
1371
|
+
#
|
1372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociation AWS API Documentation
|
1373
|
+
#
|
1374
|
+
class ExtensionAssociation < Struct.new(
|
1375
|
+
:id,
|
1376
|
+
:extension_arn,
|
1377
|
+
:resource_arn,
|
1378
|
+
:arn,
|
1379
|
+
:parameters,
|
1380
|
+
:extension_version_number)
|
1381
|
+
SENSITIVE = []
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# Information about an association between an extension and an AppConfig
|
1386
|
+
# resource such as an application, environment, or configuration
|
1387
|
+
# profile. Call `GetExtensionAssociation` to get more information about
|
1388
|
+
# an association.
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] id
|
1391
|
+
# The extension association ID. This ID is used to call other
|
1392
|
+
# `ExtensionAssociation` API actions such as `GetExtensionAssociation`
|
1393
|
+
# or `DeleteExtensionAssociation`.
|
1394
|
+
# @return [String]
|
1395
|
+
#
|
1396
|
+
# @!attribute [rw] extension_arn
|
1397
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1398
|
+
# @return [String]
|
1399
|
+
#
|
1400
|
+
# @!attribute [rw] resource_arn
|
1401
|
+
# The ARNs of applications, configuration profiles, or environments
|
1402
|
+
# defined in the association.
|
1403
|
+
# @return [String]
|
1404
|
+
#
|
1405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociationSummary AWS API Documentation
|
1406
|
+
#
|
1407
|
+
class ExtensionAssociationSummary < Struct.new(
|
1408
|
+
:id,
|
1409
|
+
:extension_arn,
|
1410
|
+
:resource_arn)
|
1411
|
+
SENSITIVE = []
|
1412
|
+
include Aws::Structure
|
1413
|
+
end
|
1414
|
+
|
1415
|
+
# @!attribute [rw] items
|
1416
|
+
# The list of extension associations. Each item represents an
|
1417
|
+
# extension association to an application, environment, or
|
1418
|
+
# configuration profile.
|
1419
|
+
# @return [Array<Types::ExtensionAssociationSummary>]
|
1420
|
+
#
|
1421
|
+
# @!attribute [rw] next_token
|
1422
|
+
# The token for the next set of items to return. Use this token to get
|
1423
|
+
# the next set of results.
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociations AWS API Documentation
|
1427
|
+
#
|
1428
|
+
class ExtensionAssociations < Struct.new(
|
1429
|
+
:items,
|
1430
|
+
:next_token)
|
1431
|
+
SENSITIVE = []
|
1432
|
+
include Aws::Structure
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# Information about an extension. Call `GetExtension` to get more
|
1436
|
+
# information about an extension.
|
1437
|
+
#
|
1438
|
+
# @!attribute [rw] id
|
1439
|
+
# The system-generated ID of the extension.
|
1440
|
+
# @return [String]
|
1441
|
+
#
|
1442
|
+
# @!attribute [rw] name
|
1443
|
+
# The extension name.
|
1444
|
+
# @return [String]
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] version_number
|
1447
|
+
# The extension version number.
|
1448
|
+
# @return [Integer]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] arn
|
1451
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1452
|
+
# @return [String]
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] description
|
1455
|
+
# Information about the extension.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionSummary AWS API Documentation
|
1459
|
+
#
|
1460
|
+
class ExtensionSummary < Struct.new(
|
1461
|
+
:id,
|
1462
|
+
:name,
|
1463
|
+
:version_number,
|
1464
|
+
:arn,
|
1465
|
+
:description)
|
1466
|
+
SENSITIVE = []
|
1467
|
+
include Aws::Structure
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# @!attribute [rw] items
|
1471
|
+
# The list of available extensions. The list includes Amazon Web
|
1472
|
+
# Services authored and user-created extensions.
|
1473
|
+
# @return [Array<Types::ExtensionSummary>]
|
1057
1474
|
#
|
1058
|
-
#
|
1059
|
-
#
|
1060
|
-
#
|
1475
|
+
# @!attribute [rw] next_token
|
1476
|
+
# The token for the next set of items to return. Use this token to get
|
1477
|
+
# the next set of results.
|
1478
|
+
# @return [String]
|
1061
1479
|
#
|
1480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Extensions AWS API Documentation
|
1481
|
+
#
|
1482
|
+
class Extensions < Struct.new(
|
1483
|
+
:items,
|
1484
|
+
:next_token)
|
1485
|
+
SENSITIVE = []
|
1486
|
+
include Aws::Structure
|
1487
|
+
end
|
1488
|
+
|
1062
1489
|
# @!attribute [rw] application_id
|
1063
1490
|
# The ID of the application you want to get.
|
1064
1491
|
# @return [String]
|
@@ -1071,14 +1498,6 @@ module Aws::AppConfig
|
|
1071
1498
|
include Aws::Structure
|
1072
1499
|
end
|
1073
1500
|
|
1074
|
-
# @note When making an API call, you may pass GetConfigurationProfileRequest
|
1075
|
-
# data as a hash:
|
1076
|
-
#
|
1077
|
-
# {
|
1078
|
-
# application_id: "Id", # required
|
1079
|
-
# configuration_profile_id: "Id", # required
|
1080
|
-
# }
|
1081
|
-
#
|
1082
1501
|
# @!attribute [rw] application_id
|
1083
1502
|
# The ID of the application that includes the configuration profile
|
1084
1503
|
# you want to get.
|
@@ -1097,17 +1516,6 @@ module Aws::AppConfig
|
|
1097
1516
|
include Aws::Structure
|
1098
1517
|
end
|
1099
1518
|
|
1100
|
-
# @note When making an API call, you may pass GetConfigurationRequest
|
1101
|
-
# data as a hash:
|
1102
|
-
#
|
1103
|
-
# {
|
1104
|
-
# application: "StringWithLengthBetween1And64", # required
|
1105
|
-
# environment: "StringWithLengthBetween1And64", # required
|
1106
|
-
# configuration: "StringWithLengthBetween1And64", # required
|
1107
|
-
# client_id: "StringWithLengthBetween1And64", # required
|
1108
|
-
# client_configuration_version: "Version",
|
1109
|
-
# }
|
1110
|
-
#
|
1111
1519
|
# @!attribute [rw] application
|
1112
1520
|
# The application to get. Specify either the application name or the
|
1113
1521
|
# application ID.
|
@@ -1140,18 +1548,25 @@ module Aws::AppConfig
|
|
1140
1548
|
# `GetConfiguration`, your clients receive the current configuration.
|
1141
1549
|
# You are charged each time your clients receive a configuration.
|
1142
1550
|
#
|
1143
|
-
# To avoid excess charges, we recommend
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
# the `ClientConfigurationVersion`
|
1551
|
+
# To avoid excess charges, we recommend you use the
|
1552
|
+
# [StartConfigurationSession][1] and [GetLatestConfiguration][2] APIs,
|
1553
|
+
# which track the client configuration version on your behalf. If you
|
1554
|
+
# choose to continue using `GetConfiguration`, we recommend that you
|
1555
|
+
# include the `ClientConfigurationVersion` value with every call to
|
1556
|
+
# `GetConfiguration`. The value to use for
|
1557
|
+
# `ClientConfigurationVersion` comes from the `ConfigurationVersion`
|
1558
|
+
# attribute returned by `GetConfiguration` when there is new or
|
1559
|
+
# updated data, and should be saved for subsequent calls to
|
1560
|
+
# `GetConfiguration`.
|
1148
1561
|
#
|
1149
1562
|
# For more information about working with configurations, see
|
1150
|
-
# [Retrieving the Configuration][
|
1563
|
+
# [Retrieving the Configuration][3] in the *AppConfig User Guide*.
|
1151
1564
|
#
|
1152
1565
|
#
|
1153
1566
|
#
|
1154
|
-
# [1]:
|
1567
|
+
# [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html
|
1568
|
+
# [2]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html
|
1569
|
+
# [3]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html
|
1155
1570
|
# @return [String]
|
1156
1571
|
#
|
1157
1572
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfigurationRequest AWS API Documentation
|
@@ -1166,15 +1581,6 @@ module Aws::AppConfig
|
|
1166
1581
|
include Aws::Structure
|
1167
1582
|
end
|
1168
1583
|
|
1169
|
-
# @note When making an API call, you may pass GetDeploymentRequest
|
1170
|
-
# data as a hash:
|
1171
|
-
#
|
1172
|
-
# {
|
1173
|
-
# application_id: "Id", # required
|
1174
|
-
# environment_id: "Id", # required
|
1175
|
-
# deployment_number: 1, # required
|
1176
|
-
# }
|
1177
|
-
#
|
1178
1584
|
# @!attribute [rw] application_id
|
1179
1585
|
# The ID of the application that includes the deployment you want to
|
1180
1586
|
# get.
|
@@ -1199,13 +1605,6 @@ module Aws::AppConfig
|
|
1199
1605
|
include Aws::Structure
|
1200
1606
|
end
|
1201
1607
|
|
1202
|
-
# @note When making an API call, you may pass GetDeploymentStrategyRequest
|
1203
|
-
# data as a hash:
|
1204
|
-
#
|
1205
|
-
# {
|
1206
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
1207
|
-
# }
|
1208
|
-
#
|
1209
1608
|
# @!attribute [rw] deployment_strategy_id
|
1210
1609
|
# The ID of the deployment strategy to get.
|
1211
1610
|
# @return [String]
|
@@ -1218,14 +1617,6 @@ module Aws::AppConfig
|
|
1218
1617
|
include Aws::Structure
|
1219
1618
|
end
|
1220
1619
|
|
1221
|
-
# @note When making an API call, you may pass GetEnvironmentRequest
|
1222
|
-
# data as a hash:
|
1223
|
-
#
|
1224
|
-
# {
|
1225
|
-
# application_id: "Id", # required
|
1226
|
-
# environment_id: "Id", # required
|
1227
|
-
# }
|
1228
|
-
#
|
1229
1620
|
# @!attribute [rw] application_id
|
1230
1621
|
# The ID of the application that includes the environment you want to
|
1231
1622
|
# get.
|
@@ -1244,15 +1635,37 @@ module Aws::AppConfig
|
|
1244
1635
|
include Aws::Structure
|
1245
1636
|
end
|
1246
1637
|
|
1247
|
-
#
|
1248
|
-
#
|
1638
|
+
# @!attribute [rw] extension_association_id
|
1639
|
+
# The extension association ID to get.
|
1640
|
+
# @return [String]
|
1249
1641
|
#
|
1250
|
-
#
|
1251
|
-
#
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetExtensionAssociationRequest AWS API Documentation
|
1643
|
+
#
|
1644
|
+
class GetExtensionAssociationRequest < Struct.new(
|
1645
|
+
:extension_association_id)
|
1646
|
+
SENSITIVE = []
|
1647
|
+
include Aws::Structure
|
1648
|
+
end
|
1649
|
+
|
1650
|
+
# @!attribute [rw] extension_identifier
|
1651
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
1652
|
+
# extension.
|
1653
|
+
# @return [String]
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] version_number
|
1656
|
+
# The extension version number. If no version number was defined,
|
1657
|
+
# AppConfig uses the highest version.
|
1658
|
+
# @return [Integer]
|
1255
1659
|
#
|
1660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetExtensionRequest AWS API Documentation
|
1661
|
+
#
|
1662
|
+
class GetExtensionRequest < Struct.new(
|
1663
|
+
:extension_identifier,
|
1664
|
+
:version_number)
|
1665
|
+
SENSITIVE = []
|
1666
|
+
include Aws::Structure
|
1667
|
+
end
|
1668
|
+
|
1256
1669
|
# @!attribute [rw] application_id
|
1257
1670
|
# The application ID.
|
1258
1671
|
# @return [String]
|
@@ -1304,6 +1717,16 @@ module Aws::AppConfig
|
|
1304
1717
|
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
1305
1718
|
# @return [String]
|
1306
1719
|
#
|
1720
|
+
# @!attribute [rw] version_label
|
1721
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1722
|
+
# @return [String]
|
1723
|
+
#
|
1724
|
+
# @!attribute [rw] kms_key_arn
|
1725
|
+
# The Amazon Resource Name of the Key Management Service key that was
|
1726
|
+
# used to encrypt this specific version of the configuration data in
|
1727
|
+
# the AppConfig hosted configuration store.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1307
1730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/HostedConfigurationVersion AWS API Documentation
|
1308
1731
|
#
|
1309
1732
|
class HostedConfigurationVersion < Struct.new(
|
@@ -1312,7 +1735,9 @@ module Aws::AppConfig
|
|
1312
1735
|
:version_number,
|
1313
1736
|
:description,
|
1314
1737
|
:content,
|
1315
|
-
:content_type
|
1738
|
+
:content_type,
|
1739
|
+
:version_label,
|
1740
|
+
:kms_key_arn)
|
1316
1741
|
SENSITIVE = [:content]
|
1317
1742
|
include Aws::Structure
|
1318
1743
|
end
|
@@ -1344,6 +1769,16 @@ module Aws::AppConfig
|
|
1344
1769
|
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
1345
1770
|
# @return [String]
|
1346
1771
|
#
|
1772
|
+
# @!attribute [rw] version_label
|
1773
|
+
# A user-defined label for an AppConfig hosted configuration version.
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] kms_key_arn
|
1777
|
+
# The Amazon Resource Name of the Key Management Service key that was
|
1778
|
+
# used to encrypt this specific version of the configuration data in
|
1779
|
+
# the AppConfig hosted configuration store.
|
1780
|
+
# @return [String]
|
1781
|
+
#
|
1347
1782
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/HostedConfigurationVersionSummary AWS API Documentation
|
1348
1783
|
#
|
1349
1784
|
class HostedConfigurationVersionSummary < Struct.new(
|
@@ -1351,7 +1786,9 @@ module Aws::AppConfig
|
|
1351
1786
|
:configuration_profile_id,
|
1352
1787
|
:version_number,
|
1353
1788
|
:description,
|
1354
|
-
:content_type
|
1789
|
+
:content_type,
|
1790
|
+
:version_label,
|
1791
|
+
:kms_key_arn)
|
1355
1792
|
SENSITIVE = []
|
1356
1793
|
include Aws::Structure
|
1357
1794
|
end
|
@@ -1408,25 +1845,23 @@ module Aws::AppConfig
|
|
1408
1845
|
# The type of error for an invalid configuration.
|
1409
1846
|
# @return [String]
|
1410
1847
|
#
|
1848
|
+
# @!attribute [rw] value
|
1849
|
+
# Details about an error with Lambda when a synchronous extension
|
1850
|
+
# experiences an error during an invocation.
|
1851
|
+
# @return [String]
|
1852
|
+
#
|
1411
1853
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/InvalidConfigurationDetail AWS API Documentation
|
1412
1854
|
#
|
1413
1855
|
class InvalidConfigurationDetail < Struct.new(
|
1414
1856
|
:constraint,
|
1415
1857
|
:location,
|
1416
1858
|
:reason,
|
1417
|
-
:type
|
1859
|
+
:type,
|
1860
|
+
:value)
|
1418
1861
|
SENSITIVE = []
|
1419
1862
|
include Aws::Structure
|
1420
1863
|
end
|
1421
1864
|
|
1422
|
-
# @note When making an API call, you may pass ListApplicationsRequest
|
1423
|
-
# data as a hash:
|
1424
|
-
#
|
1425
|
-
# {
|
1426
|
-
# max_results: 1,
|
1427
|
-
# next_token: "NextToken",
|
1428
|
-
# }
|
1429
|
-
#
|
1430
1865
|
# @!attribute [rw] max_results
|
1431
1866
|
# The maximum number of items to return for this call. The call also
|
1432
1867
|
# returns a token that you can specify in a subsequent call to get the
|
@@ -1451,16 +1886,6 @@ module Aws::AppConfig
|
|
1451
1886
|
include Aws::Structure
|
1452
1887
|
end
|
1453
1888
|
|
1454
|
-
# @note When making an API call, you may pass ListConfigurationProfilesRequest
|
1455
|
-
# data as a hash:
|
1456
|
-
#
|
1457
|
-
# {
|
1458
|
-
# application_id: "Id", # required
|
1459
|
-
# max_results: 1,
|
1460
|
-
# next_token: "NextToken",
|
1461
|
-
# type: "ConfigurationProfileType",
|
1462
|
-
# }
|
1463
|
-
#
|
1464
1889
|
# @!attribute [rw] application_id
|
1465
1890
|
# The application ID.
|
1466
1891
|
# @return [String]
|
@@ -1479,7 +1904,7 @@ module Aws::AppConfig
|
|
1479
1904
|
# @!attribute [rw] type
|
1480
1905
|
# A filter based on the type of configurations that the configuration
|
1481
1906
|
# profile contains. A configuration can be a feature flag or a
|
1482
|
-
#
|
1907
|
+
# freeform configuration.
|
1483
1908
|
# @return [String]
|
1484
1909
|
#
|
1485
1910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListConfigurationProfilesRequest AWS API Documentation
|
@@ -1493,14 +1918,6 @@ module Aws::AppConfig
|
|
1493
1918
|
include Aws::Structure
|
1494
1919
|
end
|
1495
1920
|
|
1496
|
-
# @note When making an API call, you may pass ListDeploymentStrategiesRequest
|
1497
|
-
# data as a hash:
|
1498
|
-
#
|
1499
|
-
# {
|
1500
|
-
# max_results: 1,
|
1501
|
-
# next_token: "NextToken",
|
1502
|
-
# }
|
1503
|
-
#
|
1504
1921
|
# @!attribute [rw] max_results
|
1505
1922
|
# The maximum number of items to return for this call. The call also
|
1506
1923
|
# returns a token that you can specify in a subsequent call to get the
|
@@ -1521,16 +1938,6 @@ module Aws::AppConfig
|
|
1521
1938
|
include Aws::Structure
|
1522
1939
|
end
|
1523
1940
|
|
1524
|
-
# @note When making an API call, you may pass ListDeploymentsRequest
|
1525
|
-
# data as a hash:
|
1526
|
-
#
|
1527
|
-
# {
|
1528
|
-
# application_id: "Id", # required
|
1529
|
-
# environment_id: "Id", # required
|
1530
|
-
# max_results: 1,
|
1531
|
-
# next_token: "NextToken",
|
1532
|
-
# }
|
1533
|
-
#
|
1534
1941
|
# @!attribute [rw] application_id
|
1535
1942
|
# The application ID.
|
1536
1943
|
# @return [String]
|
@@ -1540,14 +1947,16 @@ module Aws::AppConfig
|
|
1540
1947
|
# @return [String]
|
1541
1948
|
#
|
1542
1949
|
# @!attribute [rw] max_results
|
1543
|
-
# The maximum number of items
|
1544
|
-
#
|
1545
|
-
#
|
1950
|
+
# The maximum number of items that may be returned for this call. If
|
1951
|
+
# there are items that have not yet been returned, the response will
|
1952
|
+
# include a non-null `NextToken` that you can provide in a subsequent
|
1953
|
+
# call to get the next set of results.
|
1546
1954
|
# @return [Integer]
|
1547
1955
|
#
|
1548
1956
|
# @!attribute [rw] next_token
|
1549
|
-
#
|
1550
|
-
# results.
|
1957
|
+
# The token returned by a prior call to this operation indicating the
|
1958
|
+
# next set of results to be returned. If not specified, the operation
|
1959
|
+
# will return the first set of results.
|
1551
1960
|
# @return [String]
|
1552
1961
|
#
|
1553
1962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeploymentsRequest AWS API Documentation
|
@@ -1561,15 +1970,6 @@ module Aws::AppConfig
|
|
1561
1970
|
include Aws::Structure
|
1562
1971
|
end
|
1563
1972
|
|
1564
|
-
# @note When making an API call, you may pass ListEnvironmentsRequest
|
1565
|
-
# data as a hash:
|
1566
|
-
#
|
1567
|
-
# {
|
1568
|
-
# application_id: "Id", # required
|
1569
|
-
# max_results: 1,
|
1570
|
-
# next_token: "NextToken",
|
1571
|
-
# }
|
1572
|
-
#
|
1573
1973
|
# @!attribute [rw] application_id
|
1574
1974
|
# The application ID.
|
1575
1975
|
# @return [String]
|
@@ -1595,16 +1995,67 @@ module Aws::AppConfig
|
|
1595
1995
|
include Aws::Structure
|
1596
1996
|
end
|
1597
1997
|
|
1598
|
-
#
|
1599
|
-
#
|
1998
|
+
# @!attribute [rw] resource_identifier
|
1999
|
+
# The ARN of an application, configuration profile, or environment.
|
2000
|
+
# @return [String]
|
1600
2001
|
#
|
1601
|
-
#
|
1602
|
-
#
|
1603
|
-
#
|
1604
|
-
#
|
1605
|
-
# next_token: "NextToken",
|
1606
|
-
# }
|
2002
|
+
# @!attribute [rw] extension_identifier
|
2003
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
2004
|
+
# extension.
|
2005
|
+
# @return [String]
|
1607
2006
|
#
|
2007
|
+
# @!attribute [rw] extension_version_number
|
2008
|
+
# The version number for the extension defined in the association.
|
2009
|
+
# @return [Integer]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] max_results
|
2012
|
+
# The maximum number of items to return for this call. The call also
|
2013
|
+
# returns a token that you can specify in a subsequent call to get the
|
2014
|
+
# next set of results.
|
2015
|
+
# @return [Integer]
|
2016
|
+
#
|
2017
|
+
# @!attribute [rw] next_token
|
2018
|
+
# A token to start the list. Use this token to get the next set of
|
2019
|
+
# results or pass null to get the first set of results.
|
2020
|
+
# @return [String]
|
2021
|
+
#
|
2022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListExtensionAssociationsRequest AWS API Documentation
|
2023
|
+
#
|
2024
|
+
class ListExtensionAssociationsRequest < Struct.new(
|
2025
|
+
:resource_identifier,
|
2026
|
+
:extension_identifier,
|
2027
|
+
:extension_version_number,
|
2028
|
+
:max_results,
|
2029
|
+
:next_token)
|
2030
|
+
SENSITIVE = []
|
2031
|
+
include Aws::Structure
|
2032
|
+
end
|
2033
|
+
|
2034
|
+
# @!attribute [rw] max_results
|
2035
|
+
# The maximum number of items to return for this call. The call also
|
2036
|
+
# returns a token that you can specify in a subsequent call to get the
|
2037
|
+
# next set of results.
|
2038
|
+
# @return [Integer]
|
2039
|
+
#
|
2040
|
+
# @!attribute [rw] next_token
|
2041
|
+
# A token to start the list. Use this token to get the next set of
|
2042
|
+
# results.
|
2043
|
+
# @return [String]
|
2044
|
+
#
|
2045
|
+
# @!attribute [rw] name
|
2046
|
+
# The extension name.
|
2047
|
+
# @return [String]
|
2048
|
+
#
|
2049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListExtensionsRequest AWS API Documentation
|
2050
|
+
#
|
2051
|
+
class ListExtensionsRequest < Struct.new(
|
2052
|
+
:max_results,
|
2053
|
+
:next_token,
|
2054
|
+
:name)
|
2055
|
+
SENSITIVE = []
|
2056
|
+
include Aws::Structure
|
2057
|
+
end
|
2058
|
+
|
1608
2059
|
# @!attribute [rw] application_id
|
1609
2060
|
# The application ID.
|
1610
2061
|
# @return [String]
|
@@ -1624,24 +2075,26 @@ module Aws::AppConfig
|
|
1624
2075
|
# results.
|
1625
2076
|
# @return [String]
|
1626
2077
|
#
|
2078
|
+
# @!attribute [rw] version_label
|
2079
|
+
# An optional filter that can be used to specify the version label of
|
2080
|
+
# an AppConfig hosted configuration version. This parameter supports
|
2081
|
+
# filtering by prefix using a wildcard, for example "v2*". If you
|
2082
|
+
# don't specify an asterisk at the end of the value, only an exact
|
2083
|
+
# match is returned.
|
2084
|
+
# @return [String]
|
2085
|
+
#
|
1627
2086
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListHostedConfigurationVersionsRequest AWS API Documentation
|
1628
2087
|
#
|
1629
2088
|
class ListHostedConfigurationVersionsRequest < Struct.new(
|
1630
2089
|
:application_id,
|
1631
2090
|
:configuration_profile_id,
|
1632
2091
|
:max_results,
|
1633
|
-
:next_token
|
2092
|
+
:next_token,
|
2093
|
+
:version_label)
|
1634
2094
|
SENSITIVE = []
|
1635
2095
|
include Aws::Structure
|
1636
2096
|
end
|
1637
2097
|
|
1638
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1639
|
-
# data as a hash:
|
1640
|
-
#
|
1641
|
-
# {
|
1642
|
-
# resource_arn: "Arn", # required
|
1643
|
-
# }
|
1644
|
-
#
|
1645
2098
|
# @!attribute [rw] resource_arn
|
1646
2099
|
# The resource ARN.
|
1647
2100
|
# @return [String]
|
@@ -1656,14 +2109,6 @@ module Aws::AppConfig
|
|
1656
2109
|
|
1657
2110
|
# Amazon CloudWatch alarms to monitor during the deployment process.
|
1658
2111
|
#
|
1659
|
-
# @note When making an API call, you may pass Monitor
|
1660
|
-
# data as a hash:
|
1661
|
-
#
|
1662
|
-
# {
|
1663
|
-
# alarm_arn: "StringWithLengthBetween1And2048", # required
|
1664
|
-
# alarm_role_arn: "RoleArn",
|
1665
|
-
# }
|
1666
|
-
#
|
1667
2112
|
# @!attribute [rw] alarm_arn
|
1668
2113
|
# Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
|
1669
2114
|
# @return [String]
|
@@ -1682,6 +2127,33 @@ module Aws::AppConfig
|
|
1682
2127
|
include Aws::Structure
|
1683
2128
|
end
|
1684
2129
|
|
2130
|
+
# A value such as an Amazon Resource Name (ARN) or an Amazon Simple
|
2131
|
+
# Notification Service topic entered in an extension when invoked.
|
2132
|
+
# Parameter values are specified in an extension association. For more
|
2133
|
+
# information about extensions, see [Working with AppConfig
|
2134
|
+
# extensions][1] in the *AppConfig User Guide*.
|
2135
|
+
#
|
2136
|
+
#
|
2137
|
+
#
|
2138
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] description
|
2141
|
+
# Information about the parameter.
|
2142
|
+
# @return [String]
|
2143
|
+
#
|
2144
|
+
# @!attribute [rw] required
|
2145
|
+
# A parameter value must be specified in the extension association.
|
2146
|
+
# @return [Boolean]
|
2147
|
+
#
|
2148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Parameter AWS API Documentation
|
2149
|
+
#
|
2150
|
+
class Parameter < Struct.new(
|
2151
|
+
:description,
|
2152
|
+
:required)
|
2153
|
+
SENSITIVE = []
|
2154
|
+
include Aws::Structure
|
2155
|
+
end
|
2156
|
+
|
1685
2157
|
# The configuration size is too large.
|
1686
2158
|
#
|
1687
2159
|
# @!attribute [rw] message
|
@@ -1738,9 +2210,26 @@ module Aws::AppConfig
|
|
1738
2210
|
include Aws::Structure
|
1739
2211
|
end
|
1740
2212
|
|
1741
|
-
# The number of
|
1742
|
-
#
|
1743
|
-
#
|
2213
|
+
# The number of one more AppConfig resources exceeds the maximum
|
2214
|
+
# allowed. Verify that your environment doesn't exceed the following
|
2215
|
+
# service quotas:
|
2216
|
+
#
|
2217
|
+
# Applications: 100 max
|
2218
|
+
#
|
2219
|
+
# Deployment strategies: 20 max
|
2220
|
+
#
|
2221
|
+
# Configuration profiles: 100 max per application
|
2222
|
+
#
|
2223
|
+
# Environments: 20 max per application
|
2224
|
+
#
|
2225
|
+
# To resolve this issue, you can delete one or more resources and try
|
2226
|
+
# again. Or, you can request a quota increase. For more information
|
2227
|
+
# about quotas and to request an increase, see [Service quotas for
|
2228
|
+
# AppConfig][1] in the Amazon Web Services General Reference.
|
2229
|
+
#
|
2230
|
+
#
|
2231
|
+
#
|
2232
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig
|
1744
2233
|
#
|
1745
2234
|
# @!attribute [rw] message
|
1746
2235
|
# @return [String]
|
@@ -1753,21 +2242,6 @@ module Aws::AppConfig
|
|
1753
2242
|
include Aws::Structure
|
1754
2243
|
end
|
1755
2244
|
|
1756
|
-
# @note When making an API call, you may pass StartDeploymentRequest
|
1757
|
-
# data as a hash:
|
1758
|
-
#
|
1759
|
-
# {
|
1760
|
-
# application_id: "Id", # required
|
1761
|
-
# environment_id: "Id", # required
|
1762
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
1763
|
-
# configuration_profile_id: "Id", # required
|
1764
|
-
# configuration_version: "Version", # required
|
1765
|
-
# description: "Description",
|
1766
|
-
# tags: {
|
1767
|
-
# "TagKey" => "TagValue",
|
1768
|
-
# },
|
1769
|
-
# }
|
1770
|
-
#
|
1771
2245
|
# @!attribute [rw] application_id
|
1772
2246
|
# The application ID.
|
1773
2247
|
# @return [String]
|
@@ -1785,7 +2259,10 @@ module Aws::AppConfig
|
|
1785
2259
|
# @return [String]
|
1786
2260
|
#
|
1787
2261
|
# @!attribute [rw] configuration_version
|
1788
|
-
# The configuration version to deploy.
|
2262
|
+
# The configuration version to deploy. If deploying an AppConfig
|
2263
|
+
# hosted configuration version, you can specify either the version
|
2264
|
+
# number or version label. For all other configurations, you must
|
2265
|
+
# specify the version number.
|
1789
2266
|
# @return [String]
|
1790
2267
|
#
|
1791
2268
|
# @!attribute [rw] description
|
@@ -1798,6 +2275,12 @@ module Aws::AppConfig
|
|
1798
2275
|
# an optional value, both of which you define.
|
1799
2276
|
# @return [Hash<String,String>]
|
1800
2277
|
#
|
2278
|
+
# @!attribute [rw] kms_key_identifier
|
2279
|
+
# The KMS key identifier (key ID, key alias, or key ARN). AppConfig
|
2280
|
+
# uses this ID to encrypt the configuration data using a customer
|
2281
|
+
# managed key.
|
2282
|
+
# @return [String]
|
2283
|
+
#
|
1801
2284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/StartDeploymentRequest AWS API Documentation
|
1802
2285
|
#
|
1803
2286
|
class StartDeploymentRequest < Struct.new(
|
@@ -1807,20 +2290,12 @@ module Aws::AppConfig
|
|
1807
2290
|
:configuration_profile_id,
|
1808
2291
|
:configuration_version,
|
1809
2292
|
:description,
|
1810
|
-
:tags
|
2293
|
+
:tags,
|
2294
|
+
:kms_key_identifier)
|
1811
2295
|
SENSITIVE = []
|
1812
2296
|
include Aws::Structure
|
1813
2297
|
end
|
1814
2298
|
|
1815
|
-
# @note When making an API call, you may pass StopDeploymentRequest
|
1816
|
-
# data as a hash:
|
1817
|
-
#
|
1818
|
-
# {
|
1819
|
-
# application_id: "Id", # required
|
1820
|
-
# environment_id: "Id", # required
|
1821
|
-
# deployment_number: 1, # required
|
1822
|
-
# }
|
1823
|
-
#
|
1824
2299
|
# @!attribute [rw] application_id
|
1825
2300
|
# The application ID.
|
1826
2301
|
# @return [String]
|
@@ -1843,16 +2318,6 @@ module Aws::AppConfig
|
|
1843
2318
|
include Aws::Structure
|
1844
2319
|
end
|
1845
2320
|
|
1846
|
-
# @note When making an API call, you may pass TagResourceRequest
|
1847
|
-
# data as a hash:
|
1848
|
-
#
|
1849
|
-
# {
|
1850
|
-
# resource_arn: "Arn", # required
|
1851
|
-
# tags: { # required
|
1852
|
-
# "TagKey" => "TagValue",
|
1853
|
-
# },
|
1854
|
-
# }
|
1855
|
-
#
|
1856
2321
|
# @!attribute [rw] resource_arn
|
1857
2322
|
# The ARN of the resource for which to retrieve tags.
|
1858
2323
|
# @return [String]
|
@@ -1872,14 +2337,6 @@ module Aws::AppConfig
|
|
1872
2337
|
include Aws::Structure
|
1873
2338
|
end
|
1874
2339
|
|
1875
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
1876
|
-
# data as a hash:
|
1877
|
-
#
|
1878
|
-
# {
|
1879
|
-
# resource_arn: "Arn", # required
|
1880
|
-
# tag_keys: ["TagKey"], # required
|
1881
|
-
# }
|
1882
|
-
#
|
1883
2340
|
# @!attribute [rw] resource_arn
|
1884
2341
|
# The ARN of the resource for which to remove tags.
|
1885
2342
|
# @return [String]
|
@@ -1897,15 +2354,6 @@ module Aws::AppConfig
|
|
1897
2354
|
include Aws::Structure
|
1898
2355
|
end
|
1899
2356
|
|
1900
|
-
# @note When making an API call, you may pass UpdateApplicationRequest
|
1901
|
-
# data as a hash:
|
1902
|
-
#
|
1903
|
-
# {
|
1904
|
-
# application_id: "Id", # required
|
1905
|
-
# name: "Name",
|
1906
|
-
# description: "Description",
|
1907
|
-
# }
|
1908
|
-
#
|
1909
2357
|
# @!attribute [rw] application_id
|
1910
2358
|
# The application ID.
|
1911
2359
|
# @return [String]
|
@@ -1928,23 +2376,6 @@ module Aws::AppConfig
|
|
1928
2376
|
include Aws::Structure
|
1929
2377
|
end
|
1930
2378
|
|
1931
|
-
# @note When making an API call, you may pass UpdateConfigurationProfileRequest
|
1932
|
-
# data as a hash:
|
1933
|
-
#
|
1934
|
-
# {
|
1935
|
-
# application_id: "Id", # required
|
1936
|
-
# configuration_profile_id: "Id", # required
|
1937
|
-
# name: "Name",
|
1938
|
-
# description: "Description",
|
1939
|
-
# retrieval_role_arn: "RoleArn",
|
1940
|
-
# validators: [
|
1941
|
-
# {
|
1942
|
-
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
1943
|
-
# content: "StringWithLengthBetween0And32768", # required
|
1944
|
-
# },
|
1945
|
-
# ],
|
1946
|
-
# }
|
1947
|
-
#
|
1948
2379
|
# @!attribute [rw] application_id
|
1949
2380
|
# The application ID.
|
1950
2381
|
# @return [String]
|
@@ -1970,6 +2401,16 @@ module Aws::AppConfig
|
|
1970
2401
|
# A list of methods for validating the configuration.
|
1971
2402
|
# @return [Array<Types::Validator>]
|
1972
2403
|
#
|
2404
|
+
# @!attribute [rw] kms_key_identifier
|
2405
|
+
# The identifier for a Key Management Service key to encrypt new
|
2406
|
+
# configuration data versions in the AppConfig hosted configuration
|
2407
|
+
# store. This attribute is only used for `hosted` configuration types.
|
2408
|
+
# The identifier can be an KMS key ID, alias, or the Amazon Resource
|
2409
|
+
# Name (ARN) of the key ID or alias. To encrypt data managed in other
|
2410
|
+
# configuration stores, see the documentation for how to specify an
|
2411
|
+
# KMS key for that particular service.
|
2412
|
+
# @return [String]
|
2413
|
+
#
|
1973
2414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateConfigurationProfileRequest AWS API Documentation
|
1974
2415
|
#
|
1975
2416
|
class UpdateConfigurationProfileRequest < Struct.new(
|
@@ -1978,23 +2419,12 @@ module Aws::AppConfig
|
|
1978
2419
|
:name,
|
1979
2420
|
:description,
|
1980
2421
|
:retrieval_role_arn,
|
1981
|
-
:validators
|
2422
|
+
:validators,
|
2423
|
+
:kms_key_identifier)
|
1982
2424
|
SENSITIVE = []
|
1983
2425
|
include Aws::Structure
|
1984
2426
|
end
|
1985
2427
|
|
1986
|
-
# @note When making an API call, you may pass UpdateDeploymentStrategyRequest
|
1987
|
-
# data as a hash:
|
1988
|
-
#
|
1989
|
-
# {
|
1990
|
-
# deployment_strategy_id: "DeploymentStrategyId", # required
|
1991
|
-
# description: "Description",
|
1992
|
-
# deployment_duration_in_minutes: 1,
|
1993
|
-
# final_bake_time_in_minutes: 1,
|
1994
|
-
# growth_factor: 1.0,
|
1995
|
-
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
1996
|
-
# }
|
1997
|
-
#
|
1998
2428
|
# @!attribute [rw] deployment_strategy_id
|
1999
2429
|
# The deployment strategy ID.
|
2000
2430
|
# @return [String]
|
@@ -2022,7 +2452,7 @@ module Aws::AppConfig
|
|
2022
2452
|
# The algorithm used to define how percentage grows over time.
|
2023
2453
|
# AppConfig supports the following growth types:
|
2024
2454
|
#
|
2025
|
-
# **Linear
|
2455
|
+
# **Linear**: For this type, AppConfig processes the deployment by
|
2026
2456
|
# increments of the growth factor evenly distributed over the
|
2027
2457
|
# deployment time. For example, a linear deployment that uses a growth
|
2028
2458
|
# factor of 20 initially makes the configuration available to 20
|
@@ -2031,7 +2461,7 @@ module Aws::AppConfig
|
|
2031
2461
|
# continues until 100% of the targets are set to receive the deployed
|
2032
2462
|
# configuration.
|
2033
2463
|
#
|
2034
|
-
# **Exponential
|
2464
|
+
# **Exponential**: For this type, AppConfig processes the deployment
|
2035
2465
|
# exponentially using the following formula: `G*(2^N)`. In this
|
2036
2466
|
# formula, `G` is the growth factor specified by the user and `N` is
|
2037
2467
|
# the number of steps until the configuration is deployed to all
|
@@ -2062,22 +2492,6 @@ module Aws::AppConfig
|
|
2062
2492
|
include Aws::Structure
|
2063
2493
|
end
|
2064
2494
|
|
2065
|
-
# @note When making an API call, you may pass UpdateEnvironmentRequest
|
2066
|
-
# data as a hash:
|
2067
|
-
#
|
2068
|
-
# {
|
2069
|
-
# application_id: "Id", # required
|
2070
|
-
# environment_id: "Id", # required
|
2071
|
-
# name: "Name",
|
2072
|
-
# description: "Description",
|
2073
|
-
# monitors: [
|
2074
|
-
# {
|
2075
|
-
# alarm_arn: "StringWithLengthBetween1And2048", # required
|
2076
|
-
# alarm_role_arn: "RoleArn",
|
2077
|
-
# },
|
2078
|
-
# ],
|
2079
|
-
# }
|
2080
|
-
#
|
2081
2495
|
# @!attribute [rw] application_id
|
2082
2496
|
# The application ID.
|
2083
2497
|
# @return [String]
|
@@ -2110,15 +2524,56 @@ module Aws::AppConfig
|
|
2110
2524
|
include Aws::Structure
|
2111
2525
|
end
|
2112
2526
|
|
2113
|
-
#
|
2114
|
-
#
|
2527
|
+
# @!attribute [rw] extension_association_id
|
2528
|
+
# The system-generated ID for the association.
|
2529
|
+
# @return [String]
|
2530
|
+
#
|
2531
|
+
# @!attribute [rw] parameters
|
2532
|
+
# The parameter names and values defined in the extension.
|
2533
|
+
# @return [Hash<String,String>]
|
2534
|
+
#
|
2535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateExtensionAssociationRequest AWS API Documentation
|
2536
|
+
#
|
2537
|
+
class UpdateExtensionAssociationRequest < Struct.new(
|
2538
|
+
:extension_association_id,
|
2539
|
+
:parameters)
|
2540
|
+
SENSITIVE = []
|
2541
|
+
include Aws::Structure
|
2542
|
+
end
|
2543
|
+
|
2544
|
+
# @!attribute [rw] extension_identifier
|
2545
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
2546
|
+
# extension.
|
2547
|
+
# @return [String]
|
2548
|
+
#
|
2549
|
+
# @!attribute [rw] description
|
2550
|
+
# Information about the extension.
|
2551
|
+
# @return [String]
|
2552
|
+
#
|
2553
|
+
# @!attribute [rw] actions
|
2554
|
+
# The actions defined in the extension.
|
2555
|
+
# @return [Hash<String,Array<Types::Action>>]
|
2115
2556
|
#
|
2116
|
-
#
|
2117
|
-
#
|
2118
|
-
#
|
2119
|
-
# configuration_version: "Version", # required
|
2120
|
-
# }
|
2557
|
+
# @!attribute [rw] parameters
|
2558
|
+
# One or more parameters for the actions called by the extension.
|
2559
|
+
# @return [Hash<String,Types::Parameter>]
|
2121
2560
|
#
|
2561
|
+
# @!attribute [rw] version_number
|
2562
|
+
# The extension version number.
|
2563
|
+
# @return [Integer]
|
2564
|
+
#
|
2565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateExtensionRequest AWS API Documentation
|
2566
|
+
#
|
2567
|
+
class UpdateExtensionRequest < Struct.new(
|
2568
|
+
:extension_identifier,
|
2569
|
+
:description,
|
2570
|
+
:actions,
|
2571
|
+
:parameters,
|
2572
|
+
:version_number)
|
2573
|
+
SENSITIVE = []
|
2574
|
+
include Aws::Structure
|
2575
|
+
end
|
2576
|
+
|
2122
2577
|
# @!attribute [rw] application_id
|
2123
2578
|
# The application ID.
|
2124
2579
|
# @return [String]
|
@@ -2144,17 +2599,9 @@ module Aws::AppConfig
|
|
2144
2599
|
# A validator provides a syntactic or semantic check to ensure the
|
2145
2600
|
# configuration that you want to deploy functions as intended. To
|
2146
2601
|
# validate your application configuration data, you provide a schema or
|
2147
|
-
#
|
2148
|
-
# configuration deployment or update can only proceed
|
2149
|
-
# configuration data is valid.
|
2150
|
-
#
|
2151
|
-
# @note When making an API call, you may pass Validator
|
2152
|
-
# data as a hash:
|
2153
|
-
#
|
2154
|
-
# {
|
2155
|
-
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
2156
|
-
# content: "StringWithLengthBetween0And32768", # required
|
2157
|
-
# }
|
2602
|
+
# an Amazon Web Services Lambda function that runs against the
|
2603
|
+
# configuration. The configuration deployment or update can only proceed
|
2604
|
+
# when the configuration data is valid.
|
2158
2605
|
#
|
2159
2606
|
# @!attribute [rw] type
|
2160
2607
|
# AppConfig supports validators of type `JSON_SCHEMA` and `LAMBDA`
|