/AWS1/CL_SFNENCRYPTIONCONF¶
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?
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_TYPE TYPE /AWS1/SFNENCRYPTIONTYPE /AWS1/SFNENCRYPTIONTYPE¶
Encryption type
Optional arguments:¶
IV_KMSKEYID TYPE /AWS1/SFNKMSKEYID /AWS1/SFNKMSKEYID¶
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.
IV_KMSDATAKEYREUSEPERSECONDS TYPE /AWS1/SFNKMSDATAKEYREUSEPERS00 /AWS1/SFNKMSDATAKEYREUSEPERS00¶
Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call
GenerateDataKey. Only applies to customer managed keys.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSDATAKEYREUSEPERSECS() |
Getter for KMSDATAKEYREUSEPERIODSECONDS, with configurable d |
ASK_KMSDATAKEYREUSEPERSECS() |
Getter for KMSDATAKEYREUSEPERIODSECONDS w/ exceptions if fie |
HAS_KMSDATAKEYREUSEPERSECS() |
Determine if KMSDATAKEYREUSEPERIODSECONDS has a value |
type¶
Encryption type
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |