Package software.amazon.awscdk.services.stepfunctions

Interface CfnActivityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnActivityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:17.504Z")
@Stability(Stable)
public interface CfnActivityProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnActivity.

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.*;
 CfnActivityProps cfnActivityProps = CfnActivityProps.builder()
         .name("name")
         // the properties below are optional
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .kmsDataKeyReusePeriodSeconds(123)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnActivityProps.Builder	builder()
default Object	getEncryptionConfiguration()	Encryption configuration for the activity.
String	getName()	The name of the activity.
default List<CfnActivity.TagsEntryProperty>	getTags()	The list of tags to add to a resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the activity.

A name must not contain:

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-name

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

Encryption configuration for the activity.

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 AWS CloudFormation template.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnActivity.TagsEntryProperty> getTags()

The list of tags to add to a resource.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-tags

builder

@Stability(Stable)
static CfnActivityProps.Builder builder()

Returns:

a CfnActivityProps.Builder of CfnActivityProps