aws-sdk-cloudformation 1.52.0 → 1.53.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.
@@ -46,6 +46,7 @@ module Aws::CloudFormation
46
46
  # * {StackSetNotFoundException}
47
47
  # * {StaleRequestException}
48
48
  # * {TokenAlreadyExistsException}
49
+ # * {TypeConfigurationNotFoundException}
49
50
  # * {TypeNotFoundException}
50
51
  #
51
52
  # Additionally, error classes are dynamically generated for service errors based on the error code
@@ -249,6 +250,16 @@ module Aws::CloudFormation
249
250
  end
250
251
  end
251
252
 
253
+ class TypeConfigurationNotFoundException < ServiceError
254
+
255
+ # @param [Seahorse::Client::RequestContext] context
256
+ # @param [String] message
257
+ # @param [Aws::CloudFormation::Types::TypeConfigurationNotFoundException] data
258
+ def initialize(context, message, data = Aws::EmptyStructure.new)
259
+ super(context, message, data)
260
+ end
261
+ end
262
+
252
263
  class TypeNotFoundException < ServiceError
253
264
 
254
265
  # @param [Seahorse::Client::RequestContext] context
@@ -113,6 +113,133 @@ module Aws::CloudFormation
113
113
  include Aws::Structure
114
114
  end
115
115
 
116
+ # @note When making an API call, you may pass ActivateTypeInput
117
+ # data as a hash:
118
+ #
119
+ # {
120
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
121
+ # public_type_arn: "ThirdPartyTypeArn",
122
+ # publisher_id: "PublisherId",
123
+ # type_name: "TypeName",
124
+ # type_name_alias: "TypeName",
125
+ # auto_update: false,
126
+ # logging_config: {
127
+ # log_role_arn: "RoleArn", # required
128
+ # log_group_name: "LogGroupName", # required
129
+ # },
130
+ # execution_role_arn: "RoleArn",
131
+ # version_bump: "MAJOR", # accepts MAJOR, MINOR
132
+ # major_version: 1,
133
+ # }
134
+ #
135
+ # @!attribute [rw] type
136
+ # The extension type.
137
+ #
138
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
139
+ # `Type`, and `PublisherId`.
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] public_type_arn
143
+ # The Amazon Resource Number (ARN) of the public extension.
144
+ #
145
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
146
+ # `Type`, and `PublisherId`.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] publisher_id
150
+ # The ID of the extension publisher.
151
+ #
152
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
153
+ # `Type`, and `PublisherId`.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] type_name
157
+ # The name of the extension.
158
+ #
159
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
160
+ # `Type`, and `PublisherId`.
161
+ # @return [String]
162
+ #
163
+ # @!attribute [rw] type_name_alias
164
+ # An alias to assign to the public extension, in this account and
165
+ # region. If you specify an alias for the extension, CloudFormation
166
+ # treats the alias as the extension type name within this account and
167
+ # region. You must use the alias to refer to the extension in your
168
+ # templates, API calls, and CloudFormation console.
169
+ #
170
+ # An extension alias must be unique within a given account and region.
171
+ # You can activate the same public resource multiple times in the same
172
+ # account and region, using different type name aliases.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] auto_update
176
+ # Whether to automatically update the extension in this account and
177
+ # region when a new *minor* version is published by the extension
178
+ # publisher. Major versions released by the publisher must be manually
179
+ # updated.
180
+ #
181
+ # The default is `true`.
182
+ # @return [Boolean]
183
+ #
184
+ # @!attribute [rw] logging_config
185
+ # Contains logging configuration information for an extension.
186
+ # @return [Types::LoggingConfig]
187
+ #
188
+ # @!attribute [rw] execution_role_arn
189
+ # The name of the IAM execution role to use to activate the extension.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] version_bump
193
+ # Manually updates a previously-activated type to a new major or minor
194
+ # version, if available. You can also use this parameter to update the
195
+ # value of `AutoUpdate`.
196
+ #
197
+ # * `MAJOR`\: CloudFormation updates the extension to the newest major
198
+ # version, if one is available.
199
+ #
200
+ # * `MINOR`\: CloudFormation updates the extension to the newest minor
201
+ # version, if one is available.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] major_version
205
+ # The major version of this extension you want to activate, if
206
+ # multiple major versions are available. The default is the latest
207
+ # major version. CloudFormation uses the latest available *minor*
208
+ # version of the major version selected.
209
+ #
210
+ # You can specify `MajorVersion` or `VersionBump`, but not both.
211
+ # @return [Integer]
212
+ #
213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeInput AWS API Documentation
214
+ #
215
+ class ActivateTypeInput < Struct.new(
216
+ :type,
217
+ :public_type_arn,
218
+ :publisher_id,
219
+ :type_name,
220
+ :type_name_alias,
221
+ :auto_update,
222
+ :logging_config,
223
+ :execution_role_arn,
224
+ :version_bump,
225
+ :major_version)
226
+ SENSITIVE = []
227
+ include Aws::Structure
228
+ end
229
+
230
+ # @!attribute [rw] arn
231
+ # The Amazon Resource Number (ARN) of the activated extension, in this
232
+ # account and region.
233
+ # @return [String]
234
+ #
235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeOutput AWS API Documentation
236
+ #
237
+ class ActivateTypeOutput < Struct.new(
238
+ :arn)
239
+ SENSITIVE = []
240
+ include Aws::Structure
241
+ end
242
+
116
243
  # The resource with the name requested already exists.
117
244
  #
118
245
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/AlreadyExistsException AWS API Documentation
@@ -154,6 +281,84 @@ module Aws::CloudFormation
154
281
  include Aws::Structure
155
282
  end
156
283
 
284
+ # Detailed information concerning an error generated during the setting
285
+ # of configuration data for a CloudFormation extension.
286
+ #
287
+ # @!attribute [rw] error_code
288
+ # The error code.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] error_message
292
+ # The error message.
293
+ # @return [String]
294
+ #
295
+ # @!attribute [rw] type_configuration_identifier
296
+ # Identifying information for the configuration of a CloudFormation
297
+ # extension.
298
+ # @return [Types::TypeConfigurationIdentifier]
299
+ #
300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsError AWS API Documentation
301
+ #
302
+ class BatchDescribeTypeConfigurationsError < Struct.new(
303
+ :error_code,
304
+ :error_message,
305
+ :type_configuration_identifier)
306
+ SENSITIVE = []
307
+ include Aws::Structure
308
+ end
309
+
310
+ # @note When making an API call, you may pass BatchDescribeTypeConfigurationsInput
311
+ # data as a hash:
312
+ #
313
+ # {
314
+ # type_configuration_identifiers: [ # required
315
+ # {
316
+ # type_arn: "TypeArn",
317
+ # type_configuration_alias: "TypeConfigurationAlias",
318
+ # type_configuration_arn: "TypeConfigurationArn",
319
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
320
+ # type_name: "TypeName",
321
+ # },
322
+ # ],
323
+ # }
324
+ #
325
+ # @!attribute [rw] type_configuration_identifiers
326
+ # The list of identifiers for the desired extension configurations.
327
+ # @return [Array<Types::TypeConfigurationIdentifier>]
328
+ #
329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsInput AWS API Documentation
330
+ #
331
+ class BatchDescribeTypeConfigurationsInput < Struct.new(
332
+ :type_configuration_identifiers)
333
+ SENSITIVE = []
334
+ include Aws::Structure
335
+ end
336
+
337
+ # @!attribute [rw] errors
338
+ # A list of information concerning any errors generated during the
339
+ # setting of the specified configurations.
340
+ # @return [Array<Types::BatchDescribeTypeConfigurationsError>]
341
+ #
342
+ # @!attribute [rw] unprocessed_type_configurations
343
+ # A list of any of the specified extension configurations that
344
+ # CloudFormation could not process for any reason.
345
+ # @return [Array<Types::TypeConfigurationIdentifier>]
346
+ #
347
+ # @!attribute [rw] type_configurations
348
+ # A list of any of the specified extension configurations from the
349
+ # CloudFormation registry.
350
+ # @return [Array<Types::TypeConfigurationDetails>]
351
+ #
352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsOutput AWS API Documentation
353
+ #
354
+ class BatchDescribeTypeConfigurationsOutput < Struct.new(
355
+ :errors,
356
+ :unprocessed_type_configurations,
357
+ :type_configurations)
358
+ SENSITIVE = []
359
+ include Aws::Structure
360
+ end
361
+
157
362
  # An error occurred during a CloudFormation registry operation.
158
363
  #
159
364
  # @!attribute [rw] message
@@ -1577,6 +1782,53 @@ module Aws::CloudFormation
1577
1782
  #
1578
1783
  class CreatedButModifiedException < Aws::EmptyStructure; end
1579
1784
 
1785
+ # @note When making an API call, you may pass DeactivateTypeInput
1786
+ # data as a hash:
1787
+ #
1788
+ # {
1789
+ # type_name: "TypeName",
1790
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
1791
+ # arn: "PrivateTypeArn",
1792
+ # }
1793
+ #
1794
+ # @!attribute [rw] type_name
1795
+ # The type name of the extension, in this account and region. If you
1796
+ # specified a type name alias when enabling the extension, use the
1797
+ # type name alias.
1798
+ #
1799
+ # Conditional: You must specify either `Arn`, or `TypeName` and
1800
+ # `Type`.
1801
+ # @return [String]
1802
+ #
1803
+ # @!attribute [rw] type
1804
+ # The extension type.
1805
+ #
1806
+ # Conditional: You must specify either `Arn`, or `TypeName` and
1807
+ # `Type`.
1808
+ # @return [String]
1809
+ #
1810
+ # @!attribute [rw] arn
1811
+ # The Amazon Resource Name (ARN) for the extension, in this account
1812
+ # and region.
1813
+ #
1814
+ # Conditional: You must specify either `Arn`, or `TypeName` and
1815
+ # `Type`.
1816
+ # @return [String]
1817
+ #
1818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateTypeInput AWS API Documentation
1819
+ #
1820
+ class DeactivateTypeInput < Struct.new(
1821
+ :type_name,
1822
+ :type,
1823
+ :arn)
1824
+ SENSITIVE = []
1825
+ include Aws::Structure
1826
+ end
1827
+
1828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateTypeOutput AWS API Documentation
1829
+ #
1830
+ class DeactivateTypeOutput < Aws::EmptyStructure; end
1831
+
1580
1832
  # The input for the DeleteChangeSet action.
1581
1833
  #
1582
1834
  # @note When making an API call, you may pass DeleteChangeSetInput
@@ -2168,6 +2420,58 @@ module Aws::CloudFormation
2168
2420
  include Aws::Structure
2169
2421
  end
2170
2422
 
2423
+ # @note When making an API call, you may pass DescribePublisherInput
2424
+ # data as a hash:
2425
+ #
2426
+ # {
2427
+ # publisher_id: "PublisherId",
2428
+ # }
2429
+ #
2430
+ # @!attribute [rw] publisher_id
2431
+ # The ID of the extension publisher.
2432
+ #
2433
+ # If you do not supply a `PublisherId`, and you have registered as an
2434
+ # extension publisher, `DescribePublisher` returns information about
2435
+ # your own publisher account.
2436
+ # @return [String]
2437
+ #
2438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisherInput AWS API Documentation
2439
+ #
2440
+ class DescribePublisherInput < Struct.new(
2441
+ :publisher_id)
2442
+ SENSITIVE = []
2443
+ include Aws::Structure
2444
+ end
2445
+
2446
+ # @!attribute [rw] publisher_id
2447
+ # The ID of the extension publisher.
2448
+ # @return [String]
2449
+ #
2450
+ # @!attribute [rw] publisher_status
2451
+ # Whether the publisher is verified. Currently, all registered
2452
+ # publishers are verified.
2453
+ # @return [String]
2454
+ #
2455
+ # @!attribute [rw] identity_provider
2456
+ # The type of account used as the identity provider when registering
2457
+ # this publisher with CloudFormation.
2458
+ # @return [String]
2459
+ #
2460
+ # @!attribute [rw] publisher_profile
2461
+ # The URL to the publisher's profile with the identity provider.
2462
+ # @return [String]
2463
+ #
2464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisherOutput AWS API Documentation
2465
+ #
2466
+ class DescribePublisherOutput < Struct.new(
2467
+ :publisher_id,
2468
+ :publisher_status,
2469
+ :identity_provider,
2470
+ :publisher_profile)
2471
+ SENSITIVE = []
2472
+ include Aws::Structure
2473
+ end
2474
+
2171
2475
  # @note When making an API call, you may pass DescribeStackDriftDetectionStatusInput
2172
2476
  # data as a hash:
2173
2477
  #
@@ -2797,6 +3101,8 @@ module Aws::CloudFormation
2797
3101
  # type_name: "TypeName",
2798
3102
  # arn: "TypeArn",
2799
3103
  # version_id: "TypeVersionId",
3104
+ # publisher_id: "PublisherId",
3105
+ # public_version_number: "PublicVersionNumber",
2800
3106
  # }
2801
3107
  #
2802
3108
  # @!attribute [rw] type
@@ -2830,13 +3136,25 @@ module Aws::CloudFormation
2830
3136
  # information about the default extension version.
2831
3137
  # @return [String]
2832
3138
  #
3139
+ # @!attribute [rw] publisher_id
3140
+ # The publisher ID of the extension publisher.
3141
+ #
3142
+ # Extensions provided by Amazon are not assigned a publisher ID.
3143
+ # @return [String]
3144
+ #
3145
+ # @!attribute [rw] public_version_number
3146
+ # The version number of a public third-party extension.
3147
+ # @return [String]
3148
+ #
2833
3149
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeInput AWS API Documentation
2834
3150
  #
2835
3151
  class DescribeTypeInput < Struct.new(
2836
3152
  :type,
2837
3153
  :type_name,
2838
3154
  :arn,
2839
- :version_id)
3155
+ :version_id,
3156
+ :publisher_id,
3157
+ :public_version_number)
2840
3158
  SENSITIVE = []
2841
3159
  include Aws::Structure
2842
3160
  end
@@ -2850,24 +3168,84 @@ module Aws::CloudFormation
2850
3168
  # @return [String]
2851
3169
  #
2852
3170
  # @!attribute [rw] type_name
2853
- # The name of the registered extension.
3171
+ # The name of the extension.
3172
+ #
3173
+ # If the extension is a public third-party type you have activated
3174
+ # with a type name alias, CloudFormation returns the type name alias.
3175
+ # For more information, see [ActivateType][1].
3176
+ #
3177
+ #
3178
+ #
3179
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
2854
3180
  # @return [String]
2855
3181
  #
2856
3182
  # @!attribute [rw] default_version_id
2857
3183
  # The ID of the default version of the extension. The default version
2858
3184
  # is used when the extension version is not specified.
2859
3185
  #
3186
+ # This applies only to private extensions you have registered in your
3187
+ # account. For public extensions, both those provided by Amazon and
3188
+ # published by third parties, CloudFormation returns `null`. For more
3189
+ # information, see [RegisterType][1].
3190
+ #
2860
3191
  # To set the default version of an extension, use `
2861
3192
  # SetTypeDefaultVersion `.
3193
+ #
3194
+ #
3195
+ #
3196
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
2862
3197
  # @return [String]
2863
3198
  #
2864
3199
  # @!attribute [rw] is_default_version
2865
3200
  # Whether the specified extension version is set as the default
2866
3201
  # version.
3202
+ #
3203
+ # This applies only to private extensions you have registered in your
3204
+ # account, and extensions published by Amazon. For public third-party
3205
+ # extensions, whether or not they are activated in your account,
3206
+ # CloudFormation returns `null`.
2867
3207
  # @return [Boolean]
2868
3208
  #
3209
+ # @!attribute [rw] type_tests_status
3210
+ # The contract test status of the registered extension version. To
3211
+ # return the extension test status of a specifc extension version, you
3212
+ # must specify `VersionId`.
3213
+ #
3214
+ # This applies only to registered private extension versions.
3215
+ # CloudFormation does not return this information for public
3216
+ # extensions, whether or not they are activated in your account.
3217
+ #
3218
+ # * `PASSED`\: The extension has passed all its contract tests.
3219
+ #
3220
+ # An extension must have a test status of `PASSED` before it can be
3221
+ # published. For more information, see [Publishing extensions to
3222
+ # make them available for public use][1] in the *CloudFormation
3223
+ # Command Line Interface User Guide*.
3224
+ #
3225
+ # * `FAILED`\: The extension has failed one or more contract tests.
3226
+ #
3227
+ # * `IN_PROGRESS`\: Contract tests are currently being performed on
3228
+ # the extension.
3229
+ #
3230
+ # * `NOT_TESTED`\: Contract tests have not been performed on the
3231
+ # extension.
3232
+ #
3233
+ #
3234
+ #
3235
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
3236
+ # @return [String]
3237
+ #
3238
+ # @!attribute [rw] type_tests_status_description
3239
+ # The description of the test status. To return the extension test
3240
+ # status of a specifc extension version, you must specify `VersionId`.
3241
+ #
3242
+ # This applies only to registered private extension versions.
3243
+ # CloudFormation does not return this information for public
3244
+ # extensions, whether or not they are activated in your account.
3245
+ # @return [String]
3246
+ #
2869
3247
  # @!attribute [rw] description
2870
- # The description of the registered extension.
3248
+ # The description of the extension.
2871
3249
  # @return [String]
2872
3250
  #
2873
3251
  # @!attribute [rw] schema
@@ -2882,21 +3260,23 @@ module Aws::CloudFormation
2882
3260
  # @return [String]
2883
3261
  #
2884
3262
  # @!attribute [rw] provisioning_type
2885
- # The provisioning behavior of the extension. AWS CloudFormation
2886
- # determines the provisioning type during registration, based on the
2887
- # types of handlers in the schema handler package submitted.
3263
+ # For resource type extensions, the provisioning behavior of the
3264
+ # resource type. AWS CloudFormation determines the provisioning type
3265
+ # during registration, based on the types of handlers in the schema
3266
+ # handler package submitted.
2888
3267
  #
2889
3268
  # Valid values include:
2890
3269
  #
2891
- # * `FULLY_MUTABLE`\: The extension includes an update handler to
2892
- # process updates to the extension during stack update operations.
3270
+ # * `FULLY_MUTABLE`\: The resource type includes an update handler to
3271
+ # process updates to the type during stack update operations.
2893
3272
  #
2894
- # * `IMMUTABLE`\: The extension does not include an update handler, so
2895
- # the extension cannot be updated and must instead be replaced
2896
- # during stack update operations.
3273
+ # * `IMMUTABLE`\: The resource type does not include an update
3274
+ # handler, so the type cannot be updated and must instead be
3275
+ # replaced during stack update operations.
2897
3276
  #
2898
- # * `NON_PROVISIONABLE`\: The extension does not include all of the
2899
- # following handlers, and therefore cannot actually be provisioned.
3277
+ # * `NON_PROVISIONABLE`\: The resource type does not include all of
3278
+ # the following handlers, and therefore cannot actually be
3279
+ # provisioned.
2900
3280
  #
2901
3281
  # * create
2902
3282
  #
@@ -2910,27 +3290,53 @@ module Aws::CloudFormation
2910
3290
  #
2911
3291
  # Valid values include:
2912
3292
  #
2913
- # * `LIVE`\: The extension is registered and can be used in
2914
- # CloudFormation operations, dependent on its provisioning behavior
2915
- # and visibility scope.
3293
+ # * `LIVE`\: The extension is activated or registered and can be used
3294
+ # in CloudFormation operations, dependent on its provisioning
3295
+ # behavior and visibility scope.
2916
3296
  #
2917
- # * `DEPRECATED`\: The extension has been deregistered and can no
2918
- # longer be used in CloudFormation operations.
3297
+ # * `DEPRECATED`\: The extension has been deactivated or deregistered
3298
+ # and can no longer be used in CloudFormation operations.
3299
+ #
3300
+ # For public third-party extensions, CloudFormation returns `null`.
2919
3301
  # @return [String]
2920
3302
  #
2921
3303
  # @!attribute [rw] logging_config
2922
- # Contains logging configuration information for an extension.
3304
+ # Contains logging configuration information for private extensions.
3305
+ # This applies only to private extensions you have registered in your
3306
+ # account. For public extensions, both those provided by Amazon and
3307
+ # published by third parties, CloudFormation returns `null`. For more
3308
+ # information, see [RegisterType][1].
3309
+ #
3310
+ #
3311
+ #
3312
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
2923
3313
  # @return [Types::LoggingConfig]
2924
3314
  #
3315
+ # @!attribute [rw] required_activated_types
3316
+ # For extensions that are modules, the public third-party extensions
3317
+ # that must be activated in your account in order for the module
3318
+ # itself to be activated.
3319
+ # @return [Array<Types::RequiredActivatedType>]
3320
+ #
2925
3321
  # @!attribute [rw] execution_role_arn
2926
3322
  # The Amazon Resource Name (ARN) of the IAM execution role used to
2927
- # register the extension. If your resource type calls AWS APIs in any
2928
- # of its handlers, you must create an <i> <a
3323
+ # register the extension. This applies only to private extensions you
3324
+ # have registered in your account. For more information, see
3325
+ # [RegisterType][1].
3326
+ #
3327
+ #
3328
+ #
3329
+ # If the registered extension calls any AWS APIs, you must create an
3330
+ # <i> <a
2929
3331
  # href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
2930
3332
  # execution role</a> </i> that includes the necessary permissions to
2931
3333
  # call those AWS APIs, and provision that execution role in your
2932
3334
  # account. CloudFormation then assumes that execution role to provide
2933
3335
  # your extension with the appropriate credentials.
3336
+ #
3337
+ #
3338
+ #
3339
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
2934
3340
  # @return [String]
2935
3341
  #
2936
3342
  # @!attribute [rw] visibility
@@ -2940,8 +3346,8 @@ module Aws::CloudFormation
2940
3346
  # Valid values include:
2941
3347
  #
2942
3348
  # * `PRIVATE`\: The extension is only visible and usable within the
2943
- # account in which it is registered. Currently, AWS CloudFormation
2944
- # marks any types you register as `PRIVATE`.
3349
+ # account in which it is registered. AWS CloudFormation marks any
3350
+ # extensions you register as `PRIVATE`.
2945
3351
  #
2946
3352
  # * `PUBLIC`\: The extension is publically visible and usable within
2947
3353
  # any Amazon account.
@@ -2957,13 +3363,106 @@ module Aws::CloudFormation
2957
3363
  # @return [String]
2958
3364
  #
2959
3365
  # @!attribute [rw] last_updated
2960
- # When the specified extension version was registered.
3366
+ # When the specified extension version was registered. This applies
3367
+ # only to:
3368
+ #
3369
+ # * Private extensions you have registered in your account. For more
3370
+ # information, see [RegisterType][1].
3371
+ #
3372
+ # * Public extensions you have activated in your account with
3373
+ # auto-update specified. For more information, see
3374
+ # [ActivateType][2].
3375
+ #
3376
+ #
3377
+ #
3378
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
3379
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
2961
3380
  # @return [Time]
2962
3381
  #
2963
3382
  # @!attribute [rw] time_created
2964
- # When the specified extension version was registered.
3383
+ # When the specified private extension version was registered or
3384
+ # activated in your account.
2965
3385
  # @return [Time]
2966
3386
  #
3387
+ # @!attribute [rw] configuration_schema
3388
+ # A JSON string that represent the current configuration data for the
3389
+ # extension in this account and region.
3390
+ #
3391
+ # To set the configuration data for an extension, use
3392
+ # [SetTypeConfiguration][1]. For more information, see [Configuring
3393
+ # extensions at the account level][2] in the *CloudFormation User
3394
+ # Guide*.
3395
+ #
3396
+ #
3397
+ #
3398
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
3399
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
3400
+ # @return [String]
3401
+ #
3402
+ # @!attribute [rw] publisher_id
3403
+ # The publisher ID of the extension publisher.
3404
+ #
3405
+ # This applies only to public third-party extensions. For private
3406
+ # registered extensions, and extensions provided by Amazon,
3407
+ # CloudFormation returns `null`.
3408
+ # @return [String]
3409
+ #
3410
+ # @!attribute [rw] original_type_name
3411
+ # For public extensions that have been activated for this account and
3412
+ # region, the type name of the public extension.
3413
+ #
3414
+ # If you specified a `TypeNameAlias` when enabling the extension in
3415
+ # this account and region, CloudFormation treats that alias as the
3416
+ # extension's type name within the account and region, not the type
3417
+ # name of the public extension. For more information, see [Specifying
3418
+ # aliases to refer to extensions][1] in the *CloudFormation User
3419
+ # Guide*.
3420
+ #
3421
+ #
3422
+ #
3423
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
3424
+ # @return [String]
3425
+ #
3426
+ # @!attribute [rw] original_type_arn
3427
+ # For public extensions that have been activated for this account and
3428
+ # region, the Amazon Resource Name (ARN) of the public extension.
3429
+ # @return [String]
3430
+ #
3431
+ # @!attribute [rw] public_version_number
3432
+ # The version number of a public third-party extension.
3433
+ #
3434
+ # This applies only if you specify a public extension you have
3435
+ # activated in your account, or specify a public extension without
3436
+ # specifying a version. For all other extensions, CloudFormation
3437
+ # returns `null`.
3438
+ # @return [String]
3439
+ #
3440
+ # @!attribute [rw] latest_public_version
3441
+ # The latest version of a public extension *that is available* for
3442
+ # use.
3443
+ #
3444
+ # This only applies if you specify a public extension, and you do not
3445
+ # specify a version. For all other requests, CloudFormation returns
3446
+ # `null`.
3447
+ # @return [String]
3448
+ #
3449
+ # @!attribute [rw] is_activated
3450
+ # Whether or not the extension is activated in the account and region.
3451
+ #
3452
+ # This only applies to public third-party extensions. For all other
3453
+ # extensions, CloudFormation returns `null`.
3454
+ # @return [Boolean]
3455
+ #
3456
+ # @!attribute [rw] auto_update
3457
+ # Whether CloudFormation automatically updates the extension in this
3458
+ # account and region when a new *minor* version is published by the
3459
+ # extension publisher. Major versions released by the publisher must
3460
+ # be manually updated. For more information, see [Activating public
3461
+ # extensions for use in your
3462
+ # account](AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable)
3463
+ # in the *AWS CloudFormation User Guide*.
3464
+ # @return [Boolean]
3465
+ #
2967
3466
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation
2968
3467
  #
2969
3468
  class DescribeTypeOutput < Struct.new(
@@ -2972,17 +3471,28 @@ module Aws::CloudFormation
2972
3471
  :type_name,
2973
3472
  :default_version_id,
2974
3473
  :is_default_version,
3474
+ :type_tests_status,
3475
+ :type_tests_status_description,
2975
3476
  :description,
2976
3477
  :schema,
2977
3478
  :provisioning_type,
2978
3479
  :deprecated_status,
2979
3480
  :logging_config,
3481
+ :required_activated_types,
2980
3482
  :execution_role_arn,
2981
3483
  :visibility,
2982
3484
  :source_url,
2983
3485
  :documentation_url,
2984
3486
  :last_updated,
2985
- :time_created)
3487
+ :time_created,
3488
+ :configuration_schema,
3489
+ :publisher_id,
3490
+ :original_type_name,
3491
+ :original_type_arn,
3492
+ :public_version_number,
3493
+ :latest_public_version,
3494
+ :is_activated,
3495
+ :auto_update)
2986
3496
  SENSITIVE = []
2987
3497
  include Aws::Structure
2988
3498
  end
@@ -3444,7 +3954,7 @@ module Aws::CloudFormation
3444
3954
  #
3445
3955
  # If the template doesn't include transforms, `Original` and
3446
3956
  # `Processed` return the same template. By default, AWS CloudFormation
3447
- # specifies `Original`.
3957
+ # specifies `Processed`.
3448
3958
  # @return [String]
3449
3959
  #
3450
3960
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateInput AWS API Documentation
@@ -4430,10 +4940,11 @@ module Aws::CloudFormation
4430
4940
  # {
4431
4941
  # type: "RESOURCE", # accepts RESOURCE, MODULE
4432
4942
  # type_name: "TypeName",
4433
- # arn: "PrivateTypeArn",
4943
+ # arn: "TypeArn",
4434
4944
  # max_results: 1,
4435
4945
  # next_token: "NextToken",
4436
4946
  # deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
4947
+ # publisher_id: "PublisherId",
4437
4948
  # }
4438
4949
  #
4439
4950
  # @!attribute [rw] type
@@ -4491,6 +5002,12 @@ module Aws::CloudFormation
4491
5002
  # The default is `LIVE`.
4492
5003
  # @return [String]
4493
5004
  #
5005
+ # @!attribute [rw] publisher_id
5006
+ # The publisher ID of the extension publisher.
5007
+ #
5008
+ # Extensions published by Amazon are not assigned a publisher ID.
5009
+ # @return [String]
5010
+ #
4494
5011
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersionsInput AWS API Documentation
4495
5012
  #
4496
5013
  class ListTypeVersionsInput < Struct.new(
@@ -4499,7 +5016,8 @@ module Aws::CloudFormation
4499
5016
  :arn,
4500
5017
  :max_results,
4501
5018
  :next_token,
4502
- :deprecated_status)
5019
+ :deprecated_status,
5020
+ :publisher_id)
4503
5021
  SENSITIVE = []
4504
5022
  include Aws::Structure
4505
5023
  end
@@ -4534,42 +5052,57 @@ module Aws::CloudFormation
4534
5052
  # provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
4535
5053
  # deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
4536
5054
  # type: "RESOURCE", # accepts RESOURCE, MODULE
5055
+ # filters: {
5056
+ # category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
5057
+ # publisher_id: "PublisherId",
5058
+ # type_name_prefix: "TypeNamePrefix",
5059
+ # },
4537
5060
  # max_results: 1,
4538
5061
  # next_token: "NextToken",
4539
5062
  # }
4540
5063
  #
4541
5064
  # @!attribute [rw] visibility
4542
- # The scope at which the extension is visible and usable in
5065
+ # The scope at which the extensions are visible and usable in
4543
5066
  # CloudFormation operations.
4544
5067
  #
4545
5068
  # Valid values include:
4546
5069
  #
4547
- # * `PRIVATE`\: The extension is only visible and usable within the
4548
- # account in which it is registered. Currently, AWS CloudFormation
4549
- # marks any extension you create as `PRIVATE`.
5070
+ # * `PRIVATE`\: Extensions that are visible and usable within this
5071
+ # account and region. This includes:
4550
5072
  #
4551
- # * `PUBLIC`\: The extension is publically visible and usable within
4552
- # any Amazon account.
5073
+ # * Private extensions you have registered in this account and
5074
+ # region.
5075
+ #
5076
+ # * Public extensions that you have activated in this account and
5077
+ # region.
5078
+ #
5079
+ # * `PUBLIC`\: Extensions that are publicly visible and available to
5080
+ # be activated within any Amazon account. This includes extensions
5081
+ # from Amazon, as well as third-party publishers.
4553
5082
  #
4554
5083
  # The default is `PRIVATE`.
4555
5084
  # @return [String]
4556
5085
  #
4557
5086
  # @!attribute [rw] provisioning_type
4558
- # The provisioning behavior of the type. AWS CloudFormation determines
4559
- # the provisioning type during registration, based on the types of
4560
- # handlers in the schema handler package submitted.
5087
+ # For resource types, the provisioning behavior of the resource type.
5088
+ # AWS CloudFormation determines the provisioning type during
5089
+ # registration, based on the types of handlers in the schema handler
5090
+ # package submitted.
4561
5091
  #
4562
5092
  # Valid values include:
4563
5093
  #
4564
- # * `FULLY_MUTABLE`\: The extension includes an update handler to
4565
- # process updates to the extension during stack update operations.
5094
+ # * `FULLY_MUTABLE`\: The resource type includes an update handler to
5095
+ # process updates to the type during stack update operations.
4566
5096
  #
4567
- # * `IMMUTABLE`\: The extension does not include an update handler, so
4568
- # the extension cannot be updated and must instead be replaced
4569
- # during stack update operations.
5097
+ # * `IMMUTABLE`\: The resource type does not include an update
5098
+ # handler, so the type cannot be updated and must instead be
5099
+ # replaced during stack update operations.
4570
5100
  #
4571
- # * `NON_PROVISIONABLE`\: The extension does not include create, read,
4572
- # and delete handlers, and therefore cannot actually be provisioned.
5101
+ # * `NON_PROVISIONABLE`\: The resource type does not include create,
5102
+ # read, and delete handlers, and therefore cannot actually be
5103
+ # provisioned.
5104
+ #
5105
+ # The default is `FULLY_MUTABLE`.
4573
5106
  # @return [String]
4574
5107
  #
4575
5108
  # @!attribute [rw] deprecated_status
@@ -4589,6 +5122,13 @@ module Aws::CloudFormation
4589
5122
  # The type of extension.
4590
5123
  # @return [String]
4591
5124
  #
5125
+ # @!attribute [rw] filters
5126
+ # Filter criteria to use in determining which extensions to return.
5127
+ #
5128
+ # If you specify a filter, CloudFormation ignores any specified
5129
+ # `Visibility` value when returning the list of types.
5130
+ # @return [Types::TypeFilters]
5131
+ #
4592
5132
  # @!attribute [rw] max_results
4593
5133
  # The maximum number of results to be returned with a single call. If
4594
5134
  # the number of available results exceeds this maximum, the response
@@ -4612,6 +5152,7 @@ module Aws::CloudFormation
4612
5152
  :provisioning_type,
4613
5153
  :deprecated_status,
4614
5154
  :type,
5155
+ :filters,
4615
5156
  :max_results,
4616
5157
  :next_token)
4617
5158
  SENSITIVE = []
@@ -4640,7 +5181,7 @@ module Aws::CloudFormation
4640
5181
  include Aws::Structure
4641
5182
  end
4642
5183
 
4643
- # Contains logging configuration information for a type.
5184
+ # Contains logging configuration information for an extension.
4644
5185
  #
4645
5186
  # @note When making an API call, you may pass LoggingConfig
4646
5187
  # data as a hash:
@@ -4657,7 +5198,7 @@ module Aws::CloudFormation
4657
5198
  #
4658
5199
  # @!attribute [rw] log_group_name
4659
5200
  # The Amazon CloudWatch log group to which CloudFormation sends error
4660
- # logging information when invoking the type's handlers.
5201
+ # logging information when invoking the extension's handlers.
4661
5202
  # @return [String]
4662
5203
  #
4663
5204
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/LoggingConfig AWS API Documentation
@@ -4958,7 +5499,77 @@ module Aws::CloudFormation
4958
5499
  include Aws::Structure
4959
5500
  end
4960
5501
 
4961
- # @note When making an API call, you may pass RecordHandlerProgressInput
5502
+ # @note When making an API call, you may pass PublishTypeInput
5503
+ # data as a hash:
5504
+ #
5505
+ # {
5506
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
5507
+ # arn: "PrivateTypeArn",
5508
+ # type_name: "TypeName",
5509
+ # public_version_number: "PublicVersionNumber",
5510
+ # }
5511
+ #
5512
+ # @!attribute [rw] type
5513
+ # The type of the extension.
5514
+ #
5515
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
5516
+ # @return [String]
5517
+ #
5518
+ # @!attribute [rw] arn
5519
+ # The Amazon Resource Number (ARN) of the extension.
5520
+ #
5521
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
5522
+ # @return [String]
5523
+ #
5524
+ # @!attribute [rw] type_name
5525
+ # The name of the extension.
5526
+ #
5527
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
5528
+ # @return [String]
5529
+ #
5530
+ # @!attribute [rw] public_version_number
5531
+ # The version number to assign to this version of the extension.
5532
+ #
5533
+ # Use the following format, and adhere to semantic versioning when
5534
+ # assigning a version number to your extension:
5535
+ #
5536
+ # `MAJOR.MINOR.PATCH`
5537
+ #
5538
+ # For more information, see [Semantic Versioning 2.0.0][1].
5539
+ #
5540
+ # If you do not specify a version number, CloudFormation increments
5541
+ # the version number by one minor version release.
5542
+ #
5543
+ #
5544
+ #
5545
+ # [1]: https://semver.org/
5546
+ # @return [String]
5547
+ #
5548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishTypeInput AWS API Documentation
5549
+ #
5550
+ class PublishTypeInput < Struct.new(
5551
+ :type,
5552
+ :arn,
5553
+ :type_name,
5554
+ :public_version_number)
5555
+ SENSITIVE = []
5556
+ include Aws::Structure
5557
+ end
5558
+
5559
+ # @!attribute [rw] public_type_arn
5560
+ # The Amazon Resource Number (ARN) assigned to the public extension
5561
+ # upon publication.
5562
+ # @return [String]
5563
+ #
5564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishTypeOutput AWS API Documentation
5565
+ #
5566
+ class PublishTypeOutput < Struct.new(
5567
+ :public_type_arn)
5568
+ SENSITIVE = []
5569
+ include Aws::Structure
5570
+ end
5571
+
5572
+ # @note When making an API call, you may pass RecordHandlerProgressInput
4962
5573
  # data as a hash:
4963
5574
  #
4964
5575
  # {
@@ -4966,7 +5577,7 @@ module Aws::CloudFormation
4966
5577
  # operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
4967
5578
  # current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
4968
5579
  # status_message: "StatusMessage",
4969
- # error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
5580
+ # error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration
4970
5581
  # resource_model: "ResourceModel",
4971
5582
  # client_request_token: "ClientRequestToken",
4972
5583
  # }
@@ -5045,6 +5656,59 @@ module Aws::CloudFormation
5045
5656
  #
5046
5657
  class RecordHandlerProgressOutput < Aws::EmptyStructure; end
5047
5658
 
5659
+ # @note When making an API call, you may pass RegisterPublisherInput
5660
+ # data as a hash:
5661
+ #
5662
+ # {
5663
+ # accept_terms_and_conditions: false,
5664
+ # connection_arn: "ConnectionArn",
5665
+ # }
5666
+ #
5667
+ # @!attribute [rw] accept_terms_and_conditions
5668
+ # Whether you accept the terms and conditions for publishing
5669
+ # extensions in the CloudFormation registry. You must accept the terms
5670
+ # and conditions in order to register to publish public extensions to
5671
+ # the CloudFormation registry.
5672
+ #
5673
+ # The default is `false`.
5674
+ # @return [Boolean]
5675
+ #
5676
+ # @!attribute [rw] connection_arn
5677
+ # If you are using a Bitbucket or GitHub account for identity
5678
+ # verification, the Amazon Resource Name (ARN) for your connection to
5679
+ # that account.
5680
+ #
5681
+ # For more information, see [Registering your account to publish
5682
+ # CloudFormation extensions][1] in the *CloudFormation CLI User
5683
+ # Guide*.
5684
+ #
5685
+ #
5686
+ #
5687
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
5688
+ # @return [String]
5689
+ #
5690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisherInput AWS API Documentation
5691
+ #
5692
+ class RegisterPublisherInput < Struct.new(
5693
+ :accept_terms_and_conditions,
5694
+ :connection_arn)
5695
+ SENSITIVE = []
5696
+ include Aws::Structure
5697
+ end
5698
+
5699
+ # @!attribute [rw] publisher_id
5700
+ # The ID assigned this account by CloudFormation for publishing
5701
+ # extensions.
5702
+ # @return [String]
5703
+ #
5704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisherOutput AWS API Documentation
5705
+ #
5706
+ class RegisterPublisherOutput < Struct.new(
5707
+ :publisher_id)
5708
+ SENSITIVE = []
5709
+ include Aws::Structure
5710
+ end
5711
+
5048
5712
  # @note When making an API call, you may pass RegisterTypeInput
5049
5713
  # data as a hash:
5050
5714
  #
@@ -5067,8 +5731,13 @@ module Aws::CloudFormation
5067
5731
  # @!attribute [rw] type_name
5068
5732
  # The name of the extension being registered.
5069
5733
  #
5070
- # We recommend that extension names adhere to the following pattern:
5071
- # *company\_or\_organization*\::*service*\::*type*.
5734
+ # We recommend that extension names adhere to the following patterns:
5735
+ #
5736
+ # * For resource types,
5737
+ # *company\_or\_organization*\::*service*\::*type*.
5738
+ #
5739
+ # * For modules,
5740
+ # *company\_or\_organization*\::*service*\::*type*\::MODULE.
5072
5741
  #
5073
5742
  # <note markdown="1"> The following organization namespaces are reserved and cannot be
5074
5743
  # used in your extension names:
@@ -5118,15 +5787,26 @@ module Aws::CloudFormation
5118
5787
  #
5119
5788
  # @!attribute [rw] execution_role_arn
5120
5789
  # The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
5121
- # assume when invoking the extension. If your extension calls AWS APIs
5122
- # in any of its handlers, you must create an <i> <a
5790
+ # assume when invoking the extension.
5791
+ #
5792
+ # For CloudFormation to assume the specified execution role, the role
5793
+ # must contain a trust relationship with the CloudFormation service
5794
+ # principle (`resources.cloudformation.amazonaws.com`). For more
5795
+ # information on adding trust relationships, see [Modifying a role
5796
+ # trust
5797
+ # policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
5798
+ # in the *AWS Identity and Access Management User Guide*.
5799
+ #
5800
+ # If your extension calls AWS APIs in any of its handlers, you must
5801
+ # create an <i> <a
5123
5802
  # href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
5124
5803
  # execution role</a> </i> that includes the necessary permissions to
5125
5804
  # call those AWS APIs, and provision that execution role in your
5126
- # account. When CloudFormation needs to invoke the extension handler,
5127
- # CloudFormation assumes this execution role to create a temporary
5128
- # session token, which it then passes to the extension handler,
5129
- # thereby supplying your extension with the appropriate credentials.
5805
+ # account. When CloudFormation needs to invoke the resource type
5806
+ # handler, CloudFormation assumes this execution role to create a
5807
+ # temporary session token, which it then passes to the resource type
5808
+ # handler, thereby supplying your resource type with the appropriate
5809
+ # credentials.
5130
5810
  # @return [String]
5131
5811
  #
5132
5812
  # @!attribute [rw] client_request_token
@@ -5166,6 +5846,60 @@ module Aws::CloudFormation
5166
5846
  include Aws::Structure
5167
5847
  end
5168
5848
 
5849
+ # For extensions that are modules, a public third-party extension that
5850
+ # must be activated in your account in order for the module itself to be
5851
+ # activated.
5852
+ #
5853
+ # For more information, see [Activating public modules for use in your
5854
+ # account][1] in the *AWS CloudFormation User Guide*.
5855
+ #
5856
+ #
5857
+ #
5858
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling
5859
+ #
5860
+ # @!attribute [rw] type_name_alias
5861
+ # An alias assigned to the public extension, in this account and
5862
+ # region. If you specify an alias for the extension, CloudFormation
5863
+ # treats the alias as the extension type name within this account and
5864
+ # region. You must use the alias to refer to the extension in your
5865
+ # templates, API calls, and CloudFormation console.
5866
+ # @return [String]
5867
+ #
5868
+ # @!attribute [rw] original_type_name
5869
+ # The type name of the public extension.
5870
+ #
5871
+ # If you specified a `TypeNameAlias` when enabling the extension in
5872
+ # this account and region, CloudFormation treats that alias as the
5873
+ # extension's type name within the account and region, not the type
5874
+ # name of the public extension. For more information, see [Specifying
5875
+ # aliases to refer to extensions][1] in the *CloudFormation User
5876
+ # Guide*.
5877
+ #
5878
+ #
5879
+ #
5880
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
5881
+ # @return [String]
5882
+ #
5883
+ # @!attribute [rw] publisher_id
5884
+ # The publisher ID of the extension publisher.
5885
+ # @return [String]
5886
+ #
5887
+ # @!attribute [rw] supported_major_versions
5888
+ # A list of the major versions of the extension type that the macro
5889
+ # supports.
5890
+ # @return [Array<Integer>]
5891
+ #
5892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RequiredActivatedType AWS API Documentation
5893
+ #
5894
+ class RequiredActivatedType < Struct.new(
5895
+ :type_name_alias,
5896
+ :original_type_name,
5897
+ :publisher_id,
5898
+ :supported_major_versions)
5899
+ SENSITIVE = []
5900
+ include Aws::Structure
5901
+ end
5902
+
5169
5903
  # The `ResourceChange` structure describes the resource and the action
5170
5904
  # that AWS CloudFormation will perform on it if you execute this change
5171
5905
  # set.
@@ -5607,6 +6341,101 @@ module Aws::CloudFormation
5607
6341
  include Aws::Structure
5608
6342
  end
5609
6343
 
6344
+ # @note When making an API call, you may pass SetTypeConfigurationInput
6345
+ # data as a hash:
6346
+ #
6347
+ # {
6348
+ # type_arn: "TypeArn",
6349
+ # configuration: "TypeConfiguration", # required
6350
+ # configuration_alias: "TypeConfigurationAlias",
6351
+ # type_name: "TypeName",
6352
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
6353
+ # }
6354
+ #
6355
+ # @!attribute [rw] type_arn
6356
+ # The Amazon Resource Name (ARN) for the extension, in this account
6357
+ # and region.
6358
+ #
6359
+ # For public extensions, this will be the ARN assigned when you
6360
+ # [activate the type][1] in this account and region. For private
6361
+ # extensions, this will be the ARN assigned when you [register the
6362
+ # type][2] in this account and region.
6363
+ #
6364
+ # Do not include the extension versions suffix at the end of the ARN.
6365
+ # You can set the configuration for an extension, but not for a
6366
+ # specific extension version.
6367
+ #
6368
+ #
6369
+ #
6370
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
6371
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
6372
+ # @return [String]
6373
+ #
6374
+ # @!attribute [rw] configuration
6375
+ # The configuration data for the extension, in this account and
6376
+ # region.
6377
+ #
6378
+ # The configuration data must be formatted as JSON, and validate
6379
+ # against the schema returned in the `ConfigurationSchema` response
6380
+ # element of
6381
+ # [API\_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
6382
+ # For more information, see [Defining account-level configuration data
6383
+ # for an extension][1] in the *CloudFormation CLI User Guide*.
6384
+ #
6385
+ #
6386
+ #
6387
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
6388
+ # @return [String]
6389
+ #
6390
+ # @!attribute [rw] configuration_alias
6391
+ # An alias by which to refer to this extension configuration data.
6392
+ #
6393
+ # Conditional: Specifying a configuration alias is required when
6394
+ # setting a configuration for a resource type extension.
6395
+ # @return [String]
6396
+ #
6397
+ # @!attribute [rw] type_name
6398
+ # The name of the extension.
6399
+ #
6400
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
6401
+ # `TypeName`.
6402
+ # @return [String]
6403
+ #
6404
+ # @!attribute [rw] type
6405
+ # The type of extension.
6406
+ #
6407
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
6408
+ # `TypeName`.
6409
+ # @return [String]
6410
+ #
6411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfigurationInput AWS API Documentation
6412
+ #
6413
+ class SetTypeConfigurationInput < Struct.new(
6414
+ :type_arn,
6415
+ :configuration,
6416
+ :configuration_alias,
6417
+ :type_name,
6418
+ :type)
6419
+ SENSITIVE = []
6420
+ include Aws::Structure
6421
+ end
6422
+
6423
+ # @!attribute [rw] configuration_arn
6424
+ # The Amazon Resource Name (ARN) for the configuration data, in this
6425
+ # account and region.
6426
+ #
6427
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
6428
+ # `TypeName`.
6429
+ # @return [String]
6430
+ #
6431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfigurationOutput AWS API Documentation
6432
+ #
6433
+ class SetTypeConfigurationOutput < Struct.new(
6434
+ :configuration_arn)
6435
+ SENSITIVE = []
6436
+ include Aws::Structure
6437
+ end
6438
+
5610
6439
  # @note When making an API call, you may pass SetTypeDefaultVersionInput
5611
6440
  # data as a hash:
5612
6441
  #
@@ -7222,6 +8051,8 @@ module Aws::CloudFormation
7222
8051
  #
7223
8052
  # Conditional: You must specify either `FailureToleranceCount` or
7224
8053
  # `FailureTolerancePercentage` (but not both).
8054
+ #
8055
+ # By default, `0` is specified.
7225
8056
  # @return [Integer]
7226
8057
  #
7227
8058
  # @!attribute [rw] failure_tolerance_percentage
@@ -7237,6 +8068,8 @@ module Aws::CloudFormation
7237
8068
  #
7238
8069
  # Conditional: You must specify either `FailureToleranceCount` or
7239
8070
  # `FailureTolerancePercentage`, but not both.
8071
+ #
8072
+ # By default, `0` is specified.
7240
8073
  # @return [Integer]
7241
8074
  #
7242
8075
  # @!attribute [rw] max_concurrent_count
@@ -7252,6 +8085,8 @@ module Aws::CloudFormation
7252
8085
  #
7253
8086
  # Conditional: You must specify either `MaxConcurrentCount` or
7254
8087
  # `MaxConcurrentPercentage`, but not both.
8088
+ #
8089
+ # By default, `1` is specified.
7255
8090
  # @return [Integer]
7256
8091
  #
7257
8092
  # @!attribute [rw] max_concurrent_percentage
@@ -7270,6 +8105,8 @@ module Aws::CloudFormation
7270
8105
  #
7271
8106
  # Conditional: You must specify either `MaxConcurrentCount` or
7272
8107
  # `MaxConcurrentPercentage`, but not both.
8108
+ #
8109
+ # By default, `1` is specified.
7273
8110
  # @return [Integer]
7274
8111
  #
7275
8112
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationPreferences AWS API Documentation
@@ -7737,47 +8574,440 @@ module Aws::CloudFormation
7737
8574
  include Aws::Structure
7738
8575
  end
7739
8576
 
8577
+ # @note When making an API call, you may pass TestTypeInput
8578
+ # data as a hash:
8579
+ #
8580
+ # {
8581
+ # arn: "TypeArn",
8582
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
8583
+ # type_name: "TypeName",
8584
+ # version_id: "TypeVersionId",
8585
+ # log_delivery_bucket: "S3Bucket",
8586
+ # }
8587
+ #
8588
+ # @!attribute [rw] arn
8589
+ # The Amazon Resource Number (ARN) of the extension.
8590
+ #
8591
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
8592
+ # @return [String]
8593
+ #
8594
+ # @!attribute [rw] type
8595
+ # The type of the extension to test.
8596
+ #
8597
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
8598
+ # @return [String]
8599
+ #
8600
+ # @!attribute [rw] type_name
8601
+ # The name of the extension to test.
8602
+ #
8603
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
8604
+ # @return [String]
8605
+ #
8606
+ # @!attribute [rw] version_id
8607
+ # The version of the extension to test.
8608
+ #
8609
+ # You can specify the version id with either `Arn`, or with `TypeName`
8610
+ # and `Type`.
8611
+ #
8612
+ # If you do not specify a version, CloudFormation uses the default
8613
+ # version of the extension in this account and region for testing.
8614
+ # @return [String]
8615
+ #
8616
+ # @!attribute [rw] log_delivery_bucket
8617
+ # The S3 bucket to which CloudFormation delivers the contract test
8618
+ # execution logs.
8619
+ #
8620
+ # CloudFormation delivers the logs by the time contract testing has
8621
+ # completed and the extension has been assigned a test type status of
8622
+ # `PASSED` or `FAILED`.
8623
+ #
8624
+ # The user calling `TestType` must be able to access items in the
8625
+ # specified S3 bucket. Specifically, the user needs the following
8626
+ # permissions:
8627
+ #
8628
+ # * GetObject
8629
+ #
8630
+ # * PutObject
8631
+ #
8632
+ # For more information, see [Actions, Resources, and Condition Keys
8633
+ # for Amazon S3][1] in the *AWS Identity and Access Management User
8634
+ # Guide*.
8635
+ #
8636
+ #
8637
+ #
8638
+ # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html
8639
+ # @return [String]
8640
+ #
8641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestTypeInput AWS API Documentation
8642
+ #
8643
+ class TestTypeInput < Struct.new(
8644
+ :arn,
8645
+ :type,
8646
+ :type_name,
8647
+ :version_id,
8648
+ :log_delivery_bucket)
8649
+ SENSITIVE = []
8650
+ include Aws::Structure
8651
+ end
8652
+
8653
+ # @!attribute [rw] type_version_arn
8654
+ # The Amazon Resource Number (ARN) of the extension.
8655
+ # @return [String]
8656
+ #
8657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestTypeOutput AWS API Documentation
8658
+ #
8659
+ class TestTypeOutput < Struct.new(
8660
+ :type_version_arn)
8661
+ SENSITIVE = []
8662
+ include Aws::Structure
8663
+ end
8664
+
7740
8665
  # A client request token already exists.
7741
8666
  #
7742
8667
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TokenAlreadyExistsException AWS API Documentation
7743
8668
  #
7744
8669
  class TokenAlreadyExistsException < Aws::EmptyStructure; end
7745
8670
 
7746
- # The specified type does not exist in the CloudFormation registry.
8671
+ # Detailed information concerning the specification of a CloudFormation
8672
+ # extension in a given account and region.
8673
+ #
8674
+ # For more information, see [Configuring extensions at the account
8675
+ # level][1] in the *CloudFormation User Guide*.
8676
+ #
8677
+ #
8678
+ #
8679
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
8680
+ #
8681
+ # @!attribute [rw] arn
8682
+ # The Amazon Resource Name (ARN) for the configuration data, in this
8683
+ # account and region.
8684
+ # @return [String]
8685
+ #
8686
+ # @!attribute [rw] alias
8687
+ # The alias specified for this configuration, if one was specified
8688
+ # when the configuration was set.
8689
+ # @return [String]
8690
+ #
8691
+ # @!attribute [rw] configuration
8692
+ # A JSON string specifying the configuration data for the extension,
8693
+ # in this account and region.
8694
+ #
8695
+ # If a configuration has not been set for a specified extension,
8696
+ # CloudFormation returns `\{\}`.
8697
+ # @return [String]
8698
+ #
8699
+ # @!attribute [rw] last_updated
8700
+ # When the configuration data was last updated for this extension.
8701
+ #
8702
+ # If a configuration has not been set for a specified extension,
8703
+ # CloudFormation returns `null`.
8704
+ # @return [Time]
8705
+ #
8706
+ # @!attribute [rw] type_arn
8707
+ # The Amazon Resource Name (ARN) for the extension, in this account
8708
+ # and region.
8709
+ #
8710
+ # For public extensions, this will be the ARN assigned when you
8711
+ # [activate the type][1] in this account and region. For private
8712
+ # extensions, this will be the ARN assigned when you [register the
8713
+ # type][2] in this account and region.
8714
+ #
8715
+ #
8716
+ #
8717
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
8718
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
8719
+ # @return [String]
8720
+ #
8721
+ # @!attribute [rw] type_name
8722
+ # The name of the extension.
8723
+ # @return [String]
8724
+ #
8725
+ # @!attribute [rw] is_default_configuration
8726
+ # Whether or not this configuration data is the default configuration
8727
+ # for the extension.
8728
+ # @return [Boolean]
8729
+ #
8730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationDetails AWS API Documentation
8731
+ #
8732
+ class TypeConfigurationDetails < Struct.new(
8733
+ :arn,
8734
+ :alias,
8735
+ :configuration,
8736
+ :last_updated,
8737
+ :type_arn,
8738
+ :type_name,
8739
+ :is_default_configuration)
8740
+ SENSITIVE = []
8741
+ include Aws::Structure
8742
+ end
8743
+
8744
+ # Identifying information for the configuration of a CloudFormation
8745
+ # extension.
8746
+ #
8747
+ # @note When making an API call, you may pass TypeConfigurationIdentifier
8748
+ # data as a hash:
8749
+ #
8750
+ # {
8751
+ # type_arn: "TypeArn",
8752
+ # type_configuration_alias: "TypeConfigurationAlias",
8753
+ # type_configuration_arn: "TypeConfigurationArn",
8754
+ # type: "RESOURCE", # accepts RESOURCE, MODULE
8755
+ # type_name: "TypeName",
8756
+ # }
8757
+ #
8758
+ # @!attribute [rw] type_arn
8759
+ # The Amazon Resource Name (ARN) for the extension, in this account
8760
+ # and region.
8761
+ #
8762
+ # For public extensions, this will be the ARN assigned when you
8763
+ # [activate the type][1] in this account and region. For private
8764
+ # extensions, this will be the ARN assigned when you [register the
8765
+ # type][2] in this account and region.
8766
+ #
8767
+ #
8768
+ #
8769
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
8770
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
8771
+ # @return [String]
8772
+ #
8773
+ # @!attribute [rw] type_configuration_alias
8774
+ # The alias specified for this configuration, if one was specified
8775
+ # when the configuration was set.
8776
+ # @return [String]
8777
+ #
8778
+ # @!attribute [rw] type_configuration_arn
8779
+ # The Amazon Resource Name (ARN) for the configuration, in this
8780
+ # account and region.
8781
+ # @return [String]
8782
+ #
8783
+ # @!attribute [rw] type
8784
+ # The type of extension.
8785
+ # @return [String]
8786
+ #
8787
+ # @!attribute [rw] type_name
8788
+ # The name of the extension type to which this configuration applies.
8789
+ # @return [String]
8790
+ #
8791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationIdentifier AWS API Documentation
8792
+ #
8793
+ class TypeConfigurationIdentifier < Struct.new(
8794
+ :type_arn,
8795
+ :type_configuration_alias,
8796
+ :type_configuration_arn,
8797
+ :type,
8798
+ :type_name)
8799
+ SENSITIVE = []
8800
+ include Aws::Structure
8801
+ end
8802
+
8803
+ # The specified extension configuration cannot be found.
8804
+ #
8805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationNotFoundException AWS API Documentation
8806
+ #
8807
+ class TypeConfigurationNotFoundException < Aws::EmptyStructure; end
8808
+
8809
+ # Filter criteria to use in determining which extensions to return.
8810
+ #
8811
+ # @note When making an API call, you may pass TypeFilters
8812
+ # data as a hash:
8813
+ #
8814
+ # {
8815
+ # category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
8816
+ # publisher_id: "PublisherId",
8817
+ # type_name_prefix: "TypeNamePrefix",
8818
+ # }
8819
+ #
8820
+ # @!attribute [rw] category
8821
+ # The category of extensions to return.
8822
+ #
8823
+ # * `REGISTERED`\: Private extensions that have been registered for
8824
+ # this account and region.
8825
+ #
8826
+ # * `ACTIVATED`\: Public extensions that have been activated for this
8827
+ # account and region.
8828
+ #
8829
+ # * `THIRD-PARTY`\: Extensions available for use from publishers other
8830
+ # than Amazon. This includes:
8831
+ #
8832
+ # * Private extensions registered in the account.
8833
+ #
8834
+ # * Public extensions from publishers other than Amazon, whether
8835
+ # activated or not.
8836
+ #
8837
+ # * `AWS-TYPES`\: Extensions available for use from Amazon.
8838
+ # @return [String]
8839
+ #
8840
+ # @!attribute [rw] publisher_id
8841
+ # The id of the publisher of the extension.
8842
+ #
8843
+ # Extensions published by Amazon are not assigned a publisher ID. Use
8844
+ # the `AWS-TYPES` category to specify a list of types published by
8845
+ # Amazon.
8846
+ # @return [String]
8847
+ #
8848
+ # @!attribute [rw] type_name_prefix
8849
+ # A prefix to use as a filter for results.
8850
+ # @return [String]
8851
+ #
8852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeFilters AWS API Documentation
8853
+ #
8854
+ class TypeFilters < Struct.new(
8855
+ :category,
8856
+ :publisher_id,
8857
+ :type_name_prefix)
8858
+ SENSITIVE = []
8859
+ include Aws::Structure
8860
+ end
8861
+
8862
+ # The specified extension does not exist in the CloudFormation registry.
7747
8863
  #
7748
8864
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeNotFoundException AWS API Documentation
7749
8865
  #
7750
8866
  class TypeNotFoundException < Aws::EmptyStructure; end
7751
8867
 
7752
- # Contains summary information about the specified CloudFormation type.
8868
+ # Contains summary information about the specified CloudFormation
8869
+ # extension.
7753
8870
  #
7754
8871
  # @!attribute [rw] type
7755
- # The kind of type.
8872
+ # The kind of extension.
7756
8873
  # @return [String]
7757
8874
  #
7758
8875
  # @!attribute [rw] type_name
7759
- # The name of the type.
8876
+ # The name of the extension.
8877
+ #
8878
+ # If you specified a `TypeNameAlias` when you [activate this
8879
+ # extension][1] in your account and region, CloudFormation considers
8880
+ # that alias as the type name.
8881
+ #
8882
+ #
8883
+ #
8884
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
7760
8885
  # @return [String]
7761
8886
  #
7762
8887
  # @!attribute [rw] default_version_id
7763
- # The ID of the default version of the type. The default version is
7764
- # used when the type version is not specified.
8888
+ # The ID of the default version of the extension. The default version
8889
+ # is used when the extension version is not specified.
8890
+ #
8891
+ # This applies only to private extensions you have registered in your
8892
+ # account. For public extensions, both those provided by Amazon and
8893
+ # published by third parties, CloudFormation returns `null`. For more
8894
+ # information, see [RegisterType][1].
8895
+ #
8896
+ # To set the default version of an extension, use `
8897
+ # SetTypeDefaultVersion `.
7765
8898
  #
7766
- # To set the default version of a type, use ` SetTypeDefaultVersion `.
8899
+ #
8900
+ #
8901
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
7767
8902
  # @return [String]
7768
8903
  #
7769
8904
  # @!attribute [rw] type_arn
7770
- # The Amazon Resource Name (ARN) of the type.
8905
+ # The Amazon Resource Name (ARN) of the extension.
7771
8906
  # @return [String]
7772
8907
  #
7773
8908
  # @!attribute [rw] last_updated
7774
- # When the current default version of the type was registered.
8909
+ # When the specified extension version was registered. This applies
8910
+ # only to:
8911
+ #
8912
+ # * Private extensions you have registered in your account. For more
8913
+ # information, see [RegisterType][1].
8914
+ #
8915
+ # * Public extensions you have activated in your account with
8916
+ # auto-update specified. For more information, see
8917
+ # [ActivateType][2].
8918
+ #
8919
+ # For all other extension types, CloudFormation returns `null`.
8920
+ #
8921
+ #
8922
+ #
8923
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
8924
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
7775
8925
  # @return [Time]
7776
8926
  #
7777
8927
  # @!attribute [rw] description
7778
- # The description of the type.
8928
+ # The description of the extension.
8929
+ # @return [String]
8930
+ #
8931
+ # @!attribute [rw] publisher_id
8932
+ # The ID of the extension publisher, if the extension is published by
8933
+ # a third party. Extensions published by Amazon do not return a
8934
+ # publisher ID.
7779
8935
  # @return [String]
7780
8936
  #
8937
+ # @!attribute [rw] original_type_name
8938
+ # For public extensions that have been activated for this account and
8939
+ # region, the type name of the public extension.
8940
+ #
8941
+ # If you specified a `TypeNameAlias` when enabling the extension in
8942
+ # this account and region, CloudFormation treats that alias as the
8943
+ # extension's type name within the account and region, not the type
8944
+ # name of the public extension. For more information, see [Specifying
8945
+ # aliases to refer to extensions][1] in the *CloudFormation User
8946
+ # Guide*.
8947
+ #
8948
+ #
8949
+ #
8950
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
8951
+ # @return [String]
8952
+ #
8953
+ # @!attribute [rw] public_version_number
8954
+ # For public extensions that have been activated for this account and
8955
+ # region, the version of the public extension to be used for
8956
+ # CloudFormation operations in this account and region.
8957
+ #
8958
+ # How you specified `AutoUpdate` when enabling the extension affects
8959
+ # whether CloudFormation automatically updates the extention in this
8960
+ # account and region when a new version is released. For more
8961
+ # information, see [Setting CloudFormation to automatically use new
8962
+ # versions of extensions][1] in the *CloudFormation User Guide*.
8963
+ #
8964
+ #
8965
+ #
8966
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
8967
+ # @return [String]
8968
+ #
8969
+ # @!attribute [rw] latest_public_version
8970
+ # For public extensions that have been activated for this account and
8971
+ # region, the latest version of the public extension *that is
8972
+ # available*. For any extensions other than activated third-arty
8973
+ # extensions, CloudFormation returns `null`.
8974
+ #
8975
+ # How you specified `AutoUpdate` when enabling the extension affects
8976
+ # whether CloudFormation automatically updates the extention in this
8977
+ # account and region when a new version is released. For more
8978
+ # information, see [Setting CloudFormation to automatically use new
8979
+ # versions of extensions][1] in the *CloudFormation User Guide*.
8980
+ #
8981
+ #
8982
+ #
8983
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
8984
+ # @return [String]
8985
+ #
8986
+ # @!attribute [rw] publisher_identity
8987
+ # The service used to verify the publisher identity.
8988
+ #
8989
+ # For more information, see [Registering your account to publish
8990
+ # CloudFormation extensions][1] in the <i> CFN-CLI User Guide for
8991
+ # Extension Development</i>.
8992
+ #
8993
+ #
8994
+ #
8995
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
8996
+ # @return [String]
8997
+ #
8998
+ # @!attribute [rw] publisher_name
8999
+ # The publisher name, as defined in the public profile for that
9000
+ # publisher in the service used to verify the publisher identity.
9001
+ # @return [String]
9002
+ #
9003
+ # @!attribute [rw] is_activated
9004
+ # Whether or not the extension is activated for this account and
9005
+ # region.
9006
+ #
9007
+ # This applies only to third-party public extensions. Extensions
9008
+ # published by Amazon are activated by default.
9009
+ # @return [Boolean]
9010
+ #
7781
9011
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeSummary AWS API Documentation
7782
9012
  #
7783
9013
  class TypeSummary < Struct.new(
@@ -7786,34 +9016,47 @@ module Aws::CloudFormation
7786
9016
  :default_version_id,
7787
9017
  :type_arn,
7788
9018
  :last_updated,
7789
- :description)
9019
+ :description,
9020
+ :publisher_id,
9021
+ :original_type_name,
9022
+ :public_version_number,
9023
+ :latest_public_version,
9024
+ :publisher_identity,
9025
+ :publisher_name,
9026
+ :is_activated)
7790
9027
  SENSITIVE = []
7791
9028
  include Aws::Structure
7792
9029
  end
7793
9030
 
7794
9031
  # Contains summary information about a specific version of a
7795
- # CloudFormation type.
9032
+ # CloudFormation extension.
7796
9033
  #
7797
9034
  # @!attribute [rw] type
7798
- # The kind of type.
9035
+ # The kind of extension.
7799
9036
  # @return [String]
7800
9037
  #
7801
9038
  # @!attribute [rw] type_name
7802
- # The name of the type.
9039
+ # The name of the extension.
7803
9040
  # @return [String]
7804
9041
  #
7805
9042
  # @!attribute [rw] version_id
7806
- # The ID of a specific version of the type. The version ID is the
9043
+ # The ID of a specific version of the extension. The version ID is the
7807
9044
  # value at the end of the Amazon Resource Name (ARN) assigned to the
7808
- # type version when it is registered.
9045
+ # extension version when it is registered.
7809
9046
  # @return [String]
7810
9047
  #
7811
9048
  # @!attribute [rw] is_default_version
7812
- # Whether the specified type version is set as the default version.
9049
+ # Whether the specified extension version is set as the default
9050
+ # version.
9051
+ #
9052
+ # This applies only to private extensions you have registered in your
9053
+ # account, and extensions published by Amazon. For public third-party
9054
+ # extensions, whether or not they are activated in your account,
9055
+ # CloudFormation returns `null`.
7813
9056
  # @return [Boolean]
7814
9057
  #
7815
9058
  # @!attribute [rw] arn
7816
- # The Amazon Resource Name (ARN) of the type version.
9059
+ # The Amazon Resource Name (ARN) of the extension version.
7817
9060
  # @return [String]
7818
9061
  #
7819
9062
  # @!attribute [rw] time_created
@@ -7821,7 +9064,25 @@ module Aws::CloudFormation
7821
9064
  # @return [Time]
7822
9065
  #
7823
9066
  # @!attribute [rw] description
7824
- # The description of the type version.
9067
+ # The description of the extension version.
9068
+ # @return [String]
9069
+ #
9070
+ # @!attribute [rw] public_version_number
9071
+ # For public extensions that have been activated for this account and
9072
+ # region, the version of the public extension to be used for
9073
+ # CloudFormation operations in this account and region. For any
9074
+ # extensions other than activated third-arty extensions,
9075
+ # CloudFormation returns `null`.
9076
+ #
9077
+ # How you specified `AutoUpdate` when enabling the extension affects
9078
+ # whether CloudFormation automatically updates the extention in this
9079
+ # account and region when a new version is released. For more
9080
+ # information, see [Setting CloudFormation to automatically use new
9081
+ # versions of extensions][1] in the *CloudFormation User Guide*.
9082
+ #
9083
+ #
9084
+ #
9085
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
7825
9086
  # @return [String]
7826
9087
  #
7827
9088
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeVersionSummary AWS API Documentation
@@ -7833,7 +9094,8 @@ module Aws::CloudFormation
7833
9094
  :is_default_version,
7834
9095
  :arn,
7835
9096
  :time_created,
7836
- :description)
9097
+ :description,
9098
+ :public_version_number)
7837
9099
  SENSITIVE = []
7838
9100
  include Aws::Structure
7839
9101
  end