KeyOrigin Property

The origin of the CMK's key material.

Syntax

ANSI (Cross Platform)
int GetKeyOrigin(int iKeyIndex);

Unicode (Windows)
INT GetKeyOrigin(INT iKeyIndex);

Possible Values

AKO_KMS(0), 
AKO_EXTERNAL(1), 
AKO_CLOUD_HSM(2)
- (int)keyOrigin:(int)keyIndex;

Possible Values

AKO_KMS(0), 
AKO_EXTERNAL(1), 
AKO_CLOUD_HSM(2)
#define PID_AMAZONKMS_KEYORIGIN 43

CLOUDKEYS_EXTERNAL void* CLOUDKEYS_CALL CloudKeys_AmazonKMS_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonKMS_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

0

Remarks

The origin of the CMK's key material.

This property reflects the origin of the CMK's key material. Possible values are:

  • akoKMS (0): Key material from Amazon KMS. (Also the default value used when ListKeys is called.)
  • akoExternal (1): External key material imported into Amazon KMS.
  • akoCloudHSM (2): Key material from an Amazon CloudHSM cluster.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer
Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]