Package software.amazon.awscdk.services.stepfunctions

Interface CfnActivity.EncryptionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnActivity.EncryptionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnActivity

@Stability(Stable)
public static interface CfnActivity.EncryptionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Settings to configure server-side encryption for an activity.

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

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnActivity.EncryptionConfigurationProperty.Builder	A builder for CfnActivity.EncryptionConfigurationProperty
static final class	CfnActivity.EncryptionConfigurationProperty.Jsii$Proxy	An implementation for CfnActivity.EncryptionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnActivity.EncryptionConfigurationProperty.Builder	builder()
default Number	getKmsDataKeyReusePeriodSeconds()	Maximum duration that Step Functions will reuse data keys.
default String	getKmsKeyId()	An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data.
String	getType()	Encryption option for an activity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

Encryption option for an activity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-type

getKmsDataKeyReusePeriodSeconds

@Stability(Stable)
@Nullable
default Number 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmsdatakeyreuseperiodseconds

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmskeyid

builder

@Stability(Stable)
static CfnActivity.EncryptionConfigurationProperty.Builder builder()

Returns:

a CfnActivity.EncryptionConfigurationProperty.Builder of CfnActivity.EncryptionConfigurationProperty