EncryptionConfiguration (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.stepfunctions.model

Class EncryptionConfiguration

java.lang.Object
- com.amazonaws.services.stepfunctions.model.EncryptionConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EncryptionConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Settings to configure server-side encryption.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines and activities. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine, and when creating an Activity. The execution history and state machine definition will be encrypted with the key applied to the State Machine. Activity inputs will be encrypted with the key applied to the Activity.

Step Functions automatically enables encryption at rest using Amazon Web Services owned keys at no charge. However, KMS charges apply when using a customer managed key. For more information about pricing, see Key Management Service pricing.

For more information on KMS, see What is Key Management Service?

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EncryptionConfiguration ()

Constructors
Constructor and Description
`EncryptionConfiguration ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`EncryptionConfiguration`	`clone ()`
`boolean`	`equals (Object obj)`
`Integer`	`getKmsDataKeyReusePeriodSeconds ()` Maximum duration that Step Functions will reuse data keys.
`String`	`getKmsKeyId ()` An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data.
`String`	`getType ()` Encryption type
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setKmsDataKeyReusePeriodSeconds (Integer kmsDataKeyReusePeriodSeconds)` Maximum duration that Step Functions will reuse data keys.
`void`	`setKmsKeyId (String kmsKeyId)` An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data.
`void`	`setType (String type)` Encryption type
`String`	`toString ()` Returns a string representation of this object.
`EncryptionConfiguration`	`withKmsDataKeyReusePeriodSeconds (Integer kmsDataKeyReusePeriodSeconds)` Maximum duration that Step Functions will reuse data keys.
`EncryptionConfiguration`	`withKmsKeyId (String kmsKeyId)` An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data.
`EncryptionConfiguration`	`withType (EncryptionType type)` Encryption type
`EncryptionConfiguration`	`withType (String type)` Encryption type

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

- Constructor Detail
  - EncryptionConfiguration
```
public EncryptionConfiguration()
```
- Method Detail
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    Parameters:
    
    kmsKeyId - An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    Returns:
    
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
  - withKmsKeyId
```
public EncryptionConfiguration withKmsKeyId(String kmsKeyId)
```
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    Parameters:
    
    kmsKeyId - An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsDataKeyReusePeriodSeconds
```
public void setKmsDataKeyReusePeriodSeconds(Integer kmsDataKeyReusePeriodSeconds)
```
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    Parameters:
    
    kmsDataKeyReusePeriodSeconds - Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
  - getKmsDataKeyReusePeriodSeconds
```
public Integer getKmsDataKeyReusePeriodSeconds()
```
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    Returns:
    
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
  - withKmsDataKeyReusePeriodSeconds
```
public EncryptionConfiguration withKmsDataKeyReusePeriodSeconds(Integer kmsDataKeyReusePeriodSeconds)
```
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    Parameters:
    
    kmsDataKeyReusePeriodSeconds - Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Encryption type
    
    Parameters:
    
    type - Encryption type
    
    See Also:
    
    EncryptionType
  - getType
```
public String getType()
```
    Encryption type
    
    Returns:
    
    Encryption type
    
    See Also:
    
    EncryptionType
  - withType
```
public EncryptionConfiguration withType(String type)
```
    Encryption type
    
    Parameters:
    
    type - Encryption type
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - withType
```
public EncryptionConfiguration withType(EncryptionType type)
```
    Encryption type
    
    Parameters:
    
    type - Encryption type
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - 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 EncryptionConfiguration 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class EncryptionConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncryptionConfiguration

Method Detail

setKmsKeyId

getKmsKeyId

withKmsKeyId

setKmsDataKeyReusePeriodSeconds

getKmsDataKeyReusePeriodSeconds

withKmsDataKeyReusePeriodSeconds

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall