Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.ProjectionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.ProjectionProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.ProjectionProperty
extends software.amazon.jsii.JsiiSerializable

Represents attributes that are copied (projected) from the table into an index.

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 ProjectionProperty projectionProperty = ProjectionProperty.builder()
         .nonKeyAttributes(List.of("nonKeyAttributes"))
         .projectionType("projectionType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.ProjectionProperty.Builder	builder()
default List<String>	getNonKeyAttributes()	Represents the non-key attribute names which will be projected into the index.
default String	getProjectionType()	The set of attributes that are projected into the index:.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNonKeyAttributes

@Stability(Stable)
@Nullable
default List<String> getNonKeyAttributes()

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html#cfn-dynamodb-table-projection-nonkeyattributes

getProjectionType

@Stability(Stable)
@Nullable
default String getProjectionType()

The set of attributes that are projected into the index:.

• KEYS_ONLY - Only the index and primary keys are projected into the index.
• INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
• ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html#cfn-dynamodb-table-projection-projectiontype

builder

@Stability(Stable)
static CfnTable.ProjectionProperty.Builder builder()

Returns:

a CfnTable.ProjectionProperty.Builder of CfnTable.ProjectionProperty