api_op_AttachDisk.go raw
1 // Code generated by smithy-go-codegen DO NOT EDIT.
2
3 package lightsail
4
5 import (
6 "context"
7 "fmt"
8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9 "github.com/aws/aws-sdk-go-v2/service/lightsail/types"
10 "github.com/aws/smithy-go/middleware"
11 smithyhttp "github.com/aws/smithy-go/transport/http"
12 )
13
14 // Attaches a block storage disk to a running or stopped Lightsail instance and
15 // exposes it to the instance with the specified disk name.
16 //
17 // The attach disk operation supports tag-based access control via resource tags
18 // applied to the resource identified by disk name . For more information, see the [Amazon Lightsail Developer Guide]
19 // .
20 //
21 // [Amazon Lightsail Developer Guide]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags
22 func (c *Client) AttachDisk(ctx context.Context, params *AttachDiskInput, optFns ...func(*Options)) (*AttachDiskOutput, error) {
23 if params == nil {
24 params = &AttachDiskInput{}
25 }
26
27 result, metadata, err := c.invokeOperation(ctx, "AttachDisk", params, optFns, c.addOperationAttachDiskMiddlewares)
28 if err != nil {
29 return nil, err
30 }
31
32 out := result.(*AttachDiskOutput)
33 out.ResultMetadata = metadata
34 return out, nil
35 }
36
37 type AttachDiskInput struct {
38
39 // The unique Lightsail disk name ( my-disk ).
40 //
41 // This member is required.
42 DiskName *string
43
44 // The disk path to expose to the instance ( /dev/xvdf ).
45 //
46 // This member is required.
47 DiskPath *string
48
49 // The name of the Lightsail instance where you want to utilize the storage disk.
50 //
51 // This member is required.
52 InstanceName *string
53
54 // A Boolean value used to determine the automatic mounting of a storage volume to
55 // a virtual computer. The default value is False .
56 //
57 // This value only applies to Lightsail for Research resources.
58 AutoMounting *bool
59
60 noSmithyDocumentSerde
61 }
62
63 type AttachDiskOutput struct {
64
65 // An array of objects that describe the result of the action, such as the status
66 // of the request, the timestamp of the request, and the resources affected by the
67 // request.
68 Operations []types.Operation
69
70 // Metadata pertaining to the operation's result.
71 ResultMetadata middleware.Metadata
72
73 noSmithyDocumentSerde
74 }
75
76 func (c *Client) addOperationAttachDiskMiddlewares(stack *middleware.Stack, options Options) (err error) {
77 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
78 return err
79 }
80 err = stack.Serialize.Add(&awsAwsjson11_serializeOpAttachDisk{}, middleware.After)
81 if err != nil {
82 return err
83 }
84 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpAttachDisk{}, middleware.After)
85 if err != nil {
86 return err
87 }
88 if err := addProtocolFinalizerMiddlewares(stack, options, "AttachDisk"); err != nil {
89 return fmt.Errorf("add protocol finalizers: %v", err)
90 }
91
92 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
93 return err
94 }
95 if err = addSetLoggerMiddleware(stack, options); err != nil {
96 return err
97 }
98 if err = addClientRequestID(stack); err != nil {
99 return err
100 }
101 if err = addComputeContentLength(stack); err != nil {
102 return err
103 }
104 if err = addResolveEndpointMiddleware(stack, options); err != nil {
105 return err
106 }
107 if err = addComputePayloadSHA256(stack); err != nil {
108 return err
109 }
110 if err = addRetry(stack, options); err != nil {
111 return err
112 }
113 if err = addRawResponseToMetadata(stack); err != nil {
114 return err
115 }
116 if err = addRecordResponseTiming(stack); err != nil {
117 return err
118 }
119 if err = addSpanRetryLoop(stack, options); err != nil {
120 return err
121 }
122 if err = addClientUserAgent(stack, options); err != nil {
123 return err
124 }
125 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
126 return err
127 }
128 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
129 return err
130 }
131 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
132 return err
133 }
134 if err = addTimeOffsetBuild(stack, c); err != nil {
135 return err
136 }
137 if err = addUserAgentRetryMode(stack, options); err != nil {
138 return err
139 }
140 if err = addCredentialSource(stack, options); err != nil {
141 return err
142 }
143 if err = addOpAttachDiskValidationMiddleware(stack); err != nil {
144 return err
145 }
146 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAttachDisk(options.Region), middleware.Before); err != nil {
147 return err
148 }
149 if err = addRecursionDetection(stack); err != nil {
150 return err
151 }
152 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
153 return err
154 }
155 if err = addResponseErrorMiddleware(stack); err != nil {
156 return err
157 }
158 if err = addRequestResponseLogging(stack, options); err != nil {
159 return err
160 }
161 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
162 return err
163 }
164 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
165 return err
166 }
167 if err = addInterceptAttempt(stack, options); err != nil {
168 return err
169 }
170 if err = addInterceptors(stack, options); err != nil {
171 return err
172 }
173 return nil
174 }
175
176 func newServiceMetadataMiddleware_opAttachDisk(region string) *awsmiddleware.RegisterServiceMetadata {
177 return &awsmiddleware.RegisterServiceMetadata{
178 Region: region,
179 ServiceID: ServiceID,
180 OperationName: "AttachDisk",
181 }
182 }
183