EncryptRequest

public struct EncryptRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.

    Declaration

    Swift

    public let encryptionAlgorithm: EncryptionAlgorithmSpec?

  • Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

    Declaration

    Swift

    public let encryptionContext: [String : String]?

  • A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

    Declaration

    Swift

    public let grantTokens: [String]?

  • A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    Declaration

    Swift

    public let keyId: String

  • Data to be encrypted.

    Declaration

    Swift

    public let plaintext: Data

  • Undocumented

    Declaration

    Swift

    public init(encryptionAlgorithm: EncryptionAlgorithmSpec? = nil, encryptionContext: [String : String]? = nil, grantTokens: [String]? = nil, keyId: String, plaintext: Data)

  • Declaration

    Swift

    public func validate(name: String) throws