Class EncryptionConfiguration

java.lang.Object
software.amazon.awssdk.services.sfn.model.EncryptionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class EncryptionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>

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:

  • Method Details

    • kmsKeyId

      public final 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.

      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.

    • kmsDataKeyReusePeriodSeconds

      public final 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.

      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.

    • type

      public final EncryptionType type()

      Encryption type

      If the service returns an enum value that is not available in the current SDK version, type will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Encryption type
      See Also:

    • typeAsString

      public final String typeAsString()

      Encryption type

      If the service returns an enum value that is not available in the current SDK version, type will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Encryption type
      See Also:

    • toBuilder

      public EncryptionConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static EncryptionConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EncryptionConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.