Package software.amazon.awscdk.services.dynamodb

Enum ProjectionType

java.lang.Object

java.lang.Enum<ProjectionType>

software.amazon.awscdk.services.dynamodb.ProjectionType

All Implemented Interfaces:

Serializable, Comparable<ProjectionType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.286Z")
@Stability(Stable)
public enum ProjectionType
extends Enum<ProjectionType>

The set of attributes that are projected into the index.

See Also:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All of the table attributes are projected into the index.
INCLUDE	Only the specified table attributes are projected into the index.
KEYS_ONLY	Only the index and primary keys are projected into the index.

Method Summary

Modifier and Type	Method	Description
static ProjectionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProjectionType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

KEYS_ONLY

@Stability(Stable)
public static final ProjectionType KEYS_ONLY

Only the index and primary keys are projected into the index.

INCLUDE

@Stability(Stable)
public static final ProjectionType INCLUDE

Only the specified table attributes are projected into the index.

The list of projected attributes is in nonKeyAttributes.

ALL

@Stability(Stable)
public static final ProjectionType ALL

All of the table attributes are projected into the index.

Method Details

values

public static ProjectionType[] values()

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

Returns:

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

valueOf

public static ProjectionType 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