api_op_DeleteRelationalDatabase.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 // Deletes a database in Amazon Lightsail.
15 //
16 // The delete relational database operation supports tag-based access control via
17 // resource tags applied to the resource identified by relationalDatabaseName. For
18 // more information, see the [Amazon Lightsail Developer Guide].
19 //
20 // [Amazon Lightsail Developer Guide]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags
21 func (c *Client) DeleteRelationalDatabase(ctx context.Context, params *DeleteRelationalDatabaseInput, optFns ...func(*Options)) (*DeleteRelationalDatabaseOutput, error) {
22 if params == nil {
23 params = &DeleteRelationalDatabaseInput{}
24 }
25
26 result, metadata, err := c.invokeOperation(ctx, "DeleteRelationalDatabase", params, optFns, c.addOperationDeleteRelationalDatabaseMiddlewares)
27 if err != nil {
28 return nil, err
29 }
30
31 out := result.(*DeleteRelationalDatabaseOutput)
32 out.ResultMetadata = metadata
33 return out, nil
34 }
35
36 type DeleteRelationalDatabaseInput struct {
37
38 // The name of the database that you are deleting.
39 //
40 // This member is required.
41 RelationalDatabaseName *string
42
43 // The name of the database snapshot created if skip final snapshot is false ,
44 // which is the default value for that parameter.
45 //
46 // Specifying this parameter and also specifying the skip final snapshot parameter
47 // to true results in an error.
48 //
49 // Constraints:
50 //
51 // - Must contain from 2 to 255 alphanumeric characters, or hyphens.
52 //
53 // - The first and last character must be a letter or number.
54 FinalRelationalDatabaseSnapshotName *string
55
56 // Determines whether a final database snapshot is created before your database is
57 // deleted. If true is specified, no database snapshot is created. If false is
58 // specified, a database snapshot is created before your database is deleted.
59 //
60 // You must specify the final relational database snapshot name parameter if the
61 // skip final snapshot parameter is false .
62 //
63 // Default: false
64 SkipFinalSnapshot *bool
65
66 noSmithyDocumentSerde
67 }
68
69 type DeleteRelationalDatabaseOutput struct {
70
71 // An array of objects that describe the result of the action, such as the status
72 // of the request, the timestamp of the request, and the resources affected by the
73 // request.
74 Operations []types.Operation
75
76 // Metadata pertaining to the operation's result.
77 ResultMetadata middleware.Metadata
78
79 noSmithyDocumentSerde
80 }
81
82 func (c *Client) addOperationDeleteRelationalDatabaseMiddlewares(stack *middleware.Stack, options Options) (err error) {
83 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
84 return err
85 }
86 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteRelationalDatabase{}, middleware.After)
87 if err != nil {
88 return err
89 }
90 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteRelationalDatabase{}, middleware.After)
91 if err != nil {
92 return err
93 }
94 if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteRelationalDatabase"); err != nil {
95 return fmt.Errorf("add protocol finalizers: %v", err)
96 }
97
98 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
99 return err
100 }
101 if err = addSetLoggerMiddleware(stack, options); err != nil {
102 return err
103 }
104 if err = addClientRequestID(stack); err != nil {
105 return err
106 }
107 if err = addComputeContentLength(stack); err != nil {
108 return err
109 }
110 if err = addResolveEndpointMiddleware(stack, options); err != nil {
111 return err
112 }
113 if err = addComputePayloadSHA256(stack); err != nil {
114 return err
115 }
116 if err = addRetry(stack, options); err != nil {
117 return err
118 }
119 if err = addRawResponseToMetadata(stack); err != nil {
120 return err
121 }
122 if err = addRecordResponseTiming(stack); err != nil {
123 return err
124 }
125 if err = addSpanRetryLoop(stack, options); err != nil {
126 return err
127 }
128 if err = addClientUserAgent(stack, options); err != nil {
129 return err
130 }
131 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
132 return err
133 }
134 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
135 return err
136 }
137 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
138 return err
139 }
140 if err = addTimeOffsetBuild(stack, c); err != nil {
141 return err
142 }
143 if err = addUserAgentRetryMode(stack, options); err != nil {
144 return err
145 }
146 if err = addCredentialSource(stack, options); err != nil {
147 return err
148 }
149 if err = addOpDeleteRelationalDatabaseValidationMiddleware(stack); err != nil {
150 return err
151 }
152 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteRelationalDatabase(options.Region), middleware.Before); err != nil {
153 return err
154 }
155 if err = addRecursionDetection(stack); err != nil {
156 return err
157 }
158 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
159 return err
160 }
161 if err = addResponseErrorMiddleware(stack); err != nil {
162 return err
163 }
164 if err = addRequestResponseLogging(stack, options); err != nil {
165 return err
166 }
167 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
168 return err
169 }
170 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
171 return err
172 }
173 if err = addInterceptAttempt(stack, options); err != nil {
174 return err
175 }
176 if err = addInterceptors(stack, options); err != nil {
177 return err
178 }
179 return nil
180 }
181
182 func newServiceMetadataMiddleware_opDeleteRelationalDatabase(region string) *awsmiddleware.RegisterServiceMetadata {
183 return &awsmiddleware.RegisterServiceMetadata{
184 Region: region,
185 ServiceID: ServiceID,
186 OperationName: "DeleteRelationalDatabase",
187 }
188 }
189