SetKeyRotationStatus Method
Enables or disables automatic key rotation for a CMK.
Syntax
ANSI (Cross Platform) int SetKeyRotationStatus(const char* lpszKeyId, int bEnabled); Unicode (Windows) INT SetKeyRotationStatus(LPCWSTR lpszKeyId, BOOL bEnabled);
- (void)setKeyRotationStatus:(NSString*)keyId :(BOOL)enabled;
#define MID_AMAZONKMS_SETKEYROTATIONSTATUS 27 CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonKMS_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method enables or disables automatic key material rotation for the CMK specified by KeyId.
The value passed for the KeyId parameter must be the Id or ARN of a CMK in the current account and Region.
This method will fail if any of the following are true regarding the specified CMK:
- Its KeyState is anything other than aksEnabled (0).
- It is asymmetric (see KeyKeySpec).
- It has imported key material (see KeyOrigin).
- It resides in a custom key store (see KeyCustomKeyStoreId).
- It is an AWS-managed CMK (see KeyAWSManaged).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)