SQL Server Failover Cluster Instance on the AWS Cloud

Quick Start Reference Deployment

QS

April 2021
Sepehr Samiei and Garry Singh, AWS Microsoft Tech Specialist Solutions Architect team
Dave May, AWS Quick Start 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 SQL Server Failover Cluster Instance Quick Start on the AWS Cloud.

This Quick Start is for IT infrastructure architects, database administrators, and DevOps professionals who plan to implement or extend Microsoft SQL Server (MSSQL) using SQL Server on AWS with Windows Server Failover Clustering (WSFC). Unlike the Quick Start for SQL Server with Always On Replication, this one deploys an Always On Failover Cluster Instance (FCI). It also deploys Amazon FSx for Windows File Server as a network share to store the database files.

This guide does not provide general configuration and usage information for WSFC and MSSQL. For general guidance and best practices, consult the Microsoft product documentation and the Best Practices for Deploying Microsoft SQL Server on AWS whitepaper.

SQL Server Failover Cluster Instance on AWS

The SQL Server FCI Quick Start deploys a highly available environment that includes Windows Server and SQL Server running on Amazon Elastic Compute Cloud (EC2). It requires shared storage that is accessible by all nodes within the WSFC cluster. It supports SQL Server 2019 running on Windows Server 2019.

This architecture uses a highly available Multi-AZ Amazon FSx file system as the network share used to store MSSQL database files. The Amazon FSx file system and EC2 Windows instances that host this architecture’s nodes are joined to the same Active Directory domain.

The "instance" in "failover cluster instance" means something different from the "instance" in "EC2 instance." In this Quick Start, a failover cluster instance, or FCI, has the appearance of an instance of SQL Server running on a single computer. A failover cluster instance provides failover from one EC2 instance (WSFC node) to another if the current EC2 instance goes down. For an illustration, see Figure 1.

Traditionally, FCIs have been difficult to deploy and manage. With its Multi-AZ file system option, Amazon FSx provides fully managed file storage. This storage enables the high availability and durability that’s required to run business-critical Microsoft SQL Server database workloads without requiring licenses for each server. Amazon FSx automatically handles failover, simplifying shared storage to host your database deployments while reducing cost.

The automation in this deployment uses AWS Systems Manager Automation, AWS CloudFormation, and Windows PowerShell Desired State Configuration (DSC) to deploy a multi-node SQL Always On FCI. Windows Server Failover Clustering is a prerequisite for deploying an Always On FCI. MSSQL uses WSFC to increase application availability. WSFC provides infrastructure features that complement the high availability and disaster recovery scenarios supported in the AWS Cloud.

FCI, which was introduced with SQL Server 2008 as a high availability feature, continues to be available in all newer versions of MSSQL. When used on premises, SQL Server FCI is often used purely for high availability within a single data center. On AWS, you can use the SQL Server FCI Quick Start to cover both high availability and disaster recovery requirements.

Since FCIs require shared storage, traditionally they had to be deployed within a single data center. On AWS, the shared storage can span multiple Availability Zones, enabling WSFC clusters to span multiple Availability Zones.

Implementing WSFC on AWS is similar to deploying it on premises as long as you meet these two requirements:

  • The cluster nodes are deployed inside a virtual private cloud (VPC).

  • The cluster nodes are deployed in separate subnets to provide high availability across multiple Availability Zones.

This Quick Start meets these requirements.

For more information:

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 requires a license for Microsoft SQL Server 2019. You can obtain a trial license from the Microsoft Evaluation Center.

Alternatively, if you’re not using the software for a production environment, you can use the MSSQL Developer Edition. This edition provides the full capabilities of Enterprise Edition without requiring license costs.

This Quick Start deploys MSSQL in Bring-Your-Own-License mode. It does not support deployment of MSSQL license-included Amazon Machine Images (AMIs).

Architecture

Deploying this Quick Start for a new VPC with default parameters builds the following environment in the AWS Cloud.

architecture1
Figure 1. Quick Start architecture for SQL Server FCI on AWS

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

  • A highly available architecture that spans two Availability Zones.*

  • A VPC configured with public and private subnets, according to AWS best practices, to provide you with your own virtual network on AWS.*

  • In the public subnets:

    • Managed network address translation (NAT) gateways to allow outbound internet access for resources in the private subnets.*

    • A Remote Desktop Gateway (RD Gateway) host in an Auto Scaling group to allow inbound Remote Desktop Protocol (RDP) access to EC2 instances in public and private subnets.*

  • In the private subnets:

    • Two EC2 instances running Microsoft Windows with SQL Server. These instances are installed as nodes in a WSFC cluster in an Always On FCI configuration across the Availability Zones. Each node contains an Amazon Elastic Block Store (Amazon EBS) root volume.

  • An Amazon FSx file system, which the FCI nodes share. SQL Server is installed in this file system. This file system also stores all SQL database and log files, and it acts as the WSFC cluster’s file-share witness.*

  • AWS Directory Service with a managed directory. The Amazon FSx file system and the EC2 Windows instances that host this architecture’s nodes are joined to the same Active Directory domain.

  • AWS Secrets Manager keys to store credentials.

  • An AWS Systems Manager automation document to automate the deployment.

*The template that deploys the Quick Start into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.

Comparison with SQL Server with Always On Replication

To better understand the architecture of the SQL Server FCI Quick Start, it’s helpful to compare with the Quick Start for SQL Server with Always On Replication. Both Quick Starts are architected to ensure high availability. Both have EC2 instances clustered using WSFC. Both have database files stored in multiple Availability Zones. What’s different is the way each Quick Start accomplishes database high availability.

The replication-based architecture requires a full installation of SQL Server (Standard or Enterprise edition) on each EC2 instance. Therefore, each EC2 instance requires a SQL Server license.

What makes the FCI-based architecture unique is that it requires only one SQL Server license. With FCI, database-related files aren’t replicated across the WSFC cluster, and SQL Server is not installed in the local file systems. Instead, this Quick Start creates an Amazon FSx file system and installs SQL Server there. The EC2 instances (FCI nodes) share this file system, which also stores all the SQL database files and log files. In addition, this shared file system acts as the cluster’s file-share witness.

Advantages and disadvantages

The architecture of each SQL Server Quick Start has advantages and disadvantages.

SQL Server with Always On Replication Quick Start:

  • Advantages:

    • The EBS volume type, capacity, and IOPS can be configured, allowing flexibility.

    • It supports both AWS-provided licensing and Bring Your Own License models for Microsoft SQL.

  • Disadvantage:

    • Each WSFC node with SQL Server installed requires a SQL Server license, increasing cost.

SQL Server FCI Quick Start:

  • Advantage: It requires only one SQL Server license.

  • Disadvantages:

    • It relies on an Amazon FSx Multi-AZ file system, which is not supported in all AWS Regions.

    • It requires the customer to provide a SQL Server .iso file and license since AWS-provided SQL licensing is not supported.

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 assumes that you’re familiar with Microsoft SQL Server and Always On Failover Cluster Instances. For details, consult the Microsoft product documentation.

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

VPC

1

Elastic IP address

1

Security groups

3

AWS Identity and Access Management (IAM) roles

4

Auto Scaling group

1

Network Load Balancers

1

EC2 instances

3

AWS managed directory

1

AWS Secrets Manager secrets

2

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

When deploying the SQL Server FCI Quick Start, you have three options:

  • Deploy it into a new VPC. This option works with either AWS Directory Service for Microsoft Active Directory (AWS Managed Microsoft AD) or self-managed Active Directory. It builds a new AWS environment consisting of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys SQL Server FCI into this new VPC.

  • Deploy it into an existing VPC using an existing AWS managed directory. With this option, you join Amazon FSx and the SQL Server FCI instances to an existing AWS Managed Microsoft AD domain.

  • Deploy it into an existing VPC using an existing self-managed directory. With this option, you join Amazon FSx and the SQL Server FCI instances to an existing self-managed Active Directory running on-premises or running on EC2 instances.

The Quick Start provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and other settings, as discussed later in this guide.

Prepare for the deployment

The deployment of this Quick Start requires a copy of the Microsoft SQL Server 2019 installation media as an .iso file. The typical file name is SQLServer2019-x64-ENU.iso.

  1. Download the SQL Server 2019 evaluation edition from the Microsoft Evaluation Center.

    —or—

    Obtain the .iso file from the Microsoft Developer Network if you have an MSDN account with licenses for server software.

  2. Upload the .iso file to an S3 bucket.

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. Make sure that your AWS account is configured correctly, as discussed in the Technical requirements section.

Launch the Quick Start

If you’re deploying this Quick Start into an existing VPC, make sure that your VPC has two private subnets in different Availability Zones for the workload instances and that the subnets aren’t shared. This Quick Start doesn’t support shared subnets. These subnets require NAT gateways in their route tables to allow the instances to download packages and software without exposing them to the internet. Also make sure that the domain name option in the DHCP options is configured as explained in DHCP options sets. You provide your VPC settings when you launch the Quick Start.

Each deployment takes about 2.25 hours to complete.

  1. Sign in to your AWS account, and choose one of the following options to launch the AWS CloudFormation template. For help with choosing an option, see Deployment options earlier in this guide.

    Deploy into a new VPC

    View template

    Deploy into an existing VPC with AWS Managed Microsoft AD

    View template

    Deploy into an existing VPC with self-managed Active Directory

    View template

  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 the network infrastructure for the SQL Server FCI Quick Start is built. The template is launched in the us-east-1 Region by default. For other choices, see Supported 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. For details on each parameter, see the Parameter reference section of this guide. 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 SQL Server FCI deployment is ready.

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

Post-deployment steps

Run Windows updates

In order to ensure the deployed servers' operating systems and installed applications have the latest Microsoft updates, run Windows Update on each server.

  1. Create an RDP session from the Remote Desktop Gateway server to each deployed server.

  2. Choose the Settings application.

  3. Choose Update & Security.

  4. Choose Check for updates.

  5. Install any updates and reboot if necessary.

Test the deployment

  1. Open an RDP session to one of the two SQL servers.

  2. Open Windows Administrative Tools, and launch Failover Cluster Manager.

    postdeploy1
    Figure 2. Failover Cluster Manager
  3. Choose Nodes, and ensure that both nodes are online.

    postdeploy2
    Figure 3. Both nodes showing online
  4. Select the failover cluster, and verify that both the cluster and the file-share witness are online.

    postdeploy3
    Figure 4. Cluster overview showing that both the cluster and the file-share witness are online
  5. Download SQL Server Management Studio (SSMS).

  6. Install SQL Server Management Studio. The installation requires a reboot.

  7. After rebooting, log back in to the SQL server.

  8. Launch SQL Server Management Studio, and connect to the FCI.

    50%
    Figure 5. Connecting to the cluster
  9. If you are able to log in, the deployment was successful.

Troubleshooting

If the deployment fails, follow these steps:

  1. Open the AWS Systems Manager console.

  2. Select your deployment Region.

  3. Choose Automation from the left-hand side, and locate the failed automation document.

  4. Navigate to the failed step.

  5. Expand Output to view the automation logs.

  6. Follow the link to Amazon CloudWatch Logs to view detailed automation logs.

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.

Additional resources

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.

Parameter reference

Unless you are customizing the Quick Start templates for your own deployment projects, keep the default settings for the parameters labeled Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. Changing these parameter settings automatically updates code references to point to a new Quick Start location. For more information, see the AWS Quick Start Contributor’s Guide.

Parameters for deploying into a new VPC

Table 1. Network configuration
Parameter label (name) Default value Description

Availability Zones (AvailabilityZones)

Requires input

Availability Zones to use for the subnets in the VPC. Two Availability Zones are used and the logical order is preserved.

VPC CIDR block (VPCCIDR)

10.0.0.0/16

CIDR block for the VPC.

Public subnet 1 CIDR (PublicSubnet1CIDR)

10.0.128.0/20

CIDR block for public subnet 1 located in Availability Zone 1.

Public subnet 2 CIDR (PublicSubnet2CIDR)

10.0.144.0/20

CIDR block for public subnet 2 located in Availability Zone 2.

Private subnet 1 CIDR (PrivateSubnet1CIDR)

10.0.0.0/19

CIDR block for private subnet 1 located in Availability Zone 1.

Private subnet 2 CIDR (PrivateSubnet2CIDR)

10.0.32.0/19

CIDR block for private subnet 2 located in Availability Zone 2.

Table 2. Remote Desktop Gateway configuration
Parameter label (name) Default value Description

Allowed RD Gateway external access CIDR (RDGWCIDR)

Requires input

Allowed CIDR block for external access to the Remote Desktop Gateway instances.

Number of RD Gateway hosts (NumberOfRDGWHosts)

1

Number of Remote Desktop Gateway hosts to create.

RD Gateway instance type (RDGWInstanceType)

t2.large

Amazon EC2 instance type for the Remote Desktop Gateway instances.

Table 3. Active Directory configuration
Parameter label (name) Default value Description

Active Directory scenario type (ADScenarioType)

AWS Directory Service for Microsoft AD (Enterprise Edition)

Type of AD DS deployment to use. If you want to manage your own Amazon EC2 Active Directory instances, choose "Microsoft AD on Amazon EC2."

Domain DNS name (DomainDNSName)

example.com

Fully qualified domain name (FQDN) of the forest root domain.

Domain NetBIOS name (DomainNetBIOSName)

example

NetBIOS name of the domain for users of earlier versions of Windows. You can use up to 15 characters.

Domain administrator user name (DomainAdminUser)

Admin

User name for the account that will be added as domain administrator. This is separate from the default "Administrator" account. You can specify this user name only for the self-managed Active Directory scenario. If you’re using the AWS Directory Service for Microsoft AD, the default stays "Admin" regardless of any value provided.

Domain administrator password (DomainAdminPassword)

Requires input

Password for the domain administrator. Must be at least 8 characters containing letters, numbers, and symbols.

Table 4. Self-managed Active Directory configuration
Parameter label (name) Default value Description

Domain controller 1 instance type (ADServer1InstanceType)

m5.xlarge

Amazon EC2 instance type for the first Active Directory instance, located in Availability Zone 1.

Domain controller 1 NetBIOS name (ADServer1NetBIOSName)

DC1

NetBIOS name of the first Active Directory instance, located in Availability Zone 1. This name can have up to 15 characters.

Domain controller 1 private IP address (ADServer1PrivateIP)

10.0.0.10

Fixed private IP address for the first Active Directory instance, located in Availability Zone 1.

Domain controller 2 instance type (ADServer2InstanceType)

m5.xlarge

Amazon EC2 instance type for the second Active Directory instance, located in Availability Zone 2.

Domain controller 2 NetBIOS name (ADServer2NetBIOSName)

DC2

NetBIOS name of the second Active Directory instance, located in Availability Zone 2. This name can have up to 15 characters.

Domain controller 2 private IP address (ADServer2PrivateIP)

10.0.32.10

Fixed private IP address for the second Active Directory instance, located in Availability Zone 2.

Table 5. Amazon EC2 configuration
Parameter label (name) Default value Description

EC2 key pair name (KeyPairName)

Requires input

Name of an existing EC2 key pair. All instances will launch with this key pair.

Server1 NetBIOS name (SqlFSxServerNetBIOSName1)

SqlFSx1

NetBIOS name of the primary instance. You can use up to 15 characters.

Server2 NetBIOS name (SqlFSxServerNetBIOSName2)

SqlFSx2

NetBIOS name of the secondary instance. You can use up to 15 characters.

Windows version (WindowsVersion)

Windows_Server-2019-English-Full-Base*

Choose the Windows version to run SQL Server.

Workload servers EC2 instance type (WorkloadInstanceType)

r5.2xlarge

Type of EC2 instance for the workload instances.

Table 6. Amazon FSx Windows file-share configuration
Parameter label (name) Default value Description

File-share volume size (FileShareVolumeSize)

32

Capacity (GB) of the volume used to store SQL Server files. Minimum value is 32 and maximum 65536.

File-share throughput capacity (FileShareThroughputCapacity)

8

File-share throughput capacity (MB/s) in 2 to the nth power increments, where 3 ≤ n ≤ 11, i.e. between 2^3 and 2^11.

Table 7. Microsoft SQL Server FCI configurations
Parameter label (name) Default value Description

S3 bucket for SQL media (MSSQLMediaBucketName)

Requires input

Name of the S3 bucket from which MSSQL media can be downloaded. You can use lowercase letters, uppercase letters, and hyphens (-). Do not start or end with a hyphen (-).

S3 key for SQL media path (MSSQLMediaPathKey)

SQLServer2019-x64-ENU.iso

Key for the S3 bucket from which MSSQL media can be downloaded. You can use numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/).

Windows Server Failover Cluster (WSFC) name (SqlFSxWSFCName)

WSFC1

Name of the Windows Server Failover Cluster (WSFC). You can use up to 15 characters.

Failover cluster instance (FCI) name (SqlFSxFCIName)

SqlFCI

Name of the failover cluster instance (FCI). You can use up to 15 characters.

SQL administrator account or accounts (SQLAdminAccounts)

example\Admin

Comma-separated user names are used as MSSQL DB administrators. It could be Active Directory domain administrators or other local or domain users.

Table 8. Application Insights configuration
Parameter label (name) Default value Description

Enable Application Insights (EnableAppInsights)

false

Select whether to enable Application Insights

Application Insights application name (ApplicationName)

MSSQL

Application Insights application name

Resource Group name (ResourceGroupName)

SQL

Application Resource Group name

Table 9. AWS Quick Start configuration
Parameter label (name) Default value Description

Quick Start S3 bucket name (QSS3BucketName)

aws-quickstart

Name of the S3 bucket for your copy of the Quick Start assets. Keep the default name unless you are customizing the template. Changing the name updates code references to point to a new Quick Start location. This name can include numbers, lowercase letters, uppercase letters, and hyphens, but do not start or end with a hyphen (-). See https://aws-quickstart.github.io/option1.html.

Quick Start S3 bucket Region (QSS3BucketRegion)

us-east-1

AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. Keep the default Region unless you are customizing the template. Changing this Region updates code references to point to a new Quick Start location. When using your own bucket, specify the Region. See https://aws-quickstart.github.io/option1.html.

Quick Start S3 key prefix (QSS3KeyPrefix)

quickstart-microsoft-sql-fci-fsx/

S3 key prefix that is used to simulate a directory for your copy of the Quick Start assets. Keep the default prefix unless you are customizing the template. Changing this prefix updates code references to point to a new Quick Start location. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). End with a forward slash. See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html and https://aws-quickstart.github.io/option1.html.

Parameters for deploying into an existing VPC with AWS Managed Microsoft AD

Table 10. Network configuration
Parameter label (name) Default value Description

VPC ID (VPCID)

Requires input

ID of your existing VPC for deployment.

Private subnet 1 ID (PrivateSubnet1ID)

Requires input

ID of private subnet 1 in Availability Zone 1 for the workload (e.g., subnet-a0246dcd).

Private subnet 2 ID (PrivateSubnet2ID)

Requires input

ID of private subnet 2 in Availability Zone 2 for the workload (e.g., subnet-a0246dcd).

VPC CIDR (VPCcidr)

10.0.0.0/16

CIDR block for the VPC.

Table 11. Microsoft Active Directory configuration
Parameter label (name) Default value Description

Domain DNS name (DomainDNSName)

example.com

Fully qualified domain name (FQDN).

Domain NetBIOS name (DomainNetBIOSName)

EXAMPLE

NetBIOS name of the domain for users of earlier versions of Windows. You can use up to 15 characters.

Domain administrator user name (DomainAdminUser)

StackAdmin

User name for the account that will be used as domain administrator. This is separate from the default "Administrator" account.

Domain administrator password (DomainAdminPassword)

Requires input

Password for the domain administrator.

Security group ID for Active Directory domain members (DomainMemberSGID)

Requires input

ID of the domain member security group (e.g., sg-9cb7d0e5).

Active Directory DNS IP addresses (ADDnsIpAddresses)

Requires input

DNS IP addresses for Active Directory. Separate these with commas.

ID of the AWS Directory Service directory (DirectoryId)

Requires input

The ID of the AWS Directory Service directory.

Table 12. Amazon EC2 configuration
Parameter label (name) Default value Description

Server1 NetBIOS name (SqlFSxServerNetBIOSName1)

SqlFSx1

NetBIOS name of the primary instance. You can use up to 15 characters.

Server2 NetBIOS name (SqlFSxServerNetBIOSName2)

SqlFSx2

NetBIOS name of the secondary instance. You can use up to 15 characters.

SSH key name (KeyPairName)

Requires input

Name of an existing EC2 key pair. All instances will launch with this key pair.

Windows version (WindowsVersion)

Windows_Server-2019-English-Full-Base*

Select Windows version to run SQL Server.

Workload servers instance type (WorkloadInstanceType)

r5.2xlarge

Type of EC2 instance for the workload instances.

Table 13. Amazon FSx Windows file-share configuration
Parameter label (name) Default value Description

File-share volume size (FileShareVolumeSize)

32

Capacity (GB) of the volume used to store SQL Server files. Minimum value is 32 and maximum 65536.

File-share throughput capacity (FileShareThroughputCapacity)

8

File-share throughput capacity (MB/s) in 2 to the nth power increments, where 3 ≤ n ≤ 11, i.e. between 2^3 and 2^11.

Table 14. Microsoft SQL Server FCI configurations
Parameter label (name) Default value Description

S3 bucket for SQL media (MSSQLMediaBucketName)

ss-experiments

Name of the S3 bucket from which MSSQL media can be downloaded. You can use lowercase letters, uppercase letters, and hyphens (-). Do not start or end with a hyphen (-).

S3 key for SQL media path (MSSQLMediaPathKey)

quickstart-microsoft-SqlFSx/sql-installation-media/en_sql_server_2019_developer_x64_dvd_baea4195.iso

Key for the S3 bucket from which MSSQL media can be downloaded. You can use numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/).

Windows Server Failover Cluster (WSFC) name (SqlFSxWSFCName)

WSFC1

Name of the Windows Server Failover Cluster (WSFC). You can use up to 15 characters.

Failover cluster instance (FCI) name (SqlFSxFCIName)

SqlFCI

Name of the failover cluster instance (FCI). You can use up to 15 characters.

SQL administrator account or accounts (SQLAdminAccounts)

contoso\Administrator

Comma-separated user names will be used as MSSQL DB administrators. It could be Active Directory domain administrators or other local or domain users.

Table 15. Application Insights configuration
Parameter label (name) Default value Description

Enable Application Insights (EnableAppInsights)

false

Select whether to enable Application Insights

Application Insights application name (ApplicationName)

MSSQLFCI

Application Insights application name

Resource Group name (ResourceGroupName)

SQL

Application Resource Group name

Table 16. AWS Quick Start configuration
Parameter label (name) Default value Description

Quick Start S3 bucket name (QSS3BucketName)

aws-quickstart

Name of the S3 bucket for your copy of the Quick Start assets. Keep the default name unless you are customizing the template. Changing the name updates code references to point to a new Quick Start location. This name can include numbers, lowercase letters, uppercase letters, and hyphens, but do not start or end with a hyphen (-). See https://aws-quickstart.github.io/option1.html.

Quick Start S3 bucket Region (QSS3BucketRegion)

us-east-1

AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. Keep the default Region unless you are customizing the template. Changing this Region updates code references to point to a new Quick Start location. When using your own bucket, specify the Region. See https://aws-quickstart.github.io/option1.html.

Quick Start S3 key prefix (QSS3KeyPrefix)

quickstart-microsoft-sql-fci-fsx/

S3 key prefix that is used to simulate a directory for your copy of the Quick Start assets. Keep the default prefix unless you are customizing the template. Changing this prefix updates code references to point to a new Quick Start location. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). End with a forward slash. See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html and https://aws-quickstart.github.io/option1.html.

Parameters for deploying into an existing VPC with self-managed Active Directory

Table 17. Network configuration
Parameter label (name) Default value Description

VPC ID (VPCID)

Requires input

ID of your existing VPC for deployment

10.0.0.0/8 (VPCcidr)

10.0.0.0/16

CIDR block for the VPC.

Private subnet 1 ID (PrivateSubnet1ID)

Requires input

ID of private subnet 1 in Availability Zone 1 for the workload (e.g., subnet-a0246dcd).

Private subnet 2 ID (PrivateSubnet2ID)

Requires input

ID of private subnet 2 in Availability Zone 2 for the workload (e.g., subnet-a0246dcd).

Table 18. Microsoft Active Directory configuration
Parameter label (name) Default value Description

Domain DNS name (DomainDNSName)

example.com

Fully qualified domain name (FQDN).

Domain NetBIOS name (DomainNetBIOSName)

EXAMPLE

NetBIOS name of the domain for users of earlier versions of Windows. You can use up to 15 characters.

Domain administrator user name (DomainAdminUser)

StackAdmin

User name for the account that will be used as domain administrator. This is separate from the default "Administrator" account.

Domain administrator password (DomainAdminPassword)

Requires input

Password for the domain administrator.

Security group ID for Active Directory domain members (DomainMemberSGID)

Requires input

ID of the domain member security group (e.g., sg-9cb7d0e5).

Active Directory DNS IP addresses (ADDnsIpAddresses)

Requires input

DNS IP addresses for Active Directory. Separate these with commas.

Table 19. Amazon EC2 configuration
Parameter label (name) Default value Description

Server1 NetBIOS name (SqlFSxServerNetBIOSName1)

SqlFSx1

NetBIOS name of the primary instance. You can use up to 15 characters.

Server2 NetBIOS name (SqlFSxServerNetBIOSName2)

SqlFSx2

NetBIOS name of the secondary instance. You can use up to 15 characters.

SSH key name (KeyPairName)

Requires input

Name of an existing EC2 key pair. All instances will launch with this key pair.

Windows version (WindowsVersion)

Windows_Server-2019-English-Full-Base*

Select Windows version to run SQL Server.

Workload servers instance type (WorkloadInstanceType)

r5.2xlarge

Type of EC2 instance for the workload instances.

Table 20. Amazon FSx Windows file-share configuration
Parameter label (name) Default value Description

File-share volume size (FileShareVolumeSize)

32

Capacity (GB) of the volume used to store SQL Server files. Minimum value is 32 and maximum 65536.

File-share throughput capacity (FileShareThroughputCapacity)

8

File-share throughput capacity (MB/s) in 2 to the nth power increments, where 3 ≤ n ≤ 11, i.e. between 2^3 and 2^11.

Table 21. Microsoft SQL Server FCI configurations
Parameter label (name) Default value Description

S3 bucket for SQL media (MSSQLMediaBucketName)

ss-experiments

Name of the S3 bucket from which MSSQL media can be downloaded. You can use lowercase letters, uppercase letters, and hyphens (-). Do not start or end with a hyphen (-).

S3 key for SQL media path (MSSQLMediaPathKey)

quickstart-microsoft-SqlFSx/sql-installation-media/en_sql_server_2019_developer_x64_dvd_baea4195.iso

Key for the S3 bucket from which MSSQL media can be downloaded. You can use numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/).

Windows Server Failover Cluster (WSFC) name (SqlFSxWSFCName)

WSFC1

Name of the Windows Server Failover Cluster (WSFC). You can use up to 15 characters.

Failover cluster instance (FCI) name (SqlFSxFCIName)

SqlFCI

Name of the failover cluster instance (FCI). You can use up to 15 characters.

SQL administrator account or accounts (SQLAdminAccounts)

contoso\Administrator

Comma-separated user names are used as MSSQL DB administrators. It could be Active Directory domain administrators or other local or domain users.

Table 22. Application Insights configuration
Parameter label (name) Default value Description

Enable Application Insights (EnableAppInsights)

false

Select whether to enable Application Insights

Application Insights application name (ApplicationName)

MSSQL

Application Insights application name

Resource Group name (ResourceGroupName)

SQL

Application Resource Group name

Table 23. AWS Quick Start configuration
Parameter label (name) Default value Description

Quick Start S3 bucket name (QSS3BucketName)

aws-quickstart

Name of the S3 bucket for your copy of the Quick Start assets. Keep the default name unless you are customizing the template. Changing the name updates code references to point to a new Quick Start location. This name can include numbers, lowercase letters, uppercase letters, and hyphens, but do not start or end with a hyphen (-). See https://aws-quickstart.github.io/option1.html.

Quick Start S3 bucket Region (QSS3BucketRegion)

us-east-1

AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. Keep the default Region unless you are customizing the template. Changing this Region updates code references to point to a new Quick Start location. When using your own bucket, specify the Region. See https://aws-quickstart.github.io/option1.html.

Quick Start S3 key prefix (QSS3KeyPrefix)

quickstart-microsoft-sql-fci-fsx/

S3 key prefix that is used to simulate a directory for your copy of the Quick Start assets. Keep the default prefix unless you are customizing the template. Changing this prefix updates code references to point to a new Quick Start location. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). End with a forward slash. See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html and https://aws-quickstart.github.io/option1.html.

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.