@aws-sdk/client-cloudformation 3.533.0 → 3.535.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.
- package/dist-types/CloudFormation.d.ts +30 -1
- package/dist-types/CloudFormationClient.d.ts +1 -1
- package/dist-types/commands/ActivateOrganizationsAccessCommand.d.ts +2 -1
- package/dist-types/commands/ActivateTypeCommand.d.ts +2 -1
- package/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -1
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +2 -1
- package/dist-types/commands/CreateChangeSetCommand.d.ts +2 -1
- package/dist-types/commands/CreateGeneratedTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateStackCommand.d.ts +2 -1
- package/dist-types/commands/CreateStackInstancesCommand.d.ts +2 -1
- package/dist-types/commands/CreateStackSetCommand.d.ts +2 -1
- package/dist-types/commands/DeactivateOrganizationsAccessCommand.d.ts +2 -1
- package/dist-types/commands/DeactivateTypeCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +2 -1
- package/dist-types/commands/DeleteGeneratedTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStackCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStackInstancesCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStackSetCommand.d.ts +2 -1
- package/dist-types/commands/DeregisterTypeCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChangeSetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +2 -1
- package/dist-types/commands/DescribeGeneratedTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DescribeOrganizationsAccessCommand.d.ts +2 -1
- package/dist-types/commands/DescribePublisherCommand.d.ts +2 -1
- package/dist-types/commands/DescribeResourceScanCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackDriftDetectionStatusCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackInstanceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackResourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackResourcesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackSetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStackSetOperationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStacksCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTypeCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTypeRegistrationCommand.d.ts +2 -1
- package/dist-types/commands/DetectStackDriftCommand.d.ts +2 -1
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +2 -1
- package/dist-types/commands/DetectStackSetDriftCommand.d.ts +2 -1
- package/dist-types/commands/EstimateTemplateCostCommand.d.ts +2 -1
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +2 -1
- package/dist-types/commands/GetGeneratedTemplateCommand.d.ts +2 -1
- package/dist-types/commands/GetStackPolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetTemplateCommand.d.ts +2 -1
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +2 -1
- package/dist-types/commands/ImportStacksToStackSetCommand.d.ts +2 -1
- package/dist-types/commands/ListChangeSetsCommand.d.ts +2 -1
- package/dist-types/commands/ListExportsCommand.d.ts +2 -1
- package/dist-types/commands/ListGeneratedTemplatesCommand.d.ts +2 -1
- package/dist-types/commands/ListImportsCommand.d.ts +2 -1
- package/dist-types/commands/ListResourceScanRelatedResourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListResourceScanResourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListResourceScansCommand.d.ts +2 -1
- package/dist-types/commands/ListStackInstanceResourceDriftsCommand.d.ts +2 -1
- package/dist-types/commands/ListStackInstancesCommand.d.ts +2 -1
- package/dist-types/commands/ListStackResourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListStackSetOperationResultsCommand.d.ts +2 -1
- package/dist-types/commands/ListStackSetOperationsCommand.d.ts +2 -1
- package/dist-types/commands/ListStackSetsCommand.d.ts +2 -1
- package/dist-types/commands/ListStacksCommand.d.ts +2 -1
- package/dist-types/commands/ListTypeRegistrationsCommand.d.ts +2 -1
- package/dist-types/commands/ListTypeVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTypesCommand.d.ts +2 -1
- package/dist-types/commands/PublishTypeCommand.d.ts +2 -1
- package/dist-types/commands/RecordHandlerProgressCommand.d.ts +2 -1
- package/dist-types/commands/RegisterPublisherCommand.d.ts +2 -1
- package/dist-types/commands/RegisterTypeCommand.d.ts +2 -1
- package/dist-types/commands/RollbackStackCommand.d.ts +2 -1
- package/dist-types/commands/SetStackPolicyCommand.d.ts +2 -1
- package/dist-types/commands/SetTypeConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/SetTypeDefaultVersionCommand.d.ts +2 -1
- package/dist-types/commands/SignalResourceCommand.d.ts +2 -1
- package/dist-types/commands/StartResourceScanCommand.d.ts +2 -1
- package/dist-types/commands/StopStackSetOperationCommand.d.ts +2 -1
- package/dist-types/commands/TestTypeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGeneratedTemplateCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStackCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStackInstancesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStackSetCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +2 -1
- package/dist-types/commands/ValidateTemplateCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +993 -993
- package/dist-types/models/models_1.d.ts +86 -86
- package/dist-types/ts3.4/CloudFormation.d.ts +29 -0
- package/dist-types/ts3.4/commands/ActivateOrganizationsAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ActivateTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchDescribeTypeConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelUpdateStackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ContinueUpdateRollbackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChangeSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateGeneratedTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStackInstancesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStackSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeactivateOrganizationsAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeactivateTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChangeSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteGeneratedTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStackInstancesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStackSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeregisterTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAccountLimitsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChangeSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChangeSetHooksCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeGeneratedTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeOrganizationsAccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribePublisherCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeResourceScanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackDriftDetectionStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackResourceDriftsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStackSetOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStacksCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTypeRegistrationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DetectStackDriftCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DetectStackResourceDriftCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DetectStackSetDriftCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EstimateTemplateCostCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ExecuteChangeSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGeneratedTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetStackPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTemplateSummaryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportStacksToStackSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChangeSetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListExportsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListGeneratedTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListImportsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListResourceScanRelatedResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListResourceScanResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListResourceScansCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStackInstanceResourceDriftsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStackInstancesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStackResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStackSetOperationResultsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStackSetOperationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStackSetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStacksCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTypeRegistrationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTypeVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTypesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PublishTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RecordHandlerProgressCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RegisterPublisherCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RegisterTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RollbackStackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetStackPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetTypeConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetTypeDefaultVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SignalResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartResourceScanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopStackSetOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TestTypeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateGeneratedTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStackInstancesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStackSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTerminationProtectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ValidateTemplateCommand.d.ts +9 -0
- package/package.json +41 -41
|
@@ -2,7 +2,6 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { CloudFormationServiceException as __BaseException } from "./CloudFormationServiceException";
|
|
3
3
|
import { AutoDeployment, CallAs, Capability, DeploymentTargets, ManagedExecution, Parameter, PermissionModels, ResourceDefinition, RollbackConfiguration, StackSetOperationPreferences, Tag, TemplateConfiguration, ThirdPartyType } from "./models_0";
|
|
4
4
|
/**
|
|
5
|
-
* @public
|
|
6
5
|
* <p>The limit on resource scans has been exceeded. Reasons include:</p>
|
|
7
6
|
* <ul>
|
|
8
7
|
* <li>
|
|
@@ -16,6 +15,7 @@ import { AutoDeployment, CallAs, Capability, DeploymentTargets, ManagedExecution
|
|
|
16
15
|
* before starting a new resource scan.</p>
|
|
17
16
|
* </li>
|
|
18
17
|
* </ul>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
export declare class ResourceScanLimitExceededException extends __BaseException {
|
|
21
21
|
readonly name: "ResourceScanLimitExceededException";
|
|
@@ -31,9 +31,9 @@ export declare class ResourceScanLimitExceededException extends __BaseException
|
|
|
31
31
|
*/
|
|
32
32
|
export interface StartResourceScanInput {
|
|
33
33
|
/**
|
|
34
|
-
* @public
|
|
35
34
|
* <p>A unique identifier for this <code>StartResourceScan</code> request. Specify this token if you plan to retry
|
|
36
35
|
* requests so that CloudFormation knows that you're not attempting to start a new resource scan.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
ClientRequestToken?: string;
|
|
39
39
|
}
|
|
@@ -42,11 +42,11 @@ export interface StartResourceScanInput {
|
|
|
42
42
|
*/
|
|
43
43
|
export interface StartResourceScanOutput {
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>The Amazon Resource Name (ARN) of the resource scan. The format is
|
|
47
46
|
* <code>arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}</code>. An example is
|
|
48
47
|
* <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i>
|
|
49
48
|
* </code>.</p>
|
|
49
|
+
* @public
|
|
50
50
|
*/
|
|
51
51
|
ResourceScanId?: string;
|
|
52
52
|
}
|
|
@@ -55,17 +55,16 @@ export interface StartResourceScanOutput {
|
|
|
55
55
|
*/
|
|
56
56
|
export interface StopStackSetOperationInput {
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>The name or unique ID of the stack set that you want to stop the operation for.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
StackSetName: string | undefined;
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>The ID of the stack operation.</p>
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
OperationId: string | undefined;
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
70
69
|
* management account or as a delegated administrator in a member account.</p>
|
|
71
70
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
@@ -80,6 +79,7 @@ export interface StopStackSetOperationInput {
|
|
|
80
79
|
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
81
80
|
* </li>
|
|
82
81
|
* </ul>
|
|
82
|
+
* @public
|
|
83
83
|
*/
|
|
84
84
|
CallAs?: CallAs;
|
|
85
85
|
}
|
|
@@ -93,34 +93,33 @@ export interface StopStackSetOperationOutput {
|
|
|
93
93
|
*/
|
|
94
94
|
export interface TestTypeInput {
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
98
97
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
Arn?: string;
|
|
101
101
|
/**
|
|
102
|
-
* @public
|
|
103
102
|
* <p>The type of the extension to test.</p>
|
|
104
103
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
Type?: ThirdPartyType;
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>The name of the extension to test.</p>
|
|
110
109
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
TypeName?: string;
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>The version of the extension to test.</p>
|
|
116
115
|
* <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and
|
|
117
116
|
* <code>Type</code>.</p>
|
|
118
117
|
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region
|
|
119
118
|
* for testing.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
VersionId?: string;
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
|
|
125
124
|
* <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a
|
|
126
125
|
* test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
|
|
@@ -139,6 +138,7 @@ export interface TestTypeInput {
|
|
|
139
138
|
* </li>
|
|
140
139
|
* </ul>
|
|
141
140
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
141
|
+
* @public
|
|
142
142
|
*/
|
|
143
143
|
LogDeliveryBucket?: string;
|
|
144
144
|
}
|
|
@@ -147,8 +147,8 @@ export interface TestTypeInput {
|
|
|
147
147
|
*/
|
|
148
148
|
export interface TestTypeOutput {
|
|
149
149
|
/**
|
|
150
|
-
* @public
|
|
151
150
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
151
|
+
* @public
|
|
152
152
|
*/
|
|
153
153
|
TypeVersionArn?: string;
|
|
154
154
|
}
|
|
@@ -157,36 +157,36 @@ export interface TestTypeOutput {
|
|
|
157
157
|
*/
|
|
158
158
|
export interface UpdateGeneratedTemplateInput {
|
|
159
159
|
/**
|
|
160
|
-
* @public
|
|
161
160
|
* <p>The name or Amazon Resource Name (ARN) of a generated template.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
GeneratedTemplateName: string | undefined;
|
|
164
164
|
/**
|
|
165
|
-
* @public
|
|
166
165
|
* <p>An optional new name to assign to the generated template.</p>
|
|
166
|
+
* @public
|
|
167
167
|
*/
|
|
168
168
|
NewGeneratedTemplateName?: string;
|
|
169
169
|
/**
|
|
170
|
-
* @public
|
|
171
170
|
* <p>An optional list of resources to be added to the generated template.</p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
AddResources?: ResourceDefinition[];
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>A list of logical ids for resources to remove from the generated template.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
RemoveResources?: string[];
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>If <code>true</code>, update the resource properties in the generated template with their current live state.
|
|
182
181
|
* This feature is useful when the resource properties in your generated a template does not reflect the live state of
|
|
183
182
|
* the resource properties. This happens when a user update the resource properties after generating a template.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
RefreshAllResources?: boolean;
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>The configuration details of the generated template, including the <code>DeletionPolicy</code> and
|
|
189
188
|
* <code>UpdateReplacePolicy</code>.</p>
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
TemplateConfiguration?: TemplateConfiguration;
|
|
192
192
|
}
|
|
@@ -195,78 +195,77 @@ export interface UpdateGeneratedTemplateInput {
|
|
|
195
195
|
*/
|
|
196
196
|
export interface UpdateGeneratedTemplateOutput {
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p>The Amazon Resource Name (ARN) of the generated template. The format is
|
|
200
199
|
* <code>arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}</code>. For example,
|
|
201
200
|
* <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i>
|
|
202
201
|
* </code>.</p>
|
|
202
|
+
* @public
|
|
203
203
|
*/
|
|
204
204
|
GeneratedTemplateId?: string;
|
|
205
205
|
}
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>The input for an <a>UpdateStack</a> action.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
export interface UpdateStackInput {
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>The name or unique stack ID of the stack to update.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
StackName: string | undefined;
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
|
219
218
|
* (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
220
219
|
* <i>CloudFormation User Guide</i>.)</p>
|
|
221
220
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
222
221
|
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
222
|
+
* @public
|
|
223
223
|
*/
|
|
224
224
|
TemplateBody?: string;
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p>Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
228
227
|
* <i>CloudFormation User Guide</i>. The location for an Amazon S3 bucket must start with <code>https://</code>.</p>
|
|
229
228
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
230
229
|
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
TemplateURL?: string;
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <p>Reuse the existing template that is associated with the stack that you are updating.</p>
|
|
236
235
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
237
236
|
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
UsePreviousTemplate?: boolean;
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>Structure containing the temporary overriding stack policy body. You can specify either the
|
|
243
242
|
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not
|
|
244
243
|
* both.</p>
|
|
245
244
|
* <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If
|
|
246
245
|
* you don't specify a stack policy, the current policy that is associated with the stack will be used.</p>
|
|
246
|
+
* @public
|
|
247
247
|
*/
|
|
248
248
|
StackPolicyDuringUpdateBody?: string;
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
|
|
252
251
|
* 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
|
|
253
252
|
* <code>https://</code>. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the
|
|
254
253
|
* <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p>
|
|
255
254
|
* <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If
|
|
256
255
|
* you don't specify a stack policy, the current policy that is associated with the stack will be used.</p>
|
|
256
|
+
* @public
|
|
257
257
|
*/
|
|
258
258
|
StackPolicyDuringUpdateURL?: string;
|
|
259
259
|
/**
|
|
260
|
-
* @public
|
|
261
260
|
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information,
|
|
262
261
|
* see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">
|
|
263
262
|
* <code>Parameter</code>
|
|
264
263
|
* </a>
|
|
265
264
|
* data type.</p>
|
|
265
|
+
* @public
|
|
266
266
|
*/
|
|
267
267
|
Parameters?: Parameter[];
|
|
268
268
|
/**
|
|
269
|
-
* @public
|
|
270
269
|
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
271
270
|
* for CloudFormation to update the stack.</p>
|
|
272
271
|
* <ul>
|
|
@@ -380,10 +379,10 @@ export interface UpdateStackInput {
|
|
|
380
379
|
* <note>
|
|
381
380
|
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p>
|
|
382
381
|
* </note>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
Capabilities?: Capability[];
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>The template resource types that you have permissions to work with for this update stack action, such as
|
|
388
387
|
* <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p>
|
|
389
388
|
* <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By
|
|
@@ -392,35 +391,35 @@ export interface UpdateStackInput {
|
|
|
392
391
|
* <note>
|
|
393
392
|
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p>
|
|
394
393
|
* </note>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
ResourceTypes?: string[];
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
|
|
400
399
|
* update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role
|
|
401
400
|
* for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses
|
|
402
401
|
* this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p>
|
|
403
402
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role
|
|
404
403
|
* is available, CloudFormation uses a temporary session that is generated from your user credentials.</p>
|
|
404
|
+
* @public
|
|
405
405
|
*/
|
|
406
406
|
RoleARN?: string;
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
|
|
410
409
|
* specified monitoring period afterwards.</p>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
RollbackConfiguration?: RollbackConfiguration;
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the
|
|
416
415
|
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
417
416
|
* <p>You might update the stack policy, for example, in order to protect a new resource that you created during a
|
|
418
417
|
* stack update. If you don't specify a stack policy, the current policy that is associated with the stack is
|
|
419
418
|
* unchanged.</p>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
StackPolicyBody?: string;
|
|
422
422
|
/**
|
|
423
|
-
* @public
|
|
424
423
|
* <p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
|
|
425
424
|
* in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
|
|
426
425
|
* <code>https://</code>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code>
|
|
@@ -428,31 +427,31 @@ export interface UpdateStackInput {
|
|
|
428
427
|
* <p>You might update the stack policy, for example, in order to protect a new resource that you created during a
|
|
429
428
|
* stack update. If you don't specify a stack policy, the current policy that is associated with the stack is
|
|
430
429
|
* unchanged.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
StackPolicyURL?: string;
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.
|
|
436
435
|
* Specify an empty list to remove all notification topics.</p>
|
|
436
|
+
* @public
|
|
437
437
|
*/
|
|
438
438
|
NotificationARNs?: string[];
|
|
439
439
|
/**
|
|
440
|
-
* @public
|
|
441
440
|
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the
|
|
442
441
|
* stack. You can specify a maximum number of 50 tags.</p>
|
|
443
442
|
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value,
|
|
444
443
|
* CloudFormation removes all associated tags.</p>
|
|
444
|
+
* @public
|
|
445
445
|
*/
|
|
446
446
|
Tags?: Tag[];
|
|
447
447
|
/**
|
|
448
|
-
* @public
|
|
449
448
|
* <p>Preserve the state of previously provisioned resources when an operation fails.</p>
|
|
450
449
|
* <p>Default: <code>False</code>
|
|
451
450
|
* </p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
DisableRollback?: boolean;
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests
|
|
457
456
|
* so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
|
|
458
457
|
* <code>UpdateStack</code> requests to ensure that CloudFormation successfully received them.</p>
|
|
@@ -465,25 +464,26 @@ export interface UpdateStackInput {
|
|
|
465
464
|
* easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
|
|
466
465
|
* assigned the same token in the following format:
|
|
467
466
|
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
467
|
+
* @public
|
|
468
468
|
*/
|
|
469
469
|
ClientRequestToken?: string;
|
|
470
470
|
/**
|
|
471
|
-
* @public
|
|
472
471
|
* <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes
|
|
473
472
|
* newly created resources marked with a deletion policy of <code>Retain</code>.</p>
|
|
474
473
|
* <p>Default: <code>false</code>
|
|
475
474
|
* </p>
|
|
475
|
+
* @public
|
|
476
476
|
*/
|
|
477
477
|
RetainExceptOnCreate?: boolean;
|
|
478
478
|
}
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>The output for an <a>UpdateStack</a> action.</p>
|
|
481
|
+
* @public
|
|
482
482
|
*/
|
|
483
483
|
export interface UpdateStackOutput {
|
|
484
484
|
/**
|
|
485
|
-
* @public
|
|
486
485
|
* <p>Unique identifier of the stack.</p>
|
|
486
|
+
* @public
|
|
487
487
|
*/
|
|
488
488
|
StackId?: string;
|
|
489
489
|
}
|
|
@@ -492,36 +492,35 @@ export interface UpdateStackOutput {
|
|
|
492
492
|
*/
|
|
493
493
|
export interface UpdateStackInstancesInput {
|
|
494
494
|
/**
|
|
495
|
-
* @public
|
|
496
495
|
* <p>The name or unique ID of the stack set associated with the stack instances.</p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
StackSetName: string | undefined;
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update
|
|
502
501
|
* parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the
|
|
503
502
|
* specified accounts and Amazon Web Services Regions.</p>
|
|
504
503
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
504
|
+
* @public
|
|
505
505
|
*/
|
|
506
506
|
Accounts?: string[];
|
|
507
507
|
/**
|
|
508
|
-
* @public
|
|
509
508
|
* <p>[Service-managed permissions] The Organizations accounts for which you want to update parameter values
|
|
510
509
|
* for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are
|
|
511
510
|
* currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future
|
|
512
511
|
* won't use the overridden values.</p>
|
|
513
512
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
DeploymentTargets?: DeploymentTargets;
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack
|
|
519
518
|
* instances. The overridden parameter values will be applied to all stack instances in the specified accounts and
|
|
520
519
|
* Amazon Web Services Regions.</p>
|
|
520
|
+
* @public
|
|
521
521
|
*/
|
|
522
522
|
Regions: string[] | undefined;
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>A list of input parameters whose values you want to update for the specified stack instances.</p>
|
|
526
525
|
* <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values
|
|
527
526
|
* during stack instance update operations:</p>
|
|
@@ -552,24 +551,24 @@ export interface UpdateStackInstancesInput {
|
|
|
552
551
|
* update all stack instances with the updated template and parameter value specified in the stack set. Once a stack
|
|
553
552
|
* instance has been updated with the new parameter, you can then override the parameter value using
|
|
554
553
|
* <code>UpdateStackInstances</code>.</p>
|
|
554
|
+
* @public
|
|
555
555
|
*/
|
|
556
556
|
ParameterOverrides?: Parameter[];
|
|
557
557
|
/**
|
|
558
|
-
* @public
|
|
559
558
|
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
OperationPreferences?: StackSetOperationPreferences;
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The unique identifier for this stack set operation.</p>
|
|
565
564
|
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
|
|
566
565
|
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests to
|
|
567
566
|
* ensure that CloudFormation successfully received them.</p>
|
|
568
567
|
* <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
|
|
568
|
+
* @public
|
|
569
569
|
*/
|
|
570
570
|
OperationId?: string;
|
|
571
571
|
/**
|
|
572
|
-
* @public
|
|
573
572
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
574
573
|
* management account or as a delegated administrator in a member account.</p>
|
|
575
574
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
@@ -584,6 +583,7 @@ export interface UpdateStackInstancesInput {
|
|
|
584
583
|
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
585
584
|
* </li>
|
|
586
585
|
* </ul>
|
|
586
|
+
* @public
|
|
587
587
|
*/
|
|
588
588
|
CallAs?: CallAs;
|
|
589
589
|
}
|
|
@@ -592,8 +592,8 @@ export interface UpdateStackInstancesInput {
|
|
|
592
592
|
*/
|
|
593
593
|
export interface UpdateStackInstancesOutput {
|
|
594
594
|
/**
|
|
595
|
-
* @public
|
|
596
595
|
* <p>The unique identifier for this stack set operation.</p>
|
|
596
|
+
* @public
|
|
597
597
|
*/
|
|
598
598
|
OperationId?: string;
|
|
599
599
|
}
|
|
@@ -602,48 +602,47 @@ export interface UpdateStackInstancesOutput {
|
|
|
602
602
|
*/
|
|
603
603
|
export interface UpdateStackSetInput {
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p>The name or unique ID of the stack set that you want to update.</p>
|
|
606
|
+
* @public
|
|
607
607
|
*/
|
|
608
608
|
StackSetName: string | undefined;
|
|
609
609
|
/**
|
|
610
|
-
* @public
|
|
611
610
|
* <p>A brief description of updates that you are making.</p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
Description?: string;
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
|
|
617
616
|
* bytes. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
618
617
|
* <i>CloudFormation User Guide</i>.</p>
|
|
619
618
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
|
|
620
619
|
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
|
|
620
|
+
* @public
|
|
621
621
|
*/
|
|
622
622
|
TemplateBody?: string;
|
|
623
623
|
/**
|
|
624
|
-
* @public
|
|
625
624
|
* <p>The location of the file that contains the template body. The URL must point to a template (maximum size:
|
|
626
625
|
* 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
627
626
|
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
628
627
|
* Anatomy</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
629
628
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
|
|
630
629
|
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
TemplateURL?: string;
|
|
633
633
|
/**
|
|
634
|
-
* @public
|
|
635
634
|
* <p>Use the existing template that's associated with the stack set that you're updating.</p>
|
|
636
635
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
|
|
637
636
|
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
|
|
637
|
+
* @public
|
|
638
638
|
*/
|
|
639
639
|
UsePreviousTemplate?: boolean;
|
|
640
640
|
/**
|
|
641
|
-
* @public
|
|
642
641
|
* <p>A list of input parameters for the stack set template.</p>
|
|
642
|
+
* @public
|
|
643
643
|
*/
|
|
644
644
|
Parameters?: Parameter[];
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
648
647
|
* for CloudFormation to update the stack set and its associated stack instances.</p>
|
|
649
648
|
* <ul>
|
|
@@ -745,10 +744,10 @@ export interface UpdateStackSetInput {
|
|
|
745
744
|
* </important>
|
|
746
745
|
* </li>
|
|
747
746
|
* </ul>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
Capabilities?: Capability[];
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these
|
|
753
752
|
* tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.</p>
|
|
754
753
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are currently associated with
|
|
@@ -773,25 +772,25 @@ export interface UpdateStackSetInput {
|
|
|
773
772
|
* if you have permission to untag resources. If you don't have the necessary permission(s), the entire
|
|
774
773
|
* <code>UpdateStackSet</code> action fails with an <code>access denied</code> error, and the stack set is not
|
|
775
774
|
* updated.</p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
Tags?: Tag[];
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
OperationPreferences?: StackSetOperationPreferences;
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.</p>
|
|
786
785
|
* <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can
|
|
787
786
|
* manage specific stack sets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Granting Permissions for Stack
|
|
788
787
|
* Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
789
788
|
* <p>If you specified a customized administrator role when you created the stack set, you must specify a customized
|
|
790
789
|
* administrator role, even if it is the same customized administrator role used with this stack set previously.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
AdministrationRoleARN?: string;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,
|
|
796
795
|
* CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p>
|
|
797
796
|
* <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users
|
|
@@ -799,10 +798,10 @@ export interface UpdateStackSetInput {
|
|
|
799
798
|
* <p>If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a
|
|
800
799
|
* customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long
|
|
801
800
|
* as you have permissions to perform operations on the stack set.</p>
|
|
801
|
+
* @public
|
|
802
802
|
*/
|
|
803
803
|
ExecutionRoleName?: string;
|
|
804
804
|
/**
|
|
805
|
-
* @public
|
|
806
805
|
* <p>[Service-managed permissions] The Organizations accounts in which to update associated stack
|
|
807
806
|
* instances.</p>
|
|
808
807
|
* <p>To update all the stack instances associated with this stack set, do not specify <code>DeploymentTargets</code>
|
|
@@ -812,10 +811,10 @@ export interface UpdateStackSetInput {
|
|
|
812
811
|
* of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances
|
|
813
812
|
* in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance
|
|
814
813
|
* status.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
DeploymentTargets?: DeploymentTargets;
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>Describes how the IAM roles required for stack set operations are created. You cannot modify
|
|
820
819
|
* <code>PermissionModel</code> if there are stack instances associated with your stack set.</p>
|
|
821
820
|
* <ul>
|
|
@@ -830,18 +829,18 @@ export interface UpdateStackSetInput {
|
|
|
830
829
|
* Permissions</a>.</p>
|
|
831
830
|
* </li>
|
|
832
831
|
* </ul>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
PermissionModel?: PermissionModels;
|
|
835
835
|
/**
|
|
836
|
-
* @public
|
|
837
836
|
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations
|
|
838
837
|
* accounts that are added to a target organization or organizational unit (OU).</p>
|
|
839
838
|
* <p>If you specify <code>AutoDeployment</code>, don't specify <code>DeploymentTargets</code> or
|
|
840
839
|
* <code>Regions</code>.</p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
AutoDeployment?: AutoDeployment;
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>The unique ID for this stack set operation.</p>
|
|
846
845
|
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
|
|
847
846
|
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests to
|
|
@@ -849,10 +848,10 @@ export interface UpdateStackSetInput {
|
|
|
849
848
|
* <p>If you don't specify an operation ID, CloudFormation generates one automatically.</p>
|
|
850
849
|
* <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is
|
|
851
850
|
* <code>OUTDATED</code>.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
OperationId?: string;
|
|
854
854
|
/**
|
|
855
|
-
* @public
|
|
856
855
|
* <p>[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,
|
|
857
856
|
* you must also specify the Amazon Web Services Regions in which to update stack set instances.</p>
|
|
858
857
|
* <p>To update <i>all</i> the stack instances associated with this stack set, don't specify the
|
|
@@ -863,10 +862,10 @@ export interface UpdateStackSetInput {
|
|
|
863
862
|
* Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation
|
|
864
863
|
* updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack
|
|
865
864
|
* instances with their existing stack instance status.</p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
Accounts?: string[];
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must
|
|
871
870
|
* also specify accounts in which to update stack set instances.</p>
|
|
872
871
|
* <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the
|
|
@@ -877,10 +876,10 @@ export interface UpdateStackSetInput {
|
|
|
877
876
|
* Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack
|
|
878
877
|
* instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack
|
|
879
878
|
* instance status.</p>
|
|
879
|
+
* @public
|
|
880
880
|
*/
|
|
881
881
|
Regions?: string[];
|
|
882
882
|
/**
|
|
883
|
-
* @public
|
|
884
883
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
885
884
|
* management account or as a delegated administrator in a member account.</p>
|
|
886
885
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
@@ -895,12 +894,13 @@ export interface UpdateStackSetInput {
|
|
|
895
894
|
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
896
895
|
* </li>
|
|
897
896
|
* </ul>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
CallAs?: CallAs;
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting
|
|
903
902
|
* operations.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
ManagedExecution?: ManagedExecution;
|
|
906
906
|
}
|
|
@@ -909,8 +909,8 @@ export interface UpdateStackSetInput {
|
|
|
909
909
|
*/
|
|
910
910
|
export interface UpdateStackSetOutput {
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>The unique ID for this stack set operation.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
OperationId?: string;
|
|
916
916
|
}
|
|
@@ -919,13 +919,13 @@ export interface UpdateStackSetOutput {
|
|
|
919
919
|
*/
|
|
920
920
|
export interface UpdateTerminationProtectionInput {
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>Whether to enable termination protection on the specified stack.</p>
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
EnableTerminationProtection: boolean | undefined;
|
|
926
926
|
/**
|
|
927
|
-
* @public
|
|
928
927
|
* <p>The name or unique ID of the stack for which you want to set termination protection.</p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
StackName: string | undefined;
|
|
931
931
|
}
|
|
@@ -934,93 +934,93 @@ export interface UpdateTerminationProtectionInput {
|
|
|
934
934
|
*/
|
|
935
935
|
export interface UpdateTerminationProtectionOutput {
|
|
936
936
|
/**
|
|
937
|
-
* @public
|
|
938
937
|
* <p>The unique ID of the stack.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
StackId?: string;
|
|
941
941
|
}
|
|
942
942
|
/**
|
|
943
|
-
* @public
|
|
944
943
|
* <p>The input for <a>ValidateTemplate</a> action.</p>
|
|
944
|
+
* @public
|
|
945
945
|
*/
|
|
946
946
|
export interface ValidateTemplateInput {
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
|
|
950
949
|
* more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
951
950
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
952
951
|
* <code>TemplateBody</code> is used.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
TemplateBody?: string;
|
|
955
955
|
/**
|
|
956
|
-
* @public
|
|
957
956
|
* <p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that
|
|
958
957
|
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
959
958
|
* <i>CloudFormation User Guide</i>. The location for an Amazon S3 bucket must start with <code>https://</code>.</p>
|
|
960
959
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
961
960
|
* <code>TemplateBody</code> is used.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
TemplateURL?: string;
|
|
964
964
|
}
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>The TemplateParameter data type.</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
export interface TemplateParameter {
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>The name associated with the parameter.</p>
|
|
972
|
+
* @public
|
|
973
973
|
*/
|
|
974
974
|
ParameterKey?: string;
|
|
975
975
|
/**
|
|
976
|
-
* @public
|
|
977
976
|
* <p>The default value associated with the parameter.</p>
|
|
977
|
+
* @public
|
|
978
978
|
*/
|
|
979
979
|
DefaultValue?: string;
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>Flag indicating whether the parameter should be displayed as plain text in logs and UIs.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
NoEcho?: boolean;
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>User defined description associated with the parameter.</p>
|
|
987
|
+
* @public
|
|
988
988
|
*/
|
|
989
989
|
Description?: string;
|
|
990
990
|
}
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>The output for <a>ValidateTemplate</a> action.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
export interface ValidateTemplateOutput {
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>A list of <code>TemplateParameter</code> structures.</p>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
Parameters?: TemplateParameter[];
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>The description found within the template.</p>
|
|
1003
|
+
* @public
|
|
1004
1004
|
*/
|
|
1005
1005
|
Description?: string;
|
|
1006
1006
|
/**
|
|
1007
|
-
* @public
|
|
1008
1007
|
* <p>The capabilities found within the template. If your template contains IAM resources, you must specify the
|
|
1009
1008
|
* CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or
|
|
1010
1009
|
* <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities
|
|
1011
1010
|
* error.</p>
|
|
1012
1011
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in
|
|
1013
1012
|
* CloudFormation Templates</a>.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
Capabilities?: Capability[];
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>
|
|
1018
|
+
* @public
|
|
1019
1019
|
*/
|
|
1020
1020
|
CapabilitiesReason?: string;
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>A list of the transforms that are declared in the template.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
DeclaredTransforms?: string[];
|
|
1026
1026
|
}
|