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,
};
python
# 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
from aws_cdk import aws_dynamodb as dynamodb
from aws_cdk import aws_iam as iam
from aws_cdk.interfaces import aws_appsync as interfaces_appsync
# graph_ql_api_ref: interfaces_appsync.IGraphQLApiRef
# role: iam.Role
# table: dynamodb.Table
dynamo_db_data_source_props = appsync.DynamoDbDataSourceProps(
api=graph_ql_api_ref,
table=table,
# the properties below are optional
description="description",
metrics_config=appsync.DataSourceMetricsConfig.ENABLED,
name="name",
read_only_access=False,
service_role=role,
use_caller_credentials=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appsync.*;
import software.amazon.awscdk.services.dynamodb.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.interfaces.appsync.*;
IGraphQLApiRef graphQLApiRef;
Role role;
Table table;
DynamoDbDataSourceProps dynamoDbDataSourceProps = DynamoDbDataSourceProps.builder()
.api(graphQLApiRef)
.table(table)
// the properties below are optional
.description("description")
.metricsConfig(DataSourceMetricsConfig.ENABLED)
.name("name")
.readOnlyAccess(false)
.serviceRole(role)
.useCallerCredentials(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
using Amazon.CDK.AWS.DynamoDB;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Interfaces.AppSync;
IGraphQLApiRef graphQLApiRef;
Role role;
Table table;
var dynamoDbDataSourceProps = new DynamoDbDataSourceProps {
Api = graphQLApiRef,
Table = table,
// the properties below are optional
Description = "description",
MetricsConfig = DataSourceMetricsConfig.ENABLED,
Name = "name",
ReadOnlyAccess = false,
ServiceRole = role,
UseCallerCredentials = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var graphQLApiRef IGraphQLApiRef
var role Role
var table Table
dynamoDbDataSourceProps := &DynamoDbDataSourceProps{
Api: graphQLApiRef,
Table: table,
// the properties below are optional
Description: jsii.String("description"),
MetricsConfig: awscdk.Aws_appsync.DataSourceMetricsConfig_ENABLED,
Name: jsii.String("name"),
ReadOnlyAccess: jsii.Boolean(false),
ServiceRole: role,
UseCallerCredentials: jsii.Boolean(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.