BackedDataSourceProps

class aws_cdk.aws_appsync.BackedDataSourceProps(*, api, description=None, name=None, service_role=None)

Bases: aws_cdk.aws_appsync.BaseDataSourceProps

(experimental) properties for an AppSync datasource backed by a resource.

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

  • service_role (Optional[IRole]) – (experimental) The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new role

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
import aws_cdk.aws_iam as iam

# graphql_api: appsync.GraphqlApi
# role: iam.Role

backed_data_source_props = appsync.BackedDataSourceProps(
    api=graphql_api,

    # the properties below are optional
    description="description",
    name="name",
    service_role=role
)

Attributes

api

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

Stability

experimental

Return type

IGraphqlApi

description

(experimental) the description of the data source.

Default
  • None

Stability

experimental

Return type

Optional[str]

name

(experimental) The name of the data source.

Default
  • id of data source

Stability

experimental

Return type

Optional[str]

service_role

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

Default
  • Create a new role

Stability

experimental

Return type

Optional[IRole]