Microsoft.Orleans.Persistence.DynamoDB 9.2.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Microsoft.Orleans.Persistence.DynamoDB --version 9.2.1
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Persistence.DynamoDB -Version 9.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.Orleans.Persistence.DynamoDB" Version="9.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Persistence.DynamoDB" Version="9.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Persistence.DynamoDB" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Microsoft.Orleans.Persistence.DynamoDB --version 9.2.1
                    


                    

                
#r "nuget: Microsoft.Orleans.Persistence.DynamoDB, 9.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Microsoft.Orleans.Persistence.DynamoDB@9.2.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Microsoft.Orleans.Persistence.DynamoDB&version=9.2.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Persistence.DynamoDB&version=9.2.1
                    


                            Install as a Cake Tool

Microsoft Orleans Persistence for DynamoDB

Introduction

Microsoft Orleans Persistence for DynamoDB provides grain persistence for Microsoft Orleans using Amazon's DynamoDB. This allows your grains to persist their state in DynamoDB and reload it when they are reactivated.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Persistence.DynamoDB

Example - Configuring DynamoDB Persistence

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure DynamoDB as grain storage
            .AddDynamoDBGrainStorage(
                name: "dynamoStore",
                configureOptions: options =>
                {
                    options.AccessKey = "YOUR_AWS_ACCESS_KEY";
                    options.SecretKey = "YOUR_AWS_SECRET_KEY";
                    options.Region = "us-east-1";
                    options.TableName = "OrleansGrainState";
                    options.CreateIfNotExists = true;
                });
    });

// Run the host
await builder.RunAsync();

Example - Using Grain Storage in a Grain

// Define grain state class

public class MyGrainState
{
    public string Data { get; set; }
    public int Version { get; set; }
}

// Grain implementation that uses the DynamoDB storage
public class MyGrain : Grain, IMyGrain, IGrainWithStringKey
{
    private readonly IPersistentState<MyGrainState> _state;

    public MyGrain([PersistentState("state", "dynamoStore")] IPersistentState<MyGrainState> state)
    {
        _state = state;
    }

    public async Task SetData(string data)
    {
        _state.State.Data = data;
        _state.State.Version++;
        await _state.WriteStateAsync();
    }

    public Task<string> GetData()
    {
        return Task.FromResult(_state.State.Data);
    }
}

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.Orleans.Persistence.DynamoDB:

Package Downloads
Microsoft.Orleans.OrleansAWSUtils

Library of utility types for Amazon AWS of Microsoft Orleans.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Orleans.Persistence.DynamoDB:

Repository Stars
PiotrJustyna/road-to-orleans
This repository illustrates the road to orleans with practical, real-life examples. From most basic, to more advanced techniques.
Version Downloads Last Updated
9.2.1 2,284 7/16/2025
9.2.0 517 7/14/2025
9.2.0-preview3 299 6/10/2025
9.2.0-preview2 158 6/4/2025
9.2.0-preview1 124 4/4/2025
9.1.2 38,384 2/13/2025
9.0.1 33,129 11/23/2024
9.0.0 1,091 11/14/2024
8.2.0 27,178 7/12/2024
8.2.0-preview1 192 5/22/2024
8.1.0 44,262 4/17/2024
8.1.0-preview3 243 3/11/2024
8.1.0-preview2 152 2/23/2024
8.1.0-preview1 154 2/13/2024
8.0.0 50,272 1/5/2024
8.0.0-rc2 268 12/20/2023
8.0.0-rc1 180 12/4/2023
7.2.7 162 10/15/2024
7.2.6 4,974 3/9/2024
7.2.5 199 2/22/2024
7.2.4 5,880 12/2/2023
7.2.3 14,794 11/3/2023
7.2.2 4,019 10/16/2023
7.2.1 12,549 7/11/2023
7.2.0 272 7/7/2023
7.1.2 22,874 4/19/2023
7.1.1 9,597 3/23/2023
7.1.0 4,121 2/1/2023
7.0.0 12,648 11/8/2022
7.0.0-rc2 328 10/19/2022
4.0.0-preview2 1,716 8/4/2022
4.0.0-preview1 2,077 2/10/2022
3.8.0 176 5/6/2025
3.8.0-preview5 222 5/12/2025
3.8.0-preview3 198 4/8/2025
3.8.0-preview2 122 4/4/2025
3.8.0-preview1 195 3/31/2025
3.7.2 3,551 5/10/2024
3.7.1 14,779 5/27/2023
3.7.0 1,775 3/23/2023
3.6.5 43,642 8/15/2022
3.6.4 529 8/10/2022
3.6.3 517 8/4/2022
3.6.2 16,389 4/15/2022
3.6.1 896 4/5/2022
3.6.0 8,055 1/20/2022
3.5.1 10,811 11/8/2021
3.5.0 17,445 9/3/2021
3.4.4 515 10/4/2021
3.4.3 6,513 6/3/2021
3.4.2 3,399 4/5/2021
3.4.1 11,564 2/3/2021
3.4.0 85,357 1/6/2021
3.4.0-rc1 515 12/9/2020
3.3.0 18,470 9/9/2020
3.3.0-rc2 486 9/2/2020
3.3.0-rc1 476 8/19/2020
3.2.2 6,125 7/22/2020
3.2.1 854 7/2/2020
3.2.0 1,372 6/4/2020
3.2.0-rc2 541 5/20/2020
3.2.0-rc1 491 5/7/2020
3.1.7 2,060 5/19/2020
3.1.6 6,060 4/16/2020
3.1.5 776 4/9/2020
3.1.4 1,289 3/26/2020
3.1.3 1,090 3/16/2020
3.1.2 3,092 3/5/2020
3.1.0 1,042 2/23/2020
3.1.0-rc3 577 2/13/2020
3.1.0-rc2 594 2/12/2020
3.1.0-rc1 624 2/10/2020
3.0.2 2,598 12/12/2019
3.0.1 841 11/27/2019
3.0.0 1,328 10/24/2019
3.0.0-rc2 638 10/16/2019
3.0.0-rc1 648 10/9/2019
3.0.0-beta1 1,279 8/16/2019
2.4.5 13,077 12/29/2019
2.4.4 1,195 11/27/2019
2.4.3 1,453 10/10/2019
2.4.2 5,787 8/31/2019
2.4.1 1,758 8/14/2019
2.4.0 1,540 8/8/2019
2.3.6 1,821 7/24/2019
2.3.5 5,260 6/14/2019
2.3.4 1,617 6/4/2019
2.3.3 1,324 6/2/2019
2.3.2 2,204 5/9/2019
2.3.1 1,448 4/26/2019
2.3.0 3,150 3/20/2019
2.3.0-rc2 718 3/13/2019
2.3.0-rc1 785 3/4/2019
2.2.4 2,387 2/25/2019
2.2.3 2,611 1/17/2019
2.2.0 1,517 12/13/2018
2.2.0-rc1 884 12/4/2018
2.2.0-beta1 1,010 10/21/2018
2.1.2 3,726 10/11/2018
2.1.0 1,726 9/28/2018
2.1.0-rc2 1,230 9/21/2018
2.1.0-rc1 1,245 9/14/2018
2.1.0-beta1 1,221 8/27/2018
2.0.0 8,712 3/28/2018
2.0.0-rc2 5,120 3/13/2018
2.0.0-rc1 1,237 2/26/2018
2.0.0-beta3 3,079 12/21/2017