aws-sdk-cloudformation 1.97.0 → 1.99.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +1022 -2
- data/lib/aws-sdk-cloudformation/client_api.rb +403 -0
- data/lib/aws-sdk-cloudformation/endpoints.rb +154 -0
- data/lib/aws-sdk-cloudformation/errors.rb +55 -0
- data/lib/aws-sdk-cloudformation/plugins/endpoints.rb +23 -0
- data/lib/aws-sdk-cloudformation/resource.rb +1 -1
- data/lib/aws-sdk-cloudformation/stack.rb +1 -1
- data/lib/aws-sdk-cloudformation/types.rb +1151 -15
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/client.rbs +1538 -0
- data/sig/errors.rbs +71 -0
- data/sig/event.rbs +80 -0
- data/sig/resource.rbs +134 -0
- data/sig/stack.rbs +222 -0
- data/sig/stack_resource.rbs +74 -0
- data/sig/stack_resource_summary.rbs +62 -0
- data/sig/types.rbs +1928 -0
- data/sig/waiters.rbs +101 -0
- metadata +17 -8
@@ -604,6 +604,15 @@ module Aws::CloudFormation
|
|
604
604
|
include Aws::Structure
|
605
605
|
end
|
606
606
|
|
607
|
+
# No more than 5 generated templates can be in an `InProgress` or
|
608
|
+
# `Pending` status at one time. This error is also returned if a
|
609
|
+
# generated template that is in an `InProgress` or `Pending` status is
|
610
|
+
# attempted to be updated or deleted.
|
611
|
+
#
|
612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ConcurrentResourcesLimitExceededException AWS API Documentation
|
613
|
+
#
|
614
|
+
class ConcurrentResourcesLimitExceededException < Aws::EmptyStructure; end
|
615
|
+
|
607
616
|
# The input for the ContinueUpdateRollback action.
|
608
617
|
#
|
609
618
|
# @!attribute [rw] stack_name
|
@@ -1036,6 +1045,52 @@ module Aws::CloudFormation
|
|
1036
1045
|
include Aws::Structure
|
1037
1046
|
end
|
1038
1047
|
|
1048
|
+
# @!attribute [rw] resources
|
1049
|
+
# An optional list of resources to be included in the generated
|
1050
|
+
# template.
|
1051
|
+
#
|
1052
|
+
# If no resources are specified,the template will be created without
|
1053
|
+
# any resources. Resources can be added to the template using the
|
1054
|
+
# `UpdateGeneratedTemplate` API action.
|
1055
|
+
# @return [Array<Types::ResourceDefinition>]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] generated_template_name
|
1058
|
+
# The name assigned to the generated template.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] stack_name
|
1062
|
+
# An optional name or ARN of a stack to use as the base stack for the
|
1063
|
+
# generated template.
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] template_configuration
|
1067
|
+
# The configuration details of the generated template, including the
|
1068
|
+
# `DeletionPolicy` and `UpdateReplacePolicy`.
|
1069
|
+
# @return [Types::TemplateConfiguration]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateGeneratedTemplateInput AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class CreateGeneratedTemplateInput < Struct.new(
|
1074
|
+
:resources,
|
1075
|
+
:generated_template_name,
|
1076
|
+
:stack_name,
|
1077
|
+
:template_configuration)
|
1078
|
+
SENSITIVE = []
|
1079
|
+
include Aws::Structure
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# @!attribute [rw] generated_template_id
|
1083
|
+
# The ID of the generated template.
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateGeneratedTemplateOutput AWS API Documentation
|
1087
|
+
#
|
1088
|
+
class CreateGeneratedTemplateOutput < Struct.new(
|
1089
|
+
:generated_template_id)
|
1090
|
+
SENSITIVE = []
|
1091
|
+
include Aws::Structure
|
1092
|
+
end
|
1093
|
+
|
1039
1094
|
# The input for CreateStack action.
|
1040
1095
|
#
|
1041
1096
|
# @!attribute [rw] stack_name
|
@@ -1101,7 +1156,7 @@ module Aws::CloudFormation
|
|
1101
1156
|
#
|
1102
1157
|
# @!attribute [rw] timeout_in_minutes
|
1103
1158
|
# The amount of time that can pass before the stack status becomes
|
1104
|
-
#
|
1159
|
+
# `CREATE_FAILED`; if `DisableRollback` is not set or is set to
|
1105
1160
|
# `false`, the stack will be rolled back.
|
1106
1161
|
# @return [Integer]
|
1107
1162
|
#
|
@@ -1867,6 +1922,18 @@ module Aws::CloudFormation
|
|
1867
1922
|
#
|
1868
1923
|
class DeleteChangeSetOutput < Aws::EmptyStructure; end
|
1869
1924
|
|
1925
|
+
# @!attribute [rw] generated_template_name
|
1926
|
+
# The name or Amazon Resource Name (ARN) of a generated template.
|
1927
|
+
# @return [String]
|
1928
|
+
#
|
1929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteGeneratedTemplateInput AWS API Documentation
|
1930
|
+
#
|
1931
|
+
class DeleteGeneratedTemplateInput < Struct.new(
|
1932
|
+
:generated_template_name)
|
1933
|
+
SENSITIVE = []
|
1934
|
+
include Aws::Structure
|
1935
|
+
end
|
1936
|
+
|
1870
1937
|
# The input for DeleteStack action.
|
1871
1938
|
#
|
1872
1939
|
# @!attribute [rw] stack_name
|
@@ -2488,6 +2555,106 @@ module Aws::CloudFormation
|
|
2488
2555
|
include Aws::Structure
|
2489
2556
|
end
|
2490
2557
|
|
2558
|
+
# @!attribute [rw] generated_template_name
|
2559
|
+
# The name or Amazon Resource Name (ARN) of a generated template.
|
2560
|
+
# @return [String]
|
2561
|
+
#
|
2562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeGeneratedTemplateInput AWS API Documentation
|
2563
|
+
#
|
2564
|
+
class DescribeGeneratedTemplateInput < Struct.new(
|
2565
|
+
:generated_template_name)
|
2566
|
+
SENSITIVE = []
|
2567
|
+
include Aws::Structure
|
2568
|
+
end
|
2569
|
+
|
2570
|
+
# @!attribute [rw] generated_template_id
|
2571
|
+
# The Amazon Resource Name (ARN) of the generated template. The format
|
2572
|
+
# is
|
2573
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
2574
|
+
# For example,
|
2575
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
2576
|
+
# `.
|
2577
|
+
# @return [String]
|
2578
|
+
#
|
2579
|
+
# @!attribute [rw] generated_template_name
|
2580
|
+
# The name of the generated template.
|
2581
|
+
# @return [String]
|
2582
|
+
#
|
2583
|
+
# @!attribute [rw] resources
|
2584
|
+
# A list of objects describing the details of the resources in the
|
2585
|
+
# template generation.
|
2586
|
+
# @return [Array<Types::ResourceDetail>]
|
2587
|
+
#
|
2588
|
+
# @!attribute [rw] status
|
2589
|
+
# The status of the template generation. Supported values are:
|
2590
|
+
#
|
2591
|
+
# * `CreatePending` - the creation of the template is pending.
|
2592
|
+
#
|
2593
|
+
# * `CreateInProgress` - the creation of the template is in progress.
|
2594
|
+
#
|
2595
|
+
# * `DeletePending` - the deletion of the template is pending.
|
2596
|
+
#
|
2597
|
+
# * `DeleteInProgress` - the deletion of the template is in progress.
|
2598
|
+
#
|
2599
|
+
# * `UpdatePending` - the update of the template is pending.
|
2600
|
+
#
|
2601
|
+
# * `UpdateInProgress` - the update of the template is in progress.
|
2602
|
+
#
|
2603
|
+
# * `Failed` - the template operation failed.
|
2604
|
+
#
|
2605
|
+
# * `Complete` - the template operation is complete.
|
2606
|
+
# @return [String]
|
2607
|
+
#
|
2608
|
+
# @!attribute [rw] status_reason
|
2609
|
+
# The reason for the current template generation status. This will
|
2610
|
+
# provide more details if a failure happened.
|
2611
|
+
# @return [String]
|
2612
|
+
#
|
2613
|
+
# @!attribute [rw] creation_time
|
2614
|
+
# The time the generated template was created.
|
2615
|
+
# @return [Time]
|
2616
|
+
#
|
2617
|
+
# @!attribute [rw] last_updated_time
|
2618
|
+
# The time the generated template was last updated.
|
2619
|
+
# @return [Time]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] progress
|
2622
|
+
# An object describing the progress of the template generation.
|
2623
|
+
# @return [Types::TemplateProgress]
|
2624
|
+
#
|
2625
|
+
# @!attribute [rw] stack_id
|
2626
|
+
# The stack ARN of the base stack if a base stack was provided when
|
2627
|
+
# generating the template.
|
2628
|
+
# @return [String]
|
2629
|
+
#
|
2630
|
+
# @!attribute [rw] template_configuration
|
2631
|
+
# The configuration details of the generated template, including the
|
2632
|
+
# `DeletionPolicy` and `UpdateReplacePolicy`.
|
2633
|
+
# @return [Types::TemplateConfiguration]
|
2634
|
+
#
|
2635
|
+
# @!attribute [rw] total_warnings
|
2636
|
+
# The number of warnings generated for this template. The warnings are
|
2637
|
+
# found in the details of each of the resources in the template.
|
2638
|
+
# @return [Integer]
|
2639
|
+
#
|
2640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeGeneratedTemplateOutput AWS API Documentation
|
2641
|
+
#
|
2642
|
+
class DescribeGeneratedTemplateOutput < Struct.new(
|
2643
|
+
:generated_template_id,
|
2644
|
+
:generated_template_name,
|
2645
|
+
:resources,
|
2646
|
+
:status,
|
2647
|
+
:status_reason,
|
2648
|
+
:creation_time,
|
2649
|
+
:last_updated_time,
|
2650
|
+
:progress,
|
2651
|
+
:stack_id,
|
2652
|
+
:template_configuration,
|
2653
|
+
:total_warnings)
|
2654
|
+
SENSITIVE = []
|
2655
|
+
include Aws::Structure
|
2656
|
+
end
|
2657
|
+
|
2491
2658
|
# @!attribute [rw] call_as
|
2492
2659
|
# \[Service-managed permissions\] Specifies whether you are acting as
|
2493
2660
|
# an account administrator in the organization's management account
|
@@ -2575,6 +2742,100 @@ module Aws::CloudFormation
|
|
2575
2742
|
include Aws::Structure
|
2576
2743
|
end
|
2577
2744
|
|
2745
|
+
# @!attribute [rw] resource_scan_id
|
2746
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
2747
|
+
# @return [String]
|
2748
|
+
#
|
2749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeResourceScanInput AWS API Documentation
|
2750
|
+
#
|
2751
|
+
class DescribeResourceScanInput < Struct.new(
|
2752
|
+
:resource_scan_id)
|
2753
|
+
SENSITIVE = []
|
2754
|
+
include Aws::Structure
|
2755
|
+
end
|
2756
|
+
|
2757
|
+
# @!attribute [rw] resource_scan_id
|
2758
|
+
# The Amazon Resource Name (ARN) of the resource scan. The format is
|
2759
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}`.
|
2760
|
+
# An example is
|
2761
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
|
2762
|
+
# `.
|
2763
|
+
# @return [String]
|
2764
|
+
#
|
2765
|
+
# @!attribute [rw] status
|
2766
|
+
# Status of the resource scan.
|
2767
|
+
#
|
2768
|
+
# INPROGRESS
|
2769
|
+
#
|
2770
|
+
# : The resource scan is still in progress.
|
2771
|
+
#
|
2772
|
+
# COMPLETE
|
2773
|
+
#
|
2774
|
+
# : The resource scan is complete.
|
2775
|
+
#
|
2776
|
+
# EXPIRED
|
2777
|
+
#
|
2778
|
+
# : The resource scan has expired.
|
2779
|
+
#
|
2780
|
+
# FAILED
|
2781
|
+
#
|
2782
|
+
# : The resource scan has failed.
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @!attribute [rw] status_reason
|
2786
|
+
# The reason for the resource scan status, providing more information
|
2787
|
+
# if a failure happened.
|
2788
|
+
# @return [String]
|
2789
|
+
#
|
2790
|
+
# @!attribute [rw] start_time
|
2791
|
+
# The time that the resource scan was started.
|
2792
|
+
# @return [Time]
|
2793
|
+
#
|
2794
|
+
# @!attribute [rw] end_time
|
2795
|
+
# The time that the resource scan was finished.
|
2796
|
+
# @return [Time]
|
2797
|
+
#
|
2798
|
+
# @!attribute [rw] percentage_completed
|
2799
|
+
# The percentage of the resource scan that has been completed.
|
2800
|
+
# @return [Float]
|
2801
|
+
#
|
2802
|
+
# @!attribute [rw] resource_types
|
2803
|
+
# The list of resource types for the specified scan. Resource types
|
2804
|
+
# are only available for scans with a `Status` set to `COMPLETE` or
|
2805
|
+
# `FAILED `.
|
2806
|
+
# @return [Array<String>]
|
2807
|
+
#
|
2808
|
+
# @!attribute [rw] resources_scanned
|
2809
|
+
# The number of resources that were listed. This is only available for
|
2810
|
+
# scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED `.
|
2811
|
+
# @return [Integer]
|
2812
|
+
#
|
2813
|
+
# @!attribute [rw] resources_read
|
2814
|
+
# The number of resources that were read. This is only available for
|
2815
|
+
# scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED `.
|
2816
|
+
#
|
2817
|
+
# <note markdown="1"> This field may be 0 if the resource scan failed with a
|
2818
|
+
# `ResourceScanLimitExceededException`.
|
2819
|
+
#
|
2820
|
+
# </note>
|
2821
|
+
# @return [Integer]
|
2822
|
+
#
|
2823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeResourceScanOutput AWS API Documentation
|
2824
|
+
#
|
2825
|
+
class DescribeResourceScanOutput < Struct.new(
|
2826
|
+
:resource_scan_id,
|
2827
|
+
:status,
|
2828
|
+
:status_reason,
|
2829
|
+
:start_time,
|
2830
|
+
:end_time,
|
2831
|
+
:percentage_completed,
|
2832
|
+
:resource_types,
|
2833
|
+
:resources_scanned,
|
2834
|
+
:resources_read)
|
2835
|
+
SENSITIVE = []
|
2836
|
+
include Aws::Structure
|
2837
|
+
end
|
2838
|
+
|
2578
2839
|
# @!attribute [rw] stack_drift_detection_id
|
2579
2840
|
# The ID of the drift detection results of this operation.
|
2580
2841
|
#
|
@@ -3876,6 +4137,73 @@ module Aws::CloudFormation
|
|
3876
4137
|
include Aws::Structure
|
3877
4138
|
end
|
3878
4139
|
|
4140
|
+
# The generated template was not found.
|
4141
|
+
#
|
4142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GeneratedTemplateNotFoundException AWS API Documentation
|
4143
|
+
#
|
4144
|
+
class GeneratedTemplateNotFoundException < Aws::EmptyStructure; end
|
4145
|
+
|
4146
|
+
# @!attribute [rw] format
|
4147
|
+
# The language to use to retrieve for the generated template.
|
4148
|
+
# Supported values are:
|
4149
|
+
#
|
4150
|
+
# * `JSON`
|
4151
|
+
#
|
4152
|
+
# * `YAML`
|
4153
|
+
# @return [String]
|
4154
|
+
#
|
4155
|
+
# @!attribute [rw] generated_template_name
|
4156
|
+
# The name or Amazon Resource Name (ARN) of the generated template.
|
4157
|
+
# The format is
|
4158
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
4159
|
+
# For example,
|
4160
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
4161
|
+
# `.
|
4162
|
+
# @return [String]
|
4163
|
+
#
|
4164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetGeneratedTemplateInput AWS API Documentation
|
4165
|
+
#
|
4166
|
+
class GetGeneratedTemplateInput < Struct.new(
|
4167
|
+
:format,
|
4168
|
+
:generated_template_name)
|
4169
|
+
SENSITIVE = []
|
4170
|
+
include Aws::Structure
|
4171
|
+
end
|
4172
|
+
|
4173
|
+
# @!attribute [rw] status
|
4174
|
+
# The status of the template generation. Supported values are:
|
4175
|
+
#
|
4176
|
+
# * `CreatePending` - the creation of the template is pending.
|
4177
|
+
#
|
4178
|
+
# * `CreateInProgress` - the creation of the template is in progress.
|
4179
|
+
#
|
4180
|
+
# * `DeletePending` - the deletion of the template is pending.
|
4181
|
+
#
|
4182
|
+
# * `DeleteInProgress` - the deletion of the template is in progress.
|
4183
|
+
#
|
4184
|
+
# * `UpdatePending` - the update of the template is pending.
|
4185
|
+
#
|
4186
|
+
# * `UpdateInProgress` - the update of the template is in progress.
|
4187
|
+
#
|
4188
|
+
# * `Failed` - the template operation failed.
|
4189
|
+
#
|
4190
|
+
# * `Complete` - the template operation is complete.
|
4191
|
+
# @return [String]
|
4192
|
+
#
|
4193
|
+
# @!attribute [rw] template_body
|
4194
|
+
# The template body of the generated template, in the language
|
4195
|
+
# specified by the `Language` parameter.
|
4196
|
+
# @return [String]
|
4197
|
+
#
|
4198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetGeneratedTemplateOutput AWS API Documentation
|
4199
|
+
#
|
4200
|
+
class GetGeneratedTemplateOutput < Struct.new(
|
4201
|
+
:status,
|
4202
|
+
:template_body)
|
4203
|
+
SENSITIVE = []
|
4204
|
+
include Aws::Structure
|
4205
|
+
end
|
4206
|
+
|
3879
4207
|
# The input for the GetStackPolicy action.
|
3880
4208
|
#
|
3881
4209
|
# @!attribute [rw] stack_name
|
@@ -4351,6 +4679,48 @@ module Aws::CloudFormation
|
|
4351
4679
|
include Aws::Structure
|
4352
4680
|
end
|
4353
4681
|
|
4682
|
+
# @!attribute [rw] next_token
|
4683
|
+
# A string that identifies the next page of resource scan results.
|
4684
|
+
# @return [String]
|
4685
|
+
#
|
4686
|
+
# @!attribute [rw] max_results
|
4687
|
+
# If the number of available results exceeds this maximum, the
|
4688
|
+
# response includes a `NextToken` value that you can use for the
|
4689
|
+
# `NextToken` parameter to get the next set of results. By default the
|
4690
|
+
# `ListGeneratedTemplates` API action will return at most 50 results
|
4691
|
+
# in each response. The maximum value is 100.
|
4692
|
+
# @return [Integer]
|
4693
|
+
#
|
4694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListGeneratedTemplatesInput AWS API Documentation
|
4695
|
+
#
|
4696
|
+
class ListGeneratedTemplatesInput < Struct.new(
|
4697
|
+
:next_token,
|
4698
|
+
:max_results)
|
4699
|
+
SENSITIVE = []
|
4700
|
+
include Aws::Structure
|
4701
|
+
end
|
4702
|
+
|
4703
|
+
# @!attribute [rw] summaries
|
4704
|
+
# A list of summaries of the generated templates.
|
4705
|
+
# @return [Array<Types::TemplateSummary>]
|
4706
|
+
#
|
4707
|
+
# @!attribute [rw] next_token
|
4708
|
+
# If the request doesn't return all the remaining results,
|
4709
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4710
|
+
# call `ListGeneratedTemplates` again and use that value for the
|
4711
|
+
# `NextToken` parameter. If the request returns all results,
|
4712
|
+
# `NextToken` is set to an empty string.
|
4713
|
+
# @return [String]
|
4714
|
+
#
|
4715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListGeneratedTemplatesOutput AWS API Documentation
|
4716
|
+
#
|
4717
|
+
class ListGeneratedTemplatesOutput < Struct.new(
|
4718
|
+
:summaries,
|
4719
|
+
:next_token)
|
4720
|
+
SENSITIVE = []
|
4721
|
+
include Aws::Structure
|
4722
|
+
end
|
4723
|
+
|
4354
4724
|
# @!attribute [rw] export_name
|
4355
4725
|
# The name of the exported output value. CloudFormation returns the
|
4356
4726
|
# stack names that are importing this value.
|
@@ -4390,6 +4760,172 @@ module Aws::CloudFormation
|
|
4390
4760
|
include Aws::Structure
|
4391
4761
|
end
|
4392
4762
|
|
4763
|
+
# @!attribute [rw] resource_scan_id
|
4764
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
4765
|
+
# @return [String]
|
4766
|
+
#
|
4767
|
+
# @!attribute [rw] resources
|
4768
|
+
# The list of resources for which you want to get the related
|
4769
|
+
# resources. Up to 100 resources can be provided.
|
4770
|
+
# @return [Array<Types::ScannedResourceIdentifier>]
|
4771
|
+
#
|
4772
|
+
# @!attribute [rw] next_token
|
4773
|
+
# A string that identifies the next page of resource scan results.
|
4774
|
+
# @return [String]
|
4775
|
+
#
|
4776
|
+
# @!attribute [rw] max_results
|
4777
|
+
# If the number of available results exceeds this maximum, the
|
4778
|
+
# response includes a `NextToken` value that you can use for the
|
4779
|
+
# `NextToken` parameter to get the next set of results. By default the
|
4780
|
+
# `ListResourceScanRelatedResources` API action will return up to 100
|
4781
|
+
# results in each response. The maximum value is 100.
|
4782
|
+
# @return [Integer]
|
4783
|
+
#
|
4784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanRelatedResourcesInput AWS API Documentation
|
4785
|
+
#
|
4786
|
+
class ListResourceScanRelatedResourcesInput < Struct.new(
|
4787
|
+
:resource_scan_id,
|
4788
|
+
:resources,
|
4789
|
+
:next_token,
|
4790
|
+
:max_results)
|
4791
|
+
SENSITIVE = []
|
4792
|
+
include Aws::Structure
|
4793
|
+
end
|
4794
|
+
|
4795
|
+
# @!attribute [rw] related_resources
|
4796
|
+
# List of up to `MaxResults` resources in the specified resource scan
|
4797
|
+
# related to the specified resources.
|
4798
|
+
# @return [Array<Types::ScannedResource>]
|
4799
|
+
#
|
4800
|
+
# @!attribute [rw] next_token
|
4801
|
+
# If the request doesn't return all the remaining results,
|
4802
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4803
|
+
# call `ListResourceScanRelatedResources` again and use that value for
|
4804
|
+
# the `NextToken` parameter. If the request returns all results,
|
4805
|
+
# `NextToken` is set to an empty string.
|
4806
|
+
# @return [String]
|
4807
|
+
#
|
4808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanRelatedResourcesOutput AWS API Documentation
|
4809
|
+
#
|
4810
|
+
class ListResourceScanRelatedResourcesOutput < Struct.new(
|
4811
|
+
:related_resources,
|
4812
|
+
:next_token)
|
4813
|
+
SENSITIVE = []
|
4814
|
+
include Aws::Structure
|
4815
|
+
end
|
4816
|
+
|
4817
|
+
# @!attribute [rw] resource_scan_id
|
4818
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
4819
|
+
# @return [String]
|
4820
|
+
#
|
4821
|
+
# @!attribute [rw] resource_identifier
|
4822
|
+
# If specified, the returned resources will have the specified
|
4823
|
+
# resource identifier (or one of them in the case where the resource
|
4824
|
+
# has multiple identifiers).
|
4825
|
+
# @return [String]
|
4826
|
+
#
|
4827
|
+
# @!attribute [rw] resource_type_prefix
|
4828
|
+
# If specified, the returned resources will be of any of the resource
|
4829
|
+
# types with the specified prefix.
|
4830
|
+
# @return [String]
|
4831
|
+
#
|
4832
|
+
# @!attribute [rw] tag_key
|
4833
|
+
# If specified, the returned resources will have a matching tag key.
|
4834
|
+
# @return [String]
|
4835
|
+
#
|
4836
|
+
# @!attribute [rw] tag_value
|
4837
|
+
# If specified, the returned resources will have a matching tag value.
|
4838
|
+
# @return [String]
|
4839
|
+
#
|
4840
|
+
# @!attribute [rw] next_token
|
4841
|
+
# A string that identifies the next page of resource scan results.
|
4842
|
+
# @return [String]
|
4843
|
+
#
|
4844
|
+
# @!attribute [rw] max_results
|
4845
|
+
# If the number of available results exceeds this maximum, the
|
4846
|
+
# response includes a `NextToken` value that you can use for the
|
4847
|
+
# `NextToken` parameter to get the next set of results. By default the
|
4848
|
+
# `ListResourceScanResources` API action will return at most 100
|
4849
|
+
# results in each response. The maximum value is 100.
|
4850
|
+
# @return [Integer]
|
4851
|
+
#
|
4852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanResourcesInput AWS API Documentation
|
4853
|
+
#
|
4854
|
+
class ListResourceScanResourcesInput < Struct.new(
|
4855
|
+
:resource_scan_id,
|
4856
|
+
:resource_identifier,
|
4857
|
+
:resource_type_prefix,
|
4858
|
+
:tag_key,
|
4859
|
+
:tag_value,
|
4860
|
+
:next_token,
|
4861
|
+
:max_results)
|
4862
|
+
SENSITIVE = []
|
4863
|
+
include Aws::Structure
|
4864
|
+
end
|
4865
|
+
|
4866
|
+
# @!attribute [rw] resources
|
4867
|
+
# List of up to `MaxResults` resources in the specified resource scan
|
4868
|
+
# that match all of the specified filters.
|
4869
|
+
# @return [Array<Types::ScannedResource>]
|
4870
|
+
#
|
4871
|
+
# @!attribute [rw] next_token
|
4872
|
+
# If the request doesn't return all the remaining results,
|
4873
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4874
|
+
# call `ListResourceScanResources` again and use that value for the
|
4875
|
+
# `NextToken` parameter. If the request returns all results,
|
4876
|
+
# `NextToken` is set to an empty string.
|
4877
|
+
# @return [String]
|
4878
|
+
#
|
4879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanResourcesOutput AWS API Documentation
|
4880
|
+
#
|
4881
|
+
class ListResourceScanResourcesOutput < Struct.new(
|
4882
|
+
:resources,
|
4883
|
+
:next_token)
|
4884
|
+
SENSITIVE = []
|
4885
|
+
include Aws::Structure
|
4886
|
+
end
|
4887
|
+
|
4888
|
+
# @!attribute [rw] next_token
|
4889
|
+
# A string that identifies the next page of resource scan results.
|
4890
|
+
# @return [String]
|
4891
|
+
#
|
4892
|
+
# @!attribute [rw] max_results
|
4893
|
+
# If the number of available results exceeds this maximum, the
|
4894
|
+
# response includes a `NextToken` value that you can use for the
|
4895
|
+
# `NextToken` parameter to get the next set of results. The default
|
4896
|
+
# value is 10. The maximum value is 100.
|
4897
|
+
# @return [Integer]
|
4898
|
+
#
|
4899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScansInput AWS API Documentation
|
4900
|
+
#
|
4901
|
+
class ListResourceScansInput < Struct.new(
|
4902
|
+
:next_token,
|
4903
|
+
:max_results)
|
4904
|
+
SENSITIVE = []
|
4905
|
+
include Aws::Structure
|
4906
|
+
end
|
4907
|
+
|
4908
|
+
# @!attribute [rw] resource_scan_summaries
|
4909
|
+
# The list of scans returned.
|
4910
|
+
# @return [Array<Types::ResourceScanSummary>]
|
4911
|
+
#
|
4912
|
+
# @!attribute [rw] next_token
|
4913
|
+
# If the request doesn't return all the remaining results,
|
4914
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4915
|
+
# call `ListResourceScans` again and use that value for the
|
4916
|
+
# `NextToken` parameter. If the request returns all results,
|
4917
|
+
# `NextToken` is set to an empty string.
|
4918
|
+
# @return [String]
|
4919
|
+
#
|
4920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScansOutput AWS API Documentation
|
4921
|
+
#
|
4922
|
+
class ListResourceScansOutput < Struct.new(
|
4923
|
+
:resource_scan_summaries,
|
4924
|
+
:next_token)
|
4925
|
+
SENSITIVE = []
|
4926
|
+
include Aws::Structure
|
4927
|
+
end
|
4928
|
+
|
4393
4929
|
# @!attribute [rw] stack_set_name
|
4394
4930
|
# The name or unique ID of the stack set that you want to list drifted
|
4395
4931
|
# resources for.
|
@@ -6087,24 +6623,144 @@ module Aws::CloudFormation
|
|
6087
6623
|
# an update on the parent stack.
|
6088
6624
|
# @return [String]
|
6089
6625
|
#
|
6090
|
-
# @!attribute [rw] causing_entity
|
6091
|
-
# The identity of the entity that triggered this change. This entity
|
6092
|
-
# is a member of the group that's specified by the `ChangeSource`
|
6093
|
-
# field. For example, if you modified the value of the `KeyPairName`
|
6094
|
-
# parameter, the `CausingEntity` is the name of the parameter
|
6095
|
-
# (`KeyPairName`).
|
6626
|
+
# @!attribute [rw] causing_entity
|
6627
|
+
# The identity of the entity that triggered this change. This entity
|
6628
|
+
# is a member of the group that's specified by the `ChangeSource`
|
6629
|
+
# field. For example, if you modified the value of the `KeyPairName`
|
6630
|
+
# parameter, the `CausingEntity` is the name of the parameter
|
6631
|
+
# (`KeyPairName`).
|
6632
|
+
#
|
6633
|
+
# If the `ChangeSource` value is `DirectModification`, no value is
|
6634
|
+
# given for `CausingEntity`.
|
6635
|
+
# @return [String]
|
6636
|
+
#
|
6637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceChangeDetail AWS API Documentation
|
6638
|
+
#
|
6639
|
+
class ResourceChangeDetail < Struct.new(
|
6640
|
+
:target,
|
6641
|
+
:evaluation,
|
6642
|
+
:change_source,
|
6643
|
+
:causing_entity)
|
6644
|
+
SENSITIVE = []
|
6645
|
+
include Aws::Structure
|
6646
|
+
end
|
6647
|
+
|
6648
|
+
# A resource included in a generated template. This data type is used
|
6649
|
+
# with the `CreateGeneratedTemplate` and `UpdateGeneratedTemplate` API
|
6650
|
+
# actions.
|
6651
|
+
#
|
6652
|
+
# @!attribute [rw] resource_type
|
6653
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
6654
|
+
# list of supported resources, see [IaC generator supported resource
|
6655
|
+
# types][1] in the *CloudFormation User Guide*
|
6656
|
+
#
|
6657
|
+
#
|
6658
|
+
#
|
6659
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html
|
6660
|
+
# @return [String]
|
6661
|
+
#
|
6662
|
+
# @!attribute [rw] logical_resource_id
|
6663
|
+
# The logical resource id for this resource in the generated template.
|
6664
|
+
# @return [String]
|
6665
|
+
#
|
6666
|
+
# @!attribute [rw] resource_identifier
|
6667
|
+
# A list of up to 256 key-value pairs that identifies the scanned
|
6668
|
+
# resource. The key is the name of one of the primary identifiers for
|
6669
|
+
# the resource. (Primary identifiers are specified in the
|
6670
|
+
# `primaryIdentifier` list in the resource schema.) The value is the
|
6671
|
+
# value of that primary identifier. For example, for a
|
6672
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
6673
|
+
# `TableName` so the key-value pair could be `"TableName":
|
6674
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
6675
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
6676
|
+
# development*.
|
6677
|
+
#
|
6678
|
+
#
|
6679
|
+
#
|
6680
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
6681
|
+
# @return [Hash<String,String>]
|
6682
|
+
#
|
6683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceDefinition AWS API Documentation
|
6684
|
+
#
|
6685
|
+
class ResourceDefinition < Struct.new(
|
6686
|
+
:resource_type,
|
6687
|
+
:logical_resource_id,
|
6688
|
+
:resource_identifier)
|
6689
|
+
SENSITIVE = []
|
6690
|
+
include Aws::Structure
|
6691
|
+
end
|
6692
|
+
|
6693
|
+
# Details about a resource in a generated template
|
6694
|
+
#
|
6695
|
+
# @!attribute [rw] resource_type
|
6696
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
6697
|
+
# list of supported resources, see [IaC generator supported resource
|
6698
|
+
# types][1] In the *CloudFormation User Guide*
|
6699
|
+
#
|
6700
|
+
#
|
6701
|
+
#
|
6702
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html
|
6703
|
+
# @return [String]
|
6704
|
+
#
|
6705
|
+
# @!attribute [rw] logical_resource_id
|
6706
|
+
# The logical id for this resource in the final generated template.
|
6707
|
+
# @return [String]
|
6708
|
+
#
|
6709
|
+
# @!attribute [rw] resource_identifier
|
6710
|
+
# A list of up to 256 key-value pairs that identifies the resource in
|
6711
|
+
# the generated template. The key is the name of one of the primary
|
6712
|
+
# identifiers for the resource. (Primary identifiers are specified in
|
6713
|
+
# the `primaryIdentifier` list in the resource schema.) The value is
|
6714
|
+
# the value of that primary identifier. For example, for a
|
6715
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
6716
|
+
# `TableName` so the key-value pair could be `"TableName":
|
6717
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
6718
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
6719
|
+
# development*.
|
6720
|
+
#
|
6721
|
+
#
|
6722
|
+
#
|
6723
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
6724
|
+
# @return [Hash<String,String>]
|
6725
|
+
#
|
6726
|
+
# @!attribute [rw] resource_status
|
6727
|
+
# Status of the processing of a resource in a generated template.
|
6728
|
+
#
|
6729
|
+
# InProgress
|
6730
|
+
#
|
6731
|
+
# : The resource processing is still in progress.
|
6732
|
+
#
|
6733
|
+
# Complete
|
6734
|
+
#
|
6735
|
+
# : The resource processing is complete.
|
6736
|
+
#
|
6737
|
+
# Pending
|
6738
|
+
#
|
6739
|
+
# : The resource processing is pending.
|
6096
6740
|
#
|
6097
|
-
#
|
6098
|
-
#
|
6741
|
+
# Failed
|
6742
|
+
#
|
6743
|
+
# : The resource processing has failed.
|
6099
6744
|
# @return [String]
|
6100
6745
|
#
|
6101
|
-
#
|
6746
|
+
# @!attribute [rw] resource_status_reason
|
6747
|
+
# The reason for the resource detail, providing more information if a
|
6748
|
+
# failure happened.
|
6749
|
+
# @return [String]
|
6102
6750
|
#
|
6103
|
-
|
6104
|
-
|
6105
|
-
|
6106
|
-
|
6107
|
-
|
6751
|
+
# @!attribute [rw] warnings
|
6752
|
+
# The warnings generated for this resource.
|
6753
|
+
# @return [Array<Types::WarningDetail>]
|
6754
|
+
#
|
6755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceDetail AWS API Documentation
|
6756
|
+
#
|
6757
|
+
class ResourceDetail < Struct.new(
|
6758
|
+
:resource_type,
|
6759
|
+
:logical_resource_id,
|
6760
|
+
:resource_identifier,
|
6761
|
+
:resource_status,
|
6762
|
+
:resource_status_reason,
|
6763
|
+
:warnings)
|
6108
6764
|
SENSITIVE = []
|
6109
6765
|
include Aws::Structure
|
6110
6766
|
end
|
@@ -6140,6 +6796,91 @@ module Aws::CloudFormation
|
|
6140
6796
|
include Aws::Structure
|
6141
6797
|
end
|
6142
6798
|
|
6799
|
+
# A resource scan is currently in progress. Only one can be run at a
|
6800
|
+
# time for an account in a Region.
|
6801
|
+
#
|
6802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanInProgressException AWS API Documentation
|
6803
|
+
#
|
6804
|
+
class ResourceScanInProgressException < Aws::EmptyStructure; end
|
6805
|
+
|
6806
|
+
# The limit on resource scans has been exceeded. Reasons include:
|
6807
|
+
#
|
6808
|
+
# * Exceeded the daily quota for resource scans.
|
6809
|
+
#
|
6810
|
+
# * A resource scan recently failed. You must wait 10 minutes before
|
6811
|
+
# starting a new resource scan.
|
6812
|
+
#
|
6813
|
+
# * The last resource scan failed after exceeding 100,000 resources.
|
6814
|
+
# When this happens, you must wait 24 hours before starting a new
|
6815
|
+
# resource scan.
|
6816
|
+
#
|
6817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanLimitExceededException AWS API Documentation
|
6818
|
+
#
|
6819
|
+
class ResourceScanLimitExceededException < Aws::EmptyStructure; end
|
6820
|
+
|
6821
|
+
# The resource scan was not found.
|
6822
|
+
#
|
6823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanNotFoundException AWS API Documentation
|
6824
|
+
#
|
6825
|
+
class ResourceScanNotFoundException < Aws::EmptyStructure; end
|
6826
|
+
|
6827
|
+
# A summary of the resource scan. This is returned by the
|
6828
|
+
# `ListResourceScan` API action.
|
6829
|
+
#
|
6830
|
+
# @!attribute [rw] resource_scan_id
|
6831
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
6832
|
+
# @return [String]
|
6833
|
+
#
|
6834
|
+
# @!attribute [rw] status
|
6835
|
+
# Status of the resource scan.
|
6836
|
+
#
|
6837
|
+
# INPROGRESS
|
6838
|
+
#
|
6839
|
+
# : The resource scan is still in progress.
|
6840
|
+
#
|
6841
|
+
# COMPLETE
|
6842
|
+
#
|
6843
|
+
# : The resource scan is complete.
|
6844
|
+
#
|
6845
|
+
# EXPIRED
|
6846
|
+
#
|
6847
|
+
# : The resource scan has expired.
|
6848
|
+
#
|
6849
|
+
# FAILED
|
6850
|
+
#
|
6851
|
+
# : The resource scan has failed.
|
6852
|
+
# @return [String]
|
6853
|
+
#
|
6854
|
+
# @!attribute [rw] status_reason
|
6855
|
+
# The reason for the resource scan status, providing more information
|
6856
|
+
# if a failure happened.
|
6857
|
+
# @return [String]
|
6858
|
+
#
|
6859
|
+
# @!attribute [rw] start_time
|
6860
|
+
# The time that the resource scan was started.
|
6861
|
+
# @return [Time]
|
6862
|
+
#
|
6863
|
+
# @!attribute [rw] end_time
|
6864
|
+
# The time that the resource scan was finished.
|
6865
|
+
# @return [Time]
|
6866
|
+
#
|
6867
|
+
# @!attribute [rw] percentage_completed
|
6868
|
+
# The percentage of the resource scan that has been completed.
|
6869
|
+
# @return [Float]
|
6870
|
+
#
|
6871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanSummary AWS API Documentation
|
6872
|
+
#
|
6873
|
+
class ResourceScanSummary < Struct.new(
|
6874
|
+
:resource_scan_id,
|
6875
|
+
:status,
|
6876
|
+
:status_reason,
|
6877
|
+
:start_time,
|
6878
|
+
:end_time,
|
6879
|
+
:percentage_completed)
|
6880
|
+
SENSITIVE = []
|
6881
|
+
include Aws::Structure
|
6882
|
+
end
|
6883
|
+
|
6143
6884
|
# The field that CloudFormation will change, such as the name of a
|
6144
6885
|
# resource's property, and whether the resource will be recreated.
|
6145
6886
|
#
|
@@ -6360,6 +7101,89 @@ module Aws::CloudFormation
|
|
6360
7101
|
include Aws::Structure
|
6361
7102
|
end
|
6362
7103
|
|
7104
|
+
# A scanned resource returned by `ListResourceScanResources` or
|
7105
|
+
# `ListResourceScanRelatedResources`.
|
7106
|
+
#
|
7107
|
+
# @!attribute [rw] resource_type
|
7108
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
7109
|
+
# list of supported resources, see [IaC generator supported resource
|
7110
|
+
# types][1] In the *CloudFormation User Guide*
|
7111
|
+
#
|
7112
|
+
#
|
7113
|
+
#
|
7114
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html
|
7115
|
+
# @return [String]
|
7116
|
+
#
|
7117
|
+
# @!attribute [rw] resource_identifier
|
7118
|
+
# A list of up to 256 key-value pairs that identifies for the scanned
|
7119
|
+
# resource. The key is the name of one of the primary identifiers for
|
7120
|
+
# the resource. (Primary identifiers are specified in the
|
7121
|
+
# `primaryIdentifier` list in the resource schema.) The value is the
|
7122
|
+
# value of that primary identifier. For example, for a
|
7123
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
7124
|
+
# `TableName` so the key-value pair could be `"TableName":
|
7125
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
7126
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
7127
|
+
# development*.
|
7128
|
+
#
|
7129
|
+
#
|
7130
|
+
#
|
7131
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
7132
|
+
# @return [Hash<String,String>]
|
7133
|
+
#
|
7134
|
+
# @!attribute [rw] managed_by_stack
|
7135
|
+
# If `true`, the resource is managed by a CloudFormation stack.
|
7136
|
+
# @return [Boolean]
|
7137
|
+
#
|
7138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ScannedResource AWS API Documentation
|
7139
|
+
#
|
7140
|
+
class ScannedResource < Struct.new(
|
7141
|
+
:resource_type,
|
7142
|
+
:resource_identifier,
|
7143
|
+
:managed_by_stack)
|
7144
|
+
SENSITIVE = []
|
7145
|
+
include Aws::Structure
|
7146
|
+
end
|
7147
|
+
|
7148
|
+
# Identifies a scanned resource. This is used with the
|
7149
|
+
# `ListResourceScanRelatedResources` API action.
|
7150
|
+
#
|
7151
|
+
# @!attribute [rw] resource_type
|
7152
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
7153
|
+
# list of supported resources, see [IaC generator supported resource
|
7154
|
+
# types][1] In the *CloudFormation User Guide*
|
7155
|
+
#
|
7156
|
+
#
|
7157
|
+
#
|
7158
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-supported-resources.html
|
7159
|
+
# @return [String]
|
7160
|
+
#
|
7161
|
+
# @!attribute [rw] resource_identifier
|
7162
|
+
# A list of up to 256 key-value pairs that identifies the scanned
|
7163
|
+
# resource. The key is the name of one of the primary identifiers for
|
7164
|
+
# the resource. (Primary identifiers are specified in the
|
7165
|
+
# `primaryIdentifier` list in the resource schema.) The value is the
|
7166
|
+
# value of that primary identifier. For example, for a
|
7167
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
7168
|
+
# `TableName` so the key-value pair could be `"TableName":
|
7169
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
7170
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
7171
|
+
# development*.
|
7172
|
+
#
|
7173
|
+
#
|
7174
|
+
#
|
7175
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
7176
|
+
# @return [Hash<String,String>]
|
7177
|
+
#
|
7178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ScannedResourceIdentifier AWS API Documentation
|
7179
|
+
#
|
7180
|
+
class ScannedResourceIdentifier < Struct.new(
|
7181
|
+
:resource_type,
|
7182
|
+
:resource_identifier)
|
7183
|
+
SENSITIVE = []
|
7184
|
+
include Aws::Structure
|
7185
|
+
end
|
7186
|
+
|
6363
7187
|
# The input for the SetStackPolicy action.
|
6364
7188
|
#
|
6365
7189
|
# @!attribute [rw] stack_name
|
@@ -8206,6 +9030,10 @@ module Aws::CloudFormation
|
|
8206
9030
|
# @!attribute [rw] region_order
|
8207
9031
|
# The order of the Regions where you want to perform the stack
|
8208
9032
|
# operation.
|
9033
|
+
#
|
9034
|
+
# <note markdown="1"> `RegionOrder` isn't followed if `AutoDeployment` is enabled.
|
9035
|
+
#
|
9036
|
+
# </note>
|
8209
9037
|
# @return [Array<String>]
|
8210
9038
|
#
|
8211
9039
|
# @!attribute [rw] failure_tolerance_count
|
@@ -8687,6 +9515,36 @@ module Aws::CloudFormation
|
|
8687
9515
|
#
|
8688
9516
|
class StaleRequestException < Aws::EmptyStructure; end
|
8689
9517
|
|
9518
|
+
# @!attribute [rw] client_request_token
|
9519
|
+
# A unique identifier for this `StartResourceScan` request. Specify
|
9520
|
+
# this token if you plan to retry requests so that CloudFormation
|
9521
|
+
# knows that you're not attempting to start a new resource scan.
|
9522
|
+
# @return [String]
|
9523
|
+
#
|
9524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StartResourceScanInput AWS API Documentation
|
9525
|
+
#
|
9526
|
+
class StartResourceScanInput < Struct.new(
|
9527
|
+
:client_request_token)
|
9528
|
+
SENSITIVE = []
|
9529
|
+
include Aws::Structure
|
9530
|
+
end
|
9531
|
+
|
9532
|
+
# @!attribute [rw] resource_scan_id
|
9533
|
+
# The Amazon Resource Name (ARN) of the resource scan. The format is
|
9534
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}`.
|
9535
|
+
# An example is
|
9536
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
|
9537
|
+
# `.
|
9538
|
+
# @return [String]
|
9539
|
+
#
|
9540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StartResourceScanOutput AWS API Documentation
|
9541
|
+
#
|
9542
|
+
class StartResourceScanOutput < Struct.new(
|
9543
|
+
:resource_scan_id)
|
9544
|
+
SENSITIVE = []
|
9545
|
+
include Aws::Structure
|
9546
|
+
end
|
9547
|
+
|
8690
9548
|
# @!attribute [rw] stack_set_name
|
8691
9549
|
# The name or unique ID of the stack set that you want to stop the
|
8692
9550
|
# operation for.
|
@@ -8756,6 +9614,51 @@ module Aws::CloudFormation
|
|
8756
9614
|
include Aws::Structure
|
8757
9615
|
end
|
8758
9616
|
|
9617
|
+
# The configuration details of a generated template.
|
9618
|
+
#
|
9619
|
+
# @!attribute [rw] deletion_policy
|
9620
|
+
# The `DeletionPolicy` assigned to resources in the generated
|
9621
|
+
# template. Supported values are:
|
9622
|
+
#
|
9623
|
+
# * `DELETE` - delete all resources when the stack is deleted.
|
9624
|
+
#
|
9625
|
+
# * `RETAIN` - retain all resources when the stack is deleted.
|
9626
|
+
#
|
9627
|
+
# For more information, see [ `DeletionPolicy` attribute][1] in the
|
9628
|
+
# *CloudFormation User Guide*.
|
9629
|
+
#
|
9630
|
+
#
|
9631
|
+
#
|
9632
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html
|
9633
|
+
# @return [String]
|
9634
|
+
#
|
9635
|
+
# @!attribute [rw] update_replace_policy
|
9636
|
+
# The `UpdateReplacePolicy` assigned to resources in the generated
|
9637
|
+
# template. Supported values are:
|
9638
|
+
#
|
9639
|
+
# * `DELETE` - delete all resources when the resource is replaced
|
9640
|
+
# during an update operation.
|
9641
|
+
#
|
9642
|
+
# * `RETAIN` - retain all resources when the resource is replaced
|
9643
|
+
# during an update operation.
|
9644
|
+
#
|
9645
|
+
# For more information, see [ `UpdateReplacePolicy` attribute][1] in
|
9646
|
+
# the *CloudFormation User Guide*.
|
9647
|
+
#
|
9648
|
+
#
|
9649
|
+
#
|
9650
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html
|
9651
|
+
# @return [String]
|
9652
|
+
#
|
9653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TemplateConfiguration AWS API Documentation
|
9654
|
+
#
|
9655
|
+
class TemplateConfiguration < Struct.new(
|
9656
|
+
:deletion_policy,
|
9657
|
+
:update_replace_policy)
|
9658
|
+
SENSITIVE = []
|
9659
|
+
include Aws::Structure
|
9660
|
+
end
|
9661
|
+
|
8759
9662
|
# The TemplateParameter data type.
|
8760
9663
|
#
|
8761
9664
|
# @!attribute [rw] parameter_key
|
@@ -8786,6 +9689,104 @@ module Aws::CloudFormation
|
|
8786
9689
|
include Aws::Structure
|
8787
9690
|
end
|
8788
9691
|
|
9692
|
+
# A summary of the progress of the template generation.
|
9693
|
+
#
|
9694
|
+
# @!attribute [rw] resources_succeeded
|
9695
|
+
# The number of resources that succeeded the template generation.
|
9696
|
+
# @return [Integer]
|
9697
|
+
#
|
9698
|
+
# @!attribute [rw] resources_failed
|
9699
|
+
# The number of resources that failed the template generation.
|
9700
|
+
# @return [Integer]
|
9701
|
+
#
|
9702
|
+
# @!attribute [rw] resources_processing
|
9703
|
+
# The number of resources that are in-process for the template
|
9704
|
+
# generation.
|
9705
|
+
# @return [Integer]
|
9706
|
+
#
|
9707
|
+
# @!attribute [rw] resources_pending
|
9708
|
+
# The number of resources that are still pending the template
|
9709
|
+
# generation.
|
9710
|
+
# @return [Integer]
|
9711
|
+
#
|
9712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TemplateProgress AWS API Documentation
|
9713
|
+
#
|
9714
|
+
class TemplateProgress < Struct.new(
|
9715
|
+
:resources_succeeded,
|
9716
|
+
:resources_failed,
|
9717
|
+
:resources_processing,
|
9718
|
+
:resources_pending)
|
9719
|
+
SENSITIVE = []
|
9720
|
+
include Aws::Structure
|
9721
|
+
end
|
9722
|
+
|
9723
|
+
# The summary of a generated template.
|
9724
|
+
#
|
9725
|
+
# @!attribute [rw] generated_template_id
|
9726
|
+
# The Amazon Resource Name (ARN) of the generated template. The format
|
9727
|
+
# is
|
9728
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
9729
|
+
# For example,
|
9730
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
9731
|
+
# `.
|
9732
|
+
# @return [String]
|
9733
|
+
#
|
9734
|
+
# @!attribute [rw] generated_template_name
|
9735
|
+
# The name of the generated template.
|
9736
|
+
# @return [String]
|
9737
|
+
#
|
9738
|
+
# @!attribute [rw] status
|
9739
|
+
# The status of the template generation. Supported values are:
|
9740
|
+
#
|
9741
|
+
# * `CreatePending` - the creation of the template is pending.
|
9742
|
+
#
|
9743
|
+
# * `CreateInProgress` - the creation of the template is in progress.
|
9744
|
+
#
|
9745
|
+
# * `DeletePending` - the deletion of the template is pending.
|
9746
|
+
#
|
9747
|
+
# * `DeleteInProgress` - the deletion of the template is in progress.
|
9748
|
+
#
|
9749
|
+
# * `UpdatePending` - the update of the template is pending.
|
9750
|
+
#
|
9751
|
+
# * `UpdateInProgress` - the update of the template is in progress.
|
9752
|
+
#
|
9753
|
+
# * `Failed` - the template operation failed.
|
9754
|
+
#
|
9755
|
+
# * `Complete` - the template operation is complete.
|
9756
|
+
# @return [String]
|
9757
|
+
#
|
9758
|
+
# @!attribute [rw] status_reason
|
9759
|
+
# The reason for the current template generation status. This will
|
9760
|
+
# provide more details if a failure happened.
|
9761
|
+
# @return [String]
|
9762
|
+
#
|
9763
|
+
# @!attribute [rw] creation_time
|
9764
|
+
# The time the generated template was created.
|
9765
|
+
# @return [Time]
|
9766
|
+
#
|
9767
|
+
# @!attribute [rw] last_updated_time
|
9768
|
+
# The time the generated template was last updated.
|
9769
|
+
# @return [Time]
|
9770
|
+
#
|
9771
|
+
# @!attribute [rw] number_of_resources
|
9772
|
+
# The number of resources in the generated template. This is a total
|
9773
|
+
# of resources in pending, in-progress, completed, and failed states.
|
9774
|
+
# @return [Integer]
|
9775
|
+
#
|
9776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TemplateSummary AWS API Documentation
|
9777
|
+
#
|
9778
|
+
class TemplateSummary < Struct.new(
|
9779
|
+
:generated_template_id,
|
9780
|
+
:generated_template_name,
|
9781
|
+
:status,
|
9782
|
+
:status_reason,
|
9783
|
+
:creation_time,
|
9784
|
+
:last_updated_time,
|
9785
|
+
:number_of_resources)
|
9786
|
+
SENSITIVE = []
|
9787
|
+
include Aws::Structure
|
9788
|
+
end
|
9789
|
+
|
8789
9790
|
# Options for the `GetTemplateSummary` API action.
|
8790
9791
|
#
|
8791
9792
|
# @!attribute [rw] treat_unrecognized_resource_types_as_warnings
|
@@ -9295,6 +10296,66 @@ module Aws::CloudFormation
|
|
9295
10296
|
include Aws::Structure
|
9296
10297
|
end
|
9297
10298
|
|
10299
|
+
# @!attribute [rw] generated_template_name
|
10300
|
+
# The name or Amazon Resource Name (ARN) of a generated template.
|
10301
|
+
# @return [String]
|
10302
|
+
#
|
10303
|
+
# @!attribute [rw] new_generated_template_name
|
10304
|
+
# An optional new name to assign to the generated template.
|
10305
|
+
# @return [String]
|
10306
|
+
#
|
10307
|
+
# @!attribute [rw] add_resources
|
10308
|
+
# An optional list of resources to be added to the generated template.
|
10309
|
+
# @return [Array<Types::ResourceDefinition>]
|
10310
|
+
#
|
10311
|
+
# @!attribute [rw] remove_resources
|
10312
|
+
# A list of logical ids for resources to remove from the generated
|
10313
|
+
# template.
|
10314
|
+
# @return [Array<String>]
|
10315
|
+
#
|
10316
|
+
# @!attribute [rw] refresh_all_resources
|
10317
|
+
# If `true`, update the resource properties in the generated template
|
10318
|
+
# with their current live state. This feature is useful when the
|
10319
|
+
# resource properties in your generated a template does not reflect
|
10320
|
+
# the live state of the resource properties. This happens when a user
|
10321
|
+
# update the resource properties after generating a template.
|
10322
|
+
# @return [Boolean]
|
10323
|
+
#
|
10324
|
+
# @!attribute [rw] template_configuration
|
10325
|
+
# The configuration details of the generated template, including the
|
10326
|
+
# `DeletionPolicy` and `UpdateReplacePolicy`.
|
10327
|
+
# @return [Types::TemplateConfiguration]
|
10328
|
+
#
|
10329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateGeneratedTemplateInput AWS API Documentation
|
10330
|
+
#
|
10331
|
+
class UpdateGeneratedTemplateInput < Struct.new(
|
10332
|
+
:generated_template_name,
|
10333
|
+
:new_generated_template_name,
|
10334
|
+
:add_resources,
|
10335
|
+
:remove_resources,
|
10336
|
+
:refresh_all_resources,
|
10337
|
+
:template_configuration)
|
10338
|
+
SENSITIVE = []
|
10339
|
+
include Aws::Structure
|
10340
|
+
end
|
10341
|
+
|
10342
|
+
# @!attribute [rw] generated_template_id
|
10343
|
+
# The Amazon Resource Name (ARN) of the generated template. The format
|
10344
|
+
# is
|
10345
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
10346
|
+
# For example,
|
10347
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
10348
|
+
# `.
|
10349
|
+
# @return [String]
|
10350
|
+
#
|
10351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateGeneratedTemplateOutput AWS API Documentation
|
10352
|
+
#
|
10353
|
+
class UpdateGeneratedTemplateOutput < Struct.new(
|
10354
|
+
:generated_template_id)
|
10355
|
+
SENSITIVE = []
|
10356
|
+
include Aws::Structure
|
10357
|
+
end
|
10358
|
+
|
9298
10359
|
# The input for an UpdateStack action.
|
9299
10360
|
#
|
9300
10361
|
# @!attribute [rw] stack_name
|
@@ -10265,6 +11326,81 @@ module Aws::CloudFormation
|
|
10265
11326
|
include Aws::Structure
|
10266
11327
|
end
|
10267
11328
|
|
11329
|
+
# The warnings generated for a specific resource for this generated
|
11330
|
+
# template.
|
11331
|
+
#
|
11332
|
+
# @!attribute [rw] type
|
11333
|
+
# The type of this warning. For more information, see [IaC generator
|
11334
|
+
# and write-only properties][1] in the *CloudFormation User Guide*.
|
11335
|
+
#
|
11336
|
+
# * `MUTUALLY_EXCLUSIVE_PROPERTIES` - The resource requires
|
11337
|
+
# mutually-exclusive write-only properties. The IaC generator
|
11338
|
+
# selects one set of mutually exclusive properties and converts the
|
11339
|
+
# included properties into parameters. The parameter names have a
|
11340
|
+
# suffix `OneOf` and the parameter descriptions indicate that the
|
11341
|
+
# corresponding property can be replaced with other exclusive
|
11342
|
+
# properties.
|
11343
|
+
#
|
11344
|
+
# * `UNSUPPORTED_PROPERTIES` - Unsupported properties are present in
|
11345
|
+
# the resource. One example of unsupported properties would be a
|
11346
|
+
# required write-only property that is an array, because a parameter
|
11347
|
+
# cannot be an array. Another example is an optional write-only
|
11348
|
+
# property.
|
11349
|
+
#
|
11350
|
+
# * `MUTUALLY_EXCLUSIVE_TYPES` - One or more required write-only
|
11351
|
+
# properties are found in the resource, and the type of that
|
11352
|
+
# property can be any of several types.
|
11353
|
+
#
|
11354
|
+
# <note markdown="1"> Currently the resource and property reference documentation does not
|
11355
|
+
# indicate if a property uses a type of `oneOf` or `anyOf`. You need
|
11356
|
+
# to look at the resource provider schema.
|
11357
|
+
#
|
11358
|
+
# </note>
|
11359
|
+
#
|
11360
|
+
#
|
11361
|
+
#
|
11362
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html
|
11363
|
+
# @return [String]
|
11364
|
+
#
|
11365
|
+
# @!attribute [rw] properties
|
11366
|
+
# The properties of the resource that are impacted by this warning.
|
11367
|
+
# @return [Array<Types::WarningProperty>]
|
11368
|
+
#
|
11369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/WarningDetail AWS API Documentation
|
11370
|
+
#
|
11371
|
+
class WarningDetail < Struct.new(
|
11372
|
+
:type,
|
11373
|
+
:properties)
|
11374
|
+
SENSITIVE = []
|
11375
|
+
include Aws::Structure
|
11376
|
+
end
|
11377
|
+
|
11378
|
+
# A specific property that is impacted by a warning.
|
11379
|
+
#
|
11380
|
+
# @!attribute [rw] property_path
|
11381
|
+
# The path of the property. For example, if this is for the `S3Bucket`
|
11382
|
+
# member of the `Code` property, the property path would be
|
11383
|
+
# `Code/S3Bucket`.
|
11384
|
+
# @return [String]
|
11385
|
+
#
|
11386
|
+
# @!attribute [rw] required
|
11387
|
+
# If `true`, the specified property is required.
|
11388
|
+
# @return [Boolean]
|
11389
|
+
#
|
11390
|
+
# @!attribute [rw] description
|
11391
|
+
# The description of the property from the resource provider schema.
|
11392
|
+
# @return [String]
|
11393
|
+
#
|
11394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/WarningProperty AWS API Documentation
|
11395
|
+
#
|
11396
|
+
class WarningProperty < Struct.new(
|
11397
|
+
:property_path,
|
11398
|
+
:required,
|
11399
|
+
:description)
|
11400
|
+
SENSITIVE = []
|
11401
|
+
include Aws::Structure
|
11402
|
+
end
|
11403
|
+
|
10268
11404
|
# Contains any warnings returned by the `GetTemplateSummary` API action.
|
10269
11405
|
#
|
10270
11406
|
# @!attribute [rw] unrecognized_resource_types
|