class CfnStateMachinePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SAM.Mixins.CfnStateMachinePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssam/mixins#CfnStateMachinePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.sam.mixins.CfnStateMachinePropsMixin
Python	aws_cdk.mixins_preview.aws_sam.mixins.CfnStateMachinePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_sam » mixins » CfnStateMachinePropsMixin

Implements IMixin

Extends Mixin

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html.

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 { mixins } from '@aws-cdk/mixins-preview';
import { mixins as sam_mixins } from '@aws-cdk/mixins-preview/aws-sam';

declare const definition: any;
const cfnStateMachinePropsMixin = new sam_mixins.CfnStateMachinePropsMixin({
  definition: definition,
  definitionSubstitutions: {
    definitionSubstitutionsKey: 'definitionSubstitutions',
  },
  definitionUri: 'definitionUri',
  events: {
    eventsKey: {
      properties: {
        method: 'method',
        path: 'path',
        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',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnStateMachinePropsMixin(props: CfnStateMachineMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnStateMachineMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Serverless::StateMachine.

Properties

Name	Type	Description
props	CfnStateMachineMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnStateMachineMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.