api_op_CreateBucket.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 // Creates an Amazon Lightsail bucket.
15 //
16 // A bucket is a cloud storage resource available in the Lightsail object storage
17 // service. Use buckets to store objects such as data and its descriptive metadata.
18 // For more information about buckets, see [Buckets in Amazon Lightsail]in the Amazon Lightsail Developer Guide.
19 //
20 // [Buckets in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/buckets-in-amazon-lightsail
21 func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) {
22 if params == nil {
23 params = &CreateBucketInput{}
24 }
25
26 result, metadata, err := c.invokeOperation(ctx, "CreateBucket", params, optFns, c.addOperationCreateBucketMiddlewares)
27 if err != nil {
28 return nil, err
29 }
30
31 out := result.(*CreateBucketOutput)
32 out.ResultMetadata = metadata
33 return out, nil
34 }
35
36 type CreateBucketInput struct {
37
38 // The name for the bucket.
39 //
40 // For more information about bucket names, see [Bucket naming rules in Amazon Lightsail] in the Amazon Lightsail Developer
41 // Guide.
42 //
43 // [Bucket naming rules in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/bucket-naming-rules-in-amazon-lightsail
44 //
45 // This member is required.
46 BucketName *string
47
48 // The ID of the bundle to use for the bucket.
49 //
50 // A bucket bundle specifies the monthly cost, storage space, and data transfer
51 // quota for a bucket.
52 //
53 // Use the [GetBucketBundles] action to get a list of bundle IDs that you can specify.
54 //
55 // Use the [UpdateBucketBundle] action to change the bundle after the bucket is created.
56 //
57 // [UpdateBucketBundle]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html
58 // [GetBucketBundles]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html
59 //
60 // This member is required.
61 BundleId *string
62
63 // A Boolean value that indicates whether to enable versioning of objects in the
64 // bucket.
65 //
66 // For more information about versioning, see [Enabling and suspending object versioning in a bucket in Amazon Lightsail] in the Amazon Lightsail Developer
67 // Guide.
68 //
69 // [Enabling and suspending object versioning in a bucket in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-managing-bucket-object-versioning
70 EnableObjectVersioning *bool
71
72 // The tag keys and optional values to add to the bucket during creation.
73 //
74 // Use the [TagResource] action to tag the bucket after it's created.
75 //
76 // [TagResource]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html
77 Tags []types.Tag
78
79 noSmithyDocumentSerde
80 }
81
82 type CreateBucketOutput struct {
83
84 // An object that describes the bucket that is created.
85 Bucket *types.Bucket
86
87 // An array of objects that describe the result of the action, such as the status
88 // of the request, the timestamp of the request, and the resources affected by the
89 // request.
90 Operations []types.Operation
91
92 // Metadata pertaining to the operation's result.
93 ResultMetadata middleware.Metadata
94
95 noSmithyDocumentSerde
96 }
97
98 func (c *Client) addOperationCreateBucketMiddlewares(stack *middleware.Stack, options Options) (err error) {
99 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
100 return err
101 }
102 err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateBucket{}, middleware.After)
103 if err != nil {
104 return err
105 }
106 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateBucket{}, middleware.After)
107 if err != nil {
108 return err
109 }
110 if err := addProtocolFinalizerMiddlewares(stack, options, "CreateBucket"); err != nil {
111 return fmt.Errorf("add protocol finalizers: %v", err)
112 }
113
114 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
115 return err
116 }
117 if err = addSetLoggerMiddleware(stack, options); err != nil {
118 return err
119 }
120 if err = addClientRequestID(stack); err != nil {
121 return err
122 }
123 if err = addComputeContentLength(stack); err != nil {
124 return err
125 }
126 if err = addResolveEndpointMiddleware(stack, options); err != nil {
127 return err
128 }
129 if err = addComputePayloadSHA256(stack); err != nil {
130 return err
131 }
132 if err = addRetry(stack, options); err != nil {
133 return err
134 }
135 if err = addRawResponseToMetadata(stack); err != nil {
136 return err
137 }
138 if err = addRecordResponseTiming(stack); err != nil {
139 return err
140 }
141 if err = addSpanRetryLoop(stack, options); err != nil {
142 return err
143 }
144 if err = addClientUserAgent(stack, options); err != nil {
145 return err
146 }
147 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
148 return err
149 }
150 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
151 return err
152 }
153 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
154 return err
155 }
156 if err = addTimeOffsetBuild(stack, c); err != nil {
157 return err
158 }
159 if err = addUserAgentRetryMode(stack, options); err != nil {
160 return err
161 }
162 if err = addCredentialSource(stack, options); err != nil {
163 return err
164 }
165 if err = addOpCreateBucketValidationMiddleware(stack); err != nil {
166 return err
167 }
168 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateBucket(options.Region), middleware.Before); err != nil {
169 return err
170 }
171 if err = addRecursionDetection(stack); err != nil {
172 return err
173 }
174 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
175 return err
176 }
177 if err = addResponseErrorMiddleware(stack); err != nil {
178 return err
179 }
180 if err = addRequestResponseLogging(stack, options); err != nil {
181 return err
182 }
183 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
184 return err
185 }
186 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
187 return err
188 }
189 if err = addInterceptAttempt(stack, options); err != nil {
190 return err
191 }
192 if err = addInterceptors(stack, options); err != nil {
193 return err
194 }
195 return nil
196 }
197
198 func newServiceMetadataMiddleware_opCreateBucket(region string) *awsmiddleware.RegisterServiceMetadata {
199 return &awsmiddleware.RegisterServiceMetadata{
200 Region: region,
201 ServiceID: ServiceID,
202 OperationName: "CreateBucket",
203 }
204 }
205