Class CfnStateMachine

Provisions a state machine.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnStateMachine

Implements

IInspectable

IStateMachineRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnStateMachine : CfnResource, IInspectable, IStateMachineRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnStateMachine Inherits CfnResource Implements IInspectable, IStateMachineRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnStateMachineProps)

Create a new AWS::StepFunctions::StateMachine.

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	Provisions a state machine.
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.
StateMachineRef	A reference to a StateMachine resource.
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

ArnForStateMachine(IStateMachineRef)	Provisions a state machine.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnStateMachine(object)	Checks whether the given object is a CfnStateMachine.
RenderProperties(IDictionary<string, object>)	Provisions a state machine.

Constructors

CfnStateMachine(Construct, string, ICfnStateMachineProps)

Create a new AWS::StepFunctions::StateMachine.

public CfnStateMachine(Construct scope, string id, ICfnStateMachineProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnStateMachineProps: Resource properties.

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

Properties

AttrArn

Returns the ARN of the resource.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrName

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

public virtual string AttrName { get; }

Property Value

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

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

string

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

CfnProperties

Provisions a state machine.

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

Definition

The Amazon States Language definition of the state machine.

public virtual object? Definition { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

DefinitionS3Location

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

public virtual object? DefinitionS3Location { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnStateMachine.IS3LocationProperty

DefinitionString

The Amazon States Language definition of the state machine.

public virtual string? DefinitionString { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either Dictionary<string, string> or IResolvable

EncryptionConfiguration

Encryption configuration for the state machine.

public virtual object? EncryptionConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnStateMachine.IEncryptionConfigurationProperty

LoggingConfiguration

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

public virtual object? LoggingConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnStateMachine.ILoggingConfigurationProperty

RoleArn

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

public virtual string RoleArn { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

StateMachineName

The name of the state machine.

public virtual string? StateMachineName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

StateMachineRef

A reference to a StateMachine resource.

public virtual IStateMachineReference StateMachineRef { get; }

Property Value

IStateMachineReference

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

StateMachineType

Determines whether a STANDARD or EXPRESS state machine is created.

public virtual string? StateMachineType { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

TagsRaw

The list of tags to add to a resource.

public virtual CfnStateMachine.ITagsEntryProperty[]? TagsRaw { get; set; }

Property Value

ITagsEntryProperty[]

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

TracingConfiguration

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

public virtual object? TracingConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnStateMachine.ITracingConfigurationProperty

Methods

ArnForStateMachine(IStateMachineRef)

Provisions a state machine.

public static string ArnForStateMachine(IStateMachineRef resource)

Parameters

resource IStateMachineRef

Returns

string

Remarks

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
                 }
             });

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.

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

IsCfnStateMachine(object)

Checks whether the given object is a CfnStateMachine.

public static bool IsCfnStateMachine(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Provisions a state machine.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::StepFunctions::StateMachine

ExampleMetadata: fixture=_generated

Implements

IInspectable

IStateMachineRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable