AWSKMSRetireGrantRequest

Objective-C

@interface AWSKMSRetireGrantRequest

Swift

class AWSKMSRetireGrantRequest
  • Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

    • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantId;

    Swift

    var grantId: String? { get set }
  • Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

    Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the AWS Key Management Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantToken;

    Swift

    var grantToken: String? { get set }
  • The key ARN CMK associated with the grant. To find the key ARN, use the ListKeys operation.

    For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }