.NET Development Environment on the AWS Cloud

Quick Start Reference Deployment

QS

January 2022
Andy Hopper, AWS Microsoft Workloads team
Dave May, AWS Integration & Automation team

Visit our GitHub repository for source files and to post feedback, report bugs, or submit feature ideas for this Quick Start.

This Quick Start was created by Amazon Web Services (AWS). Quick Starts are automated reference deployments that use AWS CloudFormation templates to deploy key technologies on AWS, following AWS best practices.

Overview

This guide provides instructions for deploying the .NET Development Environment Quick Start reference architecture on the AWS Cloud.

This Quick Start is for developers who want to provision an environment for building and maintaining .NET and .NET Framework applications on AWS.

.NET Development Environment on AWS

This Quick Start installs the .NET software development kit (SDK) and other development tools you need to write .NET code. An AWS CloudFormation template automatically deploys the software into an Amazon Elastic Compute Cloud (Amazon EC2) Windows instance, eliminating many manual steps and standardizing the AWS Cloud environment.

AWS costs

You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start. There is no additional cost for using the Quick Start.

The AWS CloudFormation templates for Quick Starts include configuration parameters that you can customize. Some of the settings, such as the instance type, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service you use. Prices are subject to change.

After you deploy the Quick Start, create AWS Cost and Usage Reports to deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. These reports provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, see What are AWS Cost and Usage Reports?

Software licenses

This Quick Start includes a trial license for JetBrains Rider. If you want to use the Quick Start in your production environment, sign up for a Rider license. For details, see the Rider subscription options and pricing and the instructions to register JetBrains Rider.

Architecture

Deploying this Quick Start with default parameter values and an EC2 key pair builds the following environment in the AWS Cloud.

Architecture
Figure 1. Architecture for the .NET Development Environment Quick Start on AWS

As shown in Figure 1, the Quick Start sets up the following:

  • A virtual private cloud (VPC) configured with a public subnet to provide you with your own virtual network on AWS.*

  • In the public subnet, an EC2 Windows instance configured with the .NET SDK and the following tools that are commonly used to develop .NET applications:

    • Git for Windows

    • Visual Studio Code

    • JetBrains Rider

    • Chocolatey package manager

    • AWS Command Line Interface (AWS CLI)

    • PowerShell Core

* If you specify an existing VPC and subnet, the template skips the creation of those components.

Planning the deployment

Specialized knowledge

This deployment requires a moderate level of familiarity with AWS services. If you’re new to AWS, see Getting Started Resource Center and AWS Training and Certification. These sites provide materials for learning how to design, deploy, and operate your infrastructure and applications on the AWS Cloud.

This Quick Start also assumes familiarity with establishing Remote Desktop Protocol (RDP) connections to EC2 instances. For more information, see Connect to your Windows instance.

AWS account

If you don’t already have an AWS account, create one at https://aws.amazon.com by following the on-screen instructions. Part of the sign-up process involves receiving a phone call and entering a PIN using the phone keypad.

Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.

Technical requirements

Before you launch the Quick Start, review the following information and ensure that your account is properly configured. Otherwise, deployment might fail.

Resource quotas

If necessary, request service quota increases for the following resources. You might need to request increases if your existing deployment currently uses these resources and if this Quick Start deployment could result in exceeding the default quotas. The Service Quotas console displays your usage and quotas for some aspects of some services. For more information, see What is Service Quotas? and AWS service quotas.

Resource This deployment uses

VPCs

1

Subnets

1

Security groups

1

AWS Identity and Access Management (IAM) roles

1

EC2 instances

1

Supported AWS Regions

For any Quick Start to work in a Region other than its default Region, all the services it deploys must be supported in that Region. You can launch a Quick Start in any Region and see if it works. If you get an error such as “Unrecognized resource type,” the Quick Start is not supported in that Region.

For an up-to-date list of AWS Regions and the AWS services they support, see AWS Regional Services.

Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions.

Amazon EC2 key pairs

Ensure that at least one Amazon EC2 key pair exists in your AWS account in the Region where you plan to deploy the Quick Start. Note the key-pair name because you will use it during deployment. To create a key pair, see Amazon EC2 key pairs and Linux instances.

For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already being used by a production instance.

IAM permissions

Before launching the Quick Start, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions. For more information, see AWS managed policies for job functions.

Deployment options

This Quick Start provides two deployment options:

  • Deploy into a new VPC. This option builds a new AWS environment consisting of a new VPC, public subnet, security group, and other infrastructure components. It then deploys software into this environment.

  • Deploy into an existing VPC. This option deploys software into your existing VPC and subnet.

The Quick Start provides one template. In the template, you can configure various parameters. By default, the template deploys a new VPC. To deploy into an existing VPC, you fill in your VPC and subnet IDs.

Prepare your AWS account

Verify that your AWS account has the permissions required to create the resources listed in the Resource quotas section of this guide.

Deployment steps

Confirm your AWS account configuration

  1. Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see Planning the deployment earlier in this guide.

  2. Ensure that your AWS account is configured correctly, as discussed in the Technical requirements section.

Launch the Quick Start

If you’re deploying into an existing VPC, ensure that your VPC has a public subnet for hosting the development-tools instance.

Each deployment takes about 20 minutes to complete.

  1. Sign in to your AWS account, and launch the AWS CloudFormation template. (View the template.) For details, see Deployment options earlier in this guide.

  2. Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where you build the infrastructure. The template is launched in the us-east-1 Region by default. For more information, see Supported AWS Regions earlier in this guide.

  3. On the Create stack page, keep the default setting for the template URL, and then choose Next.

  4. On the Specify stack details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary.

    To deploy into an existing VPC, provide the IDs for your VPC and public subnet. Otherwise, by default, the template deploys a new VPC.

    When you finish reviewing and customizing the parameters, choose Next.

  5. On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you finish, choose Next.

  6. On the Review page, review and confirm the template settings. Under Capabilities, select the two check boxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros.

  7. Choose Create stack to deploy the stack.

  8. Monitor the status of the stack. When the status is CREATE_COMPLETE, the .NET Development Environment deployment is ready.

  9. To view the created resources, see the values displayed in the Outputs tab for the stack.

Postdeployment steps

(Optional) Sign up for a JetBrains Rider license

This Quick Start creates an EC2 instance that uses a trial license of JetBrains Rider. To use the Quick Start in your production environment, sign up for a Rider license. For details, see Software licenses earlier in this guide.

(Optional) Set up AWS Instance Scheduler

To reduce EC2 usage, set up AWS Instance Scheduler to automate starting and stopping the instance. For example, you can automatically shut down the instance outside of office hours. For details, see How do I use CloudFormation to stop and start my instances at predefined times?

FAQ

Q. I encountered a CREATE_FAILED error when I launched the Quick Start.

A. If AWS CloudFormation fails to create the stack, relaunch the template with Rollback on failure set to Disabled. This setting is under Advanced in the AWS CloudFormation console on the Configure stack options page. With this setting, the stack’s state is retained, and the instance keeps running so that you can troubleshoot the issue. (For Windows, look at the log files in %ProgramFiles%\Amazon\EC2ConfigService and C:\cfn\log.)

When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Delete the stack when you finish troubleshooting.

For more information, see Troubleshooting AWS CloudFormation.


Q. I encountered a size-limitation error when I deployed the AWS CloudFormation templates.

A. Launch the Quick Start templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer or from a location other than an S3 bucket, you might encounter template-size limitations. For more information, see AWS CloudFormation quotas.

Customer responsibility

After you successfully deploy this Quick Start, confirm that your resources and services are updated and configured — including any required patches — to meet your security and other needs. For more information, see the AWS Shared Responsibility Model.

Send us feedback

To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. To submit code, see the Quick Start Contributor’s Guide.

Quick Start reference deployments

GitHub repository

Visit our GitHub repository to download the templates and scripts for this Quick Start, to post your comments, and to share your customizations with others.


Notices

This document is provided for informational purposes only. It represents AWS’s current product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS’s products or services, each of which is provided “as is” without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.

The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for specific language governing permissions and limitations.