HttpDataSourceProps

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

Bases: aws_cdk.aws_appsync.BaseDataSourceProps

(experimental) Properties for an AppSync http datasource.

Parameters
  • 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

  • endpoint (str) – (experimental) The http endpoint.

  • authorization_config (Optional[AwsIamConfig]) – (experimental) The authorization config in case the HTTP endpoint requires authorization. Default: - none

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

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

# graphql_api: appsync.GraphqlApi

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

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

Attributes

api

(experimental) The API to attach this data source to.

Stability

experimental

Return type

IGraphqlApi

authorization_config

(experimental) The authorization config in case the HTTP endpoint requires authorization.

Default
  • none

Stability

experimental

Return type

Optional[AwsIamConfig]

description

(experimental) the description of the data source.

Default
  • None

Stability

experimental

Return type

Optional[str]

endpoint

(experimental) The http endpoint.

Stability

experimental

Return type

str

name

(experimental) The name of the data source.

Default
  • id of data source

Stability

experimental

Return type

Optional[str]