API.md

API Reference

Constructs

AppSyncDataSourceStepFunctionsExpress

A CDK construct to create an AWS AppSync data source to call AWS Step Functions express workflows.

Initializers

import { AppSyncDataSourceStepFunctionsExpress } from '@opsbr/cdk-appsync-data-source-sfn-express'

new AppSyncDataSourceStepFunctionsExpress(scope: Construct, id: string, props: AppSyncDataSourceStepFunctionsExpressProps)

Name	Type	Description
scope	constructs.Construct	Scope in which this resource is defined.
id	string	Scoped id of the resource.
props	AppSyncDataSourceStepFunctionsExpressProps	Resource properties.

---

scope^Required

• Type: constructs.Construct

Scope in which this resource is defined.

---

id^Required

• Type: string

Scoped id of the resource.

---

props^Required

• Type: AppSyncDataSourceStepFunctionsExpressProps

Resource properties.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
createStateMachineResolver	Create a resolver to execute a state machine with a synchronous express workflow.

---

toString

public toString(): string

Returns a string representation of this construct.

createStateMachineResolver

public createStateMachineResolver(id: string, props: CreateStateMachineResolverProps): CfnResolver

Create a resolver to execute a state machine with a synchronous express workflow.

id^Required

• Type: string

Scoped id of the resource.

---

props^Required

• Type: CreateStateMachineResolverProps

Resource properties.

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { AppSyncDataSourceStepFunctionsExpress } from '@opsbr/cdk-appsync-data-source-sfn-express'

AppSyncDataSourceStepFunctionsExpress.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
dataSource	aws-cdk-lib.aws_appsync.CfnDataSource	Data source to call AWS Step Functions API endpoint for StartSyncExecution.
role	aws-cdk-lib.aws_iam.Role	IAM role to call AWS Step Functions API endpoint for StartSyncExecution.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

dataSource^Required

public readonly dataSource: CfnDataSource;

• Type: aws-cdk-lib.aws_appsync.CfnDataSource

Data source to call AWS Step Functions API endpoint for StartSyncExecution.

---

role^Required

public readonly role: Role;

• Type: aws-cdk-lib.aws_iam.Role

IAM role to call AWS Step Functions API endpoint for StartSyncExecution.

---

Structs

AppSyncDataSourceStepFunctionsExpressProps

Initializer

import { AppSyncDataSourceStepFunctionsExpressProps } from '@opsbr/cdk-appsync-data-source-sfn-express'

const appSyncDataSourceStepFunctionsExpressProps: AppSyncDataSourceStepFunctionsExpressProps = { ... }

Properties

Name	Type	Description
apiId	string	Id of AppSync GraphQLApi to be associated with the data source.

---

apiId^Required

public readonly apiId: string;

• Type: string

Id of AppSync GraphQLApi to be associated with the data source.

---

CreateStateMachineResolverProps

Initializer

import { CreateStateMachineResolverProps } from '@opsbr/cdk-appsync-data-source-sfn-express'

const createStateMachineResolverProps: CreateStateMachineResolverProps = { ... }

Properties

Name	Type	Description
fieldName	string	Field name for the resolver association e.g. getPost.
stateMachine	aws-cdk-lib.aws_stepfunctions.StateMachine	State machine to be called.
typeName	string	Type name for the resolver association e.g. Query.
schema	aws-cdk-lib.aws_appsync.CfnGraphQLSchema	GraphQL schema to be associated.

---

fieldName^Required

public readonly fieldName: string;

• Type: string

Field name for the resolver association e.g. getPost.

---

stateMachine^Required

public readonly stateMachine: StateMachine;

• Type: aws-cdk-lib.aws_stepfunctions.StateMachine

State machine to be called.

The state machine type must be EXPRESS.

---

typeName^Required

public readonly typeName: string;

• Type: string

Type name for the resolver association e.g. Query.

---

schema^Optional

public readonly schema: CfnGraphQLSchema;

• Type: aws-cdk-lib.aws_appsync.CfnGraphQLSchema

GraphQL schema to be associated.

Note: This is only used to add dependency. Omit if you don't manage your schema in CDK.

---