HttpDataSource

class aws_cdk.aws_appsync.HttpDataSource(scope, id, *, endpoint, authorization_config=None, api, description=None, name=None)

Bases: BackedDataSource

(experimental) An AppSync datasource backed by a http endpoint.

Stability:: experimental
ExampleMetadata:: infused

Example:

api = appsync.GraphqlApi(self, "api",
    name="api",
    schema=appsync.Schema.from_asset(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(
    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) – (experimental) The http endpoint.
authorization_config (Union[AwsIamConfig, Dict[str, Any], None]) – (experimental) The authorization config in case the HTTP endpoint requires authorization. Default: - none
api (IGraphqlApi) – (experimental) The API to attach this data source to.
description (Optional[str]) – (experimental) the description of the data source. Default: - None
name (Optional[str]) – (experimental) The name of the data source. Default: - id of data source

Stability:

experimental

Methods

create_function(*, name, description=None, request_mapping_template=None, response_mapping_template=None)

(experimental) creates a new appsync function for this datasource and API using the given properties.

Parameters:

name (str) – (experimental) the name of the AppSync Function.
description (Optional[str]) – (experimental) the description for this AppSync Function. Default: - no description
request_mapping_template (Optional[MappingTemplate]) – (experimental) the request mapping template for the AppSync Function. Default: - no request mapping template
response_mapping_template (Optional[MappingTemplate]) – (experimental) the response mapping template for the AppSync Function. Default: - no response mapping template

Stability:

experimental

Return type:

AppsyncFunction

create_resolver(*, field_name, type_name, caching_config=None, pipeline_config=None, request_mapping_template=None, response_mapping_template=None)

(experimental) creates a new resolver for this datasource and API using the given properties.

Parameters:

field_name (str) – (experimental) name of the GraphQL field in the given type this resolver is attached to.
type_name (str) – (experimental) name of the GraphQL type this resolver is attached to.
caching_config (Union[CachingConfig, Dict[str, Any], None]) – (experimental) The caching configuration for this resolver. Default: - No caching configuration
pipeline_config (Optional[Sequence[IAppsyncFunction]]) – (experimental) configuration of the pipeline resolver. Default: - no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unit
request_mapping_template (Optional[MappingTemplate]) – (experimental) The request mapping template for this resolver. Default: - No mapping template
response_mapping_template (Optional[MappingTemplate]) – (experimental) The response mapping template for this resolver. Default: - No mapping template

Stability:

experimental

Return type:

Resolver

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

ds

(experimental) the underlying CFN data source resource.

Stability:: experimental

grant_principal

(experimental) the principal of the data source to be IGrantable.

Stability:: experimental

name

(experimental) the name of the data source.

Stability:: experimental

node: The construct tree node associated with this construct.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool