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 3,082 7/16/2025
9.2.0 559 7/14/2025
9.2.0-preview3 326 6/10/2025
9.2.0-preview2 168 6/4/2025
9.2.0-preview1 1,320 4/4/2025
9.1.2 38,557 2/13/2025
9.0.1 33,004 11/23/2024
9.0.0 776 11/14/2024
8.2.0 30,783 7/12/2024
8.2.0-preview1 196 5/22/2024
8.1.0 42,586 4/17/2024
8.1.0-preview3 159 3/11/2024
8.1.0-preview2 139 2/23/2024
8.1.0-preview1 139 2/13/2024
8.0.0 42,984 1/5/2024
8.0.0-rc2 275 12/20/2023
8.0.0-rc1 182 12/4/2023
7.2.7 166 10/15/2024
7.2.6 5,555 3/9/2024
7.2.5 201 2/22/2024
7.2.4 10,700 12/2/2023
7.2.3 4,369 11/3/2023
7.2.2 4,544 10/16/2023
7.2.1 14,250 7/11/2023
7.2.0 289 7/7/2023
7.1.2 28,137 4/19/2023
7.1.1 7,844 3/23/2023
7.1.0 2,614 2/1/2023
7.0.0 16,230 11/8/2022
7.0.0-rc2 365 10/19/2022
4.0.0-preview2 1,697 8/4/2022
4.0.0-preview1 2,036 2/10/2022
3.8.0 202 5/6/2025
3.8.0-preview5 230 5/12/2025
3.8.0-preview3 175 4/8/2025
3.8.0-preview2 124 4/4/2025
3.8.0-preview1 182 3/31/2025
3.7.2 8,940 5/10/2024
3.7.1 16,225 5/27/2023
3.7.0 2,700 3/23/2023
3.6.5 39,944 8/15/2022
3.6.4 518 8/10/2022
3.6.3 520 8/4/2022
3.6.2 11,206 4/15/2022
3.6.1 845 4/5/2022
3.6.0 12,014 1/20/2022
3.5.1 6,309 11/8/2021
3.5.0 22,139 9/3/2021
3.4.4 553 10/4/2021
3.4.3 6,033 6/3/2021
3.4.2 2,453 4/5/2021
3.4.1 3,783 2/3/2021
3.4.0 85,153 1/6/2021
3.4.0-rc1 507 12/9/2020
3.3.0 15,812 9/9/2020
3.3.0-rc2 499 9/2/2020
3.3.0-rc1 488 8/19/2020
3.2.2 5,908 7/22/2020
3.2.1 856 7/2/2020
3.2.0 1,253 6/4/2020
3.2.0-rc2 550 5/20/2020
3.2.0-rc1 511 5/7/2020
3.1.7 1,986 5/19/2020
3.1.6 5,480 4/16/2020
3.1.5 767 4/9/2020
3.1.4 1,301 3/26/2020
3.1.3 1,037 3/16/2020
3.1.2 1,863 3/5/2020
3.1.0 788 2/23/2020
3.1.0-rc3 647 2/13/2020
3.1.0-rc2 643 2/12/2020
3.1.0-rc1 644 2/10/2020
3.0.2 15,813 12/12/2019
3.0.1 754 11/27/2019
3.0.0 950 10/24/2019
3.0.0-rc2 605 10/16/2019
3.0.0-rc1 558 10/9/2019
3.0.0-beta1 1,126 8/16/2019
2.4.5 13,118 12/29/2019
2.4.4 1,173 11/27/2019
2.4.3 1,488 10/10/2019
2.4.2 4,652 8/31/2019
2.4.1 1,539 8/14/2019
2.4.0 1,589 8/8/2019
2.3.6 1,748 7/24/2019
2.3.5 6,560 6/14/2019
2.3.4 1,674 6/4/2019
2.3.3 1,256 6/2/2019
2.3.2 1,973 5/9/2019
2.3.1 1,486 4/26/2019
2.3.0 3,116 3/20/2019
2.3.0-rc2 737 3/13/2019
2.3.0-rc1 825 3/4/2019
2.2.4 2,398 2/25/2019
2.2.3 2,683 1/17/2019
2.2.0 1,633 12/13/2018
2.2.0-rc1 899 12/4/2018
2.2.0-beta1 970 10/21/2018
2.1.2 3,734 10/11/2018
2.1.0 1,801 9/28/2018
2.1.0-rc2 1,259 9/21/2018
2.1.0-rc1 1,312 9/14/2018
2.1.0-beta1 1,251 8/27/2018
2.0.0 8,809 3/28/2018
2.0.0-rc2 5,039 3/13/2018
2.0.0-rc1 1,261 2/26/2018
2.0.0-beta3 3,162 12/21/2017