software.amazon.awscdk.services.appsync

Class DynamoDbDataSource.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.DynamoDbDataSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoDbDataSource>

Enclosing class:

DynamoDbDataSource

@Stability(value=Experimental)
public static final class DynamoDbDataSource.Builder
extends Object
implements software.amazon.jsii.Builder<DynamoDbDataSource>

(experimental) A fluent builder for DynamoDbDataSource.

Method Summary

Modifier and Type	Method and Description
DynamoDbDataSource.Builder	api(IGraphqlApi api) (experimental) The API to attach this data source to.
DynamoDbDataSource	build()
static DynamoDbDataSource.Builder	create(software.constructs.Construct scope, String id)
DynamoDbDataSource.Builder	description(String description) (experimental) the description of the data source.
DynamoDbDataSource.Builder	name(String name) (experimental) The name of the data source.
DynamoDbDataSource.Builder	readOnlyAccess(Boolean readOnlyAccess) (experimental) Specify whether this DS is read only or has read and write permissions to the DynamoDB table.
DynamoDbDataSource.Builder	serviceRole(IRole serviceRole) (experimental) The IAM service role to be assumed by AppSync to interact with the data source.
DynamoDbDataSource.Builder	table(ITable table) (experimental) The DynamoDB table backing this data source.
DynamoDbDataSource.Builder	useCallerCredentials(Boolean useCallerCredentials) (experimental) use credentials of caller to access DynamoDB.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static DynamoDbDataSource.Builder create(software.constructs.Construct scope,
                                                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DynamoDbDataSource.Builder.

api

@Stability(value=Experimental)
public DynamoDbDataSource.Builder api(IGraphqlApi api)

(experimental) The API to attach this data source to.

Parameters:

api - The API to attach this data source to. This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public DynamoDbDataSource.Builder description(String description)

(experimental) the description of the data source.

Default: - None

Parameters:

description - the description of the data source. This parameter is required.

Returns:

this

name

@Stability(value=Experimental)
public DynamoDbDataSource.Builder name(String name)

(experimental) The name of the data source.

Default: - id of data source

Parameters:

name - The name of the data source. This parameter is required.

Returns:

this

serviceRole

@Stability(value=Experimental)
public DynamoDbDataSource.Builder serviceRole(IRole serviceRole)

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

Default: - Create a new role

Parameters:

serviceRole - The IAM service role to be assumed by AppSync to interact with the data source. This parameter is required.

Returns:

this

table

@Stability(value=Experimental)
public DynamoDbDataSource.Builder table(ITable table)

(experimental) The DynamoDB table backing this data source.

Parameters:

table - The DynamoDB table backing this data source. This parameter is required.

Returns:

this

readOnlyAccess

@Stability(value=Experimental)
public DynamoDbDataSource.Builder readOnlyAccess(Boolean readOnlyAccess)

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

Default: false

Parameters:

readOnlyAccess - Specify whether this DS is read only or has read and write permissions to the DynamoDB table. This parameter is required.

Returns:

this

useCallerCredentials

@Stability(value=Experimental)
public DynamoDbDataSource.Builder useCallerCredentials(Boolean useCallerCredentials)

(experimental) use credentials of caller to access DynamoDB.

Default: false

Parameters:

useCallerCredentials - use credentials of caller to access DynamoDB. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public DynamoDbDataSource build()

Specified by:

build in interface software.amazon.jsii.Builder<DynamoDbDataSource>