AWS CDK Reference

Appearance

v2.274.0

HttpDataSourceOptions Struct ​

Optional configuration for Http data sources.

Source
aws-appsync/lib/graphqlapi-base.ts
Type last changed
v2.60.0 · 12 Jan 2023

Example ​

ts
const api = new appsync.GraphqlApi(this, 'api', {
  name: 'api',
  definition: appsync.Definition.fromFile(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'),
});

Properties ​

authorizationConfigAwsIamConfigauthorization_configAwsIamConfigauthorizationConfigAwsIamConfigAuthorizationConfigAwsIamConfigAuthorizationConfigAwsIamConfig= none#
The authorization config in case the HTTP endpoint requires authorization.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The description of the data source.

Default: No description

metricsConfigDataSourceMetricsConfigmetrics_configDataSourceMetricsConfigmetricsConfigDataSourceMetricsConfigMetricsConfigDataSourceMetricsConfigMetricsConfigDataSourceMetricsConfig#
Whether to enable enhanced metrics of the data source Value will be ignored, if `enhancedMetricsConfig.dataSourceLevelMetricsBehavior` on AppSync GraphqlApi construct is set to `FULL_REQUEST_DATA_SOURCE_METRICS`.

Default: Enhance metrics are disabled

namestringnamestrnameStringNamestringName*string#
The name of the data source, overrides the id given by cdk.

Default: generated by cdk given the id