/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the kms-2014-11-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.KeyManagementService.Model
{
///
/// Container for the parameters to the DisableKeyRotation operation.
/// Disables automatic
/// rotation of the key material of the specified symmetric encryption KMS key.
///
///
///
/// Automatic key rotation is supported only on symmetric encryption KMS keys. 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.
///
///
///
/// You can enable (EnableKeyRotation) and disable automatic rotation of the key
/// material in customer
/// managed KMS keys. Key material rotation of Amazon
/// Web Services managed KMS keys is not configurable. KMS always rotates the key
/// material for every year. Rotation of Amazon
/// Web Services owned KMS keys varies.
///
///
///
/// In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys
/// from every three years to every year. For details, see EnableKeyRotation.
///
///
///
/// The KMS key that you use for this operation must be in a compatible key state. For
/// details, see Key
/// states of KMS keys in the Key Management Service Developer Guide.
///
///
///
/// Cross-account use: No. You cannot perform this operation on a KMS key in a
/// different Amazon Web Services account.
///
///
///
/// Required permissions: kms:DisableKeyRotation
/// (key policy)
///
///
///
/// Related operations:
///
///
///
public partial class DisableKeyRotationRequest : AmazonKeyManagementServiceRequest
{
private string _keyId;
///
/// Gets and sets the property KeyId.
///
/// Identifies a symmetric encryption KMS key. You cannot enable or disable automatic
/// rotation of asymmetric
/// KMS keys, HMAC
/// KMS keys, KMS keys with imported
/// key material, or KMS keys in a custom
/// key store.
///
///
///
/// 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.
///
///
[AWSProperty(Required=true, Min=1, Max=2048)]
public string KeyId
{
get { return this._keyId; }
set { this._keyId = value; }
}
// Check to see if KeyId property is set
internal bool IsSetKeyId()
{
return this._keyId != null;
}
}
}