-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DeleteDBInstance.go
185 lines (168 loc) · 6.65 KB
/
api_op_DeleteDBInstance.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
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/rds/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// The DeleteDBInstance action deletes a previously provisioned DB instance. When
// you delete a DB instance, all automated backups for that instance are deleted
// and can't be recovered. Manual DB snapshots of the DB instance to be deleted by
// DeleteDBInstance are not deleted. If you request a final DB snapshot the status
// of the Amazon RDS DB instance is deleting until the DB snapshot is created. The
// API action DescribeDBInstance is used to monitor the status of this operation.
// The action can't be canceled or reverted once submitted. When a DB instance is
// in a failure state and has a status of failed, incompatible-restore, or
// incompatible-network, you can only delete it when you skip creation of the final
// snapshot with the SkipFinalSnapshot parameter. If the specified DB instance is
// part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of
// the following conditions are true:
//
// * The DB cluster is a read replica of
// another Amazon Aurora DB cluster.
//
// * The DB instance is the only instance in the
// DB cluster.
//
// To delete a DB instance in this case, first call the
// PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no
// longer a read replica. After the promotion completes, then call the
// DeleteDBInstance API action to delete the final instance in the DB cluster.
func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceInput, optFns ...func(*Options)) (*DeleteDBInstanceOutput, error) {
if params == nil {
params = &DeleteDBInstanceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeleteDBInstance", params, optFns, c.addOperationDeleteDBInstanceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeleteDBInstanceOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeleteDBInstanceInput struct {
// The DB instance identifier for the DB instance to be deleted. This parameter
// isn't case-sensitive. Constraints:
//
// * Must match the name of an existing DB
// instance.
//
// This member is required.
DBInstanceIdentifier *string
// A value that indicates whether to remove automated backups immediately after the
// DB instance is deleted. This parameter isn't case-sensitive. The default is to
// remove automated backups immediately after the DB instance is deleted.
DeleteAutomatedBackups *bool
// The DBSnapshotIdentifier of the new DBSnapshot created when the
// SkipFinalSnapshot parameter is disabled. If you enable this parameter and also
// enable SkipFinalShapshot, the command results in an error. This setting doesn't
// apply to RDS Custom. Constraints:
//
// * Must be 1 to 255 letters or numbers.
//
// *
// First character must be a letter.
//
// * Can't end with a hyphen or contain two
// consecutive hyphens.
//
// * Can't be specified when deleting a read replica.
FinalDBSnapshotIdentifier *string
// A value that indicates whether to skip the creation of a final DB snapshot
// before deleting the instance. If you enable this parameter, RDS doesn't create a
// DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot
// before the DB instance is deleted. By default, skip isn't enabled, and the DB
// snapshot is created. If you don't enable this parameter, you must specify the
// FinalDBSnapshotIdentifier parameter. When a DB instance is in a failure state
// and has a status of failed, incompatible-restore, or incompatible-network, RDS
// can delete the instance only if you enable this parameter. If you delete a read
// replica or an RDS Custom instance, you must enable this setting. This setting is
// required for RDS Custom.
SkipFinalSnapshot bool
noSmithyDocumentSerde
}
type DeleteDBInstanceOutput struct {
// Contains the details of an Amazon RDS DB instance. This data type is used as a
// response element in the operations CreateDBInstance,
// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances,
// ModifyDBInstance, PromoteReadReplica, RebootDBInstance,
// RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
DBInstance *types.DBInstance
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeleteDBInstanceMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpDeleteDBInstance{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDeleteDBInstance{}, 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 = addOpDeleteDBInstanceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteDBInstance(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_opDeleteDBInstance(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "DeleteDBInstance",
}
}