Skip to content
v2.274.0

EncryptionConfigurationProperty Struct ​

Settings to configure server-side encryption for a state machine.

By default, Step Functions provides transparent server-side encryption. With this configuration, you can specify a customer managed AWS key for encryption.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const encryptionConfigurationProperty: stepfunctions.CfnStateMachine.EncryptionConfigurationProperty = {
  type: 'type',

  // the properties below are optional
  kmsDataKeyReusePeriodSeconds: 123,
  kmsKeyId: 'kmsKeyId',
};

Properties ​

kmsDataKeyReusePeriodSecondsnumberkms_data_key_reuse_period_secondsint | floatkmsDataKeyReusePeriodSecondsNumberKmsDataKeyReusePeriodSecondsdoubleKmsDataKeyReusePeriodSeconds*float64#
Maximum duration that Step Functions will reuse data keys.

When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.

kmsKeyIdstringkms_key_idstrkmsKeyIdStringKmsKeyIdstringKmsKeyId*string#
An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS key to encrypt data.

To specify a AWS key in a different AWS account, you must use the key ARN or alias ARN.

typestringtypestrtypeStringTypestringType*stringrequired#
Encryption option for a state machine.