api_op_UpdateBucket.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 // Updates an existing Amazon Lightsail bucket.
15 //
16 // Use this action to update the configuration of an existing bucket, such as
17 // versioning, public accessibility, and the Amazon Web Services accounts that can
18 // access the bucket.
19 func (c *Client) UpdateBucket(ctx context.Context, params *UpdateBucketInput, optFns ...func(*Options)) (*UpdateBucketOutput, error) {
20 if params == nil {
21 params = &UpdateBucketInput{}
22 }
23
24 result, metadata, err := c.invokeOperation(ctx, "UpdateBucket", params, optFns, c.addOperationUpdateBucketMiddlewares)
25 if err != nil {
26 return nil, err
27 }
28
29 out := result.(*UpdateBucketOutput)
30 out.ResultMetadata = metadata
31 return out, nil
32 }
33
34 type UpdateBucketInput struct {
35
36 // The name of the bucket to update.
37 //
38 // This member is required.
39 BucketName *string
40
41 // An object that describes the access log configuration for the bucket.
42 AccessLogConfig *types.BucketAccessLogConfig
43
44 // An object that sets the public accessibility of objects in the specified bucket.
45 AccessRules *types.AccessRules
46
47 // Sets the cross-origin resource sharing (CORS) configuration for your bucket. If
48 // a CORS configuration exists, it is replaced with the specified configuration.
49 // For AWS CLI operations, this parameter can also be passed as a file. For more
50 // information, see [Configuring cross-origin resource sharing (CORS)].
51 //
52 // CORS information is only returned in a response when you update the CORS policy.
53 //
54 // [Configuring cross-origin resource sharing (CORS)]: https://docs.aws.amazon.com/lightsail/latest/userguide/configure-cors.html
55 Cors *types.BucketCorsConfig
56
57 // An array of strings to specify the Amazon Web Services account IDs that can
58 // access the bucket.
59 //
60 // You can give a maximum of 10 Amazon Web Services accounts access to a bucket.
61 ReadonlyAccessAccounts []string
62
63 // Specifies whether to enable or suspend versioning of objects in the bucket.
64 //
65 // The following options can be specified:
66 //
67 // - Enabled - Enables versioning of objects in the specified bucket.
68 //
69 // - Suspended - Suspends versioning of objects in the specified bucket. Existing
70 // object versions are retained.
71 Versioning *string
72
73 noSmithyDocumentSerde
74 }
75
76 type UpdateBucketOutput struct {
77
78 // An object that describes the bucket that is updated.
79 Bucket *types.Bucket
80
81 // An array of objects that describe the result of the action, such as the status
82 // of the request, the timestamp of the request, and the resources affected by the
83 // request.
84 Operations []types.Operation
85
86 // Metadata pertaining to the operation's result.
87 ResultMetadata middleware.Metadata
88
89 noSmithyDocumentSerde
90 }
91
92 func (c *Client) addOperationUpdateBucketMiddlewares(stack *middleware.Stack, options Options) (err error) {
93 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
94 return err
95 }
96 err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateBucket{}, middleware.After)
97 if err != nil {
98 return err
99 }
100 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateBucket{}, middleware.After)
101 if err != nil {
102 return err
103 }
104 if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateBucket"); err != nil {
105 return fmt.Errorf("add protocol finalizers: %v", err)
106 }
107
108 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
109 return err
110 }
111 if err = addSetLoggerMiddleware(stack, options); err != nil {
112 return err
113 }
114 if err = addClientRequestID(stack); err != nil {
115 return err
116 }
117 if err = addComputeContentLength(stack); err != nil {
118 return err
119 }
120 if err = addResolveEndpointMiddleware(stack, options); err != nil {
121 return err
122 }
123 if err = addComputePayloadSHA256(stack); err != nil {
124 return err
125 }
126 if err = addRetry(stack, options); err != nil {
127 return err
128 }
129 if err = addRawResponseToMetadata(stack); err != nil {
130 return err
131 }
132 if err = addRecordResponseTiming(stack); err != nil {
133 return err
134 }
135 if err = addSpanRetryLoop(stack, options); err != nil {
136 return err
137 }
138 if err = addClientUserAgent(stack, options); err != nil {
139 return err
140 }
141 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
142 return err
143 }
144 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
145 return err
146 }
147 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
148 return err
149 }
150 if err = addTimeOffsetBuild(stack, c); err != nil {
151 return err
152 }
153 if err = addUserAgentRetryMode(stack, options); err != nil {
154 return err
155 }
156 if err = addCredentialSource(stack, options); err != nil {
157 return err
158 }
159 if err = addOpUpdateBucketValidationMiddleware(stack); err != nil {
160 return err
161 }
162 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateBucket(options.Region), middleware.Before); err != nil {
163 return err
164 }
165 if err = addRecursionDetection(stack); err != nil {
166 return err
167 }
168 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
169 return err
170 }
171 if err = addResponseErrorMiddleware(stack); err != nil {
172 return err
173 }
174 if err = addRequestResponseLogging(stack, options); err != nil {
175 return err
176 }
177 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
178 return err
179 }
180 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
181 return err
182 }
183 if err = addInterceptAttempt(stack, options); err != nil {
184 return err
185 }
186 if err = addInterceptors(stack, options); err != nil {
187 return err
188 }
189 return nil
190 }
191
192 func newServiceMetadataMiddleware_opUpdateBucket(region string) *awsmiddleware.RegisterServiceMetadata {
193 return &awsmiddleware.RegisterServiceMetadata{
194 Region: region,
195 ServiceID: ServiceID,
196 OperationName: "UpdateBucket",
197 }
198 }
199