Class: Aws::KMS::Types::RotateKeyOnDemandRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::RotateKeyOnDemandRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_id ⇒ String

  Identifies a symmetric encryption KMS key.

Instance Attribute Details

#key_id ⇒ String

Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To perform on-demand rotation of a set of related [multi-Region keys], invoke the on-demand rotation on the primary key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`

• Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

[1]: docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html [2]: docs.aws.amazon.com/kms/latest/developerguide/hmac.html [3]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html [4]: docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html [5]: docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 5703

class RotateKeyOnDemandRequest < Struct.new(
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end