aws-cdk-lib.aws_appsync.HttpDataSourceProps

interface HttpDataSourceProps

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

Properties for an AppSync http datasource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';

declare const graphqlApi: appsync.GraphqlApi;
const httpDataSourceProps: appsync.HttpDataSourceProps = {
  api: graphqlApi,
  endpoint: 'endpoint',

  // the properties below are optional
  authorizationConfig: {
    signingRegion: 'signingRegion',
    signingServiceName: 'signingServiceName',
  },
  description: 'description',
  name: 'name',
};

Properties

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.