/
SecretsManager.ts
1190 lines (1167 loc) · 72.6 KB
/
SecretsManager.ts
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
import {
CancelRotateSecretCommand,
CancelRotateSecretCommandInput,
CancelRotateSecretCommandOutput,
} from "./commands/CancelRotateSecretCommand";
import {
CreateSecretCommand,
CreateSecretCommandInput,
CreateSecretCommandOutput,
} from "./commands/CreateSecretCommand";
import {
DeleteResourcePolicyCommand,
DeleteResourcePolicyCommandInput,
DeleteResourcePolicyCommandOutput,
} from "./commands/DeleteResourcePolicyCommand";
import {
DeleteSecretCommand,
DeleteSecretCommandInput,
DeleteSecretCommandOutput,
} from "./commands/DeleteSecretCommand";
import {
DescribeSecretCommand,
DescribeSecretCommandInput,
DescribeSecretCommandOutput,
} from "./commands/DescribeSecretCommand";
import {
GetRandomPasswordCommand,
GetRandomPasswordCommandInput,
GetRandomPasswordCommandOutput,
} from "./commands/GetRandomPasswordCommand";
import {
GetResourcePolicyCommand,
GetResourcePolicyCommandInput,
GetResourcePolicyCommandOutput,
} from "./commands/GetResourcePolicyCommand";
import {
GetSecretValueCommand,
GetSecretValueCommandInput,
GetSecretValueCommandOutput,
} from "./commands/GetSecretValueCommand";
import { ListSecretsCommand, ListSecretsCommandInput, ListSecretsCommandOutput } from "./commands/ListSecretsCommand";
import {
ListSecretVersionIdsCommand,
ListSecretVersionIdsCommandInput,
ListSecretVersionIdsCommandOutput,
} from "./commands/ListSecretVersionIdsCommand";
import {
PutResourcePolicyCommand,
PutResourcePolicyCommandInput,
PutResourcePolicyCommandOutput,
} from "./commands/PutResourcePolicyCommand";
import {
PutSecretValueCommand,
PutSecretValueCommandInput,
PutSecretValueCommandOutput,
} from "./commands/PutSecretValueCommand";
import {
RemoveRegionsFromReplicationCommand,
RemoveRegionsFromReplicationCommandInput,
RemoveRegionsFromReplicationCommandOutput,
} from "./commands/RemoveRegionsFromReplicationCommand";
import {
ReplicateSecretToRegionsCommand,
ReplicateSecretToRegionsCommandInput,
ReplicateSecretToRegionsCommandOutput,
} from "./commands/ReplicateSecretToRegionsCommand";
import {
RestoreSecretCommand,
RestoreSecretCommandInput,
RestoreSecretCommandOutput,
} from "./commands/RestoreSecretCommand";
import {
RotateSecretCommand,
RotateSecretCommandInput,
RotateSecretCommandOutput,
} from "./commands/RotateSecretCommand";
import {
StopReplicationToReplicaCommand,
StopReplicationToReplicaCommandInput,
StopReplicationToReplicaCommandOutput,
} from "./commands/StopReplicationToReplicaCommand";
import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
import {
UntagResourceCommand,
UntagResourceCommandInput,
UntagResourceCommandOutput,
} from "./commands/UntagResourceCommand";
import {
UpdateSecretCommand,
UpdateSecretCommandInput,
UpdateSecretCommandOutput,
} from "./commands/UpdateSecretCommand";
import {
UpdateSecretVersionStageCommand,
UpdateSecretVersionStageCommandInput,
UpdateSecretVersionStageCommandOutput,
} from "./commands/UpdateSecretVersionStageCommand";
import {
ValidateResourcePolicyCommand,
ValidateResourcePolicyCommandInput,
ValidateResourcePolicyCommandOutput,
} from "./commands/ValidateResourcePolicyCommand";
import { SecretsManagerClient } from "./SecretsManagerClient";
/**
* <fullname>Amazon Web Services Secrets Manager</fullname>
* <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
* <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
* service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
* <p>
* <b>API Version</b>
* </p>
* <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
* <p>
* <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
* </p>
* <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
* information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
* Help</a>.</p>
* <p>
* <b>Logging API Requests</b>
* </p>
* <p>Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services
* account and delivers log files to an Amazon S3 bucket. By using information that's collected
* by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
* request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
* CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
* Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
* To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
*/
export class SecretsManager extends SecretsManagerClient {
/**
* <p>Turns off automatic rotation, and if a rotation is currently in
* progress, cancels the rotation.</p>
* <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
* labels in an unexpected state. You might
* need to remove the staging label <code>AWSPENDING</code> from the partially created version.
* You also need to determine whether to roll back to the previous version of the secret
* by moving the staging label <code>AWSCURRENT</code> to the version that has <code>AWSPENDING</code>.
* To determine
* which version has a specific staging label, call <a>ListSecretVersionIds</a>. Then use
* <a>UpdateSecretVersionStage</a> to change staging labels.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
* <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:CancelRotateSecret</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public cancelRotateSecret(
args: CancelRotateSecretCommandInput,
options?: __HttpHandlerOptions
): Promise<CancelRotateSecretCommandOutput>;
public cancelRotateSecret(
args: CancelRotateSecretCommandInput,
cb: (err: any, data?: CancelRotateSecretCommandOutput) => void
): void;
public cancelRotateSecret(
args: CancelRotateSecretCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CancelRotateSecretCommandOutput) => void
): void;
public cancelRotateSecret(
args: CancelRotateSecretCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelRotateSecretCommandOutput) => void),
cb?: (err: any, data?: CancelRotateSecretCommandOutput) => void
): Promise<CancelRotateSecretCommandOutput> | void {
const command = new CancelRotateSecretCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Creates a new secret. A <i>secret</i> can be a password, a set of
* credentials such as a user name and password, an OAuth token, or other secret information
* that you store in an encrypted form in Secrets Manager. The secret also
* includes the connection information to access a database or other service, which Secrets Manager
* doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
* important information needed to manage the secret.</p>
* <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a secret</a>.</p>
* <p>To create a secret, you can provide the secret value to be encrypted in either the
* <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
* If you include <code>SecretString</code> or <code>SecretBinary</code>
* then Secrets Manager creates an initial secret version and automatically attaches the staging
* label <code>AWSCURRENT</code> to it.</p>
* <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,
* you must make sure the JSON you store in the <code>SecretString</code> matches the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html">JSON structure of
* a database secret</a>.</p>
* <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
* <code>aws/secretsmanager</code>. If this key
* doesn't already exist in your account, then Secrets Manager creates it for you automatically. All
* users and roles in the Amazon Web Services account automatically have access to use <code>aws/secretsmanager</code>.
* Creating <code>aws/secretsmanager</code> can result in a one-time significant delay in returning the
* result.</p>
* <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then
* you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create
* and use a customer managed KMS key. </p>
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except <code>SecretBinary</code> or <code>SecretString</code> because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:CreateSecret</code>. If you
* include tags in the secret, you also need <code>secretsmanager:TagResource</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
* <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the key. </p>
*/
public createSecret(
args: CreateSecretCommandInput,
options?: __HttpHandlerOptions
): Promise<CreateSecretCommandOutput>;
public createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
public createSecret(
args: CreateSecretCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CreateSecretCommandOutput) => void
): void;
public createSecret(
args: CreateSecretCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecretCommandOutput) => void),
cb?: (err: any, data?: CreateSecretCommandOutput) => void
): Promise<CreateSecretCommandOutput> | void {
const command = new CreateSecretCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Deletes the resource-based permission policy attached to the secret. To attach a policy to
* a secret, use <a>PutResourcePolicy</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:DeleteResourcePolicy</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public deleteResourcePolicy(
args: DeleteResourcePolicyCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteResourcePolicyCommandOutput>;
public deleteResourcePolicy(
args: DeleteResourcePolicyCommandInput,
cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void
): void;
public deleteResourcePolicy(
args: DeleteResourcePolicyCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void
): void;
public deleteResourcePolicy(
args: DeleteResourcePolicyCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void),
cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void
): Promise<DeleteResourcePolicyCommandOutput> | void {
const command = new DeleteResourcePolicyCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>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 <code>DeletionDate</code> 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.</p>
* <p>You can't delete a primary secret that is replicated to other Regions. You must first delete the
* replicas using <a>RemoveRegionsFromReplication</a>, and then delete the primary secret.
* When you delete a replica, it is deleted immediately.</p>
* <p>You can't directly delete a version of a secret. Instead, you remove all staging labels
* from the version using <a>UpdateSecretVersionStage</a>. This marks the version as deprecated,
* and then Secrets Manager can automatically delete the version in the background.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html">
* Monitor secrets scheduled for deletion</a>.</p>
* <p>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.</p>
* <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to
* remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
* <p>When a secret is scheduled for deletion, you cannot retrieve the secret value.
* You must first cancel the deletion with <a>RestoreSecret</a> and then you can retrieve the secret.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:DeleteSecret</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public deleteSecret(
args: DeleteSecretCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteSecretCommandOutput>;
public deleteSecret(args: DeleteSecretCommandInput, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
public deleteSecret(
args: DeleteSecretCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteSecretCommandOutput) => void
): void;
public deleteSecret(
args: DeleteSecretCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecretCommandOutput) => void),
cb?: (err: any, data?: DeleteSecretCommandOutput) => void
): Promise<DeleteSecretCommandOutput> | void {
const command = new DeleteSecretCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager
* only returns fields that have a value in the response. </p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:DescribeSecret</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public describeSecret(
args: DescribeSecretCommandInput,
options?: __HttpHandlerOptions
): Promise<DescribeSecretCommandOutput>;
public describeSecret(
args: DescribeSecretCommandInput,
cb: (err: any, data?: DescribeSecretCommandOutput) => void
): void;
public describeSecret(
args: DescribeSecretCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DescribeSecretCommandOutput) => void
): void;
public describeSecret(
args: DescribeSecretCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecretCommandOutput) => void),
cb?: (err: any, data?: DescribeSecretCommandOutput) => void
): Promise<DescribeSecretCommandOutput> | void {
const command = new DescribeSecretCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Generates a random password. We recommend that you specify the
* maximum length and include every character type that the system you are generating a password
* for can support.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:GetRandomPassword</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public getRandomPassword(
args: GetRandomPasswordCommandInput,
options?: __HttpHandlerOptions
): Promise<GetRandomPasswordCommandOutput>;
public getRandomPassword(
args: GetRandomPasswordCommandInput,
cb: (err: any, data?: GetRandomPasswordCommandOutput) => void
): void;
public getRandomPassword(
args: GetRandomPasswordCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetRandomPasswordCommandOutput) => void
): void;
public getRandomPassword(
args: GetRandomPasswordCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRandomPasswordCommandOutput) => void),
cb?: (err: any, data?: GetRandomPasswordCommandOutput) => void
): Promise<GetRandomPasswordCommandOutput> | void {
const command = new GetRandomPasswordCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Retrieves the JSON text of the resource-based policy document attached to the
* secret. For more information about permissions policies attached to a secret, see
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
* policies attached to a secret</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:GetResourcePolicy</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public getResourcePolicy(
args: GetResourcePolicyCommandInput,
options?: __HttpHandlerOptions
): Promise<GetResourcePolicyCommandOutput>;
public getResourcePolicy(
args: GetResourcePolicyCommandInput,
cb: (err: any, data?: GetResourcePolicyCommandOutput) => void
): void;
public getResourcePolicy(
args: GetResourcePolicyCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetResourcePolicyCommandOutput) => void
): void;
public getResourcePolicy(
args: GetResourcePolicyCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void),
cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void
): Promise<GetResourcePolicyCommandOutput> | void {
const command = new GetResourcePolicyCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
* <code>SecretBinary</code> from the specified version of a secret, whichever contains
* content.</p>
* <p>We recommend that you cache your secret values by using client-side caching.
* Caching secrets improves speed and reduces your costs. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html">Cache secrets for
* your applications</a>.</p>
* <p>To retrieve the previous version of a secret, use <code>VersionStage</code> and specify
* AWSPREVIOUS. To revert to the previous version of a secret, call <a href="https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html">UpdateSecretVersionStage</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:GetSecretValue</code>.
* If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key
* <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public getSecretValue(
args: GetSecretValueCommandInput,
options?: __HttpHandlerOptions
): Promise<GetSecretValueCommandOutput>;
public getSecretValue(
args: GetSecretValueCommandInput,
cb: (err: any, data?: GetSecretValueCommandOutput) => void
): void;
public getSecretValue(
args: GetSecretValueCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetSecretValueCommandOutput) => void
): void;
public getSecretValue(
args: GetSecretValueCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSecretValueCommandOutput) => void),
cb?: (err: any, data?: GetSecretValueCommandOutput) => void
): Promise<GetSecretValueCommandOutput> | void {
const command = new GetSecretValueCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets
* that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.</p>
* <p>ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes.
* To get the latest information for a specific secret, use <a>DescribeSecret</a>.</p>
* <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>
* <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
* call <a>GetSecretValue</a>.</p>
* <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:ListSecrets</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public listSecrets(args: ListSecretsCommandInput, options?: __HttpHandlerOptions): Promise<ListSecretsCommandOutput>;
public listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
public listSecrets(
args: ListSecretsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListSecretsCommandOutput) => void
): void;
public listSecrets(
args: ListSecretsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecretsCommandOutput) => void),
cb?: (err: any, data?: ListSecretsCommandOutput) => void
): Promise<ListSecretsCommandOutput> | void {
const command = new ListSecretsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions
* of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">
* Secrets Manager concepts: Versions</a>.</p>
* <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:ListSecretVersionIds</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public listSecretVersionIds(
args: ListSecretVersionIdsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListSecretVersionIdsCommandOutput>;
public listSecretVersionIds(
args: ListSecretVersionIdsCommandInput,
cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void
): void;
public listSecretVersionIds(
args: ListSecretVersionIdsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void
): void;
public listSecretVersionIds(
args: ListSecretVersionIdsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecretVersionIdsCommandOutput) => void),
cb?: (err: any, data?: ListSecretVersionIdsCommandOutput) => void
): Promise<ListSecretVersionIdsCommandOutput> | void {
const command = new ListSecretVersionIdsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Attaches a resource-based permission policy to a secret. A resource-based policy is
* optional. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for Secrets Manager</a>
* </p>
* <p>For information about attaching a policy in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html">Attach a
* permissions policy to a secret</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:PutResourcePolicy</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public putResourcePolicy(
args: PutResourcePolicyCommandInput,
options?: __HttpHandlerOptions
): Promise<PutResourcePolicyCommandOutput>;
public putResourcePolicy(
args: PutResourcePolicyCommandInput,
cb: (err: any, data?: PutResourcePolicyCommandOutput) => void
): void;
public putResourcePolicy(
args: PutResourcePolicyCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: PutResourcePolicyCommandOutput) => void
): void;
public putResourcePolicy(
args: PutResourcePolicyCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void),
cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void
): Promise<PutResourcePolicyCommandOutput> | void {
const command = new PutResourcePolicyCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Creates a new version with a new encrypted secret value and attaches it to the secret. The
* version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>
* <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
* once every 10 minutes. When you update the secret value, Secrets Manager creates a new version
* of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
* remove versions created less than 24 hours ago. If you call <code>PutSecretValue</code> more
* than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
* the quota for secret versions.</p>
* <p>You can specify the staging labels to attach to the new version in <code>VersionStages</code>.
* If you don't include <code>VersionStages</code>, then Secrets Manager automatically
* moves the staging label <code>AWSCURRENT</code> to this version. If this operation creates
* the first version for the secret, then Secrets Manager
* automatically attaches the staging label <code>AWSCURRENT</code> to it.
* If this operation moves the staging label <code>AWSCURRENT</code> from another version to this
* version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to
* the version that <code>AWSCURRENT</code> was removed from.</p>
* <p>This operation is idempotent. If you call this operation with a <code>ClientRequestToken</code>
* that matches an existing version's VersionId, and you specify the
* same secret data, the operation succeeds but does nothing. However, if the secret data is
* different, then the operation fails because you can't modify an existing version; you can
* only create new ones.</p>
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except <code>SecretBinary</code> or <code>SecretString</code> because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:PutSecretValue</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public putSecretValue(
args: PutSecretValueCommandInput,
options?: __HttpHandlerOptions
): Promise<PutSecretValueCommandOutput>;
public putSecretValue(
args: PutSecretValueCommandInput,
cb: (err: any, data?: PutSecretValueCommandOutput) => void
): void;
public putSecretValue(
args: PutSecretValueCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: PutSecretValueCommandOutput) => void
): void;
public putSecretValue(
args: PutSecretValueCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSecretValueCommandOutput) => void),
cb?: (err: any, data?: PutSecretValueCommandOutput) => void
): Promise<PutSecretValueCommandOutput> | void {
const command = new PutSecretValueCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:RemoveRegionsFromReplication</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public removeRegionsFromReplication(
args: RemoveRegionsFromReplicationCommandInput,
options?: __HttpHandlerOptions
): Promise<RemoveRegionsFromReplicationCommandOutput>;
public removeRegionsFromReplication(
args: RemoveRegionsFromReplicationCommandInput,
cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void
): void;
public removeRegionsFromReplication(
args: RemoveRegionsFromReplicationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void
): void;
public removeRegionsFromReplication(
args: RemoveRegionsFromReplicationCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void),
cb?: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void
): Promise<RemoveRegionsFromReplicationCommandOutput> | void {
const command = new RemoveRegionsFromReplicationCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Replicates the secret to a new Regions. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html">Multi-Region secrets</a>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:ReplicateSecretToRegions</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public replicateSecretToRegions(
args: ReplicateSecretToRegionsCommandInput,
options?: __HttpHandlerOptions
): Promise<ReplicateSecretToRegionsCommandOutput>;
public replicateSecretToRegions(
args: ReplicateSecretToRegionsCommandInput,
cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void
): void;
public replicateSecretToRegions(
args: ReplicateSecretToRegionsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void
): void;
public replicateSecretToRegions(
args: ReplicateSecretToRegionsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplicateSecretToRegionsCommandOutput) => void),
cb?: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void
): Promise<ReplicateSecretToRegionsCommandOutput> | void {
const command = new ReplicateSecretToRegionsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
* stamp. You can access a secret again after it has been restored.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:RestoreSecret</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public restoreSecret(
args: RestoreSecretCommandInput,
options?: __HttpHandlerOptions
): Promise<RestoreSecretCommandOutput>;
public restoreSecret(
args: RestoreSecretCommandInput,
cb: (err: any, data?: RestoreSecretCommandOutput) => void
): void;
public restoreSecret(
args: RestoreSecretCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: RestoreSecretCommandOutput) => void
): void;
public restoreSecret(
args: RestoreSecretCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreSecretCommandOutput) => void),
cb?: (err: any, data?: RestoreSecretCommandOutput) => void
): Promise<RestoreSecretCommandOutput> | void {
const command = new RestoreSecretCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Configures and starts the asynchronous process of rotating the secret. For more information about rotation,
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
* <p>If you include the
* configuration parameters, the operation sets the values for the secret and then immediately
* starts a rotation. If you don't include the configuration parameters, the operation starts a
* rotation with the values already stored in the secret. </p>
* <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
* make sure the secret value is in the
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
* of a database secret</a>. In particular, if you want to use the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users"> alternating users strategy</a>, your secret must contain the ARN of a superuser
* secret.</p>
* <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
* for the rotation. The Lambda rotation function creates a new
* version of the secret and creates or updates the credentials on the database or service to
* match. After testing the new credentials, the function marks the new secret version with the staging
* label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
* <p>You can create the Lambda rotation function based on the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html">rotation function templates</a> that Secrets Manager provides. Choose
* a template that matches your <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html">Rotation strategy</a>.</p>
* <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
* to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
* version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
* version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
* assumes that a previous rotation request is still in progress and returns an error.</p>
* <p>When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:RotateSecret</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. You also need <code>lambda:InvokeFunction</code> permissions on the rotation function.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html">
* Permissions for rotation</a>.</p>
*/
public rotateSecret(
args: RotateSecretCommandInput,
options?: __HttpHandlerOptions
): Promise<RotateSecretCommandOutput>;
public rotateSecret(args: RotateSecretCommandInput, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
public rotateSecret(
args: RotateSecretCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: RotateSecretCommandOutput) => void
): void;
public rotateSecret(
args: RotateSecretCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RotateSecretCommandOutput) => void),
cb?: (err: any, data?: RotateSecretCommandOutput) => void
): Promise<RotateSecretCommandOutput> | void {
const command = new RotateSecretCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>
* <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:StopReplicationToReplica</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public stopReplicationToReplica(
args: StopReplicationToReplicaCommandInput,
options?: __HttpHandlerOptions
): Promise<StopReplicationToReplicaCommandOutput>;
public stopReplicationToReplica(
args: StopReplicationToReplicaCommandInput,
cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void
): void;
public stopReplicationToReplica(
args: StopReplicationToReplicaCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void
): void;
public stopReplicationToReplica(
args: StopReplicationToReplicaCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopReplicationToReplicaCommandOutput) => void),
cb?: (err: any, data?: StopReplicationToReplicaCommandOutput) => void
): Promise<StopReplicationToReplicaCommandOutput> | void {
const command = new StopReplicationToReplicaCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
* secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
* <p>The following restrictions apply to tags:</p>
* <ul>
* <li>
* <p>Maximum number of tags per secret: 50</p>
* </li>
* <li>
* <p>Maximum key length: 127 Unicode characters in UTF-8</p>
* </li>
* <li>
* <p>Maximum value length: 255 Unicode characters in UTF-8</p>
* </li>
* <li>
* <p>Tag keys and values are case sensitive.</p>
* </li>
* <li>
* <p>Do not use the <code>aws:</code> prefix in your tag names or values because Amazon Web Services reserves it
* for Amazon Web Services use. You can't edit or delete tag names or values with this
* prefix. Tags with this prefix do not count against your tags per secret limit.</p>
* </li>
* <li>
* <p>If you use your tagging schema across multiple services and resources,
* other services might have restrictions on allowed characters. Generally
* allowed characters: letters, spaces, and numbers representable in UTF-8, plus the
* following special characters: + - = . _ : / @.</p>
* </li>
* </ul>
* <important>
* <p>If you use tags as part of your security strategy, then adding or removing a tag can
* change permissions. If successfully completing this operation would result in you losing
* your permissions for this secret, then the operation is blocked and returns an Access Denied
* error.</p>
* </important>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:TagResource</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>
*/
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
public tagResource(
args: TagResourceCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: TagResourceCommandOutput) => void
): void;
public tagResource(
args: TagResourceCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void),
cb?: (err: any, data?: TagResourceCommandOutput) => void
): Promise<TagResourceCommandOutput> | void {
const command = new TagResourceCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}
/**
* <p>Removes specific tags from a secret.</p>
* <p>This operation is idempotent. If a requested tag is not attached to the secret, no error
* is returned and the secret metadata is unchanged.</p>
* <important>
* <p>If you use tags as part of your security strategy, then removing a tag can change
* permissions. If successfully completing this operation would result in you losing your
* permissions for this secret, then the operation is blocked and returns an Access Denied
* error.</p>
* </important>
* <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:UntagResource</code>.
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
* and access control in Secrets Manager</a>. </p>