-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_RegisterImage.go
250 lines (221 loc) · 10 KB
/
api_op_RegisterImage.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package ec2
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/ec2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Registers an AMI. When you're creating an AMI, this is the final step you must
// complete before you can launch an instance from the AMI. For more information
// about creating AMIs, see Creating your own AMIs
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html) in
// the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances,
// CreateImage creates and registers the AMI in a single request, so you don't have
// to register the AMI yourself. If needed, you can deregister an AMI at any time.
// Any modifications you make to an AMI backed by an instance store volume
// invalidates its registration. If you make changes to an image, deregister the
// previous image and register the new image. Register a snapshot of a root device
// volume You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a
// snapshot of a root device volume. You specify the snapshot using a block device
// mapping. You can't set the encryption state of the volume using the block device
// mapping. If the snapshot is encrypted, or encryption by default is enabled, the
// root volume of an instance launched from the AMI is encrypted. For more
// information, see Create a Linux AMI from a snapshot
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot)
// and Use encryption with Amazon EBS-backed AMIs
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html) in the
// Amazon Elastic Compute Cloud User Guide. Amazon Web Services Marketplace product
// codes If any snapshots have Amazon Web Services Marketplace product codes, they
// are copied to the new AMI. Windows and some Linux distributions, such as Red Hat
// Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon
// EC2 billing product code associated with an AMI to verify the subscription
// status for package updates. To create a new AMI for operating systems that
// require a billing product code, instead of registering the AMI, do the following
// to preserve the billing product code association:
//
// * Launch an instance from an
// existing AMI with that billing product code.
//
// * Customize the instance.
//
// *
// Create an AMI from the instance using CreateImage.
//
// If you purchase a Reserved
// Instance to apply to an On-Demand Instance that was launched from an AMI with a
// billing product code, make sure that the Reserved Instance has the matching
// billing product code. If you purchase a Reserved Instance without the matching
// billing product code, the Reserved Instance will not be applied to the On-Demand
// Instance. For information about how to obtain the platform details and billing
// information of an AMI, see Understanding AMI billing
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) in
// the Amazon Elastic Compute Cloud User Guide.
func (c *Client) RegisterImage(ctx context.Context, params *RegisterImageInput, optFns ...func(*Options)) (*RegisterImageOutput, error) {
if params == nil {
params = &RegisterImageInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RegisterImage", params, optFns, c.addOperationRegisterImageMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RegisterImageOutput)
out.ResultMetadata = metadata
return out, nil
}
// Contains the parameters for RegisterImage.
type RegisterImageInput struct {
// A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses
// (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-),
// single quotes ('), at-signs (@), or underscores(_)
//
// This member is required.
Name *string
// The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For
// instance store-backed AMIs, the architecture specified in the manifest file.
Architecture types.ArchitectureValues
// The billing product codes. Your account must be authorized to specify billing
// product codes. Otherwise, you can use the Amazon Web Services Marketplace to
// bill for the use of an AMI.
BillingProducts []string
// The block device mapping entries. If you specify an Amazon EBS volume using the
// ID of an Amazon EBS snapshot, you can't specify the encryption state of the
// volume. If you create an AMI on an Outpost, then all backing snapshots must be
// on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that
// include local snapshots can be used to launch instances on the same Outpost
// only. For more information, Amazon EBS local snapshots on Outposts
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami)
// in the Amazon Elastic Compute Cloud User Guide.
BlockDeviceMappings []types.BlockDeviceMapping
// The boot mode of the AMI. For more information, see Boot modes
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the
// Amazon Elastic Compute Cloud User Guide.
BootMode types.BootModeValues
// A description for your AMI.
Description *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
// Set to true to enable enhanced networking with ENA for the AMI and any instances
// that you launch from the AMI. This option is supported only for HVM AMIs.
// Specifying this option with a PV AMI can make instances launched from the AMI
// unreachable.
EnaSupport *bool
// The full path to your AMI manifest in Amazon S3 storage. The specified bucket
// must have the aws-exec-read canned access control list (ACL) to ensure that it
// can be accessed by Amazon EC2. For more information, see Canned ACLs
// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
// in the Amazon S3 Service Developer Guide.
ImageLocation *string
// The ID of the kernel.
KernelId *string
// The ID of the RAM disk.
RamdiskId *string
// The device name of the root device volume (for example, /dev/sda1).
RootDeviceName *string
// Set to simple to enable enhanced networking with the Intel 82599 Virtual
// Function interface for the AMI and any instances that you launch from the AMI.
// There is no way to disable sriovNetSupport at this time. This option is
// supported only for HVM AMIs. Specifying this option with a PV AMI can make
// instances launched from the AMI unreachable.
SriovNetSupport *string
// Set to v2.0 to enable Trusted Platform Module (TPM) support. For more
// information, see NitroTPM
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) in the
// Amazon Elastic Compute Cloud User Guide.
TpmSupport types.TpmSupportValues
// Base64 representation of the non-volatile UEFI variable store. To retrieve the
// UEFI data, use the GetInstanceUefiData
// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData)
// command. You can inspect and modify the UEFI data by using the python-uefivars
// tool (https://github.com/awslabs/python-uefivars) on GitHub. For more
// information, see UEFI Secure Boot
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in
// the Amazon Elastic Compute Cloud User Guide.
UefiData *string
// The type of virtualization (hvm | paravirtual). Default: paravirtual
VirtualizationType *string
noSmithyDocumentSerde
}
// Contains the output of RegisterImage.
type RegisterImageOutput struct {
// The ID of the newly registered AMI.
ImageId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRegisterImageMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsEc2query_serializeOpRegisterImage{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsEc2query_deserializeOpRegisterImage{}, 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 = addOpRegisterImageValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRegisterImage(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_opRegisterImage(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ec2",
OperationName: "RegisterImage",
}
}