Package com.amazonaws.services.s3.model
Class KMSEncryptionMaterials
- java.lang.Object
-
- com.amazonaws.services.s3.model.EncryptionMaterials
-
- com.amazonaws.services.s3.model.KMSEncryptionMaterials
-
- All Implemented Interfaces:
Serializable
public class KMSEncryptionMaterials extends EncryptionMaterials implements Serializable
KMS specific encryption materials.The KEK has no relevance on the client-side, as KMS only requires the CMK id to be used to uniquely identify the KEK on the server side.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
CUSTOMER_MASTER_KEY_ID
Name of the material description to be persisted in S3 for the KMS's customer master key id.
-
Constructor Summary
Constructors Constructor Description KMSEncryptionMaterials(String defaultCustomerMasterKeyId)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCustomerMasterKeyId()
Returns the default KMS's Customer Master Key ID; or null if there isn't one.KeyPair
getKeyPair()
Always throwsUnsupportedOperationException
.SecretKey
getSymmetricKey()
Always throwsUnsupportedOperationException
.boolean
isKMSEnabled()
Returns true if this is a KMS material description; false otherwise.String
toString()
-
Methods inherited from class com.amazonaws.services.s3.model.EncryptionMaterials
addDescription, addDescriptions, getAccessor, getDescription, getMaterialsDescription
-
-
-
-
Field Detail
-
CUSTOMER_MASTER_KEY_ID
public static final String CUSTOMER_MASTER_KEY_ID
Name of the material description to be persisted in S3 for the KMS's customer master key id.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
KMSEncryptionMaterials
public KMSEncryptionMaterials(String defaultCustomerMasterKeyId)
- Parameters:
defaultCustomerMasterKeyId
- KMS's customer master key id; must not be null
-
-
Method Detail
-
getKeyPair
public final KeyPair getKeyPair()
Always throwsUnsupportedOperationException
.- Overrides:
getKeyPair
in classEncryptionMaterials
- Returns:
- the key pair stored in this EncryptionMaterials object.
-
getSymmetricKey
public final SecretKey getSymmetricKey()
Always throwsUnsupportedOperationException
.- Overrides:
getSymmetricKey
in classEncryptionMaterials
- Returns:
- the symmetric key stored in this EncryptionMaterials object.
-
isKMSEnabled
public final boolean isKMSEnabled()
Returns true if this is a KMS material description; false otherwise. Always returns true.- Overrides:
isKMSEnabled
in classEncryptionMaterials
- Returns:
- true
-
getCustomerMasterKeyId
public String getCustomerMasterKeyId()
Returns the default KMS's Customer Master Key ID; or null if there isn't one.- Overrides:
getCustomerMasterKeyId
in classEncryptionMaterials
-
-