HttpDataSourceProps

class aws_cdk.aws_appsync.HttpDataSourceProps(*, api, description=None, metrics_config=None, name=None, service_role=None, endpoint, authorization_config=None)

Bases: BackedDataSourceProps

Properties for an AppSync http datasource.

Parameters:

api (IGraphQLApiRef) – The API to attach this data source to.
description (Optional[str]) – the description of the data source. Default: - None
metrics_config (Optional[DataSourceMetricsConfig]) – 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
name (Optional[str]) – The name of the data source. Default: - id of data source
service_role (Optional[IRole]) – The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new role
endpoint (str) – The http endpoint.
authorization_config (Union[AwsIamConfig, Dict[str, Any], None]) – The authorization config in case the HTTP endpoint requires authorization. Default: - none

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync
from aws_cdk import aws_iam as iam
from aws_cdk.interfaces import aws_appsync as interfaces_appsync

# graph_qLApi_ref: interfaces_appsync.IGraphQLApiRef
# role: iam.Role

http_data_source_props = appsync.HttpDataSourceProps(
    api=graph_qLApi_ref,
    endpoint="endpoint",

    # the properties below are optional
    authorization_config=appsync.AwsIamConfig(
        signing_region="signingRegion",
        signing_service_name="signingServiceName"
    ),
    description="description",
    metrics_config=appsync.DataSourceMetricsConfig.ENABLED,
    name="name",
    service_role=role
)

Attributes

api: The API to attach this data source to.

authorization_config

The authorization config in case the HTTP endpoint requires authorization.

Default:

none

description

the description of the data source.

Default:

None

endpoint: The http endpoint.

metrics_config

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

name

The name of the data source.

Default:

id of data source

service_role

The IAM service role to be assumed by AppSync to interact with the data source.

Default:

Create a new role