Class DynamoDbDataSourceProps
(experimental) Properties for an AppSync DynamoDB datasource.
Inheritance
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public class DynamoDbDataSourceProps : Object, IDynamoDbDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps
Syntax (vb)
Public Class DynamoDbDataSourceProps
Inherits Object
Implements IDynamoDbDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// 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;
GraphqlApi graphqlApi;
Role role;
Table table;
var dynamoDbDataSourceProps = new DynamoDbDataSourceProps {
Api = graphqlApi,
Table = table,
// the properties below are optional
Description = "description",
Name = "name",
ReadOnlyAccess = false,
ServiceRole = role,
UseCallerCredentials = false
};
Synopsis
Constructors
DynamoDbDataSourceProps() |
Properties
Api | (experimental) The API to attach this data source to. |
Description | (experimental) the description of the data source. |
Name | (experimental) The name of the data source. |
ReadOnlyAccess | (experimental) Specify whether this DS is read only or has read and write permissions to the DynamoDB table. |
ServiceRole | (experimental) The IAM service role to be assumed by AppSync to interact with the data source. |
Table | (experimental) The DynamoDB table backing this data source. |
UseCallerCredentials | (experimental) use credentials of caller to access DynamoDB. |
Constructors
DynamoDbDataSourceProps()
public DynamoDbDataSourceProps()
Properties
Api
(experimental) The API to attach this data source to.
public IGraphqlApi Api { get; set; }
Property Value
Remarks
Stability: Experimental
Description
(experimental) the description of the data source.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - None
Stability: Experimental
Name
(experimental) The name of the data source.
public string Name { get; set; }
Property Value
System.String
Remarks
Default: - id of data source
Stability: Experimental
ReadOnlyAccess
(experimental) Specify whether this DS is read only or has read and write permissions to the DynamoDB table.
public Nullable<bool> ReadOnlyAccess { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
ServiceRole
(experimental) The IAM service role to be assumed by AppSync to interact with the data source.
public IRole ServiceRole { get; set; }
Property Value
Remarks
Default: - Create a new role
Stability: Experimental
Table
(experimental) The DynamoDB table backing this data source.
public ITable Table { get; set; }
Property Value
Remarks
Stability: Experimental
UseCallerCredentials
(experimental) use credentials of caller to access DynamoDB.
public Nullable<bool> UseCallerCredentials { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental