Package software.amazon.awscdk.services.stepfunctions

Class CfnActivity

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.stepfunctions.CfnActivity
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.859Z") @Stability(Stable) public class CfnActivity extends CfnResource implements IInspectable
A CloudFormation AWS::StepFunctions::Activity.

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 lets Step Functions know the existence 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
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnActivityProps props)
      Create a new AWS::StepFunctions::Activity.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()

    • 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()
      The list of tags to add to a resource.

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

    • getName

      @Stability(Stable) @NotNull public 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 _.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      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 _.