Class CfnActivity

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnActivity
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnActivity : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnActivity
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;

var cfnActivity = new CfnActivity(this, "MyCfnActivity", new CfnActivityProps {
    Name = "name",

    // the properties below are optional
    EncryptionConfiguration = new EncryptionConfigurationProperty {
        Type = "type",

        // the properties below are optional
        KmsDataKeyReusePeriodSeconds = 123,
        KmsKeyId = "kmsKeyId"
    },
    Tags = new [] { new TagsEntryProperty {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnActivity(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnActivity(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnActivity(Construct, String, ICfnActivityProps)

Properties

AttrArn

Returns the ARN of the resource.
AttrName

Returns the name of the activity. For example:.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
EncryptionConfiguration

Encryption configuration for the activity.
Name

The name of the activity.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The list of tags to add to a resource.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnActivity(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnActivity(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnActivity(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnActivity(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnActivity(Construct, String, ICfnActivityProps)

public CfnActivity(Construct scope, string id, ICfnActivityProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnActivityProps

Resource properties.

Properties

AttrArn

Returns the ARN of the resource.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrName

Returns the name of the activity. For example:.

public virtual string AttrName { get; }
Property Value

System.String

Remarks

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

Returns a value similar to the following:

myActivity

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

CloudformationAttribute: Name

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

EncryptionConfiguration

Encryption configuration for the activity.

public virtual object EncryptionConfiguration { get; set; }
Property Value

System.Object

Name

The name of the activity.

public virtual string Name { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

The list of tags to add to a resource.

public virtual CfnActivity.ITagsEntryProperty[] TagsRaw { get; set; }
Property Value

CfnActivity.ITagsEntryProperty[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements