SSESpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.SSESpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SSESpecification
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents the settings used to enable server-side encryption.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SSESpecification()

Constructors
Constructor and Description
`SSESpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SSESpecification`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getEnabled()` Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK.
`String`	`getKMSMasterKeyId()` The KMS Customer Master Key (CMK) which should be used for the KMS encryption.
`String`	`getSSEType()` Server-side encryption type.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEnabled(Boolean enabled)` Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK.
`void`	`setKMSMasterKeyId(String kMSMasterKeyId)` The KMS Customer Master Key (CMK) which should be used for the KMS encryption.
`void`	`setSSEType(String sSEType)` Server-side encryption type.
`String`	`toString()` Returns a string representation of this object.
`SSESpecification`	`withEnabled(Boolean enabled)` Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK.
`SSESpecification`	`withKMSMasterKeyId(String kMSMasterKeyId)` The KMS Customer Master Key (CMK) which should be used for the KMS encryption.
`SSESpecification`	`withSSEType(SSEType sSEType)` Server-side encryption type.
`SSESpecification`	`withSSEType(String sSEType)` Server-side encryption type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SSESpecification
```
public SSESpecification()
```
- Method Detail
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
    
    Parameters:
    
    enabled - Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
  - getEnabled
```
public Boolean getEnabled()
```
    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
    
    Returns:
    
    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
  - withEnabled
```
public SSESpecification withEnabled(Boolean enabled)
```
    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
    
    Parameters:
    
    enabled - Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
    
    Returns:
    
    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
  - setSSEType
```
public void setSSEType(String sSEType)
```
    Server-side encryption type. The only supported value is:
    - KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    Parameters:
    sSEType - Server-side encryption type. The only supported value is:
    
    KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    See Also:
    
    SSEType
  - getSSEType
```
public String getSSEType()
```
    Server-side encryption type. The only supported value is:
    - KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    Returns:
    Server-side encryption type. The only supported value is:
    
    KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    See Also:
    
    SSEType
  - withSSEType
```
public SSESpecification withSSEType(String sSEType)
```
    Server-side encryption type. The only supported value is:
    - KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    Parameters:
    sSEType - Server-side encryption type. The only supported value is:
    
    KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SSEType
  - withSSEType
```
public SSESpecification withSSEType(SSEType sSEType)
```
    Server-side encryption type. The only supported value is:
    - KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    Parameters:
    sSEType - Server-side encryption type. The only supported value is:
    
    KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SSEType
  - setKMSMasterKeyId
```
public void setKMSMasterKeyId(String kMSMasterKeyId)
```
    The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.
    
    Parameters:
    
    kMSMasterKeyId - The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.
  - getKMSMasterKeyId
```
public String getKMSMasterKeyId()
```
    The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.
    
    Returns:
    
    The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.
  - withKMSMasterKeyId
```
public SSESpecification withKMSMasterKeyId(String kMSMasterKeyId)
```
    The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.
    
    Parameters:
    
    kMSMasterKeyId - The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SSESpecification clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SSESpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SSESpecification

Method Detail

setEnabled

getEnabled

withEnabled

isEnabled

setSSEType

getSSEType

withSSEType

withSSEType

setKMSMasterKeyId

getKMSMasterKeyId

withKMSMasterKeyId

toString

equals

hashCode

clone

marshall