aws-sdk-secretsmanager 1.50.0 → 1.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-secretsmanager/client.rb +499 -1054
- data/lib/aws-sdk-secretsmanager/types.rb +468 -632
- data/lib/aws-sdk-secretsmanager.rb +1 -1
- metadata +4 -4
@@ -119,7 +119,9 @@ module Aws::SecretsManager
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -285,6 +287,15 @@ module Aws::SecretsManager
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
288
|
# requests are made, and retries are disabled.
|
287
289
|
#
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
|
+
# will be used if available.
|
293
|
+
#
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
297
|
+
# is set to `true`.
|
298
|
+
#
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
289
300
|
# When `true`, request parameters are validated before
|
290
301
|
# sending the request.
|
@@ -337,60 +348,23 @@ module Aws::SecretsManager
|
|
337
348
|
|
338
349
|
# @!group API Operations
|
339
350
|
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
343
|
-
# To re-enable scheduled rotation, call RotateSecret with
|
344
|
-
# `AutomaticallyRotateAfterDays` set to a value greater than 0. This
|
345
|
-
# immediately rotates your secret and then enables the automatic
|
346
|
-
# schedule.
|
347
|
-
#
|
348
|
-
# <note markdown="1"> If you cancel a rotation while in progress, it can leave the
|
349
|
-
# `VersionStage` labels in an unexpected state. Depending on the step of
|
350
|
-
# the rotation in progress, you might need to remove the staging label
|
351
|
-
# `AWSPENDING` from the partially created version, specified by the
|
352
|
-
# `VersionId` response value. You should also evaluate the partially
|
353
|
-
# rotated new version to see if it should be deleted, which you can do
|
354
|
-
# by removing all staging labels from the new version `VersionStage`
|
355
|
-
# field.
|
356
|
-
#
|
357
|
-
# </note>
|
351
|
+
# Turns off automatic rotation, and if a rotation is currently in
|
352
|
+
# progress, cancels the rotation.
|
358
353
|
#
|
359
|
-
# To
|
360
|
-
# be in one of the following states:
|
354
|
+
# To turn on automatic rotation again, call RotateSecret.
|
361
355
|
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
# **Minimum permissions**
|
356
|
+
# <note markdown="1"> If you cancel a rotation in progress, it can leave the `VersionStage`
|
357
|
+
# labels in an unexpected state. Depending on the step of the rotation
|
358
|
+
# in progress, you might need to remove the staging label `AWSPENDING`
|
359
|
+
# from the partially created version, specified by the `VersionId`
|
360
|
+
# response value. We recommend you also evaluate the partially rotated
|
361
|
+
# new version to see if it should be deleted. You can delete a version
|
362
|
+
# by removing all staging labels from it.
|
370
363
|
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
# * secretsmanager:CancelRotateSecret
|
374
|
-
#
|
375
|
-
# ^
|
376
|
-
#
|
377
|
-
# **Related operations**
|
378
|
-
#
|
379
|
-
# * To configure rotation for a secret or to manually trigger a
|
380
|
-
# rotation, use RotateSecret.
|
381
|
-
#
|
382
|
-
# * To get the rotation configuration details for a secret, use
|
383
|
-
# DescribeSecret.
|
384
|
-
#
|
385
|
-
# * To list all of the currently available secrets, use ListSecrets.
|
386
|
-
#
|
387
|
-
# * To list all of the versions currently associated with a secret, use
|
388
|
-
# ListSecretVersionIds.
|
364
|
+
# </note>
|
389
365
|
#
|
390
366
|
# @option params [required, String] :secret_id
|
391
|
-
#
|
392
|
-
# either the Amazon Resource Name (ARN) or the friendly name of the
|
393
|
-
# secret.
|
367
|
+
# The ARN or name of the secret.
|
394
368
|
#
|
395
369
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
396
370
|
# partial ARN.
|
@@ -439,119 +413,64 @@ module Aws::SecretsManager
|
|
439
413
|
req.send_request(options)
|
440
414
|
end
|
441
415
|
|
442
|
-
# Creates a new secret. A secret
|
443
|
-
#
|
444
|
-
# the
|
445
|
-
#
|
446
|
-
# Secrets Manager
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
# You provide the secret data to be encrypted by putting text in either
|
456
|
-
# the `SecretString` parameter or binary data in the `SecretBinary`
|
416
|
+
# Creates a new secret. A *secret* is a set of credentials, such as a
|
417
|
+
# user name and password, that you store in an encrypted form in Secrets
|
418
|
+
# Manager. The secret also includes the connection information to access
|
419
|
+
# a database or other service, which Secrets Manager doesn't encrypt. A
|
420
|
+
# secret in Secrets Manager consists of both the protected secret data
|
421
|
+
# and the important information needed to manage the secret.
|
422
|
+
#
|
423
|
+
# For information about creating a secret in the console, see [Create a
|
424
|
+
# secret][1].
|
425
|
+
#
|
426
|
+
# To create a secret, you can provide the secret value to be encrypted
|
427
|
+
# in either the `SecretString` parameter or the `SecretBinary`
|
457
428
|
# parameter, but not both. If you include `SecretString` or
|
458
|
-
# `SecretBinary` then Secrets Manager
|
459
|
-
#
|
460
|
-
# the new version.
|
461
|
-
#
|
462
|
-
# <note markdown="1"> * If you call an operation to encrypt or decrypt the `SecretString` or
|
463
|
-
# `SecretBinary` for a secret in the same account as the calling user
|
464
|
-
# and that secret doesn't specify a Amazon Web Services KMS
|
465
|
-
# encryption key, Secrets Manager uses the account's default Amazon
|
466
|
-
# Web Services managed customer master key (CMK) with the alias
|
467
|
-
# `aws/secretsmanager`. If this key doesn't already exist in your
|
468
|
-
# account then Secrets Manager creates it for you automatically. All
|
469
|
-
# users and roles in the same Amazon Web Services account
|
470
|
-
# automatically have access to use the default CMK. Note that if an
|
471
|
-
# Secrets Manager API call results in Amazon Web Services creating the
|
472
|
-
# account's Amazon Web Services-managed CMK, it can result in a
|
473
|
-
# one-time significant delay in returning the result.
|
474
|
-
#
|
475
|
-
# * If the secret resides in a different Amazon Web Services account
|
476
|
-
# from the credentials calling an API that requires encryption or
|
477
|
-
# decryption of the secret value then you must create and use a custom
|
478
|
-
# Amazon Web Services KMS CMK because you can't access the default
|
479
|
-
# CMK for the account using credentials from a different Amazon Web
|
480
|
-
# Services account. Store the ARN of the CMK in the secret when you
|
481
|
-
# create the secret or when you update it by including it in the
|
482
|
-
# `KMSKeyId`. If you call an API that must encrypt or decrypt
|
483
|
-
# `SecretString` or `SecretBinary` using credentials from a different
|
484
|
-
# account then the Amazon Web Services KMS key policy must grant
|
485
|
-
# cross-account access to that other account's user or role for both
|
486
|
-
# the kms:GenerateDataKey and kms:Decrypt operations.
|
487
|
-
#
|
488
|
-
# </note>
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
# **Minimum permissions**
|
493
|
-
#
|
494
|
-
# To run this command, you must have the following permissions:
|
495
|
-
#
|
496
|
-
# * secretsmanager:CreateSecret
|
497
|
-
#
|
498
|
-
# * kms:GenerateDataKey - needed only if you use a customer-managed
|
499
|
-
# Amazon Web Services KMS key to encrypt the secret. You do not need
|
500
|
-
# this permission to use the account default Amazon Web Services
|
501
|
-
# managed CMK for Secrets Manager.
|
502
|
-
#
|
503
|
-
# * kms:Decrypt - needed only if you use a customer-managed Amazon Web
|
504
|
-
# Services KMS key to encrypt the secret. You do not need this
|
505
|
-
# permission to use the account default Amazon Web Services managed
|
506
|
-
# CMK for Secrets Manager.
|
507
|
-
#
|
508
|
-
# * secretsmanager:TagResource - needed only if you include the `Tags`
|
509
|
-
# parameter.
|
510
|
-
#
|
511
|
-
# **Related operations**
|
512
|
-
#
|
513
|
-
# * To delete a secret, use DeleteSecret.
|
429
|
+
# `SecretBinary` then Secrets Manager creates an initial secret version
|
430
|
+
# and automatically attaches the staging label `AWSCURRENT` to it.
|
514
431
|
#
|
515
|
-
#
|
432
|
+
# If you don't specify an KMS encryption key, Secrets Manager uses the
|
433
|
+
# Amazon Web Services managed key `aws/secretsmanager`. If this key
|
434
|
+
# doesn't already exist in your account, then Secrets Manager creates
|
435
|
+
# it for you automatically. All users and roles in the Amazon Web
|
436
|
+
# Services account automatically have access to use
|
437
|
+
# `aws/secretsmanager`. Creating `aws/secretsmanager` can result in a
|
438
|
+
# one-time significant delay in returning the result.
|
516
439
|
#
|
517
|
-
#
|
440
|
+
# If the secret is in a different Amazon Web Services account from the
|
441
|
+
# credentials calling the API, then you can't use `aws/secretsmanager`
|
442
|
+
# to encrypt the secret, and you must create and use a customer managed
|
443
|
+
# KMS key.
|
518
444
|
#
|
519
|
-
# * To retrieve the encrypted secure string and secure binary values,
|
520
|
-
# use GetSecretValue.
|
521
445
|
#
|
522
|
-
# * To retrieve all other details for a secret, use DescribeSecret. This
|
523
|
-
# does not include the encrypted secure string and secure binary
|
524
|
-
# values.
|
525
446
|
#
|
526
|
-
#
|
527
|
-
# secret, use DescribeSecret and examine the `SecretVersionsToStages`
|
528
|
-
# response value.
|
447
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html
|
529
448
|
#
|
530
449
|
# @option params [required, String] :name
|
531
|
-
#
|
450
|
+
# The name of the new secret.
|
532
451
|
#
|
533
|
-
# The secret name
|
534
|
-
# characters
|
452
|
+
# The secret name can contain ASCII letters, numbers, and the following
|
453
|
+
# characters: /\_+=.@-
|
535
454
|
#
|
536
|
-
#
|
455
|
+
# Do not end your secret name with a hyphen followed by six characters.
|
537
456
|
# If you do so, you risk confusion and unexpected results when searching
|
538
457
|
# for a secret by partial ARN. Secrets Manager automatically adds a
|
539
|
-
# hyphen and six random characters at the end of
|
540
|
-
#
|
541
|
-
# </note>
|
458
|
+
# hyphen and six random characters after the secret name at the end of
|
459
|
+
# the ARN.
|
542
460
|
#
|
543
461
|
# @option params [String] :client_request_token
|
544
|
-
#
|
545
|
-
# initial version
|
546
|
-
# specifies
|
462
|
+
# If you include `SecretString` or `SecretBinary`, then Secrets Manager
|
463
|
+
# creates an initial version for the secret, and this parameter
|
464
|
+
# specifies the unique identifier for the new version.
|
547
465
|
#
|
548
466
|
# <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
|
549
|
-
# Services
|
550
|
-
# empty. The CLI or SDK generates a random UUID for you and
|
551
|
-
# as the value for this parameter in the request. If you
|
552
|
-
# SDK and instead generate a raw HTTP request to the
|
553
|
-
# service endpoint, then you must generate a
|
554
|
-
# yourself for the new version and include the
|
467
|
+
# Services SDKs to call this operation, then you can leave this
|
468
|
+
# parameter empty. The CLI or SDK generates a random UUID for you and
|
469
|
+
# includes it as the value for this parameter in the request. If you
|
470
|
+
# don't use the SDK and instead generate a raw HTTP request to the
|
471
|
+
# Secrets Manager service endpoint, then you must generate a
|
472
|
+
# `ClientRequestToken` yourself for the new version and include the
|
473
|
+
# value in the request.
|
555
474
|
#
|
556
475
|
# </note>
|
557
476
|
#
|
@@ -584,99 +503,79 @@ module Aws::SecretsManager
|
|
584
503
|
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
585
504
|
#
|
586
505
|
# @option params [String] :description
|
587
|
-
#
|
506
|
+
# The description of the secret.
|
588
507
|
#
|
589
508
|
# @option params [String] :kms_key_id
|
590
|
-
#
|
591
|
-
#
|
592
|
-
# `SecretString` or `SecretBinary` values in the versions stored in this
|
593
|
-
# secret.
|
509
|
+
# The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
|
510
|
+
# encrypt the secret value in the secret.
|
594
511
|
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
# account, you can use only the key ARN or the alias ARN.
|
512
|
+
# To use a KMS key in a different account, use the key ARN or the alias
|
513
|
+
# ARN.
|
598
514
|
#
|
599
|
-
# If you don't specify this value, then Secrets Manager
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
# automatically the first time it needs to encrypt a version's
|
604
|
-
# `SecretString` or `SecretBinary` fields.
|
515
|
+
# If you don't specify this value, then Secrets Manager uses the key
|
516
|
+
# `aws/secretsmanager`. If that key doesn't yet exist, then Secrets
|
517
|
+
# Manager creates it for you automatically the first time it encrypts
|
518
|
+
# the secret value.
|
605
519
|
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
# the secret
|
609
|
-
#
|
520
|
+
# If the secret is in a different Amazon Web Services account from the
|
521
|
+
# credentials calling the API, then you can't use `aws/secretsmanager`
|
522
|
+
# to encrypt the secret, and you must create and use a customer managed
|
523
|
+
# KMS key.
|
610
524
|
#
|
611
525
|
# @option params [String, StringIO, File] :secret_binary
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
# file and then use the appropriate technique for your tool to pass the
|
616
|
-
# contents of the file as a parameter.
|
526
|
+
# The binary data to encrypt and store in the new version of the secret.
|
527
|
+
# We recommend that you store your binary data in a file and then pass
|
528
|
+
# the contents of the file as a parameter.
|
617
529
|
#
|
618
530
|
# Either `SecretString` or `SecretBinary` must have a value, but not
|
619
|
-
# both.
|
531
|
+
# both.
|
620
532
|
#
|
621
|
-
# This parameter is not available
|
622
|
-
# can be accessed only by using the Amazon Web Services CLI or one of
|
623
|
-
# the Amazon Web Services SDKs.
|
533
|
+
# This parameter is not available in the Secrets Manager console.
|
624
534
|
#
|
625
535
|
# @option params [String] :secret_string
|
626
|
-
#
|
627
|
-
#
|
536
|
+
# The text data to encrypt and store in this new version of the secret.
|
537
|
+
# We recommend you use a JSON structure of key/value pairs for your
|
538
|
+
# secret value.
|
628
539
|
#
|
629
540
|
# Either `SecretString` or `SecretBinary` must have a value, but not
|
630
|
-
# both.
|
541
|
+
# both.
|
631
542
|
#
|
632
543
|
# If you create a secret by using the Secrets Manager console then
|
633
544
|
# Secrets Manager puts the protected secret text in only the
|
634
545
|
# `SecretString` parameter. The Secrets Manager console stores the
|
635
|
-
# information as a JSON structure of key/value pairs that
|
636
|
-
# rotation function
|
637
|
-
#
|
638
|
-
# For storing multiple values, we recommend that you use a JSON text
|
639
|
-
# string argument and specify key/value pairs. For more information, see
|
640
|
-
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
641
|
-
# the Amazon Web Services CLI User Guide.
|
642
|
-
#
|
643
|
-
#
|
644
|
-
#
|
645
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
|
546
|
+
# information as a JSON structure of key/value pairs that a Lambda
|
547
|
+
# rotation function can parse.
|
646
548
|
#
|
647
549
|
# @option params [Array<Types::Tag>] :tags
|
648
|
-
#
|
649
|
-
#
|
650
|
-
# operation only appends tags to the existing list of tags. To remove
|
651
|
-
# tags, you must use UntagResource.
|
550
|
+
# A list of tags to attach to the secret. Each tag is a key and value
|
551
|
+
# pair of strings in a JSON text string, for example:
|
652
552
|
#
|
653
|
-
#
|
654
|
-
# "ABC" is a different tag from one with key "abc".
|
655
|
-
#
|
656
|
-
# * If you check tags in IAM policy `Condition` elements as part of your
|
657
|
-
# security strategy, then adding or removing a tag can change
|
658
|
-
# permissions. If the successful completion of this operation would
|
659
|
-
# result in you losing your permissions for this secret, then this
|
660
|
-
# operation is blocked and returns an `Access Denied` error.
|
553
|
+
# `[\{"Key":"CostCenter","Value":"12345"\},\{"Key":"environment","Value":"production"\}]`
|
661
554
|
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
# environments, see [Using JSON for Parameters][1] in the *CLI User
|
665
|
-
# Guide*. For example:
|
555
|
+
# Secrets Manager tag key names are case sensitive. A tag with the key
|
556
|
+
# "ABC" is a different tag from one with key "abc".
|
666
557
|
#
|
667
|
-
#
|
558
|
+
# If you check tags in permissions policies as part of your security
|
559
|
+
# strategy, then adding or removing a tag can change permissions. If the
|
560
|
+
# completion of this operation would result in you losing your
|
561
|
+
# permissions for this secret, then Secrets Manager blocks the operation
|
562
|
+
# and returns an `Access Denied` error. For more information, see
|
563
|
+
# [Control access to secrets using tags][1] and [Limit access to
|
564
|
+
# identities with tags that match secrets' tags][2].
|
668
565
|
#
|
669
|
-
#
|
566
|
+
# For information about how to format a JSON parameter for the various
|
567
|
+
# command line tool environments, see [Using JSON for Parameters][3]. If
|
568
|
+
# your command-line tool or SDK requires quotation marks around the
|
670
569
|
# parameter, you should use single quotes to avoid confusion with the
|
671
570
|
# double quotes required in the JSON text.
|
672
571
|
#
|
673
|
-
# The following
|
572
|
+
# The following restrictions apply to tags:
|
674
573
|
#
|
675
|
-
# * Maximum number of tags per secret
|
574
|
+
# * Maximum number of tags per secret: 50
|
676
575
|
#
|
677
|
-
# * Maximum key length
|
576
|
+
# * Maximum key length: 127 Unicode characters in UTF-8
|
678
577
|
#
|
679
|
-
# * Maximum value length
|
578
|
+
# * Maximum value length: 255 Unicode characters in UTF-8
|
680
579
|
#
|
681
580
|
# * Tag keys and values are case sensitive.
|
682
581
|
#
|
@@ -686,23 +585,23 @@ module Aws::SecretsManager
|
|
686
585
|
# with this prefix do not count against your tags per secret limit.
|
687
586
|
#
|
688
587
|
# * If you use your tagging schema across multiple services and
|
689
|
-
# resources,
|
690
|
-
#
|
691
|
-
#
|
588
|
+
# resources, other services might have restrictions on allowed
|
589
|
+
# characters. Generally allowed characters: letters, spaces, and
|
590
|
+
# numbers representable in UTF-8, plus the following special
|
692
591
|
# characters: + - = . \_ : / @.
|
693
592
|
#
|
694
593
|
#
|
695
594
|
#
|
696
|
-
# [1]: https://docs.aws.amazon.com/
|
595
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac
|
596
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2
|
597
|
+
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
|
697
598
|
#
|
698
599
|
# @option params [Array<Types::ReplicaRegionType>] :add_replica_regions
|
699
|
-
#
|
700
|
-
# replicates the KMSKeyID objects to the list of regions specified in
|
701
|
-
# the parameter.
|
600
|
+
# A list of Regions and KMS keys to replicate secrets.
|
702
601
|
#
|
703
602
|
# @option params [Boolean] :force_overwrite_replica_secret
|
704
|
-
#
|
705
|
-
#
|
603
|
+
# Specifies whether to overwrite a secret with the same name in the
|
604
|
+
# destination Region.
|
706
605
|
#
|
707
606
|
# @return [Types::CreateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
708
607
|
#
|
@@ -777,28 +676,11 @@ module Aws::SecretsManager
|
|
777
676
|
end
|
778
677
|
|
779
678
|
# Deletes the resource-based permission policy attached to the secret.
|
780
|
-
#
|
781
|
-
# **Minimum permissions**
|
782
|
-
#
|
783
|
-
# To run this command, you must have the following permissions:
|
784
|
-
#
|
785
|
-
# * secretsmanager:DeleteResourcePolicy
|
786
|
-
#
|
787
|
-
# ^
|
788
|
-
#
|
789
|
-
# **Related operations**
|
790
|
-
#
|
791
|
-
# * To attach a resource policy to a secret, use PutResourcePolicy.
|
792
|
-
#
|
793
|
-
# * To retrieve the current resource-based policy attached to a secret,
|
794
|
-
# use GetResourcePolicy.
|
795
|
-
#
|
796
|
-
# * To list all of the currently available secrets, use ListSecrets.
|
679
|
+
# To attach a policy to a secret, use PutResourcePolicy.
|
797
680
|
#
|
798
681
|
# @option params [required, String] :secret_id
|
799
|
-
#
|
800
|
-
#
|
801
|
-
# Name (ARN) or the friendly name of the secret.
|
682
|
+
# The ARN or name of the secret to delete the attached resource-based
|
683
|
+
# policy for.
|
802
684
|
#
|
803
685
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
804
686
|
# partial ARN.
|
@@ -843,86 +725,62 @@ module Aws::SecretsManager
|
|
843
725
|
req.send_request(options)
|
844
726
|
end
|
845
727
|
|
846
|
-
# Deletes
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
728
|
+
# Deletes a secret and all of its versions. You can specify a recovery
|
729
|
+
# window during which you can restore the secret. The minimum recovery
|
730
|
+
# window is 7 days. The default recovery window is 30 days. Secrets
|
731
|
+
# Manager attaches a `DeletionDate` stamp to the secret that specifies
|
732
|
+
# the end of the recovery window. At the end of the recovery window,
|
733
|
+
# Secrets Manager deletes the secret permanently.
|
852
734
|
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
# You cannot access the encrypted secret information in any secret
|
857
|
-
# scheduled for deletion. If you need to access that information, you
|
858
|
-
# must cancel the deletion with RestoreSecret and then retrieve the
|
859
|
-
# information.
|
860
|
-
#
|
861
|
-
# <note markdown="1"> * There is no explicit operation to delete a version of a secret.
|
862
|
-
# Instead, remove all staging labels from the `VersionStage` field of
|
863
|
-
# a version. That marks the version as deprecated and allows Secrets
|
864
|
-
# Manager to delete it as needed. Versions without any staging labels
|
865
|
-
# do not show up in ListSecretVersionIds unless you specify
|
866
|
-
# `IncludeDeprecated`.
|
735
|
+
# For information about deleting a secret in the console, see
|
736
|
+
# [https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage\_delete-secret.html][1].
|
867
737
|
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
871
|
-
#
|
872
|
-
#
|
873
|
-
# </note>
|
874
|
-
#
|
875
|
-
# **Minimum permissions**
|
738
|
+
# Secrets Manager performs the permanent secret deletion at the end of
|
739
|
+
# the waiting period as a background task with low priority. There is no
|
740
|
+
# guarantee of a specific time after the recovery window for the
|
741
|
+
# permanent delete to occur.
|
876
742
|
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
# * secretsmanager:DeleteSecret
|
743
|
+
# At any time before recovery window ends, you can use RestoreSecret to
|
744
|
+
# remove the `DeletionDate` and cancel the deletion of the secret.
|
880
745
|
#
|
881
|
-
#
|
746
|
+
# In a secret scheduled for deletion, you cannot access the encrypted
|
747
|
+
# secret value. To access that information, first cancel the deletion
|
748
|
+
# with RestoreSecret and then retrieve the information.
|
882
749
|
#
|
883
|
-
# **Related operations**
|
884
750
|
#
|
885
|
-
# * To create a secret, use CreateSecret.
|
886
751
|
#
|
887
|
-
#
|
888
|
-
# window has expired, use RestoreSecret.
|
752
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html
|
889
753
|
#
|
890
754
|
# @option params [required, String] :secret_id
|
891
|
-
#
|
892
|
-
# Resource Name (ARN) or the friendly name of the secret.
|
755
|
+
# The ARN or name of the secret to delete.
|
893
756
|
#
|
894
757
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
895
758
|
# partial ARN.
|
896
759
|
#
|
897
760
|
# @option params [Integer] :recovery_window_in_days
|
898
|
-
#
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
# This value can range from 7 to 30 days with a default value of 30.
|
761
|
+
# The number of days from 7 to 30 that Secrets Manager waits before
|
762
|
+
# permanently deleting the secret. You can't use both this parameter
|
763
|
+
# and `ForceDeleteWithoutRecovery` in the same call. If you don't use
|
764
|
+
# either, then Secrets Manager defaults to a 30 day recovery window.
|
904
765
|
#
|
905
766
|
# @option params [Boolean] :force_delete_without_recovery
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
767
|
+
# Specifies whether to delete the secret without any recovery window.
|
768
|
+
# You can't use both this parameter and `RecoveryWindowInDays` in the
|
769
|
+
# same call. If you don't use either, then Secrets Manager defaults to
|
770
|
+
# a 30 day recovery window.
|
909
771
|
#
|
910
|
-
#
|
911
|
-
# there
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
772
|
+
# Secrets Manager performs the actual deletion with an asynchronous
|
773
|
+
# background process, so there might be a short delay before the secret
|
774
|
+
# is permanently deleted. If you delete a secret and then immediately
|
775
|
+
# create a secret with the same name, use appropriate back off and retry
|
776
|
+
# logic.
|
915
777
|
#
|
916
778
|
# Use this parameter with caution. This parameter causes the operation
|
917
|
-
# to skip the normal
|
918
|
-
#
|
919
|
-
#
|
920
|
-
#
|
921
|
-
#
|
922
|
-
#
|
923
|
-
# If you use this parameter and include a previously deleted or
|
924
|
-
# nonexistent secret, the operation does not return the error
|
925
|
-
# `ResourceNotFoundException` in order to correctly handle retries.
|
779
|
+
# to skip the normal recovery window before the permanent deletion that
|
780
|
+
# Secrets Manager would normally impose with the `RecoveryWindowInDays`
|
781
|
+
# parameter. If you delete a secret with the `ForceDeleteWithouRecovery`
|
782
|
+
# parameter, then you have no opportunity to recover the secret. You
|
783
|
+
# lose the secret permanently.
|
926
784
|
#
|
927
785
|
# @return [Types::DeleteSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
928
786
|
#
|
@@ -973,33 +831,11 @@ module Aws::SecretsManager
|
|
973
831
|
end
|
974
832
|
|
975
833
|
# Retrieves the details of a secret. It does not include the encrypted
|
976
|
-
#
|
834
|
+
# secret value. Secrets Manager only returns fields that have a value in
|
977
835
|
# the response.
|
978
836
|
#
|
979
|
-
# **Minimum permissions**
|
980
|
-
#
|
981
|
-
# To run this command, you must have the following permissions:
|
982
|
-
#
|
983
|
-
# * secretsmanager:DescribeSecret
|
984
|
-
#
|
985
|
-
# ^
|
986
|
-
#
|
987
|
-
# **Related operations**
|
988
|
-
#
|
989
|
-
# * To create a secret, use CreateSecret.
|
990
|
-
#
|
991
|
-
# * To modify a secret, use UpdateSecret.
|
992
|
-
#
|
993
|
-
# * To retrieve the encrypted secret information in a version of the
|
994
|
-
# secret, use GetSecretValue.
|
995
|
-
#
|
996
|
-
# * To list all of the secrets in the Amazon Web Services account, use
|
997
|
-
# ListSecrets.
|
998
|
-
#
|
999
837
|
# @option params [required, String] :secret_id
|
1000
|
-
# The
|
1001
|
-
# can specify either the Amazon Resource Name (ARN) or the friendly name
|
1002
|
-
# of the secret.
|
838
|
+
# The ARN or name of the secret.
|
1003
839
|
#
|
1004
840
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1005
841
|
# partial ARN.
|
@@ -1111,66 +947,45 @@ module Aws::SecretsManager
|
|
1111
947
|
req.send_request(options)
|
1112
948
|
end
|
1113
949
|
|
1114
|
-
# Generates a random password
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
# include every character type that the system you are generating a
|
1118
|
-
# password for can support.
|
1119
|
-
#
|
1120
|
-
# **Minimum permissions**
|
1121
|
-
#
|
1122
|
-
# To run this command, you must have the following permissions:
|
1123
|
-
#
|
1124
|
-
# * secretsmanager:GetRandomPassword
|
1125
|
-
#
|
1126
|
-
# ^
|
950
|
+
# Generates a random password. We recommend that you specify the maximum
|
951
|
+
# length and include every character type that the system you are
|
952
|
+
# generating a password for can support.
|
1127
953
|
#
|
1128
954
|
# @option params [Integer] :password_length
|
1129
|
-
# The
|
1130
|
-
#
|
955
|
+
# The length of the password. If you don't include this parameter, the
|
956
|
+
# default length is 32 characters.
|
1131
957
|
#
|
1132
958
|
# @option params [String] :exclude_characters
|
1133
|
-
# A string
|
1134
|
-
# generated password. The default is that all characters from the
|
1135
|
-
# included sets can be used.
|
959
|
+
# A string of the characters that you don't want in the password.
|
1136
960
|
#
|
1137
961
|
# @option params [Boolean] :exclude_numbers
|
1138
|
-
# Specifies
|
1139
|
-
#
|
1140
|
-
# be included.
|
962
|
+
# Specifies whether to exclude numbers from the password. If you don't
|
963
|
+
# include this switch, the password can contain numbers.
|
1141
964
|
#
|
1142
965
|
# @option params [Boolean] :exclude_punctuation
|
1143
|
-
# Specifies
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
# The following are the punctuation characters that *can* be included in
|
1148
|
-
# the generated password if you don't explicitly exclude them with
|
1149
|
-
# `ExcludeCharacters` or `ExcludePunctuation`\:
|
1150
|
-
#
|
1151
|
-
# `` ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` \{ | \} ~
|
1152
|
-
# ``
|
966
|
+
# Specifies whether to exclude the following punctuation characters from
|
967
|
+
# the password: `` ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _
|
968
|
+
# ` \{ | \} ~ ``. If you don't include this switch, the password can
|
969
|
+
# contain punctuation.
|
1153
970
|
#
|
1154
971
|
# @option params [Boolean] :exclude_uppercase
|
1155
|
-
# Specifies
|
1156
|
-
#
|
1157
|
-
#
|
972
|
+
# Specifies whether to exclude uppercase letters from the password. If
|
973
|
+
# you don't include this switch, the password can contain uppercase
|
974
|
+
# letters.
|
1158
975
|
#
|
1159
976
|
# @option params [Boolean] :exclude_lowercase
|
1160
|
-
# Specifies
|
1161
|
-
#
|
1162
|
-
#
|
977
|
+
# Specifies whether to exclude lowercase letters from the password. If
|
978
|
+
# you don't include this switch, the password can contain lowercase
|
979
|
+
# letters.
|
1163
980
|
#
|
1164
981
|
# @option params [Boolean] :include_space
|
1165
|
-
# Specifies
|
1166
|
-
#
|
1167
|
-
# space character is not included.
|
982
|
+
# Specifies whether to include the space character. If you include this
|
983
|
+
# switch, the password can contain space characters.
|
1168
984
|
#
|
1169
985
|
# @option params [Boolean] :require_each_included_type
|
1170
|
-
#
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
# character type.
|
986
|
+
# Specifies whether to include at least one upper and lowercase letter,
|
987
|
+
# one number, and one punctuation. If you don't include this switch,
|
988
|
+
# the password contains at least one of every character type.
|
1174
989
|
#
|
1175
990
|
# @return [Types::GetRandomPasswordResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1176
991
|
#
|
@@ -1220,31 +1035,17 @@ module Aws::SecretsManager
|
|
1220
1035
|
end
|
1221
1036
|
|
1222
1037
|
# Retrieves the JSON text of the resource-based policy document attached
|
1223
|
-
# to the
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
# **Minimum permissions**
|
1228
|
-
#
|
1229
|
-
# To run this command, you must have the following permissions:
|
1038
|
+
# to the secret. For more information about permissions policies
|
1039
|
+
# attached to a secret, see [Permissions policies attached to a
|
1040
|
+
# secret][1].
|
1230
1041
|
#
|
1231
|
-
# * secretsmanager:GetResourcePolicy
|
1232
1042
|
#
|
1233
|
-
# ^
|
1234
1043
|
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
# * To attach a resource policy to a secret, use PutResourcePolicy.
|
1238
|
-
#
|
1239
|
-
# * To delete the resource-based policy attached to a secret, use
|
1240
|
-
# DeleteResourcePolicy.
|
1241
|
-
#
|
1242
|
-
# * To list all of the currently available secrets, use ListSecrets.
|
1044
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html
|
1243
1045
|
#
|
1244
1046
|
# @option params [required, String] :secret_id
|
1245
|
-
#
|
1246
|
-
#
|
1247
|
-
# Name (ARN) or the friendly name of the secret.
|
1047
|
+
# The ARN or name of the secret to retrieve the attached resource-based
|
1048
|
+
# policy for.
|
1248
1049
|
#
|
1249
1050
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1250
1051
|
# partial ARN.
|
@@ -1296,40 +1097,30 @@ module Aws::SecretsManager
|
|
1296
1097
|
# `SecretBinary` from the specified version of a secret, whichever
|
1297
1098
|
# contains content.
|
1298
1099
|
#
|
1299
|
-
#
|
1300
|
-
#
|
1301
|
-
# To run this command, you must have the following permissions:
|
1302
|
-
#
|
1303
|
-
# * secretsmanager:GetSecretValue
|
1100
|
+
# For information about retrieving the secret value in the console, see
|
1101
|
+
# [Retrieve secrets][1].
|
1304
1102
|
#
|
1305
|
-
#
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
#
|
1103
|
+
# To run this command, you must have `secretsmanager:GetSecretValue`
|
1104
|
+
# permissions. If the secret is encrypted using a customer-managed key
|
1105
|
+
# instead of the Amazon Web Services managed key `aws/secretsmanager`,
|
1106
|
+
# then you also need `kms:Decrypt` permissions for that key.
|
1309
1107
|
#
|
1310
|
-
# **Related operations**
|
1311
1108
|
#
|
1312
|
-
# * To create a new version of the secret with different encrypted
|
1313
|
-
# information, use PutSecretValue.
|
1314
1109
|
#
|
1315
|
-
#
|
1316
|
-
# DescribeSecret.
|
1110
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html
|
1317
1111
|
#
|
1318
1112
|
# @option params [required, String] :secret_id
|
1319
|
-
#
|
1320
|
-
# You can specify either the Amazon Resource Name (ARN) or the friendly
|
1321
|
-
# name of the secret.
|
1113
|
+
# The ARN or name of the secret to retrieve.
|
1322
1114
|
#
|
1323
1115
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1324
1116
|
# partial ARN.
|
1325
1117
|
#
|
1326
1118
|
# @option params [String] :version_id
|
1327
|
-
#
|
1328
|
-
#
|
1329
|
-
#
|
1330
|
-
#
|
1331
|
-
#
|
1332
|
-
# `VersionStage` value of `AWSCURRENT`.
|
1119
|
+
# The unique identifier of the version of the secret to retrieve. If you
|
1120
|
+
# include both this parameter and `VersionStage`, the two parameters
|
1121
|
+
# must refer to the same secret version. If you don't specify either a
|
1122
|
+
# `VersionStage` or `VersionId`, then Secrets Manager returns the
|
1123
|
+
# `AWSCURRENT` version.
|
1333
1124
|
#
|
1334
1125
|
# This value is typically a [UUID-type][1] value with 32 hexadecimal
|
1335
1126
|
# digits.
|
@@ -1339,15 +1130,13 @@ module Aws::SecretsManager
|
|
1339
1130
|
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
1340
1131
|
#
|
1341
1132
|
# @option params [String] :version_stage
|
1342
|
-
#
|
1343
|
-
# label attached to the version.
|
1133
|
+
# The staging label of the version of the secret to retrieve.
|
1344
1134
|
#
|
1345
|
-
#
|
1346
|
-
# rotation process. If you
|
1347
|
-
# the two parameters must refer to the same
|
1348
|
-
# don't specify either a `VersionStage` or
|
1349
|
-
#
|
1350
|
-
# `VersionStage` value of `AWSCURRENT`.
|
1135
|
+
# Secrets Manager uses staging labels to keep track of different
|
1136
|
+
# versions during the rotation process. If you include both this
|
1137
|
+
# parameter and `VersionId`, the two parameters must refer to the same
|
1138
|
+
# secret version. If you don't specify either a `VersionStage` or
|
1139
|
+
# `VersionId`, Secrets Manager returns the `AWSCURRENT` version.
|
1351
1140
|
#
|
1352
1141
|
# @return [Types::GetSecretValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1353
1142
|
#
|
@@ -1411,66 +1200,40 @@ module Aws::SecretsManager
|
|
1411
1200
|
req.send_request(options)
|
1412
1201
|
end
|
1413
1202
|
|
1414
|
-
# Lists
|
1415
|
-
# does not include the `SecretString` or `SecretBinary` fields. By
|
1416
|
-
# default, the list includes only versions that have at least one
|
1417
|
-
# staging label in `VersionStage` attached.
|
1418
|
-
#
|
1419
|
-
# <note markdown="1"> Always check the `NextToken` response parameter when calling any of
|
1420
|
-
# the `List*` operations. These operations can occasionally return an
|
1421
|
-
# empty or shorter than expected list of results even when there more
|
1422
|
-
# results become available. When this happens, the `NextToken` response
|
1423
|
-
# parameter contains a value to pass to the next call to the same API to
|
1424
|
-
# request the next part of the list.
|
1203
|
+
# Lists the versions for a secret.
|
1425
1204
|
#
|
1426
|
-
#
|
1205
|
+
# To list the secrets in the account, use ListSecrets.
|
1427
1206
|
#
|
1428
|
-
#
|
1207
|
+
# To get the secret value from `SecretString` or `SecretBinary`, call
|
1208
|
+
# GetSecretValue.
|
1429
1209
|
#
|
1430
|
-
#
|
1431
|
-
#
|
1432
|
-
# * secretsmanager:ListSecretVersionIds
|
1433
|
-
#
|
1434
|
-
# ^
|
1435
|
-
#
|
1436
|
-
# **Related operations**
|
1437
|
-
#
|
1438
|
-
# * To list the secrets in an account, use ListSecrets.
|
1210
|
+
# **Minimum permissions**
|
1439
1211
|
#
|
1440
|
-
#
|
1212
|
+
# To run this command, you must have
|
1213
|
+
# `secretsmanager:ListSecretVersionIds` permissions.
|
1441
1214
|
#
|
1442
1215
|
# @option params [required, String] :secret_id
|
1443
|
-
# The
|
1444
|
-
# list. You can specify either the Amazon Resource Name (ARN) or the
|
1445
|
-
# friendly name of the secret.
|
1216
|
+
# The ARN or name of the secret whose versions you want to list.
|
1446
1217
|
#
|
1447
1218
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1448
1219
|
# partial ARN.
|
1449
1220
|
#
|
1450
1221
|
# @option params [Integer] :max_results
|
1451
|
-
#
|
1452
|
-
#
|
1453
|
-
#
|
1454
|
-
#
|
1455
|
-
#
|
1456
|
-
# request parameter in the next call to the operation to get the next
|
1457
|
-
# part of the results. Note that Secrets Manager might return fewer
|
1458
|
-
# results than the maximum even when there are more results available.
|
1459
|
-
# You should check `NextToken` after every operation to ensure that you
|
1460
|
-
# receive all of the results.
|
1222
|
+
# The number of results to include in the response.
|
1223
|
+
#
|
1224
|
+
# If there are more results available, in the response, Secrets Manager
|
1225
|
+
# includes `NextToken`. To get the next results, call
|
1226
|
+
# `ListSecretVersionIds` again with the value from `NextToken`.
|
1461
1227
|
#
|
1462
1228
|
# @option params [String] :next_token
|
1463
|
-
#
|
1464
|
-
#
|
1465
|
-
#
|
1466
|
-
# previous call `NextToken` response to indicate where the output should
|
1467
|
-
# continue from.
|
1229
|
+
# A token that indicates where the output should continue from, if a
|
1230
|
+
# previous call did not show all results. To get the next results, call
|
1231
|
+
# `ListSecretVersionIds` again with this value.
|
1468
1232
|
#
|
1469
1233
|
# @option params [Boolean] :include_deprecated
|
1470
|
-
#
|
1471
|
-
#
|
1472
|
-
#
|
1473
|
-
# Manager as needed.
|
1234
|
+
# Specifies whether to include versions of secrets that don't have any
|
1235
|
+
# staging labels attached to them. Versions without staging labels are
|
1236
|
+
# considered deprecated and are subject to deletion by Secrets Manager.
|
1474
1237
|
#
|
1475
1238
|
# @return [Types::ListSecretVersionIdsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1476
1239
|
#
|
@@ -1550,56 +1313,40 @@ module Aws::SecretsManager
|
|
1550
1313
|
req.send_request(options)
|
1551
1314
|
end
|
1552
1315
|
|
1553
|
-
# Lists
|
1554
|
-
#
|
1555
|
-
# a specific secret, use ListSecretVersionIds. The encrypted fields
|
1556
|
-
# `SecretString` and `SecretBinary` are not included in the output. To
|
1557
|
-
# get that information, call the GetSecretValue operation.
|
1558
|
-
#
|
1559
|
-
# <note markdown="1"> Always check the `NextToken` response parameter when calling any of
|
1560
|
-
# the `List*` operations. These operations can occasionally return an
|
1561
|
-
# empty or shorter than expected list of results even when there more
|
1562
|
-
# results become available. When this happens, the `NextToken` response
|
1563
|
-
# parameter contains a value to pass to the next call to the same API to
|
1564
|
-
# request the next part of the list.
|
1316
|
+
# Lists the secrets that are stored by Secrets Manager in the Amazon Web
|
1317
|
+
# Services account.
|
1565
1318
|
#
|
1566
|
-
#
|
1319
|
+
# To list the versions of a secret, use ListSecretVersionIds.
|
1567
1320
|
#
|
1568
|
-
#
|
1321
|
+
# To get the secret value from `SecretString` or `SecretBinary`, call
|
1322
|
+
# GetSecretValue.
|
1569
1323
|
#
|
1570
|
-
#
|
1324
|
+
# For information about finding secrets in the console, see [Enhanced
|
1325
|
+
# search capabilities for secrets in Secrets Manager][1].
|
1571
1326
|
#
|
1572
|
-
#
|
1327
|
+
# **Minimum permissions**
|
1573
1328
|
#
|
1574
|
-
#
|
1329
|
+
# To run this command, you must have `secretsmanager:ListSecrets`
|
1330
|
+
# permissions.
|
1575
1331
|
#
|
1576
|
-
# **Related operations**
|
1577
1332
|
#
|
1578
|
-
# * To list the versions attached to a secret, use ListSecretVersionIds.
|
1579
1333
|
#
|
1580
|
-
#
|
1334
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html
|
1581
1335
|
#
|
1582
1336
|
# @option params [Integer] :max_results
|
1583
|
-
#
|
1584
|
-
#
|
1585
|
-
#
|
1586
|
-
#
|
1587
|
-
#
|
1588
|
-
# request parameter in the next call to the operation to get the next
|
1589
|
-
# part of the results. Note that Secrets Manager might return fewer
|
1590
|
-
# results than the maximum even when there are more results available.
|
1591
|
-
# You should check `NextToken` after every operation to ensure that you
|
1592
|
-
# receive all of the results.
|
1337
|
+
# The number of results to include in the response.
|
1338
|
+
#
|
1339
|
+
# If there are more results available, in the response, Secrets Manager
|
1340
|
+
# includes `NextToken`. To get the next results, call `ListSecrets`
|
1341
|
+
# again with the value from `NextToken`.
|
1593
1342
|
#
|
1594
1343
|
# @option params [String] :next_token
|
1595
|
-
#
|
1596
|
-
#
|
1597
|
-
#
|
1598
|
-
# previous call `NextToken` response to indicate where the output should
|
1599
|
-
# continue from.
|
1344
|
+
# A token that indicates where the output should continue from, if a
|
1345
|
+
# previous call did not show all results. To get the next results, call
|
1346
|
+
# `ListSecrets` again with this value.
|
1600
1347
|
#
|
1601
1348
|
# @option params [Array<Types::Filter>] :filters
|
1602
|
-
#
|
1349
|
+
# The filters to apply to the list of secrets.
|
1603
1350
|
#
|
1604
1351
|
# @option params [String] :sort_order
|
1605
1352
|
# Lists secrets in the requested order.
|
@@ -1695,65 +1442,37 @@ module Aws::SecretsManager
|
|
1695
1442
|
req.send_request(options)
|
1696
1443
|
end
|
1697
1444
|
|
1698
|
-
# Attaches
|
1699
|
-
#
|
1700
|
-
#
|
1701
|
-
# the secret's Amazon Resource Name (ARN) in the policy statement's
|
1702
|
-
# `Resources` element. You can also use a combination of both
|
1703
|
-
# identity-based and resource-based policies. The affected users and
|
1704
|
-
# roles receive the permissions that are permitted by all of the
|
1705
|
-
# relevant policies. For more information, see [Using Resource-Based
|
1706
|
-
# Policies for Amazon Web Services Secrets Manager][1]. For the complete
|
1707
|
-
# description of the Amazon Web Services policy syntax and grammar, see
|
1708
|
-
# [IAM JSON Policy Reference][2] in the *IAM User Guide*.
|
1709
|
-
#
|
1710
|
-
# **Minimum permissions**
|
1711
|
-
#
|
1712
|
-
# To run this command, you must have the following permissions:
|
1713
|
-
#
|
1714
|
-
# * secretsmanager:PutResourcePolicy
|
1715
|
-
#
|
1716
|
-
# ^
|
1717
|
-
#
|
1718
|
-
# **Related operations**
|
1445
|
+
# Attaches a resource-based permission policy to a secret. A
|
1446
|
+
# resource-based policy is optional. For more information, see
|
1447
|
+
# [Authentication and access control for Secrets Manager][1]
|
1719
1448
|
#
|
1720
|
-
#
|
1721
|
-
#
|
1449
|
+
# For information about attaching a policy in the console, see [Attach a
|
1450
|
+
# permissions policy to a secret][2].
|
1722
1451
|
#
|
1723
|
-
# * To delete the resource-based policy attached to a secret, use
|
1724
|
-
# DeleteResourcePolicy.
|
1725
1452
|
#
|
1726
|
-
# * To list all of the currently available secrets, use ListSecrets.
|
1727
1453
|
#
|
1728
|
-
#
|
1729
|
-
#
|
1730
|
-
# [1]: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html
|
1731
|
-
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
|
1454
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
1455
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html
|
1732
1456
|
#
|
1733
1457
|
# @option params [required, String] :secret_id
|
1734
|
-
#
|
1735
|
-
# policy. You can specify either the ARN or the friendly name of the
|
1736
|
-
# secret.
|
1458
|
+
# The ARN or name of the secret to attach the resource-based policy.
|
1737
1459
|
#
|
1738
1460
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1739
1461
|
# partial ARN.
|
1740
1462
|
#
|
1741
1463
|
# @option params [required, String] :resource_policy
|
1742
|
-
# A JSON-formatted string
|
1743
|
-
#
|
1744
|
-
# the string identifies who can access or manage this secret and its
|
1745
|
-
# versions. For information on how to format a JSON parameter for the
|
1746
|
-
# various command line tool environments, see [Using JSON for
|
1747
|
-
# Parameters][1] in the *CLI User Guide*.
|
1464
|
+
# A JSON-formatted string for an Amazon Web Services resource-based
|
1465
|
+
# policy. For example policies, see [Permissions policy examples][1].
|
1748
1466
|
#
|
1749
1467
|
#
|
1750
1468
|
#
|
1751
|
-
# [1]:
|
1469
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html
|
1752
1470
|
#
|
1753
1471
|
# @option params [Boolean] :block_public_policy
|
1754
|
-
#
|
1755
|
-
#
|
1756
|
-
#
|
1472
|
+
# Specifies whether to block resource-based policies that allow broad
|
1473
|
+
# access to the secret. By default, Secrets Manager blocks policies that
|
1474
|
+
# allow broad access, for example those that use a wildcard for the
|
1475
|
+
# principal.
|
1757
1476
|
#
|
1758
1477
|
# @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1759
1478
|
#
|
@@ -1798,11 +1517,9 @@ module Aws::SecretsManager
|
|
1798
1517
|
req.send_request(options)
|
1799
1518
|
end
|
1800
1519
|
|
1801
|
-
#
|
1802
|
-
#
|
1803
|
-
#
|
1804
|
-
# `SecretBinary` value. You can also specify the staging labels that are
|
1805
|
-
# initially attached to the new version.
|
1520
|
+
# Creates a new version with a new encrypted secret value and attaches
|
1521
|
+
# it to the secret. The version can contain a new `SecretString` value
|
1522
|
+
# or a new `SecretBinary` value.
|
1806
1523
|
#
|
1807
1524
|
# We recommend you avoid calling `PutSecretValue` at a sustained rate of
|
1808
1525
|
# more than once every 10 minutes. When you update the secret value,
|
@@ -1813,116 +1530,64 @@ module Aws::SecretsManager
|
|
1813
1530
|
# versions than Secrets Manager removes, and you will reach the quota
|
1814
1531
|
# for secret versions.
|
1815
1532
|
#
|
1816
|
-
#
|
1817
|
-
#
|
1818
|
-
#
|
1819
|
-
#
|
1820
|
-
#
|
1821
|
-
#
|
1822
|
-
#
|
1823
|
-
#
|
1824
|
-
#
|
1825
|
-
#
|
1826
|
-
#
|
1827
|
-
#
|
1828
|
-
#
|
1829
|
-
#
|
1830
|
-
#
|
1831
|
-
#
|
1832
|
-
#
|
1833
|
-
#
|
1834
|
-
# can only create new ones.
|
1835
|
-
#
|
1836
|
-
# <note markdown="1"> * If you call an operation to encrypt or decrypt the `SecretString` or
|
1837
|
-
# `SecretBinary` for a secret in the same account as the calling user
|
1838
|
-
# and that secret doesn't specify a Amazon Web Services KMS
|
1839
|
-
# encryption key, Secrets Manager uses the account's default Amazon
|
1840
|
-
# Web Services managed customer master key (CMK) with the alias
|
1841
|
-
# `aws/secretsmanager`. If this key doesn't already exist in your
|
1842
|
-
# account then Secrets Manager creates it for you automatically. All
|
1843
|
-
# users and roles in the same Amazon Web Services account
|
1844
|
-
# automatically have access to use the default CMK. Note that if an
|
1845
|
-
# Secrets Manager API call results in Amazon Web Services creating the
|
1846
|
-
# account's Amazon Web Services-managed CMK, it can result in a
|
1847
|
-
# one-time significant delay in returning the result.
|
1848
|
-
#
|
1849
|
-
# * If the secret resides in a different Amazon Web Services account
|
1850
|
-
# from the credentials calling an API that requires encryption or
|
1851
|
-
# decryption of the secret value then you must create and use a custom
|
1852
|
-
# Amazon Web Services KMS CMK because you can't access the default
|
1853
|
-
# CMK for the account using credentials from a different Amazon Web
|
1854
|
-
# Services account. Store the ARN of the CMK in the secret when you
|
1855
|
-
# create the secret or when you update it by including it in the
|
1856
|
-
# `KMSKeyId`. If you call an API that must encrypt or decrypt
|
1857
|
-
# `SecretString` or `SecretBinary` using credentials from a different
|
1858
|
-
# account then the Amazon Web Services KMS key policy must grant
|
1859
|
-
# cross-account access to that other account's user or role for both
|
1860
|
-
# the kms:GenerateDataKey and kms:Decrypt operations.
|
1861
|
-
#
|
1862
|
-
# </note>
|
1863
|
-
#
|
1864
|
-
# **Minimum permissions**
|
1865
|
-
#
|
1866
|
-
# To run this command, you must have the following permissions:
|
1867
|
-
#
|
1868
|
-
# * secretsmanager:PutSecretValue
|
1869
|
-
#
|
1870
|
-
# * kms:GenerateDataKey - needed only if you use a customer-managed
|
1871
|
-
# Amazon Web Services KMS key to encrypt the secret. You do not need
|
1872
|
-
# this permission to use the account's default Amazon Web Services
|
1873
|
-
# managed CMK for Secrets Manager.
|
1874
|
-
#
|
1875
|
-
# **Related operations**
|
1876
|
-
#
|
1877
|
-
# * To retrieve the encrypted value you store in the version of a
|
1878
|
-
# secret, use GetSecretValue.
|
1879
|
-
#
|
1880
|
-
# * To create a secret, use CreateSecret.
|
1881
|
-
#
|
1882
|
-
# * To get the details for a secret, use DescribeSecret.
|
1883
|
-
#
|
1884
|
-
# * To list the versions attached to a secret, use ListSecretVersionIds.
|
1533
|
+
# You can specify the staging labels to attach to the new version in
|
1534
|
+
# `VersionStages`. If you don't include `VersionStages`, then Secrets
|
1535
|
+
# Manager automatically moves the staging label `AWSCURRENT` to this
|
1536
|
+
# version. If this operation creates the first version for the secret,
|
1537
|
+
# then Secrets Manager automatically attaches the staging label
|
1538
|
+
# `AWSCURRENT` to it .
|
1539
|
+
#
|
1540
|
+
# If this operation moves the staging label `AWSCURRENT` from another
|
1541
|
+
# version to this version, then Secrets Manager also automatically moves
|
1542
|
+
# the staging label `AWSPREVIOUS` to the version that `AWSCURRENT` was
|
1543
|
+
# removed from.
|
1544
|
+
#
|
1545
|
+
# This operation is idempotent. If a version with a `VersionId` with the
|
1546
|
+
# same value as the `ClientRequestToken` parameter already exists, and
|
1547
|
+
# you specify the same secret data, the operation succeeds but does
|
1548
|
+
# nothing. However, if the secret data is different, then the operation
|
1549
|
+
# fails because you can't modify an existing version; you can only
|
1550
|
+
# create new ones.
|
1885
1551
|
#
|
1886
1552
|
# @option params [required, String] :secret_id
|
1887
|
-
#
|
1888
|
-
# specify either the Amazon Resource Name (ARN) or the friendly name of
|
1889
|
-
# the secret. The secret must already exist.
|
1553
|
+
# The ARN or name of the secret to add a new version to.
|
1890
1554
|
#
|
1891
1555
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1892
1556
|
# partial ARN.
|
1893
1557
|
#
|
1558
|
+
# If the secret doesn't already exist, use `CreateSecret` instead.
|
1559
|
+
#
|
1894
1560
|
# @option params [String] :client_request_token
|
1895
|
-
#
|
1896
|
-
# secret.
|
1561
|
+
# A unique identifier for the new version of the secret.
|
1897
1562
|
#
|
1898
1563
|
# <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
|
1899
|
-
# Services
|
1900
|
-
# empty
|
1901
|
-
#
|
1902
|
-
#
|
1903
|
-
#
|
1904
|
-
#
|
1564
|
+
# Services SDKs to call this operation, then you can leave this
|
1565
|
+
# parameter empty because they generate a random UUID for you. If you
|
1566
|
+
# don't use the SDK and instead generate a raw HTTP request to the
|
1567
|
+
# Secrets Manager service endpoint, then you must generate a
|
1568
|
+
# `ClientRequestToken` yourself for new versions and include that value
|
1569
|
+
# in the request.
|
1905
1570
|
#
|
1906
1571
|
# </note>
|
1907
1572
|
#
|
1908
1573
|
# This value helps ensure idempotency. Secrets Manager uses this value
|
1909
1574
|
# to prevent the accidental creation of duplicate versions if there are
|
1910
|
-
# failures and retries during the Lambda rotation function
|
1911
|
-
#
|
1912
|
-
#
|
1575
|
+
# failures and retries during the Lambda rotation function processing.
|
1576
|
+
# We recommend that you generate a [UUID-type][1] value to ensure
|
1577
|
+
# uniqueness within the specified secret.
|
1913
1578
|
#
|
1914
1579
|
# * If the `ClientRequestToken` value isn't already associated with a
|
1915
1580
|
# version of the secret then a new version of the secret is created.
|
1916
1581
|
#
|
1917
1582
|
# * If a version with this value already exists and that version's
|
1918
1583
|
# `SecretString` or `SecretBinary` values are the same as those in the
|
1919
|
-
# request then the request is ignored
|
1584
|
+
# request then the request is ignored. The operation is idempotent.
|
1920
1585
|
#
|
1921
1586
|
# * If a version with this value already exists and the version of the
|
1922
1587
|
# `SecretString` and `SecretBinary` values are different from those in
|
1923
|
-
# the request then the request fails because you
|
1924
|
-
#
|
1925
|
-
#
|
1588
|
+
# the request, then the request fails because you can't modify a
|
1589
|
+
# secret version. You can only create new versions to store new secret
|
1590
|
+
# values.
|
1926
1591
|
#
|
1927
1592
|
# This value becomes the `VersionId` of the new version.
|
1928
1593
|
#
|
@@ -1934,52 +1599,37 @@ module Aws::SecretsManager
|
|
1934
1599
|
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
1935
1600
|
#
|
1936
1601
|
# @option params [String, StringIO, File] :secret_binary
|
1937
|
-
#
|
1938
|
-
#
|
1939
|
-
#
|
1940
|
-
# file
|
1941
|
-
# contents of the file as a parameter. Either `SecretBinary` or
|
1942
|
-
# `SecretString` must have a value, but not both. They cannot both be
|
1943
|
-
# empty.
|
1602
|
+
# The binary data to encrypt and store in the new version of the secret.
|
1603
|
+
# To use this parameter in the command-line tools, we recommend that you
|
1604
|
+
# store your binary data in a file and then pass the contents of the
|
1605
|
+
# file as a parameter.
|
1944
1606
|
#
|
1945
|
-
#
|
1946
|
-
# Manager console.
|
1607
|
+
# You must include `SecretBinary` or `SecretString`, but not both.
|
1947
1608
|
#
|
1948
|
-
#
|
1949
|
-
# (Optional) Specifies text data that you want to encrypt and store in
|
1950
|
-
# this new version of the secret. Either `SecretString` or
|
1951
|
-
# `SecretBinary` must have a value, but not both. They cannot both be
|
1952
|
-
# empty.
|
1953
|
-
#
|
1954
|
-
# If you create this secret by using the Secrets Manager console then
|
1955
|
-
# Secrets Manager puts the protected secret text in only the
|
1956
|
-
# `SecretString` parameter. The Secrets Manager console stores the
|
1957
|
-
# information as a JSON structure of key/value pairs that the default
|
1958
|
-
# Lambda rotation function knows how to parse.
|
1959
|
-
#
|
1960
|
-
# For storing multiple values, we recommend that you use a JSON text
|
1961
|
-
# string argument and specify key/value pairs. For more information, see
|
1962
|
-
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
1963
|
-
# the Amazon Web Services CLI User Guide.
|
1609
|
+
# You can't access this value from the Secrets Manager console.
|
1964
1610
|
#
|
1611
|
+
# @option params [String] :secret_string
|
1612
|
+
# The text to encrypt and store in the new version of the secret.
|
1965
1613
|
#
|
1614
|
+
# You must include `SecretBinary` or `SecretString`, but not both.
|
1966
1615
|
#
|
1967
|
-
#
|
1616
|
+
# We recommend you create the secret string as JSON key/value pairs, as
|
1617
|
+
# shown in the example.
|
1968
1618
|
#
|
1969
1619
|
# @option params [Array<String>] :version_stages
|
1970
|
-
#
|
1971
|
-
#
|
1972
|
-
#
|
1973
|
-
#
|
1974
|
-
# A staging label must be unique to a single version of the secret. If
|
1975
|
-
# you specify a staging label that's already associated with a
|
1976
|
-
# different version of the same secret then that staging label is
|
1977
|
-
# automatically removed from the other version and attached to this
|
1978
|
-
# version.
|
1620
|
+
# A list of staging labels to attach to this version of the secret.
|
1621
|
+
# Secrets Manager uses staging labels to track versions of a secret
|
1622
|
+
# through the rotation process.
|
1979
1623
|
#
|
1980
|
-
# If you
|
1981
|
-
#
|
1982
|
-
# version.
|
1624
|
+
# If you specify a staging label that's already associated with a
|
1625
|
+
# different version of the same secret, then Secrets Manager removes the
|
1626
|
+
# label from the other version and attaches it to this version. If you
|
1627
|
+
# specify `AWSCURRENT`, and it is already attached to another version,
|
1628
|
+
# then Secrets Manager also moves the staging label `AWSPREVIOUS` to the
|
1629
|
+
# version that `AWSCURRENT` was removed from.
|
1630
|
+
#
|
1631
|
+
# If you don't include `VersionStages`, then Secrets Manager
|
1632
|
+
# automatically moves the staging label `AWSCURRENT` to this version.
|
1983
1633
|
#
|
1984
1634
|
# @return [Types::PutSecretValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1985
1635
|
#
|
@@ -2037,13 +1687,14 @@ module Aws::SecretsManager
|
|
2037
1687
|
req.send_request(options)
|
2038
1688
|
end
|
2039
1689
|
|
2040
|
-
#
|
1690
|
+
# For a secret that is replicated to other Regions, deletes the secret
|
1691
|
+
# replicas from the Regions you specify.
|
2041
1692
|
#
|
2042
1693
|
# @option params [required, String] :secret_id
|
2043
|
-
#
|
1694
|
+
# The ARN or name of the secret.
|
2044
1695
|
#
|
2045
1696
|
# @option params [required, Array<String>] :remove_replica_regions
|
2046
|
-
#
|
1697
|
+
# The Regions of the replicas to remove.
|
2047
1698
|
#
|
2048
1699
|
# @return [Types::RemoveRegionsFromReplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2049
1700
|
#
|
@@ -2076,18 +1727,21 @@ module Aws::SecretsManager
|
|
2076
1727
|
req.send_request(options)
|
2077
1728
|
end
|
2078
1729
|
|
2079
|
-
#
|
2080
|
-
#
|
1730
|
+
# Replicates the secret to a new Regions. See [Multi-Region secrets][1].
|
1731
|
+
#
|
1732
|
+
#
|
1733
|
+
#
|
1734
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html
|
2081
1735
|
#
|
2082
1736
|
# @option params [required, String] :secret_id
|
2083
|
-
#
|
1737
|
+
# The ARN or name of the secret to replicate.
|
2084
1738
|
#
|
2085
1739
|
# @option params [required, Array<Types::ReplicaRegionType>] :add_replica_regions
|
2086
|
-
#
|
1740
|
+
# A list of Regions in which to replicate the secret.
|
2087
1741
|
#
|
2088
1742
|
# @option params [Boolean] :force_overwrite_replica_secret
|
2089
|
-
#
|
2090
|
-
#
|
1743
|
+
# Specifies whether to overwrite a secret with the same name in the
|
1744
|
+
# destination Region.
|
2091
1745
|
#
|
2092
1746
|
# @return [Types::ReplicateSecretToRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2093
1747
|
#
|
@@ -2127,27 +1781,11 @@ module Aws::SecretsManager
|
|
2127
1781
|
end
|
2128
1782
|
|
2129
1783
|
# Cancels the scheduled deletion of a secret by removing the
|
2130
|
-
# `DeletedDate` time stamp.
|
2131
|
-
#
|
2132
|
-
#
|
2133
|
-
# **Minimum permissions**
|
2134
|
-
#
|
2135
|
-
# To run this command, you must have the following permissions:
|
2136
|
-
#
|
2137
|
-
# * secretsmanager:RestoreSecret
|
2138
|
-
#
|
2139
|
-
# ^
|
2140
|
-
#
|
2141
|
-
# **Related operations**
|
2142
|
-
#
|
2143
|
-
# * To delete a secret, use DeleteSecret.
|
2144
|
-
#
|
2145
|
-
# ^
|
1784
|
+
# `DeletedDate` time stamp. You can access a secret again after it has
|
1785
|
+
# been restored.
|
2146
1786
|
#
|
2147
1787
|
# @option params [required, String] :secret_id
|
2148
|
-
#
|
2149
|
-
# scheduled deletion. You can specify either the Amazon Resource Name
|
2150
|
-
# (ARN) or the friendly name of the secret.
|
1788
|
+
# The ARN or name of the secret to restore.
|
2151
1789
|
#
|
2152
1790
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2153
1791
|
# partial ARN.
|
@@ -2192,82 +1830,52 @@ module Aws::SecretsManager
|
|
2192
1830
|
req.send_request(options)
|
2193
1831
|
end
|
2194
1832
|
|
2195
|
-
# Configures and starts the asynchronous process of rotating
|
2196
|
-
#
|
2197
|
-
#
|
2198
|
-
#
|
2199
|
-
#
|
2200
|
-
#
|
2201
|
-
#
|
2202
|
-
#
|
2203
|
-
#
|
2204
|
-
#
|
2205
|
-
#
|
2206
|
-
#
|
2207
|
-
#
|
2208
|
-
#
|
2209
|
-
#
|
2210
|
-
#
|
2211
|
-
#
|
2212
|
-
#
|
2213
|
-
#
|
2214
|
-
#
|
2215
|
-
# Secrets Manager schedules the next rotation when the previous one
|
2216
|
-
# completes. Secrets Manager schedules the date by adding the rotation
|
2217
|
-
# interval (number of days) to the actual date of the last rotation. The
|
2218
|
-
# service chooses the hour within that 24-hour date window randomly. The
|
2219
|
-
# minute is also chosen somewhat randomly, but weighted towards the top
|
2220
|
-
# of the hour and influenced by a variety of factors that help
|
2221
|
-
# distribute load.
|
2222
|
-
#
|
2223
|
-
# The rotation function must end with the versions of the secret in one
|
2224
|
-
# of two states:
|
2225
|
-
#
|
2226
|
-
# * The `AWSPENDING` and `AWSCURRENT` staging labels are attached to the
|
2227
|
-
# same version of the secret, or
|
2228
|
-
#
|
2229
|
-
# * The `AWSPENDING` staging label is not attached to any version of the
|
2230
|
-
# secret.
|
1833
|
+
# Configures and starts the asynchronous process of rotating the secret.
|
1834
|
+
#
|
1835
|
+
# If you include the configuration parameters, the operation sets the
|
1836
|
+
# values for the secret and then immediately starts a rotation. If you
|
1837
|
+
# don't include the configuration parameters, the operation starts a
|
1838
|
+
# rotation with the values already stored in the secret. For more
|
1839
|
+
# information about rotation, see [Rotate secrets][1].
|
1840
|
+
#
|
1841
|
+
# To configure rotation, you include the ARN of an Amazon Web Services
|
1842
|
+
# Lambda function and the schedule for the rotation. The Lambda rotation
|
1843
|
+
# function creates a new version of the secret and creates or updates
|
1844
|
+
# the credentials on the database or service to match. After testing the
|
1845
|
+
# new credentials, the function marks the new secret version with the
|
1846
|
+
# staging label `AWSCURRENT`. Then anyone who retrieves the secret gets
|
1847
|
+
# the new version. For more information, see [How rotation works][2].
|
1848
|
+
#
|
1849
|
+
# When rotation is successful, the `AWSPENDING` staging label might be
|
1850
|
+
# attached to the same version as the `AWSCURRENT` version, or it might
|
1851
|
+
# not be attached to any version.
|
2231
1852
|
#
|
2232
1853
|
# If the `AWSPENDING` staging label is present but not attached to the
|
2233
|
-
# same version as `AWSCURRENT
|
1854
|
+
# same version as `AWSCURRENT`, then any later invocation of
|
2234
1855
|
# `RotateSecret` assumes that a previous rotation request is still in
|
2235
1856
|
# progress and returns an error.
|
2236
1857
|
#
|
2237
|
-
#
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
#
|
2241
|
-
# * secretsmanager:RotateSecret
|
2242
|
-
#
|
2243
|
-
# * lambda:InvokeFunction (on the function specified in the secret's
|
2244
|
-
# metadata)
|
2245
|
-
#
|
2246
|
-
# **Related operations**
|
2247
|
-
#
|
2248
|
-
# * To list the secrets in your account, use ListSecrets.
|
2249
|
-
#
|
2250
|
-
# * To get the details for a version of a secret, use DescribeSecret.
|
2251
|
-
#
|
2252
|
-
# * To create a new version of a secret, use CreateSecret.
|
2253
|
-
#
|
2254
|
-
# * To attach staging labels to or remove staging labels from a version
|
2255
|
-
# of a secret, use UpdateSecretVersionStage.
|
1858
|
+
# To run this command, you must have `secretsmanager:RotateSecret`
|
1859
|
+
# permissions and `lambda:InvokeFunction` permissions on the function
|
1860
|
+
# specified in the secret's metadata.
|
2256
1861
|
#
|
2257
1862
|
#
|
2258
1863
|
#
|
2259
1864
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html
|
1865
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
|
2260
1866
|
#
|
2261
1867
|
# @option params [required, String] :secret_id
|
2262
|
-
#
|
2263
|
-
# the Amazon Resource Name (ARN) or the friendly name of the secret.
|
1868
|
+
# The ARN or name of the secret to rotate.
|
2264
1869
|
#
|
2265
1870
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2266
1871
|
# partial ARN.
|
2267
1872
|
#
|
2268
1873
|
# @option params [String] :client_request_token
|
2269
|
-
#
|
2270
|
-
#
|
1874
|
+
# A unique identifier for the new version of the secret that helps
|
1875
|
+
# ensure idempotency. Secrets Manager uses this value to prevent the
|
1876
|
+
# accidental creation of duplicate versions if there are failures and
|
1877
|
+
# retries during rotation. This value becomes the `VersionId` of the new
|
1878
|
+
# version.
|
2271
1879
|
#
|
2272
1880
|
# If you use the Amazon Web Services CLI or one of the Amazon Web
|
2273
1881
|
# Services SDK to call this operation, then you can leave this parameter
|
@@ -2277,15 +1885,10 @@ module Aws::SecretsManager
|
|
2277
1885
|
# endpoint, then you must generate a `ClientRequestToken` yourself for
|
2278
1886
|
# new versions and include that value in the request.
|
2279
1887
|
#
|
2280
|
-
# You only need to specify
|
2281
|
-
#
|
2282
|
-
# twice. We recommend that you generate a
|
2283
|
-
# uniqueness within the specified secret.
|
2284
|
-
#
|
2285
|
-
# Secrets Manager uses this value to prevent the accidental creation of
|
2286
|
-
# duplicate versions if there are failures and retries during the
|
2287
|
-
# function's processing. This value becomes the `VersionId` of the new
|
2288
|
-
# version.
|
1888
|
+
# You only need to specify this value if you implement your own retry
|
1889
|
+
# logic and you want to ensure that Secrets Manager doesn't attempt to
|
1890
|
+
# create a secret version twice. We recommend that you generate a
|
1891
|
+
# [UUID-type][1] value to ensure uniqueness within the specified secret.
|
2289
1892
|
#
|
2290
1893
|
# **A suitable default value is auto-generated.** You should normally
|
2291
1894
|
# not need to pass this option.**
|
@@ -2295,8 +1898,7 @@ module Aws::SecretsManager
|
|
2295
1898
|
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
2296
1899
|
#
|
2297
1900
|
# @option params [String] :rotation_lambda_arn
|
2298
|
-
#
|
2299
|
-
# the secret.
|
1901
|
+
# The ARN of the Lambda rotation function that can rotate the secret.
|
2300
1902
|
#
|
2301
1903
|
# @option params [Types::RotationRulesType] :rotation_rules
|
2302
1904
|
# A structure that defines the rotation configuration for this secret.
|
@@ -2333,12 +1935,14 @@ module Aws::SecretsManager
|
|
2333
1935
|
req.send_request(options)
|
2334
1936
|
end
|
2335
1937
|
|
2336
|
-
# Removes the
|
2337
|
-
#
|
1938
|
+
# Removes the link between the replica secret and the primary secret and
|
1939
|
+
# promotes the replica to a primary secret in the replica Region.
|
1940
|
+
#
|
1941
|
+
# You must call this operation from the Region in which you want to
|
1942
|
+
# promote the replica to a primary secret.
|
2338
1943
|
#
|
2339
1944
|
# @option params [required, String] :secret_id
|
2340
|
-
#
|
2341
|
-
# `SecretId`.
|
1945
|
+
# The ARN of the primary secret.
|
2342
1946
|
#
|
2343
1947
|
# @return [Types::StopReplicationToReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2344
1948
|
#
|
@@ -2363,19 +1967,18 @@ module Aws::SecretsManager
|
|
2363
1967
|
req.send_request(options)
|
2364
1968
|
end
|
2365
1969
|
|
2366
|
-
# Attaches
|
2367
|
-
#
|
2368
|
-
#
|
2369
|
-
#
|
2370
|
-
# To remove tags, you must use UntagResource.
|
1970
|
+
# Attaches tags to a secret. Tags consist of a key name and a value.
|
1971
|
+
# Tags are part of the secret's metadata. They are not associated with
|
1972
|
+
# specific versions of the secret. This operation appends tags to the
|
1973
|
+
# existing list of tags.
|
2371
1974
|
#
|
2372
|
-
# The following
|
1975
|
+
# The following restrictions apply to tags:
|
2373
1976
|
#
|
2374
|
-
# * Maximum number of tags per secret
|
1977
|
+
# * Maximum number of tags per secret: 50
|
2375
1978
|
#
|
2376
|
-
# * Maximum key length
|
1979
|
+
# * Maximum key length: 127 Unicode characters in UTF-8
|
2377
1980
|
#
|
2378
|
-
# * Maximum value length
|
1981
|
+
# * Maximum value length: 255 Unicode characters in UTF-8
|
2379
1982
|
#
|
2380
1983
|
# * Tag keys and values are case sensitive.
|
2381
1984
|
#
|
@@ -2385,9 +1988,9 @@ module Aws::SecretsManager
|
|
2385
1988
|
# with this prefix do not count against your tags per secret limit.
|
2386
1989
|
#
|
2387
1990
|
# * If you use your tagging schema across multiple services and
|
2388
|
-
# resources,
|
2389
|
-
#
|
2390
|
-
#
|
1991
|
+
# resources, other services might have restrictions on allowed
|
1992
|
+
# characters. Generally allowed characters: letters, spaces, and
|
1993
|
+
# numbers representable in UTF-8, plus the following special
|
2391
1994
|
# characters: + - = . \_ : / @.
|
2392
1995
|
#
|
2393
1996
|
# If you use tags as part of your security strategy, then adding or
|
@@ -2395,34 +1998,17 @@ module Aws::SecretsManager
|
|
2395
1998
|
# operation would result in you losing your permissions for this secret,
|
2396
1999
|
# then the operation is blocked and returns an Access Denied error.
|
2397
2000
|
#
|
2398
|
-
# **Minimum permissions**
|
2399
|
-
#
|
2400
|
-
# To run this command, you must have the following permissions:
|
2401
|
-
#
|
2402
|
-
# * secretsmanager:TagResource
|
2403
|
-
#
|
2404
|
-
# ^
|
2405
|
-
#
|
2406
|
-
# **Related operations**
|
2407
|
-
#
|
2408
|
-
# * To remove one or more tags from the collection attached to a secret,
|
2409
|
-
# use UntagResource.
|
2410
|
-
#
|
2411
|
-
# * To view the list of tags attached to a secret, use DescribeSecret.
|
2412
|
-
#
|
2413
2001
|
# @option params [required, String] :secret_id
|
2414
|
-
# The identifier for the secret
|
2415
|
-
#
|
2416
|
-
#
|
2002
|
+
# The identifier for the secret to attach tags to. You can specify
|
2003
|
+
# either the Amazon Resource Name (ARN) or the friendly name of the
|
2004
|
+
# secret.
|
2417
2005
|
#
|
2418
2006
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2419
2007
|
# partial ARN.
|
2420
2008
|
#
|
2421
2009
|
# @option params [required, Array<Types::Tag>] :tags
|
2422
|
-
# The tags to attach to the secret
|
2423
|
-
# a `Key` and a `Value`.
|
2424
|
-
#
|
2425
|
-
# This parameter to the API requires a JSON text string argument.
|
2010
|
+
# The tags to attach to the secret as a JSON text string argument. Each
|
2011
|
+
# element in the list consists of a `Key` and a `Value`.
|
2426
2012
|
#
|
2427
2013
|
# For storing multiple values, we recommend that you use a JSON text
|
2428
2014
|
# string argument and specify key/value pairs. For more information, see
|
@@ -2476,7 +2062,7 @@ module Aws::SecretsManager
|
|
2476
2062
|
req.send_request(options)
|
2477
2063
|
end
|
2478
2064
|
|
2479
|
-
# Removes
|
2065
|
+
# Removes specific tags from a secret.
|
2480
2066
|
#
|
2481
2067
|
# This operation is idempotent. If a requested tag is not attached to
|
2482
2068
|
# the secret, no error is returned and the secret metadata is unchanged.
|
@@ -2486,25 +2072,8 @@ module Aws::SecretsManager
|
|
2486
2072
|
# would result in you losing your permissions for this secret, then the
|
2487
2073
|
# operation is blocked and returns an Access Denied error.
|
2488
2074
|
#
|
2489
|
-
# **Minimum permissions**
|
2490
|
-
#
|
2491
|
-
# To run this command, you must have the following permissions:
|
2492
|
-
#
|
2493
|
-
# * secretsmanager:UntagResource
|
2494
|
-
#
|
2495
|
-
# ^
|
2496
|
-
#
|
2497
|
-
# **Related operations**
|
2498
|
-
#
|
2499
|
-
# * To add one or more tags to the collection attached to a secret, use
|
2500
|
-
# TagResource.
|
2501
|
-
#
|
2502
|
-
# * To view the list of tags attached to a secret, use DescribeSecret.
|
2503
|
-
#
|
2504
2075
|
# @option params [required, String] :secret_id
|
2505
|
-
# The
|
2506
|
-
# can specify either the Amazon Resource Name (ARN) or the friendly name
|
2507
|
-
# of the secret.
|
2076
|
+
# The ARN or name of the secret.
|
2508
2077
|
#
|
2509
2078
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2510
2079
|
# partial ARN.
|
@@ -2513,7 +2082,7 @@ module Aws::SecretsManager
|
|
2513
2082
|
# A list of tag key names to remove from the secret. You don't specify
|
2514
2083
|
# the value. Both the key and its associated value are removed.
|
2515
2084
|
#
|
2516
|
-
# This parameter
|
2085
|
+
# This parameter requires a JSON text string argument.
|
2517
2086
|
#
|
2518
2087
|
# For storing multiple values, we recommend that you use a JSON text
|
2519
2088
|
# string argument and specify key/value pairs. For more information, see
|
@@ -2556,9 +2125,8 @@ module Aws::SecretsManager
|
|
2556
2125
|
req.send_request(options)
|
2557
2126
|
end
|
2558
2127
|
|
2559
|
-
# Modifies
|
2560
|
-
#
|
2561
|
-
# To change the secret value, you can also use PutSecretValue.
|
2128
|
+
# Modifies the details of a secret, including metadata and the secret
|
2129
|
+
# value. To change the secret value, you can also use PutSecretValue.
|
2562
2130
|
#
|
2563
2131
|
# To change the rotation configuration of a secret, use RotateSecret
|
2564
2132
|
# instead.
|
@@ -2572,185 +2140,99 @@ module Aws::SecretsManager
|
|
2572
2140
|
# you create more versions than Secrets Manager removes, and you will
|
2573
2141
|
# reach the quota for secret versions.
|
2574
2142
|
#
|
2575
|
-
#
|
2576
|
-
#
|
2577
|
-
#
|
2578
|
-
#
|
2579
|
-
#
|
2580
|
-
#
|
2581
|
-
#
|
2582
|
-
#
|
2583
|
-
#
|
2584
|
-
#
|
2585
|
-
#
|
2586
|
-
#
|
2587
|
-
#
|
2588
|
-
#
|
2589
|
-
#
|
2590
|
-
#
|
2591
|
-
#
|
2592
|
-
#
|
2593
|
-
#
|
2594
|
-
#
|
2595
|
-
#
|
2596
|
-
#
|
2597
|
-
#
|
2598
|
-
#
|
2599
|
-
#
|
2600
|
-
#
|
2601
|
-
# Secrets Manager API call results in Amazon Web Services creating the
|
2602
|
-
# account's Amazon Web Services-managed CMK, it can result in a
|
2603
|
-
# one-time significant delay in returning the result.
|
2604
|
-
#
|
2605
|
-
# * If the secret resides in a different Amazon Web Services account
|
2606
|
-
# from the credentials calling an API that requires encryption or
|
2607
|
-
# decryption of the secret value then you must create and use a custom
|
2608
|
-
# Amazon Web Services KMS CMK because you can't access the default
|
2609
|
-
# CMK for the account using credentials from a different Amazon Web
|
2610
|
-
# Services account. Store the ARN of the CMK in the secret when you
|
2611
|
-
# create the secret or when you update it by including it in the
|
2612
|
-
# `KMSKeyId`. If you call an API that must encrypt or decrypt
|
2613
|
-
# `SecretString` or `SecretBinary` using credentials from a different
|
2614
|
-
# account then the Amazon Web Services KMS key policy must grant
|
2615
|
-
# cross-account access to that other account's user or role for both
|
2616
|
-
# the kms:GenerateDataKey and kms:Decrypt operations.
|
2617
|
-
#
|
2618
|
-
# </note>
|
2619
|
-
#
|
2620
|
-
# **Minimum permissions**
|
2621
|
-
#
|
2622
|
-
# To run this command, you must have the following permissions:
|
2623
|
-
#
|
2624
|
-
# * secretsmanager:UpdateSecret
|
2625
|
-
#
|
2626
|
-
# * kms:GenerateDataKey - needed only if you use a custom Amazon Web
|
2627
|
-
# Services KMS key to encrypt the secret. You do not need this
|
2628
|
-
# permission to use the account's Amazon Web Services managed CMK for
|
2629
|
-
# Secrets Manager.
|
2630
|
-
#
|
2631
|
-
# * kms:Decrypt - needed only if you use a custom Amazon Web Services
|
2632
|
-
# KMS key to encrypt the secret. You do not need this permission to
|
2633
|
-
# use the account's Amazon Web Services managed CMK for Secrets
|
2634
|
-
# Manager.
|
2635
|
-
#
|
2636
|
-
# **Related operations**
|
2637
|
-
#
|
2638
|
-
# * To create a new secret, use CreateSecret.
|
2639
|
-
#
|
2640
|
-
# * To add only a new version to an existing secret, use PutSecretValue.
|
2641
|
-
#
|
2642
|
-
# * To get the details for a secret, use DescribeSecret.
|
2643
|
-
#
|
2644
|
-
# * To list the versions contained in a secret, use
|
2645
|
-
# ListSecretVersionIds.
|
2143
|
+
# If you include `SecretString` or `SecretBinary` to create a new secret
|
2144
|
+
# version, Secrets Manager automatically attaches the staging label
|
2145
|
+
# `AWSCURRENT` to the new version.
|
2146
|
+
#
|
2147
|
+
# If you call this operation with a `VersionId` that matches an existing
|
2148
|
+
# version's `ClientRequestToken`, the operation results in an error.
|
2149
|
+
# You can't modify an existing version, you can only create a new
|
2150
|
+
# version. To remove a version, remove all staging labels from it. See
|
2151
|
+
# UpdateSecretVersionStage.
|
2152
|
+
#
|
2153
|
+
# If you don't specify an KMS encryption key, Secrets Manager uses the
|
2154
|
+
# Amazon Web Services managed key `aws/secretsmanager`. If this key
|
2155
|
+
# doesn't already exist in your account, then Secrets Manager creates
|
2156
|
+
# it for you automatically. All users and roles in the Amazon Web
|
2157
|
+
# Services account automatically have access to use
|
2158
|
+
# `aws/secretsmanager`. Creating `aws/secretsmanager` can result in a
|
2159
|
+
# one-time significant delay in returning the result.
|
2160
|
+
#
|
2161
|
+
# If the secret is in a different Amazon Web Services account from the
|
2162
|
+
# credentials calling the API, then you can't use `aws/secretsmanager`
|
2163
|
+
# to encrypt the secret, and you must create and use a customer managed
|
2164
|
+
# key.
|
2165
|
+
#
|
2166
|
+
# To run this command, you must have `secretsmanager:UpdateSecret`
|
2167
|
+
# permissions. If you use a customer managed key, you must also have
|
2168
|
+
# `kms:GenerateDataKey` and `kms:Decrypt` permissions .
|
2646
2169
|
#
|
2647
2170
|
# @option params [required, String] :secret_id
|
2648
|
-
#
|
2649
|
-
# add a new version. You can specify either the Amazon Resource Name
|
2650
|
-
# (ARN) or the friendly name of the secret.
|
2171
|
+
# The ARN or name of the secret.
|
2651
2172
|
#
|
2652
2173
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2653
2174
|
# partial ARN.
|
2654
2175
|
#
|
2655
2176
|
# @option params [String] :client_request_token
|
2656
|
-
#
|
2657
|
-
#
|
2658
|
-
#
|
2659
|
-
#
|
2660
|
-
# If you use the Amazon Web Services CLI or one of the Amazon Web
|
2661
|
-
# Services SDK to call this operation, then you can leave this parameter
|
2662
|
-
# empty. The CLI or SDK generates a random UUID for you and includes
|
2663
|
-
# that in the request. If you don't use the SDK and instead generate a
|
2664
|
-
# raw HTTP request to the Secrets Manager service endpoint, then you
|
2665
|
-
# must generate a `ClientRequestToken` yourself for new versions and
|
2666
|
-
# include that value in the request.
|
2667
|
-
#
|
2668
|
-
# You typically only need to interact with this value if you implement
|
2669
|
-
# your own retry logic and want to ensure that a given secret is not
|
2670
|
-
# created twice. We recommend that you generate a [UUID-type][1] value
|
2671
|
-
# to ensure uniqueness within the specified secret.
|
2672
|
-
#
|
2673
|
-
# Secrets Manager uses this value to prevent the accidental creation of
|
2674
|
-
# duplicate versions if there are failures and retries during the Lambda
|
2675
|
-
# rotation function's processing.
|
2676
|
-
#
|
2677
|
-
# * If the `ClientRequestToken` value isn't already associated with a
|
2678
|
-
# version of the secret then a new version of the secret is created.
|
2177
|
+
# If you include `SecretString` or `SecretBinary`, then Secrets Manager
|
2178
|
+
# creates a new version for the secret, and this parameter specifies the
|
2179
|
+
# unique identifier for the new version.
|
2679
2180
|
#
|
2680
|
-
#
|
2681
|
-
#
|
2682
|
-
#
|
2683
|
-
#
|
2181
|
+
# <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
|
2182
|
+
# Services SDKs to call this operation, then you can leave this
|
2183
|
+
# parameter empty. The CLI or SDK generates a random UUID for you and
|
2184
|
+
# includes it as the value for this parameter in the request. If you
|
2185
|
+
# don't use the SDK and instead generate a raw HTTP request to the
|
2186
|
+
# Secrets Manager service endpoint, then you must generate a
|
2187
|
+
# `ClientRequestToken` yourself for the new version and include the
|
2188
|
+
# value in the request.
|
2684
2189
|
#
|
2685
|
-
#
|
2686
|
-
# `SecretString` and `SecretBinary` values are different from the
|
2687
|
-
# request then an error occurs because you cannot modify an existing
|
2688
|
-
# secret value.
|
2190
|
+
# </note>
|
2689
2191
|
#
|
2690
2192
|
# This value becomes the `VersionId` of the new version.
|
2691
2193
|
#
|
2692
2194
|
# **A suitable default value is auto-generated.** You should normally
|
2693
2195
|
# not need to pass this option.**
|
2694
2196
|
#
|
2695
|
-
#
|
2696
|
-
#
|
2697
|
-
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
2698
|
-
#
|
2699
2197
|
# @option params [String] :description
|
2700
|
-
#
|
2701
|
-
# secret.
|
2198
|
+
# The description of the secret.
|
2702
2199
|
#
|
2703
2200
|
# @option params [String] :kms_key_id
|
2704
|
-
#
|
2705
|
-
#
|
2706
|
-
#
|
2707
|
-
#
|
2708
|
-
#
|
2709
|
-
# staging labels, see [Staging Labels][1] in the *Amazon Web Services
|
2710
|
-
# Secrets Manager User Guide*.
|
2201
|
+
# The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
|
2202
|
+
# encrypt new secret versions as well as any existing versions the
|
2203
|
+
# staging labels `AWSCURRENT`, `AWSPENDING`, or `AWSPREVIOUS`. For more
|
2204
|
+
# information about versions and staging labels, see [Concepts:
|
2205
|
+
# Version][1].
|
2711
2206
|
#
|
2712
|
-
# You can only use the
|
2713
|
-
# you call this operation using credentials from
|
2714
|
-
#
|
2715
|
-
#
|
2716
|
-
#
|
2717
|
-
# secret and the
|
2207
|
+
# You can only use the Amazon Web Services managed key
|
2208
|
+
# `aws/secretsmanager` if you call this operation using credentials from
|
2209
|
+
# the same Amazon Web Services account that owns the secret. If the
|
2210
|
+
# secret is in a different account, then you must use a customer managed
|
2211
|
+
# key and provide the ARN of that KMS key in this field. The user making
|
2212
|
+
# the call must have permissions to both the secret and the KMS key in
|
2213
|
+
# their respective accounts.
|
2718
2214
|
#
|
2719
2215
|
#
|
2720
2216
|
#
|
2721
|
-
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
2217
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
|
2722
2218
|
#
|
2723
2219
|
# @option params [String, StringIO, File] :secret_binary
|
2724
|
-
#
|
2725
|
-
#
|
2726
|
-
#
|
2727
|
-
# file and then use the appropriate technique for your tool to pass the
|
2728
|
-
# contents of the file as a parameter. Either `SecretBinary` or
|
2729
|
-
# `SecretString` must have a value, but not both. They cannot both be
|
2730
|
-
# empty.
|
2731
|
-
#
|
2732
|
-
# This parameter is not accessible using the Secrets Manager console.
|
2733
|
-
#
|
2734
|
-
# @option params [String] :secret_string
|
2735
|
-
# (Optional) Specifies updated text data that you want to encrypt and
|
2736
|
-
# store in this new version of the secret. Either `SecretBinary` or
|
2737
|
-
# `SecretString` must have a value, but not both. They cannot both be
|
2738
|
-
# empty.
|
2739
|
-
#
|
2740
|
-
# If you create this secret by using the Secrets Manager console then
|
2741
|
-
# Secrets Manager puts the protected secret text in only the
|
2742
|
-
# `SecretString` parameter. The Secrets Manager console stores the
|
2743
|
-
# information as a JSON structure of key/value pairs that the default
|
2744
|
-
# Lambda rotation function knows how to parse.
|
2220
|
+
# The binary data to encrypt and store in the new version of the secret.
|
2221
|
+
# We recommend that you store your binary data in a file and then pass
|
2222
|
+
# the contents of the file as a parameter.
|
2745
2223
|
#
|
2746
|
-
#
|
2747
|
-
#
|
2748
|
-
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
2749
|
-
# the Amazon Web Services CLI User Guide.
|
2224
|
+
# Either `SecretBinary` or `SecretString` must have a value, but not
|
2225
|
+
# both.
|
2750
2226
|
#
|
2227
|
+
# You can't access this parameter in the Secrets Manager console.
|
2751
2228
|
#
|
2229
|
+
# @option params [String] :secret_string
|
2230
|
+
# The text data to encrypt and store in the new version of the secret.
|
2231
|
+
# We recommend you use a JSON structure of key/value pairs for your
|
2232
|
+
# secret value.
|
2752
2233
|
#
|
2753
|
-
#
|
2234
|
+
# Either `SecretBinary` or `SecretString` must have a value, but not
|
2235
|
+
# both.
|
2754
2236
|
#
|
2755
2237
|
# @return [Types::UpdateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2756
2238
|
#
|
@@ -2834,18 +2316,17 @@ module Aws::SecretsManager
|
|
2834
2316
|
req.send_request(options)
|
2835
2317
|
end
|
2836
2318
|
|
2837
|
-
# Modifies the staging labels attached to a version of a secret.
|
2838
|
-
#
|
2839
|
-
# rotation process.
|
2840
|
-
#
|
2841
|
-
#
|
2842
|
-
#
|
2843
|
-
#
|
2844
|
-
#
|
2319
|
+
# Modifies the staging labels attached to a version of a secret. Secrets
|
2320
|
+
# Manager uses staging labels to track a version as it progresses
|
2321
|
+
# through the secret rotation process. Each staging label can be
|
2322
|
+
# attached to only one version at a time. To add a staging label to a
|
2323
|
+
# version when it is already attached to another version, Secrets
|
2324
|
+
# Manager first removes it from the other version first and then
|
2325
|
+
# attaches it to this one. For more information about versions and
|
2326
|
+
# staging labels, see [Concepts: Version][1].
|
2845
2327
|
#
|
2846
2328
|
# The staging labels that you specify in the `VersionStage` parameter
|
2847
|
-
# are added to the existing list of staging labels
|
2848
|
-
# it.
|
2329
|
+
# are added to the existing list of staging labels for the version.
|
2849
2330
|
#
|
2850
2331
|
# You can move the `AWSCURRENT` staging label to this version by
|
2851
2332
|
# including it in this call.
|
@@ -2860,30 +2341,13 @@ module Aws::SecretsManager
|
|
2860
2341
|
# then the version is considered to be 'deprecated' and can be deleted
|
2861
2342
|
# by Secrets Manager.
|
2862
2343
|
#
|
2863
|
-
# **Minimum permissions**
|
2864
|
-
#
|
2865
|
-
# To run this command, you must have the following permissions:
|
2866
|
-
#
|
2867
|
-
# * secretsmanager:UpdateSecretVersionStage
|
2868
|
-
#
|
2869
|
-
# ^
|
2870
|
-
#
|
2871
|
-
# **Related operations**
|
2872
|
-
#
|
2873
|
-
# * To get the list of staging labels that are currently associated with
|
2874
|
-
# a version of a secret, use ` DescribeSecret ` and examine the
|
2875
|
-
# `SecretVersionsToStages` response value.
|
2876
|
-
#
|
2877
|
-
# ^
|
2878
|
-
#
|
2879
2344
|
#
|
2880
2345
|
#
|
2881
|
-
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
2346
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
|
2882
2347
|
#
|
2883
2348
|
# @option params [required, String] :secret_id
|
2884
|
-
#
|
2885
|
-
#
|
2886
|
-
# (ARN) or the friendly name of the secret.
|
2349
|
+
# The ARN or the name of the secret with the version and staging
|
2350
|
+
# labelsto modify.
|
2887
2351
|
#
|
2888
2352
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2889
2353
|
# partial ARN.
|
@@ -2892,18 +2356,16 @@ module Aws::SecretsManager
|
|
2892
2356
|
# The staging label to add to this version.
|
2893
2357
|
#
|
2894
2358
|
# @option params [String] :remove_from_version_id
|
2895
|
-
#
|
2896
|
-
#
|
2897
|
-
#
|
2898
|
-
#
|
2899
|
-
#
|
2900
|
-
#
|
2901
|
-
# operation fails.
|
2359
|
+
# The ID of the version that the staging label is to be removed from. If
|
2360
|
+
# the staging label you are trying to attach to one version is already
|
2361
|
+
# attached to a different version, then you must include this parameter
|
2362
|
+
# and specify the version that the label is to be removed from. If the
|
2363
|
+
# label is attached and you either do not specify this parameter, or the
|
2364
|
+
# version ID does not match, then the operation fails.
|
2902
2365
|
#
|
2903
2366
|
# @option params [String] :move_to_version_id
|
2904
|
-
#
|
2905
|
-
#
|
2906
|
-
# specify this parameter.
|
2367
|
+
# The ID of the version to add the staging label to. To remove a label
|
2368
|
+
# from a version, then do not specify this parameter.
|
2907
2369
|
#
|
2908
2370
|
# If the staging label is already attached to a different version of the
|
2909
2371
|
# secret, then you must also specify the `RemoveFromVersionId`
|
@@ -2992,53 +2454,36 @@ module Aws::SecretsManager
|
|
2992
2454
|
req.send_request(options)
|
2993
2455
|
end
|
2994
2456
|
|
2995
|
-
# Validates that
|
2996
|
-
# principals access to your secret.
|
2997
|
-
#
|
2998
|
-
# breaks for better readability. Submit your input as a single line JSON
|
2999
|
-
# string. A resource-based policy is optional for secrets.
|
2457
|
+
# Validates that a resource policy does not grant a wide range of
|
2458
|
+
# principals access to your secret. A resource-based policy is optional
|
2459
|
+
# for secrets.
|
3000
2460
|
#
|
3001
|
-
# The API performs three checks when validating the
|
2461
|
+
# The API performs three checks when validating the policy:
|
3002
2462
|
#
|
3003
2463
|
# * Sends a call to [Zelkova][1], an automated reasoning engine, to
|
3004
|
-
# ensure your
|
3005
|
-
# secret.
|
2464
|
+
# ensure your resource policy does not allow broad access to your
|
2465
|
+
# secret, for example policies that use a wildcard for the principal.
|
3006
2466
|
#
|
3007
2467
|
# * Checks for correct syntax in a policy.
|
3008
2468
|
#
|
3009
2469
|
# * Verifies the policy does not lock out a caller.
|
3010
2470
|
#
|
3011
|
-
# **Minimum Permissions**
|
3012
|
-
#
|
3013
|
-
# You must have the permissions required to access the following APIs:
|
3014
|
-
#
|
3015
|
-
# * `secretsmanager:PutResourcePolicy`
|
3016
|
-
#
|
3017
|
-
# * `secretsmanager:ValidateResourcePolicy`
|
3018
|
-
#
|
3019
2471
|
#
|
3020
2472
|
#
|
3021
2473
|
# [1]: https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/
|
3022
2474
|
#
|
3023
2475
|
# @option params [String] :secret_id
|
3024
|
-
#
|
3025
|
-
# you want to validate. You can specify either the Amazon Resource Name
|
3026
|
-
# (ARN) or the friendly name of the secret.
|
3027
|
-
#
|
3028
|
-
# For an ARN, we recommend that you specify a complete ARN rather than a
|
3029
|
-
# partial ARN.
|
2476
|
+
# This field is reserved for internal use.
|
3030
2477
|
#
|
3031
2478
|
# @option params [required, String] :resource_policy
|
3032
|
-
# A JSON-formatted string
|
3033
|
-
#
|
3034
|
-
#
|
3035
|
-
#
|
3036
|
-
# various command line tool environments, see [Using JSON for
|
3037
|
-
# Parameters][1] in the *CLI User Guide*.publi
|
2479
|
+
# A JSON-formatted string that contains an Amazon Web Services
|
2480
|
+
# resource-based policy. The policy in the string identifies who can
|
2481
|
+
# access or manage this secret and its versions. For example policies,
|
2482
|
+
# see [Permissions policy examples][1].
|
3038
2483
|
#
|
3039
2484
|
#
|
3040
2485
|
#
|
3041
|
-
# [1]:
|
2486
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html
|
3042
2487
|
#
|
3043
2488
|
# @return [Types::ValidateResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3044
2489
|
#
|
@@ -3098,7 +2543,7 @@ module Aws::SecretsManager
|
|
3098
2543
|
params: params,
|
3099
2544
|
config: config)
|
3100
2545
|
context[:gem_name] = 'aws-sdk-secretsmanager'
|
3101
|
-
context[:gem_version] = '1.
|
2546
|
+
context[:gem_version] = '1.54.0'
|
3102
2547
|
Seahorse::Client::Request.new(handlers, context)
|
3103
2548
|
end
|
3104
2549
|
|