aws-cdk-lib.aws_appsync.HttpDataSource

class HttpDataSource (construct)

LanguageType name
.NETAmazon.CDK.AWS.AppSync.HttpDataSource
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#HttpDataSource
Javasoftware.amazon.awscdk.services.appsync.HttpDataSource
Pythonaws_cdk.aws_appsync.HttpDataSource
TypeScript (source)aws-cdk-lib » aws_appsync » HttpDataSource

Implements IConstruct, IDependable, IGrantable

An AppSync datasource backed by a http endpoint.

Example

const api = new appsync.GraphqlApi(this, 'api', {
  name: 'api',
  schema: appsync.SchemaFile.fromAsset(path.join(__dirname, 'schema.graphql')),
});

const httpDs = api.addHttpDataSource(
  'ds',
  'https://states.amazonaws.com',
  {
    name: 'httpDsWithStepF',
    description: 'from appsync to StepFunctions Workflow',
    authorizationConfig: {
      signingRegion: 'us-east-1',
      signingServiceName: 'states',
    }
  }
);

httpDs.createResolver('MutationCallStepFunctionResolver', {
  typeName: 'Mutation',
  fieldName: 'callStepFunction',
  requestMappingTemplate: appsync.MappingTemplate.fromFile('request.vtl'),
  responseMappingTemplate: appsync.MappingTemplate.fromFile('response.vtl'),
});

Initializer

new HttpDataSource(scope: Construct, id: string, props: HttpDataSourceProps)

Parameters

  • scope Construct
  • id string
  • props HttpDataSourceProps

Construct Props

NameTypeDescription
apiIGraphqlApiThe API to attach this data source to.
endpointstringThe http endpoint.
authorizationConfig?AwsIamConfigThe authorization config in case the HTTP endpoint requires authorization.
description?stringthe description of the data source.
name?stringThe name of the data source.

api

Type: IGraphqlApi

The API to attach this data source to.


endpoint

Type: string

The http endpoint.


authorizationConfig?

Type: AwsIamConfig (optional, default: none)

The authorization config in case the HTTP endpoint requires authorization.


description?

Type: string (optional, default: None)

the description of the data source.


name?

Type: string (optional, default: id of data source)

The name of the data source.

Properties

NameTypeDescription
dsCfnDataSourcethe underlying CFN data source resource.
grantPrincipalIPrincipalthe principal of the data source to be IGrantable.
namestringthe name of the data source.
nodeNodeThe tree node.

ds

Type: CfnDataSource

the underlying CFN data source resource.


grantPrincipal

Type: IPrincipal

the principal of the data source to be IGrantable.


name

Type: string

the name of the data source.


node

Type: Node

The tree node.

Methods

NameDescription
createFunction(id, props)creates a new appsync function for this datasource and API using the given properties.
createResolver(id, props)creates a new resolver for this datasource and API using the given properties.
toString()Returns a string representation of this construct.

createFunction(id, props)

public createFunction(id: string, props: BaseAppsyncFunctionProps): AppsyncFunction

Parameters

  • id string
  • props BaseAppsyncFunctionProps

Returns

  • AppsyncFunction

creates a new appsync function for this datasource and API using the given properties.


createResolver(id, props)

public createResolver(id: string, props: BaseResolverProps): Resolver

Parameters

  • id string
  • props BaseResolverProps

Returns

  • Resolver

creates a new resolver for this datasource and API using the given properties.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.