software.amazon.awsconstructs.services.apigatewaydynamodb

Class ApiGatewayToDynamoDB.Builder

java.lang.Object

software.amazon.awsconstructs.services.apigatewaydynamodb.ApiGatewayToDynamoDB.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayToDynamoDB>

Enclosing class:

ApiGatewayToDynamoDB

public static final class ApiGatewayToDynamoDB.Builder
extends Object
implements software.amazon.jsii.Builder<ApiGatewayToDynamoDB>

A fluent builder for ApiGatewayToDynamoDB.

Method Summary

Modifier and Type	Method and Description
ApiGatewayToDynamoDB.Builder	allowCreateOperation(Boolean allowCreateOperation) Whether to deploy API Gateway Method for Create operation on DynamoDB table.
ApiGatewayToDynamoDB.Builder	allowDeleteOperation(Boolean allowDeleteOperation) Whether to deploy API Gateway Method for Delete operation on DynamoDB table.
ApiGatewayToDynamoDB.Builder	allowReadOperation(Boolean allowReadOperation) Whether to deploy API Gateway Method for Read operation on DynamoDB table.
ApiGatewayToDynamoDB.Builder	allowUpdateOperation(Boolean allowUpdateOperation) Whether to deploy API Gateway Method for Update operation on DynamoDB table.
ApiGatewayToDynamoDB.Builder	apiGatewayProps(software.amazon.awscdk.services.apigateway.RestApiProps apiGatewayProps) Optional user-provided props to override the default props for the API Gateway.
ApiGatewayToDynamoDB	build()
static ApiGatewayToDynamoDB.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
ApiGatewayToDynamoDB.Builder	createRequestTemplate(String createRequestTemplate) API Gateway Request template for Create method, required if allowCreateOperation set to true.
ApiGatewayToDynamoDB.Builder	deleteRequestTemplate(String deleteRequestTemplate) Optional API Gateway Request template for Delete method, it will use the default template if allowDeleteOperation is true and deleteRequestTemplate is not provided.
ApiGatewayToDynamoDB.Builder	dynamoTableProps(software.amazon.awscdk.services.dynamodb.TableProps dynamoTableProps) Optional user provided props to override the default props.
ApiGatewayToDynamoDB.Builder	existingTableObj(software.amazon.awscdk.services.dynamodb.Table existingTableObj) Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.
ApiGatewayToDynamoDB.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) User provided props to override the default props for the CloudWatchLogs LogGroup.
ApiGatewayToDynamoDB.Builder	readRequestTemplate(String readRequestTemplate) Optional API Gateway Request template for Read method, it will use the default template if allowReadOperation is true and readRequestTemplate is not provided.
ApiGatewayToDynamoDB.Builder	updateRequestTemplate(String updateRequestTemplate) API Gateway Request template for Update method, required if allowUpdateOperation set to true.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ApiGatewayToDynamoDB.Builder create(software.amazon.awscdk.core.Construct scope,
                                                  String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of ApiGatewayToDynamoDB.Builder.

allowCreateOperation

public ApiGatewayToDynamoDB.Builder allowCreateOperation(Boolean allowCreateOperation)

Whether to deploy API Gateway Method for Create operation on DynamoDB table.

Default: - false

Parameters:

allowCreateOperation - Whether to deploy API Gateway Method for Create operation on DynamoDB table. This parameter is required.

Returns:

this

allowDeleteOperation

public ApiGatewayToDynamoDB.Builder allowDeleteOperation(Boolean allowDeleteOperation)

Whether to deploy API Gateway Method for Delete operation on DynamoDB table.

Default: - false

Parameters:

allowDeleteOperation - Whether to deploy API Gateway Method for Delete operation on DynamoDB table. This parameter is required.

Returns:

this

allowReadOperation

public ApiGatewayToDynamoDB.Builder allowReadOperation(Boolean allowReadOperation)

Whether to deploy API Gateway Method for Read operation on DynamoDB table.

Default: - true

Parameters:

allowReadOperation - Whether to deploy API Gateway Method for Read operation on DynamoDB table. This parameter is required.

Returns:

this

allowUpdateOperation

public ApiGatewayToDynamoDB.Builder allowUpdateOperation(Boolean allowUpdateOperation)

Whether to deploy API Gateway Method for Update operation on DynamoDB table.

Default: - false

Parameters:

allowUpdateOperation - Whether to deploy API Gateway Method for Update operation on DynamoDB table. This parameter is required.

Returns:

this

apiGatewayProps

public ApiGatewayToDynamoDB.Builder apiGatewayProps(software.amazon.awscdk.services.apigateway.RestApiProps apiGatewayProps)

Optional user-provided props to override the default props for the API Gateway.

Default: - Default properties are used.

Parameters:

apiGatewayProps - Optional user-provided props to override the default props for the API Gateway. This parameter is required.

Returns:

this

createRequestTemplate

public ApiGatewayToDynamoDB.Builder createRequestTemplate(String createRequestTemplate)

API Gateway Request template for Create method, required if allowCreateOperation set to true.

Default: - None

Parameters:

createRequestTemplate - API Gateway Request template for Create method, required if allowCreateOperation set to true. This parameter is required.

Returns:

this

deleteRequestTemplate

public ApiGatewayToDynamoDB.Builder deleteRequestTemplate(String deleteRequestTemplate)

Optional API Gateway Request template for Delete method, it will use the default template if allowDeleteOperation is true and deleteRequestTemplate is not provided.

The default template only supports a partition key and not partition + sort keys.

Default: - None

Parameters:

deleteRequestTemplate - Optional API Gateway Request template for Delete method, it will use the default template if allowDeleteOperation is true and deleteRequestTemplate is not provided. This parameter is required.

Returns:

this

dynamoTableProps

public ApiGatewayToDynamoDB.Builder dynamoTableProps(software.amazon.awscdk.services.dynamodb.TableProps dynamoTableProps)

Optional user provided props to override the default props.

Default: - Default props are used

Parameters:

dynamoTableProps - Optional user provided props to override the default props. This parameter is required.

Returns:

this

existingTableObj

public ApiGatewayToDynamoDB.Builder existingTableObj(software.amazon.awscdk.services.dynamodb.Table existingTableObj)

Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.

Default: - None

Parameters:

existingTableObj - Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error. This parameter is required.

Returns:

this

logGroupProps

public ApiGatewayToDynamoDB.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

User provided props to override the default props for the CloudWatchLogs LogGroup.

Default: - Default props are used

Parameters:

logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup. This parameter is required.

Returns:

this

readRequestTemplate

public ApiGatewayToDynamoDB.Builder readRequestTemplate(String readRequestTemplate)

Optional API Gateway Request template for Read method, it will use the default template if allowReadOperation is true and readRequestTemplate is not provided.

The default template only supports a partition key and not partition + sort keys.

Default: - None

Parameters:

readRequestTemplate - Optional API Gateway Request template for Read method, it will use the default template if allowReadOperation is true and readRequestTemplate is not provided. This parameter is required.

Returns:

this

updateRequestTemplate

public ApiGatewayToDynamoDB.Builder updateRequestTemplate(String updateRequestTemplate)

API Gateway Request template for Update method, required if allowUpdateOperation set to true.

Default: - None

Parameters:

updateRequestTemplate - API Gateway Request template for Update method, required if allowUpdateOperation set to true. This parameter is required.

Returns:

this

build

public ApiGatewayToDynamoDB build()

Specified by:

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