Skip to content

API.md

Latest commit

 

History

History
executable file
·
198 lines (121 loc) · 7.2 KB

API.md

File metadata and controls

executable file
·
198 lines (121 loc) · 7.2 KB
Raw

API Reference

Constructs

StateMachineApiGatewayExample

Converted from an AWS Blog post.

It is the first example mentioned in https://aws.amazon.com/tw/blogs/compute/introducing-amazon-api-gateway-service-integration-for-aws-step-functions/. This constcut will create an API Gateway Rest API with two methods and are manipulated by a state machine managed in AWS StepFucntions.

Initializers 

import { StateMachineApiGatewayExample } from 'projen-statemachine-example'

new StateMachineApiGatewayExample(parent: Construct, name: string, props: StateMachineApiGatewayExampleProps)
Name Type Description
parent constructs.Construct No description.
name string No description.
props StateMachineApiGatewayExampleProps No description.
parentRequired
  • Type: constructs.Construct
nameRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { StateMachineApiGatewayExample } from 'projen-statemachine-example'

StateMachineApiGatewayExample.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
executionInput string sample input to start execution for the workflow.
stateMachine aws-cdk-lib.aws_stepfunctions.StateMachine the representation of a state machine.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

executionInputRequired 
public readonly executionInput: string;
  • Type: string

sample input to start execution for the workflow.

stateMachineRequired 
public readonly stateMachine: StateMachine;
  • Type: aws-cdk-lib.aws_stepfunctions.StateMachine

the representation of a state machine.

Structs

StateMachineApiGatewayExampleProps

Initializer 

import { StateMachineApiGatewayExampleProps } from 'projen-statemachine-example'

const stateMachineApiGatewayExampleProps: StateMachineApiGatewayExampleProps = { ... }

Properties

Name Type Description
partPath string The path part for the resource.
stageName string A stage name for the rest api.
partPathRequired 
public readonly partPath: string;
  • Type: string
  • Default: 'pets'

The path part for the resource.

stageNameRequired 
public readonly stageName: string;
  • Type: string
  • Default: 'default'

A stage name for the rest api.