IncludeKeyDetails Property

Whether to attempt to retrieve full details when listing CMKs.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetIncludeKeyDetails();
int SetIncludeKeyDetails(int bIncludeKeyDetails);

Unicode (Windows)
BOOL GetIncludeKeyDetails();
INT SetIncludeKeyDetails(BOOL bIncludeKeyDetails);

@property (nonatomic,readwrite,assign,getter=includeKeyDetails,setter=setIncludeKeyDetails:) BOOL includeKeyDetails;
- (BOOL)includeKeyDetails;
- (void)setIncludeKeyDetails:(BOOL)newIncludeKeyDetails;

#define PID_AMAZONKMS_INCLUDEKEYDETAILS 17

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_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

FALSE

Remarks

This property specifies whether the class should make additional requests when ListKeys is called in order to retrieve full information for each CMK. By default, Amazon will only return the KeyARN and KeyId of each CMK.

If this property is enabled, then after the initial listing is returned, the class will call GetKeyInfo internally for each CMK returned. For all CMKs for which this call is successful, the additional information will be used to populate the Key* properties. Any CMKs for which the GetKeyInfo call fails will only have their KeyARN and KeyId properties populated, as usual.

This property is not available at design time.

Data Type

Boolean