SourceApi

class aws_cdk.aws_appsync.SourceApi(*, source_api, description=None, merge_type=None)

Bases: object

Configuration of source API.

Parameters:
  • source_api (IGraphqlApi) – Source API that is associated with the merged API.

  • description (Optional[str]) – Description of the Source API asssociation.

  • merge_type (Optional[MergeType]) – Merging option used to associate the source API to the Merged API. Default: - Auto merge. The merge is triggered automatically when the source API has changed

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

# graphql_api: appsync.GraphqlApi

source_api = appsync.SourceApi(
    source_api=graphql_api,

    # the properties below are optional
    description="description",
    merge_type=appsync.MergeType.MANUAL_MERGE
)

Attributes

description

Description of the Source API asssociation.

merge_type

Merging option used to associate the source API to the Merged API.

Default:
  • Auto merge. The merge is triggered automatically when the source API has changed

source_api

Source API that is associated with the merged API.