Skip to content
v2.278.0

DynamoDBEventProperty Struct ​

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';
const dynamoDBEventProperty: sam.CfnFunction.DynamoDBEventProperty = {
  startingPosition: 'startingPosition',
  stream: 'stream',

  // the properties below are optional
  batchSize: 123,
  bisectBatchOnFunctionError: false,
  destinationConfig: {
    onFailure: {
      destination: 'destination',

      // the properties below are optional
      type: 'type',
    },
  },
  enabled: false,
  maximumBatchingWindowInSeconds: 123,
  maximumRecordAgeInSeconds: 123,
  maximumRetryAttempts: 123,
  parallelizationFactor: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

dynamo_db_event_property = sam.CfnFunction.DynamoDBEventProperty(
    starting_position="startingPosition",
    stream="stream",

    # the properties below are optional
    batch_size=123,
    bisect_batch_on_function_error=False,
    destination_config=sam.CfnFunction.DestinationConfigProperty(
        on_failure=sam.CfnFunction.DestinationProperty(
            destination="destination",

            # the properties below are optional
            type="type"
        )
    ),
    enabled=False,
    maximum_batching_window_in_seconds=123,
    maximum_record_age_in_seconds=123,
    maximum_retry_attempts=123,
    parallelization_factor=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sam.*;

DynamoDBEventProperty dynamoDBEventProperty = DynamoDBEventProperty.builder()
        .startingPosition("startingPosition")
        .stream("stream")

        // the properties below are optional
        .batchSize(123)
        .bisectBatchOnFunctionError(false)
        .destinationConfig(DestinationConfigProperty.builder()
                .onFailure(DestinationProperty.builder()
                        .destination("destination")

                        // the properties below are optional
                        .type("type")
                        .build())
                .build())
        .enabled(false)
        .maximumBatchingWindowInSeconds(123)
        .maximumRecordAgeInSeconds(123)
        .maximumRetryAttempts(123)
        .parallelizationFactor(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SAM;

var dynamoDBEventProperty = new DynamoDBEventProperty {
    StartingPosition = "startingPosition",
    Stream = "stream",

    // the properties below are optional
    BatchSize = 123,
    BisectBatchOnFunctionError = false,
    DestinationConfig = new DestinationConfigProperty {
        OnFailure = new DestinationProperty {
            Destination = "destination",

            // the properties below are optional
            Type = "type"
        }
    },
    Enabled = false,
    MaximumBatchingWindowInSeconds = 123,
    MaximumRecordAgeInSeconds = 123,
    MaximumRetryAttempts = 123,
    ParallelizationFactor = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dynamoDBEventProperty := &DynamoDBEventProperty{
	StartingPosition: jsii.String("startingPosition"),
	Stream: jsii.String("stream"),

	// the properties below are optional
	BatchSize: jsii.Number(123),
	BisectBatchOnFunctionError: jsii.Boolean(false),
	DestinationConfig: &DestinationConfigProperty{
		OnFailure: &DestinationProperty{
			Destination: jsii.String("destination"),

			// the properties below are optional
			Type: jsii.String("type"),
		},
	},
	Enabled: jsii.Boolean(false),
	MaximumBatchingWindowInSeconds: jsii.Number(123),
	MaximumRecordAgeInSeconds: jsii.Number(123),
	MaximumRetryAttempts: jsii.Number(123),
	ParallelizationFactor: jsii.Number(123),
}

Properties ​

batchSizeoptionalnumberbatch_sizeoptionalint | floatbatchSizeoptionalNumberBatchSizeoptionaldoubleBatchSizeoptional*float64 #
bisectBatchOnFunctionErroroptionalboolean | IResolvablebisect_batch_on_function_erroroptionaltyping.Union[bool, IResolvable]bisectBatchOnFunctionErroroptionalBooleanBisectBatchOnFunctionErroroptionalboolBisectBatchOnFunctionErroroptionalinterface{} #
destinationConfigoptionalIResolvable | CfnFunction.DestinationConfigPropertydestination_configoptionaltyping.Union[IResolvable, DestinationConfigProperty]destinationConfigoptionalIResolvableDestinationConfigoptionalIResolvableDestinationConfigoptionalinterface{} #
enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{} #
maximumBatchingWindowInSecondsoptionalnumbermaximum_batching_window_in_secondsoptionalint | floatmaximumBatchingWindowInSecondsoptionalNumberMaximumBatchingWindowInSecondsoptionaldoubleMaximumBatchingWindowInSecondsoptional*float64 #
maximumRecordAgeInSecondsoptionalnumbermaximum_record_age_in_secondsoptionalint | floatmaximumRecordAgeInSecondsoptionalNumberMaximumRecordAgeInSecondsoptionaldoubleMaximumRecordAgeInSecondsoptional*float64 #
maximumRetryAttemptsoptionalnumbermaximum_retry_attemptsoptionalint | floatmaximumRetryAttemptsoptionalNumberMaximumRetryAttemptsoptionaldoubleMaximumRetryAttemptsoptional*float64 #
parallelizationFactoroptionalnumberparallelization_factoroptionalint | floatparallelizationFactoroptionalNumberParallelizationFactoroptionaldoubleParallelizationFactoroptional*float64 #
startingPositionstringstarting_positionstrstartingPositionStringStartingPositionstringStartingPosition*string required #
streamstringstreamstrstreamStringStreamstringStream*string required #