software.amazon.awsconstructs.services.apigatewaydynamodb

Class ApiGatewayToDynamoDBProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.apigatewaydynamodb.ApiGatewayToDynamoDBProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayToDynamoDBProps>

Enclosing interface:

ApiGatewayToDynamoDBProps

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

A builder for ApiGatewayToDynamoDBProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ApiGatewayToDynamoDBProps.Builder	allowCreateOperation(Boolean allowCreateOperation) Sets the value of ApiGatewayToDynamoDBProps.getAllowCreateOperation()
ApiGatewayToDynamoDBProps.Builder	allowDeleteOperation(Boolean allowDeleteOperation) Sets the value of ApiGatewayToDynamoDBProps.getAllowDeleteOperation()
ApiGatewayToDynamoDBProps.Builder	allowReadOperation(Boolean allowReadOperation) Sets the value of ApiGatewayToDynamoDBProps.getAllowReadOperation()
ApiGatewayToDynamoDBProps.Builder	allowUpdateOperation(Boolean allowUpdateOperation) Sets the value of ApiGatewayToDynamoDBProps.getAllowUpdateOperation()
ApiGatewayToDynamoDBProps.Builder	apiGatewayProps(software.amazon.awscdk.services.apigateway.RestApiProps apiGatewayProps) Sets the value of ApiGatewayToDynamoDBProps.getApiGatewayProps()
ApiGatewayToDynamoDBProps	build() Builds the configured instance.
ApiGatewayToDynamoDBProps.Builder	createRequestTemplate(String createRequestTemplate) Sets the value of ApiGatewayToDynamoDBProps.getCreateRequestTemplate()
ApiGatewayToDynamoDBProps.Builder	deleteRequestTemplate(String deleteRequestTemplate) Sets the value of ApiGatewayToDynamoDBProps.getDeleteRequestTemplate()
ApiGatewayToDynamoDBProps.Builder	dynamoTableProps(software.amazon.awscdk.services.dynamodb.TableProps dynamoTableProps) Sets the value of ApiGatewayToDynamoDBProps.getDynamoTableProps()
ApiGatewayToDynamoDBProps.Builder	existingTableObj(software.amazon.awscdk.services.dynamodb.Table existingTableObj) Sets the value of ApiGatewayToDynamoDBProps.getExistingTableObj()
ApiGatewayToDynamoDBProps.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) Sets the value of ApiGatewayToDynamoDBProps.getLogGroupProps()
ApiGatewayToDynamoDBProps.Builder	readRequestTemplate(String readRequestTemplate) Sets the value of ApiGatewayToDynamoDBProps.getReadRequestTemplate()
ApiGatewayToDynamoDBProps.Builder	updateRequestTemplate(String updateRequestTemplate) Sets the value of ApiGatewayToDynamoDBProps.getUpdateRequestTemplate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

allowCreateOperation

public ApiGatewayToDynamoDBProps.Builder allowCreateOperation(Boolean allowCreateOperation)

Sets the value of ApiGatewayToDynamoDBProps.getAllowCreateOperation()

Parameters:

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

Returns:

this

allowDeleteOperation

public ApiGatewayToDynamoDBProps.Builder allowDeleteOperation(Boolean allowDeleteOperation)

Sets the value of ApiGatewayToDynamoDBProps.getAllowDeleteOperation()

Parameters:

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

Returns:

this

allowReadOperation

public ApiGatewayToDynamoDBProps.Builder allowReadOperation(Boolean allowReadOperation)

Sets the value of ApiGatewayToDynamoDBProps.getAllowReadOperation()

Parameters:

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

Returns:

this

allowUpdateOperation

public ApiGatewayToDynamoDBProps.Builder allowUpdateOperation(Boolean allowUpdateOperation)

Sets the value of ApiGatewayToDynamoDBProps.getAllowUpdateOperation()

Parameters:

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

Returns:

this

apiGatewayProps

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

Sets the value of ApiGatewayToDynamoDBProps.getApiGatewayProps()

Parameters:

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

Returns:

this

createRequestTemplate

public ApiGatewayToDynamoDBProps.Builder createRequestTemplate(String createRequestTemplate)

Sets the value of ApiGatewayToDynamoDBProps.getCreateRequestTemplate()

Parameters:

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

Returns:

this

deleteRequestTemplate

public ApiGatewayToDynamoDBProps.Builder deleteRequestTemplate(String deleteRequestTemplate)

Sets the value of ApiGatewayToDynamoDBProps.getDeleteRequestTemplate()

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. The default template only supports a partition key and not partition + sort keys.

Returns:

this

dynamoTableProps

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

Sets the value of ApiGatewayToDynamoDBProps.getDynamoTableProps()

Parameters:

dynamoTableProps - Optional user provided props to override the default props.

Returns:

this

existingTableObj

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

Sets the value of ApiGatewayToDynamoDBProps.getExistingTableObj()

Parameters:

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

Returns:

this

logGroupProps

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

Sets the value of ApiGatewayToDynamoDBProps.getLogGroupProps()

Parameters:

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

Returns:

this

readRequestTemplate

public ApiGatewayToDynamoDBProps.Builder readRequestTemplate(String readRequestTemplate)

Sets the value of ApiGatewayToDynamoDBProps.getReadRequestTemplate()

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. The default template only supports a partition key and not partition + sort keys.

Returns:

this

updateRequestTemplate

public ApiGatewayToDynamoDBProps.Builder updateRequestTemplate(String updateRequestTemplate)

Sets the value of ApiGatewayToDynamoDBProps.getUpdateRequestTemplate()

Parameters:

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

Returns:

this

build

public ApiGatewayToDynamoDBProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiGatewayToDynamoDBProps

Throws:

NullPointerException - if any required attribute was not provided