HttpDataSource
- class aws_cdk.aws_appsync.HttpDataSource(scope, id, *, endpoint, authorization_config=None, api, description=None, name=None)
Bases:
BackedDataSource
An AppSync datasource backed by a http endpoint.
- ExampleMetadata:
infused
Example:
api = appsync.GraphqlApi(self, "api", name="api", definition=appsync.Definition.from_file(path.join(__dirname, "schema.graphql")) ) http_ds = api.add_http_data_source("ds", "https://states.amazonaws.com", name="httpDsWithStepF", description="from appsync to StepFunctions Workflow", authorization_config=appsync.AwsIamConfig( signing_region="us-east-1", signing_service_name="states" ) ) http_ds.create_resolver("MutationCallStepFunctionResolver", type_name="Mutation", field_name="callStepFunction", request_mapping_template=appsync.MappingTemplate.from_file("request.vtl"), response_mapping_template=appsync.MappingTemplate.from_file("response.vtl") )
- Parameters:
scope (
Construct
) –id (
str
) –endpoint (
str
) – The http endpoint.authorization_config (
Union
[AwsIamConfig
,Dict
[str
,Any
],None
]) – The authorization config in case the HTTP endpoint requires authorization. Default: - noneapi (
IGraphqlApi
) – The API to attach this data source to.description (
Optional
[str
]) – the description of the data source. Default: - Nonename (
Optional
[str
]) – The name of the data source. Default: - id of data source
Methods
- create_function(id, *, name, code=None, description=None, max_batch_size=None, request_mapping_template=None, response_mapping_template=None, runtime=None)
creates a new appsync function for this datasource and API using the given properties.
- Parameters:
id (
str
) –name (
str
) – the name of the AppSync Function.code (
Optional
[Code
]) – The function code. Default: - no code is useddescription (
Optional
[str
]) – the description for this AppSync Function. Default: - no descriptionmax_batch_size (
Union
[int
,float
,None
]) – The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. Can only be set when using LambdaDataSource. Default: - No max batch sizerequest_mapping_template (
Optional
[MappingTemplate
]) – the request mapping template for the AppSync Function. Default: - no request mapping templateresponse_mapping_template (
Optional
[MappingTemplate
]) – the response mapping template for the AppSync Function. Default: - no response mapping templateruntime (
Optional
[FunctionRuntime
]) – The functions runtime. Default: - no function runtime, VTL mapping templates used
- Return type:
- create_resolver(id, *, field_name, type_name, caching_config=None, code=None, max_batch_size=None, pipeline_config=None, request_mapping_template=None, response_mapping_template=None, runtime=None)
creates a new resolver for this datasource and API using the given properties.
- Parameters:
id (
str
) –field_name (
str
) – name of the GraphQL field in the given type this resolver is attached to.type_name (
str
) – name of the GraphQL type this resolver is attached to.caching_config (
Union
[CachingConfig
,Dict
[str
,Any
],None
]) – The caching configuration for this resolver. Default: - No caching configurationcode (
Optional
[Code
]) – The function code. Default: - no code is usedmax_batch_size (
Union
[int
,float
,None
]) – The maximum number of elements per batch, when using batch invoke. Default: - No max batch sizepipeline_config (
Optional
[Sequence
[IAppsyncFunction
]]) – configuration of the pipeline resolver. Default: - no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unitrequest_mapping_template (
Optional
[MappingTemplate
]) – The request mapping template for this resolver. Default: - No mapping templateresponse_mapping_template (
Optional
[MappingTemplate
]) – The response mapping template for this resolver. Default: - No mapping templateruntime (
Optional
[FunctionRuntime
]) – The functions runtime. Default: - no function runtime, VTL mapping templates used
- Return type:
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- ds
the underlying CFN data source resource.
- grant_principal
the principal of the data source to be IGrantable.
- name
the name of the data source.
- node
The tree node.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.