interface CfnStateMachineProps

Language	Type name
.NET	Amazon.CDK.AWS.SAM.CfnStateMachineProps
Java	software.amazon.awscdk.services.sam.CfnStateMachineProps
Python	aws_cdk.aws_sam.CfnStateMachineProps
TypeScript	@aws-cdk/aws-sam » CfnStateMachineProps

Properties for defining a CfnStateMachine.

Example

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

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	AWS::Serverless::StateMachine.Definition.
definitionSubstitutions?	IResolvable | { [string]: string }	AWS::Serverless::StateMachine.DefinitionSubstitutions.
definitionUri?	string | IResolvable | S3LocationProperty	AWS::Serverless::StateMachine.DefinitionUri.
events?	IResolvable | { [string]: IResolvable | EventSourceProperty }	AWS::Serverless::StateMachine.Events.
logging?	IResolvable | LoggingConfigurationProperty	AWS::Serverless::StateMachine.Logging.
name?	string	AWS::Serverless::StateMachine.Name.
permissionsBoundaries?	string	AWS::Serverless::StateMachine.PermissionsBoundaries.
policies?	string | IResolvable | IAMPolicyDocumentProperty | string | IResolvable | IAMPolicyDocumentProperty | SAMPolicyTemplateProperty[]	AWS::Serverless::StateMachine.Policies.
role?	string	AWS::Serverless::StateMachine.Role.
tags?	{ [string]: string }	AWS::Serverless::StateMachine.Tags.
tracing?	IResolvable | TracingConfigurationProperty	AWS::Serverless::StateMachine.Tracing.
type?	string	AWS::Serverless::StateMachine.Type.

---

definition?

Type: any (optional)

AWS::Serverless::StateMachine.Definition.

---

definitionSubstitutions?

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

AWS::Serverless::StateMachine.DefinitionSubstitutions.

---

definitionUri?

Type: string | IResolvable | S3LocationProperty (optional)

AWS::Serverless::StateMachine.DefinitionUri.

---

events?

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

AWS::Serverless::StateMachine.Events.

---

logging?

Type: IResolvable | LoggingConfigurationProperty (optional)

AWS::Serverless::StateMachine.Logging.

---

name?

Type: string (optional)

AWS::Serverless::StateMachine.Name.

---

permissionsBoundaries?

Type: string (optional)

AWS::Serverless::StateMachine.PermissionsBoundaries.

---

policies?

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

AWS::Serverless::StateMachine.Policies.

---

role?

Type: string (optional)

AWS::Serverless::StateMachine.Role.

---

tags?

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

AWS::Serverless::StateMachine.Tags.

---

tracing?

Type: IResolvable | TracingConfigurationProperty (optional)

AWS::Serverless::StateMachine.Tracing.

---

type?

Type: string (optional)

AWS::Serverless::StateMachine.Type.