aws-sdk-kms 1.117.0 → 1.118.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kms/client.rb +71 -38
- data/lib/aws-sdk-kms/types.rb +30 -15
- data/lib/aws-sdk-kms.rb +1 -1
- data/sig/types.rbs +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9e2a68224f5a86c92b415535c7bef7f87cf196d5dd5ffbd46a3a75724fb210fe
|
|
4
|
+
data.tar.gz: 87ba5536876bed1393d07de29b509be6684217d0397aa3981bec94cb5e573bb5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 26bfa9abee5b2cb9e02977f17a145247f4b1091d08a398864a5d84ff8b6849b026062b37a07e6c5e12dbb511f709628796200818a6e08e9e72e67197920b11ff
|
|
7
|
+
data.tar.gz: ddadc9d563a9613fa0f709ac71148ba6bf9449cf6e7848b0367484520ea6771ac6f38854ff1d230ce70455eed6706a9d05192d966d2d1e983f16fbb1c2cb5f33
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.118.0
|
data/lib/aws-sdk-kms/client.rb
CHANGED
|
@@ -3006,6 +3006,16 @@ module Aws::KMS
|
|
|
3006
3006
|
# operation does not change the KMS key's state. Otherwise, it changes
|
|
3007
3007
|
# the KMS key's state to `PendingImport`.
|
|
3008
3008
|
#
|
|
3009
|
+
# **Considerations for multi-Region symmetric encryption keys**
|
|
3010
|
+
#
|
|
3011
|
+
# * When you delete the key material of a primary Region key that is in
|
|
3012
|
+
# `PENDING_ROTATION` or
|
|
3013
|
+
# `PENDING_MULTI_REGION_IMPORT_AND_ROTATION`state, you'll also be
|
|
3014
|
+
# deleting the key materials for the replica Region keys.
|
|
3015
|
+
#
|
|
3016
|
+
# * If you delete any key material of a replica Region key, the primary
|
|
3017
|
+
# Region key and other replica Region keys remain unchanged.
|
|
3018
|
+
#
|
|
3009
3019
|
# The KMS key that you use for this operation must be in a compatible
|
|
3010
3020
|
# key state. For details, see [Key states of KMS keys][2] in the *Key
|
|
3011
3021
|
# Management Service Developer Guide*.
|
|
@@ -6789,10 +6799,28 @@ module Aws::KMS
|
|
|
6789
6799
|
# information about importing key material, see [Importing key
|
|
6790
6800
|
# material][1].
|
|
6791
6801
|
#
|
|
6792
|
-
# For asymmetric
|
|
6793
|
-
#
|
|
6794
|
-
#
|
|
6795
|
-
#
|
|
6802
|
+
# For asymmetric and HMAC keys, you cannot change the key material after
|
|
6803
|
+
# the initial import. You can import multiple key materials into
|
|
6804
|
+
# symmetric encryption keys and rotate the key material on demand using
|
|
6805
|
+
# `RotateKeyOnDemand`.
|
|
6806
|
+
#
|
|
6807
|
+
# You can import new key materials into multi-Region symmetric
|
|
6808
|
+
# encryption keys. To do so, you must import the new key material into
|
|
6809
|
+
# the primary Region key. Then you can import the same key materials
|
|
6810
|
+
# into the replica Region keys. You cannot directly import new key
|
|
6811
|
+
# material into the replica Region keys.
|
|
6812
|
+
#
|
|
6813
|
+
# To import new key material for a multi-Region symmetric key, you’ll
|
|
6814
|
+
# need to complete the following:
|
|
6815
|
+
#
|
|
6816
|
+
# 1. Call `ImportKeyMaterial` on the primary Region key with the
|
|
6817
|
+
# `ImportType`set to `NEW_KEY_MATERIAL`.
|
|
6818
|
+
#
|
|
6819
|
+
# 2. Call `ImportKeyMaterial` on the replica Region key with the
|
|
6820
|
+
# `ImportType` set to `EXISTING_KEY_MATERIAL` using the same key
|
|
6821
|
+
# material imported to the primary Region key. You must do this for
|
|
6822
|
+
# every replica Region key before you can perform the
|
|
6823
|
+
# RotateKeyOnDemand operation on the primary Region key.
|
|
6796
6824
|
#
|
|
6797
6825
|
# After you import key material, you can [reimport the same key
|
|
6798
6826
|
# material][2] into that KMS key or, if the key supports on-demand
|
|
@@ -6834,10 +6862,10 @@ module Aws::KMS
|
|
|
6834
6862
|
#
|
|
6835
6863
|
# * The key ID or key ARN of the KMS key to associate with the imported
|
|
6836
6864
|
# key material. Its `Origin` must be `EXTERNAL` and its `KeyState`
|
|
6837
|
-
# must be `PendingImport`. You cannot perform this
|
|
6838
|
-
# key in a [custom key store][5], or on a KMS key
|
|
6839
|
-
# Amazon Web Services account. To get the `Origin` and
|
|
6840
|
-
# KMS key, call DescribeKey.
|
|
6865
|
+
# must be `PendingImport` or `Enabled`. You cannot perform this
|
|
6866
|
+
# operation on a KMS key in a [custom key store][5], or on a KMS key
|
|
6867
|
+
# in a different Amazon Web Services account. To get the `Origin` and
|
|
6868
|
+
# `KeyState` of a KMS key, call DescribeKey.
|
|
6841
6869
|
#
|
|
6842
6870
|
# * The encrypted key material.
|
|
6843
6871
|
#
|
|
@@ -6857,13 +6885,12 @@ module Aws::KMS
|
|
|
6857
6885
|
# Each time you reimport, you can eliminate or reset the expiration
|
|
6858
6886
|
# time.
|
|
6859
6887
|
#
|
|
6860
|
-
# When this operation is successful, the
|
|
6861
|
-
#
|
|
6862
|
-
#
|
|
6863
|
-
#
|
|
6864
|
-
# the
|
|
6865
|
-
#
|
|
6866
|
-
# key material associated with a KMS key.
|
|
6888
|
+
# When this operation is successful, the state of the KMS key changes to
|
|
6889
|
+
# `Enabled`, and you can use the KMS key in cryptographic operations.
|
|
6890
|
+
# For symmetric encryption keys, you will need to import all of the key
|
|
6891
|
+
# materials associated with the KMS key to change its state to
|
|
6892
|
+
# `Enabled`. Use the `ListKeyRotations` operation to list the ID and
|
|
6893
|
+
# import state of each key material associated with a KMS key.
|
|
6867
6894
|
#
|
|
6868
6895
|
# If this operation fails, use the exception to help determine the
|
|
6869
6896
|
# problem. If the error is related to the key material, the import
|
|
@@ -6991,6 +7018,12 @@ module Aws::KMS
|
|
|
6991
7018
|
# material is imported, if this parameter is omitted then the parameter
|
|
6992
7019
|
# defaults to `EXISTING_KEY_MATERIAL`.
|
|
6993
7020
|
#
|
|
7021
|
+
# For multi-Region keys, you must first import new key material into the
|
|
7022
|
+
# primary Region key. You should use the `NEW_KEY_MATERIAL` import type
|
|
7023
|
+
# when importing key material into the primary Region key. Then, you can
|
|
7024
|
+
# import the same key material into the replica Region key. The import
|
|
7025
|
+
# type for the replica Region key should be `EXISTING_KEY_MATERIAL`.
|
|
7026
|
+
#
|
|
6994
7027
|
# @option params [String] :key_material_description
|
|
6995
7028
|
# Description for the key material being imported. This parameter is
|
|
6996
7029
|
# optional and only usable with symmetric encryption keys. If you do not
|
|
@@ -7687,7 +7720,7 @@ module Aws::KMS
|
|
|
7687
7720
|
# resp.rotations[0].key_material_id #=> String
|
|
7688
7721
|
# resp.rotations[0].key_material_description #=> String
|
|
7689
7722
|
# resp.rotations[0].import_state #=> String, one of "IMPORTED", "PENDING_IMPORT"
|
|
7690
|
-
# resp.rotations[0].key_material_state #=> String, one of "NON_CURRENT", "CURRENT", "PENDING_ROTATION"
|
|
7723
|
+
# resp.rotations[0].key_material_state #=> String, one of "NON_CURRENT", "CURRENT", "PENDING_ROTATION", "PENDING_MULTI_REGION_IMPORT_AND_ROTATION"
|
|
7691
7724
|
# resp.rotations[0].expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
|
|
7692
7725
|
# resp.rotations[0].valid_to #=> Time
|
|
7693
7726
|
# resp.rotations[0].rotation_date #=> Time
|
|
@@ -9220,30 +9253,31 @@ module Aws::KMS
|
|
|
9220
9253
|
#
|
|
9221
9254
|
# On-demand key rotation is supported only on symmetric encryption KMS
|
|
9222
9255
|
# keys. You cannot perform on-demand rotation of [asymmetric KMS
|
|
9223
|
-
# keys][3], [HMAC KMS keys][4],
|
|
9224
|
-
#
|
|
9225
|
-
#
|
|
9226
|
-
#
|
|
9227
|
-
# material][7] and that key material's state should be
|
|
9256
|
+
# keys][3], [HMAC KMS keys][4], or KMS keys in a [custom key store][5].
|
|
9257
|
+
# When you initiate on-demand key rotation on a symmetric encryption KMS
|
|
9258
|
+
# key with imported key material, you must have already imported [new
|
|
9259
|
+
# key material][6] and that key material's state should be
|
|
9228
9260
|
# `PENDING_ROTATION`. Use the `ListKeyRotations` operation to check the
|
|
9229
9261
|
# state of all key materials associated with a KMS key. To perform
|
|
9230
|
-
# on-demand rotation of a set of related [multi-Region keys][
|
|
9231
|
-
#
|
|
9262
|
+
# on-demand rotation of a set of related [multi-Region keys][7], import
|
|
9263
|
+
# new key material in the primary Region key, import the same key
|
|
9264
|
+
# material in each replica Region key, and invoke the on-demand rotation
|
|
9265
|
+
# on the primary Region key.
|
|
9232
9266
|
#
|
|
9233
9267
|
# You cannot initiate on-demand rotation of [Amazon Web Services managed
|
|
9234
|
-
# KMS keys][
|
|
9268
|
+
# KMS keys][8]. KMS always rotates the key material of Amazon Web
|
|
9235
9269
|
# Services managed keys every year. Rotation of [Amazon Web Services
|
|
9236
|
-
# owned KMS keys][
|
|
9270
|
+
# owned KMS keys][9] is managed by the Amazon Web Services service that
|
|
9237
9271
|
# owns the key.
|
|
9238
9272
|
#
|
|
9239
9273
|
# The KMS key that you use for this operation must be in a compatible
|
|
9240
|
-
# key state. For details, see [Key states of KMS keys][
|
|
9274
|
+
# key state. For details, see [Key states of KMS keys][10] in the *Key
|
|
9241
9275
|
# Management Service Developer Guide*.
|
|
9242
9276
|
#
|
|
9243
9277
|
# **Cross-account use**: No. You cannot perform this operation on a KMS
|
|
9244
9278
|
# key in a different Amazon Web Services account.
|
|
9245
9279
|
#
|
|
9246
|
-
# **Required permissions**: [kms:RotateKeyOnDemand][
|
|
9280
|
+
# **Required permissions**: [kms:RotateKeyOnDemand][11] (key policy)
|
|
9247
9281
|
#
|
|
9248
9282
|
# **Related operations:**
|
|
9249
9283
|
#
|
|
@@ -9258,7 +9292,7 @@ module Aws::KMS
|
|
|
9258
9292
|
# * ListKeyRotations
|
|
9259
9293
|
#
|
|
9260
9294
|
# **Eventual consistency**: The KMS API follows an eventual consistency
|
|
9261
|
-
# model. For more information, see [KMS eventual consistency][
|
|
9295
|
+
# model. For more information, see [KMS eventual consistency][12].
|
|
9262
9296
|
#
|
|
9263
9297
|
#
|
|
9264
9298
|
#
|
|
@@ -9266,15 +9300,14 @@ module Aws::KMS
|
|
|
9266
9300
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html
|
|
9267
9301
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
|
9268
9302
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
|
|
9269
|
-
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
9270
|
-
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-
|
|
9271
|
-
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
9272
|
-
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
9273
|
-
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-
|
|
9274
|
-
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
9275
|
-
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
9276
|
-
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-
|
|
9277
|
-
# [13]: https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency
|
|
9303
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
9304
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html
|
|
9305
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate
|
|
9306
|
+
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key
|
|
9307
|
+
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-key
|
|
9308
|
+
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
|
9309
|
+
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
|
9310
|
+
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency
|
|
9278
9311
|
#
|
|
9279
9312
|
# @option params [required, String] :key_id
|
|
9280
9313
|
# Identifies a symmetric encryption KMS key. You cannot perform
|
|
@@ -11124,7 +11157,7 @@ module Aws::KMS
|
|
|
11124
11157
|
tracer: tracer
|
|
11125
11158
|
)
|
|
11126
11159
|
context[:gem_name] = 'aws-sdk-kms'
|
|
11127
|
-
context[:gem_version] = '1.
|
|
11160
|
+
context[:gem_version] = '1.118.0'
|
|
11128
11161
|
Seahorse::Client::Request.new(handlers, context)
|
|
11129
11162
|
end
|
|
11130
11163
|
|
data/lib/aws-sdk-kms/types.rb
CHANGED
|
@@ -3993,6 +3993,13 @@ module Aws::KMS
|
|
|
3993
3993
|
# the parameter defaults to `NEW_KEY_MATERIAL`. After the first key
|
|
3994
3994
|
# material is imported, if this parameter is omitted then the
|
|
3995
3995
|
# parameter defaults to `EXISTING_KEY_MATERIAL`.
|
|
3996
|
+
#
|
|
3997
|
+
# For multi-Region keys, you must first import new key material into
|
|
3998
|
+
# the primary Region key. You should use the `NEW_KEY_MATERIAL` import
|
|
3999
|
+
# type when importing key material into the primary Region key. Then,
|
|
4000
|
+
# you can import the same key material into the replica Region key.
|
|
4001
|
+
# The import type for the replica Region key should be
|
|
4002
|
+
# `EXISTING_KEY_MATERIAL`.
|
|
3996
4003
|
# @return [String]
|
|
3997
4004
|
#
|
|
3998
4005
|
# @!attribute [rw] key_material_description
|
|
@@ -4576,12 +4583,11 @@ module Aws::KMS
|
|
|
4576
4583
|
#
|
|
4577
4584
|
# @!attribute [rw] current_key_material_id
|
|
4578
4585
|
# Identifies the current key material. This value is present for
|
|
4579
|
-
# symmetric encryption keys with `AWS_KMS` origin
|
|
4580
|
-
#
|
|
4581
|
-
#
|
|
4582
|
-
# key
|
|
4583
|
-
# material for
|
|
4584
|
-
# material for decryption operations only.
|
|
4586
|
+
# symmetric encryption keys with `AWS_KMS` or `EXTERNAL` origin. These
|
|
4587
|
+
# KMS keys support automatic or on-demand key rotation and can have
|
|
4588
|
+
# multiple key materials associated with them. KMS uses the current
|
|
4589
|
+
# key material for both encryption and decryption, and the non-current
|
|
4590
|
+
# key material for decryption operations only.
|
|
4585
4591
|
# @return [String]
|
|
4586
4592
|
#
|
|
4587
4593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyMetadata AWS API Documentation
|
|
@@ -6001,15 +6007,24 @@ module Aws::KMS
|
|
|
6001
6007
|
# @return [String]
|
|
6002
6008
|
#
|
|
6003
6009
|
# @!attribute [rw] key_material_state
|
|
6004
|
-
# There are
|
|
6005
|
-
# `NON_CURRENT
|
|
6006
|
-
#
|
|
6007
|
-
#
|
|
6008
|
-
# material that has been
|
|
6009
|
-
#
|
|
6010
|
-
#
|
|
6011
|
-
#
|
|
6012
|
-
#
|
|
6010
|
+
# There are four possible values for this field: `CURRENT`,
|
|
6011
|
+
# `NON_CURRENT`, `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` and
|
|
6012
|
+
# `PENDING_ROTATION`. KMS uses `CURRENT` key material for both
|
|
6013
|
+
# encryption and decryption and `NON_CURRENT` key material only for
|
|
6014
|
+
# decryption. `PENDING_ROTATION` identifies key material that has been
|
|
6015
|
+
# imported for on-demand key rotation but the rotation hasn't
|
|
6016
|
+
# completed. The key material state
|
|
6017
|
+
# `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` is unique to
|
|
6018
|
+
# multi-region, symmetric encryption keys with imported key material.
|
|
6019
|
+
# It indicates key material that has been imported into the primary
|
|
6020
|
+
# Region key but not all of the replica Region keys. When this key
|
|
6021
|
+
# material is imported in to all of the replica Region keys, the key
|
|
6022
|
+
# material state will change to `PENDING_ROTATION`. Key material in
|
|
6023
|
+
# `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` or `PENDING_ROTATION`
|
|
6024
|
+
# state is not permanently associated with the KMS key. You can delete
|
|
6025
|
+
# this key material and import different key material in its place.
|
|
6026
|
+
# The `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` and
|
|
6027
|
+
# `PENDING_ROTATION` values are only used in symmetric encryption keys
|
|
6013
6028
|
# with imported key material. The other values, `CURRENT` and
|
|
6014
6029
|
# `NON_CURRENT`, are used for all KMS keys that support automatic or
|
|
6015
6030
|
# on-demand key rotation.
|
data/lib/aws-sdk-kms.rb
CHANGED
data/sig/types.rbs
CHANGED
|
@@ -846,7 +846,7 @@ module Aws::KMS
|
|
|
846
846
|
attr_accessor key_material_id: ::String
|
|
847
847
|
attr_accessor key_material_description: ::String
|
|
848
848
|
attr_accessor import_state: ("IMPORTED" | "PENDING_IMPORT")
|
|
849
|
-
attr_accessor key_material_state: ("NON_CURRENT" | "CURRENT" | "PENDING_ROTATION")
|
|
849
|
+
attr_accessor key_material_state: ("NON_CURRENT" | "CURRENT" | "PENDING_ROTATION" | "PENDING_MULTI_REGION_IMPORT_AND_ROTATION")
|
|
850
850
|
attr_accessor expiration_model: ("KEY_MATERIAL_EXPIRES" | "KEY_MATERIAL_DOES_NOT_EXPIRE")
|
|
851
851
|
attr_accessor valid_to: ::Time
|
|
852
852
|
attr_accessor rotation_date: ::Time
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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.118.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Amazon Web Services
|
|
@@ -18,7 +18,7 @@ dependencies:
|
|
|
18
18
|
version: '3'
|
|
19
19
|
- - ">="
|
|
20
20
|
- !ruby/object:Gem::Version
|
|
21
|
-
version: 3.
|
|
21
|
+
version: 3.239.1
|
|
22
22
|
type: :runtime
|
|
23
23
|
prerelease: false
|
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -28,7 +28,7 @@ dependencies:
|
|
|
28
28
|
version: '3'
|
|
29
29
|
- - ">="
|
|
30
30
|
- !ruby/object:Gem::Version
|
|
31
|
-
version: 3.
|
|
31
|
+
version: 3.239.1
|
|
32
32
|
- !ruby/object:Gem::Dependency
|
|
33
33
|
name: aws-sigv4
|
|
34
34
|
requirement: !ruby/object:Gem::Requirement
|