DynamoDbDataSourceProps

class aws_cdk.aws_appsync.DynamoDbDataSourceProps(*, api, name, description=None, service_role=None, table, read_only_access=None, use_caller_credentials=None)

Bases: aws_cdk.aws_appsync.BaseDataSourceProps

__init__(*, api, name, description=None, service_role=None, table, read_only_access=None, use_caller_credentials=None)

Properties for an AppSync DynamoDB datasource.

Parameters
  • api (GraphQLApi) – The API to attach this data source to.

  • name (str) – The name of the data source.

  • description (Optional[str]) – the description of the data source. Default: - None

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

  • table (Table) – The DynamoDB table backing this data source [disable-awslint:ref-via-interface].

  • read_only_access (Optional[bool]) – Specify whether this DS is read only or has read and write permissions to the DynamoDB table. Default: false

  • use_caller_credentials (Optional[bool]) – use credentials of caller to access DynamoDB. Default: false

stability :stability: experimental

Attributes

api

The API to attach this data source to.

stability :stability: experimental

Return type

GraphQLApi

description

the description of the data source.

default :default: - None

stability :stability: experimental

Return type

Optional[str]

name

The name of the data source.

stability :stability: experimental

Return type

str

read_only_access

Specify whether this DS is read only or has read and write permissions to the DynamoDB table.

default :default: false

stability :stability: experimental

Return type

Optional[bool]

service_role

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

default :default: - Create a new role

stability :stability: experimental

Return type

Optional[IRole]

table

ref-via-interface].

stability :stability: experimental

Type

The DynamoDB table backing this data source [disable-awslint

Return type

Table

use_caller_credentials

use credentials of caller to access DynamoDB.

default :default: false

stability :stability: experimental

Return type

Optional[bool]