aws-sdk-cloudformation 1.98.0 → 1.100.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +1142 -112
- data/lib/aws-sdk-cloudformation/client_api.rb +406 -0
- data/lib/aws-sdk-cloudformation/endpoints.rb +154 -0
- data/lib/aws-sdk-cloudformation/errors.rb +55 -0
- data/lib/aws-sdk-cloudformation/event.rb +24 -0
- data/lib/aws-sdk-cloudformation/plugins/endpoints.rb +22 -0
- data/lib/aws-sdk-cloudformation/resource.rb +16 -14
- data/lib/aws-sdk-cloudformation/stack.rb +49 -28
- data/lib/aws-sdk-cloudformation/types.rb +1372 -169
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/client.rbs +172 -0
- data/sig/errors.rbs +10 -0
- data/sig/event.rbs +3 -0
- data/sig/stack.rbs +3 -0
- data/sig/types.rbs +244 -1
- metadata +2 -2
@@ -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
|
@@ -728,7 +737,8 @@ module Aws::CloudFormation
|
|
728
737
|
# must point to a template (max size: 460,800 bytes) that's located
|
729
738
|
# in an Amazon S3 bucket or a Systems Manager document. CloudFormation
|
730
739
|
# generates the change set by comparing this template with the stack
|
731
|
-
# that you specified.
|
740
|
+
# that you specified. The location for an Amazon S3 bucket must start
|
741
|
+
# with `https://`.
|
732
742
|
#
|
733
743
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
734
744
|
# @return [String]
|
@@ -771,19 +781,19 @@ module Aws::CloudFormation
|
|
771
781
|
# you review all permissions associated with them and edit their
|
772
782
|
# permissions if necessary.
|
773
783
|
#
|
774
|
-
# * [ AWS::IAM::AccessKey][1]
|
784
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
775
785
|
#
|
776
|
-
# * [ AWS::IAM::Group][2]
|
786
|
+
# * [ `AWS::IAM::Group` ][2]
|
777
787
|
#
|
778
|
-
# * [AWS::IAM::InstanceProfile][3]
|
788
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
779
789
|
#
|
780
|
-
# * [ AWS::IAM::Policy][4]
|
790
|
+
# * [ `AWS::IAM::Policy` ][4]
|
781
791
|
#
|
782
|
-
# * [ AWS::IAM::Role][5]
|
792
|
+
# * [ `AWS::IAM::Role` ][5]
|
783
793
|
#
|
784
|
-
# * [ AWS::IAM::User][6]
|
794
|
+
# * [ `AWS::IAM::User` ][6]
|
785
795
|
#
|
786
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
796
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
787
797
|
#
|
788
798
|
# For more information, see [Acknowledging IAM resources in
|
789
799
|
# CloudFormation templates][8].
|
@@ -799,9 +809,9 @@ module Aws::CloudFormation
|
|
799
809
|
# your stack template contains one or more macros, and you choose to
|
800
810
|
# create a stack directly from the processed template, without first
|
801
811
|
# reviewing the resulting changes in a change set, you must
|
802
|
-
# acknowledge this capability. This includes the [AWS::Include
|
803
|
-
# and [AWS::Serverless][10] transforms, which are macros
|
804
|
-
# CloudFormation.
|
812
|
+
# acknowledge this capability. This includes the [ `AWS::Include`
|
813
|
+
# ][9] and [ `AWS::Serverless` ][10] transforms, which are macros
|
814
|
+
# hosted by CloudFormation.
|
805
815
|
#
|
806
816
|
# <note markdown="1"> This capacity doesn't apply to creating change sets, and
|
807
817
|
# specifying it when creating change sets has no effect.
|
@@ -947,8 +957,8 @@ module Aws::CloudFormation
|
|
947
957
|
# @!attribute [rw] on_stack_failure
|
948
958
|
# Determines what action will be taken if stack creation fails. If
|
949
959
|
# this parameter is specified, the `DisableRollback` parameter to the
|
950
|
-
# [ExecuteChangeSet][1] API operation must not be specified. This
|
951
|
-
# be one of these values:
|
960
|
+
# [ `ExecuteChangeSet` ][1] API operation must not be specified. This
|
961
|
+
# must be one of these values:
|
952
962
|
#
|
953
963
|
# * `DELETE` - Deletes the change set if the stack creation fails.
|
954
964
|
# This is only valid when the `ChangeSetType` parameter is set to
|
@@ -957,11 +967,11 @@ module Aws::CloudFormation
|
|
957
967
|
#
|
958
968
|
# * `DO_NOTHING` - if the stack creation fails, do nothing. This is
|
959
969
|
# equivalent to specifying `true` for the `DisableRollback`
|
960
|
-
# parameter to the [ExecuteChangeSet][1] API operation.
|
970
|
+
# parameter to the [ `ExecuteChangeSet` ][1] API operation.
|
961
971
|
#
|
962
972
|
# * `ROLLBACK` - if the stack creation fails, roll back the stack.
|
963
973
|
# This is equivalent to specifying `false` for the `DisableRollback`
|
964
|
-
# parameter to the [ExecuteChangeSet][1] API operation.
|
974
|
+
# parameter to the [ `ExecuteChangeSet` ][1] API operation.
|
965
975
|
#
|
966
976
|
# For nested stacks, when the `OnStackFailure` parameter is set to
|
967
977
|
# `DELETE` for the change set for the parent stack, any failure in a
|
@@ -1036,6 +1046,52 @@ module Aws::CloudFormation
|
|
1036
1046
|
include Aws::Structure
|
1037
1047
|
end
|
1038
1048
|
|
1049
|
+
# @!attribute [rw] resources
|
1050
|
+
# An optional list of resources to be included in the generated
|
1051
|
+
# template.
|
1052
|
+
#
|
1053
|
+
# If no resources are specified,the template will be created without
|
1054
|
+
# any resources. Resources can be added to the template using the
|
1055
|
+
# `UpdateGeneratedTemplate` API action.
|
1056
|
+
# @return [Array<Types::ResourceDefinition>]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] generated_template_name
|
1059
|
+
# The name assigned to the generated template.
|
1060
|
+
# @return [String]
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] stack_name
|
1063
|
+
# An optional name or ARN of a stack to use as the base stack for the
|
1064
|
+
# generated template.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] template_configuration
|
1068
|
+
# The configuration details of the generated template, including the
|
1069
|
+
# `DeletionPolicy` and `UpdateReplacePolicy`.
|
1070
|
+
# @return [Types::TemplateConfiguration]
|
1071
|
+
#
|
1072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateGeneratedTemplateInput AWS API Documentation
|
1073
|
+
#
|
1074
|
+
class CreateGeneratedTemplateInput < Struct.new(
|
1075
|
+
:resources,
|
1076
|
+
:generated_template_name,
|
1077
|
+
:stack_name,
|
1078
|
+
:template_configuration)
|
1079
|
+
SENSITIVE = []
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# @!attribute [rw] generated_template_id
|
1084
|
+
# The ID of the generated template.
|
1085
|
+
# @return [String]
|
1086
|
+
#
|
1087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateGeneratedTemplateOutput AWS API Documentation
|
1088
|
+
#
|
1089
|
+
class CreateGeneratedTemplateOutput < Struct.new(
|
1090
|
+
:generated_template_id)
|
1091
|
+
SENSITIVE = []
|
1092
|
+
include Aws::Structure
|
1093
|
+
end
|
1094
|
+
|
1039
1095
|
# The input for CreateStack action.
|
1040
1096
|
#
|
1041
1097
|
# @!attribute [rw] stack_name
|
@@ -1066,7 +1122,8 @@ module Aws::CloudFormation
|
|
1066
1122
|
# Location of file containing the template body. The URL must point to
|
1067
1123
|
# a template (max size: 460,800 bytes) that's located in an Amazon S3
|
1068
1124
|
# bucket or a Systems Manager document. For more information, go to
|
1069
|
-
# the [Template anatomy][1] in the *CloudFormation User Guide*.
|
1125
|
+
# the [Template anatomy][1] in the *CloudFormation User Guide*. The
|
1126
|
+
# location for an Amazon S3 bucket must start with `https://`.
|
1070
1127
|
#
|
1071
1128
|
# Conditional: You must specify either the `TemplateBody` or the
|
1072
1129
|
# `TemplateURL` parameter, but not both.
|
@@ -1078,7 +1135,8 @@ module Aws::CloudFormation
|
|
1078
1135
|
#
|
1079
1136
|
# @!attribute [rw] parameters
|
1080
1137
|
# A list of `Parameter` structures that specify input parameters for
|
1081
|
-
# the stack. For more information, see the [Parameter][1] data
|
1138
|
+
# the stack. For more information, see the [ `Parameter` ][1] data
|
1139
|
+
# type.
|
1082
1140
|
#
|
1083
1141
|
#
|
1084
1142
|
#
|
@@ -1101,7 +1159,7 @@ module Aws::CloudFormation
|
|
1101
1159
|
#
|
1102
1160
|
# @!attribute [rw] timeout_in_minutes
|
1103
1161
|
# The amount of time that can pass before the stack status becomes
|
1104
|
-
#
|
1162
|
+
# `CREATE_FAILED`; if `DisableRollback` is not set or is set to
|
1105
1163
|
# `false`, the stack will be rolled back.
|
1106
1164
|
# @return [Integer]
|
1107
1165
|
#
|
@@ -1140,19 +1198,19 @@ module Aws::CloudFormation
|
|
1140
1198
|
# you review all permissions associated with them and edit their
|
1141
1199
|
# permissions if necessary.
|
1142
1200
|
#
|
1143
|
-
# * [ AWS::IAM::AccessKey][1]
|
1201
|
+
# * [ `AWS::IAM::AccessKey` AWS::IAM::AccessKey][1]
|
1144
1202
|
#
|
1145
|
-
# * [ AWS::IAM::Group][2]
|
1203
|
+
# * [ `AWS::IAM::Group` ][2]
|
1146
1204
|
#
|
1147
|
-
# * [AWS::IAM::InstanceProfile][3]
|
1205
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
1148
1206
|
#
|
1149
|
-
# * [ AWS::IAM::Policy][4]
|
1207
|
+
# * [ `AWS::IAM::Policy` ][4]
|
1150
1208
|
#
|
1151
|
-
# * [ AWS::IAM::Role][5]
|
1209
|
+
# * [ `AWS::IAM::Role` ][5]
|
1152
1210
|
#
|
1153
|
-
# * [ AWS::IAM::User][6]
|
1211
|
+
# * [ `AWS::IAM::User` ][6]
|
1154
1212
|
#
|
1155
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
1213
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
1156
1214
|
#
|
1157
1215
|
# For more information, see [Acknowledging IAM Resources in
|
1158
1216
|
# CloudFormation Templates][8].
|
@@ -1168,9 +1226,9 @@ module Aws::CloudFormation
|
|
1168
1226
|
# your stack template contains one or more macros, and you choose to
|
1169
1227
|
# create a stack directly from the processed template, without first
|
1170
1228
|
# reviewing the resulting changes in a change set, you must
|
1171
|
-
# acknowledge this capability. This includes the [AWS::Include
|
1172
|
-
# and [AWS::Serverless][10] transforms, which are macros
|
1173
|
-
# CloudFormation.
|
1229
|
+
# acknowledge this capability. This includes the [ `AWS::Include`
|
1230
|
+
# ][9] and [ `AWS::Serverless` ][10] transforms, which are macros
|
1231
|
+
# hosted by CloudFormation.
|
1174
1232
|
#
|
1175
1233
|
# If you want to create a stack from a stack template that contains
|
1176
1234
|
# macros *and* nested stacks, you must create the stack directly
|
@@ -1274,8 +1332,9 @@ module Aws::CloudFormation
|
|
1274
1332
|
# @!attribute [rw] stack_policy_url
|
1275
1333
|
# Location of a file containing the stack policy. The URL must point
|
1276
1334
|
# to a policy (maximum size: 16 KB) located in an S3 bucket in the
|
1277
|
-
# same Region as the stack.
|
1278
|
-
# `
|
1335
|
+
# same Region as the stack. The location for an Amazon S3 bucket must
|
1336
|
+
# start with `https://`. You can specify either the `StackPolicyBody`
|
1337
|
+
# or the `StackPolicyURL` parameter, but not both.
|
1279
1338
|
# @return [String]
|
1280
1339
|
#
|
1281
1340
|
# @!attribute [rw] tags
|
@@ -1411,8 +1470,8 @@ module Aws::CloudFormation
|
|
1411
1470
|
# stack instance aren't updated, but retain their overridden value.
|
1412
1471
|
#
|
1413
1472
|
# You can only override the parameter *values* that are specified in
|
1414
|
-
# the stack set; to add or delete a parameter itself, use
|
1415
|
-
#
|
1473
|
+
# the stack set; to add or delete a parameter itself, use [
|
1474
|
+
# `UpdateStackSet` ][1] to update the stack set template.
|
1416
1475
|
#
|
1417
1476
|
#
|
1418
1477
|
#
|
@@ -1589,19 +1648,19 @@ module Aws::CloudFormation
|
|
1589
1648
|
# you review all permissions associated with them and edit their
|
1590
1649
|
# permissions if necessary.
|
1591
1650
|
#
|
1592
|
-
# * [ AWS::IAM::AccessKey][1]
|
1651
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
1593
1652
|
#
|
1594
|
-
# * [ AWS::IAM::Group][2]
|
1653
|
+
# * [ `AWS::IAM::Group` ][2]
|
1595
1654
|
#
|
1596
|
-
# * [AWS::IAM::InstanceProfile][3]
|
1655
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
1597
1656
|
#
|
1598
|
-
# * [ AWS::IAM::Policy][4]
|
1657
|
+
# * [ `AWS::IAM::Policy` ][4]
|
1599
1658
|
#
|
1600
|
-
# * [ AWS::IAM::Role][5]
|
1659
|
+
# * [ `AWS::IAM::Role` ][5]
|
1601
1660
|
#
|
1602
|
-
# * [ AWS::IAM::User][6]
|
1661
|
+
# * [ `AWS::IAM::User` ][6]
|
1603
1662
|
#
|
1604
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
1663
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
1605
1664
|
#
|
1606
1665
|
# For more information, see [Acknowledging IAM Resources in
|
1607
1666
|
# CloudFormation Templates][8].
|
@@ -1617,11 +1676,11 @@ module Aws::CloudFormation
|
|
1617
1676
|
# Processing on Templates][9].
|
1618
1677
|
#
|
1619
1678
|
# Stack sets with service-managed permissions don't currently
|
1620
|
-
# support the use of macros in templates. (This includes the
|
1621
|
-
#
|
1622
|
-
# macros hosted by CloudFormation.) Even if you specify
|
1623
|
-
# capability for a stack set with service-managed permissions,
|
1624
|
-
# you reference a macro in your template the stack set operation
|
1679
|
+
# support the use of macros in templates. (This includes the [
|
1680
|
+
# `AWS::Include` ][10] and [ `AWS::Serverless` ][11] transforms,
|
1681
|
+
# which are macros hosted by CloudFormation.) Even if you specify
|
1682
|
+
# this capability for a stack set with service-managed permissions,
|
1683
|
+
# if you reference a macro in your template the stack set operation
|
1625
1684
|
# will fail.
|
1626
1685
|
#
|
1627
1686
|
#
|
@@ -1867,6 +1926,18 @@ module Aws::CloudFormation
|
|
1867
1926
|
#
|
1868
1927
|
class DeleteChangeSetOutput < Aws::EmptyStructure; end
|
1869
1928
|
|
1929
|
+
# @!attribute [rw] generated_template_name
|
1930
|
+
# The name or Amazon Resource Name (ARN) of a generated template.
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteGeneratedTemplateInput AWS API Documentation
|
1934
|
+
#
|
1935
|
+
class DeleteGeneratedTemplateInput < Struct.new(
|
1936
|
+
:generated_template_name)
|
1937
|
+
SENSITIVE = []
|
1938
|
+
include Aws::Structure
|
1939
|
+
end
|
1940
|
+
|
1870
1941
|
# The input for DeleteStack action.
|
1871
1942
|
#
|
1872
1943
|
# @!attribute [rw] stack_name
|
@@ -2345,7 +2416,7 @@ module Aws::CloudFormation
|
|
2345
2416
|
# @!attribute [rw] parameters
|
2346
2417
|
# A list of `Parameter` structures that describes the input parameters
|
2347
2418
|
# and their values used to create the change set. For more
|
2348
|
-
# information, see the [Parameter][1] data type.
|
2419
|
+
# information, see the [ `Parameter` ][1] data type.
|
2349
2420
|
#
|
2350
2421
|
#
|
2351
2422
|
#
|
@@ -2424,8 +2495,8 @@ module Aws::CloudFormation
|
|
2424
2495
|
# @!attribute [rw] on_stack_failure
|
2425
2496
|
# Determines what action will be taken if stack creation fails. When
|
2426
2497
|
# this parameter is specified, the `DisableRollback` parameter to the
|
2427
|
-
# [ExecuteChangeSet][1] API operation must not be specified. This
|
2428
|
-
# be one of these values:
|
2498
|
+
# [ `ExecuteChangeSet` ][1] API operation must not be specified. This
|
2499
|
+
# must be one of these values:
|
2429
2500
|
#
|
2430
2501
|
# * `DELETE` - Deletes the change set if the stack creation fails.
|
2431
2502
|
# This is only valid when the `ChangeSetType` parameter is set to
|
@@ -2434,11 +2505,11 @@ module Aws::CloudFormation
|
|
2434
2505
|
#
|
2435
2506
|
# * `DO_NOTHING` - if the stack creation fails, do nothing. This is
|
2436
2507
|
# equivalent to specifying `true` for the `DisableRollback`
|
2437
|
-
# parameter to the [ExecuteChangeSet][1] API operation.
|
2508
|
+
# parameter to the [ `ExecuteChangeSet` ][1] API operation.
|
2438
2509
|
#
|
2439
2510
|
# * `ROLLBACK` - if the stack creation fails, roll back the stack.
|
2440
2511
|
# This is equivalent to specifying `false` for the `DisableRollback`
|
2441
|
-
# parameter to the [ExecuteChangeSet][1] API operation.
|
2512
|
+
# parameter to the [ `ExecuteChangeSet` ][1] API operation.
|
2442
2513
|
#
|
2443
2514
|
#
|
2444
2515
|
#
|
@@ -2488,6 +2559,106 @@ module Aws::CloudFormation
|
|
2488
2559
|
include Aws::Structure
|
2489
2560
|
end
|
2490
2561
|
|
2562
|
+
# @!attribute [rw] generated_template_name
|
2563
|
+
# The name or Amazon Resource Name (ARN) of a generated template.
|
2564
|
+
# @return [String]
|
2565
|
+
#
|
2566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeGeneratedTemplateInput AWS API Documentation
|
2567
|
+
#
|
2568
|
+
class DescribeGeneratedTemplateInput < Struct.new(
|
2569
|
+
:generated_template_name)
|
2570
|
+
SENSITIVE = []
|
2571
|
+
include Aws::Structure
|
2572
|
+
end
|
2573
|
+
|
2574
|
+
# @!attribute [rw] generated_template_id
|
2575
|
+
# The Amazon Resource Name (ARN) of the generated template. The format
|
2576
|
+
# is
|
2577
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
2578
|
+
# For example,
|
2579
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
2580
|
+
# `.
|
2581
|
+
# @return [String]
|
2582
|
+
#
|
2583
|
+
# @!attribute [rw] generated_template_name
|
2584
|
+
# The name of the generated template.
|
2585
|
+
# @return [String]
|
2586
|
+
#
|
2587
|
+
# @!attribute [rw] resources
|
2588
|
+
# A list of objects describing the details of the resources in the
|
2589
|
+
# template generation.
|
2590
|
+
# @return [Array<Types::ResourceDetail>]
|
2591
|
+
#
|
2592
|
+
# @!attribute [rw] status
|
2593
|
+
# The status of the template generation. Supported values are:
|
2594
|
+
#
|
2595
|
+
# * `CreatePending` - the creation of the template is pending.
|
2596
|
+
#
|
2597
|
+
# * `CreateInProgress` - the creation of the template is in progress.
|
2598
|
+
#
|
2599
|
+
# * `DeletePending` - the deletion of the template is pending.
|
2600
|
+
#
|
2601
|
+
# * `DeleteInProgress` - the deletion of the template is in progress.
|
2602
|
+
#
|
2603
|
+
# * `UpdatePending` - the update of the template is pending.
|
2604
|
+
#
|
2605
|
+
# * `UpdateInProgress` - the update of the template is in progress.
|
2606
|
+
#
|
2607
|
+
# * `Failed` - the template operation failed.
|
2608
|
+
#
|
2609
|
+
# * `Complete` - the template operation is complete.
|
2610
|
+
# @return [String]
|
2611
|
+
#
|
2612
|
+
# @!attribute [rw] status_reason
|
2613
|
+
# The reason for the current template generation status. This will
|
2614
|
+
# provide more details if a failure happened.
|
2615
|
+
# @return [String]
|
2616
|
+
#
|
2617
|
+
# @!attribute [rw] creation_time
|
2618
|
+
# The time the generated template was created.
|
2619
|
+
# @return [Time]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] last_updated_time
|
2622
|
+
# The time the generated template was last updated.
|
2623
|
+
# @return [Time]
|
2624
|
+
#
|
2625
|
+
# @!attribute [rw] progress
|
2626
|
+
# An object describing the progress of the template generation.
|
2627
|
+
# @return [Types::TemplateProgress]
|
2628
|
+
#
|
2629
|
+
# @!attribute [rw] stack_id
|
2630
|
+
# The stack ARN of the base stack if a base stack was provided when
|
2631
|
+
# generating the template.
|
2632
|
+
# @return [String]
|
2633
|
+
#
|
2634
|
+
# @!attribute [rw] template_configuration
|
2635
|
+
# The configuration details of the generated template, including the
|
2636
|
+
# `DeletionPolicy` and `UpdateReplacePolicy`.
|
2637
|
+
# @return [Types::TemplateConfiguration]
|
2638
|
+
#
|
2639
|
+
# @!attribute [rw] total_warnings
|
2640
|
+
# The number of warnings generated for this template. The warnings are
|
2641
|
+
# found in the details of each of the resources in the template.
|
2642
|
+
# @return [Integer]
|
2643
|
+
#
|
2644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeGeneratedTemplateOutput AWS API Documentation
|
2645
|
+
#
|
2646
|
+
class DescribeGeneratedTemplateOutput < Struct.new(
|
2647
|
+
:generated_template_id,
|
2648
|
+
:generated_template_name,
|
2649
|
+
:resources,
|
2650
|
+
:status,
|
2651
|
+
:status_reason,
|
2652
|
+
:creation_time,
|
2653
|
+
:last_updated_time,
|
2654
|
+
:progress,
|
2655
|
+
:stack_id,
|
2656
|
+
:template_configuration,
|
2657
|
+
:total_warnings)
|
2658
|
+
SENSITIVE = []
|
2659
|
+
include Aws::Structure
|
2660
|
+
end
|
2661
|
+
|
2491
2662
|
# @!attribute [rw] call_as
|
2492
2663
|
# \[Service-managed permissions\] Specifies whether you are acting as
|
2493
2664
|
# an account administrator in the organization's management account
|
@@ -2575,6 +2746,100 @@ module Aws::CloudFormation
|
|
2575
2746
|
include Aws::Structure
|
2576
2747
|
end
|
2577
2748
|
|
2749
|
+
# @!attribute [rw] resource_scan_id
|
2750
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
2751
|
+
# @return [String]
|
2752
|
+
#
|
2753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeResourceScanInput AWS API Documentation
|
2754
|
+
#
|
2755
|
+
class DescribeResourceScanInput < Struct.new(
|
2756
|
+
:resource_scan_id)
|
2757
|
+
SENSITIVE = []
|
2758
|
+
include Aws::Structure
|
2759
|
+
end
|
2760
|
+
|
2761
|
+
# @!attribute [rw] resource_scan_id
|
2762
|
+
# The Amazon Resource Name (ARN) of the resource scan. The format is
|
2763
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}`.
|
2764
|
+
# An example is
|
2765
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
|
2766
|
+
# `.
|
2767
|
+
# @return [String]
|
2768
|
+
#
|
2769
|
+
# @!attribute [rw] status
|
2770
|
+
# Status of the resource scan.
|
2771
|
+
#
|
2772
|
+
# INPROGRESS
|
2773
|
+
#
|
2774
|
+
# : The resource scan is still in progress.
|
2775
|
+
#
|
2776
|
+
# COMPLETE
|
2777
|
+
#
|
2778
|
+
# : The resource scan is complete.
|
2779
|
+
#
|
2780
|
+
# EXPIRED
|
2781
|
+
#
|
2782
|
+
# : The resource scan has expired.
|
2783
|
+
#
|
2784
|
+
# FAILED
|
2785
|
+
#
|
2786
|
+
# : The resource scan has failed.
|
2787
|
+
# @return [String]
|
2788
|
+
#
|
2789
|
+
# @!attribute [rw] status_reason
|
2790
|
+
# The reason for the resource scan status, providing more information
|
2791
|
+
# if a failure happened.
|
2792
|
+
# @return [String]
|
2793
|
+
#
|
2794
|
+
# @!attribute [rw] start_time
|
2795
|
+
# The time that the resource scan was started.
|
2796
|
+
# @return [Time]
|
2797
|
+
#
|
2798
|
+
# @!attribute [rw] end_time
|
2799
|
+
# The time that the resource scan was finished.
|
2800
|
+
# @return [Time]
|
2801
|
+
#
|
2802
|
+
# @!attribute [rw] percentage_completed
|
2803
|
+
# The percentage of the resource scan that has been completed.
|
2804
|
+
# @return [Float]
|
2805
|
+
#
|
2806
|
+
# @!attribute [rw] resource_types
|
2807
|
+
# The list of resource types for the specified scan. Resource types
|
2808
|
+
# are only available for scans with a `Status` set to `COMPLETE` or
|
2809
|
+
# `FAILED `.
|
2810
|
+
# @return [Array<String>]
|
2811
|
+
#
|
2812
|
+
# @!attribute [rw] resources_scanned
|
2813
|
+
# The number of resources that were listed. This is only available for
|
2814
|
+
# scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED `.
|
2815
|
+
# @return [Integer]
|
2816
|
+
#
|
2817
|
+
# @!attribute [rw] resources_read
|
2818
|
+
# The number of resources that were read. This is only available for
|
2819
|
+
# scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED `.
|
2820
|
+
#
|
2821
|
+
# <note markdown="1"> This field may be 0 if the resource scan failed with a
|
2822
|
+
# `ResourceScanLimitExceededException`.
|
2823
|
+
#
|
2824
|
+
# </note>
|
2825
|
+
# @return [Integer]
|
2826
|
+
#
|
2827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeResourceScanOutput AWS API Documentation
|
2828
|
+
#
|
2829
|
+
class DescribeResourceScanOutput < Struct.new(
|
2830
|
+
:resource_scan_id,
|
2831
|
+
:status,
|
2832
|
+
:status_reason,
|
2833
|
+
:start_time,
|
2834
|
+
:end_time,
|
2835
|
+
:percentage_completed,
|
2836
|
+
:resource_types,
|
2837
|
+
:resources_scanned,
|
2838
|
+
:resources_read)
|
2839
|
+
SENSITIVE = []
|
2840
|
+
include Aws::Structure
|
2841
|
+
end
|
2842
|
+
|
2578
2843
|
# @!attribute [rw] stack_drift_detection_id
|
2579
2844
|
# The ID of the drift detection results of this operation.
|
2580
2845
|
#
|
@@ -3206,7 +3471,7 @@ module Aws::CloudFormation
|
|
3206
3471
|
#
|
3207
3472
|
# If the extension is a public third-party type you have activated
|
3208
3473
|
# with a type name alias, CloudFormation returns the type name alias.
|
3209
|
-
# For more information, see [ActivateType][1].
|
3474
|
+
# For more information, see [ `ActivateType` ][1].
|
3210
3475
|
#
|
3211
3476
|
#
|
3212
3477
|
#
|
@@ -3220,7 +3485,7 @@ module Aws::CloudFormation
|
|
3220
3485
|
# This applies only to private extensions you have registered in your
|
3221
3486
|
# account. For public extensions, both those provided by Amazon Web
|
3222
3487
|
# Services and published by third parties, CloudFormation returns
|
3223
|
-
# `null`. For more information, see [RegisterType][1].
|
3488
|
+
# `null`. For more information, see [ `RegisterType` ][1].
|
3224
3489
|
#
|
3225
3490
|
# To set the default version of an extension, use
|
3226
3491
|
# SetTypeDefaultVersion.
|
@@ -3339,7 +3604,7 @@ module Aws::CloudFormation
|
|
3339
3604
|
# This applies only to private extensions you have registered in your
|
3340
3605
|
# account. For public extensions, both those provided by Amazon Web
|
3341
3606
|
# Services and published by third parties, CloudFormation returns
|
3342
|
-
# `null`. For more information, see [RegisterType][1].
|
3607
|
+
# `null`. For more information, see [ `RegisterType` ][1].
|
3343
3608
|
#
|
3344
3609
|
#
|
3345
3610
|
#
|
@@ -3355,8 +3620,8 @@ module Aws::CloudFormation
|
|
3355
3620
|
# @!attribute [rw] execution_role_arn
|
3356
3621
|
# The Amazon Resource Name (ARN) of the IAM execution role used to
|
3357
3622
|
# register the extension. This applies only to private extensions you
|
3358
|
-
# have registered in your account. For more information, see
|
3359
|
-
#
|
3623
|
+
# have registered in your account. For more information, see [
|
3624
|
+
# `RegisterType` ][1].
|
3360
3625
|
#
|
3361
3626
|
# If the registered extension calls any Amazon Web Services APIs, you
|
3362
3627
|
# must create an <i> <a
|
@@ -3399,11 +3664,11 @@ module Aws::CloudFormation
|
|
3399
3664
|
# only to:
|
3400
3665
|
#
|
3401
3666
|
# * Private extensions you have registered in your account. For more
|
3402
|
-
# information, see [RegisterType][1].
|
3667
|
+
# information, see [ `RegisterType` ][1].
|
3403
3668
|
#
|
3404
3669
|
# * Public extensions you have activated in your account with
|
3405
|
-
# auto-update specified. For more information, see
|
3406
|
-
#
|
3670
|
+
# auto-update specified. For more information, see [ `ActivateType`
|
3671
|
+
# ][2].
|
3407
3672
|
#
|
3408
3673
|
#
|
3409
3674
|
#
|
@@ -3420,8 +3685,8 @@ module Aws::CloudFormation
|
|
3420
3685
|
# A JSON string that represent the current configuration data for the
|
3421
3686
|
# extension in this account and Region.
|
3422
3687
|
#
|
3423
|
-
# To set the configuration data for an extension, use
|
3424
|
-
#
|
3688
|
+
# To set the configuration data for an extension, use [
|
3689
|
+
# `SetTypeConfiguration` ][1]. For more information, see [Configuring
|
3425
3690
|
# extensions at the account level][2] in the *CloudFormation User
|
3426
3691
|
# Guide*.
|
3427
3692
|
#
|
@@ -3739,7 +4004,8 @@ module Aws::CloudFormation
|
|
3739
4004
|
# Location of file containing the template body. The URL must point to
|
3740
4005
|
# a template that's located in an Amazon S3 bucket or a Systems
|
3741
4006
|
# Manager document. For more information, go to [Template Anatomy][1]
|
3742
|
-
# in the *CloudFormation User Guide*.
|
4007
|
+
# in the *CloudFormation User Guide*. The location for an Amazon S3
|
4008
|
+
# bucket must start with `https://`.
|
3743
4009
|
#
|
3744
4010
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
3745
4011
|
# are passed, only `TemplateBody` is used.
|
@@ -3802,16 +4068,16 @@ module Aws::CloudFormation
|
|
3802
4068
|
# @!attribute [rw] disable_rollback
|
3803
4069
|
# Preserves the state of previously provisioned resources when an
|
3804
4070
|
# operation fails. This parameter can't be specified when the
|
3805
|
-
# `OnStackFailure` parameter to the [CreateChangeSet][1] API
|
3806
|
-
# was specified.
|
4071
|
+
# `OnStackFailure` parameter to the [ `CreateChangeSet` ][1] API
|
4072
|
+
# operation was specified.
|
3807
4073
|
#
|
3808
4074
|
# * `True` - if the stack creation fails, do nothing. This is
|
3809
4075
|
# equivalent to specifying `DO_NOTHING` for the `OnStackFailure`
|
3810
|
-
# parameter to the [CreateChangeSet][1] API operation.
|
4076
|
+
# parameter to the [ `CreateChangeSet` ][1] API operation.
|
3811
4077
|
#
|
3812
4078
|
# * `False` - if the stack creation fails, roll back the stack. This
|
3813
4079
|
# is equivalent to specifying `ROLLBACK` for the `OnStackFailure`
|
3814
|
-
# parameter to the [CreateChangeSet][1] API operation.
|
4080
|
+
# parameter to the [ `CreateChangeSet` ][1] API operation.
|
3815
4081
|
#
|
3816
4082
|
# Default: `True`
|
3817
4083
|
#
|
@@ -3876,6 +4142,73 @@ module Aws::CloudFormation
|
|
3876
4142
|
include Aws::Structure
|
3877
4143
|
end
|
3878
4144
|
|
4145
|
+
# The generated template was not found.
|
4146
|
+
#
|
4147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GeneratedTemplateNotFoundException AWS API Documentation
|
4148
|
+
#
|
4149
|
+
class GeneratedTemplateNotFoundException < Aws::EmptyStructure; end
|
4150
|
+
|
4151
|
+
# @!attribute [rw] format
|
4152
|
+
# The language to use to retrieve for the generated template.
|
4153
|
+
# Supported values are:
|
4154
|
+
#
|
4155
|
+
# * `JSON`
|
4156
|
+
#
|
4157
|
+
# * `YAML`
|
4158
|
+
# @return [String]
|
4159
|
+
#
|
4160
|
+
# @!attribute [rw] generated_template_name
|
4161
|
+
# The name or Amazon Resource Name (ARN) of the generated template.
|
4162
|
+
# The format is
|
4163
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
4164
|
+
# For example,
|
4165
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
4166
|
+
# `.
|
4167
|
+
# @return [String]
|
4168
|
+
#
|
4169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetGeneratedTemplateInput AWS API Documentation
|
4170
|
+
#
|
4171
|
+
class GetGeneratedTemplateInput < Struct.new(
|
4172
|
+
:format,
|
4173
|
+
:generated_template_name)
|
4174
|
+
SENSITIVE = []
|
4175
|
+
include Aws::Structure
|
4176
|
+
end
|
4177
|
+
|
4178
|
+
# @!attribute [rw] status
|
4179
|
+
# The status of the template generation. Supported values are:
|
4180
|
+
#
|
4181
|
+
# * `CreatePending` - the creation of the template is pending.
|
4182
|
+
#
|
4183
|
+
# * `CreateInProgress` - the creation of the template is in progress.
|
4184
|
+
#
|
4185
|
+
# * `DeletePending` - the deletion of the template is pending.
|
4186
|
+
#
|
4187
|
+
# * `DeleteInProgress` - the deletion of the template is in progress.
|
4188
|
+
#
|
4189
|
+
# * `UpdatePending` - the update of the template is pending.
|
4190
|
+
#
|
4191
|
+
# * `UpdateInProgress` - the update of the template is in progress.
|
4192
|
+
#
|
4193
|
+
# * `Failed` - the template operation failed.
|
4194
|
+
#
|
4195
|
+
# * `Complete` - the template operation is complete.
|
4196
|
+
# @return [String]
|
4197
|
+
#
|
4198
|
+
# @!attribute [rw] template_body
|
4199
|
+
# The template body of the generated template, in the language
|
4200
|
+
# specified by the `Language` parameter.
|
4201
|
+
# @return [String]
|
4202
|
+
#
|
4203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetGeneratedTemplateOutput AWS API Documentation
|
4204
|
+
#
|
4205
|
+
class GetGeneratedTemplateOutput < Struct.new(
|
4206
|
+
:status,
|
4207
|
+
:template_body)
|
4208
|
+
SENSITIVE = []
|
4209
|
+
include Aws::Structure
|
4210
|
+
end
|
4211
|
+
|
3879
4212
|
# The input for the GetStackPolicy action.
|
3880
4213
|
#
|
3881
4214
|
# @!attribute [rw] stack_name
|
@@ -4004,7 +4337,8 @@ module Aws::CloudFormation
|
|
4004
4337
|
# a template (max size: 460,800 bytes) that's located in an Amazon S3
|
4005
4338
|
# bucket or a Systems Manager document. For more information about
|
4006
4339
|
# templates, see [Template anatomy][1] in the *CloudFormation User
|
4007
|
-
# Guide*.
|
4340
|
+
# Guide*. The location for an Amazon S3 bucket must start with
|
4341
|
+
# `https://`.
|
4008
4342
|
#
|
4009
4343
|
# Conditional: You must specify only one of the following parameters:
|
4010
4344
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -4351,6 +4685,48 @@ module Aws::CloudFormation
|
|
4351
4685
|
include Aws::Structure
|
4352
4686
|
end
|
4353
4687
|
|
4688
|
+
# @!attribute [rw] next_token
|
4689
|
+
# A string that identifies the next page of resource scan results.
|
4690
|
+
# @return [String]
|
4691
|
+
#
|
4692
|
+
# @!attribute [rw] max_results
|
4693
|
+
# If the number of available results exceeds this maximum, the
|
4694
|
+
# response includes a `NextToken` value that you can use for the
|
4695
|
+
# `NextToken` parameter to get the next set of results. By default the
|
4696
|
+
# `ListGeneratedTemplates` API action will return at most 50 results
|
4697
|
+
# in each response. The maximum value is 100.
|
4698
|
+
# @return [Integer]
|
4699
|
+
#
|
4700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListGeneratedTemplatesInput AWS API Documentation
|
4701
|
+
#
|
4702
|
+
class ListGeneratedTemplatesInput < Struct.new(
|
4703
|
+
:next_token,
|
4704
|
+
:max_results)
|
4705
|
+
SENSITIVE = []
|
4706
|
+
include Aws::Structure
|
4707
|
+
end
|
4708
|
+
|
4709
|
+
# @!attribute [rw] summaries
|
4710
|
+
# A list of summaries of the generated templates.
|
4711
|
+
# @return [Array<Types::TemplateSummary>]
|
4712
|
+
#
|
4713
|
+
# @!attribute [rw] next_token
|
4714
|
+
# If the request doesn't return all the remaining results,
|
4715
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4716
|
+
# call `ListGeneratedTemplates` again and use that value for the
|
4717
|
+
# `NextToken` parameter. If the request returns all results,
|
4718
|
+
# `NextToken` is set to an empty string.
|
4719
|
+
# @return [String]
|
4720
|
+
#
|
4721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListGeneratedTemplatesOutput AWS API Documentation
|
4722
|
+
#
|
4723
|
+
class ListGeneratedTemplatesOutput < Struct.new(
|
4724
|
+
:summaries,
|
4725
|
+
:next_token)
|
4726
|
+
SENSITIVE = []
|
4727
|
+
include Aws::Structure
|
4728
|
+
end
|
4729
|
+
|
4354
4730
|
# @!attribute [rw] export_name
|
4355
4731
|
# The name of the exported output value. CloudFormation returns the
|
4356
4732
|
# stack names that are importing this value.
|
@@ -4390,6 +4766,172 @@ module Aws::CloudFormation
|
|
4390
4766
|
include Aws::Structure
|
4391
4767
|
end
|
4392
4768
|
|
4769
|
+
# @!attribute [rw] resource_scan_id
|
4770
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
4771
|
+
# @return [String]
|
4772
|
+
#
|
4773
|
+
# @!attribute [rw] resources
|
4774
|
+
# The list of resources for which you want to get the related
|
4775
|
+
# resources. Up to 100 resources can be provided.
|
4776
|
+
# @return [Array<Types::ScannedResourceIdentifier>]
|
4777
|
+
#
|
4778
|
+
# @!attribute [rw] next_token
|
4779
|
+
# A string that identifies the next page of resource scan results.
|
4780
|
+
# @return [String]
|
4781
|
+
#
|
4782
|
+
# @!attribute [rw] max_results
|
4783
|
+
# If the number of available results exceeds this maximum, the
|
4784
|
+
# response includes a `NextToken` value that you can use for the
|
4785
|
+
# `NextToken` parameter to get the next set of results. By default the
|
4786
|
+
# `ListResourceScanRelatedResources` API action will return up to 100
|
4787
|
+
# results in each response. The maximum value is 100.
|
4788
|
+
# @return [Integer]
|
4789
|
+
#
|
4790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanRelatedResourcesInput AWS API Documentation
|
4791
|
+
#
|
4792
|
+
class ListResourceScanRelatedResourcesInput < Struct.new(
|
4793
|
+
:resource_scan_id,
|
4794
|
+
:resources,
|
4795
|
+
:next_token,
|
4796
|
+
:max_results)
|
4797
|
+
SENSITIVE = []
|
4798
|
+
include Aws::Structure
|
4799
|
+
end
|
4800
|
+
|
4801
|
+
# @!attribute [rw] related_resources
|
4802
|
+
# List of up to `MaxResults` resources in the specified resource scan
|
4803
|
+
# related to the specified resources.
|
4804
|
+
# @return [Array<Types::ScannedResource>]
|
4805
|
+
#
|
4806
|
+
# @!attribute [rw] next_token
|
4807
|
+
# If the request doesn't return all the remaining results,
|
4808
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4809
|
+
# call `ListResourceScanRelatedResources` again and use that value for
|
4810
|
+
# the `NextToken` parameter. If the request returns all results,
|
4811
|
+
# `NextToken` is set to an empty string.
|
4812
|
+
# @return [String]
|
4813
|
+
#
|
4814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanRelatedResourcesOutput AWS API Documentation
|
4815
|
+
#
|
4816
|
+
class ListResourceScanRelatedResourcesOutput < Struct.new(
|
4817
|
+
:related_resources,
|
4818
|
+
:next_token)
|
4819
|
+
SENSITIVE = []
|
4820
|
+
include Aws::Structure
|
4821
|
+
end
|
4822
|
+
|
4823
|
+
# @!attribute [rw] resource_scan_id
|
4824
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
4825
|
+
# @return [String]
|
4826
|
+
#
|
4827
|
+
# @!attribute [rw] resource_identifier
|
4828
|
+
# If specified, the returned resources will have the specified
|
4829
|
+
# resource identifier (or one of them in the case where the resource
|
4830
|
+
# has multiple identifiers).
|
4831
|
+
# @return [String]
|
4832
|
+
#
|
4833
|
+
# @!attribute [rw] resource_type_prefix
|
4834
|
+
# If specified, the returned resources will be of any of the resource
|
4835
|
+
# types with the specified prefix.
|
4836
|
+
# @return [String]
|
4837
|
+
#
|
4838
|
+
# @!attribute [rw] tag_key
|
4839
|
+
# If specified, the returned resources will have a matching tag key.
|
4840
|
+
# @return [String]
|
4841
|
+
#
|
4842
|
+
# @!attribute [rw] tag_value
|
4843
|
+
# If specified, the returned resources will have a matching tag value.
|
4844
|
+
# @return [String]
|
4845
|
+
#
|
4846
|
+
# @!attribute [rw] next_token
|
4847
|
+
# A string that identifies the next page of resource scan results.
|
4848
|
+
# @return [String]
|
4849
|
+
#
|
4850
|
+
# @!attribute [rw] max_results
|
4851
|
+
# If the number of available results exceeds this maximum, the
|
4852
|
+
# response includes a `NextToken` value that you can use for the
|
4853
|
+
# `NextToken` parameter to get the next set of results. By default the
|
4854
|
+
# `ListResourceScanResources` API action will return at most 100
|
4855
|
+
# results in each response. The maximum value is 100.
|
4856
|
+
# @return [Integer]
|
4857
|
+
#
|
4858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanResourcesInput AWS API Documentation
|
4859
|
+
#
|
4860
|
+
class ListResourceScanResourcesInput < Struct.new(
|
4861
|
+
:resource_scan_id,
|
4862
|
+
:resource_identifier,
|
4863
|
+
:resource_type_prefix,
|
4864
|
+
:tag_key,
|
4865
|
+
:tag_value,
|
4866
|
+
:next_token,
|
4867
|
+
:max_results)
|
4868
|
+
SENSITIVE = []
|
4869
|
+
include Aws::Structure
|
4870
|
+
end
|
4871
|
+
|
4872
|
+
# @!attribute [rw] resources
|
4873
|
+
# List of up to `MaxResults` resources in the specified resource scan
|
4874
|
+
# that match all of the specified filters.
|
4875
|
+
# @return [Array<Types::ScannedResource>]
|
4876
|
+
#
|
4877
|
+
# @!attribute [rw] next_token
|
4878
|
+
# If the request doesn't return all the remaining results,
|
4879
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4880
|
+
# call `ListResourceScanResources` again and use that value for the
|
4881
|
+
# `NextToken` parameter. If the request returns all results,
|
4882
|
+
# `NextToken` is set to an empty string.
|
4883
|
+
# @return [String]
|
4884
|
+
#
|
4885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScanResourcesOutput AWS API Documentation
|
4886
|
+
#
|
4887
|
+
class ListResourceScanResourcesOutput < Struct.new(
|
4888
|
+
:resources,
|
4889
|
+
:next_token)
|
4890
|
+
SENSITIVE = []
|
4891
|
+
include Aws::Structure
|
4892
|
+
end
|
4893
|
+
|
4894
|
+
# @!attribute [rw] next_token
|
4895
|
+
# A string that identifies the next page of resource scan results.
|
4896
|
+
# @return [String]
|
4897
|
+
#
|
4898
|
+
# @!attribute [rw] max_results
|
4899
|
+
# If the number of available results exceeds this maximum, the
|
4900
|
+
# response includes a `NextToken` value that you can use for the
|
4901
|
+
# `NextToken` parameter to get the next set of results. The default
|
4902
|
+
# value is 10. The maximum value is 100.
|
4903
|
+
# @return [Integer]
|
4904
|
+
#
|
4905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScansInput AWS API Documentation
|
4906
|
+
#
|
4907
|
+
class ListResourceScansInput < Struct.new(
|
4908
|
+
:next_token,
|
4909
|
+
:max_results)
|
4910
|
+
SENSITIVE = []
|
4911
|
+
include Aws::Structure
|
4912
|
+
end
|
4913
|
+
|
4914
|
+
# @!attribute [rw] resource_scan_summaries
|
4915
|
+
# The list of scans returned.
|
4916
|
+
# @return [Array<Types::ResourceScanSummary>]
|
4917
|
+
#
|
4918
|
+
# @!attribute [rw] next_token
|
4919
|
+
# If the request doesn't return all the remaining results,
|
4920
|
+
# `NextToken` is set to a token. To retrieve the next set of results,
|
4921
|
+
# call `ListResourceScans` again and use that value for the
|
4922
|
+
# `NextToken` parameter. If the request returns all results,
|
4923
|
+
# `NextToken` is set to an empty string.
|
4924
|
+
# @return [String]
|
4925
|
+
#
|
4926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScansOutput AWS API Documentation
|
4927
|
+
#
|
4928
|
+
class ListResourceScansOutput < Struct.new(
|
4929
|
+
:resource_scan_summaries,
|
4930
|
+
:next_token)
|
4931
|
+
SENSITIVE = []
|
4932
|
+
include Aws::Structure
|
4933
|
+
end
|
4934
|
+
|
4393
4935
|
# @!attribute [rw] stack_set_name
|
4394
4936
|
# The name or unique ID of the stack set that you want to list drifted
|
4395
4937
|
# resources for.
|
@@ -6098,44 +6640,249 @@ module Aws::CloudFormation
|
|
6098
6640
|
# given for `CausingEntity`.
|
6099
6641
|
# @return [String]
|
6100
6642
|
#
|
6101
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceChangeDetail AWS API Documentation
|
6643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceChangeDetail AWS API Documentation
|
6644
|
+
#
|
6645
|
+
class ResourceChangeDetail < Struct.new(
|
6646
|
+
:target,
|
6647
|
+
:evaluation,
|
6648
|
+
:change_source,
|
6649
|
+
:causing_entity)
|
6650
|
+
SENSITIVE = []
|
6651
|
+
include Aws::Structure
|
6652
|
+
end
|
6653
|
+
|
6654
|
+
# A resource included in a generated template. This data type is used
|
6655
|
+
# with the `CreateGeneratedTemplate` and `UpdateGeneratedTemplate` API
|
6656
|
+
# actions.
|
6657
|
+
#
|
6658
|
+
# @!attribute [rw] resource_type
|
6659
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
6660
|
+
# list of supported resources, see [IaC generator supported resource
|
6661
|
+
# types][1] in the *CloudFormation User Guide*
|
6662
|
+
#
|
6663
|
+
#
|
6664
|
+
#
|
6665
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
|
6666
|
+
# @return [String]
|
6667
|
+
#
|
6668
|
+
# @!attribute [rw] logical_resource_id
|
6669
|
+
# The logical resource id for this resource in the generated template.
|
6670
|
+
# @return [String]
|
6671
|
+
#
|
6672
|
+
# @!attribute [rw] resource_identifier
|
6673
|
+
# A list of up to 256 key-value pairs that identifies the scanned
|
6674
|
+
# resource. The key is the name of one of the primary identifiers for
|
6675
|
+
# the resource. (Primary identifiers are specified in the
|
6676
|
+
# `primaryIdentifier` list in the resource schema.) The value is the
|
6677
|
+
# value of that primary identifier. For example, for a
|
6678
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
6679
|
+
# `TableName` so the key-value pair could be `"TableName":
|
6680
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
6681
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
6682
|
+
# development*.
|
6683
|
+
#
|
6684
|
+
#
|
6685
|
+
#
|
6686
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
6687
|
+
# @return [Hash<String,String>]
|
6688
|
+
#
|
6689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceDefinition AWS API Documentation
|
6690
|
+
#
|
6691
|
+
class ResourceDefinition < Struct.new(
|
6692
|
+
:resource_type,
|
6693
|
+
:logical_resource_id,
|
6694
|
+
:resource_identifier)
|
6695
|
+
SENSITIVE = []
|
6696
|
+
include Aws::Structure
|
6697
|
+
end
|
6698
|
+
|
6699
|
+
# Details about a resource in a generated template
|
6700
|
+
#
|
6701
|
+
# @!attribute [rw] resource_type
|
6702
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
6703
|
+
# list of supported resources, see [IaC generator supported resource
|
6704
|
+
# types][1] In the *CloudFormation User Guide*
|
6705
|
+
#
|
6706
|
+
#
|
6707
|
+
#
|
6708
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
|
6709
|
+
# @return [String]
|
6710
|
+
#
|
6711
|
+
# @!attribute [rw] logical_resource_id
|
6712
|
+
# The logical id for this resource in the final generated template.
|
6713
|
+
# @return [String]
|
6714
|
+
#
|
6715
|
+
# @!attribute [rw] resource_identifier
|
6716
|
+
# A list of up to 256 key-value pairs that identifies the resource in
|
6717
|
+
# the generated template. The key is the name of one of the primary
|
6718
|
+
# identifiers for the resource. (Primary identifiers are specified in
|
6719
|
+
# the `primaryIdentifier` list in the resource schema.) The value is
|
6720
|
+
# the value of that primary identifier. For example, for a
|
6721
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
6722
|
+
# `TableName` so the key-value pair could be `"TableName":
|
6723
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
6724
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
6725
|
+
# development*.
|
6726
|
+
#
|
6727
|
+
#
|
6728
|
+
#
|
6729
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
6730
|
+
# @return [Hash<String,String>]
|
6731
|
+
#
|
6732
|
+
# @!attribute [rw] resource_status
|
6733
|
+
# Status of the processing of a resource in a generated template.
|
6734
|
+
#
|
6735
|
+
# InProgress
|
6736
|
+
#
|
6737
|
+
# : The resource processing is still in progress.
|
6738
|
+
#
|
6739
|
+
# Complete
|
6740
|
+
#
|
6741
|
+
# : The resource processing is complete.
|
6742
|
+
#
|
6743
|
+
# Pending
|
6744
|
+
#
|
6745
|
+
# : The resource processing is pending.
|
6746
|
+
#
|
6747
|
+
# Failed
|
6748
|
+
#
|
6749
|
+
# : The resource processing has failed.
|
6750
|
+
# @return [String]
|
6751
|
+
#
|
6752
|
+
# @!attribute [rw] resource_status_reason
|
6753
|
+
# The reason for the resource detail, providing more information if a
|
6754
|
+
# failure happened.
|
6755
|
+
# @return [String]
|
6756
|
+
#
|
6757
|
+
# @!attribute [rw] warnings
|
6758
|
+
# The warnings generated for this resource.
|
6759
|
+
# @return [Array<Types::WarningDetail>]
|
6760
|
+
#
|
6761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceDetail AWS API Documentation
|
6762
|
+
#
|
6763
|
+
class ResourceDetail < Struct.new(
|
6764
|
+
:resource_type,
|
6765
|
+
:logical_resource_id,
|
6766
|
+
:resource_identifier,
|
6767
|
+
:resource_status,
|
6768
|
+
:resource_status_reason,
|
6769
|
+
:warnings)
|
6770
|
+
SENSITIVE = []
|
6771
|
+
include Aws::Structure
|
6772
|
+
end
|
6773
|
+
|
6774
|
+
# Describes the target resources of a specific type in your import
|
6775
|
+
# template (for example, all `AWS::S3::Bucket` resources) and the
|
6776
|
+
# properties you can provide during the import to identify resources of
|
6777
|
+
# that type.
|
6778
|
+
#
|
6779
|
+
# @!attribute [rw] resource_type
|
6780
|
+
# The template resource type of the target resources, such as
|
6781
|
+
# `AWS::S3::Bucket`.
|
6782
|
+
# @return [String]
|
6783
|
+
#
|
6784
|
+
# @!attribute [rw] logical_resource_ids
|
6785
|
+
# The logical IDs of the target resources of the specified
|
6786
|
+
# `ResourceType`, as defined in the import template.
|
6787
|
+
# @return [Array<String>]
|
6788
|
+
#
|
6789
|
+
# @!attribute [rw] resource_identifiers
|
6790
|
+
# The resource properties you can provide during the import to
|
6791
|
+
# identify your target resources. For example, `BucketName` is a
|
6792
|
+
# possible identifier property for `AWS::S3::Bucket` resources.
|
6793
|
+
# @return [Array<String>]
|
6794
|
+
#
|
6795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceIdentifierSummary AWS API Documentation
|
6796
|
+
#
|
6797
|
+
class ResourceIdentifierSummary < Struct.new(
|
6798
|
+
:resource_type,
|
6799
|
+
:logical_resource_ids,
|
6800
|
+
:resource_identifiers)
|
6801
|
+
SENSITIVE = []
|
6802
|
+
include Aws::Structure
|
6803
|
+
end
|
6804
|
+
|
6805
|
+
# A resource scan is currently in progress. Only one can be run at a
|
6806
|
+
# time for an account in a Region.
|
6807
|
+
#
|
6808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanInProgressException AWS API Documentation
|
6809
|
+
#
|
6810
|
+
class ResourceScanInProgressException < Aws::EmptyStructure; end
|
6811
|
+
|
6812
|
+
# The limit on resource scans has been exceeded. Reasons include:
|
6813
|
+
#
|
6814
|
+
# * Exceeded the daily quota for resource scans.
|
6815
|
+
#
|
6816
|
+
# * A resource scan recently failed. You must wait 10 minutes before
|
6817
|
+
# starting a new resource scan.
|
6818
|
+
#
|
6819
|
+
# * The last resource scan failed after exceeding 100,000 resources.
|
6820
|
+
# When this happens, you must wait 24 hours before starting a new
|
6821
|
+
# resource scan.
|
6822
|
+
#
|
6823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanLimitExceededException AWS API Documentation
|
6824
|
+
#
|
6825
|
+
class ResourceScanLimitExceededException < Aws::EmptyStructure; end
|
6826
|
+
|
6827
|
+
# The resource scan was not found.
|
6828
|
+
#
|
6829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanNotFoundException AWS API Documentation
|
6830
|
+
#
|
6831
|
+
class ResourceScanNotFoundException < Aws::EmptyStructure; end
|
6832
|
+
|
6833
|
+
# A summary of the resource scan. This is returned by the
|
6834
|
+
# `ListResourceScan` API action.
|
6835
|
+
#
|
6836
|
+
# @!attribute [rw] resource_scan_id
|
6837
|
+
# The Amazon Resource Name (ARN) of the resource scan.
|
6838
|
+
# @return [String]
|
6839
|
+
#
|
6840
|
+
# @!attribute [rw] status
|
6841
|
+
# Status of the resource scan.
|
6842
|
+
#
|
6843
|
+
# INPROGRESS
|
6844
|
+
#
|
6845
|
+
# : The resource scan is still in progress.
|
6846
|
+
#
|
6847
|
+
# COMPLETE
|
6848
|
+
#
|
6849
|
+
# : The resource scan is complete.
|
6850
|
+
#
|
6851
|
+
# EXPIRED
|
6102
6852
|
#
|
6103
|
-
|
6104
|
-
:target,
|
6105
|
-
:evaluation,
|
6106
|
-
:change_source,
|
6107
|
-
:causing_entity)
|
6108
|
-
SENSITIVE = []
|
6109
|
-
include Aws::Structure
|
6110
|
-
end
|
6111
|
-
|
6112
|
-
# Describes the target resources of a specific type in your import
|
6113
|
-
# template (for example, all `AWS::S3::Bucket` resources) and the
|
6114
|
-
# properties you can provide during the import to identify resources of
|
6115
|
-
# that type.
|
6853
|
+
# : The resource scan has expired.
|
6116
6854
|
#
|
6117
|
-
#
|
6118
|
-
#
|
6119
|
-
#
|
6855
|
+
# FAILED
|
6856
|
+
#
|
6857
|
+
# : The resource scan has failed.
|
6120
6858
|
# @return [String]
|
6121
6859
|
#
|
6122
|
-
# @!attribute [rw]
|
6123
|
-
# The
|
6124
|
-
#
|
6125
|
-
# @return [
|
6860
|
+
# @!attribute [rw] status_reason
|
6861
|
+
# The reason for the resource scan status, providing more information
|
6862
|
+
# if a failure happened.
|
6863
|
+
# @return [String]
|
6126
6864
|
#
|
6127
|
-
# @!attribute [rw]
|
6128
|
-
# The
|
6129
|
-
#
|
6130
|
-
# possible identifier property for `AWS::S3::Bucket` resources.
|
6131
|
-
# @return [Array<String>]
|
6865
|
+
# @!attribute [rw] start_time
|
6866
|
+
# The time that the resource scan was started.
|
6867
|
+
# @return [Time]
|
6132
6868
|
#
|
6133
|
-
#
|
6869
|
+
# @!attribute [rw] end_time
|
6870
|
+
# The time that the resource scan was finished.
|
6871
|
+
# @return [Time]
|
6134
6872
|
#
|
6135
|
-
|
6136
|
-
|
6137
|
-
|
6138
|
-
|
6873
|
+
# @!attribute [rw] percentage_completed
|
6874
|
+
# The percentage of the resource scan that has been completed.
|
6875
|
+
# @return [Float]
|
6876
|
+
#
|
6877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceScanSummary AWS API Documentation
|
6878
|
+
#
|
6879
|
+
class ResourceScanSummary < Struct.new(
|
6880
|
+
:resource_scan_id,
|
6881
|
+
:status,
|
6882
|
+
:status_reason,
|
6883
|
+
:start_time,
|
6884
|
+
:end_time,
|
6885
|
+
:percentage_completed)
|
6139
6886
|
SENSITIVE = []
|
6140
6887
|
include Aws::Structure
|
6141
6888
|
end
|
@@ -6261,8 +7008,8 @@ module Aws::CloudFormation
|
|
6261
7008
|
# triggers, CloudFormation still waits the specified period of time
|
6262
7009
|
# before cleaning up old resources after update operations. You can
|
6263
7010
|
# use this monitoring period to perform any manual stack validation
|
6264
|
-
# desired, and manually cancel the stack creation or update (using
|
6265
|
-
#
|
7011
|
+
# desired, and manually cancel the stack creation or update (using [
|
7012
|
+
# `CancelUpdateStack` ][1], for example) as necessary.
|
6266
7013
|
#
|
6267
7014
|
# If you specify 0 for this parameter, CloudFormation still monitors
|
6268
7015
|
# the specified rollback triggers during stack creation and update
|
@@ -6341,9 +7088,9 @@ module Aws::CloudFormation
|
|
6341
7088
|
# @return [String]
|
6342
7089
|
#
|
6343
7090
|
# @!attribute [rw] type
|
6344
|
-
# The resource type of the rollback trigger. Specify either
|
6345
|
-
#
|
6346
|
-
# resource types.
|
7091
|
+
# The resource type of the rollback trigger. Specify either [
|
7092
|
+
# `AWS::CloudWatch::Alarm` ][1] or [ `AWS::CloudWatch::CompositeAlarm`
|
7093
|
+
# ][2] resource types.
|
6347
7094
|
#
|
6348
7095
|
#
|
6349
7096
|
#
|
@@ -6360,6 +7107,89 @@ module Aws::CloudFormation
|
|
6360
7107
|
include Aws::Structure
|
6361
7108
|
end
|
6362
7109
|
|
7110
|
+
# A scanned resource returned by `ListResourceScanResources` or
|
7111
|
+
# `ListResourceScanRelatedResources`.
|
7112
|
+
#
|
7113
|
+
# @!attribute [rw] resource_type
|
7114
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
7115
|
+
# list of supported resources, see [Resource type support][1] In the
|
7116
|
+
# *CloudFormation User Guide*
|
7117
|
+
#
|
7118
|
+
#
|
7119
|
+
#
|
7120
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
|
7121
|
+
# @return [String]
|
7122
|
+
#
|
7123
|
+
# @!attribute [rw] resource_identifier
|
7124
|
+
# A list of up to 256 key-value pairs that identifies for the scanned
|
7125
|
+
# resource. The key is the name of one of the primary identifiers for
|
7126
|
+
# the resource. (Primary identifiers are specified in the
|
7127
|
+
# `primaryIdentifier` list in the resource schema.) The value is the
|
7128
|
+
# value of that primary identifier. For example, for a
|
7129
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
7130
|
+
# `TableName` so the key-value pair could be `"TableName":
|
7131
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
7132
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
7133
|
+
# development*.
|
7134
|
+
#
|
7135
|
+
#
|
7136
|
+
#
|
7137
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
7138
|
+
# @return [Hash<String,String>]
|
7139
|
+
#
|
7140
|
+
# @!attribute [rw] managed_by_stack
|
7141
|
+
# If `true`, the resource is managed by a CloudFormation stack.
|
7142
|
+
# @return [Boolean]
|
7143
|
+
#
|
7144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ScannedResource AWS API Documentation
|
7145
|
+
#
|
7146
|
+
class ScannedResource < Struct.new(
|
7147
|
+
:resource_type,
|
7148
|
+
:resource_identifier,
|
7149
|
+
:managed_by_stack)
|
7150
|
+
SENSITIVE = []
|
7151
|
+
include Aws::Structure
|
7152
|
+
end
|
7153
|
+
|
7154
|
+
# Identifies a scanned resource. This is used with the
|
7155
|
+
# `ListResourceScanRelatedResources` API action.
|
7156
|
+
#
|
7157
|
+
# @!attribute [rw] resource_type
|
7158
|
+
# The type of the resource, such as `AWS::DynamoDB::Table`. For the
|
7159
|
+
# list of supported resources, see [IaC generator supported resource
|
7160
|
+
# types][1] In the *CloudFormation User Guide*.
|
7161
|
+
#
|
7162
|
+
#
|
7163
|
+
#
|
7164
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
|
7165
|
+
# @return [String]
|
7166
|
+
#
|
7167
|
+
# @!attribute [rw] resource_identifier
|
7168
|
+
# A list of up to 256 key-value pairs that identifies the scanned
|
7169
|
+
# resource. The key is the name of one of the primary identifiers for
|
7170
|
+
# the resource. (Primary identifiers are specified in the
|
7171
|
+
# `primaryIdentifier` list in the resource schema.) The value is the
|
7172
|
+
# value of that primary identifier. For example, for a
|
7173
|
+
# `AWS::DynamoDB::Table` resource, the primary identifiers is
|
7174
|
+
# `TableName` so the key-value pair could be `"TableName":
|
7175
|
+
# "MyDDBTable"`. For more information, see [primaryIdentifier][1] in
|
7176
|
+
# the *CloudFormation Command Line Interface User guide for extension
|
7177
|
+
# development*.
|
7178
|
+
#
|
7179
|
+
#
|
7180
|
+
#
|
7181
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
|
7182
|
+
# @return [Hash<String,String>]
|
7183
|
+
#
|
7184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ScannedResourceIdentifier AWS API Documentation
|
7185
|
+
#
|
7186
|
+
class ScannedResourceIdentifier < Struct.new(
|
7187
|
+
:resource_type,
|
7188
|
+
:resource_identifier)
|
7189
|
+
SENSITIVE = []
|
7190
|
+
include Aws::Structure
|
7191
|
+
end
|
7192
|
+
|
6363
7193
|
# The input for the SetStackPolicy action.
|
6364
7194
|
#
|
6365
7195
|
# @!attribute [rw] stack_name
|
@@ -6381,7 +7211,8 @@ module Aws::CloudFormation
|
|
6381
7211
|
# @!attribute [rw] stack_policy_url
|
6382
7212
|
# Location of a file containing the stack policy. The URL must point
|
6383
7213
|
# to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in
|
6384
|
-
# the same Amazon Web Services Region as the stack.
|
7214
|
+
# the same Amazon Web Services Region as the stack. The location for
|
7215
|
+
# an Amazon S3 bucket must start with `https://`. You can specify
|
6385
7216
|
# either the `StackPolicyBody` or the `StackPolicyURL` parameter, but
|
6386
7217
|
# not both.
|
6387
7218
|
# @return [String]
|
@@ -6400,10 +7231,10 @@ module Aws::CloudFormation
|
|
6400
7231
|
# The Amazon Resource Name (ARN) for the extension, in this account
|
6401
7232
|
# and Region.
|
6402
7233
|
#
|
6403
|
-
# For public extensions, this will be the ARN assigned when you
|
6404
|
-
# [
|
6405
|
-
# extensions, this will be the ARN assigned when you
|
6406
|
-
#
|
7234
|
+
# For public extensions, this will be the ARN assigned when you call
|
7235
|
+
# the [ `ActivateType` ][1] API operation in this account and Region.
|
7236
|
+
# For private extensions, this will be the ARN assigned when you call
|
7237
|
+
# the [ `RegisterType` ][2] API operation in this account and Region.
|
6407
7238
|
#
|
6408
7239
|
# Do not include the extension versions suffix at the end of the ARN.
|
6409
7240
|
# You can set the configuration for an extension, but not for a
|
@@ -6421,9 +7252,9 @@ module Aws::CloudFormation
|
|
6421
7252
|
#
|
6422
7253
|
# The configuration data must be formatted as JSON, and validate
|
6423
7254
|
# against the schema returned in the `ConfigurationSchema` response
|
6424
|
-
# element of [DescribeType][1]. For more information, see
|
6425
|
-
# account-level configuration data for an extension][2] in
|
6426
|
-
# *CloudFormation CLI User Guide*.
|
7255
|
+
# element of [ `DescribeType` ][1]. For more information, see
|
7256
|
+
# [Defining account-level configuration data for an extension][2] in
|
7257
|
+
# the *CloudFormation CLI User Guide*.
|
6427
7258
|
#
|
6428
7259
|
#
|
6429
7260
|
#
|
@@ -6706,6 +7537,20 @@ module Aws::CloudFormation
|
|
6706
7537
|
# Default: `false`
|
6707
7538
|
# @return [Boolean]
|
6708
7539
|
#
|
7540
|
+
# @!attribute [rw] detailed_status
|
7541
|
+
# The detailed status of the resource or stack. If
|
7542
|
+
# `CONFIGURATION_COMPLETE` is present, the resource or resource
|
7543
|
+
# configuration phase has completed and the stabilization of the
|
7544
|
+
# resources is in progress. The stack sets `CONFIGURATION_COMPLETE`
|
7545
|
+
# when all of the resources in the stack have reached that event. For
|
7546
|
+
# more information, see [CloudFormation stack deployment][1] in the
|
7547
|
+
# *CloudFormation User Guide*.
|
7548
|
+
#
|
7549
|
+
#
|
7550
|
+
#
|
7551
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
7552
|
+
# @return [String]
|
7553
|
+
#
|
6709
7554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Stack AWS API Documentation
|
6710
7555
|
#
|
6711
7556
|
class Stack < Struct.new(
|
@@ -6731,7 +7576,8 @@ module Aws::CloudFormation
|
|
6731
7576
|
:parent_id,
|
6732
7577
|
:root_id,
|
6733
7578
|
:drift_information,
|
6734
|
-
:retain_except_on_create
|
7579
|
+
:retain_except_on_create,
|
7580
|
+
:detailed_status)
|
6735
7581
|
SENSITIVE = []
|
6736
7582
|
include Aws::Structure
|
6737
7583
|
end
|
@@ -6904,6 +7750,28 @@ module Aws::CloudFormation
|
|
6904
7750
|
# * `WARN` Allows provisioning to continue with a warning message.
|
6905
7751
|
# @return [String]
|
6906
7752
|
#
|
7753
|
+
# @!attribute [rw] detailed_status
|
7754
|
+
# An optional field containing information about the detailed status
|
7755
|
+
# of the stack event.
|
7756
|
+
#
|
7757
|
+
# * `CONFIGURATION_COMPLETE` - all of the resources in the stack have
|
7758
|
+
# reached that event. For more information, see [CloudFormation
|
7759
|
+
# stack deployment][1] in the *CloudFormation User Guide*.
|
7760
|
+
#
|
7761
|
+
# ^
|
7762
|
+
# ^
|
7763
|
+
#
|
7764
|
+
# * `VALIDATION_FAILED` - template validation failed because of
|
7765
|
+
# invalid properties in the template. The `ResourceStatusReason`
|
7766
|
+
# field shows what properties are defined incorrectly.
|
7767
|
+
#
|
7768
|
+
# ^
|
7769
|
+
#
|
7770
|
+
#
|
7771
|
+
#
|
7772
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
7773
|
+
# @return [String]
|
7774
|
+
#
|
6907
7775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackEvent AWS API Documentation
|
6908
7776
|
#
|
6909
7777
|
class StackEvent < Struct.new(
|
@@ -6922,7 +7790,8 @@ module Aws::CloudFormation
|
|
6922
7790
|
:hook_status,
|
6923
7791
|
:hook_status_reason,
|
6924
7792
|
:hook_invocation_point,
|
6925
|
-
:hook_failure_mode
|
7793
|
+
:hook_failure_mode,
|
7794
|
+
:detailed_status)
|
6926
7795
|
SENSITIVE = []
|
6927
7796
|
include Aws::Structure
|
6928
7797
|
end
|
@@ -6969,7 +7838,12 @@ module Aws::CloudFormation
|
|
6969
7838
|
# excluded from further `UpdateStackSet` operations. You might need
|
6970
7839
|
# to perform a `DeleteStackInstances` operation, with `RetainStacks`
|
6971
7840
|
# set to `true`, to delete the stack instance, and then delete the
|
6972
|
-
# stack manually.
|
7841
|
+
# stack manually. `INOPERABLE` can be returned here when the cause
|
7842
|
+
# is a failed import. If it's due to a failed import, the operation
|
7843
|
+
# can be retried once the failures are fixed. To see if this is due
|
7844
|
+
# to a failed import, look at the `DetailedStatus` member in the
|
7845
|
+
# `StackInstanceSummary` member that is a peer to this `Status`
|
7846
|
+
# member.
|
6973
7847
|
#
|
6974
7848
|
# * `OUTDATED`: The stack isn't currently up to date with the stack
|
6975
7849
|
# set because:
|
@@ -6995,8 +7869,8 @@ module Aws::CloudFormation
|
|
6995
7869
|
#
|
6996
7870
|
# @!attribute [rw] organizational_unit_id
|
6997
7871
|
# \[Service-managed permissions\] The organization root ID or
|
6998
|
-
# organizational unit (OU) IDs that you specified for
|
6999
|
-
#
|
7872
|
+
# organizational unit (OU) IDs that you specified for [
|
7873
|
+
# `DeploymentTargets` ][1].
|
7000
7874
|
#
|
7001
7875
|
#
|
7002
7876
|
#
|
@@ -7065,6 +7939,13 @@ module Aws::CloudFormation
|
|
7065
7939
|
# a Region, the failure tolerance for the stack set operation as a
|
7066
7940
|
# whole might be exceeded.
|
7067
7941
|
#
|
7942
|
+
# * `FAILED_IMPORT`: The import of the stack instance in the specified
|
7943
|
+
# account and Region failed and left the stack in an unstable state.
|
7944
|
+
# Once the issues causing the failure are fixed, the import
|
7945
|
+
# operation can be retried. If enough stack set operations fail in
|
7946
|
+
# enough accounts within a Region, the failure tolerance for the
|
7947
|
+
# stack set operation as a whole might be exceeded.
|
7948
|
+
#
|
7068
7949
|
# * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
|
7069
7950
|
# left the stack in an unstable state. Stacks in this state are
|
7070
7951
|
# excluded from further `UpdateStackSet` operations. You might need
|
@@ -7225,7 +8106,12 @@ module Aws::CloudFormation
|
|
7225
8106
|
# excluded from further `UpdateStackSet` operations. You might need
|
7226
8107
|
# to perform a `DeleteStackInstances` operation, with `RetainStacks`
|
7227
8108
|
# set to `true`, to delete the stack instance, and then delete the
|
7228
|
-
# stack manually.
|
8109
|
+
# stack manually. `INOPERABLE` can be returned here when the cause
|
8110
|
+
# is a failed import. If it's due to a failed import, the operation
|
8111
|
+
# can be retried once the failures are fixed. To see if this is due
|
8112
|
+
# to a failed import, call the DescribeStackInstance API operation,
|
8113
|
+
# look at the `DetailedStatus` member returned in the
|
8114
|
+
# `StackInstanceSummary` member.
|
7229
8115
|
#
|
7230
8116
|
# * `OUTDATED`: The stack isn't currently up to date with the stack
|
7231
8117
|
# set because:
|
@@ -7251,8 +8137,8 @@ module Aws::CloudFormation
|
|
7251
8137
|
#
|
7252
8138
|
# @!attribute [rw] organizational_unit_id
|
7253
8139
|
# \[Service-managed permissions\] The organization root ID or
|
7254
|
-
# organizational unit (OU) IDs that you specified for
|
7255
|
-
#
|
8140
|
+
# organizational unit (OU) IDs that you specified for [
|
8141
|
+
# `DeploymentTargets` ][1].
|
7256
8142
|
#
|
7257
8143
|
#
|
7258
8144
|
#
|
@@ -7867,8 +8753,8 @@ module Aws::CloudFormation
|
|
7867
8753
|
#
|
7868
8754
|
# @!attribute [rw] organizational_unit_ids
|
7869
8755
|
# \[Service-managed permissions\] The organization root ID or
|
7870
|
-
# organizational unit (OU) IDs that you specified for
|
7871
|
-
#
|
8756
|
+
# organizational unit (OU) IDs that you specified for [
|
8757
|
+
# `DeploymentTargets` ][1].
|
7872
8758
|
#
|
7873
8759
|
#
|
7874
8760
|
#
|
@@ -8206,6 +9092,10 @@ module Aws::CloudFormation
|
|
8206
9092
|
# @!attribute [rw] region_order
|
8207
9093
|
# The order of the Regions where you want to perform the stack
|
8208
9094
|
# operation.
|
9095
|
+
#
|
9096
|
+
# <note markdown="1"> `RegionOrder` isn't followed if `AutoDeployment` is enabled.
|
9097
|
+
#
|
9098
|
+
# </note>
|
8209
9099
|
# @return [Array<String>]
|
8210
9100
|
#
|
8211
9101
|
# @!attribute [rw] failure_tolerance_count
|
@@ -8359,8 +9249,8 @@ module Aws::CloudFormation
|
|
8359
9249
|
#
|
8360
9250
|
# @!attribute [rw] organizational_unit_id
|
8361
9251
|
# \[Service-managed permissions\] The organization root ID or
|
8362
|
-
# organizational unit (OU) IDs that you specified for
|
8363
|
-
#
|
9252
|
+
# organizational unit (OU) IDs that you specified for [
|
9253
|
+
# `DeploymentTargets` ][1].
|
8364
9254
|
#
|
8365
9255
|
#
|
8366
9256
|
#
|
@@ -8687,6 +9577,36 @@ module Aws::CloudFormation
|
|
8687
9577
|
#
|
8688
9578
|
class StaleRequestException < Aws::EmptyStructure; end
|
8689
9579
|
|
9580
|
+
# @!attribute [rw] client_request_token
|
9581
|
+
# A unique identifier for this `StartResourceScan` request. Specify
|
9582
|
+
# this token if you plan to retry requests so that CloudFormation
|
9583
|
+
# knows that you're not attempting to start a new resource scan.
|
9584
|
+
# @return [String]
|
9585
|
+
#
|
9586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StartResourceScanInput AWS API Documentation
|
9587
|
+
#
|
9588
|
+
class StartResourceScanInput < Struct.new(
|
9589
|
+
:client_request_token)
|
9590
|
+
SENSITIVE = []
|
9591
|
+
include Aws::Structure
|
9592
|
+
end
|
9593
|
+
|
9594
|
+
# @!attribute [rw] resource_scan_id
|
9595
|
+
# The Amazon Resource Name (ARN) of the resource scan. The format is
|
9596
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}`.
|
9597
|
+
# An example is
|
9598
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
|
9599
|
+
# `.
|
9600
|
+
# @return [String]
|
9601
|
+
#
|
9602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StartResourceScanOutput AWS API Documentation
|
9603
|
+
#
|
9604
|
+
class StartResourceScanOutput < Struct.new(
|
9605
|
+
:resource_scan_id)
|
9606
|
+
SENSITIVE = []
|
9607
|
+
include Aws::Structure
|
9608
|
+
end
|
9609
|
+
|
8690
9610
|
# @!attribute [rw] stack_set_name
|
8691
9611
|
# The name or unique ID of the stack set that you want to stop the
|
8692
9612
|
# operation for.
|
@@ -8756,6 +9676,51 @@ module Aws::CloudFormation
|
|
8756
9676
|
include Aws::Structure
|
8757
9677
|
end
|
8758
9678
|
|
9679
|
+
# The configuration details of a generated template.
|
9680
|
+
#
|
9681
|
+
# @!attribute [rw] deletion_policy
|
9682
|
+
# The `DeletionPolicy` assigned to resources in the generated
|
9683
|
+
# template. Supported values are:
|
9684
|
+
#
|
9685
|
+
# * `DELETE` - delete all resources when the stack is deleted.
|
9686
|
+
#
|
9687
|
+
# * `RETAIN` - retain all resources when the stack is deleted.
|
9688
|
+
#
|
9689
|
+
# For more information, see [ `DeletionPolicy` attribute][1] in the
|
9690
|
+
# *CloudFormation User Guide*.
|
9691
|
+
#
|
9692
|
+
#
|
9693
|
+
#
|
9694
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html
|
9695
|
+
# @return [String]
|
9696
|
+
#
|
9697
|
+
# @!attribute [rw] update_replace_policy
|
9698
|
+
# The `UpdateReplacePolicy` assigned to resources in the generated
|
9699
|
+
# template. Supported values are:
|
9700
|
+
#
|
9701
|
+
# * `DELETE` - delete all resources when the resource is replaced
|
9702
|
+
# during an update operation.
|
9703
|
+
#
|
9704
|
+
# * `RETAIN` - retain all resources when the resource is replaced
|
9705
|
+
# during an update operation.
|
9706
|
+
#
|
9707
|
+
# For more information, see [ `UpdateReplacePolicy` attribute][1] in
|
9708
|
+
# the *CloudFormation User Guide*.
|
9709
|
+
#
|
9710
|
+
#
|
9711
|
+
#
|
9712
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html
|
9713
|
+
# @return [String]
|
9714
|
+
#
|
9715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TemplateConfiguration AWS API Documentation
|
9716
|
+
#
|
9717
|
+
class TemplateConfiguration < Struct.new(
|
9718
|
+
:deletion_policy,
|
9719
|
+
:update_replace_policy)
|
9720
|
+
SENSITIVE = []
|
9721
|
+
include Aws::Structure
|
9722
|
+
end
|
9723
|
+
|
8759
9724
|
# The TemplateParameter data type.
|
8760
9725
|
#
|
8761
9726
|
# @!attribute [rw] parameter_key
|
@@ -8786,6 +9751,104 @@ module Aws::CloudFormation
|
|
8786
9751
|
include Aws::Structure
|
8787
9752
|
end
|
8788
9753
|
|
9754
|
+
# A summary of the progress of the template generation.
|
9755
|
+
#
|
9756
|
+
# @!attribute [rw] resources_succeeded
|
9757
|
+
# The number of resources that succeeded the template generation.
|
9758
|
+
# @return [Integer]
|
9759
|
+
#
|
9760
|
+
# @!attribute [rw] resources_failed
|
9761
|
+
# The number of resources that failed the template generation.
|
9762
|
+
# @return [Integer]
|
9763
|
+
#
|
9764
|
+
# @!attribute [rw] resources_processing
|
9765
|
+
# The number of resources that are in-process for the template
|
9766
|
+
# generation.
|
9767
|
+
# @return [Integer]
|
9768
|
+
#
|
9769
|
+
# @!attribute [rw] resources_pending
|
9770
|
+
# The number of resources that are still pending the template
|
9771
|
+
# generation.
|
9772
|
+
# @return [Integer]
|
9773
|
+
#
|
9774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TemplateProgress AWS API Documentation
|
9775
|
+
#
|
9776
|
+
class TemplateProgress < Struct.new(
|
9777
|
+
:resources_succeeded,
|
9778
|
+
:resources_failed,
|
9779
|
+
:resources_processing,
|
9780
|
+
:resources_pending)
|
9781
|
+
SENSITIVE = []
|
9782
|
+
include Aws::Structure
|
9783
|
+
end
|
9784
|
+
|
9785
|
+
# The summary of a generated template.
|
9786
|
+
#
|
9787
|
+
# @!attribute [rw] generated_template_id
|
9788
|
+
# The Amazon Resource Name (ARN) of the generated template. The format
|
9789
|
+
# is
|
9790
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
9791
|
+
# For example,
|
9792
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
9793
|
+
# `.
|
9794
|
+
# @return [String]
|
9795
|
+
#
|
9796
|
+
# @!attribute [rw] generated_template_name
|
9797
|
+
# The name of the generated template.
|
9798
|
+
# @return [String]
|
9799
|
+
#
|
9800
|
+
# @!attribute [rw] status
|
9801
|
+
# The status of the template generation. Supported values are:
|
9802
|
+
#
|
9803
|
+
# * `CreatePending` - the creation of the template is pending.
|
9804
|
+
#
|
9805
|
+
# * `CreateInProgress` - the creation of the template is in progress.
|
9806
|
+
#
|
9807
|
+
# * `DeletePending` - the deletion of the template is pending.
|
9808
|
+
#
|
9809
|
+
# * `DeleteInProgress` - the deletion of the template is in progress.
|
9810
|
+
#
|
9811
|
+
# * `UpdatePending` - the update of the template is pending.
|
9812
|
+
#
|
9813
|
+
# * `UpdateInProgress` - the update of the template is in progress.
|
9814
|
+
#
|
9815
|
+
# * `Failed` - the template operation failed.
|
9816
|
+
#
|
9817
|
+
# * `Complete` - the template operation is complete.
|
9818
|
+
# @return [String]
|
9819
|
+
#
|
9820
|
+
# @!attribute [rw] status_reason
|
9821
|
+
# The reason for the current template generation status. This will
|
9822
|
+
# provide more details if a failure happened.
|
9823
|
+
# @return [String]
|
9824
|
+
#
|
9825
|
+
# @!attribute [rw] creation_time
|
9826
|
+
# The time the generated template was created.
|
9827
|
+
# @return [Time]
|
9828
|
+
#
|
9829
|
+
# @!attribute [rw] last_updated_time
|
9830
|
+
# The time the generated template was last updated.
|
9831
|
+
# @return [Time]
|
9832
|
+
#
|
9833
|
+
# @!attribute [rw] number_of_resources
|
9834
|
+
# The number of resources in the generated template. This is a total
|
9835
|
+
# of resources in pending, in-progress, completed, and failed states.
|
9836
|
+
# @return [Integer]
|
9837
|
+
#
|
9838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TemplateSummary AWS API Documentation
|
9839
|
+
#
|
9840
|
+
class TemplateSummary < Struct.new(
|
9841
|
+
:generated_template_id,
|
9842
|
+
:generated_template_name,
|
9843
|
+
:status,
|
9844
|
+
:status_reason,
|
9845
|
+
:creation_time,
|
9846
|
+
:last_updated_time,
|
9847
|
+
:number_of_resources)
|
9848
|
+
SENSITIVE = []
|
9849
|
+
include Aws::Structure
|
9850
|
+
end
|
9851
|
+
|
8789
9852
|
# Options for the `GetTemplateSummary` API action.
|
8790
9853
|
#
|
8791
9854
|
# @!attribute [rw] treat_unrecognized_resource_types_as_warnings
|
@@ -8924,10 +9987,10 @@ module Aws::CloudFormation
|
|
8924
9987
|
# The Amazon Resource Name (ARN) for the extension, in this account
|
8925
9988
|
# and Region.
|
8926
9989
|
#
|
8927
|
-
# For public extensions, this will be the ARN assigned when you
|
8928
|
-
# [
|
8929
|
-
# extensions, this will be the ARN assigned when you
|
8930
|
-
#
|
9990
|
+
# For public extensions, this will be the ARN assigned when you call
|
9991
|
+
# the [ `ActivateType` ][1] API operation in this account and Region.
|
9992
|
+
# For private extensions, this will be the ARN assigned when you call
|
9993
|
+
# the [ `RegisterType` ][2] API operation in this account and Region.
|
8931
9994
|
#
|
8932
9995
|
#
|
8933
9996
|
#
|
@@ -8965,10 +10028,10 @@ module Aws::CloudFormation
|
|
8965
10028
|
# The Amazon Resource Name (ARN) for the extension, in this account
|
8966
10029
|
# and Region.
|
8967
10030
|
#
|
8968
|
-
# For public extensions, this will be the ARN assigned when you
|
8969
|
-
# [
|
8970
|
-
# extensions, this will be the ARN assigned when you
|
8971
|
-
#
|
10031
|
+
# For public extensions, this will be the ARN assigned when you call
|
10032
|
+
# the [ `ActivateType` ][1] API operation in this account and Region.
|
10033
|
+
# For private extensions, this will be the ARN assigned when you call
|
10034
|
+
# the [ `RegisterType` ][2] API operation in this account and Region.
|
8972
10035
|
#
|
8973
10036
|
#
|
8974
10037
|
#
|
@@ -9072,9 +10135,9 @@ module Aws::CloudFormation
|
|
9072
10135
|
# @!attribute [rw] type_name
|
9073
10136
|
# The name of the extension.
|
9074
10137
|
#
|
9075
|
-
# If you specified a `TypeNameAlias` when you [
|
9076
|
-
#
|
9077
|
-
# that alias as the type name.
|
10138
|
+
# If you specified a `TypeNameAlias` when you call the [
|
10139
|
+
# `ActivateType` ][1] API operation in your account and Region,
|
10140
|
+
# CloudFormation considers that alias as the type name.
|
9078
10141
|
#
|
9079
10142
|
#
|
9080
10143
|
#
|
@@ -9088,7 +10151,7 @@ module Aws::CloudFormation
|
|
9088
10151
|
# This applies only to private extensions you have registered in your
|
9089
10152
|
# account. For public extensions, both those provided by Amazon and
|
9090
10153
|
# published by third parties, CloudFormation returns `null`. For more
|
9091
|
-
# information, see [RegisterType][1].
|
10154
|
+
# information, see [ `RegisterType` ][1].
|
9092
10155
|
#
|
9093
10156
|
# To set the default version of an extension, use
|
9094
10157
|
# SetTypeDefaultVersion.
|
@@ -9107,11 +10170,11 @@ module Aws::CloudFormation
|
|
9107
10170
|
# only to:
|
9108
10171
|
#
|
9109
10172
|
# * Private extensions you have registered in your account. For more
|
9110
|
-
# information, see [RegisterType][1].
|
10173
|
+
# information, see [ `RegisterType` ][1].
|
9111
10174
|
#
|
9112
10175
|
# * Public extensions you have activated in your account with
|
9113
|
-
# auto-update specified. For more information, see
|
9114
|
-
#
|
10176
|
+
# auto-update specified. For more information, see [ `ActivateType`
|
10177
|
+
# ][2].
|
9115
10178
|
#
|
9116
10179
|
# For all other extension types, CloudFormation returns `null`.
|
9117
10180
|
#
|
@@ -9295,6 +10358,66 @@ module Aws::CloudFormation
|
|
9295
10358
|
include Aws::Structure
|
9296
10359
|
end
|
9297
10360
|
|
10361
|
+
# @!attribute [rw] generated_template_name
|
10362
|
+
# The name or Amazon Resource Name (ARN) of a generated template.
|
10363
|
+
# @return [String]
|
10364
|
+
#
|
10365
|
+
# @!attribute [rw] new_generated_template_name
|
10366
|
+
# An optional new name to assign to the generated template.
|
10367
|
+
# @return [String]
|
10368
|
+
#
|
10369
|
+
# @!attribute [rw] add_resources
|
10370
|
+
# An optional list of resources to be added to the generated template.
|
10371
|
+
# @return [Array<Types::ResourceDefinition>]
|
10372
|
+
#
|
10373
|
+
# @!attribute [rw] remove_resources
|
10374
|
+
# A list of logical ids for resources to remove from the generated
|
10375
|
+
# template.
|
10376
|
+
# @return [Array<String>]
|
10377
|
+
#
|
10378
|
+
# @!attribute [rw] refresh_all_resources
|
10379
|
+
# If `true`, update the resource properties in the generated template
|
10380
|
+
# with their current live state. This feature is useful when the
|
10381
|
+
# resource properties in your generated a template does not reflect
|
10382
|
+
# the live state of the resource properties. This happens when a user
|
10383
|
+
# update the resource properties after generating a template.
|
10384
|
+
# @return [Boolean]
|
10385
|
+
#
|
10386
|
+
# @!attribute [rw] template_configuration
|
10387
|
+
# The configuration details of the generated template, including the
|
10388
|
+
# `DeletionPolicy` and `UpdateReplacePolicy`.
|
10389
|
+
# @return [Types::TemplateConfiguration]
|
10390
|
+
#
|
10391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateGeneratedTemplateInput AWS API Documentation
|
10392
|
+
#
|
10393
|
+
class UpdateGeneratedTemplateInput < Struct.new(
|
10394
|
+
:generated_template_name,
|
10395
|
+
:new_generated_template_name,
|
10396
|
+
:add_resources,
|
10397
|
+
:remove_resources,
|
10398
|
+
:refresh_all_resources,
|
10399
|
+
:template_configuration)
|
10400
|
+
SENSITIVE = []
|
10401
|
+
include Aws::Structure
|
10402
|
+
end
|
10403
|
+
|
10404
|
+
# @!attribute [rw] generated_template_id
|
10405
|
+
# The Amazon Resource Name (ARN) of the generated template. The format
|
10406
|
+
# is
|
10407
|
+
# `arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}`.
|
10408
|
+
# For example,
|
10409
|
+
# `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
|
10410
|
+
# `.
|
10411
|
+
# @return [String]
|
10412
|
+
#
|
10413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateGeneratedTemplateOutput AWS API Documentation
|
10414
|
+
#
|
10415
|
+
class UpdateGeneratedTemplateOutput < Struct.new(
|
10416
|
+
:generated_template_id)
|
10417
|
+
SENSITIVE = []
|
10418
|
+
include Aws::Structure
|
10419
|
+
end
|
10420
|
+
|
9298
10421
|
# The input for an UpdateStack action.
|
9299
10422
|
#
|
9300
10423
|
# @!attribute [rw] stack_name
|
@@ -9319,7 +10442,8 @@ module Aws::CloudFormation
|
|
9319
10442
|
# Location of file containing the template body. The URL must point to
|
9320
10443
|
# a template that's located in an Amazon S3 bucket or a Systems
|
9321
10444
|
# Manager document. For more information, go to [Template Anatomy][1]
|
9322
|
-
# in the *CloudFormation User Guide*.
|
10445
|
+
# in the *CloudFormation User Guide*. The location for an Amazon S3
|
10446
|
+
# bucket must start with `https://`.
|
9323
10447
|
#
|
9324
10448
|
# Conditional: You must specify only one of the following parameters:
|
9325
10449
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -9353,7 +10477,8 @@ module Aws::CloudFormation
|
|
9353
10477
|
# @!attribute [rw] stack_policy_during_update_url
|
9354
10478
|
# Location of a file containing the temporary overriding stack policy.
|
9355
10479
|
# The URL must point to a policy (max size: 16KB) located in an S3
|
9356
|
-
# bucket in the same Region as the stack.
|
10480
|
+
# bucket in the same Region as the stack. The location for an Amazon
|
10481
|
+
# S3 bucket must start with `https://`. You can specify either the
|
9357
10482
|
# `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL`
|
9358
10483
|
# parameter, but not both.
|
9359
10484
|
#
|
@@ -9365,7 +10490,8 @@ module Aws::CloudFormation
|
|
9365
10490
|
#
|
9366
10491
|
# @!attribute [rw] parameters
|
9367
10492
|
# A list of `Parameter` structures that specify input parameters for
|
9368
|
-
# the stack. For more information, see the [Parameter][1] data
|
10493
|
+
# the stack. For more information, see the [ `Parameter` ][1] data
|
10494
|
+
# type.
|
9369
10495
|
#
|
9370
10496
|
#
|
9371
10497
|
#
|
@@ -9400,19 +10526,19 @@ module Aws::CloudFormation
|
|
9400
10526
|
# you review all permissions associated with them and edit their
|
9401
10527
|
# permissions if necessary.
|
9402
10528
|
#
|
9403
|
-
# * [ AWS::IAM::AccessKey][1]
|
10529
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
9404
10530
|
#
|
9405
|
-
# * [ AWS::IAM::Group][2]
|
10531
|
+
# * [ `AWS::IAM::Group` ][2]
|
9406
10532
|
#
|
9407
|
-
# * [AWS::IAM::InstanceProfile][3]
|
10533
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
9408
10534
|
#
|
9409
|
-
# * [ AWS::IAM::Policy][4]
|
10535
|
+
# * [ ` AWS::IAM::Policy` ][4]
|
9410
10536
|
#
|
9411
|
-
# * [ AWS::IAM::Role][5]
|
10537
|
+
# * [ `AWS::IAM::Role` ][5]
|
9412
10538
|
#
|
9413
|
-
# * [ AWS::IAM::User][6]
|
10539
|
+
# * [ `AWS::IAM::User` ][6]
|
9414
10540
|
#
|
9415
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
10541
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
9416
10542
|
#
|
9417
10543
|
# For more information, see [Acknowledging IAM Resources in
|
9418
10544
|
# CloudFormation Templates][8].
|
@@ -9428,9 +10554,9 @@ module Aws::CloudFormation
|
|
9428
10554
|
# your stack template contains one or more macros, and you choose to
|
9429
10555
|
# update a stack directly from the processed template, without first
|
9430
10556
|
# reviewing the resulting changes in a change set, you must
|
9431
|
-
# acknowledge this capability. This includes the [AWS::Include
|
9432
|
-
# and [AWS::Serverless][10] transforms, which are macros
|
9433
|
-
# CloudFormation.
|
10557
|
+
# acknowledge this capability. This includes the [ `AWS::Include`
|
10558
|
+
# ][9] and [ `AWS::Serverless` ][10] transforms, which are macros
|
10559
|
+
# hosted by CloudFormation.
|
9434
10560
|
#
|
9435
10561
|
# If you want to update a stack from a stack template that contains
|
9436
10562
|
# macros *and* nested stacks, you must update the stack directly
|
@@ -9525,8 +10651,9 @@ module Aws::CloudFormation
|
|
9525
10651
|
# @!attribute [rw] stack_policy_url
|
9526
10652
|
# Location of a file containing the updated stack policy. The URL must
|
9527
10653
|
# point to a policy (max size: 16KB) located in an S3 bucket in the
|
9528
|
-
# same Region as the stack.
|
9529
|
-
# `
|
10654
|
+
# same Region as the stack. The location for an Amazon S3 bucket must
|
10655
|
+
# start with `https://`. You can specify either the `StackPolicyBody`
|
10656
|
+
# or the `StackPolicyURL` parameter, but not both.
|
9530
10657
|
#
|
9531
10658
|
# You might update the stack policy, for example, in order to protect
|
9532
10659
|
# a new resource that you created during a stack update. If you don't
|
@@ -9676,11 +10803,11 @@ module Aws::CloudFormation
|
|
9676
10803
|
# the stack set; to add or delete a parameter itself, use
|
9677
10804
|
# `UpdateStackSet` to update the stack set template. If you add a
|
9678
10805
|
# parameter to a template, before you can override the parameter value
|
9679
|
-
# specified in the stack set you must first use [UpdateStackSet
|
9680
|
-
# update all stack instances with the updated template and
|
9681
|
-
# value specified in the stack set. Once a stack instance
|
9682
|
-
# updated with the new parameter, you can then override the
|
9683
|
-
# value using `UpdateStackInstances`.
|
10806
|
+
# specified in the stack set you must first use [ `UpdateStackSet`
|
10807
|
+
# ][1] to update all stack instances with the updated template and
|
10808
|
+
# parameter value specified in the stack set. Once a stack instance
|
10809
|
+
# has been updated with the new parameter, you can then override the
|
10810
|
+
# parameter value using `UpdateStackInstances`.
|
9684
10811
|
#
|
9685
10812
|
#
|
9686
10813
|
#
|
@@ -9852,19 +10979,19 @@ module Aws::CloudFormation
|
|
9852
10979
|
# you review all permissions associated with them and edit their
|
9853
10980
|
# permissions if necessary.
|
9854
10981
|
#
|
9855
|
-
# * [ AWS::IAM::AccessKey][1]
|
10982
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
9856
10983
|
#
|
9857
|
-
# * [ AWS::IAM::Group][2]
|
10984
|
+
# * [ `AWS::IAM::Group` ][2]
|
9858
10985
|
#
|
9859
|
-
# * [ AWS::IAM::InstanceProfile][3]
|
10986
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
9860
10987
|
#
|
9861
|
-
# * [ AWS::IAM::Policy][4]
|
10988
|
+
# * [ `AWS::IAM::Policy` ][4]
|
9862
10989
|
#
|
9863
|
-
# * [ AWS::IAM::Role][5]
|
10990
|
+
# * [ `AWS::IAM::Role` ][5]
|
9864
10991
|
#
|
9865
|
-
# * [ AWS::IAM::User][6]
|
10992
|
+
# * [ `AWS::IAM::User` ][6]
|
9866
10993
|
#
|
9867
|
-
# * [ AWS::IAM::UserToGroupAddition][7]
|
10994
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
9868
10995
|
#
|
9869
10996
|
# For more information, see [Acknowledging IAM Resources in
|
9870
10997
|
# CloudFormation Templates][8].
|
@@ -9880,11 +11007,11 @@ module Aws::CloudFormation
|
|
9880
11007
|
# Processing on Templates][9].
|
9881
11008
|
#
|
9882
11009
|
# Stack sets with service-managed permissions do not currently
|
9883
|
-
# support the use of macros in templates. (This includes the
|
9884
|
-
#
|
9885
|
-
# macros hosted by CloudFormation.) Even if you specify
|
9886
|
-
# capability for a stack set with service-managed permissions,
|
9887
|
-
# you reference a macro in your template the stack set operation
|
11010
|
+
# support the use of macros in templates. (This includes the [
|
11011
|
+
# `AWS::Include` ][10] and [ `AWS::Serverless` ][11] transforms,
|
11012
|
+
# which are macros hosted by CloudFormation.) Even if you specify
|
11013
|
+
# this capability for a stack set with service-managed permissions,
|
11014
|
+
# if you reference a macro in your template the stack set operation
|
9888
11015
|
# will fail.
|
9889
11016
|
#
|
9890
11017
|
#
|
@@ -10200,7 +11327,8 @@ module Aws::CloudFormation
|
|
10200
11327
|
# Location of file containing the template body. The URL must point to
|
10201
11328
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
10202
11329
|
# bucket or a Systems Manager document. For more information, go to
|
10203
|
-
# [Template Anatomy][1] in the *CloudFormation User Guide*.
|
11330
|
+
# [Template Anatomy][1] in the *CloudFormation User Guide*. The
|
11331
|
+
# location for an Amazon S3 bucket must start with `https://`.
|
10204
11332
|
#
|
10205
11333
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
10206
11334
|
# are passed, only `TemplateBody` is used.
|
@@ -10265,6 +11393,81 @@ module Aws::CloudFormation
|
|
10265
11393
|
include Aws::Structure
|
10266
11394
|
end
|
10267
11395
|
|
11396
|
+
# The warnings generated for a specific resource for this generated
|
11397
|
+
# template.
|
11398
|
+
#
|
11399
|
+
# @!attribute [rw] type
|
11400
|
+
# The type of this warning. For more information, see [IaC generator
|
11401
|
+
# and write-only properties][1] in the *CloudFormation User Guide*.
|
11402
|
+
#
|
11403
|
+
# * `MUTUALLY_EXCLUSIVE_PROPERTIES` - The resource requires
|
11404
|
+
# mutually-exclusive write-only properties. The IaC generator
|
11405
|
+
# selects one set of mutually exclusive properties and converts the
|
11406
|
+
# included properties into parameters. The parameter names have a
|
11407
|
+
# suffix `OneOf` and the parameter descriptions indicate that the
|
11408
|
+
# corresponding property can be replaced with other exclusive
|
11409
|
+
# properties.
|
11410
|
+
#
|
11411
|
+
# * `UNSUPPORTED_PROPERTIES` - Unsupported properties are present in
|
11412
|
+
# the resource. One example of unsupported properties would be a
|
11413
|
+
# required write-only property that is an array, because a parameter
|
11414
|
+
# cannot be an array. Another example is an optional write-only
|
11415
|
+
# property.
|
11416
|
+
#
|
11417
|
+
# * `MUTUALLY_EXCLUSIVE_TYPES` - One or more required write-only
|
11418
|
+
# properties are found in the resource, and the type of that
|
11419
|
+
# property can be any of several types.
|
11420
|
+
#
|
11421
|
+
# <note markdown="1"> Currently the resource and property reference documentation does not
|
11422
|
+
# indicate if a property uses a type of `oneOf` or `anyOf`. You need
|
11423
|
+
# to look at the resource provider schema.
|
11424
|
+
#
|
11425
|
+
# </note>
|
11426
|
+
#
|
11427
|
+
#
|
11428
|
+
#
|
11429
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html
|
11430
|
+
# @return [String]
|
11431
|
+
#
|
11432
|
+
# @!attribute [rw] properties
|
11433
|
+
# The properties of the resource that are impacted by this warning.
|
11434
|
+
# @return [Array<Types::WarningProperty>]
|
11435
|
+
#
|
11436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/WarningDetail AWS API Documentation
|
11437
|
+
#
|
11438
|
+
class WarningDetail < Struct.new(
|
11439
|
+
:type,
|
11440
|
+
:properties)
|
11441
|
+
SENSITIVE = []
|
11442
|
+
include Aws::Structure
|
11443
|
+
end
|
11444
|
+
|
11445
|
+
# A specific property that is impacted by a warning.
|
11446
|
+
#
|
11447
|
+
# @!attribute [rw] property_path
|
11448
|
+
# The path of the property. For example, if this is for the `S3Bucket`
|
11449
|
+
# member of the `Code` property, the property path would be
|
11450
|
+
# `Code/S3Bucket`.
|
11451
|
+
# @return [String]
|
11452
|
+
#
|
11453
|
+
# @!attribute [rw] required
|
11454
|
+
# If `true`, the specified property is required.
|
11455
|
+
# @return [Boolean]
|
11456
|
+
#
|
11457
|
+
# @!attribute [rw] description
|
11458
|
+
# The description of the property from the resource provider schema.
|
11459
|
+
# @return [String]
|
11460
|
+
#
|
11461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/WarningProperty AWS API Documentation
|
11462
|
+
#
|
11463
|
+
class WarningProperty < Struct.new(
|
11464
|
+
:property_path,
|
11465
|
+
:required,
|
11466
|
+
:description)
|
11467
|
+
SENSITIVE = []
|
11468
|
+
include Aws::Structure
|
11469
|
+
end
|
11470
|
+
|
10268
11471
|
# Contains any warnings returned by the `GetTemplateSummary` API action.
|
10269
11472
|
#
|
10270
11473
|
# @!attribute [rw] unrecognized_resource_types
|