-
Notifications
You must be signed in to change notification settings - Fork 624
/
api_op_CreateVolume.go
396 lines (348 loc) · 13.2 KB
/
api_op_CreateVolume.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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
// Code generated by smithy-go-codegen DO NOT EDIT.
package ec2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/ec2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates an EBS volume that can be attached to an instance in the same
// Availability Zone.
//
// You can create a new empty volume or restore a volume from an EBS snapshot. Any
// Amazon Web Services Marketplace product codes from the snapshot are propagated
// to the volume.
//
// You can create encrypted volumes. Encrypted volumes must be attached to
// instances that support Amazon EBS encryption. Volumes that are created from
// encrypted snapshots are also automatically encrypted. For more information, see [Amazon EBS encryption]
// in the Amazon EBS User Guide.
//
// You can tag your volumes during creation. For more information, see [Tag your Amazon EC2 resources] in the
// Amazon EC2 User Guide.
//
// For more information, see [Create an Amazon EBS volume] in the Amazon EBS User Guide.
//
// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html
// [Create an Amazon EBS volume]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-creating-volume.html
// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html
func (c *Client) CreateVolume(ctx context.Context, params *CreateVolumeInput, optFns ...func(*Options)) (*CreateVolumeOutput, error) {
if params == nil {
params = &CreateVolumeInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateVolume", params, optFns, c.addOperationCreateVolumeMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateVolumeOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateVolumeInput struct {
// The ID of the Availability Zone in which to create the volume. For example,
// us-east-1a .
//
// This member is required.
AvailabilityZone *string
// Unique, case-sensitive identifier that you provide to ensure the idempotency of
// the request. For more information, see [Ensure Idempotency].
//
// [Ensure Idempotency]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html
ClientToken *string
// Checks whether you have the required permissions for the action, without
// actually making the request, and provides an error response. If you have the
// required permissions, the error response is DryRunOperation . Otherwise, it is
// UnauthorizedOperation .
DryRun *bool
// Indicates whether the volume should be encrypted. The effect of setting the
// encryption state to true depends on the volume origin (new or from a snapshot),
// starting encryption state, ownership, and whether encryption by default is
// enabled. For more information, see [Encryption by default]in the Amazon EBS User Guide.
//
// Encrypted Amazon EBS volumes must be attached to instances that support Amazon
// EBS encryption. For more information, see [Supported instance types].
//
// [Supported instance types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances
// [Encryption by default]: https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default
Encrypted *bool
// The number of I/O operations per second (IOPS). For gp3 , io1 , and io2
// volumes, this represents the number of IOPS that are provisioned for the volume.
// For gp2 volumes, this represents the baseline performance of the volume and the
// rate at which the volume accumulates I/O credits for bursting.
//
// The following are the supported values for each volume type:
//
// - gp3 : 3,000 - 16,000 IOPS
//
// - io1 : 100 - 64,000 IOPS
//
// - io2 : 100 - 256,000 IOPS
//
// For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances,
// you can achieve performance up to 32,000 IOPS.
//
// This parameter is required for io1 and io2 volumes. The default for gp3 volumes
// is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard
// volumes.
//
// [instances built on the Nitro System]: https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html
Iops *int32
// The identifier of the KMS key to use for Amazon EBS encryption. If this
// parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
// specified, the encrypted state must be true .
//
// You can specify the KMS key using any of the following:
//
// - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
//
// - Key alias. For example, alias/ExampleAlias.
//
// - Key ARN. For example,
// arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
//
// - Alias ARN. For example,
// arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
//
// Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you
// specify an ID, alias, or ARN that is not valid, the action can appear to
// complete, but eventually fails.
KmsKeyId *string
// Indicates whether to enable Amazon EBS Multi-Attach. If you enable
// Multi-Attach, you can attach the volume to up to 16 [Instances built on the Nitro System]in the same Availability
// Zone. This parameter is supported with io1 and io2 volumes only. For more
// information, see [Amazon EBS Multi-Attach]in the Amazon EBS User Guide.
//
// [Instances built on the Nitro System]: https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html
// [Amazon EBS Multi-Attach]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html
MultiAttachEnabled *bool
// The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
//
// If you intend to use a volume with an instance running on an outpost, then you
// must create the volume on the same outpost as the instance. You can't use a
// volume created in an Amazon Web Services Region with an instance on an Amazon
// Web Services outpost, or the other way around.
OutpostArn *string
// The size of the volume, in GiBs. You must specify either a snapshot ID or a
// volume size. If you specify a snapshot, the default is the snapshot size. You
// can specify a volume size that is equal to or larger than the snapshot size.
//
// The following are the supported volumes sizes for each volume type:
//
// - gp2 and gp3 : 1 - 16,384 GiB
//
// - io1 : 4 - 16,384 GiB
//
// - io2 : 4 - 65,536 GiB
//
// - st1 and sc1 : 125 - 16,384 GiB
//
// - standard : 1 - 1024 GiB
Size *int32
// The snapshot from which to create the volume. You must specify either a
// snapshot ID or a volume size.
SnapshotId *string
// The tags to apply to the volume during creation.
TagSpecifications []types.TagSpecification
// The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
//
// This parameter is valid only for gp3 volumes.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
Throughput *int32
// The volume type. This parameter can be one of the following values:
//
// - General Purpose SSD: gp2 | gp3
//
// - Provisioned IOPS SSD: io1 | io2
//
// - Throughput Optimized HDD: st1
//
// - Cold HDD: sc1
//
// - Magnetic: standard
//
// Throughput Optimized HDD ( st1 ) and Cold HDD ( sc1 ) volumes can't be used as
// boot volumes.
//
// For more information, see [Amazon EBS volume types] in the Amazon EBS User Guide.
//
// Default: gp2
//
// [Amazon EBS volume types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html
VolumeType types.VolumeType
noSmithyDocumentSerde
}
// Describes a volume.
type CreateVolumeOutput struct {
// This parameter is not returned by CreateVolume.
//
// Information about the volume attachments.
Attachments []types.VolumeAttachment
// The Availability Zone for the volume.
AvailabilityZone *string
// The time stamp when volume creation was initiated.
CreateTime *time.Time
// Indicates whether the volume is encrypted.
Encrypted *bool
// This parameter is not returned by CreateVolume.
//
// Indicates whether the volume was created using fast snapshot restore.
FastRestored *bool
// The number of I/O operations per second (IOPS). For gp3 , io1 , and io2
// volumes, this represents the number of IOPS that are provisioned for the volume.
// For gp2 volumes, this represents the baseline performance of the volume and the
// rate at which the volume accumulates I/O credits for bursting.
Iops *int32
// The Amazon Resource Name (ARN) of the KMS key that was used to protect the
// volume encryption key for the volume.
KmsKeyId *string
// Indicates whether Amazon EBS Multi-Attach is enabled.
MultiAttachEnabled *bool
// The Amazon Resource Name (ARN) of the Outpost.
OutpostArn *string
// The size of the volume, in GiBs.
Size *int32
// The snapshot from which the volume was created, if applicable.
SnapshotId *string
// This parameter is not returned by CreateVolume.
//
// Reserved for future use.
SseType types.SSEType
// The volume state.
State types.VolumeState
// Any tags assigned to the volume.
Tags []types.Tag
// The throughput that the volume supports, in MiB/s.
Throughput *int32
// The ID of the volume.
VolumeId *string
// The volume type.
VolumeType types.VolumeType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateVolumeMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsEc2query_serializeOpCreateVolume{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsEc2query_deserializeOpCreateVolume{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateVolume"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addIdempotencyToken_opCreateVolumeMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateVolumeValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateVolume(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type idempotencyToken_initializeOpCreateVolume struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateVolume) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateVolume) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateVolumeInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateVolumeInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateVolumeMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateVolume{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateVolume(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateVolume",
}
}