Class CfnStateMachine

Provisions a state machine.

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

A state machine consists of a collection of states that can do work ( Task states), determine to which states to transition next ( Choice states), stop an execution with an error ( Fail states), and so on. State machines are specified using a JSON-based, structured language.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html

CloudformationResource: AWS::StepFunctions::StateMachine

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 definition;

var cfnStateMachine = new CfnStateMachine(this, "MyCfnStateMachine", new CfnStateMachineProps {
    RoleArn = "roleArn",

    // the properties below are optional
    Definition = definition,
    DefinitionS3Location = new S3LocationProperty {
        Bucket = "bucket",
        Key = "key",

        // the properties below are optional
        Version = "version"
    },
    DefinitionString = "definitionString",
    DefinitionSubstitutions = new Dictionary<string, string> {
        { "definitionSubstitutionsKey", "definitionSubstitutions" }
    },
    EncryptionConfiguration = new EncryptionConfigurationProperty {
        Type = "type",

        // the properties below are optional
        KmsDataKeyReusePeriodSeconds = 123,
        KmsKeyId = "kmsKeyId"
    },
    LoggingConfiguration = new LoggingConfigurationProperty {
        Destinations = new [] { new LogDestinationProperty {
            CloudWatchLogsLogGroup = new CloudWatchLogsLogGroupProperty {
                LogGroupArn = "logGroupArn"
            }
        } },
        IncludeExecutionData = false,
        Level = "level"
    },
    StateMachineName = "stateMachineName",
    StateMachineType = "stateMachineType",
    Tags = new [] { new TagsEntryProperty {
        Key = "key",
        Value = "value"
    } },
    TracingConfiguration = new TracingConfigurationProperty {
        Enabled = false
    }
});

Synopsis

Constructors

CfnStateMachine(ByRefValue)

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

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

Properties

AttrArn

Returns the ARN of the resource.
AttrName

Returns the name of the state machine. For example:.
AttrStateMachineRevisionId

Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
CFN_RESOURCE_TYPE_NAME

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

The Amazon States Language definition of the state machine.
DefinitionS3Location

The name of the S3 bucket where the state machine definition is stored.
DefinitionString

The Amazon States Language definition of the state machine.
DefinitionSubstitutions

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
EncryptionConfiguration

Encryption configuration for the state machine.
LoggingConfiguration

Defines what execution history events are logged and where they are logged.
RoleArn

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
StateMachineName

The name of the state machine.
StateMachineType

Determines whether a STANDARD or EXPRESS state machine is created.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The list of tags to add to a resource.
TracingConfiguration

Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Methods

Inspect(TreeInspector)

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

Constructors

CfnStateMachine(ByRefValue)

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

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

The Javascript-owned object reference

CfnStateMachine(DeputyBase.DeputyProps)

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

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

The deputy props

CfnStateMachine(Construct, String, ICfnStateMachineProps)

public CfnStateMachine(Construct scope, string id, ICfnStateMachineProps 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 ICfnStateMachineProps

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 state machine. For example:.

public virtual string AttrName { get; }
Property Value

System.String

Remarks

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

Returns the name of your state machine:

HelloWorld-StateMachine

If you did not specify the name it will be similar to the following:

MyStateMachine-1234abcdefgh

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

CloudformationAttribute: Name

AttrStateMachineRevisionId

Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.

public virtual string AttrStateMachineRevisionId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: StateMachineRevisionId

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

Definition

The Amazon States Language definition of the state machine.

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

System.Object

DefinitionS3Location

The name of the S3 bucket where the state machine definition is stored.

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

System.Object

DefinitionString

The Amazon States Language definition of the state machine.

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

System.String

DefinitionSubstitutions

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.

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

System.Object

EncryptionConfiguration

Encryption configuration for the state machine.

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

System.Object

LoggingConfiguration

Defines what execution history events are logged and where they are logged.

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

System.Object

RoleArn

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

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

System.String

StateMachineName

The name of the state machine.

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

System.String

StateMachineType

Determines whether a STANDARD or EXPRESS state machine is created.

public virtual string StateMachineType { 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 CfnStateMachine.ITagsEntryProperty[] TagsRaw { get; set; }
Property Value

CfnStateMachine.ITagsEntryProperty[]

TracingConfiguration

Selects whether or not the state machine's AWS X-Ray tracing is enabled.

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

System.Object

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