Microsoft.Orleans.Reminders.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.Reminders.DynamoDB --version 9.2.1
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Reminders.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.Reminders.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.Reminders.DynamoDB" Version="9.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Reminders.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.Reminders.DynamoDB --version 9.2.1
                    


                    

                
#r "nuget: Microsoft.Orleans.Reminders.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.Reminders.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.Reminders.DynamoDB&version=9.2.1
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Microsoft Orleans Reminders for DynamoDB

Introduction

Microsoft Orleans Reminders for DynamoDB provides persistence for Orleans reminders using Amazon's DynamoDB. This allows your Orleans applications to schedule persistent reminders that will be triggered even after silo restarts or grain deactivation.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Reminders.DynamoDB

Example - Configuring DynamoDB Reminders

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

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure DynamoDB as reminder storage
            .UseDynamoDBReminderService(options =>
            {
                options.AccessKey = "YOUR_AWS_ACCESS_KEY";
                options.SecretKey = "YOUR_AWS_SECRET_KEY";
                options.Region = "us-east-1";
                options.TableName = "OrleansReminders";
                options.CreateIfNotExists = true;
            });
    });

// Run the host
var host = builder.Build();
await host.StartAsync();

// Get a reference to the grain
var reminderGrain = host.Services.GetRequiredService<IGrainFactory>()
    .GetGrain<IReminderGrain>("my-reminder-grain");

// Start the reminder
await reminderGrain.StartReminder("ExampleReminder");
Console.WriteLine("Reminder started!");

// Keep the host running until the application is shut down
await host.WaitForShutdownAsync();

Example - Using Reminders in a Grain

using System;
using System.Threading.Tasks;
using Orleans;
using Orleans.Runtime;

namespace ReminderExample;

public interface IReminderGrain : IGrainWithStringKey
{
    Task StartReminder(string reminderName);
    Task StopReminder();
}

public class ReminderGrain : Grain, IReminderGrain, IRemindable
{
    private string _reminderName = "MyReminder";

    public async Task StartReminder(string reminderName)
    {
        _reminderName = reminderName;
        
        // Register a persistent reminder
        await RegisterOrUpdateReminder(
            reminderName,
            TimeSpan.FromMinutes(2),  // Time to delay before the first tick (must be > 1 minute)
            TimeSpan.FromMinutes(5)); // Period of the reminder (must be > 1 minute)
    }

    public async Task StopReminder()
    {
        // Find and unregister the reminder
        var reminder = await GetReminder(_reminderName);
        if (reminder != null)
        {
            await UnregisterReminder(reminder);
        }
    }

    public Task ReceiveReminder(string reminderName, TickStatus status)
    {
        // This method is called when the reminder ticks
        Console.WriteLine($"Reminder {reminderName} triggered at {DateTime.UtcNow}. Status: {status}");
        return Task.CompletedTask;
    }
}

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.Reminders.DynamoDB:

Package Downloads
Microsoft.Orleans.OrleansAWSUtils

Library of utility types for Amazon AWS of Microsoft Orleans.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
9.2.1 147 7/16/2025
9.2.0 311 7/14/2025
9.2.0-preview3 314 6/10/2025
9.2.0-preview2 153 6/4/2025
9.2.0-preview1 589 4/4/2025
9.1.2 34,348 2/13/2025
9.0.1 31,680 11/23/2024
9.0.0 753 11/14/2024
8.2.0 28,739 7/12/2024
8.2.0-preview1 183 5/22/2024
8.1.0 42,515 4/17/2024
8.1.0-preview3 152 3/11/2024
8.1.0-preview2 132 2/23/2024
8.1.0-preview1 133 2/13/2024
8.0.0 39,069 1/5/2024
8.0.0-rc2 268 12/20/2023
8.0.0-rc1 175 12/4/2023
7.2.7 152 10/15/2024
7.2.6 5,536 3/9/2024
7.2.5 185 2/22/2024
7.2.4 10,681 12/2/2023
7.2.3 4,273 11/3/2023
7.2.2 4,530 10/16/2023
7.2.1 14,219 7/11/2023
7.2.0 266 7/7/2023
7.1.2 27,950 4/19/2023
7.1.1 7,813 3/23/2023
7.1.0 2,587 2/1/2023
7.0.0 16,202 11/8/2022
7.0.0-rc2 338 10/19/2022
4.0.0-preview2 1,673 8/4/2022
4.0.0-preview1 2,007 2/10/2022
3.8.0 177 5/6/2025
3.8.0-preview5 222 5/12/2025
3.8.0-preview3 164 4/8/2025
3.8.0-preview2 111 4/4/2025
3.8.0-preview1 171 3/31/2025
3.7.2 6,900 5/10/2024
3.7.1 15,599 5/27/2023
3.7.0 2,670 3/23/2023
3.6.5 38,294 8/15/2022
3.6.4 491 8/10/2022
3.6.3 495 8/4/2022
3.6.2 11,085 4/15/2022
3.6.1 821 4/5/2022
3.6.0 11,989 1/20/2022
3.5.1 6,287 11/8/2021
3.5.0 22,111 9/3/2021
3.4.4 526 10/4/2021
3.4.3 6,010 6/3/2021
3.4.2 2,423 4/5/2021
3.4.1 3,749 2/3/2021
3.4.0 82,231 1/6/2021
3.4.0-rc1 480 12/9/2020
3.3.0 15,781 9/9/2020
3.3.0-rc2 467 9/2/2020
3.3.0-rc1 462 8/19/2020
3.2.2 5,875 7/22/2020
3.2.1 825 7/2/2020
3.2.0 1,226 6/4/2020
3.2.0-rc2 524 5/20/2020
3.2.0-rc1 472 5/7/2020
3.1.7 1,955 5/19/2020
3.1.6 5,448 4/16/2020
3.1.5 742 4/9/2020
3.1.4 1,271 3/26/2020
3.1.3 1,010 3/16/2020
3.1.2 1,833 3/5/2020
3.1.0 756 2/23/2020
3.1.0-rc3 615 2/13/2020
3.1.0-rc2 610 2/12/2020
3.1.0-rc1 611 2/10/2020
3.0.2 15,778 12/12/2019
3.0.1 721 11/27/2019
3.0.0 916 10/24/2019
3.0.0-rc2 574 10/16/2019
3.0.0-rc1 524 10/9/2019
3.0.0-beta1 1,095 8/16/2019
2.4.5 13,086 12/29/2019
2.4.4 1,147 11/27/2019
2.4.3 1,462 10/10/2019
2.4.2 4,623 8/31/2019
2.4.1 1,512 8/14/2019
2.4.0 1,556 8/8/2019
2.3.6 1,718 7/24/2019
2.3.5 6,527 6/14/2019
2.3.4 1,647 6/4/2019
2.3.3 1,228 6/2/2019
2.3.2 1,942 5/9/2019
2.3.1 1,456 4/26/2019
2.3.0 3,087 3/20/2019
2.3.0-rc2 710 3/13/2019
2.3.0-rc1 797 3/4/2019
2.2.4 2,310 2/25/2019
2.2.3 2,648 1/17/2019
2.2.0 1,604 12/13/2018
2.2.0-rc1 872 12/4/2018
2.2.0-beta1 939 10/21/2018
2.1.2 3,701 10/11/2018
2.1.0 1,744 9/28/2018
2.1.0-rc2 1,207 9/21/2018
2.1.0-rc1 1,263 9/14/2018
2.1.0-beta1 1,201 8/27/2018
2.0.0 8,728 3/28/2018
2.0.0-rc2 4,991 3/13/2018
2.0.0-rc1 1,211 2/26/2018
2.0.0-beta3 3,091 12/21/2017