Class: AWSCDK::DynamoDB::CfnTable::ProjectionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::DynamoDB::CfnTable::ProjectionProperty

Defined in:

dynamo_db/cfn_table.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #non_key_attributes ⇒ Array<String>^? readonly

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

• #projection_type ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(non_key_attributes: nil, projection_type: nil) ⇒ ProjectionProperty constructor

  A new instance of ProjectionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(non_key_attributes: nil, projection_type: nil) ⇒ ProjectionProperty

Returns a new instance of ProjectionProperty.

Parameters:

• non_key_attributes (Array<String>, nil) (defaults to: nil) —

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

• projection_type (String, nil) (defaults to: nil) —

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

# File 'dynamo_db/cfn_table.rb', line 1430

def initialize(non_key_attributes: nil, projection_type: nil)
  @non_key_attributes = non_key_attributes
  Jsii::Type.check_type(@non_key_attributes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "nonKeyAttributes") unless @non_key_attributes.nil?
  @projection_type = projection_type
  Jsii::Type.check_type(@projection_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectionType") unless @projection_type.nil?
end

Instance Attribute Details

#non_key_attributes ⇒ Array<String>^? (readonly)

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

For global and local secondary indexes, the total count of NonKeyAttributes summed across all of the 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. This limit only applies when you specify the ProjectionType of INCLUDE . You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

Returns:

• (Array<String>, nil)

See Also:

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

# File 'dynamo_db/cfn_table.rb', line 1443

def non_key_attributes
  @non_key_attributes
end

#projection_type ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'dynamo_db/cfn_table.rb', line 1454

def projection_type
  @projection_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'dynamo_db/cfn_table.rb', line 1456

def self.jsii_properties
  {
    :non_key_attributes => "nonKeyAttributes",
    :projection_type => "projectionType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'dynamo_db/cfn_table.rb', line 1463

def to_jsii
  result = {}
  result.merge!({
    "nonKeyAttributes" => @non_key_attributes,
    "projectionType" => @projection_type,
  })
  result.compact
end