software.amazon.awsconstructs.services.apigatewaydynamodb

Interface ApiGatewayToDynamoDBProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayToDynamoDBProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-02T20:56:21.417Z")
public interface ApiGatewayToDynamoDBProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApiGatewayToDynamoDBProps.Builder	builder()
default Boolean	getAllowCreateOperation() Whether to deploy API Gateway Method for Create operation on DynamoDB table.
default Boolean	getAllowDeleteOperation() Whether to deploy API Gateway Method for Delete operation on DynamoDB table.
default Boolean	getAllowReadOperation() Whether to deploy API Gateway Method for Read operation on DynamoDB table.
default Boolean	getAllowUpdateOperation() Whether to deploy API Gateway Method for Update operation on DynamoDB table.
default software.amazon.awscdk.services.apigateway.RestApiProps	getApiGatewayProps() Optional user-provided props to override the default props for the API Gateway.
default String	getCreateRequestTemplate() API Gateway Request template for Create method, required if allowCreateOperation set to true.
default String	getDeleteRequestTemplate() Optional API Gateway Request template for Delete method, it will use the default template if allowDeleteOperation is true and deleteRequestTemplate is not provided.
default software.amazon.awscdk.services.dynamodb.TableProps	getDynamoTableProps() Optional user provided props to override the default props.
default software.amazon.awscdk.services.dynamodb.Table	getExistingTableObj() Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.
default software.amazon.awscdk.services.logs.LogGroupProps	getLogGroupProps() User provided props to override the default props for the CloudWatchLogs LogGroup.
default String	getReadRequestTemplate() Optional API Gateway Request template for Read method, it will use the default template if allowReadOperation is true and readRequestTemplate is not provided.
default String	getUpdateRequestTemplate() API Gateway Request template for Update method, required if allowUpdateOperation set to true.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllowCreateOperation

@Nullable
default Boolean getAllowCreateOperation()

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

Default: - false

getAllowDeleteOperation

@Nullable
default Boolean getAllowDeleteOperation()

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

Default: - false

getAllowReadOperation

@Nullable
default Boolean getAllowReadOperation()

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

Default: - true

getAllowUpdateOperation

@Nullable
default Boolean getAllowUpdateOperation()

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

Default: - false

getApiGatewayProps

@Nullable
default software.amazon.awscdk.services.apigateway.RestApiProps getApiGatewayProps()

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

Default: - Default properties are used.

getCreateRequestTemplate

@Nullable
default String getCreateRequestTemplate()

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

Default: - None

getDeleteRequestTemplate

@Nullable
default String getDeleteRequestTemplate()

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

getDynamoTableProps

@Nullable
default software.amazon.awscdk.services.dynamodb.TableProps getDynamoTableProps()

Optional user provided props to override the default props.

Default: - Default props are used

getExistingTableObj

@Nullable
default software.amazon.awscdk.services.dynamodb.Table getExistingTableObj()

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

Default: - None

getLogGroupProps

@Nullable
default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()

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

Default: - Default props are used

getReadRequestTemplate

@Nullable
default String getReadRequestTemplate()

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

getUpdateRequestTemplate

@Nullable
default String getUpdateRequestTemplate()

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

Default: - None

builder

static ApiGatewayToDynamoDBProps.Builder builder()

Returns:

a ApiGatewayToDynamoDBProps.Builder of ApiGatewayToDynamoDBProps