@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:42.372Z") @Stability(value=Stable) public class CfnActivity extends CfnResource implements IInspectable
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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnActivity.Builder
A fluent builder for
CfnActivity. |
static interface |
CfnActivity.TagsEntryProperty
The `TagsEntry` property specifies *tags* to identify an activity.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnActivity(software.constructs.Construct scope,
String id,
CfnActivityProps props)
Create a new `AWS::StepFunctions::Activity`.
|
protected |
CfnActivity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnActivity(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAttrArn() |
String |
getAttrName()
Returns the name of the activity.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getName()
The name of the activity.
|
TagManager |
getTags()
The list of tags to add to a resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setName(String value)
The name of the activity.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnActivity(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnActivity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnActivity(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnActivityProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrName()
{ "Fn::GetAtt": ["MyActivity", "Name"] }
Returns a value similar to the following:
myActivity
For more information about using Fn::GetAtt , see Fn::GetAtt .
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .
@Stability(value=Stable) @NotNull public String getName()
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ $ & , ; : /`U+0000-001F , U+007F-009F )To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
@Stability(value=Stable)
public void setName(@NotNull
String value)
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ $ & , ; : /`U+0000-001F , U+007F-009F )To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
Copyright © 2022. All rights reserved.