interface CfnStateMachineProps

Language	Type name
.NET	Amazon.CDK.AWS.SAM.CfnStateMachineProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnStateMachineProps
Java	software.amazon.awscdk.services.sam.CfnStateMachineProps
Python	aws_cdk.aws_sam.CfnStateMachineProps
TypeScript	aws-cdk-lib » aws_sam » CfnStateMachineProps

Properties for defining a CfnStateMachine.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';

declare const definition: any;
const cfnStateMachineProps: sam.CfnStateMachineProps = {
  definition: definition,
  definitionSubstitutions: {
    definitionSubstitutionsKey: 'definitionSubstitutions',
  },
  definitionUri: 'definitionUri',
  events: {
    eventsKey: {
      properties: {
        method: 'method',
        path: 'path',

        // the properties below are optional
        restApiId: 'restApiId',
      },
      type: 'type',
    },
  },
  logging: {
    destinations: [{
      cloudWatchLogsLogGroup: {
        logGroupArn: 'logGroupArn',
      },
    }],
    includeExecutionData: false,
    level: 'level',
  },
  name: 'name',
  permissionsBoundaries: 'permissionsBoundaries',
  policies: 'policies',
  role: 'role',
  tags: {
    tagsKey: 'tags',
  },
  tracing: {
    enabled: false,
  },
  type: 'type',
};

Properties

Name	Type	Description
definition?	any
definitionSubstitutions?	{ [string]: string } | IResolvable
definitionUri?	string | IResolvable | S3LocationProperty
events?	IResolvable | { [string]: IResolvable | EventSourceProperty }
logging?	IResolvable | LoggingConfigurationProperty
name?	string
permissionsBoundaries?	string
policies?	string | IResolvable | IAMPolicyDocumentProperty | (string | IResolvable | IAMPolicyDocumentProperty | SAMPolicyTemplateProperty)[]
role?	string
tags?	{ [string]: string }
tracing?	IResolvable | TracingConfigurationProperty
type?	string

---

definition?

Type: any (optional)

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

---

definitionSubstitutions?

Type: { [string]: string } | IResolvable (optional)

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

---

definitionUri?

Type: string | IResolvable | S3LocationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-definitionuri

---

events?

Type: IResolvable | { [string]: IResolvable | EventSourceProperty } (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-events

---

logging?

Type: IResolvable | LoggingConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-logging

---

name?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-name

---

permissionsBoundaries?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-permissionsboundaries

---

policies?

Type: string | IResolvable | IAMPolicyDocumentProperty | (string | IResolvable | IAMPolicyDocumentProperty | SAMPolicyTemplateProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-policies

---

role?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-role

---

tags?

Type: { [string]: string } (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-tags

---

tracing?

Type: IResolvable | TracingConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-tracing

---

type?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-type