Interface ICfnStateMachineProps

Properties for defining a CfnStateMachine.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnStateMachineProps

Syntax (vb)

Public Interface ICfnStateMachineProps

Remarks

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

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 cfnStateMachineProps = 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

Properties

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	The list of tags to add to a resource.
TracingConfiguration	Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Properties

Definition

The Amazon States Language definition of the state machine.

virtual object Definition { get; }

Property Value

System.Object

Remarks

The state machine definition must be in JSON or YAML, and the format of the object must match the format of your CloudFormation template file. See Amazon States Language .

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

DefinitionS3Location

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

virtual object DefinitionS3Location { get; }

Property Value

System.Object

Remarks

The state machine definition must be a JSON or YAML file.

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

DefinitionString

The Amazon States Language definition of the state machine.

virtual string DefinitionString { get; }

Property Value

System.String

Remarks

The state machine definition must be in JSON. See Amazon States Language .

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

DefinitionSubstitutions

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

virtual object DefinitionSubstitutions { get; }

Property Value

System.Object

Remarks

This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.

Substitutions must follow the syntax: ${key_name} or ${variable_1,variable_2,...} .

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

EncryptionConfiguration

Encryption configuration for the state machine.

virtual object EncryptionConfiguration { get; }

Property Value

System.Object

Remarks

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

LoggingConfiguration

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

virtual object LoggingConfiguration { get; }

Property Value

System.Object

Remarks

By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

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

RoleArn

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

string RoleArn { get; }

Property Value

System.String

Remarks

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

StateMachineName

The name of the state machine.

virtual string StateMachineName { get; }

Property Value

System.String

Remarks

A name must not contain:

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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

StateMachineType

Determines whether a STANDARD or EXPRESS state machine is created.

virtual string StateMachineType { get; }

Property Value

System.String

Remarks

The default is STANDARD . You cannot update the type of a state machine once it has been created. For more information on STANDARD and EXPRESS workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

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

TracingConfiguration

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

virtual object TracingConfiguration { get; }

Property Value

System.Object

Remarks

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