Package software.amazon.awscdk.services.stepfunctions

Class CfnActivity

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.stepfunctions.CfnActivity
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-27T16:51:05.884Z") @Stability(Stable) public class CfnActivity extends CfnResource implements IInspectable, ITaggable
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 .

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.*;
 CfnActivity cfnActivity = CfnActivity.Builder.create(this, "MyCfnActivity")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnActivity

      protected CfnActivity(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnActivity

      protected CfnActivity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnActivity

      @Stability(Stable) public CfnActivity(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnActivityProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the ARN of the resource.

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      Returns the name of the activity. For example:.

      { "Fn::GetAtt": ["MyActivity", "Name"] }

      Returns a value similar to the following:

      myActivity

      For more information about using Fn::GetAtt , see Fn::GetAtt .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the activity.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the activity.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      Encryption configuration for the activity.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      Encryption configuration for the activity.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnActivity.EncryptionConfigurationProperty value)
      Encryption configuration for the activity.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnActivity.TagsEntryProperty> getTagsRaw()
      The list of tags to add to a resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnActivity.TagsEntryProperty> value)
      The list of tags to add to a resource.