Skip to content
v2.275.0

CfnActivityProps Struct ​

Properties for defining a CfnActivity.

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 cfnActivityProps: stepfunctions.CfnActivityProps = {
  name: 'name',

  // the properties below are optional
  encryptionConfiguration: {
    type: 'type',

    // the properties below are optional
    kmsDataKeyReusePeriodSeconds: 123,
    kmsKeyId: 'kmsKeyId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

encryptionConfigurationoptionalIResolvable | CfnActivity.EncryptionConfigurationPropertyencryption_configurationoptionaltyping.Union[IResolvable, EncryptionConfigurationProperty]encryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalinterface{}#
Encryption configuration for the activity.
notes

Activity configuration is immutable, and resource names must be unique. To set customer managed keys for encryption, you must create a new Activity . If you attempt to change the configuration in your CFN template for an existing activity, you will receive an ActivityAlreadyExists exception.

To update your activity to include customer managed keys, set a new activity name within your CloudFormation template.

namestringnamestrnameStringNamestringName*stringrequired#
The name of the activity.
notes

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ $ & , ; : /`
  • control characters ( U+0000-001F , U+007F-009F , U+FFFE-FFFF )
  • surrogates ( U+D800-DFFF )
  • invalid characters ( U+10FFFF )

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

tagsoptionalCfnActivity.TagsEntryProperty[]tagsoptionaltyping.List[TagsEntryProperty]tagsoptionalList<TagsEntryProperty>TagsoptionalTagsEntryProperty[]Tagsoptional*[]TagsEntryProperty#
The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -