aws-sdk-secretsmanager 1.15.0 → 1.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-secretsmanager.rb +1 -1
- data/lib/aws-sdk-secretsmanager/client.rb +234 -1
- data/lib/aws-sdk-secretsmanager/types.rb +248 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ba66d47e8c861bec152252573965a3fd96f79bc8
|
4
|
+
data.tar.gz: b6ef1cd15618e9de6a8d062eed40b49fca3eb16a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1237ee3dd2714764a4b55c7311d312e8ff8f6772042847e9b97ff7a03ee5c40faa6241a3a7d640828fa42fffe0d5593f8a63c2eb6afd486bd7b0b43f650c18dc
|
7
|
+
data.tar.gz: 24e2954d9ec8cb6f76f69864b7c5743b993abcc99b1c87c484d72478826c3b1d746c4d5c0984dc89f6aadf7973fce84122c5b6b7013930b8e7aed21ac82c43df
|
@@ -241,6 +241,21 @@ module Aws::SecretsManager
|
|
241
241
|
# You can specify either the Amazon Resource Name (ARN) or the friendly
|
242
242
|
# name of the secret.
|
243
243
|
#
|
244
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
245
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
246
|
+
# don’t include the final hyphen and six random characters that Secrets
|
247
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
248
|
+
# partial ARN match can work as long as it uniquely matches only one
|
249
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
250
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
251
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
252
|
+
# then those characters cause Secrets Manager to assume that you’re
|
253
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
254
|
+
# results. To avoid this situation, we recommend that you don’t create
|
255
|
+
# secret names that end with a hyphen followed by six characters.
|
256
|
+
#
|
257
|
+
# </note>
|
258
|
+
#
|
244
259
|
# @return [Types::CancelRotateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
245
260
|
#
|
246
261
|
# * {Types::CancelRotateSecretResponse#arn #arn} => String
|
@@ -372,6 +387,14 @@ module Aws::SecretsManager
|
|
372
387
|
# The secret name must be ASCII letters, digits, or the following
|
373
388
|
# characters : /\_+=.@-
|
374
389
|
#
|
390
|
+
# <note markdown="1"> Don't end your secret name with a hyphen followed by six characters.
|
391
|
+
# If you do so, you risk confusion and unexpected results when searching
|
392
|
+
# for a secret by partial ARN. This is because Secrets Manager
|
393
|
+
# automatically adds a hyphen and six random characters at the end of
|
394
|
+
# the ARN.
|
395
|
+
#
|
396
|
+
# </note>
|
397
|
+
#
|
375
398
|
# @option params [String] :client_request_token
|
376
399
|
# (Optional) If you include `SecretString` or `SecretBinary`, then an
|
377
400
|
# initial version is created as part of the secret, and this parameter
|
@@ -616,6 +639,21 @@ module Aws::SecretsManager
|
|
616
639
|
# resource-based policy for. You can specify either the Amazon Resource
|
617
640
|
# Name (ARN) or the friendly name of the secret.
|
618
641
|
#
|
642
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
643
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
644
|
+
# don’t include the final hyphen and six random characters that Secrets
|
645
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
646
|
+
# partial ARN match can work as long as it uniquely matches only one
|
647
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
648
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
649
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
650
|
+
# then those characters cause Secrets Manager to assume that you’re
|
651
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
652
|
+
# results. To avoid this situation, we recommend that you don’t create
|
653
|
+
# secret names that end with a hyphen followed by six characters.
|
654
|
+
#
|
655
|
+
# </note>
|
656
|
+
#
|
619
657
|
# @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
620
658
|
#
|
621
659
|
# * {Types::DeleteResourcePolicyResponse#arn #arn} => String
|
@@ -704,6 +742,21 @@ module Aws::SecretsManager
|
|
704
742
|
# Specifies the secret that you want to delete. You can specify either
|
705
743
|
# the Amazon Resource Name (ARN) or the friendly name of the secret.
|
706
744
|
#
|
745
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
746
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
747
|
+
# don’t include the final hyphen and six random characters that Secrets
|
748
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
749
|
+
# partial ARN match can work as long as it uniquely matches only one
|
750
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
751
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
752
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
753
|
+
# then those characters cause Secrets Manager to assume that you’re
|
754
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
755
|
+
# results. To avoid this situation, we recommend that you don’t create
|
756
|
+
# secret names that end with a hyphen followed by six characters.
|
757
|
+
#
|
758
|
+
# </note>
|
759
|
+
#
|
707
760
|
# @option params [Integer] :recovery_window_in_days
|
708
761
|
# (Optional) Specifies the number of days that Secrets Manager waits
|
709
762
|
# before it can delete the secret. You can't use both this parameter
|
@@ -805,6 +858,21 @@ module Aws::SecretsManager
|
|
805
858
|
# can specify either the Amazon Resource Name (ARN) or the friendly name
|
806
859
|
# of the secret.
|
807
860
|
#
|
861
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
862
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
863
|
+
# don’t include the final hyphen and six random characters that Secrets
|
864
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
865
|
+
# partial ARN match can work as long as it uniquely matches only one
|
866
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
867
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
868
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
869
|
+
# then those characters cause Secrets Manager to assume that you’re
|
870
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
871
|
+
# results. To avoid this situation, we recommend that you don’t create
|
872
|
+
# secret names that end with a hyphen followed by six characters.
|
873
|
+
#
|
874
|
+
# </note>
|
875
|
+
#
|
808
876
|
# @return [Types::DescribeSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
809
877
|
#
|
810
878
|
# * {Types::DescribeSecretResponse#arn #arn} => String
|
@@ -1035,6 +1103,21 @@ module Aws::SecretsManager
|
|
1035
1103
|
# resource-based policy for. You can specify either the Amazon Resource
|
1036
1104
|
# Name (ARN) or the friendly name of the secret.
|
1037
1105
|
#
|
1106
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1107
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1108
|
+
# don’t include the final hyphen and six random characters that Secrets
|
1109
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
1110
|
+
# partial ARN match can work as long as it uniquely matches only one
|
1111
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
1112
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
1113
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
1114
|
+
# then those characters cause Secrets Manager to assume that you’re
|
1115
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
1116
|
+
# results. To avoid this situation, we recommend that you don’t create
|
1117
|
+
# secret names that end with a hyphen followed by six characters.
|
1118
|
+
#
|
1119
|
+
# </note>
|
1120
|
+
#
|
1038
1121
|
# @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1039
1122
|
#
|
1040
1123
|
# * {Types::GetResourcePolicyResponse#arn #arn} => String
|
@@ -1105,6 +1188,21 @@ module Aws::SecretsManager
|
|
1105
1188
|
# You can specify either the Amazon Resource Name (ARN) or the friendly
|
1106
1189
|
# name of the secret.
|
1107
1190
|
#
|
1191
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1192
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1193
|
+
# don’t include the final hyphen and six random characters that Secrets
|
1194
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
1195
|
+
# partial ARN match can work as long as it uniquely matches only one
|
1196
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
1197
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
1198
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
1199
|
+
# then those characters cause Secrets Manager to assume that you’re
|
1200
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
1201
|
+
# results. To avoid this situation, we recommend that you don’t create
|
1202
|
+
# secret names that end with a hyphen followed by six characters.
|
1203
|
+
#
|
1204
|
+
# </note>
|
1205
|
+
#
|
1108
1206
|
# @option params [String] :version_id
|
1109
1207
|
# Specifies the unique identifier of the version of the secret that you
|
1110
1208
|
# want to retrieve. If you specify this parameter then don't specify
|
@@ -1224,6 +1322,21 @@ module Aws::SecretsManager
|
|
1224
1322
|
# list. You can specify either the Amazon Resource Name (ARN) or the
|
1225
1323
|
# friendly name of the secret.
|
1226
1324
|
#
|
1325
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1326
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1327
|
+
# don’t include the final hyphen and six random characters that Secrets
|
1328
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
1329
|
+
# partial ARN match can work as long as it uniquely matches only one
|
1330
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
1331
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
1332
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
1333
|
+
# then those characters cause Secrets Manager to assume that you’re
|
1334
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
1335
|
+
# results. To avoid this situation, we recommend that you don’t create
|
1336
|
+
# secret names that end with a hyphen followed by six characters.
|
1337
|
+
#
|
1338
|
+
# </note>
|
1339
|
+
#
|
1227
1340
|
# @option params [Integer] :max_results
|
1228
1341
|
# (Optional) Limits the number of results that you want to include in
|
1229
1342
|
# the response. If you don't include this parameter, it defaults to a
|
@@ -1489,6 +1602,21 @@ module Aws::SecretsManager
|
|
1489
1602
|
# Specifies the secret that you want to attach the resource-based policy
|
1490
1603
|
# to. You can specify either the ARN or the friendly name of the secret.
|
1491
1604
|
#
|
1605
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1606
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1607
|
+
# don’t include the final hyphen and six random characters that Secrets
|
1608
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
1609
|
+
# partial ARN match can work as long as it uniquely matches only one
|
1610
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
1611
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
1612
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
1613
|
+
# then those characters cause Secrets Manager to assume that you’re
|
1614
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
1615
|
+
# results. To avoid this situation, we recommend that you don’t create
|
1616
|
+
# secret names that end with a hyphen followed by six characters.
|
1617
|
+
#
|
1618
|
+
# </note>
|
1619
|
+
#
|
1492
1620
|
# @option params [required, String] :resource_policy
|
1493
1621
|
# A JSON-formatted string that's constructed according to the grammar
|
1494
1622
|
# and syntax for an AWS resource-based policy. The policy in the string
|
@@ -1628,6 +1756,21 @@ module Aws::SecretsManager
|
|
1628
1756
|
# specify either the Amazon Resource Name (ARN) or the friendly name of
|
1629
1757
|
# the secret. The secret must already exist.
|
1630
1758
|
#
|
1759
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1760
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1761
|
+
# don’t include the final hyphen and six random characters that Secrets
|
1762
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
1763
|
+
# partial ARN match can work as long as it uniquely matches only one
|
1764
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
1765
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
1766
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
1767
|
+
# then those characters cause Secrets Manager to assume that you’re
|
1768
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
1769
|
+
# results. To avoid this situation, we recommend that you don’t create
|
1770
|
+
# secret names that end with a hyphen followed by six characters.
|
1771
|
+
#
|
1772
|
+
# </note>
|
1773
|
+
#
|
1631
1774
|
# @option params [String] :client_request_token
|
1632
1775
|
# (Optional) Specifies a unique identifier for the new version of the
|
1633
1776
|
# secret.
|
@@ -1806,6 +1949,21 @@ module Aws::SecretsManager
|
|
1806
1949
|
# scheduled deletion. You can specify either the Amazon Resource Name
|
1807
1950
|
# (ARN) or the friendly name of the secret.
|
1808
1951
|
#
|
1952
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1953
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1954
|
+
# don’t include the final hyphen and six random characters that Secrets
|
1955
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
1956
|
+
# partial ARN match can work as long as it uniquely matches only one
|
1957
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
1958
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
1959
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
1960
|
+
# then those characters cause Secrets Manager to assume that you’re
|
1961
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
1962
|
+
# results. To avoid this situation, we recommend that you don’t create
|
1963
|
+
# secret names that end with a hyphen followed by six characters.
|
1964
|
+
#
|
1965
|
+
# </note>
|
1966
|
+
#
|
1809
1967
|
# @return [Types::RestoreSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1810
1968
|
#
|
1811
1969
|
# * {Types::RestoreSecretResponse#arn #arn} => String
|
@@ -1915,6 +2073,21 @@ module Aws::SecretsManager
|
|
1915
2073
|
# Specifies the secret that you want to rotate. You can specify either
|
1916
2074
|
# the Amazon Resource Name (ARN) or the friendly name of the secret.
|
1917
2075
|
#
|
2076
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
2077
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
2078
|
+
# don’t include the final hyphen and six random characters that Secrets
|
2079
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
2080
|
+
# partial ARN match can work as long as it uniquely matches only one
|
2081
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
2082
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
2083
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
2084
|
+
# then those characters cause Secrets Manager to assume that you’re
|
2085
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
2086
|
+
# results. To avoid this situation, we recommend that you don’t create
|
2087
|
+
# secret names that end with a hyphen followed by six characters.
|
2088
|
+
#
|
2089
|
+
# </note>
|
2090
|
+
#
|
1918
2091
|
# @option params [String] :client_request_token
|
1919
2092
|
# (Optional) Specifies a unique identifier for the new version of the
|
1920
2093
|
# secret that helps ensure idempotency.
|
@@ -2035,6 +2208,21 @@ module Aws::SecretsManager
|
|
2035
2208
|
# specify either the Amazon Resource Name (ARN) or the friendly name of
|
2036
2209
|
# the secret.
|
2037
2210
|
#
|
2211
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
2212
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
2213
|
+
# don’t include the final hyphen and six random characters that Secrets
|
2214
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
2215
|
+
# partial ARN match can work as long as it uniquely matches only one
|
2216
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
2217
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
2218
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
2219
|
+
# then those characters cause Secrets Manager to assume that you’re
|
2220
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
2221
|
+
# results. To avoid this situation, we recommend that you don’t create
|
2222
|
+
# secret names that end with a hyphen followed by six characters.
|
2223
|
+
#
|
2224
|
+
# </note>
|
2225
|
+
#
|
2038
2226
|
# @option params [required, Array<Types::Tag>] :tags
|
2039
2227
|
# The tags to attach to the secret. Each element in the list consists of
|
2040
2228
|
# a `Key` and a `Value`.
|
@@ -2122,6 +2310,21 @@ module Aws::SecretsManager
|
|
2122
2310
|
# can specify either the Amazon Resource Name (ARN) or the friendly name
|
2123
2311
|
# of the secret.
|
2124
2312
|
#
|
2313
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
2314
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
2315
|
+
# don’t include the final hyphen and six random characters that Secrets
|
2316
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
2317
|
+
# partial ARN match can work as long as it uniquely matches only one
|
2318
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
2319
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
2320
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
2321
|
+
# then those characters cause Secrets Manager to assume that you’re
|
2322
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
2323
|
+
# results. To avoid this situation, we recommend that you don’t create
|
2324
|
+
# secret names that end with a hyphen followed by six characters.
|
2325
|
+
#
|
2326
|
+
# </note>
|
2327
|
+
#
|
2125
2328
|
# @option params [required, Array<String>] :tag_keys
|
2126
2329
|
# A list of tag key names to remove from the secret. You don't specify
|
2127
2330
|
# the value. Both the key and its associated value are removed.
|
@@ -2246,6 +2449,21 @@ module Aws::SecretsManager
|
|
2246
2449
|
# add a new version. You can specify either the Amazon Resource Name
|
2247
2450
|
# (ARN) or the friendly name of the secret.
|
2248
2451
|
#
|
2452
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
2453
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
2454
|
+
# don’t include the final hyphen and six random characters that Secrets
|
2455
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
2456
|
+
# partial ARN match can work as long as it uniquely matches only one
|
2457
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
2458
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
2459
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
2460
|
+
# then those characters cause Secrets Manager to assume that you’re
|
2461
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
2462
|
+
# results. To avoid this situation, we recommend that you don’t create
|
2463
|
+
# secret names that end with a hyphen followed by six characters.
|
2464
|
+
#
|
2465
|
+
# </note>
|
2466
|
+
#
|
2249
2467
|
# @option params [String] :client_request_token
|
2250
2468
|
# (Optional) If you want to add a new version to the secret, this
|
2251
2469
|
# parameter specifies a unique identifier for the new version that helps
|
@@ -2483,6 +2701,21 @@ module Aws::SecretsManager
|
|
2483
2701
|
# want to modify. You can specify either the Amazon Resource Name (ARN)
|
2484
2702
|
# or the friendly name of the secret.
|
2485
2703
|
#
|
2704
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
2705
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
2706
|
+
# don’t include the final hyphen and six random characters that Secrets
|
2707
|
+
# Manager adds at the end of the ARN when you created the secret. A
|
2708
|
+
# partial ARN match can work as long as it uniquely matches only one
|
2709
|
+
# secret. However, if your secret has a name that ends in a hyphen
|
2710
|
+
# followed by six characters (before Secrets Manager adds the hyphen and
|
2711
|
+
# six characters to the ARN) and you try to use that as a partial ARN,
|
2712
|
+
# then those characters cause Secrets Manager to assume that you’re
|
2713
|
+
# specifying a complete ARN. This confusion can cause unexpected
|
2714
|
+
# results. To avoid this situation, we recommend that you don’t create
|
2715
|
+
# secret names that end with a hyphen followed by six characters.
|
2716
|
+
#
|
2717
|
+
# </note>
|
2718
|
+
#
|
2486
2719
|
# @option params [required, String] :version_stage
|
2487
2720
|
# The list of staging labels to add to this version.
|
2488
2721
|
#
|
@@ -2600,7 +2833,7 @@ module Aws::SecretsManager
|
|
2600
2833
|
params: params,
|
2601
2834
|
config: config)
|
2602
2835
|
context[:gem_name] = 'aws-sdk-secretsmanager'
|
2603
|
-
context[:gem_version] = '1.
|
2836
|
+
context[:gem_version] = '1.16.0'
|
2604
2837
|
Seahorse::Client::Request.new(handlers, context)
|
2605
2838
|
end
|
2606
2839
|
|
@@ -19,6 +19,22 @@ module Aws::SecretsManager
|
|
19
19
|
# Specifies the secret for which you want to cancel a rotation
|
20
20
|
# request. You can specify either the Amazon Resource Name (ARN) or
|
21
21
|
# the friendly name of the secret.
|
22
|
+
#
|
23
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
24
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
25
|
+
# don’t include the final hyphen and six random characters that
|
26
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
27
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
28
|
+
# only one secret. However, if your secret has a name that ends in a
|
29
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
30
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
31
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
32
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
33
|
+
# unexpected results. To avoid this situation, we recommend that you
|
34
|
+
# don’t create secret names that end with a hyphen followed by six
|
35
|
+
# characters.
|
36
|
+
#
|
37
|
+
# </note>
|
22
38
|
# @return [String]
|
23
39
|
#
|
24
40
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CancelRotateSecretRequest AWS API Documentation
|
@@ -77,6 +93,14 @@ module Aws::SecretsManager
|
|
77
93
|
#
|
78
94
|
# The secret name must be ASCII letters, digits, or the following
|
79
95
|
# characters : /\_+=.@-
|
96
|
+
#
|
97
|
+
# <note markdown="1"> Don't end your secret name with a hyphen followed by six
|
98
|
+
# characters. If you do so, you risk confusion and unexpected results
|
99
|
+
# when searching for a secret by partial ARN. This is because Secrets
|
100
|
+
# Manager automatically adds a hyphen and six random characters at the
|
101
|
+
# end of the ARN.
|
102
|
+
#
|
103
|
+
# </note>
|
80
104
|
# @return [String]
|
81
105
|
#
|
82
106
|
# @!attribute [rw] client_request_token
|
@@ -302,6 +326,22 @@ module Aws::SecretsManager
|
|
302
326
|
# Specifies the secret that you want to delete the attached
|
303
327
|
# resource-based policy for. You can specify either the Amazon
|
304
328
|
# Resource Name (ARN) or the friendly name of the secret.
|
329
|
+
#
|
330
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
331
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
332
|
+
# don’t include the final hyphen and six random characters that
|
333
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
334
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
335
|
+
# only one secret. However, if your secret has a name that ends in a
|
336
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
337
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
338
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
339
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
340
|
+
# unexpected results. To avoid this situation, we recommend that you
|
341
|
+
# don’t create secret names that end with a hyphen followed by six
|
342
|
+
# characters.
|
343
|
+
#
|
344
|
+
# </note>
|
305
345
|
# @return [String]
|
306
346
|
#
|
307
347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteResourcePolicyRequest AWS API Documentation
|
@@ -341,6 +381,22 @@ module Aws::SecretsManager
|
|
341
381
|
# @!attribute [rw] secret_id
|
342
382
|
# Specifies the secret that you want to delete. You can specify either
|
343
383
|
# the Amazon Resource Name (ARN) or the friendly name of the secret.
|
384
|
+
#
|
385
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
386
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
387
|
+
# don’t include the final hyphen and six random characters that
|
388
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
389
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
390
|
+
# only one secret. However, if your secret has a name that ends in a
|
391
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
392
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
393
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
394
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
395
|
+
# unexpected results. To avoid this situation, we recommend that you
|
396
|
+
# don’t create secret names that end with a hyphen followed by six
|
397
|
+
# characters.
|
398
|
+
#
|
399
|
+
# </note>
|
344
400
|
# @return [String]
|
345
401
|
#
|
346
402
|
# @!attribute [rw] recovery_window_in_days
|
@@ -414,6 +470,22 @@ module Aws::SecretsManager
|
|
414
470
|
# The identifier of the secret whose details you want to retrieve. You
|
415
471
|
# can specify either the Amazon Resource Name (ARN) or the friendly
|
416
472
|
# name of the secret.
|
473
|
+
#
|
474
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
475
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
476
|
+
# don’t include the final hyphen and six random characters that
|
477
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
478
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
479
|
+
# only one secret. However, if your secret has a name that ends in a
|
480
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
481
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
482
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
483
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
484
|
+
# unexpected results. To avoid this situation, we recommend that you
|
485
|
+
# don’t create secret names that end with a hyphen followed by six
|
486
|
+
# characters.
|
487
|
+
#
|
488
|
+
# </note>
|
417
489
|
# @return [String]
|
418
490
|
#
|
419
491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretRequest AWS API Documentation
|
@@ -631,6 +703,22 @@ module Aws::SecretsManager
|
|
631
703
|
# Specifies the secret that you want to retrieve the attached
|
632
704
|
# resource-based policy for. You can specify either the Amazon
|
633
705
|
# Resource Name (ARN) or the friendly name of the secret.
|
706
|
+
#
|
707
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
708
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
709
|
+
# don’t include the final hyphen and six random characters that
|
710
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
711
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
712
|
+
# only one secret. However, if your secret has a name that ends in a
|
713
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
714
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
715
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
716
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
717
|
+
# unexpected results. To avoid this situation, we recommend that you
|
718
|
+
# don’t create secret names that end with a hyphen followed by six
|
719
|
+
# characters.
|
720
|
+
#
|
721
|
+
# </note>
|
634
722
|
# @return [String]
|
635
723
|
#
|
636
724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetResourcePolicyRequest AWS API Documentation
|
@@ -686,6 +774,22 @@ module Aws::SecretsManager
|
|
686
774
|
# Specifies the secret containing the version that you want to
|
687
775
|
# retrieve. You can specify either the Amazon Resource Name (ARN) or
|
688
776
|
# the friendly name of the secret.
|
777
|
+
#
|
778
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
779
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
780
|
+
# don’t include the final hyphen and six random characters that
|
781
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
782
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
783
|
+
# only one secret. However, if your secret has a name that ends in a
|
784
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
785
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
786
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
787
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
788
|
+
# unexpected results. To avoid this situation, we recommend that you
|
789
|
+
# don’t create secret names that end with a hyphen followed by six
|
790
|
+
# characters.
|
791
|
+
#
|
792
|
+
# </note>
|
689
793
|
# @return [String]
|
690
794
|
#
|
691
795
|
# @!attribute [rw] version_id
|
@@ -806,6 +910,22 @@ module Aws::SecretsManager
|
|
806
910
|
# The identifier for the secret containing the versions you want to
|
807
911
|
# list. You can specify either the Amazon Resource Name (ARN) or the
|
808
912
|
# friendly name of the secret.
|
913
|
+
#
|
914
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
915
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
916
|
+
# don’t include the final hyphen and six random characters that
|
917
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
918
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
919
|
+
# only one secret. However, if your secret has a name that ends in a
|
920
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
921
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
922
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
923
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
924
|
+
# unexpected results. To avoid this situation, we recommend that you
|
925
|
+
# don’t create secret names that end with a hyphen followed by six
|
926
|
+
# characters.
|
927
|
+
#
|
928
|
+
# </note>
|
809
929
|
# @return [String]
|
810
930
|
#
|
811
931
|
# @!attribute [rw] max_results
|
@@ -962,6 +1082,22 @@ module Aws::SecretsManager
|
|
962
1082
|
# Specifies the secret that you want to attach the resource-based
|
963
1083
|
# policy to. You can specify either the ARN or the friendly name of
|
964
1084
|
# the secret.
|
1085
|
+
#
|
1086
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1087
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1088
|
+
# don’t include the final hyphen and six random characters that
|
1089
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1090
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1091
|
+
# only one secret. However, if your secret has a name that ends in a
|
1092
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1093
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1094
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1095
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1096
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1097
|
+
# don’t create secret names that end with a hyphen followed by six
|
1098
|
+
# characters.
|
1099
|
+
#
|
1100
|
+
# </note>
|
965
1101
|
# @return [String]
|
966
1102
|
#
|
967
1103
|
# @!attribute [rw] resource_policy
|
@@ -1018,6 +1154,22 @@ module Aws::SecretsManager
|
|
1018
1154
|
# Specifies the secret to which you want to add a new version. You can
|
1019
1155
|
# specify either the Amazon Resource Name (ARN) or the friendly name
|
1020
1156
|
# of the secret. The secret must already exist.
|
1157
|
+
#
|
1158
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1159
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1160
|
+
# don’t include the final hyphen and six random characters that
|
1161
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1162
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1163
|
+
# only one secret. However, if your secret has a name that ends in a
|
1164
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1165
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1166
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1167
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1168
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1169
|
+
# don’t create secret names that end with a hyphen followed by six
|
1170
|
+
# characters.
|
1171
|
+
#
|
1172
|
+
# </note>
|
1021
1173
|
# @return [String]
|
1022
1174
|
#
|
1023
1175
|
# @!attribute [rw] client_request_token
|
@@ -1178,6 +1330,22 @@ module Aws::SecretsManager
|
|
1178
1330
|
# Specifies the secret that you want to restore from a previously
|
1179
1331
|
# scheduled deletion. You can specify either the Amazon Resource Name
|
1180
1332
|
# (ARN) or the friendly name of the secret.
|
1333
|
+
#
|
1334
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1335
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1336
|
+
# don’t include the final hyphen and six random characters that
|
1337
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1338
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1339
|
+
# only one secret. However, if your secret has a name that ends in a
|
1340
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1341
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1342
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1343
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1344
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1345
|
+
# don’t create secret names that end with a hyphen followed by six
|
1346
|
+
# characters.
|
1347
|
+
#
|
1348
|
+
# </note>
|
1181
1349
|
# @return [String]
|
1182
1350
|
#
|
1183
1351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecretRequest AWS API Documentation
|
@@ -1218,6 +1386,22 @@ module Aws::SecretsManager
|
|
1218
1386
|
# @!attribute [rw] secret_id
|
1219
1387
|
# Specifies the secret that you want to rotate. You can specify either
|
1220
1388
|
# the Amazon Resource Name (ARN) or the friendly name of the secret.
|
1389
|
+
#
|
1390
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1391
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1392
|
+
# don’t include the final hyphen and six random characters that
|
1393
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1394
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1395
|
+
# only one secret. However, if your secret has a name that ends in a
|
1396
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1397
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1398
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1399
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1400
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1401
|
+
# don’t create secret names that end with a hyphen followed by six
|
1402
|
+
# characters.
|
1403
|
+
#
|
1404
|
+
# </note>
|
1221
1405
|
# @return [String]
|
1222
1406
|
#
|
1223
1407
|
# @!attribute [rw] client_request_token
|
@@ -1503,6 +1687,22 @@ module Aws::SecretsManager
|
|
1503
1687
|
# The identifier for the secret that you want to attach tags to. You
|
1504
1688
|
# can specify either the Amazon Resource Name (ARN) or the friendly
|
1505
1689
|
# name of the secret.
|
1690
|
+
#
|
1691
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1692
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1693
|
+
# don’t include the final hyphen and six random characters that
|
1694
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1695
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1696
|
+
# only one secret. However, if your secret has a name that ends in a
|
1697
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1698
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1699
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1700
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1701
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1702
|
+
# don’t create secret names that end with a hyphen followed by six
|
1703
|
+
# characters.
|
1704
|
+
#
|
1705
|
+
# </note>
|
1506
1706
|
# @return [String]
|
1507
1707
|
#
|
1508
1708
|
# @!attribute [rw] tags
|
@@ -1541,6 +1741,22 @@ module Aws::SecretsManager
|
|
1541
1741
|
# The identifier for the secret that you want to remove tags from. You
|
1542
1742
|
# can specify either the Amazon Resource Name (ARN) or the friendly
|
1543
1743
|
# name of the secret.
|
1744
|
+
#
|
1745
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1746
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1747
|
+
# don’t include the final hyphen and six random characters that
|
1748
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1749
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1750
|
+
# only one secret. However, if your secret has a name that ends in a
|
1751
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1752
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1753
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1754
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1755
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1756
|
+
# don’t create secret names that end with a hyphen followed by six
|
1757
|
+
# characters.
|
1758
|
+
#
|
1759
|
+
# </note>
|
1544
1760
|
# @return [String]
|
1545
1761
|
#
|
1546
1762
|
# @!attribute [rw] tag_keys
|
@@ -1582,6 +1798,22 @@ module Aws::SecretsManager
|
|
1582
1798
|
# Specifies the secret that you want to modify or to which you want to
|
1583
1799
|
# add a new version. You can specify either the Amazon Resource Name
|
1584
1800
|
# (ARN) or the friendly name of the secret.
|
1801
|
+
#
|
1802
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1803
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1804
|
+
# don’t include the final hyphen and six random characters that
|
1805
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1806
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1807
|
+
# only one secret. However, if your secret has a name that ends in a
|
1808
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1809
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1810
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1811
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1812
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1813
|
+
# don’t create secret names that end with a hyphen followed by six
|
1814
|
+
# characters.
|
1815
|
+
#
|
1816
|
+
# </note>
|
1585
1817
|
# @return [String]
|
1586
1818
|
#
|
1587
1819
|
# @!attribute [rw] client_request_token
|
@@ -1751,6 +1983,22 @@ module Aws::SecretsManager
|
|
1751
1983
|
# Specifies the secret with the version whose list of staging labels
|
1752
1984
|
# you want to modify. You can specify either the Amazon Resource Name
|
1753
1985
|
# (ARN) or the friendly name of the secret.
|
1986
|
+
#
|
1987
|
+
# <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
|
1988
|
+
# complete ARN. You can specify a partial ARN too—for example, if you
|
1989
|
+
# don’t include the final hyphen and six random characters that
|
1990
|
+
# Secrets Manager adds at the end of the ARN when you created the
|
1991
|
+
# secret. A partial ARN match can work as long as it uniquely matches
|
1992
|
+
# only one secret. However, if your secret has a name that ends in a
|
1993
|
+
# hyphen followed by six characters (before Secrets Manager adds the
|
1994
|
+
# hyphen and six characters to the ARN) and you try to use that as a
|
1995
|
+
# partial ARN, then those characters cause Secrets Manager to assume
|
1996
|
+
# that you’re specifying a complete ARN. This confusion can cause
|
1997
|
+
# unexpected results. To avoid this situation, we recommend that you
|
1998
|
+
# don’t create secret names that end with a hyphen followed by six
|
1999
|
+
# characters.
|
2000
|
+
#
|
2001
|
+
# </note>
|
1754
2002
|
# @return [String]
|
1755
2003
|
#
|
1756
2004
|
# @!attribute [rw] version_stage
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-secretsmanager
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.16.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-10-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|