HttpDataSourceProps Struct
Properties for an AppSync http datasource.
Example
ts
// 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';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';
declare const graphQLApiRef: interfaces_appsync.IGraphQLApiRef;
declare const role: iam.Role;
const httpDataSourceProps: appsync.HttpDataSourceProps = {
api: graphQLApiRef,
endpoint: 'endpoint',
// the properties below are optional
authorizationConfig: {
signingRegion: 'signingRegion',
signingServiceName: 'signingServiceName',
},
description: 'description',
metricsConfig: appsync.DataSourceMetricsConfig.ENABLED,
name: 'name',
serviceRole: role,
};
Properties
The API to attach this data source to.
authorizationConfigoptionalAwsIamConfigauthorization_configoptionalAwsIamConfigauthorizationConfigoptionalAwsIamConfigAuthorizationConfigoptionalAwsIamConfigAuthorizationConfigoptionalAwsIamConfig= none#The authorization config in case the HTTP endpoint requires authorization.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#the description of the data source.
The http endpoint.
metricsConfigoptionalDataSourceMetricsConfigmetrics_configoptionalDataSourceMetricsConfigmetricsConfigoptionalDataSourceMetricsConfigMetricsConfigoptionalDataSourceMetricsConfigMetricsConfigoptionalDataSourceMetricsConfig#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: no metrics configuration
The name of the data source.
Default: id of data source