aws-sdk-kms 1.27.0 → 1.28.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-kms.rb +1 -1
- data/lib/aws-sdk-kms/client.rb +68 -47
- data/lib/aws-sdk-kms/types.rb +81 -36
- 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: 7a1d64a3a6d8bb465bd5c3723efd25dc66979b2a
|
4
|
+
data.tar.gz: 4d62486183f53d341fda59abe505fe5eb574066f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d3c526c701cc03769192f049859da5944e5d9e038ffd967bfd49001c2c67970e77710f96c654653a3ac4c4fef27342a247b406902eeb9a6b95a86c5baf6cfdec
|
7
|
+
data.tar.gz: 6c1a94627d34371d991d31b314c60c7da194e554c408ff0fa3d2e44abf803af6885d03f1b2e171dd6ec22fbf30ddc100333f57fc82abb4311b0a14b7668905ba
|
data/lib/aws-sdk-kms.rb
CHANGED
data/lib/aws-sdk-kms/client.rb
CHANGED
@@ -344,7 +344,9 @@ module Aws::KMS
|
|
344
344
|
# To connect a custom key store, its associated AWS CloudHSM cluster
|
345
345
|
# must have at least one active HSM. To get the number of active HSMs in
|
346
346
|
# a cluster, use the [DescribeClusters][2] operation. To add HSMs to the
|
347
|
-
# cluster, use the [CreateHsm][3] operation.
|
347
|
+
# cluster, use the [CreateHsm][3] operation. Also, the [ `kmsuser`
|
348
|
+
# crypto user][4] (CU) must not be logged into the cluster. This
|
349
|
+
# prevents AWS KMS from using this account to log in.
|
348
350
|
#
|
349
351
|
# The connection process can take an extended amount of time to
|
350
352
|
# complete; up to 20 minutes. This operation starts the connection
|
@@ -357,8 +359,7 @@ module Aws::KMS
|
|
357
359
|
# During the connection process, AWS KMS finds the AWS CloudHSM cluster
|
358
360
|
# that is associated with the custom key store, creates the connection
|
359
361
|
# infrastructure, connects to the cluster, logs into the AWS CloudHSM
|
360
|
-
# client as the
|
361
|
-
# password.
|
362
|
+
# client as the `kmsuser` CU, and rotates its password.
|
362
363
|
#
|
363
364
|
# The `ConnectCustomKeyStore` operation might fail for various reasons.
|
364
365
|
# To find the reason, use the DescribeCustomKeyStores operation and see
|
@@ -581,6 +582,9 @@ module Aws::KMS
|
|
581
582
|
# the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as
|
582
583
|
# this user to manage key material on your behalf.
|
583
584
|
#
|
585
|
+
# The password must be a string of 7 to 32 characters. Its value is case
|
586
|
+
# sensitive.
|
587
|
+
#
|
584
588
|
# This parameter tells AWS KMS the `kmsuser` account password; it does
|
585
589
|
# not change the password in the AWS CloudHSM cluster.
|
586
590
|
#
|
@@ -831,8 +835,9 @@ module Aws::KMS
|
|
831
835
|
# * **Symmetric CMKs** contain a 256-bit symmetric key that never leaves
|
832
836
|
# AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can
|
833
837
|
# use a symmetric CMK to encrypt and decrypt small amounts of data,
|
834
|
-
# but they are typically used to generate [data keys][2]
|
835
|
-
# pairs. For details, see GenerateDataKey and
|
838
|
+
# but they are typically used to generate [data keys][2] and [data
|
839
|
+
# keys pairs][3]. For details, see GenerateDataKey and
|
840
|
+
# GenerateDataKeyPair.
|
836
841
|
#
|
837
842
|
# * **Asymmetric CMKs** can contain an RSA key pair or an Elliptic Curve
|
838
843
|
# (ECC) key pair. The private key in an asymmetric CMK never leaves
|
@@ -843,7 +848,7 @@ module Aws::KMS
|
|
843
848
|
# be used only to sign and verify messages.
|
844
849
|
#
|
845
850
|
# For information about symmetric and asymmetric CMKs, see [Using
|
846
|
-
# Symmetric and Asymmetric CMKs][
|
851
|
+
# Symmetric and Asymmetric CMKs][4] in the *AWS Key Management Service
|
847
852
|
# Developer Guide*.
|
848
853
|
#
|
849
854
|
# To create different types of CMKs, use the following guidance:
|
@@ -877,7 +882,7 @@ module Aws::KMS
|
|
877
882
|
# token, and use the public key to encrypt your key material. Then,
|
878
883
|
# use ImportKeyMaterial with your import token to import the key
|
879
884
|
# material. For step-by-step instructions, see [Importing Key
|
880
|
-
# Material][
|
885
|
+
# Material][5] in the <i> <i>AWS Key Management Service Developer
|
881
886
|
# Guide</i> </i>. You cannot import the key material into an
|
882
887
|
# asymmetric CMK.
|
883
888
|
#
|
@@ -885,7 +890,7 @@ module Aws::KMS
|
|
885
890
|
#
|
886
891
|
# Custom Key Stores
|
887
892
|
#
|
888
|
-
# : To create a symmetric CMK in a [custom key store][
|
893
|
+
# : To create a symmetric CMK in a [custom key store][6], use the
|
889
894
|
# `CustomKeyStoreId` parameter to specify the custom key store. You
|
890
895
|
# must also use the `Origin` parameter with a value of `AWS_CLOUDHSM`.
|
891
896
|
# The AWS CloudHSM cluster that is associated with the custom key
|
@@ -894,16 +899,17 @@ module Aws::KMS
|
|
894
899
|
#
|
895
900
|
# You cannot create an asymmetric CMK in a custom key store. For
|
896
901
|
# information about custom key stores in AWS KMS see [Using Custom Key
|
897
|
-
# Stores][
|
902
|
+
# Stores][6] in the <i> <i>AWS Key Management Service Developer
|
898
903
|
# Guide</i> </i>.
|
899
904
|
#
|
900
905
|
#
|
901
906
|
#
|
902
907
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master-keys
|
903
908
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
904
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
905
|
-
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
906
|
-
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
909
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs
|
910
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
911
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
912
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
907
913
|
#
|
908
914
|
# @option params [String] :policy
|
909
915
|
# The key policy to attach to the CMK.
|
@@ -931,7 +937,7 @@ module Aws::KMS
|
|
931
937
|
# policy to the CMK. For more information, see [Default Key Policy][3]
|
932
938
|
# in the *AWS Key Management Service Developer Guide*.
|
933
939
|
#
|
934
|
-
# The key policy size
|
940
|
+
# The key policy size quota is 32 kilobytes (32768 bytes).
|
935
941
|
#
|
936
942
|
#
|
937
943
|
#
|
@@ -961,20 +967,26 @@ module Aws::KMS
|
|
961
967
|
# * For asymmetric CMKs with ECC key material, specify `SIGN_VERIFY`.
|
962
968
|
#
|
963
969
|
# @option params [String] :customer_master_key_spec
|
964
|
-
# Specifies the type of CMK to create. The
|
965
|
-
#
|
966
|
-
#
|
967
|
-
#
|
968
|
-
#
|
969
|
-
# the algorithms that can be used with the CMK, use its key policy or
|
970
|
-
# IAM policy.
|
971
|
-
#
|
972
|
-
# For help with choosing a key spec for your CMK, see [Selecting a
|
973
|
-
# Customer Master Key Spec][1] in the *AWS Key Management Service
|
974
|
-
# Developer Guide*.
|
970
|
+
# Specifies the type of CMK to create. The default value,
|
971
|
+
# `SYMMETRIC_DEFAULT`, creates a CMK with a 256-bit symmetric key for
|
972
|
+
# encryption and decryption. For help choosing a key spec for your CMK,
|
973
|
+
# see [How to Choose Your CMK Configuration][1] in the *AWS Key
|
974
|
+
# Management Service Developer Guide*.
|
975
975
|
#
|
976
|
-
# The
|
977
|
-
# symmetric key.
|
976
|
+
# The `CustomerMasterKeySpec` determines whether the CMK contains a
|
977
|
+
# symmetric key or an asymmetric key pair. It also determines the
|
978
|
+
# encryption algorithms or signing algorithms that the CMK supports. You
|
979
|
+
# can't change the `CustomerMasterKeySpec` after the CMK is created. To
|
980
|
+
# further restrict the algorithms that can be used with the CMK, use a
|
981
|
+
# condition key in its key policy or IAM policy. For more information,
|
982
|
+
# see [kms:EncryptionAlgorithm][2] or [kms:Signing Algorithm][3] in the
|
983
|
+
# *AWS Key Management Service Developer Guide*.
|
984
|
+
#
|
985
|
+
# [AWS services that are integrated with AWS KMS][4] use symmetric CMKs
|
986
|
+
# to protect your data. These services do not support asymmetric CMKs.
|
987
|
+
# For help determining whether a CMK is symmetric or asymmetric, see
|
988
|
+
# [Identifying Symmetric and Asymmetric CMKs][5] in the *AWS Key
|
989
|
+
# Management Service Developer Guide*.
|
978
990
|
#
|
979
991
|
# AWS KMS supports the following key specs for CMKs:
|
980
992
|
#
|
@@ -1008,7 +1020,11 @@ module Aws::KMS
|
|
1008
1020
|
#
|
1009
1021
|
#
|
1010
1022
|
#
|
1011
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
1023
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html
|
1024
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm
|
1025
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm
|
1026
|
+
# [4]: http://aws.amazon.com/kms/features/#AWS_Service_Integration
|
1027
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html
|
1012
1028
|
#
|
1013
1029
|
# @option params [String] :origin
|
1014
1030
|
# The source of the key material for the CMK. You cannot change the
|
@@ -1610,7 +1626,7 @@ module Aws::KMS
|
|
1610
1626
|
# resp.custom_key_stores[0].cloud_hsm_cluster_id #=> String
|
1611
1627
|
# resp.custom_key_stores[0].trust_anchor_certificate #=> String
|
1612
1628
|
# resp.custom_key_stores[0].connection_state #=> String, one of "CONNECTED", "CONNECTING", "FAILED", "DISCONNECTED", "DISCONNECTING"
|
1613
|
-
# resp.custom_key_stores[0].connection_error_code #=> String, one of "INVALID_CREDENTIALS", "CLUSTER_NOT_FOUND", "NETWORK_ERRORS", "INTERNAL_ERROR", "INSUFFICIENT_CLOUDHSM_HSMS", "USER_LOCKED_OUT"
|
1629
|
+
# resp.custom_key_stores[0].connection_error_code #=> String, one of "INVALID_CREDENTIALS", "CLUSTER_NOT_FOUND", "NETWORK_ERRORS", "INTERNAL_ERROR", "INSUFFICIENT_CLOUDHSM_HSMS", "USER_LOCKED_OUT", "USER_NOT_FOUND", "USER_LOGGED_IN"
|
1614
1630
|
# resp.custom_key_stores[0].creation_date #=> Time
|
1615
1631
|
# resp.next_marker #=> String
|
1616
1632
|
# resp.truncated #=> Boolean
|
@@ -2275,7 +2291,7 @@ module Aws::KMS
|
|
2275
2291
|
#
|
2276
2292
|
# To generate a data key, specify the symmetric CMK that will be used to
|
2277
2293
|
# encrypt the data key. You cannot use an asymmetric CMK to generate
|
2278
|
-
# data keys.
|
2294
|
+
# data keys. To get the type of your CMK, use the DescribeKey operation.
|
2279
2295
|
#
|
2280
2296
|
# You must also specify the length of the data key. Use either the
|
2281
2297
|
# `KeySpec` or `NumberOfBytes` parameters (but not both). For 128-bit
|
@@ -2646,7 +2662,8 @@ module Aws::KMS
|
|
2646
2662
|
#
|
2647
2663
|
# @option params [required, String] :key_id
|
2648
2664
|
# Specifies the CMK that encrypts the private key in the data key pair.
|
2649
|
-
# You must specify a symmetric CMK. You cannot use an asymmetric CMK.
|
2665
|
+
# You must specify a symmetric CMK. You cannot use an asymmetric CMK. To
|
2666
|
+
# get the type of your CMK, use the DescribeKey operation.
|
2650
2667
|
#
|
2651
2668
|
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
2652
2669
|
# name, or alias ARN. When using an alias name, prefix it with
|
@@ -2746,14 +2763,10 @@ module Aws::KMS
|
|
2746
2763
|
# To generate a data key, you must specify the symmetric customer master
|
2747
2764
|
# key (CMK) that is used to encrypt the data key. You cannot use an
|
2748
2765
|
# asymmetric CMK to generate a data key. To get the type of your CMK,
|
2749
|
-
# use the
|
2750
|
-
# specify the length of the data key using either the `KeySpec` or
|
2751
|
-
# `NumberOfBytes` field (but not both). For common key lengths (128-bit
|
2752
|
-
# and 256-bit symmetric keys), use the `KeySpec` parameter.
|
2766
|
+
# use the DescribeKey operation.
|
2753
2767
|
#
|
2754
|
-
# If the operation succeeds, you will find the
|
2755
|
-
# data key in the `
|
2756
|
-
# copy of the data key in the `CiphertextBlob` field.
|
2768
|
+
# If the operation succeeds, you will find the encrypted copy of the
|
2769
|
+
# data key in the `CiphertextBlob` field.
|
2757
2770
|
#
|
2758
2771
|
# You can use the optional encryption context to add additional security
|
2759
2772
|
# to the encryption operation. If you specify an `EncryptionContext`,
|
@@ -3471,7 +3484,7 @@ module Aws::KMS
|
|
3471
3484
|
# field. These are predefined aliases that AWS has created but has not
|
3472
3485
|
# yet associated with a CMK. Aliases that AWS creates in your account,
|
3473
3486
|
# including predefined aliases, do not count against your [AWS KMS
|
3474
|
-
# aliases
|
3487
|
+
# aliases quota][1].
|
3475
3488
|
#
|
3476
3489
|
#
|
3477
3490
|
#
|
@@ -4147,12 +4160,15 @@ module Aws::KMS
|
|
4147
4160
|
# information, see [Changes that I make are not always immediately
|
4148
4161
|
# visible][2] in the *AWS Identity and Access Management User Guide*.
|
4149
4162
|
#
|
4150
|
-
# The key policy
|
4163
|
+
# The key policy cannot exceed 32 kilobytes (32768 bytes). For more
|
4164
|
+
# information, see [Resource Quotas][3] in the *AWS Key Management
|
4165
|
+
# Service Developer Guide*.
|
4151
4166
|
#
|
4152
4167
|
#
|
4153
4168
|
#
|
4154
4169
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
|
4155
4170
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
|
4171
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html
|
4156
4172
|
#
|
4157
4173
|
# @option params [Boolean] :bypass_policy_lockout_safety_check
|
4158
4174
|
# A flag to indicate whether to bypass the key policy lockout safety
|
@@ -5280,17 +5296,22 @@ module Aws::KMS
|
|
5280
5296
|
# To get the alias name and alias ARN, use ListAliases.
|
5281
5297
|
#
|
5282
5298
|
# @option params [required, String, IO] :message
|
5283
|
-
# Specifies the message that was signed
|
5284
|
-
#
|
5285
|
-
#
|
5299
|
+
# Specifies the message that was signed. You can submit a raw message of
|
5300
|
+
# up to 4096 bytes, or a hash digest of the message. If you submit a
|
5301
|
+
# digest, use the `MessageType` parameter with a value of `DIGEST`.
|
5286
5302
|
#
|
5287
|
-
# If the
|
5288
|
-
#
|
5303
|
+
# If the message specified here is different from the message that was
|
5304
|
+
# signed, the signature verification fails. A message and its hash
|
5305
|
+
# digest are considered to be the same message.
|
5289
5306
|
#
|
5290
5307
|
# @option params [String] :message_type
|
5291
5308
|
# Tells AWS KMS whether the value of the `Message` parameter is a
|
5292
|
-
# message or message digest.
|
5293
|
-
# indicate a message digest, enter `DIGEST`.
|
5309
|
+
# message or message digest. The default value, RAW, indicates a
|
5310
|
+
# message. To indicate a message digest, enter `DIGEST`.
|
5311
|
+
#
|
5312
|
+
# Use the `DIGEST` value only when the value of the `Message` parameter
|
5313
|
+
# is a message digest. If you use the `DIGEST` value with a raw message,
|
5314
|
+
# the security of the verification operation can be compromised.
|
5294
5315
|
#
|
5295
5316
|
# @option params [required, String, IO] :signature
|
5296
5317
|
# The signature that the `Sign` operation generated.
|
@@ -5354,7 +5375,7 @@ module Aws::KMS
|
|
5354
5375
|
params: params,
|
5355
5376
|
config: config)
|
5356
5377
|
context[:gem_name] = 'aws-sdk-kms'
|
5357
|
-
context[:gem_version] = '1.
|
5378
|
+
context[:gem_version] = '1.28.0'
|
5358
5379
|
Seahorse::Client::Request.new(handlers, context)
|
5359
5380
|
end
|
5360
5381
|
|
data/lib/aws-sdk-kms/types.rb
CHANGED
@@ -324,6 +324,9 @@ module Aws::KMS
|
|
324
324
|
# in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster
|
325
325
|
# as this user to manage key material on your behalf.
|
326
326
|
#
|
327
|
+
# The password must be a string of 7 to 32 characters. Its value is
|
328
|
+
# case sensitive.
|
329
|
+
#
|
327
330
|
# This parameter tells AWS KMS the `kmsuser` account password; it does
|
328
331
|
# not change the password in the AWS CloudHSM cluster.
|
329
332
|
#
|
@@ -555,7 +558,7 @@ module Aws::KMS
|
|
555
558
|
# policy to the CMK. For more information, see [Default Key Policy][3]
|
556
559
|
# in the *AWS Key Management Service Developer Guide*.
|
557
560
|
#
|
558
|
-
# The key policy size
|
561
|
+
# The key policy size quota is 32 kilobytes (32768 bytes).
|
559
562
|
#
|
560
563
|
#
|
561
564
|
#
|
@@ -589,20 +592,26 @@ module Aws::KMS
|
|
589
592
|
# @return [String]
|
590
593
|
#
|
591
594
|
# @!attribute [rw] customer_master_key_spec
|
592
|
-
# Specifies the type of CMK to create. The
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
# restrict the algorithms that can be used with the CMK, use its key
|
598
|
-
# policy or IAM policy.
|
599
|
-
#
|
600
|
-
# For help with choosing a key spec for your CMK, see [Selecting a
|
601
|
-
# Customer Master Key Spec][1] in the *AWS Key Management Service
|
602
|
-
# Developer Guide*.
|
595
|
+
# Specifies the type of CMK to create. The default value,
|
596
|
+
# `SYMMETRIC_DEFAULT`, creates a CMK with a 256-bit symmetric key for
|
597
|
+
# encryption and decryption. For help choosing a key spec for your
|
598
|
+
# CMK, see [How to Choose Your CMK Configuration][1] in the *AWS Key
|
599
|
+
# Management Service Developer Guide*.
|
603
600
|
#
|
604
|
-
# The
|
605
|
-
# symmetric key.
|
601
|
+
# The `CustomerMasterKeySpec` determines whether the CMK contains a
|
602
|
+
# symmetric key or an asymmetric key pair. It also determines the
|
603
|
+
# encryption algorithms or signing algorithms that the CMK supports.
|
604
|
+
# You can't change the `CustomerMasterKeySpec` after the CMK is
|
605
|
+
# created. To further restrict the algorithms that can be used with
|
606
|
+
# the CMK, use a condition key in its key policy or IAM policy. For
|
607
|
+
# more information, see [kms:EncryptionAlgorithm][2] or [kms:Signing
|
608
|
+
# Algorithm][3] in the *AWS Key Management Service Developer Guide*.
|
609
|
+
#
|
610
|
+
# [AWS services that are integrated with AWS KMS][4] use symmetric
|
611
|
+
# CMKs to protect your data. These services do not support asymmetric
|
612
|
+
# CMKs. For help determining whether a CMK is symmetric or asymmetric,
|
613
|
+
# see [Identifying Symmetric and Asymmetric CMKs][5] in the *AWS Key
|
614
|
+
# Management Service Developer Guide*.
|
606
615
|
#
|
607
616
|
# AWS KMS supports the following key specs for CMKs:
|
608
617
|
#
|
@@ -637,7 +646,11 @@ module Aws::KMS
|
|
637
646
|
#
|
638
647
|
#
|
639
648
|
#
|
640
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
649
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html
|
650
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm
|
651
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm
|
652
|
+
# [4]: http://aws.amazon.com/kms/features/#AWS_Service_Integration
|
653
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html
|
641
654
|
# @return [String]
|
642
655
|
#
|
643
656
|
# @!attribute [rw] origin
|
@@ -867,9 +880,10 @@ module Aws::KMS
|
|
867
880
|
# AWS CloudHSM cluster is active and contains at least one active HSM.
|
868
881
|
#
|
869
882
|
# A value of `FAILED` indicates that an attempt to connect was
|
870
|
-
# unsuccessful.
|
871
|
-
#
|
872
|
-
#
|
883
|
+
# unsuccessful. The `ConnectionErrorCode` field in the response
|
884
|
+
# indicates the cause of the failure. For help resolving a connection
|
885
|
+
# failure, see [Troubleshooting a Custom Key Store][1] in the *AWS Key
|
886
|
+
# Management Service Developer Guide*.
|
873
887
|
#
|
874
888
|
#
|
875
889
|
#
|
@@ -877,7 +891,12 @@ module Aws::KMS
|
|
877
891
|
# @return [String]
|
878
892
|
#
|
879
893
|
# @!attribute [rw] connection_error_code
|
880
|
-
# Describes the connection error.
|
894
|
+
# Describes the connection error. This field appears in the response
|
895
|
+
# only when the `ConnectionState` is `FAILED`. For help resolving
|
896
|
+
# these errors, see [How to Fix a Connection Failure][1] in *AWS Key
|
897
|
+
# Management Service Developer Guide*.
|
898
|
+
#
|
899
|
+
# Valid values are:
|
881
900
|
#
|
882
901
|
# * `CLUSTER_NOT_FOUND` - AWS KMS cannot find the AWS CloudHSM cluster
|
883
902
|
# with the specified cluster ID.
|
@@ -893,7 +912,10 @@ module Aws::KMS
|
|
893
912
|
# again.
|
894
913
|
#
|
895
914
|
# * `INVALID_CREDENTIALS` - AWS KMS does not have the correct password
|
896
|
-
# for the `kmsuser` crypto user in the AWS CloudHSM cluster.
|
915
|
+
# for the `kmsuser` crypto user in the AWS CloudHSM cluster. Before
|
916
|
+
# you can connect your custom key store to its AWS CloudHSM cluster,
|
917
|
+
# you must change the `kmsuser` account password and update the key
|
918
|
+
# store password value for the custom key store.
|
897
919
|
#
|
898
920
|
# * `NETWORK_ERRORS` - Network errors are preventing AWS KMS from
|
899
921
|
# connecting to the custom key store.
|
@@ -902,14 +924,28 @@ module Aws::KMS
|
|
902
924
|
# associated AWS CloudHSM cluster due to too many failed password
|
903
925
|
# attempts. Before you can connect your custom key store to its AWS
|
904
926
|
# CloudHSM cluster, you must change the `kmsuser` account password
|
905
|
-
# and update the password value for the custom key store.
|
927
|
+
# and update the key store password value for the custom key store.
|
906
928
|
#
|
907
|
-
#
|
908
|
-
#
|
929
|
+
# * `USER_LOGGED_IN` - The `kmsuser` CU account is logged into the the
|
930
|
+
# associated AWS CloudHSM cluster. This prevents AWS KMS from
|
931
|
+
# rotating the `kmsuser` account password and logging into the
|
932
|
+
# cluster. Before you can connect your custom key store to its AWS
|
933
|
+
# CloudHSM cluster, you must log the `kmsuser` CU out of the
|
934
|
+
# cluster. If you changed the `kmsuser` password to log into the
|
935
|
+
# cluster, you must also and update the key store password value for
|
936
|
+
# the custom key store. For help, see [How to Log Out and
|
937
|
+
# Reconnect][2] in the *AWS Key Management Service Developer Guide*.
|
909
938
|
#
|
939
|
+
# * `USER_NOT_FOUND` - AWS KMS cannot find a `kmsuser` CU account in
|
940
|
+
# the associated AWS CloudHSM cluster. Before you can connect your
|
941
|
+
# custom key store to its AWS CloudHSM cluster, you must create a
|
942
|
+
# `kmsuser` CU account in the cluster, and then update the key store
|
943
|
+
# password value for the custom key store.
|
910
944
|
#
|
911
945
|
#
|
912
|
-
#
|
946
|
+
#
|
947
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed
|
948
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2
|
913
949
|
# @return [String]
|
914
950
|
#
|
915
951
|
# @!attribute [rw] creation_date
|
@@ -1745,7 +1781,7 @@ module Aws::KMS
|
|
1745
1781
|
# @!attribute [rw] key_id
|
1746
1782
|
# Specifies the CMK that encrypts the private key in the data key
|
1747
1783
|
# pair. You must specify a symmetric CMK. You cannot use an asymmetric
|
1748
|
-
# CMK.
|
1784
|
+
# CMK. To get the type of your CMK, use the DescribeKey operation.
|
1749
1785
|
#
|
1750
1786
|
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
1751
1787
|
# name, or alias ARN. When using an alias name, prefix it with
|
@@ -1809,7 +1845,7 @@ module Aws::KMS
|
|
1809
1845
|
# @!attribute [rw] key_id
|
1810
1846
|
# Specifies the CMK that encrypted the private key in the data key
|
1811
1847
|
# pair. You must specify a symmetric CMK. You cannot use an asymmetric
|
1812
|
-
# CMK.
|
1848
|
+
# CMK. To get the type of your CMK, use the DescribeKey operation.
|
1813
1849
|
#
|
1814
1850
|
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
1815
1851
|
# name, or alias ARN. When using an alias name, prefix it with
|
@@ -3016,8 +3052,8 @@ module Aws::KMS
|
|
3016
3052
|
include Aws::Structure
|
3017
3053
|
end
|
3018
3054
|
|
3019
|
-
# The request was rejected because a
|
3020
|
-
# information, see [
|
3055
|
+
# The request was rejected because a quota was exceeded. For more
|
3056
|
+
# information, see [Quotas][1] in the *AWS Key Management Service
|
3021
3057
|
# Developer Guide*.
|
3022
3058
|
#
|
3023
3059
|
#
|
@@ -3521,12 +3557,15 @@ module Aws::KMS
|
|
3521
3557
|
# visible][2] in the *AWS Identity and Access Management User
|
3522
3558
|
# Guide*.
|
3523
3559
|
#
|
3524
|
-
# The key policy
|
3560
|
+
# The key policy cannot exceed 32 kilobytes (32768 bytes). For more
|
3561
|
+
# information, see [Resource Quotas][3] in the *AWS Key Management
|
3562
|
+
# Service Developer Guide*.
|
3525
3563
|
#
|
3526
3564
|
#
|
3527
3565
|
#
|
3528
3566
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
|
3529
3567
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
|
3568
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html
|
3530
3569
|
# @return [String]
|
3531
3570
|
#
|
3532
3571
|
# @!attribute [rw] bypass_policy_lockout_safety_check
|
@@ -4328,18 +4367,24 @@ module Aws::KMS
|
|
4328
4367
|
# @return [String]
|
4329
4368
|
#
|
4330
4369
|
# @!attribute [rw] message
|
4331
|
-
# Specifies the message that was signed
|
4332
|
-
#
|
4333
|
-
#
|
4370
|
+
# Specifies the message that was signed. You can submit a raw message
|
4371
|
+
# of up to 4096 bytes, or a hash digest of the message. If you submit
|
4372
|
+
# a digest, use the `MessageType` parameter with a value of `DIGEST`.
|
4334
4373
|
#
|
4335
|
-
# If the
|
4336
|
-
#
|
4374
|
+
# If the message specified here is different from the message that was
|
4375
|
+
# signed, the signature verification fails. A message and its hash
|
4376
|
+
# digest are considered to be the same message.
|
4337
4377
|
# @return [String]
|
4338
4378
|
#
|
4339
4379
|
# @!attribute [rw] message_type
|
4340
4380
|
# Tells AWS KMS whether the value of the `Message` parameter is a
|
4341
|
-
# message or message digest.
|
4342
|
-
# indicate a message digest, enter `DIGEST`.
|
4381
|
+
# message or message digest. The default value, RAW, indicates a
|
4382
|
+
# message. To indicate a message digest, enter `DIGEST`.
|
4383
|
+
#
|
4384
|
+
# Use the `DIGEST` value only when the value of the `Message`
|
4385
|
+
# parameter is a message digest. If you use the `DIGEST` value with a
|
4386
|
+
# raw message, the security of the verification operation can be
|
4387
|
+
# compromised.
|
4343
4388
|
# @return [String]
|
4344
4389
|
#
|
4345
4390
|
# @!attribute [rw] signature
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kms
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.28.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:
|
11
|
+
date: 2020-01-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|