AWS CDK Reference

Appearance

v2.277.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.

Source
Generated code
Type last changed
v2.154.0 · 22 Aug 2024

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions

encryption_configuration_property = stepfunctions.CfnStateMachine.EncryptionConfigurationProperty(
    type="type",

    # the properties below are optional
    kms_data_key_reuse_period_seconds=123,
    kms_key_id="kmsKeyId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.stepfunctions.*;

EncryptionConfigurationProperty encryptionConfigurationProperty = EncryptionConfigurationProperty.builder()
        .type("type")

        // the properties below are optional
        .kmsDataKeyReusePeriodSeconds(123)
        .kmsKeyId("kmsKeyId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;

var encryptionConfigurationProperty = new EncryptionConfigurationProperty {
    Type = "type",

    // the properties below are optional
    KmsDataKeyReusePeriodSeconds = 123,
    KmsKeyId = "kmsKeyId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionConfigurationProperty := &EncryptionConfigurationProperty{
	Type: jsii.String("type"),

	// the properties below are optional
	KmsDataKeyReusePeriodSeconds: jsii.Number(123),
	KmsKeyId: jsii.String("kmsKeyId"),
}

Properties ​

kmsDataKeyReusePeriodSecondsoptionalnumberkms_data_key_reuse_period_secondsoptionalint | floatkmsDataKeyReusePeriodSecondsoptionalNumberKmsDataKeyReusePeriodSecondsoptionaldoubleKmsDataKeyReusePeriodSecondsoptional*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.

kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*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.