AWS CDK Reference

Appearance

v2.274.0

CfnStateMachineProps Struct ​

Properties for defining a CfnStateMachine.

Source
Generated code

Example ​

ts
// 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 ​

definitionoptionalanydefinitionoptionalAnydefinitionoptionalObjectDefinitionoptionalobjectDefinitionoptionalinterface{}#
definitionSubstitutionsoptionalIResolvable | { [key: string]: string }definition_substitutionsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]definitionSubstitutionsoptionalIResolvableDefinitionSubstitutionsoptionalIResolvableDefinitionSubstitutionsoptionalinterface{}#
definitionUrioptionalstring | IResolvable | CfnStateMachine.S3LocationPropertydefinition_urioptionaltyping.Union[str, IResolvable, S3LocationProperty]definitionUrioptionalStringDefinitionUrioptionalstringDefinitionUrioptionalinterface{}#
eventsoptionalIResolvable | { [key: string]: IResolvable | CfnStateMachine.EventSourceProperty }eventsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, EventSourceProperty]]]eventsoptionalIResolvableEventsoptionalIResolvableEventsoptionalinterface{}#
loggingoptionalIResolvable | CfnStateMachine.LoggingConfigurationPropertyloggingoptionaltyping.Union[IResolvable, LoggingConfigurationProperty]loggingoptionalIResolvableLoggingoptionalIResolvableLoggingoptionalinterface{}#
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
permissionsBoundariesoptionalstringpermissions_boundariesoptionalstrpermissionsBoundariesoptionalStringPermissionsBoundariesoptionalstringPermissionsBoundariesoptional*string#
policiesoptionalstring | IResolvable | CfnStateMachine.IAMPolicyDocumentProperty | string | IResolvable | CfnStateMachine.IAMPolicyDocumentProperty | CfnStateMachine.SAMPolicyTemplateProperty[]policiesoptionaltyping.Union[str, IResolvable, IAMPolicyDocumentProperty, typing.List[typing.Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]]]policiesoptionalStringPoliciesoptionalstringPoliciesoptionalinterface{}#
roleoptionalstringroleoptionalstrroleoptionalStringRoleoptionalstringRoleoptional*string#
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
tracingoptionalIResolvable | CfnStateMachine.TracingConfigurationPropertytracingoptionaltyping.Union[IResolvable, TracingConfigurationProperty]tracingoptionalIResolvableTracingoptionalIResolvableTracingoptionalinterface{}#
typeoptionalstringtypeoptionalstrtypeoptionalStringTypeoptionalstringTypeoptional*string#