software.amazon.awscdk.services.dynamodb

Enum StreamViewType

java.lang.Object

java.lang.Enum<StreamViewType>

software.amazon.awscdk.services.dynamodb.StreamViewType

All Implemented Interfaces:

Serializable, Comparable<StreamViewType>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.079Z")
 @Stability(value=Stable)
public enum StreamViewType
extends Enum<StreamViewType>

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.dynamodb.*;
 Function fn;
 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .stream(StreamViewType.NEW_IMAGE)
         .build();
 fn.addEventSource(DynamoEventSource.Builder.create(table)
         .startingPosition(StartingPosition.LATEST)
         .filters(List.of(Map.of("eventName", FilterRule.isEqual("INSERT"))))
         .build());
 

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_StreamSpecification.html

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEYS_ONLY Only the key attributes of the modified item are written to the stream.
NEW_AND_OLD_IMAGES Both the new and the old item images of the item are written to the stream.
NEW_IMAGE The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE The entire item, as it appeared before it was modified, is written to the stream.

Method Summary

Modifier and Type	Method and Description
static StreamViewType	valueOf(String name) Returns the enum constant of this type with the specified name.
static StreamViewType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEW_IMAGE

@Stability(value=Stable)
public static final StreamViewType NEW_IMAGE

The entire item, as it appears after it was modified, is written to the stream.

OLD_IMAGE

@Stability(value=Stable)
public static final StreamViewType OLD_IMAGE

The entire item, as it appeared before it was modified, is written to the stream.

NEW_AND_OLD_IMAGES

@Stability(value=Stable)
public static final StreamViewType NEW_AND_OLD_IMAGES

Both the new and the old item images of the item are written to the stream.

KEYS_ONLY

@Stability(value=Stable)
public static final StreamViewType KEYS_ONLY

Only the key attributes of the modified item are written to the stream.

Method Detail

values

public static StreamViewType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StreamViewType c : StreamViewType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StreamViewType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null