/
api_op_CreateStack.go
321 lines (293 loc) · 14.2 KB
/
api_op_CreateStack.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
// Code generated by smithy-go-codegen DO NOT EDIT.
package cloudformation
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/cloudformation/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a stack as specified in the template. After the call completes
// successfully, the stack creation starts. You can check the status of the stack
// via the DescribeStacks API.
func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error) {
if params == nil {
params = &CreateStackInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateStack", params, optFns, addOperationCreateStackMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateStackOutput)
out.ResultMetadata = metadata
return out, nil
}
// The input for CreateStack action.
type CreateStackInput struct {
// The name that is associated with the stack. The name must be unique in the
// Region in which you are creating the stack. A stack name can contain only
// alphanumeric characters (case sensitive) and hyphens. It must start with an
// alphabetic character and cannot be longer than 128 characters.
//
// This member is required.
StackName *string
// In some cases, you must explicitly acknowledge that your stack template contains
// certain capabilities in order for AWS CloudFormation to create the stack.
//
// *
// CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include
// resources that can affect permissions in your AWS account; for example, by
// creating new AWS Identity and Access Management (IAM) users. For those stacks,
// you must explicitly acknowledge this by specifying one of these capabilities.
// The following IAM resources require you to specify either the CAPABILITY_IAM or
// CAPABILITY_NAMED_IAM capability.
//
// * If you have IAM resources, you can specify
// either capability.
//
// * If you have IAM resources with custom names, you must
// specify CAPABILITY_NAMED_IAM.
//
// * If you don't specify either of these
// capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
//
// If
// your stack template contains these resources, we recommend that you review all
// permissions associated with them and edit their permissions if necessary.
//
// *
// AWS::IAM::AccessKey
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
//
// *
// AWS::IAM::Group
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
//
// *
// AWS::IAM::InstanceProfile
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
//
// *
// AWS::IAM::Policy
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
//
// *
// AWS::IAM::Role
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
//
// *
// AWS::IAM::User
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
//
// *
// AWS::IAM::UserToGroupAddition
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
//
// For
// more information, see Acknowledging IAM Resources in AWS CloudFormation
// Templates
// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
//
// *
// CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom
// processing on templates; this can include simple actions like find-and-replace
// operations, all the way to extensive transformations of entire templates.
// Because of this, users typically create a change set from the processed
// template, so that they can review the changes resulting from the macros before
// actually creating the stack. If your stack template contains one or more macros,
// and you choose to create a stack directly from the processed template, without
// first reviewing the resulting changes in a change set, you must acknowledge this
// capability. This includes the AWS::Include
// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
// and AWS::Serverless
// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
// transforms, which are macros hosted by AWS CloudFormation. If you want to create
// a stack from a stack template that contains macros and nested stacks, you must
// create the stack directly from the template using this capability. You should
// only create stacks directly from a stack template that contains macros if you
// know what processing the macro performs. Each macro relies on an underlying
// Lambda service function for processing stack templates. Be aware that the Lambda
// function owner can update the function operation without AWS CloudFormation
// being notified. For more information, see Using AWS CloudFormation Macros to
// Perform Custom Processing on Templates
// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
Capabilities []types.Capability
// A unique identifier for this CreateStack request. Specify this token if you plan
// to retry requests so that AWS CloudFormation knows that you're not attempting to
// create a stack with the same name. You might retry CreateStack requests to
// ensure that AWS CloudFormation successfully received them. All events triggered
// by a given stack operation are assigned the same client request token, which you
// can use to track operations. For example, if you execute a CreateStack operation
// with the token token1, then all the StackEvents generated by that operation will
// have ClientRequestToken set as token1. In the console, stack operations display
// the client request token on the Events tab. Stack operations that are initiated
// from the console use the token format Console-StackOperation-ID, which helps you
// easily identify the stack operation . For example, if you create a stack using
// the console, each stack event would be assigned the same token in the following
// format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
ClientRequestToken *string
// Set to true to disable rollback of the stack if stack creation failed. You can
// specify either DisableRollback or OnFailure, but not both. Default: false
DisableRollback *bool
// Whether to enable termination protection on the specified stack. If a user
// attempts to delete a stack with termination protection enabled, the operation
// fails and the stack remains unchanged. For more information, see Protecting a
// Stack From Being Deleted
// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html)
// in the AWS CloudFormation User Guide. Termination protection is disabled on
// stacks by default. For nested stacks
// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html),
// termination protection is set on the root stack and cannot be changed directly
// on the nested stack.
EnableTerminationProtection *bool
// The Simple Notification Service (SNS) topic ARNs to publish stack related
// events. You can find your SNS topic ARNs using the SNS console or your Command
// Line Interface (CLI).
NotificationARNs []string
// Determines what action will be taken if stack creation fails. This must be one
// of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or
// DisableRollback, but not both. Default: ROLLBACK
OnFailure types.OnFailure
// A list of Parameter structures that specify input parameters for the stack. For
// more information, see the Parameter
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html)
// data type.
Parameters []types.Parameter
// The template resource types that you have permissions to work with for this
// create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or
// Custom::MyCustomInstance. Use the following syntax to describe template resource
// types: AWS::* (for all AWS resource), Custom::* (for all custom resources),
// Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for
// all resources of a particular AWS service), and
// AWS::service_name::resource_logical_ID (for a specific AWS resource). If the
// list of resource types doesn't include a resource that you're creating, the
// stack creation fails. By default, AWS CloudFormation grants permissions to all
// resource types. AWS Identity and Access Management (IAM) uses this parameter for
// AWS CloudFormation-specific condition keys in IAM policies. For more
// information, see Controlling Access with AWS Identity and Access Management
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html).
ResourceTypes []string
// The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM)
// role that AWS CloudFormation assumes to create the stack. AWS CloudFormation
// uses the role's credentials to make calls on your behalf. AWS CloudFormation
// always uses this role for all future operations on the stack. As long as users
// have permission to operate on the stack, AWS CloudFormation uses this role even
// if the users don't have permission to pass it. Ensure that the role grants least
// privilege. If you don't specify a value, AWS CloudFormation uses the role that
// was previously associated with the stack. If no role is available, AWS
// CloudFormation uses a temporary session that is generated from your user
// credentials.
RoleARN *string
// The rollback triggers for AWS CloudFormation to monitor during stack creation
// and updating operations, and for the specified monitoring period afterwards.
RollbackConfiguration *types.RollbackConfiguration
// Structure containing the stack policy body. For more information, go to Prevent
// Updates to Stack Resources
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
// in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody
// or the StackPolicyURL parameter, but not both.
StackPolicyBody *string
// Location of a file containing the stack policy. The URL must point to a policy
// (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack.
// You can specify either the StackPolicyBody or the StackPolicyURL parameter, but
// not both.
StackPolicyURL *string
// Key-value pairs to associate with this stack. AWS CloudFormation also propagates
// these tags to the resources created in the stack. A maximum number of 50 tags
// can be specified.
Tags []types.Tag
// Structure containing the template body with a minimum length of 1 byte and a
// maximum length of 51,200 bytes. For more information, go to Template Anatomy
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
// in the AWS CloudFormation User Guide. Conditional: You must specify either the
// TemplateBody or the TemplateURL parameter, but not both.
TemplateBody *string
// Location of file containing the template body. The URL must point to a template
// (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more
// information, go to the Template Anatomy
// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
// in the AWS CloudFormation User Guide. Conditional: You must specify either the
// TemplateBody or the TemplateURL parameter, but not both.
TemplateURL *string
// The amount of time that can pass before the stack status becomes CREATE_FAILED;
// if DisableRollback is not set or is set to false, the stack will be rolled back.
TimeoutInMinutes *int32
}
// The output for a CreateStack action.
type CreateStackOutput struct {
// Unique identifier of the stack.
StackId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationCreateStackMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpCreateStack{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCreateStack{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCreateStackValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateStack(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateStack(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "cloudformation",
OperationName: "CreateStack",
}
}