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
186
187
188
189
190
191
192
193
194
195
196
197
198
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package secretsmanager
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Deletes a secret and all of its versions. You can specify a recovery window
// during which you can restore the secret. The minimum recovery window is 7 days.
// The default recovery window is 30 days. Secrets Manager attaches a DeletionDate
// stamp to the secret that specifies the end of the recovery window. At the end of
// the recovery window, Secrets Manager deletes the secret permanently. You can't
// delete a primary secret that is replicated to other Regions. You must first
// delete the replicas using RemoveRegionsFromReplication , and then delete the
// primary secret. When you delete a replica, it is deleted immediately. You can't
// directly delete a version of a secret. Instead, you remove all staging labels
// from the version using UpdateSecretVersionStage . This marks the version as
// deprecated, and then Secrets Manager can automatically delete the version in the
// background. To determine whether an application still uses a secret, you can
// create an Amazon CloudWatch alarm to alert you to any attempts to access a
// secret during the recovery window. For more information, see Monitor secrets
// scheduled for deletion (https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html)
// . Secrets Manager performs the permanent secret deletion at the end of the
// waiting period as a background task with low priority. There is no guarantee of
// a specific time after the recovery window for the permanent delete to occur. At
// any time before recovery window ends, you can use RestoreSecret to remove the
// DeletionDate and cancel the deletion of the secret. When a secret is scheduled
// for deletion, you cannot retrieve the secret value. You must first cancel the
// deletion with RestoreSecret and then you can retrieve the secret. Secrets
// Manager generates a CloudTrail log entry when you call this action. Do not
// include sensitive information in request parameters because it might be logged.
// For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html)
// . Required permissions: secretsmanager:DeleteSecret . For more information, see
// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions)
// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html)
// .
func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, optFns ...func(*Options)) (*DeleteSecretOutput, error) {
if params == nil {
params = &DeleteSecretInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeleteSecret", params, optFns, c.addOperationDeleteSecretMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeleteSecretOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeleteSecretInput struct {
// The ARN or name of the secret to delete. For an ARN, we recommend that you
// specify a complete ARN rather than a partial ARN. See Finding a secret from a
// partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen)
// .
//
// This member is required.
SecretId *string
// Specifies whether to delete the secret without any recovery window. You can't
// use both this parameter and RecoveryWindowInDays in the same call. If you don't
// use either, then by default Secrets Manager uses a 30 day recovery window.
// Secrets Manager performs the actual deletion with an asynchronous background
// process, so there might be a short delay before the secret is permanently
// deleted. If you delete a secret and then immediately create a secret with the
// same name, use appropriate back off and retry logic. If you forcibly delete an
// already deleted or nonexistent secret, the operation does not return
// ResourceNotFoundException . Use this parameter with caution. This parameter
// causes the operation to skip the normal recovery window before the permanent
// deletion that Secrets Manager would normally impose with the
// RecoveryWindowInDays parameter. If you delete a secret with the
// ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover
// the secret. You lose the secret permanently.
ForceDeleteWithoutRecovery *bool
// The number of days from 7 to 30 that Secrets Manager waits before permanently
// deleting the secret. You can't use both this parameter and
// ForceDeleteWithoutRecovery in the same call. If you don't use either, then by
// default Secrets Manager uses a 30 day recovery window.
RecoveryWindowInDays *int64
noSmithyDocumentSerde
}
type DeleteSecretOutput struct {
// The ARN of the secret.
ARN *string
// The date and time after which this secret Secrets Manager can permanently
// delete this secret, and it can no longer be restored. This value is the date and
// time of the delete request plus the number of days in RecoveryWindowInDays .
DeletionDate *time.Time
// The name of the secret.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeleteSecretMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteSecret{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteSecret{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteSecret"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDeleteSecretValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteSecret(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDeleteSecret(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DeleteSecret",
}
}
|
