CfnActivityPropsMixin

class aws_cdk.mixins_preview.aws_stepfunctions.mixins.CfnActivityPropsMixin(props, *, strategy=None)

Bases: Mixin

An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions .

Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function makes Step Functions aware of your activity and returns an identifier for use in a state machine and when polling from the activity.

For information about creating an activity, see Creating an Activity State Machine in the AWS Step Functions Developer Guide and CreateActivity in the AWS Step Functions API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html
CloudformationResource:: AWS::StepFunctions::Activity
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

cfn_activity_props_mixin = stepfunctions_mixins.CfnActivityPropsMixin(stepfunctions_mixins.CfnActivityMixinProps(
    encryption_configuration=stepfunctions_mixins.CfnActivityPropsMixin.EncryptionConfigurationProperty(
        kms_data_key_reuse_period_seconds=123,
        kms_key_id="kmsKeyId",
        type="type"
    ),
    name="name",
    tags=[stepfunctions_mixins.CfnActivityPropsMixin.TagsEntryProperty(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::StepFunctions::Activity.

Parameters:

props (Union[CfnActivityMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['encryptionConfiguration', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

EncryptionConfigurationProperty

class CfnActivityPropsMixin.EncryptionConfigurationProperty(*, kms_data_key_reuse_period_seconds=None, kms_key_id=None, type=None)

Bases: object

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 key for encryption.

Parameters:

kms_data_key_reuse_period_seconds (Union[int, float, None]) – Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.
kms_key_id (Optional[str]) – 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.
type (Optional[str]) – Encryption option for an activity.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

encryption_configuration_property = stepfunctions_mixins.CfnActivityPropsMixin.EncryptionConfigurationProperty(
    kms_data_key_reuse_period_seconds=123,
    kms_key_id="kmsKeyId",
    type="type"
)

Attributes

kms_data_key_reuse_period_seconds

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmsdatakeyreuseperiodseconds

kms_key_id

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.

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

type

Encryption option for an activity.

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

TagsEntryProperty

class CfnActivityPropsMixin.TagsEntryProperty(*, key=None, value=None)

Bases: object

The TagsEntry property specifies tags to identify an activity.

Parameters:

key (Optional[str]) – The key for a key-value pair in a tag entry.
value (Optional[str]) – The value for a key-value pair in a tag entry.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

tags_entry_property = stepfunctions_mixins.CfnActivityPropsMixin.TagsEntryProperty(
    key="key",
    value="value"
)

Attributes

key

The key for a key-value pair in a tag entry.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-key

value

The value for a key-value pair in a tag entry.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-value