aws-sdk-cloudformation 1.27.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +669 -10
- data/lib/aws-sdk-cloudformation/client_api.rb +286 -0
- data/lib/aws-sdk-cloudformation/errors.rb +16 -0
- data/lib/aws-sdk-cloudformation/types.rb +936 -0
- data/lib/aws-sdk-cloudformation/waiters.rb +45 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c39da5ffd54a084841e6717105a27605fabad086
|
4
|
+
data.tar.gz: 96b615ed56e4cd111be23c1e2ebee2ce4648c16f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d5a3356e4569f93efe98e506fb66bedb824c205fad3f00fd3f4947922ed5ba89d2f85ac5acd21cc4de8851b9e10c949dd9fafc36bcedba7b623b8f0e0649a1e3
|
7
|
+
data.tar.gz: 0f43051817a10eacd017f6dfe318b6c06fd865683d9767df41176014a0e1c307ad1130012d28ada42a5b8e62558632070948bbe2b1698748de3816915dd5e4fa
|
@@ -1561,6 +1561,59 @@ module Aws::CloudFormation
|
|
1561
1561
|
req.send_request(options)
|
1562
1562
|
end
|
1563
1563
|
|
1564
|
+
# Removes a type or type version from active use in the CloudFormation
|
1565
|
+
# registry. If a type or type version is deregistered, it cannot be used
|
1566
|
+
# in CloudFormation operations.
|
1567
|
+
#
|
1568
|
+
# To deregister a type, you must individually deregister all registered
|
1569
|
+
# versions of that type. If a type has only a single registered version,
|
1570
|
+
# deregistering that version results in the type itself being
|
1571
|
+
# deregistered.
|
1572
|
+
#
|
1573
|
+
# You cannot deregister the default version of a type, unless it is the
|
1574
|
+
# only registered version of that type, in which case the type itself is
|
1575
|
+
# deregistered as well.
|
1576
|
+
#
|
1577
|
+
# @option params [String] :arn
|
1578
|
+
# The Amazon Resource Name (ARN) of the type.
|
1579
|
+
#
|
1580
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
1581
|
+
#
|
1582
|
+
# @option params [String] :type
|
1583
|
+
# The kind of type.
|
1584
|
+
#
|
1585
|
+
# Currently the only valid value is `RESOURCE`.
|
1586
|
+
#
|
1587
|
+
# @option params [String] :type_name
|
1588
|
+
# The name of the type.
|
1589
|
+
#
|
1590
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
1591
|
+
#
|
1592
|
+
# @option params [String] :version_id
|
1593
|
+
# The ID of a specific version of the type. The version ID is the value
|
1594
|
+
# at the end of the Amazon Resource Name (ARN) assigned to the type
|
1595
|
+
# version when it is registered.
|
1596
|
+
#
|
1597
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1598
|
+
#
|
1599
|
+
# @example Request syntax with placeholder values
|
1600
|
+
#
|
1601
|
+
# resp = client.deregister_type({
|
1602
|
+
# arn: "PrivateTypeArn",
|
1603
|
+
# type: "RESOURCE", # accepts RESOURCE
|
1604
|
+
# type_name: "TypeName",
|
1605
|
+
# version_id: "TypeVersionId",
|
1606
|
+
# })
|
1607
|
+
#
|
1608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeregisterType AWS API Documentation
|
1609
|
+
#
|
1610
|
+
# @overload deregister_type(params = {})
|
1611
|
+
# @param [Hash] params ({})
|
1612
|
+
def deregister_type(params = {}, options = {})
|
1613
|
+
req = build_request(:deregister_type, params)
|
1614
|
+
req.send_request(options)
|
1615
|
+
end
|
1616
|
+
|
1564
1617
|
# Retrieves your account's AWS CloudFormation limits, such as the
|
1565
1618
|
# maximum number of stacks that you can create in your account. For more
|
1566
1619
|
# information about account limits, see [AWS CloudFormation Limits][1]
|
@@ -2309,6 +2362,136 @@ module Aws::CloudFormation
|
|
2309
2362
|
req.send_request(options)
|
2310
2363
|
end
|
2311
2364
|
|
2365
|
+
# Returns detailed information about a type that has been registered.
|
2366
|
+
#
|
2367
|
+
# If you specify a `VersionId`, `DescribeType` returns information about
|
2368
|
+
# that specific type version. Otherwise, it returns information about
|
2369
|
+
# the default type version.
|
2370
|
+
#
|
2371
|
+
# @option params [String] :type
|
2372
|
+
# The kind of type.
|
2373
|
+
#
|
2374
|
+
# Currently the only valid value is `RESOURCE`.
|
2375
|
+
#
|
2376
|
+
# @option params [String] :type_name
|
2377
|
+
# The name of the type.
|
2378
|
+
#
|
2379
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
2380
|
+
#
|
2381
|
+
# @option params [String] :arn
|
2382
|
+
# The Amazon Resource Name (ARN) of the type.
|
2383
|
+
#
|
2384
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
2385
|
+
#
|
2386
|
+
# @option params [String] :version_id
|
2387
|
+
# The ID of a specific version of the type. The version ID is the value
|
2388
|
+
# at the end of the Amazon Resource Name (ARN) assigned to the type
|
2389
|
+
# version when it is registered.
|
2390
|
+
#
|
2391
|
+
# If you specify a `VersionId`, `DescribeType` returns information about
|
2392
|
+
# that specific type version. Otherwise, it returns information about
|
2393
|
+
# the default type version.
|
2394
|
+
#
|
2395
|
+
# @return [Types::DescribeTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2396
|
+
#
|
2397
|
+
# * {Types::DescribeTypeOutput#arn #arn} => String
|
2398
|
+
# * {Types::DescribeTypeOutput#type #type} => String
|
2399
|
+
# * {Types::DescribeTypeOutput#type_name #type_name} => String
|
2400
|
+
# * {Types::DescribeTypeOutput#default_version_id #default_version_id} => String
|
2401
|
+
# * {Types::DescribeTypeOutput#description #description} => String
|
2402
|
+
# * {Types::DescribeTypeOutput#schema #schema} => String
|
2403
|
+
# * {Types::DescribeTypeOutput#provisioning_type #provisioning_type} => String
|
2404
|
+
# * {Types::DescribeTypeOutput#deprecated_status #deprecated_status} => String
|
2405
|
+
# * {Types::DescribeTypeOutput#logging_config #logging_config} => Types::LoggingConfig
|
2406
|
+
# * {Types::DescribeTypeOutput#execution_role_arn #execution_role_arn} => String
|
2407
|
+
# * {Types::DescribeTypeOutput#visibility #visibility} => String
|
2408
|
+
# * {Types::DescribeTypeOutput#source_url #source_url} => String
|
2409
|
+
# * {Types::DescribeTypeOutput#documentation_url #documentation_url} => String
|
2410
|
+
# * {Types::DescribeTypeOutput#last_updated #last_updated} => Time
|
2411
|
+
# * {Types::DescribeTypeOutput#time_created #time_created} => Time
|
2412
|
+
#
|
2413
|
+
# @example Request syntax with placeholder values
|
2414
|
+
#
|
2415
|
+
# resp = client.describe_type({
|
2416
|
+
# type: "RESOURCE", # accepts RESOURCE
|
2417
|
+
# type_name: "TypeName",
|
2418
|
+
# arn: "TypeArn",
|
2419
|
+
# version_id: "TypeVersionId",
|
2420
|
+
# })
|
2421
|
+
#
|
2422
|
+
# @example Response structure
|
2423
|
+
#
|
2424
|
+
# resp.arn #=> String
|
2425
|
+
# resp.type #=> String, one of "RESOURCE"
|
2426
|
+
# resp.type_name #=> String
|
2427
|
+
# resp.default_version_id #=> String
|
2428
|
+
# resp.description #=> String
|
2429
|
+
# resp.schema #=> String
|
2430
|
+
# resp.provisioning_type #=> String, one of "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE"
|
2431
|
+
# resp.deprecated_status #=> String, one of "LIVE", "DEPRECATED"
|
2432
|
+
# resp.logging_config.log_role_arn #=> String
|
2433
|
+
# resp.logging_config.log_group_name #=> String
|
2434
|
+
# resp.execution_role_arn #=> String
|
2435
|
+
# resp.visibility #=> String, one of "PUBLIC", "PRIVATE"
|
2436
|
+
# resp.source_url #=> String
|
2437
|
+
# resp.documentation_url #=> String
|
2438
|
+
# resp.last_updated #=> Time
|
2439
|
+
# resp.time_created #=> Time
|
2440
|
+
#
|
2441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeType AWS API Documentation
|
2442
|
+
#
|
2443
|
+
# @overload describe_type(params = {})
|
2444
|
+
# @param [Hash] params ({})
|
2445
|
+
def describe_type(params = {}, options = {})
|
2446
|
+
req = build_request(:describe_type, params)
|
2447
|
+
req.send_request(options)
|
2448
|
+
end
|
2449
|
+
|
2450
|
+
# Returns information about a type's registration, including its
|
2451
|
+
# current status and type and version identifiers.
|
2452
|
+
#
|
2453
|
+
# When you initiate a registration request using ` RegisterType `, you
|
2454
|
+
# can then use ` DescribeTypeRegistration ` to monitor the progress of
|
2455
|
+
# that registration request.
|
2456
|
+
#
|
2457
|
+
# Once the registration request has completed, use ` DescribeType ` to
|
2458
|
+
# return detailed informaiton about a type.
|
2459
|
+
#
|
2460
|
+
# @option params [required, String] :registration_token
|
2461
|
+
# The identifier for this registration request.
|
2462
|
+
#
|
2463
|
+
# This registration token is generated by CloudFormation when you
|
2464
|
+
# initiate a registration request using ` RegisterType `.
|
2465
|
+
#
|
2466
|
+
# @return [Types::DescribeTypeRegistrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2467
|
+
#
|
2468
|
+
# * {Types::DescribeTypeRegistrationOutput#progress_status #progress_status} => String
|
2469
|
+
# * {Types::DescribeTypeRegistrationOutput#description #description} => String
|
2470
|
+
# * {Types::DescribeTypeRegistrationOutput#type_arn #type_arn} => String
|
2471
|
+
# * {Types::DescribeTypeRegistrationOutput#type_version_arn #type_version_arn} => String
|
2472
|
+
#
|
2473
|
+
# @example Request syntax with placeholder values
|
2474
|
+
#
|
2475
|
+
# resp = client.describe_type_registration({
|
2476
|
+
# registration_token: "RegistrationToken", # required
|
2477
|
+
# })
|
2478
|
+
#
|
2479
|
+
# @example Response structure
|
2480
|
+
#
|
2481
|
+
# resp.progress_status #=> String, one of "COMPLETE", "IN_PROGRESS", "FAILED"
|
2482
|
+
# resp.description #=> String
|
2483
|
+
# resp.type_arn #=> String
|
2484
|
+
# resp.type_version_arn #=> String
|
2485
|
+
#
|
2486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeRegistration AWS API Documentation
|
2487
|
+
#
|
2488
|
+
# @overload describe_type_registration(params = {})
|
2489
|
+
# @param [Hash] params ({})
|
2490
|
+
def describe_type_registration(params = {}, options = {})
|
2491
|
+
req = build_request(:describe_type_registration, params)
|
2492
|
+
req.send_request(options)
|
2493
|
+
end
|
2494
|
+
|
2312
2495
|
# Detects whether a stack's actual configuration differs, or has
|
2313
2496
|
# *drifted*, from it's expected configuration, as defined in the stack
|
2314
2497
|
# template and any values specified as template parameters. For each
|
@@ -3235,6 +3418,438 @@ module Aws::CloudFormation
|
|
3235
3418
|
req.send_request(options)
|
3236
3419
|
end
|
3237
3420
|
|
3421
|
+
# Returns a list of registration tokens for the specified type.
|
3422
|
+
#
|
3423
|
+
# @option params [String] :type
|
3424
|
+
# The kind of type.
|
3425
|
+
#
|
3426
|
+
# Currently the only valid value is `RESOURCE`.
|
3427
|
+
#
|
3428
|
+
# @option params [String] :type_name
|
3429
|
+
# The name of the type.
|
3430
|
+
#
|
3431
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
3432
|
+
#
|
3433
|
+
# @option params [String] :type_arn
|
3434
|
+
# The Amazon Resource Name (ARN) of the type.
|
3435
|
+
#
|
3436
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
3437
|
+
#
|
3438
|
+
# @option params [String] :registration_status_filter
|
3439
|
+
# The current status of the type registration request.
|
3440
|
+
#
|
3441
|
+
# @option params [Integer] :max_results
|
3442
|
+
# The maximum number of results to be returned with a single call. If
|
3443
|
+
# the number of available results exceeds this maximum, the response
|
3444
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
3445
|
+
# request parameter to get the next set of results.
|
3446
|
+
#
|
3447
|
+
# @option params [String] :next_token
|
3448
|
+
# If the previous paginated request didn't return all of the remaining
|
3449
|
+
# results, the response object's `NextToken` parameter value is set to
|
3450
|
+
# a token. To retrieve the next set of results, call this action again
|
3451
|
+
# and assign that token to the request object's `NextToken` parameter.
|
3452
|
+
# If there are no remaining results, the previous response object's
|
3453
|
+
# `NextToken` parameter is set to `null`.
|
3454
|
+
#
|
3455
|
+
# @return [Types::ListTypeRegistrationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3456
|
+
#
|
3457
|
+
# * {Types::ListTypeRegistrationsOutput#registration_token_list #registration_token_list} => Array<String>
|
3458
|
+
# * {Types::ListTypeRegistrationsOutput#next_token #next_token} => String
|
3459
|
+
#
|
3460
|
+
# @example Request syntax with placeholder values
|
3461
|
+
#
|
3462
|
+
# resp = client.list_type_registrations({
|
3463
|
+
# type: "RESOURCE", # accepts RESOURCE
|
3464
|
+
# type_name: "TypeName",
|
3465
|
+
# type_arn: "TypeArn",
|
3466
|
+
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
|
3467
|
+
# max_results: 1,
|
3468
|
+
# next_token: "NextToken",
|
3469
|
+
# })
|
3470
|
+
#
|
3471
|
+
# @example Response structure
|
3472
|
+
#
|
3473
|
+
# resp.registration_token_list #=> Array
|
3474
|
+
# resp.registration_token_list[0] #=> String
|
3475
|
+
# resp.next_token #=> String
|
3476
|
+
#
|
3477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeRegistrations AWS API Documentation
|
3478
|
+
#
|
3479
|
+
# @overload list_type_registrations(params = {})
|
3480
|
+
# @param [Hash] params ({})
|
3481
|
+
def list_type_registrations(params = {}, options = {})
|
3482
|
+
req = build_request(:list_type_registrations, params)
|
3483
|
+
req.send_request(options)
|
3484
|
+
end
|
3485
|
+
|
3486
|
+
# Returns summary information about the versions of a type.
|
3487
|
+
#
|
3488
|
+
# @option params [String] :type
|
3489
|
+
# The kind of the type.
|
3490
|
+
#
|
3491
|
+
# Currently the only valid value is `RESOURCE`.
|
3492
|
+
#
|
3493
|
+
# @option params [String] :type_name
|
3494
|
+
# The name of the type for which you want version summary information.
|
3495
|
+
#
|
3496
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
3497
|
+
#
|
3498
|
+
# @option params [String] :arn
|
3499
|
+
# The Amazon Resource Name (ARN) of the type for which you want version
|
3500
|
+
# summary information.
|
3501
|
+
#
|
3502
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
3503
|
+
#
|
3504
|
+
# @option params [Integer] :max_results
|
3505
|
+
# The maximum number of results to be returned with a single call. If
|
3506
|
+
# the number of available results exceeds this maximum, the response
|
3507
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
3508
|
+
# request parameter to get the next set of results.
|
3509
|
+
#
|
3510
|
+
# @option params [String] :next_token
|
3511
|
+
# If the previous paginated request didn't return all of the remaining
|
3512
|
+
# results, the response object's `NextToken` parameter value is set to
|
3513
|
+
# a token. To retrieve the next set of results, call this action again
|
3514
|
+
# and assign that token to the request object's `NextToken` parameter.
|
3515
|
+
# If there are no remaining results, the previous response object's
|
3516
|
+
# `NextToken` parameter is set to `null`.
|
3517
|
+
#
|
3518
|
+
# @option params [String] :deprecated_status
|
3519
|
+
# The deprecation status of the type versions that you want to get
|
3520
|
+
# summary information about.
|
3521
|
+
#
|
3522
|
+
# Valid values include:
|
3523
|
+
#
|
3524
|
+
# * `LIVE`\: The type version is registered and can be used in
|
3525
|
+
# CloudFormation operations, dependent on its provisioning behavior
|
3526
|
+
# and visibility scope.
|
3527
|
+
#
|
3528
|
+
# * `DEPRECATED`\: The type version has been deregistered and can no
|
3529
|
+
# longer be used in CloudFormation operations.
|
3530
|
+
#
|
3531
|
+
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3532
|
+
#
|
3533
|
+
# * {Types::ListTypeVersionsOutput#type_version_summaries #type_version_summaries} => Array<Types::TypeVersionSummary>
|
3534
|
+
# * {Types::ListTypeVersionsOutput#next_token #next_token} => String
|
3535
|
+
#
|
3536
|
+
# @example Request syntax with placeholder values
|
3537
|
+
#
|
3538
|
+
# resp = client.list_type_versions({
|
3539
|
+
# type: "RESOURCE", # accepts RESOURCE
|
3540
|
+
# type_name: "TypeName",
|
3541
|
+
# arn: "PrivateTypeArn",
|
3542
|
+
# max_results: 1,
|
3543
|
+
# next_token: "NextToken",
|
3544
|
+
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
3545
|
+
# })
|
3546
|
+
#
|
3547
|
+
# @example Response structure
|
3548
|
+
#
|
3549
|
+
# resp.type_version_summaries #=> Array
|
3550
|
+
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE"
|
3551
|
+
# resp.type_version_summaries[0].type_name #=> String
|
3552
|
+
# resp.type_version_summaries[0].version_id #=> String
|
3553
|
+
# resp.type_version_summaries[0].arn #=> String
|
3554
|
+
# resp.type_version_summaries[0].time_created #=> Time
|
3555
|
+
# resp.type_version_summaries[0].description #=> String
|
3556
|
+
# resp.next_token #=> String
|
3557
|
+
#
|
3558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions AWS API Documentation
|
3559
|
+
#
|
3560
|
+
# @overload list_type_versions(params = {})
|
3561
|
+
# @param [Hash] params ({})
|
3562
|
+
def list_type_versions(params = {}, options = {})
|
3563
|
+
req = build_request(:list_type_versions, params)
|
3564
|
+
req.send_request(options)
|
3565
|
+
end
|
3566
|
+
|
3567
|
+
# Returns summary information about types that have been registered with
|
3568
|
+
# CloudFormation.
|
3569
|
+
#
|
3570
|
+
# @option params [String] :visibility
|
3571
|
+
# The scope at which the type is visible and usable in CloudFormation
|
3572
|
+
# operations.
|
3573
|
+
#
|
3574
|
+
# Valid values include:
|
3575
|
+
#
|
3576
|
+
# * `PRIVATE`\: The type is only visible and usable within the account
|
3577
|
+
# in which it is registered. Currently, AWS CloudFormation marks any
|
3578
|
+
# types you create as `PRIVATE`.
|
3579
|
+
#
|
3580
|
+
# * `PUBLIC`\: The type is publically visible and usable within any
|
3581
|
+
# Amazon account.
|
3582
|
+
#
|
3583
|
+
# @option params [String] :provisioning_type
|
3584
|
+
# The provisioning behavior of the type. AWS CloudFormation determines
|
3585
|
+
# the provisioning type during registration, based on the types of
|
3586
|
+
# handlers in the schema handler package submitted.
|
3587
|
+
#
|
3588
|
+
# Valid values include:
|
3589
|
+
#
|
3590
|
+
# * `FULLY_MUTABLE`\: The type includes an update handler to process
|
3591
|
+
# updates to the type during stack update operations.
|
3592
|
+
#
|
3593
|
+
# * `IMMUTABLE`\: The type does not include an update handler, so the
|
3594
|
+
# type cannot be updated and must instead be replaced during stack
|
3595
|
+
# update operations.
|
3596
|
+
#
|
3597
|
+
# * `NON_PROVISIONABLE`\: The type does not include create, read, and
|
3598
|
+
# delete handlers, and therefore cannot actually be provisioned.
|
3599
|
+
#
|
3600
|
+
# @option params [String] :deprecated_status
|
3601
|
+
# The deprecation status of the types that you want to get summary
|
3602
|
+
# information about.
|
3603
|
+
#
|
3604
|
+
# Valid values include:
|
3605
|
+
#
|
3606
|
+
# * `LIVE`\: The type is registered for use in CloudFormation
|
3607
|
+
# operations.
|
3608
|
+
#
|
3609
|
+
# * `DEPRECATED`\: The type has been deregistered and can no longer be
|
3610
|
+
# used in CloudFormation operations.
|
3611
|
+
#
|
3612
|
+
# @option params [Integer] :max_results
|
3613
|
+
# The maximum number of results to be returned with a single call. If
|
3614
|
+
# the number of available results exceeds this maximum, the response
|
3615
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
3616
|
+
# request parameter to get the next set of results.
|
3617
|
+
#
|
3618
|
+
# @option params [String] :next_token
|
3619
|
+
# If the previous paginated request didn't return all of the remaining
|
3620
|
+
# results, the response object's `NextToken` parameter value is set to
|
3621
|
+
# a token. To retrieve the next set of results, call this action again
|
3622
|
+
# and assign that token to the request object's `NextToken` parameter.
|
3623
|
+
# If there are no remaining results, the previous response object's
|
3624
|
+
# `NextToken` parameter is set to `null`.
|
3625
|
+
#
|
3626
|
+
# @return [Types::ListTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3627
|
+
#
|
3628
|
+
# * {Types::ListTypesOutput#type_summaries #type_summaries} => Array<Types::TypeSummary>
|
3629
|
+
# * {Types::ListTypesOutput#next_token #next_token} => String
|
3630
|
+
#
|
3631
|
+
# @example Request syntax with placeholder values
|
3632
|
+
#
|
3633
|
+
# resp = client.list_types({
|
3634
|
+
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
3635
|
+
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
3636
|
+
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
3637
|
+
# max_results: 1,
|
3638
|
+
# next_token: "NextToken",
|
3639
|
+
# })
|
3640
|
+
#
|
3641
|
+
# @example Response structure
|
3642
|
+
#
|
3643
|
+
# resp.type_summaries #=> Array
|
3644
|
+
# resp.type_summaries[0].type #=> String, one of "RESOURCE"
|
3645
|
+
# resp.type_summaries[0].type_name #=> String
|
3646
|
+
# resp.type_summaries[0].default_version_id #=> String
|
3647
|
+
# resp.type_summaries[0].type_arn #=> String
|
3648
|
+
# resp.type_summaries[0].last_updated #=> Time
|
3649
|
+
# resp.type_summaries[0].description #=> String
|
3650
|
+
# resp.next_token #=> String
|
3651
|
+
#
|
3652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypes AWS API Documentation
|
3653
|
+
#
|
3654
|
+
# @overload list_types(params = {})
|
3655
|
+
# @param [Hash] params ({})
|
3656
|
+
def list_types(params = {}, options = {})
|
3657
|
+
req = build_request(:list_types, params)
|
3658
|
+
req.send_request(options)
|
3659
|
+
end
|
3660
|
+
|
3661
|
+
# Reports progress of a resource handler to CloudFormation.
|
3662
|
+
#
|
3663
|
+
# Reserved for use by the [CloudFormation CLI][1]. Do not use this API
|
3664
|
+
# in your code.
|
3665
|
+
#
|
3666
|
+
#
|
3667
|
+
#
|
3668
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3669
|
+
#
|
3670
|
+
# @option params [required, String] :bearer_token
|
3671
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3672
|
+
#
|
3673
|
+
#
|
3674
|
+
#
|
3675
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3676
|
+
#
|
3677
|
+
# @option params [required, String] :operation_status
|
3678
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3679
|
+
#
|
3680
|
+
#
|
3681
|
+
#
|
3682
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3683
|
+
#
|
3684
|
+
# @option params [String] :current_operation_status
|
3685
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3686
|
+
#
|
3687
|
+
#
|
3688
|
+
#
|
3689
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3690
|
+
#
|
3691
|
+
# @option params [String] :status_message
|
3692
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3693
|
+
#
|
3694
|
+
#
|
3695
|
+
#
|
3696
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3697
|
+
#
|
3698
|
+
# @option params [String] :error_code
|
3699
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3700
|
+
#
|
3701
|
+
#
|
3702
|
+
#
|
3703
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3704
|
+
#
|
3705
|
+
# @option params [String] :resource_model
|
3706
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3707
|
+
#
|
3708
|
+
#
|
3709
|
+
#
|
3710
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3711
|
+
#
|
3712
|
+
# @option params [String] :client_request_token
|
3713
|
+
# Reserved for use by the [CloudFormation CLI][1].
|
3714
|
+
#
|
3715
|
+
#
|
3716
|
+
#
|
3717
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
|
3718
|
+
#
|
3719
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3720
|
+
#
|
3721
|
+
# @example Request syntax with placeholder values
|
3722
|
+
#
|
3723
|
+
# resp = client.record_handler_progress({
|
3724
|
+
# bearer_token: "ClientToken", # required
|
3725
|
+
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
3726
|
+
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
3727
|
+
# status_message: "StatusMessage",
|
3728
|
+
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
|
3729
|
+
# resource_model: "ResourceModel",
|
3730
|
+
# client_request_token: "ClientRequestToken",
|
3731
|
+
# })
|
3732
|
+
#
|
3733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RecordHandlerProgress AWS API Documentation
|
3734
|
+
#
|
3735
|
+
# @overload record_handler_progress(params = {})
|
3736
|
+
# @param [Hash] params ({})
|
3737
|
+
def record_handler_progress(params = {}, options = {})
|
3738
|
+
req = build_request(:record_handler_progress, params)
|
3739
|
+
req.send_request(options)
|
3740
|
+
end
|
3741
|
+
|
3742
|
+
# Registers a type with the CloudFormation service. Registering a type
|
3743
|
+
# makes it available for use in CloudFormation templates in your AWS
|
3744
|
+
# account, and includes:
|
3745
|
+
#
|
3746
|
+
# * Validating the resource schema
|
3747
|
+
#
|
3748
|
+
# * Determining which handlers have been specified for the resource
|
3749
|
+
#
|
3750
|
+
# * Making the resource type available for use in your account
|
3751
|
+
#
|
3752
|
+
# For more information on how to develop types and ready them for
|
3753
|
+
# registeration, see [Creating Resource
|
3754
|
+
# Providers](cloudformation-cli/latest/userguide/resource-types.html) in
|
3755
|
+
# the *CloudFormation CLI User Guide*.
|
3756
|
+
#
|
3757
|
+
# Once you have initiated a registration request using ` RegisterType `,
|
3758
|
+
# you can use ` DescribeTypeRegistration ` to monitor the progress of
|
3759
|
+
# the registration request.
|
3760
|
+
#
|
3761
|
+
# @option params [String] :type
|
3762
|
+
# The kind of type.
|
3763
|
+
#
|
3764
|
+
# Currently, the only valid value is `RESOURCE`.
|
3765
|
+
#
|
3766
|
+
# @option params [required, String] :type_name
|
3767
|
+
# The name of the type being registered.
|
3768
|
+
#
|
3769
|
+
# We recommend that type names adhere to the following pattern:
|
3770
|
+
# *company\_or\_organization*\::*service*\::*type*.
|
3771
|
+
#
|
3772
|
+
# <note markdown="1"> The following organization namespaces are reserved and cannot be used
|
3773
|
+
# in your resource type names:
|
3774
|
+
#
|
3775
|
+
# * `Alexa`
|
3776
|
+
#
|
3777
|
+
# * `AMZN`
|
3778
|
+
#
|
3779
|
+
# * `Amazon`
|
3780
|
+
#
|
3781
|
+
# * `AWS`
|
3782
|
+
#
|
3783
|
+
# * `Custom`
|
3784
|
+
#
|
3785
|
+
# * `Dev`
|
3786
|
+
#
|
3787
|
+
# </note>
|
3788
|
+
#
|
3789
|
+
# @option params [required, String] :schema_handler_package
|
3790
|
+
# A url to the S3 bucket containing the schema handler package that
|
3791
|
+
# contains the schema, event handlers, and associated files for the type
|
3792
|
+
# you want to register.
|
3793
|
+
#
|
3794
|
+
# For information on generating a schema handler package for the type
|
3795
|
+
# you want to register, see [submit][1] in the *CloudFormation CLI User
|
3796
|
+
# Guide*.
|
3797
|
+
#
|
3798
|
+
#
|
3799
|
+
#
|
3800
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html
|
3801
|
+
#
|
3802
|
+
# @option params [Types::LoggingConfig] :logging_config
|
3803
|
+
# Specifies logging configuration information for a type.
|
3804
|
+
#
|
3805
|
+
# @option params [String] :execution_role_arn
|
3806
|
+
# The Amazon Resource Name (ARN) of the IAM execution role to use to
|
3807
|
+
# register the type. If your resource type calls AWS APIs in any of its
|
3808
|
+
# handlers, you must create an <i> <a
|
3809
|
+
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
3810
|
+
# execution role</a> </i> that includes the necessary permissions to
|
3811
|
+
# call those AWS APIs, and provision that execution role in your
|
3812
|
+
# account. CloudFormation then assumes that execution role to provide
|
3813
|
+
# your resource type with the appropriate credentials.
|
3814
|
+
#
|
3815
|
+
# @option params [String] :client_request_token
|
3816
|
+
# A unique identifier that acts as an idempotency key for this
|
3817
|
+
# registration request. Specifying a client request token prevents
|
3818
|
+
# CloudFormation from generating more than one version of a type from
|
3819
|
+
# the same registeration request, even if the request is submitted
|
3820
|
+
# multiple times.
|
3821
|
+
#
|
3822
|
+
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3823
|
+
#
|
3824
|
+
# * {Types::RegisterTypeOutput#registration_token #registration_token} => String
|
3825
|
+
#
|
3826
|
+
# @example Request syntax with placeholder values
|
3827
|
+
#
|
3828
|
+
# resp = client.register_type({
|
3829
|
+
# type: "RESOURCE", # accepts RESOURCE
|
3830
|
+
# type_name: "TypeName", # required
|
3831
|
+
# schema_handler_package: "S3Url", # required
|
3832
|
+
# logging_config: {
|
3833
|
+
# log_role_arn: "RoleArn", # required
|
3834
|
+
# log_group_name: "LogGroupName", # required
|
3835
|
+
# },
|
3836
|
+
# execution_role_arn: "RoleArn",
|
3837
|
+
# client_request_token: "RequestToken",
|
3838
|
+
# })
|
3839
|
+
#
|
3840
|
+
# @example Response structure
|
3841
|
+
#
|
3842
|
+
# resp.registration_token #=> String
|
3843
|
+
#
|
3844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterType AWS API Documentation
|
3845
|
+
#
|
3846
|
+
# @overload register_type(params = {})
|
3847
|
+
# @param [Hash] params ({})
|
3848
|
+
def register_type(params = {}, options = {})
|
3849
|
+
req = build_request(:register_type, params)
|
3850
|
+
req.send_request(options)
|
3851
|
+
end
|
3852
|
+
|
3238
3853
|
# Sets a stack policy for a specified stack.
|
3239
3854
|
#
|
3240
3855
|
# @option params [required, String] :stack_name
|
@@ -3275,6 +3890,48 @@ module Aws::CloudFormation
|
|
3275
3890
|
req.send_request(options)
|
3276
3891
|
end
|
3277
3892
|
|
3893
|
+
# Specify the default version of a type. The default version of a type
|
3894
|
+
# will be used in CloudFormation operations.
|
3895
|
+
#
|
3896
|
+
# @option params [String] :arn
|
3897
|
+
# The Amazon Resource Name (ARN) of the type for which you want version
|
3898
|
+
# summary information.
|
3899
|
+
#
|
3900
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
3901
|
+
#
|
3902
|
+
# @option params [String] :type
|
3903
|
+
# The kind of type.
|
3904
|
+
#
|
3905
|
+
# @option params [String] :type_name
|
3906
|
+
# The name of the type.
|
3907
|
+
#
|
3908
|
+
# Conditional: You must specify `TypeName` or `Arn`.
|
3909
|
+
#
|
3910
|
+
# @option params [String] :version_id
|
3911
|
+
# The ID of a specific version of the type. The version ID is the value
|
3912
|
+
# at the end of the Amazon Resource Name (ARN) assigned to the type
|
3913
|
+
# version when it is registered.
|
3914
|
+
#
|
3915
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3916
|
+
#
|
3917
|
+
# @example Request syntax with placeholder values
|
3918
|
+
#
|
3919
|
+
# resp = client.set_type_default_version({
|
3920
|
+
# arn: "PrivateTypeArn",
|
3921
|
+
# type: "RESOURCE", # accepts RESOURCE
|
3922
|
+
# type_name: "TypeName",
|
3923
|
+
# version_id: "TypeVersionId",
|
3924
|
+
# })
|
3925
|
+
#
|
3926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersion AWS API Documentation
|
3927
|
+
#
|
3928
|
+
# @overload set_type_default_version(params = {})
|
3929
|
+
# @param [Hash] params ({})
|
3930
|
+
def set_type_default_version(params = {}, options = {})
|
3931
|
+
req = build_request(:set_type_default_version, params)
|
3932
|
+
req.send_request(options)
|
3933
|
+
end
|
3934
|
+
|
3278
3935
|
# Sends a signal to the specified resource with a success or failure
|
3279
3936
|
# status. You can use the SignalResource API in conjunction with a
|
3280
3937
|
# creation policy or update policy. AWS CloudFormation doesn't proceed
|
@@ -4246,7 +4903,7 @@ module Aws::CloudFormation
|
|
4246
4903
|
params: params,
|
4247
4904
|
config: config)
|
4248
4905
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
4249
|
-
context[:gem_version] = '1.
|
4906
|
+
context[:gem_version] = '1.28.0'
|
4250
4907
|
Seahorse::Client::Request.new(handlers, context)
|
4251
4908
|
end
|
4252
4909
|
|
@@ -4312,14 +4969,15 @@ module Aws::CloudFormation
|
|
4312
4969
|
# The following table lists the valid waiter names, the operations they call,
|
4313
4970
|
# and the default `:delay` and `:max_attempts` values.
|
4314
4971
|
#
|
4315
|
-
# | waiter_name | params
|
4316
|
-
# | -------------------------- |
|
4317
|
-
# | change_set_create_complete | {#describe_change_set}
|
4318
|
-
# | stack_create_complete | {#describe_stacks}
|
4319
|
-
# | stack_delete_complete | {#describe_stacks}
|
4320
|
-
# | stack_exists | {#describe_stacks}
|
4321
|
-
# | stack_import_complete | {#describe_stacks}
|
4322
|
-
# | stack_update_complete | {#describe_stacks}
|
4972
|
+
# | waiter_name | params | :delay | :max_attempts |
|
4973
|
+
# | -------------------------- | ----------------------------- | -------- | ------------- |
|
4974
|
+
# | change_set_create_complete | {#describe_change_set} | 30 | 120 |
|
4975
|
+
# | stack_create_complete | {#describe_stacks} | 30 | 120 |
|
4976
|
+
# | stack_delete_complete | {#describe_stacks} | 30 | 120 |
|
4977
|
+
# | stack_exists | {#describe_stacks} | 5 | 20 |
|
4978
|
+
# | stack_import_complete | {#describe_stacks} | 30 | 120 |
|
4979
|
+
# | stack_update_complete | {#describe_stacks} | 30 | 120 |
|
4980
|
+
# | type_registration_complete | {#describe_type_registration} | 30 | 120 |
|
4323
4981
|
#
|
4324
4982
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
4325
4983
|
# because the waiter has entered a state that it will not transition
|
@@ -4375,7 +5033,8 @@ module Aws::CloudFormation
|
|
4375
5033
|
stack_delete_complete: Waiters::StackDeleteComplete,
|
4376
5034
|
stack_exists: Waiters::StackExists,
|
4377
5035
|
stack_import_complete: Waiters::StackImportComplete,
|
4378
|
-
stack_update_complete: Waiters::StackUpdateComplete
|
5036
|
+
stack_update_complete: Waiters::StackUpdateComplete,
|
5037
|
+
type_registration_complete: Waiters::TypeRegistrationComplete
|
4379
5038
|
}
|
4380
5039
|
end
|
4381
5040
|
|