Class KeySchema

A description of a key schema of an LSI, GSI or Table.

Inheritance

object

KeySchema

Implements

IKeySchema

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.DynamoDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class KeySchema : IKeySchema

Syntax (vb)

Public Class KeySchema Implements IKeySchema

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.DynamoDB;

            var keySchema = new KeySchema {
                PartitionKeys = new [] { new Attribute {
                    Name = "name",
                    Type = AttributeType.BINARY
                } },
                SortKeys = new [] { new Attribute {
                    Name = "name",
                    Type = AttributeType.BINARY
                } }
            };

Synopsis

Constructors

KeySchema()

A description of a key schema of an LSI, GSI or Table.

Properties

PartitionKeys	Partition key definition.
SortKeys	Sort key definition.

Constructors

KeySchema()

A description of a key schema of an LSI, GSI or Table.

public KeySchema()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.DynamoDB;

            var keySchema = new KeySchema {
                PartitionKeys = new [] { new Attribute {
                    Name = "name",
                    Type = AttributeType.BINARY
                } },
                SortKeys = new [] { new Attribute {
                    Name = "name",
                    Type = AttributeType.BINARY
                } }
            };

Properties

PartitionKeys

Partition key definition.

public IAttribute[] PartitionKeys { get; set; }

Property Value

IAttribute[]

Remarks

This array has at least one, but potentially multiple entries. Together, they form the partition key.

SortKeys

Sort key definition.

public IAttribute[] SortKeys { get; set; }

Property Value

IAttribute[]

Remarks

This array has zero or more entries. Together, they form the sort key.

Implements

IKeySchema