Menu
SQL Server with WSFC on AWS
Quick Start Reference Deployment Guide

Step 2. Launch the Quick Start

  1. Choose one of the following options to launch the AWS CloudFormation template into your AWS account. For help choosing an option, see Deployment Options earlier in this guide.

    Option 1

    Deploy software into a new VPC on AWS

    
            Quick Start launch button for SQL Server in new VPC

    Option 2

    Deploy software into an existing VPC on AWS

    
            Quick Start launch button for SQL Server in existing VPC

    Each deployment takes approximately three hours to complete.

    Note

    You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional cost for using this Quick Start. For full details, see the pricing pages for each AWS service you will be using in this Quick Start.

  2. Check the region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This is where the network infrastructure will be built. The template is launched in the US East (Ohio) Region by default.

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

  4. On the Specify Details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require your input. For all other parameters, review the default settings and customize them as necessary. When you finish reviewing and customizing the parameters, choose Next.

    In the following tables, parameters are listed by category and described separately for the two deployment options:

    Option 1: Parameters for deployment into a new VPC

    View template

    Network Configuration:

    Parameter label Parameter name Default Description
    Availability Zones AvailabilityZones Requires input The list of Availability Zones to use for the subnets in the VPC. You must specify two zones if the Third AZ parameter is set to no, or three zones if the Third AZ parameter is set to yes. The Quick Start preserves the logical order you specify.
    Third AZ ThirdAZ no Change this setting if you’d like to use three Availability Zones in your deployment. Choose witness to use the third zone for the file share witness, or full to use the third zone as a full SQL Server cluster node. If you choose witness, you must set the File Server Private IP Address parameter under Failover Cluster Configuration to an IP in the third subnet range.
    VPC CIDR VPCCIDR 10.0.0.0/16 CIDR block for the VPC to create.
    Public Subnet 1 CIDR PublicSubnet1CIDR 10.0.128.0/20 CIDR block for the public (DMZ) subnet located in Availability Zone 1.
    Public Subnet 2 CIDR PublicSubnet2CIDR 10.0.144.0/20 CIDR block for the public (DMZ) subnet located in Availability Zone 2.
    Public Subnet 3 CIDR PublicSubnet3CIDR 10.0.160.0/20 CIDR block for the optional public (DMZ) subnet located in Availability Zone 3, if you’ve chosen to use a third zone.
    Private Subnet 1 CIDR PrivateSubnet1CIDR 10.0.0.0/19 CIDR block for the private subnet located in Availability Zone 1.
    Private Subnet 2 CIDR PrivateSubnet2CIDR 10.0.32.0/19 CIDR block for the private subnet located in Availability Zone 2.
    Private Subnet 3 CIDR PrivateSubnet3CIDR 10.0.64.0/19 CIDR block for the optional private subnet located in Availability Zone 3, if you’ve chosen to use a third zone.

    Amazon EC2 Configuration:

    Parameter label Parameter name Default Description
    Key Pair Name KeyPairName Requires input Public/private key pair, which allows you to connect securely to your instance after it launches. When you created an AWS account, this is the key pair you created in your preferred region.
    Tenancy HostType Shared Host type. If you choose Dedicated or Dedicated Host, hosts will be created in each Availability Zone.
    BYOL AMI to Use on Dedicated Host DedicatedHostAMI Requires input Your imported bring your own license (BYOL) AMI ID, if you set the Tenancy parameter to Dedicated or Dedicated Host.

    Standard Active Directory Configuration:

    Parameter label Parameter name Default Description
    AD Scenario Type ADScenarioType AWS Directory Service for Microsoft AD The type of Active Directory DS deployment to use. You can use AWS Directory Service for Active Directory, or choose Microsoft AD on Amazon EC2 to manage your own EC2 instances for Active Directory.
    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. This can be up to 15 characters long.
    Domain Admin Password DomainAdminPassword Requires input Password for the domain administrator user. This must be a complex password that’s at least 8 characters long.

    Self-Managed Active Directory Configuration (for non-AWS Directory Service architecture):

    Note

    The parameters in this section are ignored if you’ve selected AWS Directory Service for Microsoft AD as the AD Scenario Type.

    Parameter label Parameter name Default Description
    Domain Admin User Name DomainAdminUser StackAdmin User name for the account that is added as domain administrator. This is separate from the default administrator account.
    Domain Controller 1 Instance Type ADServer1InstanceType m4.xlarge EC2 instance type for the first Active Directory instance.
    Domain Controller 1 NetBIOS Name ADServer1NetBIOSName DC1 NetBIOS name of the first Active Directory server. This can be up to 15 characters long.
    Domain Controller 1 Private IP Address ADServer1PrivateIP 10.0.0.10 Fixed private IP for the first Active Directory server located in Availability Zone 1.
    Domain Controller 2 Instance Type ADServer2InstanceType m4.xlarge EC2 instance type for the second Active Directory instance.
    Domain Controller 2 NetBIOS Name ADServer2NetBIOSName DC2 NetBIOS name of the second Active Directory server. This can be up to 15 characters long.
    Domain Controller 2 Private IP Address ADServer2PrivateIP 10.0.32.10 Fixed private IP for the second Active Directory server located in Availability Zone 2.
    Restore Mode Password RestoreModePassword Requires input Password for a separate administrator account when the domain controller is in restore mode. This must be a complex password that’s at least 8 characters long.

    Remote Desktop Gateway Configuration:

    Parameter label Parameter name Default Description
    Allowed Remote Desktop Gateway External Access CIDR RDGWCIDR Requires input Allowed CIDR block for external access to the Remote Desktop Gateway instances. We recommend that you set this value to a trusted CIDR block.
    Number of RDGW Hosts NumberOfRDGWHosts 1 The number of RD Gateway instances to create. You can choose 1-4 instances.
    Remote Desktop Gateway Instance Type RDGWInstanceType t2.large EC2 instance type for the Remote Desktop Gateway instances.

    Microsoft SQL Server Configuration:

    Parameter label Parameter name Default Description
    SQL Server Version SQLServerVersion 2014 The version of SQL Server Enterprise edition to install on the cluster nodes. You can choose 2012, 2014, or 2016. Note that SQL Server 2012 isn’t compatible with the Amazon-provided SQL Server licenses. If you choose 2012, make sure that the Amazon-Provided SQL License parameter is set to no.
    Service Account Name SQLServiceAccount sqlsa User name for the SQL Server service account. This account is a domain user.
    Service Account Password SQLServiceAccountPassword Requires input Password for the SQL Server service account. This must be a complex password that’s at least 8 characters long.
    Amazon-Provided SQL Server License SQLLicenseProvided no Set to yes to use the license-included SQL Server AMI from AWS. This license supports:
    • Supported SQL versions: 2014 and 2016

    • Supported instance types: r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge

    For more information about licensing options, see the Cost and Licenses section.

    SQL Server Volume IOPS VolumeIops 1000 Provisioned IOPS for the SQL Server data, logs, and tempdb volumes. This setting applies only when the SQL Server Volume Type parameter is set to io1.
    SQL Server Volume Size VolumeSize 500 Volume size for the SQL Server data, logs, and tempdb volumes, in GiB.
    SQL Server Volume Type VolumeType gp2 Volume type (gp2 or io1) for the SQL Server data, logs, and tempdb volumes.

    Failover Cluster Configuration:

    Parameter label Parameter name Default Description
    Instance Type for Cluster Nodes WSFCNodeInstanceType r4.2xlarge EC2 instance type for the WSFC nodes.
    Cluster Node 1 NETBIOS Name WSFCNode1NetBIOSName WSFCNode1 NetBIOS name of the first WSFC node. This can be up to 15 characters long.
    Cluster Node 1 Private IP Address 1 WSFCNode1PrivateIP1 10.0.0.100 Primary private IP for the first WSFC node.
    Cluster Node 1 Private IP Address 2 WSFCNode1PrivateIP2 10.0.0.101 Secondary private IP for the first WSFC node.
    Cluster Node 1 Private IP Address 3 WSFCNode1PrivateIP3 10.0.0.102 Third private IP for the first WSFC node.
    Cluster Node 2 NETBIOS Name WSFCNode2NetBIOSName WSFCNode2 NetBIOS name of the second WSFC node. This can be up to 15 characters long.
    Cluster Node 2 Private IP Address 1 WSFCNode2PrivateIP1 10.0.32.100 Primary private IP for the second WSFC node.
    Cluster Node 2 Private IP Address 2 WSFCNode2PrivateIP2 10.0.32.101 Secondary private IP for the second WSFC node.
    Cluster Node 2 Private IP Address 3 WSFCNode2PrivateIP3 10.0.32.102 Third private IP for the second WSFC node.
    Cluster Node 3 NETBIOS Name WSFCNode3NetBIOSName WSFCNode3 NetBIOS name of the third (optional) WSFC node. This can be up to 15 characters long.
    Cluster Node 3 Private IP Address 1 WSFCNode3PrivateIP1 10.0.64.100 Primary private IP for the third (optional) WSFC node.
    Cluster Node 3 Private IP Address 2 WSFCNode3PrivateIP2 10.0.64.101 Secondary private IP for the third (optional) WSFC node.
    Cluster Node 3 Private IP Address 3 WSFCNode3PrivateIP3 10.0.64.102 Third private IP for the third (optional) WSFC node.
    File Server Instance Type WSFCFileServerInstanceType t2.small EC2 instance type for the file server used to share installation media, witness, and replication folders.
    File Server Private IP Address WSFCFileServerPrivateIP 10.0.0.200 Primary private IP for the file server located in Availability Zone 1. If you choose witness for the Third AZ parameter in the Network Configuration section, you must specify an IP in the third subnet range.

    AWS Quick Start Configuration:

    Parameter label Parameter name Default Description
    Quick Start S3 Bucket Name QSS3BucketName quickstart-reference S3 bucket where the Quick Start templates and scripts are installed. Use this parameter to specify the S3 bucket name you’ve created for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. The bucket name can include numbers, lowercase letters, uppercase letters, and hyphens, but should not start or end with a hyphen.
    Quick Start S3 Key Prefix QSS3KeyPrefix microsoft/sql/latest/ The S3 key name prefix used to simulate a folder for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. This prefix can include numbers, lowercase letters, uppercase letters, hyphens, and forward slashes.

    Option 2: Parameters for deployment into an existing VPC

    View template

    Network Configuration:

    Parameter label Parameter name Default Description
    Third AZ ThirdAZ no Change this setting if you’d like to use three Availability Zones in your deployment. Choose witness to use the third zone for the file share witness, or full to use the third zone as a full SQL Server cluster node. If you choose witness, you must set the File Server Private IP Address parameter under Failover Cluster Configuration to an IP in the third subnet range.
    VPC ID VPCID Requires input ID of the existing VPC where you want to deploy RD Gateway (e.g., vpc-0343606e).
    Private Subnet 1 ID PrivateSubnet1ID Requires input ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    Private Subnet 2 ID PrivateSubnet2ID Requires input ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    Private Subnet 3 ID PrivateSubnet3ID ID of the private subnet in Availability Zone 3 in your existing VPC (e.g., subnet- 7f16e910), if you’re using three Availability Zones.

    Amazon EC2 Configuration:

    Parameter label Parameter name Default Description
    Key Pair Name KeyPairName Requires input Public/private key pair, which allows you to connect securely to your instance after it launches. When you created an AWS account, this is the key pair you created in your preferred region.
    Tenancy HostType Shared Host type. If you choose Dedicated or Dedicated Host, hosts will be created in each Availability Zone.
    BYOL AMI to Use on Dedicated Host DedicatedHostAMI Requires input Your imported bring your own license (BYOL) AMI ID, if you set the Tenancy parameter to Dedicated or Dedicated Host.

    Microsoft Active Directory Configuration:

    Parameter label Parameter name Default Description
    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. This can be up to 15 characters long.
    Domain Admin User Name DomainAdminUser StackAdmin User name for the account that is added as domain administrator. This is separate from the default administrator account.
    Domain Admin Password DomainAdminPassword Requires input Password for the domain administrator user. This must be a complex password that’s at least 8 characters long.
    Security Group ID for AD Domain Members DomainMemberSGID Requires input ID of the domain name security group (e.g., sq-7f16e910).

    Microsoft SQL Server Configuration:

    Parameter label Parameter name Default Description
    SQL Server Version SQLServerVersion 2014 The version of SQL Server Enterprise edition to install on the cluster nodes. You can choose 2012, 2014, or 2016. Note that SQL Server 2012 isn’t compatible with the Amazon-provided SQL Server licenses. If you choose 2012, make sure that the Amazon-Provided SQL License parameter is set to no.
    Service Account Name SQLServiceAccount sqlsa User name for the SQL Server service account. This account is a domain user.
    Service Account Password SQLServiceAccountPassword Requires input Password for the SQL Server service account. This must be a complex password that’s at least 8 characters long.
    Amazon-Provided SQL Server License SQLLicenseProvided no Set to yes to use the license-included SQL Server AMI from AWS. This license supports:
    • Supported SQL versions: 2014 and 2016

    • Supported instance types: r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge

    For more information about licensing options, see the Cost and Licenses section.

    Data Volume Size Volume1Size 500 Volume size for the SQL Server data drive, in GiB.
    Data Volume Type Volume1Type gp2 Volume type (gp2 or io1) for the SQL Server data drive.
    Data Volume IOPS Volume1Iops 1000 Provisioned IOPS for the SQL Server data drive. This setting applies only when the Data Volume Type parameter is set to io1.
    Logs Volume Size Volume2Size 500 Volume size for the SQL Server Logs drive, in GiB.
    Logs Volume Type Volume2Type gp2 Volume type (gp2 or io1) for the SQL Server Logs drive.
    Logs Volume IOPS Volume2Iops 1000 Provisioned IOPS for the SQL Server Logs drive. This setting applies only when the Logs Volume Type parameter is set to io1.
    TempDB Volume Size Volume3Size 500 Volume size for the SQL Server tempdb drive, in GiB.
    TempDB Volume Type Volume3Type gp2 Volume type (gp2 or io1) for the SQL Server tempdb drive.
    TempDB Volume IOPS Volume3Iops 1000 Provisioned IOPS for the SQL Server tempdb drive. This setting applies only when the TempDB Volume Type parameter is set to io1.

    Failover Cluster Configuration:

    Parameter label Parameter name Default Description
    File Server Instance Type WSFCFileServerInstanceType t2.small EC2 instance type for the file server used to share installation media, witness, and replication folders.
    File Server NETBIOS Name WSFCFileServerNetBIOSName WSFCFileServer NetBIOS name of the WSFC file server (up to 15 characters).
    File Server Private IP Address 1 WSFCFileServerPrivateIP 10.0.0.200 Primary private IP for the file server in Availability Zone 1. If you choose witness for the Third AZ parameter in the Network Configuration section, you must specify an IP in the third subnet range.
    Instance Type for Cluster Node 1 WSFCNode1InstanceType r4.2xlarge EC2 instance type for the first WSFC node.
    Cluster Node 1 NETBIOS Name WSFCNode1NetBIOSName WSFCNode1 NetBIOS name of the first WSFC node. This can be up to 15 characters long.
    Cluster Node 1 Private IP Address 1 WSFCNode1PrivateIP1 10.0.0.100 Primary private IP for the first WSFC node.
    Cluster Node 1 Private IP Address 2 WSFCNode1PrivateIP2 10.0.0.101 Secondary private IP for the first WSFC node.
    Cluster Node 1 Private IP Address 3 WSFCNode1PrivateIP3 10.0.0.102 Third private IP for the first WSFC node.
    Dedicated Host ID for Node 1 DedicatedHostIDNode1 Dedicated host ID for the first WSFC node. This parameter is used only if you set the Tenancy parameter to Dedicated Host.
    Cluster Node 2 NETBIOS Name WSFCNode2NetBIOSName WSFCNode2 NetBIOS name of the second WSFC node. This can be up to 15 characters long.
    Cluster Node 2 Private IP Address 1 WSFCNode2PrivateIP1 10.0.32.100 Primary private IP for the second WSFC node.
    Cluster Node 2 Private IP Address 2 WSFCNode2PrivateIP2 10.0.32.101 Secondary private IP for the second WSFC node.
    Cluster Node 2 Private IP Address 3 WSFCNode2PrivateIP3 10.0.32.102 Third private IP for the second WSFC node.
    Dedicated Host ID for Node 2 DedicatedHostIDNode2 Dedicated host ID for the second WSFC node. This parameter is used only if you set the Tenancy parameter to Dedicated Host.
    Cluster Node 3 NETBIOS Name WSFCNode3NetBIOSName WSFCNode3 NetBIOS name of the third (optional) WSFC node. This can be up to 15 characters long.
    Cluster Node 3 Private IP Address 1 WSFCNode3PrivateIP1 10.0.64.100 Primary private IP for the third (optional) WSFC node.
    Cluster Node 3 Private IP Address 2 WSFCNode3PrivateIP2 10.0.64.101 Secondary private IP for the third (optional) WSFC node.
    Cluster Node 3 Private IP Address 3 WSFCNode3PrivateIP3 10.0.64.102 Third private IP for the third (optional) WSFC node.
    Dedicated Host ID for Node 3 DedicatedHostIDNode3 Dedicated host ID for the optional third WSFC node. This parameter is used only if you set the Tenancy parameter to Dedicated Host.

    AWS Quick Start Configuration:

    Parameter label Parameter name Default Description
    Quick Start S3 Bucket Name QSS3BucketName quickstart-reference S3 bucket where the Quick Start templates and scripts are installed. Use this parameter to specify the S3 bucket name you’ve created for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. The bucket name can include numbers, lowercase letters, uppercase letters, and hyphens, but should not start or end with a hyphen.
    Quick Start S3 Key Prefix QSS3KeyPrefix microsoft/sql/latest/ The S3 key name prefix used to simulate a folder for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. This prefix can include numbers, lowercase letters, uppercase letters, hyphens, and forward slashes.
  5. On the Options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you're done, choose Next.

  6. On the Review page, review and confirm the template settings. Under Capabilities, select the check box to acknowledge that the template will create IAM resources.

  7. Choose Create to deploy the stack.

  8. Monitor the status of the stack. When the status is CREATE_COMPLETE, the WSFC cluster is ready.

  9. You can use the URLs displayed in the Outputs tab for the stack to view the resources that were created.