Multi-key support for DynamoDB GSIs

[petro2050]

Describe the feature

Recently, multi-key support for DynamoDB GSIs was introduced https://aws.amazon.com/blogs/database/multi-key-support-for-global-secondary-index-in-amazon-dynamodb/.

I'm trying to create a GlobalSecondaryIndex from namespace Amazon.DynamoDBv2.Model. However, it seems the KeySchema does not support multi-attribute hash and sort keys. When running tests locally, I received Key Schema must at most consist of the hash and range key of a table.

Note that I was able to create multi-key GSIs via CDK in production. For development and testing, I use DynamoDB local. Can the SDK have parity with CDK?

Use Case

This will help me run manual and automated tests to ensure the multi-key GSIs are configured correctly and we can read from them.

Proposed Solution

No response

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS .NET SDK and/or Package version used

AWSSDK.DynamoDBv2 4.0.10.1

Targeted .NET Platform

.NET 10

Operating System and version

macOS Sequoia

[normj]

Here is my code I wrote that successfully created a global index with 2 hash keys and 2 range keys. If this doesn't help can you share your code to help me understand what you are doing different then me.

using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;

var client = new AmazonDynamoDBClient();

var createTableRequest = new CreateTableRequest
{
    TableName = "CompositeKeyTable",
    KeySchema = new List<KeySchemaElement>
    {
        new KeySchemaElement
        {
            AttributeName = "PK1",
            KeyType = KeyType.HASH
        },
        new KeySchemaElement
        {
            AttributeName = "SK1",
            KeyType = KeyType.RANGE
        }
    },
    BillingMode = BillingMode.PAY_PER_REQUEST,
    GlobalSecondaryIndexes = new List<GlobalSecondaryIndex>
    {
        new GlobalSecondaryIndex
        {
            IndexName = "GSI1",
            KeySchema = new List<KeySchemaElement>
            {
                new KeySchemaElement
                {
                    AttributeName = "GSPK1",
                    KeyType = KeyType.HASH
                },
                new KeySchemaElement
                {
                    AttributeName = "GSPK2",
                    KeyType = KeyType.HASH
                },
                new KeySchemaElement
                {
                    AttributeName = "GSRK1",
                    KeyType = KeyType.RANGE
                },
                new KeySchemaElement
                {
                    AttributeName = "GSRK2",
                    KeyType = KeyType.RANGE
                }
            },
            Projection = new Projection
            {
                ProjectionType = ProjectionType.ALL
            }
        }
    },
    AttributeDefinitions = new List<AttributeDefinition>
    {
        new AttributeDefinition
        {
            AttributeName = "PK1",
            AttributeType = ScalarAttributeType.S
        },
        new AttributeDefinition
        {
            AttributeName = "SK1",
            AttributeType = ScalarAttributeType.S
        },
        new AttributeDefinition
        {
            AttributeName = "GSPK1",
            AttributeType = ScalarAttributeType.S
        },
        new AttributeDefinition
        {
            AttributeName = "GSPK2",
            AttributeType = ScalarAttributeType.S
        },
        new AttributeDefinition
        {
            AttributeName = "GSRK1",
            AttributeType = ScalarAttributeType.S
        },
        new AttributeDefinition
        {
            AttributeName = "GSRK2",
            AttributeType = ScalarAttributeType.S
        }
    }
};

try
{
    await client.CreateTableAsync(createTableRequest);
    Console.WriteLine("Table created successfully.");
}
catch(Exception ex)
{
    Console.WriteLine($"Error creating table: {ex.Message}");
}

[petro2050]

@normj the issue seems related to how AmazonDynamoDBClient is instantiated. If I run your code, it works. In my case, I pass AmazonDynamoDBConfig to it after starting Docker with port 8042. I set the service URL to amazonDynamoDBConfig.ServiceURL = $"http://{IPAddress.Loopback}:{port}";. Additionally, I pass dummy credentials public static BasicAWSCredentials LocalAWSCredentials => new("accessKey", "secretKey");.

[normj]

@petro2050 Sounds like you are trying to connect to an AWS emulator like LocalStack and that emulator hasn't been updated yet. The error message you are getting is not coming from the SDK but the service endpoint.

Nevermind my previous message. I see now you are talking about DynamoDB local. Looks like the team hasn't yet updated and released a new version of DynamoDB local with multi key support. I'll ping the DDB team to see if they have any info when that will be updated.

[normj]

I heard back from the DynamoDB team and they said they can't give a date yet but are working on adding multi-key support to DynamoDB local and a new release will happen in the near future. It is unlikely to be this month but hopefully soon after.

[normj]

Closing the issue since this is not an SDK issue and we won't get any specific notification when the new DynamoDB local will be released. Monitor the repo and the release history page for DynamoDB local for tracking if the new version has been released.