@aws-sdk/client-cloudformation 3.533.0 → 3.536.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/README.md +8 -0
- package/dist-cjs/index.js +91 -2
- package/dist-es/CloudFormation.js +2 -0
- package/dist-es/commands/ListStackSetAutoDeploymentTargetsCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +0 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_query.js +73 -0
- package/dist-types/CloudFormation.d.ts +37 -1
- package/dist-types/CloudFormationClient.d.ts +4 -3
- package/dist-types/commands/ActivateOrganizationsAccessCommand.d.ts +2 -1
- package/dist-types/commands/ActivateTypeCommand.d.ts +5 -2
- 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/ListStackSetAutoDeploymentTargetsCommand.d.ts +73 -0
- 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 +4 -3
- 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 +4 -2
- package/dist-types/commands/SignalResourceCommand.d.ts +3 -2
- 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 +4 -3
- 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 +8 -7
- 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/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1103 -1062
- package/dist-types/models/models_1.d.ts +141 -96
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/CloudFormation.d.ts +52 -0
- package/dist-types/ts3.4/CloudFormationClient.d.ts +6 -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/ListStackSetAutoDeploymentTargetsCommand.d.ts +39 -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 +11 -4
- package/dist-types/ts3.4/commands/SignalResourceCommand.d.ts +10 -1
- 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/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +14 -13
- package/dist-types/ts3.4/models/models_1.d.ts +13 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
- package/package.json +41 -41
|
@@ -3,6 +3,52 @@ import { CloudFormationServiceException as __BaseException } from "./CloudFormat
|
|
|
3
3
|
import { AutoDeployment, CallAs, Capability, DeploymentTargets, ManagedExecution, Parameter, PermissionModels, ResourceDefinition, RollbackConfiguration, StackSetOperationPreferences, Tag, TemplateConfiguration, ThirdPartyType } from "./models_0";
|
|
4
4
|
/**
|
|
5
5
|
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface SetTypeDefaultVersionOutput {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
* @enum
|
|
12
|
+
*/
|
|
13
|
+
export declare const ResourceSignalStatus: {
|
|
14
|
+
readonly FAILURE: "FAILURE";
|
|
15
|
+
readonly SUCCESS: "SUCCESS";
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export type ResourceSignalStatus = (typeof ResourceSignalStatus)[keyof typeof ResourceSignalStatus];
|
|
21
|
+
/**
|
|
22
|
+
* <p>The input for the <a>SignalResource</a> action.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
export interface SignalResourceInput {
|
|
26
|
+
/**
|
|
27
|
+
* <p>The stack name or unique stack ID that includes the resource that you want to signal.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
StackName: string | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in
|
|
33
|
+
* the template.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
LogicalResourceId: string | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the
|
|
39
|
+
* instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as
|
|
40
|
+
* signaling a wait condition), each signal requires a different unique ID.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
UniqueId: string | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately
|
|
46
|
+
* fail the stack creation or update.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
Status: ResourceSignalStatus | undefined;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
6
52
|
* <p>The limit on resource scans has been exceeded. Reasons include:</p>
|
|
7
53
|
* <ul>
|
|
8
54
|
* <li>
|
|
@@ -16,6 +62,7 @@ import { AutoDeployment, CallAs, Capability, DeploymentTargets, ManagedExecution
|
|
|
16
62
|
* before starting a new resource scan.</p>
|
|
17
63
|
* </li>
|
|
18
64
|
* </ul>
|
|
65
|
+
* @public
|
|
19
66
|
*/
|
|
20
67
|
export declare class ResourceScanLimitExceededException extends __BaseException {
|
|
21
68
|
readonly name: "ResourceScanLimitExceededException";
|
|
@@ -31,9 +78,9 @@ export declare class ResourceScanLimitExceededException extends __BaseException
|
|
|
31
78
|
*/
|
|
32
79
|
export interface StartResourceScanInput {
|
|
33
80
|
/**
|
|
34
|
-
* @public
|
|
35
81
|
* <p>A unique identifier for this <code>StartResourceScan</code> request. Specify this token if you plan to retry
|
|
36
82
|
* requests so that CloudFormation knows that you're not attempting to start a new resource scan.</p>
|
|
83
|
+
* @public
|
|
37
84
|
*/
|
|
38
85
|
ClientRequestToken?: string;
|
|
39
86
|
}
|
|
@@ -42,11 +89,11 @@ export interface StartResourceScanInput {
|
|
|
42
89
|
*/
|
|
43
90
|
export interface StartResourceScanOutput {
|
|
44
91
|
/**
|
|
45
|
-
* @public
|
|
46
92
|
* <p>The Amazon Resource Name (ARN) of the resource scan. The format is
|
|
47
93
|
* <code>arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}</code>. An example is
|
|
48
94
|
* <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i>
|
|
49
95
|
* </code>.</p>
|
|
96
|
+
* @public
|
|
50
97
|
*/
|
|
51
98
|
ResourceScanId?: string;
|
|
52
99
|
}
|
|
@@ -55,17 +102,16 @@ export interface StartResourceScanOutput {
|
|
|
55
102
|
*/
|
|
56
103
|
export interface StopStackSetOperationInput {
|
|
57
104
|
/**
|
|
58
|
-
* @public
|
|
59
105
|
* <p>The name or unique ID of the stack set that you want to stop the operation for.</p>
|
|
106
|
+
* @public
|
|
60
107
|
*/
|
|
61
108
|
StackSetName: string | undefined;
|
|
62
109
|
/**
|
|
63
|
-
* @public
|
|
64
110
|
* <p>The ID of the stack operation.</p>
|
|
111
|
+
* @public
|
|
65
112
|
*/
|
|
66
113
|
OperationId: string | undefined;
|
|
67
114
|
/**
|
|
68
|
-
* @public
|
|
69
115
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
70
116
|
* management account or as a delegated administrator in a member account.</p>
|
|
71
117
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
@@ -80,6 +126,7 @@ export interface StopStackSetOperationInput {
|
|
|
80
126
|
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
81
127
|
* </li>
|
|
82
128
|
* </ul>
|
|
129
|
+
* @public
|
|
83
130
|
*/
|
|
84
131
|
CallAs?: CallAs;
|
|
85
132
|
}
|
|
@@ -93,34 +140,33 @@ export interface StopStackSetOperationOutput {
|
|
|
93
140
|
*/
|
|
94
141
|
export interface TestTypeInput {
|
|
95
142
|
/**
|
|
96
|
-
* @public
|
|
97
143
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
98
144
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
145
|
+
* @public
|
|
99
146
|
*/
|
|
100
147
|
Arn?: string;
|
|
101
148
|
/**
|
|
102
|
-
* @public
|
|
103
149
|
* <p>The type of the extension to test.</p>
|
|
104
150
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
151
|
+
* @public
|
|
105
152
|
*/
|
|
106
153
|
Type?: ThirdPartyType;
|
|
107
154
|
/**
|
|
108
|
-
* @public
|
|
109
155
|
* <p>The name of the extension to test.</p>
|
|
110
156
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
157
|
+
* @public
|
|
111
158
|
*/
|
|
112
159
|
TypeName?: string;
|
|
113
160
|
/**
|
|
114
|
-
* @public
|
|
115
161
|
* <p>The version of the extension to test.</p>
|
|
116
162
|
* <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and
|
|
117
163
|
* <code>Type</code>.</p>
|
|
118
164
|
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region
|
|
119
165
|
* for testing.</p>
|
|
166
|
+
* @public
|
|
120
167
|
*/
|
|
121
168
|
VersionId?: string;
|
|
122
169
|
/**
|
|
123
|
-
* @public
|
|
124
170
|
* <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
|
|
125
171
|
* <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a
|
|
126
172
|
* test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
|
|
@@ -139,6 +185,7 @@ export interface TestTypeInput {
|
|
|
139
185
|
* </li>
|
|
140
186
|
* </ul>
|
|
141
187
|
* <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>
|
|
188
|
+
* @public
|
|
142
189
|
*/
|
|
143
190
|
LogDeliveryBucket?: string;
|
|
144
191
|
}
|
|
@@ -147,8 +194,8 @@ export interface TestTypeInput {
|
|
|
147
194
|
*/
|
|
148
195
|
export interface TestTypeOutput {
|
|
149
196
|
/**
|
|
150
|
-
* @public
|
|
151
197
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
198
|
+
* @public
|
|
152
199
|
*/
|
|
153
200
|
TypeVersionArn?: string;
|
|
154
201
|
}
|
|
@@ -157,36 +204,36 @@ export interface TestTypeOutput {
|
|
|
157
204
|
*/
|
|
158
205
|
export interface UpdateGeneratedTemplateInput {
|
|
159
206
|
/**
|
|
160
|
-
* @public
|
|
161
207
|
* <p>The name or Amazon Resource Name (ARN) of a generated template.</p>
|
|
208
|
+
* @public
|
|
162
209
|
*/
|
|
163
210
|
GeneratedTemplateName: string | undefined;
|
|
164
211
|
/**
|
|
165
|
-
* @public
|
|
166
212
|
* <p>An optional new name to assign to the generated template.</p>
|
|
213
|
+
* @public
|
|
167
214
|
*/
|
|
168
215
|
NewGeneratedTemplateName?: string;
|
|
169
216
|
/**
|
|
170
|
-
* @public
|
|
171
217
|
* <p>An optional list of resources to be added to the generated template.</p>
|
|
218
|
+
* @public
|
|
172
219
|
*/
|
|
173
220
|
AddResources?: ResourceDefinition[];
|
|
174
221
|
/**
|
|
175
|
-
* @public
|
|
176
222
|
* <p>A list of logical ids for resources to remove from the generated template.</p>
|
|
223
|
+
* @public
|
|
177
224
|
*/
|
|
178
225
|
RemoveResources?: string[];
|
|
179
226
|
/**
|
|
180
|
-
* @public
|
|
181
227
|
* <p>If <code>true</code>, update the resource properties in the generated template with their current live state.
|
|
182
228
|
* This feature is useful when the resource properties in your generated a template does not reflect the live state of
|
|
183
229
|
* the resource properties. This happens when a user update the resource properties after generating a template.</p>
|
|
230
|
+
* @public
|
|
184
231
|
*/
|
|
185
232
|
RefreshAllResources?: boolean;
|
|
186
233
|
/**
|
|
187
|
-
* @public
|
|
188
234
|
* <p>The configuration details of the generated template, including the <code>DeletionPolicy</code> and
|
|
189
235
|
* <code>UpdateReplacePolicy</code>.</p>
|
|
236
|
+
* @public
|
|
190
237
|
*/
|
|
191
238
|
TemplateConfiguration?: TemplateConfiguration;
|
|
192
239
|
}
|
|
@@ -195,78 +242,76 @@ export interface UpdateGeneratedTemplateInput {
|
|
|
195
242
|
*/
|
|
196
243
|
export interface UpdateGeneratedTemplateOutput {
|
|
197
244
|
/**
|
|
198
|
-
* @public
|
|
199
245
|
* <p>The Amazon Resource Name (ARN) of the generated template. The format is
|
|
200
246
|
* <code>arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}</code>. For example,
|
|
201
247
|
* <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i>
|
|
202
248
|
* </code>.</p>
|
|
249
|
+
* @public
|
|
203
250
|
*/
|
|
204
251
|
GeneratedTemplateId?: string;
|
|
205
252
|
}
|
|
206
253
|
/**
|
|
207
|
-
* @public
|
|
208
254
|
* <p>The input for an <a>UpdateStack</a> action.</p>
|
|
255
|
+
* @public
|
|
209
256
|
*/
|
|
210
257
|
export interface UpdateStackInput {
|
|
211
258
|
/**
|
|
212
|
-
* @public
|
|
213
259
|
* <p>The name or unique stack ID of the stack to update.</p>
|
|
260
|
+
* @public
|
|
214
261
|
*/
|
|
215
262
|
StackName: string | undefined;
|
|
216
263
|
/**
|
|
217
|
-
* @public
|
|
218
264
|
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
|
219
265
|
* (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
220
266
|
* <i>CloudFormation User Guide</i>.)</p>
|
|
221
267
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
222
268
|
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
269
|
+
* @public
|
|
223
270
|
*/
|
|
224
271
|
TemplateBody?: string;
|
|
225
272
|
/**
|
|
226
|
-
* @public
|
|
227
273
|
* <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
274
|
* <i>CloudFormation User Guide</i>. The location for an Amazon S3 bucket must start with <code>https://</code>.</p>
|
|
229
275
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
230
276
|
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
277
|
+
* @public
|
|
231
278
|
*/
|
|
232
279
|
TemplateURL?: string;
|
|
233
280
|
/**
|
|
234
|
-
* @public
|
|
235
281
|
* <p>Reuse the existing template that is associated with the stack that you are updating.</p>
|
|
236
282
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
237
283
|
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
284
|
+
* @public
|
|
238
285
|
*/
|
|
239
286
|
UsePreviousTemplate?: boolean;
|
|
240
287
|
/**
|
|
241
|
-
* @public
|
|
242
288
|
* <p>Structure containing the temporary overriding stack policy body. You can specify either the
|
|
243
289
|
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not
|
|
244
290
|
* both.</p>
|
|
245
291
|
* <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If
|
|
246
292
|
* you don't specify a stack policy, the current policy that is associated with the stack will be used.</p>
|
|
293
|
+
* @public
|
|
247
294
|
*/
|
|
248
295
|
StackPolicyDuringUpdateBody?: string;
|
|
249
296
|
/**
|
|
250
|
-
* @public
|
|
251
297
|
* <p>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
|
|
252
298
|
* 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
|
|
253
299
|
* <code>https://</code>. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the
|
|
254
300
|
* <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p>
|
|
255
301
|
* <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If
|
|
256
302
|
* you don't specify a stack policy, the current policy that is associated with the stack will be used.</p>
|
|
303
|
+
* @public
|
|
257
304
|
*/
|
|
258
305
|
StackPolicyDuringUpdateURL?: string;
|
|
259
306
|
/**
|
|
260
|
-
* @public
|
|
261
307
|
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information,
|
|
262
308
|
* see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">
|
|
263
309
|
* <code>Parameter</code>
|
|
264
|
-
* </a>
|
|
265
|
-
*
|
|
310
|
+
* </a> data type.</p>
|
|
311
|
+
* @public
|
|
266
312
|
*/
|
|
267
313
|
Parameters?: Parameter[];
|
|
268
314
|
/**
|
|
269
|
-
* @public
|
|
270
315
|
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
271
316
|
* for CloudFormation to update the stack.</p>
|
|
272
317
|
* <ul>
|
|
@@ -362,8 +407,8 @@ export interface UpdateStackInput {
|
|
|
362
407
|
* <code>AWS::Include</code>
|
|
363
408
|
* </a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">
|
|
364
409
|
* <code>AWS::Serverless</code>
|
|
365
|
-
* </a>
|
|
366
|
-
* are macros hosted by CloudFormation.</p>
|
|
410
|
+
* </a>
|
|
411
|
+
* transforms, which are macros hosted by CloudFormation.</p>
|
|
367
412
|
* <p>If you want to update a stack from a stack template that contains macros <i>and</i> nested
|
|
368
413
|
* stacks, you must update the stack directly from the template using this capability.</p>
|
|
369
414
|
* <important>
|
|
@@ -380,10 +425,10 @@ export interface UpdateStackInput {
|
|
|
380
425
|
* <note>
|
|
381
426
|
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p>
|
|
382
427
|
* </note>
|
|
428
|
+
* @public
|
|
383
429
|
*/
|
|
384
430
|
Capabilities?: Capability[];
|
|
385
431
|
/**
|
|
386
|
-
* @public
|
|
387
432
|
* <p>The template resource types that you have permissions to work with for this update stack action, such as
|
|
388
433
|
* <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p>
|
|
389
434
|
* <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By
|
|
@@ -392,35 +437,35 @@ export interface UpdateStackInput {
|
|
|
392
437
|
* <note>
|
|
393
438
|
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p>
|
|
394
439
|
* </note>
|
|
440
|
+
* @public
|
|
395
441
|
*/
|
|
396
442
|
ResourceTypes?: string[];
|
|
397
443
|
/**
|
|
398
|
-
* @public
|
|
399
444
|
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
|
|
400
445
|
* update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role
|
|
401
446
|
* for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses
|
|
402
447
|
* this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p>
|
|
403
448
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role
|
|
404
449
|
* is available, CloudFormation uses a temporary session that is generated from your user credentials.</p>
|
|
450
|
+
* @public
|
|
405
451
|
*/
|
|
406
452
|
RoleARN?: string;
|
|
407
453
|
/**
|
|
408
|
-
* @public
|
|
409
454
|
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
|
|
410
455
|
* specified monitoring period afterwards.</p>
|
|
456
|
+
* @public
|
|
411
457
|
*/
|
|
412
458
|
RollbackConfiguration?: RollbackConfiguration;
|
|
413
459
|
/**
|
|
414
|
-
* @public
|
|
415
460
|
* <p>Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the
|
|
416
461
|
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
417
462
|
* <p>You might update the stack policy, for example, in order to protect a new resource that you created during a
|
|
418
463
|
* stack update. If you don't specify a stack policy, the current policy that is associated with the stack is
|
|
419
464
|
* unchanged.</p>
|
|
465
|
+
* @public
|
|
420
466
|
*/
|
|
421
467
|
StackPolicyBody?: string;
|
|
422
468
|
/**
|
|
423
|
-
* @public
|
|
424
469
|
* <p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
|
|
425
470
|
* in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
|
|
426
471
|
* <code>https://</code>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code>
|
|
@@ -428,31 +473,31 @@ export interface UpdateStackInput {
|
|
|
428
473
|
* <p>You might update the stack policy, for example, in order to protect a new resource that you created during a
|
|
429
474
|
* stack update. If you don't specify a stack policy, the current policy that is associated with the stack is
|
|
430
475
|
* unchanged.</p>
|
|
476
|
+
* @public
|
|
431
477
|
*/
|
|
432
478
|
StackPolicyURL?: string;
|
|
433
479
|
/**
|
|
434
|
-
* @public
|
|
435
480
|
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.
|
|
436
481
|
* Specify an empty list to remove all notification topics.</p>
|
|
482
|
+
* @public
|
|
437
483
|
*/
|
|
438
484
|
NotificationARNs?: string[];
|
|
439
485
|
/**
|
|
440
|
-
* @public
|
|
441
486
|
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the
|
|
442
487
|
* stack. You can specify a maximum number of 50 tags.</p>
|
|
443
488
|
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value,
|
|
444
489
|
* CloudFormation removes all associated tags.</p>
|
|
490
|
+
* @public
|
|
445
491
|
*/
|
|
446
492
|
Tags?: Tag[];
|
|
447
493
|
/**
|
|
448
|
-
* @public
|
|
449
494
|
* <p>Preserve the state of previously provisioned resources when an operation fails.</p>
|
|
450
495
|
* <p>Default: <code>False</code>
|
|
451
496
|
* </p>
|
|
497
|
+
* @public
|
|
452
498
|
*/
|
|
453
499
|
DisableRollback?: boolean;
|
|
454
500
|
/**
|
|
455
|
-
* @public
|
|
456
501
|
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests
|
|
457
502
|
* so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
|
|
458
503
|
* <code>UpdateStack</code> requests to ensure that CloudFormation successfully received them.</p>
|
|
@@ -465,25 +510,26 @@ export interface UpdateStackInput {
|
|
|
465
510
|
* easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
|
|
466
511
|
* assigned the same token in the following format:
|
|
467
512
|
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
513
|
+
* @public
|
|
468
514
|
*/
|
|
469
515
|
ClientRequestToken?: string;
|
|
470
516
|
/**
|
|
471
|
-
* @public
|
|
472
517
|
* <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes
|
|
473
518
|
* newly created resources marked with a deletion policy of <code>Retain</code>.</p>
|
|
474
519
|
* <p>Default: <code>false</code>
|
|
475
520
|
* </p>
|
|
521
|
+
* @public
|
|
476
522
|
*/
|
|
477
523
|
RetainExceptOnCreate?: boolean;
|
|
478
524
|
}
|
|
479
525
|
/**
|
|
480
|
-
* @public
|
|
481
526
|
* <p>The output for an <a>UpdateStack</a> action.</p>
|
|
527
|
+
* @public
|
|
482
528
|
*/
|
|
483
529
|
export interface UpdateStackOutput {
|
|
484
530
|
/**
|
|
485
|
-
* @public
|
|
486
531
|
* <p>Unique identifier of the stack.</p>
|
|
532
|
+
* @public
|
|
487
533
|
*/
|
|
488
534
|
StackId?: string;
|
|
489
535
|
}
|
|
@@ -492,36 +538,35 @@ export interface UpdateStackOutput {
|
|
|
492
538
|
*/
|
|
493
539
|
export interface UpdateStackInstancesInput {
|
|
494
540
|
/**
|
|
495
|
-
* @public
|
|
496
541
|
* <p>The name or unique ID of the stack set associated with the stack instances.</p>
|
|
542
|
+
* @public
|
|
497
543
|
*/
|
|
498
544
|
StackSetName: string | undefined;
|
|
499
545
|
/**
|
|
500
|
-
* @public
|
|
501
546
|
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update
|
|
502
547
|
* parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the
|
|
503
548
|
* specified accounts and Amazon Web Services Regions.</p>
|
|
504
549
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
550
|
+
* @public
|
|
505
551
|
*/
|
|
506
552
|
Accounts?: string[];
|
|
507
553
|
/**
|
|
508
|
-
* @public
|
|
509
554
|
* <p>[Service-managed permissions] The Organizations accounts for which you want to update parameter values
|
|
510
555
|
* for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are
|
|
511
556
|
* currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future
|
|
512
557
|
* won't use the overridden values.</p>
|
|
513
558
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
559
|
+
* @public
|
|
514
560
|
*/
|
|
515
561
|
DeploymentTargets?: DeploymentTargets;
|
|
516
562
|
/**
|
|
517
|
-
* @public
|
|
518
563
|
* <p>The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack
|
|
519
564
|
* instances. The overridden parameter values will be applied to all stack instances in the specified accounts and
|
|
520
565
|
* Amazon Web Services Regions.</p>
|
|
566
|
+
* @public
|
|
521
567
|
*/
|
|
522
568
|
Regions: string[] | undefined;
|
|
523
569
|
/**
|
|
524
|
-
* @public
|
|
525
570
|
* <p>A list of input parameters whose values you want to update for the specified stack instances.</p>
|
|
526
571
|
* <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
572
|
* during stack instance update operations:</p>
|
|
@@ -548,28 +593,27 @@ export interface UpdateStackInstancesInput {
|
|
|
548
593
|
* delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter
|
|
549
594
|
* to a template, before you can override the parameter value specified in the stack set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">
|
|
550
595
|
* <code>UpdateStackSet</code>
|
|
551
|
-
* </a> to
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
596
|
+
* </a> to update all stack instances with the updated template and parameter value
|
|
597
|
+
* specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the
|
|
598
|
+
* parameter value using <code>UpdateStackInstances</code>.</p>
|
|
599
|
+
* @public
|
|
555
600
|
*/
|
|
556
601
|
ParameterOverrides?: Parameter[];
|
|
557
602
|
/**
|
|
558
|
-
* @public
|
|
559
603
|
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
604
|
+
* @public
|
|
560
605
|
*/
|
|
561
606
|
OperationPreferences?: StackSetOperationPreferences;
|
|
562
607
|
/**
|
|
563
|
-
* @public
|
|
564
608
|
* <p>The unique identifier for this stack set operation.</p>
|
|
565
609
|
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
|
|
566
610
|
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests to
|
|
567
611
|
* ensure that CloudFormation successfully received them.</p>
|
|
568
612
|
* <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
|
|
613
|
+
* @public
|
|
569
614
|
*/
|
|
570
615
|
OperationId?: string;
|
|
571
616
|
/**
|
|
572
|
-
* @public
|
|
573
617
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
574
618
|
* management account or as a delegated administrator in a member account.</p>
|
|
575
619
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
@@ -584,6 +628,7 @@ export interface UpdateStackInstancesInput {
|
|
|
584
628
|
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
585
629
|
* </li>
|
|
586
630
|
* </ul>
|
|
631
|
+
* @public
|
|
587
632
|
*/
|
|
588
633
|
CallAs?: CallAs;
|
|
589
634
|
}
|
|
@@ -592,8 +637,8 @@ export interface UpdateStackInstancesInput {
|
|
|
592
637
|
*/
|
|
593
638
|
export interface UpdateStackInstancesOutput {
|
|
594
639
|
/**
|
|
595
|
-
* @public
|
|
596
640
|
* <p>The unique identifier for this stack set operation.</p>
|
|
641
|
+
* @public
|
|
597
642
|
*/
|
|
598
643
|
OperationId?: string;
|
|
599
644
|
}
|
|
@@ -602,48 +647,47 @@ export interface UpdateStackInstancesOutput {
|
|
|
602
647
|
*/
|
|
603
648
|
export interface UpdateStackSetInput {
|
|
604
649
|
/**
|
|
605
|
-
* @public
|
|
606
650
|
* <p>The name or unique ID of the stack set that you want to update.</p>
|
|
651
|
+
* @public
|
|
607
652
|
*/
|
|
608
653
|
StackSetName: string | undefined;
|
|
609
654
|
/**
|
|
610
|
-
* @public
|
|
611
655
|
* <p>A brief description of updates that you are making.</p>
|
|
656
|
+
* @public
|
|
612
657
|
*/
|
|
613
658
|
Description?: string;
|
|
614
659
|
/**
|
|
615
|
-
* @public
|
|
616
660
|
* <p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
|
|
617
661
|
* bytes. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
618
662
|
* <i>CloudFormation User Guide</i>.</p>
|
|
619
663
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
|
|
620
664
|
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
|
|
665
|
+
* @public
|
|
621
666
|
*/
|
|
622
667
|
TemplateBody?: string;
|
|
623
668
|
/**
|
|
624
|
-
* @public
|
|
625
669
|
* <p>The location of the file that contains the template body. The URL must point to a template (maximum size:
|
|
626
670
|
* 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
627
671
|
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
628
672
|
* Anatomy</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
629
673
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
|
|
630
674
|
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
|
|
675
|
+
* @public
|
|
631
676
|
*/
|
|
632
677
|
TemplateURL?: string;
|
|
633
678
|
/**
|
|
634
|
-
* @public
|
|
635
679
|
* <p>Use the existing template that's associated with the stack set that you're updating.</p>
|
|
636
680
|
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
|
|
637
681
|
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
|
|
682
|
+
* @public
|
|
638
683
|
*/
|
|
639
684
|
UsePreviousTemplate?: boolean;
|
|
640
685
|
/**
|
|
641
|
-
* @public
|
|
642
686
|
* <p>A list of input parameters for the stack set template.</p>
|
|
687
|
+
* @public
|
|
643
688
|
*/
|
|
644
689
|
Parameters?: Parameter[];
|
|
645
690
|
/**
|
|
646
|
-
* @public
|
|
647
691
|
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
648
692
|
* for CloudFormation to update the stack set and its associated stack instances.</p>
|
|
649
693
|
* <ul>
|
|
@@ -739,16 +783,16 @@ export interface UpdateStackSetInput {
|
|
|
739
783
|
* <code>AWS::Include</code>
|
|
740
784
|
* </a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">
|
|
741
785
|
* <code>AWS::Serverless</code>
|
|
742
|
-
* </a>
|
|
743
|
-
* are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with
|
|
744
|
-
* if you reference a macro in your template the stack set operation will fail.</p>
|
|
786
|
+
* </a>
|
|
787
|
+
* transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with
|
|
788
|
+
* service-managed permissions, if you reference a macro in your template the stack set operation will fail.</p>
|
|
745
789
|
* </important>
|
|
746
790
|
* </li>
|
|
747
791
|
* </ul>
|
|
792
|
+
* @public
|
|
748
793
|
*/
|
|
749
794
|
Capabilities?: Capability[];
|
|
750
795
|
/**
|
|
751
|
-
* @public
|
|
752
796
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these
|
|
753
797
|
* tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.</p>
|
|
754
798
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are currently associated with
|
|
@@ -773,25 +817,25 @@ export interface UpdateStackSetInput {
|
|
|
773
817
|
* if you have permission to untag resources. If you don't have the necessary permission(s), the entire
|
|
774
818
|
* <code>UpdateStackSet</code> action fails with an <code>access denied</code> error, and the stack set is not
|
|
775
819
|
* updated.</p>
|
|
820
|
+
* @public
|
|
776
821
|
*/
|
|
777
822
|
Tags?: Tag[];
|
|
778
823
|
/**
|
|
779
|
-
* @public
|
|
780
824
|
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
825
|
+
* @public
|
|
781
826
|
*/
|
|
782
827
|
OperationPreferences?: StackSetOperationPreferences;
|
|
783
828
|
/**
|
|
784
|
-
* @public
|
|
785
829
|
* <p>The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.</p>
|
|
786
830
|
* <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can
|
|
787
831
|
* 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
832
|
* Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
789
833
|
* <p>If you specified a customized administrator role when you created the stack set, you must specify a customized
|
|
790
834
|
* administrator role, even if it is the same customized administrator role used with this stack set previously.</p>
|
|
835
|
+
* @public
|
|
791
836
|
*/
|
|
792
837
|
AdministrationRoleARN?: string;
|
|
793
838
|
/**
|
|
794
|
-
* @public
|
|
795
839
|
* <p>The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,
|
|
796
840
|
* CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p>
|
|
797
841
|
* <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users
|
|
@@ -799,10 +843,10 @@ export interface UpdateStackSetInput {
|
|
|
799
843
|
* <p>If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a
|
|
800
844
|
* customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long
|
|
801
845
|
* as you have permissions to perform operations on the stack set.</p>
|
|
846
|
+
* @public
|
|
802
847
|
*/
|
|
803
848
|
ExecutionRoleName?: string;
|
|
804
849
|
/**
|
|
805
|
-
* @public
|
|
806
850
|
* <p>[Service-managed permissions] The Organizations accounts in which to update associated stack
|
|
807
851
|
* instances.</p>
|
|
808
852
|
* <p>To update all the stack instances associated with this stack set, do not specify <code>DeploymentTargets</code>
|
|
@@ -812,10 +856,10 @@ export interface UpdateStackSetInput {
|
|
|
812
856
|
* 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
857
|
* in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance
|
|
814
858
|
* status.</p>
|
|
859
|
+
* @public
|
|
815
860
|
*/
|
|
816
861
|
DeploymentTargets?: DeploymentTargets;
|
|
817
862
|
/**
|
|
818
|
-
* @public
|
|
819
863
|
* <p>Describes how the IAM roles required for stack set operations are created. You cannot modify
|
|
820
864
|
* <code>PermissionModel</code> if there are stack instances associated with your stack set.</p>
|
|
821
865
|
* <ul>
|
|
@@ -830,18 +874,18 @@ export interface UpdateStackSetInput {
|
|
|
830
874
|
* Permissions</a>.</p>
|
|
831
875
|
* </li>
|
|
832
876
|
* </ul>
|
|
877
|
+
* @public
|
|
833
878
|
*/
|
|
834
879
|
PermissionModel?: PermissionModels;
|
|
835
880
|
/**
|
|
836
|
-
* @public
|
|
837
881
|
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations
|
|
838
882
|
* accounts that are added to a target organization or organizational unit (OU).</p>
|
|
839
883
|
* <p>If you specify <code>AutoDeployment</code>, don't specify <code>DeploymentTargets</code> or
|
|
840
884
|
* <code>Regions</code>.</p>
|
|
885
|
+
* @public
|
|
841
886
|
*/
|
|
842
887
|
AutoDeployment?: AutoDeployment;
|
|
843
888
|
/**
|
|
844
|
-
* @public
|
|
845
889
|
* <p>The unique ID for this stack set operation.</p>
|
|
846
890
|
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set
|
|
847
891
|
* operation only once, even if you retry the request multiple times. You might retry stack set operation requests to
|
|
@@ -849,10 +893,10 @@ export interface UpdateStackSetInput {
|
|
|
849
893
|
* <p>If you don't specify an operation ID, CloudFormation generates one automatically.</p>
|
|
850
894
|
* <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is
|
|
851
895
|
* <code>OUTDATED</code>.</p>
|
|
896
|
+
* @public
|
|
852
897
|
*/
|
|
853
898
|
OperationId?: string;
|
|
854
899
|
/**
|
|
855
|
-
* @public
|
|
856
900
|
* <p>[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,
|
|
857
901
|
* you must also specify the Amazon Web Services Regions in which to update stack set instances.</p>
|
|
858
902
|
* <p>To update <i>all</i> the stack instances associated with this stack set, don't specify the
|
|
@@ -863,10 +907,10 @@ export interface UpdateStackSetInput {
|
|
|
863
907
|
* Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation
|
|
864
908
|
* updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack
|
|
865
909
|
* instances with their existing stack instance status.</p>
|
|
910
|
+
* @public
|
|
866
911
|
*/
|
|
867
912
|
Accounts?: string[];
|
|
868
913
|
/**
|
|
869
|
-
* @public
|
|
870
914
|
* <p>The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must
|
|
871
915
|
* also specify accounts in which to update stack set instances.</p>
|
|
872
916
|
* <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the
|
|
@@ -877,10 +921,10 @@ export interface UpdateStackSetInput {
|
|
|
877
921
|
* Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack
|
|
878
922
|
* instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack
|
|
879
923
|
* instance status.</p>
|
|
924
|
+
* @public
|
|
880
925
|
*/
|
|
881
926
|
Regions?: string[];
|
|
882
927
|
/**
|
|
883
|
-
* @public
|
|
884
928
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
885
929
|
* management account or as a delegated administrator in a member account.</p>
|
|
886
930
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
@@ -895,12 +939,13 @@ export interface UpdateStackSetInput {
|
|
|
895
939
|
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
896
940
|
* </li>
|
|
897
941
|
* </ul>
|
|
942
|
+
* @public
|
|
898
943
|
*/
|
|
899
944
|
CallAs?: CallAs;
|
|
900
945
|
/**
|
|
901
|
-
* @public
|
|
902
946
|
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting
|
|
903
947
|
* operations.</p>
|
|
948
|
+
* @public
|
|
904
949
|
*/
|
|
905
950
|
ManagedExecution?: ManagedExecution;
|
|
906
951
|
}
|
|
@@ -909,8 +954,8 @@ export interface UpdateStackSetInput {
|
|
|
909
954
|
*/
|
|
910
955
|
export interface UpdateStackSetOutput {
|
|
911
956
|
/**
|
|
912
|
-
* @public
|
|
913
957
|
* <p>The unique ID for this stack set operation.</p>
|
|
958
|
+
* @public
|
|
914
959
|
*/
|
|
915
960
|
OperationId?: string;
|
|
916
961
|
}
|
|
@@ -919,13 +964,13 @@ export interface UpdateStackSetOutput {
|
|
|
919
964
|
*/
|
|
920
965
|
export interface UpdateTerminationProtectionInput {
|
|
921
966
|
/**
|
|
922
|
-
* @public
|
|
923
967
|
* <p>Whether to enable termination protection on the specified stack.</p>
|
|
968
|
+
* @public
|
|
924
969
|
*/
|
|
925
970
|
EnableTerminationProtection: boolean | undefined;
|
|
926
971
|
/**
|
|
927
|
-
* @public
|
|
928
972
|
* <p>The name or unique ID of the stack for which you want to set termination protection.</p>
|
|
973
|
+
* @public
|
|
929
974
|
*/
|
|
930
975
|
StackName: string | undefined;
|
|
931
976
|
}
|
|
@@ -934,93 +979,93 @@ export interface UpdateTerminationProtectionInput {
|
|
|
934
979
|
*/
|
|
935
980
|
export interface UpdateTerminationProtectionOutput {
|
|
936
981
|
/**
|
|
937
|
-
* @public
|
|
938
982
|
* <p>The unique ID of the stack.</p>
|
|
983
|
+
* @public
|
|
939
984
|
*/
|
|
940
985
|
StackId?: string;
|
|
941
986
|
}
|
|
942
987
|
/**
|
|
943
|
-
* @public
|
|
944
988
|
* <p>The input for <a>ValidateTemplate</a> action.</p>
|
|
989
|
+
* @public
|
|
945
990
|
*/
|
|
946
991
|
export interface ValidateTemplateInput {
|
|
947
992
|
/**
|
|
948
|
-
* @public
|
|
949
993
|
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
|
|
950
994
|
* 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
995
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
952
996
|
* <code>TemplateBody</code> is used.</p>
|
|
997
|
+
* @public
|
|
953
998
|
*/
|
|
954
999
|
TemplateBody?: string;
|
|
955
1000
|
/**
|
|
956
|
-
* @public
|
|
957
1001
|
* <p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that
|
|
958
1002
|
* 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
1003
|
* <i>CloudFormation User Guide</i>. The location for an Amazon S3 bucket must start with <code>https://</code>.</p>
|
|
960
1004
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
961
1005
|
* <code>TemplateBody</code> is used.</p>
|
|
1006
|
+
* @public
|
|
962
1007
|
*/
|
|
963
1008
|
TemplateURL?: string;
|
|
964
1009
|
}
|
|
965
1010
|
/**
|
|
966
|
-
* @public
|
|
967
1011
|
* <p>The TemplateParameter data type.</p>
|
|
1012
|
+
* @public
|
|
968
1013
|
*/
|
|
969
1014
|
export interface TemplateParameter {
|
|
970
1015
|
/**
|
|
971
|
-
* @public
|
|
972
1016
|
* <p>The name associated with the parameter.</p>
|
|
1017
|
+
* @public
|
|
973
1018
|
*/
|
|
974
1019
|
ParameterKey?: string;
|
|
975
1020
|
/**
|
|
976
|
-
* @public
|
|
977
1021
|
* <p>The default value associated with the parameter.</p>
|
|
1022
|
+
* @public
|
|
978
1023
|
*/
|
|
979
1024
|
DefaultValue?: string;
|
|
980
1025
|
/**
|
|
981
|
-
* @public
|
|
982
1026
|
* <p>Flag indicating whether the parameter should be displayed as plain text in logs and UIs.</p>
|
|
1027
|
+
* @public
|
|
983
1028
|
*/
|
|
984
1029
|
NoEcho?: boolean;
|
|
985
1030
|
/**
|
|
986
|
-
* @public
|
|
987
1031
|
* <p>User defined description associated with the parameter.</p>
|
|
1032
|
+
* @public
|
|
988
1033
|
*/
|
|
989
1034
|
Description?: string;
|
|
990
1035
|
}
|
|
991
1036
|
/**
|
|
992
|
-
* @public
|
|
993
1037
|
* <p>The output for <a>ValidateTemplate</a> action.</p>
|
|
1038
|
+
* @public
|
|
994
1039
|
*/
|
|
995
1040
|
export interface ValidateTemplateOutput {
|
|
996
1041
|
/**
|
|
997
|
-
* @public
|
|
998
1042
|
* <p>A list of <code>TemplateParameter</code> structures.</p>
|
|
1043
|
+
* @public
|
|
999
1044
|
*/
|
|
1000
1045
|
Parameters?: TemplateParameter[];
|
|
1001
1046
|
/**
|
|
1002
|
-
* @public
|
|
1003
1047
|
* <p>The description found within the template.</p>
|
|
1048
|
+
* @public
|
|
1004
1049
|
*/
|
|
1005
1050
|
Description?: string;
|
|
1006
1051
|
/**
|
|
1007
|
-
* @public
|
|
1008
1052
|
* <p>The capabilities found within the template. If your template contains IAM resources, you must specify the
|
|
1009
1053
|
* CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or
|
|
1010
1054
|
* <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities
|
|
1011
1055
|
* error.</p>
|
|
1012
1056
|
* <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
1057
|
* CloudFormation Templates</a>.</p>
|
|
1058
|
+
* @public
|
|
1014
1059
|
*/
|
|
1015
1060
|
Capabilities?: Capability[];
|
|
1016
1061
|
/**
|
|
1017
|
-
* @public
|
|
1018
1062
|
* <p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>
|
|
1063
|
+
* @public
|
|
1019
1064
|
*/
|
|
1020
1065
|
CapabilitiesReason?: string;
|
|
1021
1066
|
/**
|
|
1022
|
-
* @public
|
|
1023
1067
|
* <p>A list of the transforms that are declared in the template.</p>
|
|
1068
|
+
* @public
|
|
1024
1069
|
*/
|
|
1025
1070
|
DeclaredTransforms?: string[];
|
|
1026
1071
|
}
|