class HttpDataSource (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.HttpDataSource |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#HttpDataSource |
![]() | software.amazon.awscdk.services.appsync.HttpDataSource |
![]() | aws_cdk.aws_appsync.HttpDataSource |
![]() | 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',
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'),
});
Initializer
new HttpDataSource(scope: Construct, id: string, props: HttpDataSourceProps)
Parameters
- scope
Construct
- id
string
- props
Http
Data Source Props
Construct Props
Name | Type | Description |
---|---|---|
api | IGraphql | The API to attach this data source to. |
endpoint | string | The http endpoint. |
authorization | Aws | The authorization config in case the HTTP endpoint requires authorization. |
description? | string | the description of the data source. |
name? | string | The name of the data source. |
service | IRole | The IAM service role to be assumed by AppSync to interact with the data source. |
api
Type:
IGraphql
The API to attach this data source to.
endpoint
Type:
string
The http endpoint.
authorizationConfig?
Type:
Aws
(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.
serviceRole?
Type:
IRole
(optional, default: Create a new role)
The IAM service role to be assumed by AppSync to interact with the data source.
Properties
Name | Type | Description |
---|---|---|
ds | Cfn | the underlying CFN data source resource. |
grant | IPrincipal | the principal of the data source to be IGrantable. |
name | string | the name of the data source. |
node | Node | The tree node. |
ds
Type:
Cfn
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
Name | Description |
---|---|
create | creates a new appsync function for this datasource and API using the given properties. |
create | creates a new resolver for this datasource and API using the given properties. |
to | Returns a string representation of this construct. |
createFunction(id, props)
public createFunction(id: string, props: BaseAppsyncFunctionProps): AppsyncFunction
Parameters
- id
string
- props
Base
Appsync Function Props
Returns
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
Base
Resolver Props
Returns
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.