Class: Aws::KMS::Types::EnableKeyRotationRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::EnableKeyRotationRequest

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.

• #rotation_period_in_days ⇒ Integer

  Use this parameter to specify a custom period of time between each rotation date.

Instance Attribute Details

#key_id ⇒ String

Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To enable or disable automatic rotation of a set of related [multi-Region keys], set the property 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 2266

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

#rotation_period_in_days ⇒ Integer

Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the default value is 365 days.

The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.

You can use the [ ‘kms:RotationPeriodInDays` ][1] condition key to further constrain the values that principals can specify in the `RotationPeriodInDays` parameter.

[1]: docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days

Returns:

• (Integer)

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

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