DynamoDbDataSourceProps Struct
Properties for an AppSync DynamoDB datasource.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';
declare const graphQLApiRef: interfaces_appsync.IGraphQLApiRef;
declare const role: iam.Role;
declare const table: dynamodb.Table;
const dynamoDbDataSourceProps: appsync.DynamoDbDataSourceProps = {
api: graphQLApiRef,
table: table,
// the properties below are optional
description: 'description',
metricsConfig: appsync.DataSourceMetricsConfig.ENABLED,
name: 'name',
readOnlyAccess: false,
serviceRole: role,
useCallerCredentials: false,
};
Properties
The API to attach this data source to.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#the description of the data source.
metricsConfigoptionalDataSourceMetricsConfigmetrics_configoptionalDataSourceMetricsConfigmetricsConfigoptionalDataSourceMetricsConfigMetricsConfigoptionalDataSourceMetricsConfigMetricsConfigoptionalDataSourceMetricsConfig#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
The name of the data source.
Default: id of data source
readOnlyAccessoptionalbooleanread_only_accessoptionalboolreadOnlyAccessoptionalBooleanReadOnlyAccessoptionalboolReadOnlyAccessoptional*bool= false#Specify whether this DS is read only or has read and write permissions to the DynamoDB table.
serviceRoleoptionalIRoleservice_roleoptionalIRoleserviceRoleoptionalIRoleServiceRoleoptionalIRoleServiceRoleoptionalIRole#The IAM service role to be assumed by AppSync to interact with the data source.
Default: Create a new role
The DynamoDB table backing this data source.
useCallerCredentialsoptionalbooleanuse_caller_credentialsoptionalbooluseCallerCredentialsoptionalBooleanUseCallerCredentialsoptionalboolUseCallerCredentialsoptional*bool= false#use credentials of caller to access DynamoDB.