Skip to content

Latest commit

 

History

History
165 lines (110 loc) · 8.32 KB

README.md

File metadata and controls

165 lines (110 loc) · 8.32 KB

Track work items in an Aurora Serverless database with the SDK for .NET (v3)

Overview

This example shows you how to use the AWS SDK for .NET (v3) to create a REST service that lets you do the following:

  • Read, write, and update work items that are stored in an Amazon Aurora Serverless database.
  • Use Amazon Simple Email Service (Amazon SES) to send email reports of work items.
  • Create an AWS Secrets Manager secret that contains database credentials and use it to authenticate calls to the database.

⚠️ Important

  • Running this code might result in charges to your AWS account.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Prerequisites

To run the code in this example, you need the following:

Create the resources

Follow the instructions in the README for the Aurora Serverless application. to use the AWS Cloud Development Kit (AWS CDK) or AWS Command Line Interface (AWS CLI) to create and manage the resources.

Create the database table

After you have created the Aurora DB cluster and database, create a table to contain work items. You can do this by using either the AWS Command Line Interface (AWS CLI) or the AWS Management Console.

AWS CLI

Use the AWS CLI to create the work_items table by running the following command at a command prompt. Before you run, replace the following values with the output from the AWS CloudFormation setup script:

  • CLUSTER_ARN — Replace with the ARN of the Aurora DB cluster, such as arn:aws:rds:us-west-2:123456789012:cluster:doc-example-aurora-app-docexampleauroraappcluster-15xfvaEXAMPLE.
  • SECRET_ARN — Replace with the ARN of the secret that contains your database credentials, such as arn:aws:secretsmanager:us-west-2:123456789012:secret:docexampleauroraappsecret8B-xI1R8EXAMPLE-hfDaaj.
  • DATABASE — Replace with the name of the database, such as auroraappdb.

Tip: The caret ^ is the line continuation character for a Windows command prompt. If you run this command on another platform, replace the caret with the line continuation character for that platform.

aws rds-data execute-statement ^
    --resource-arn "CLUSTER_ARN" ^
    --database "DATABASE" ^
    --secret-arn "SECRET_ARN" ^
    --sql "CREATE TABLE items (id VARCHAR(45), description VARCHAR(400), guide VARCHAR(45), status VARCHAR(400), name VARCHAR(45), archived BOOLEAN);"

Verified email address

To email reports from the app, you must register at least one email address with Amazon SES. This verified email is specified as the sender for emailed reports.

  1. In a browser, navigate to the Amazon SES console.
  2. If necessary, select your AWS Region.
  3. Choose Verified identities.
  4. Choose Create identity.
  5. Select Email address.
  6. Enter an email address that you own.
  7. Choose Create identity.
  8. You will receive an email from Amazon Web Services that contains instructions on how to verify the email with Amazon SES. Follow the instructions in the email to complete verification.

Tip: For this example, you can use the same email account for both the sender and the recipient.

Build the code

This application has two parts: a user interface that uses React and a RESTful API created with C# and .NET 6. The React user interface is a single-page application (SPA) that interacts with the C# RESTful API by making GET, PUT, and POST requests.

RESTful API

The API uses the AmazonRDSDataServiceClient object to perform CRUD operations on an Aurora Serverless database. The API returns JSON data in an HTTP response, as shown in the following illustration.

AWS Tracker JSON response

Configure the application

Before you run the .NET application, set the configuration values for your Aurora Serverless database, and your verified sender email address in the appsettings.json file. Alternatively, add an appsettings.development.json file with your local settings.

Run the application

After the example compiles, you can run it from the command line. To do so, navigate to the folder that contains the .csproj file and run the following command:

dotnet run

Alternatively, you can run the example from within your IDE.

Aurora Item Tracker user interface

The .NET application is intended to be used with the Item Tracker web client. Follow the instructions in the README to set up and run this client. The client expects the API to be available at http://localhost:8080/api, which can be configured in launchSettings.json.

When the web application is running, you will see something like the following.

Aurora Item Tracker UI

Use the React web application

A user can perform the following tasks using the web application:

  1. View all items.
  2. View active items only.
  3. View archived items only.
  4. Add a new item.
  5. Change an active item into an archived item.
  6. Send a report as an email attachment.

The web application displays active, archived, or all items. For example, the following illustration shows the React application displaying active data.

Viewing active items

Here is the React application displaying archived data.

Viewing archived items

The user can insert a new item into the work item table from the user interface in the React front end application. In the following image, you can see the new item form.

Adding a new work item

The user can enter an email recipient in the Email text field and choose Send Report. The recipient will get an email like the following.

Report email

Active items are selected from the database and used to dynamically create a .csv document. Then, the application uses Amazon SES to email the document to the email address entered. The following image shows an example of a report.

A sample spreadsheet

Delete the resources

To avoid charges, delete all the resources that you created for this tutorial. Follow the instructions in the Destroying resources section of the README for the Aurora Serverless sample application.

Next steps

Congratulations! You have used the AWS SDK for .NET (v3) to create a REST service that manages data in an Amazon Aurora Serverless database, explored the database through the React frontend web application, and sent reports using Amazon SES.

Additional resources

For more AWS multiservice examples, see cross-service.