Package software.amazon.awscdk.services.appsync

Interface DynamoDbDataSourceProps

All Superinterfaces:

BackedDataSourceProps, BaseDataSourceProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DynamoDbDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:14.649Z")
@Stability(Stable)
public interface DynamoDbDataSourceProps
extends software.amazon.jsii.JsiiSerializable, BackedDataSourceProps

Properties for an AppSync DynamoDB datasource.

Example:

 // 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.*;
 GraphqlApi graphqlApi;
 Role role;
 Table table;
 DynamoDbDataSourceProps dynamoDbDataSourceProps = DynamoDbDataSourceProps.builder()
         .api(graphqlApi)
         .table(table)
         // the properties below are optional
         .description("description")
         .name("name")
         .readOnlyAccess(false)
         .serviceRole(role)
         .useCallerCredentials(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DynamoDbDataSourceProps.Builder	A builder for DynamoDbDataSourceProps
static final class	DynamoDbDataSourceProps.Jsii$Proxy	An implementation for DynamoDbDataSourceProps

Method Summary

Modifier and Type	Method	Description
static DynamoDbDataSourceProps.Builder	builder()
default Boolean	getReadOnlyAccess()	Specify whether this DS is read only or has read and write permissions to the DynamoDB table.
ITable	getTable()	The DynamoDB table backing this data source.
default Boolean	getUseCallerCredentials()	use credentials of caller to access DynamoDB.

Methods inherited from interface software.amazon.awscdk.services.appsync.BackedDataSourceProps

getServiceRole

Methods inherited from interface software.amazon.awscdk.services.appsync.BaseDataSourceProps

getApi, getDescription, getName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTable

@Stability(Stable)
@NotNull
ITable getTable()

The DynamoDB table backing this data source.

getReadOnlyAccess

@Stability(Stable)
@Nullable
default Boolean getReadOnlyAccess()

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

Default: false

getUseCallerCredentials

@Stability(Stable)
@Nullable
default Boolean getUseCallerCredentials()

use credentials of caller to access DynamoDB.

Default: false

builder

@Stability(Stable)
static DynamoDbDataSourceProps.Builder builder()

Returns:

a DynamoDbDataSourceProps.Builder of DynamoDbDataSourceProps