|
| 1 | +# MATLAB on Amazon Web Services (Windows VM) |
| 2 | + |
| 3 | +## Step 1. Launch the Template |
| 4 | + |
| 5 | +Click the **Launch Stack** button to deploy a standalone MATLAB® desktop client on AWS®. This |
| 6 | +opens the CloudFormation Create Stack screen in your web browser. |
| 7 | + |
| 8 | +| Region | Launch Link | |
| 9 | +| --------------- | ----------- | |
| 10 | +| **us-east-1** | [](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 11 | +| **us-east-2** | [](https://us-east-2.console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 12 | +| **us-west-1** | [](https://us-west-1.console.aws.amazon.com/cloudformation/home?region=us-west-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 13 | +| **us-west-2** | [](https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 14 | +| **ca-central-1** | [](https://ca-central-1.console.aws.amazon.com/cloudformation/home?region=ca-central-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 15 | +| **eu-central-1** | [](https://eu-central-1.console.aws.amazon.com/cloudformation/home?region=eu-central-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 16 | +| **eu-west-1** | [](https://eu-west-1.console.aws.amazon.com/cloudformation/home?region=eu-west-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 17 | +| **eu-west-2** | [](https://eu-west-2.console.aws.amazon.com/cloudformation/home?region=eu-west-2#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 18 | +| **eu-west-3** | [](https://eu-west-3.console.aws.amazon.com/cloudformation/home?region=eu-west-3#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 19 | +| **eu-north-1** | [](https://eu-north-1.console.aws.amazon.com/cloudformation/home?region=eu-north-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 20 | +| **sa-east-1** | [](https://sa-east-1.console.aws.amazon.com/cloudformation/home?region=sa-east-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 21 | +| **me-south-1** | [](https://me-south-1.console.aws.amazon.com/cloudformation/home?region=me-south-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 22 | +| **ap-east-1** | [](https://ap-east-1.console.aws.amazon.com/cloudformation/home?region=ap-east-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 23 | +| **ap-south-1** | [](https://ap-south-1.console.aws.amazon.com/cloudformation/home?region=ap-south-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 24 | +| **ap-northeast-1** | [](https://ap-northeast-1.console.aws.amazon.com/cloudformation/home?region=ap-northeast-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 25 | +| **ap-northeast-2** | [](https://ap-northeast-2.console.aws.amazon.com/cloudformation/home?region=ap-northeast-2#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 26 | +| **ap-southeast-1** | [](https://ap-southeast-1.console.aws.amazon.com/cloudformation/home?region=ap-southeast-1#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 27 | +| **ap-southeast-2** | [](https://ap-southeast-2.console.aws.amazon.com/cloudformation/home?region=ap-southeast-2#/stacks/create/review?templateURL=https://matlab-on-aws-win.s3.amazonaws.com/R2024a/aws-matlab-template.json) | |
| 28 | + |
| 29 | + |
| 30 | +**Note**: Creating a stack on AWS can take a few minutes. |
| 31 | + |
| 32 | +## Step 2. Configure the Cloud Resources |
| 33 | +After you click the Launch Stack button above, the “Create stack” page will open in your browser where you can configure the parameters. It is easier to complete the steps if you position these instructions and the AWS console window side by side. |
| 34 | + |
| 35 | +1. Specify a stack name. This will be shown in the AWS CloudFormation console and must be unique within the AWS account. |
| 36 | + |
| 37 | + |
| 38 | +2. Specify and check the defaults for these resource parameters: |
| 39 | + |
| 40 | +| Parameter label | Description | |
| 41 | +| --------------- | ----------- | |
| 42 | +| **AWS EC2 Instance type** | AWS instance type to use for MATLAB. See https://aws.amazon.com/ec2/instance-types for a list of instance types. | |
| 43 | +| **Instance Name** | Name for the MATLAB virtual machine | |
| 44 | +| **Storage Size (GiB)** | Size in GB of the root volume | |
| 45 | +| **Custom IAM Role (Optional)** | Name of a custom IAM Role to associate with this instance. If not specified, a predefined role is used. If specified, features requiring special permissions will be unavailable (NICE DCV, CloudWatch, IAM Policies). | |
| 46 | +| **Additional IAM Policies (Optional)** | Semicolon-delimited list of IAM Policy ARNs to add to the predefined role. This option cannot be used with a custom IAM Role. | |
| 47 | +| **VPC to deploy this stack to** | ID of an existing VPC in which to deploy this stack | |
| 48 | +| **Subnet** | ID of an existing subnet | |
| 49 | +| **RDP Key Pair** | Name of an existing EC2 KeyPair to allow RDP access to all the instances. See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html for details on creating these. | |
| 50 | +| **Allow RDP and SSH connections from** | IP address range that will be allowed to connect to this instance from outside of the VPC. This field should be formatted as \<ip_address>/\<mask>. E.g. 10.0.0.1/32. This is the public IP address which can be found by searching for 'what is my ip address' on the web. The mask determines the number of IP addresses to include. A mask of 32 is a single IP address. This calculator can be used to build a specific range: https://www.ipaddressguide.com/cidr. You may need to contact your IT administrator to determine which address is appropriate. | |
| 51 | +| **Remote password** | Password for the user Administrator | |
| 52 | +| **Confirm remote password** | Confirm Password | |
| 53 | +| **License Manager for MATLAB connection string** | Optional License Manager for MATLAB, specified as a string in the form \<port>@\<hostname>. If not specified, use online licensing. If specified, the network license manager (NLM) must be accessible from the specified VPC and subnets. To use the private hostname of the NLM hub instead of the public hostname, specify the security group ID of the NLM hub in the AdditionalSecurityGroup parameter. For more information, see https://github.com/mathworks-ref-arch/license-manager-for-matlab-on-aws. | |
| 54 | +| **Configure cloudwatch logging for the MATLAB instance** | Flag indicating whether cloudwatch logging for the MATLAB instance is enabled. | |
| 55 | +| **Additional security group to place instances in** | ID of an additional (optional) Security Group for the instances to be placed in. Often the License Manager for MATLAB's Security Group. | |
| 56 | +| **Use Elastic IP address that persists across machine reboots** | Flag indicating whether you want to keep the same public IP address for the instance. | |
| 57 | +| **AutoShutdown** | Choose whether you want to enable autoshutdown for your instance after a certain number of hours | |
| 58 | +| **Custom AMI ID (Optional)** | ID of a custom Amazon Machine Image (AMI) in the target region (optional). If the build has been customized then the resulting machine image may no longer be compatible with the provided CloudFormation template. Compatability can in some cases be restored by making corresponding modifications to the CloudFormation template. The ID should start with 'ami-'. | |
| 59 | +| **Optional user inline command** | Provide an optional inline PowerShell command to run on machine launch. For example, to set an environment variable CLOUD=AWS, use this command excluding the angle brackets: \<[System.Environment]::SetEnvironmentVariable("CLOUD","AWS", "Machine");>. You can use either double quotes or two single quotes. To run an external script, use this command excluding the angle brackets: \<Invoke-WebRequest "https://www.example.com/script.ps1" -OutFile script.ps1; .\script.ps1>. Find the logs at '$Env:ProgramData\MathWorks\startup.log'. | |
| 60 | + |
| 61 | + |
| 62 | +>**Note**: In the capabilities section, you must acknowledge that AWS Cloudformation might create IAM resources and autoexpand nested templates when creating the stack. |
| 63 | +
|
| 64 | +3. Click the **Create Stack** button. The CloudFormation service will start creating the resources for the stack. <p>After clicking **Create** you will be taken to the *Stack Detail* page for your stack. Wait for the Status to reach **CREATE\_COMPLETE**. This may take up to 10 minutes.</p> |
| 65 | + |
| 66 | +## Step 3. Connect to the Virtual Machine in the Cloud |
| 67 | + |
| 68 | +1. Expand the **Outputs** section in the *Stack Detail* page. |
| 69 | +1. Look for the key named `RDPSSHConnection` and copy the corresponding public DNS name listed under value. *For example*: ec2-11-222-33-44.compute-1.amazonaws.com |
| 70 | +1. Launch any remote desktop client, paste the public DNS name in the appropriate field, and connect. On the Windows Remote Desktop Client you need to paste the public DNS name in the **Computer** field and click **Connect**. |
| 71 | +1. In the login screen that's displayed, use the username `Administrator` and the password you specified while setting up the stack in [Step 2](#step-2-configure-the-stack). |
| 72 | +1. You can also connect using SSH from the terminal using the format: `ssh Administrator@<DNS name>`. *For example *: ssh [email protected] |
| 73 | + |
| 74 | +## Step 4. Start MATLAB |
| 75 | +Double-click the MATLAB icon on the virtual machine desktop to start MATLAB. The first time you start MATLAB, you need to enter your MathWorks® Account credentials to license MATLAB. For other ways to license MATLAB, see [MATLAB Licensing in the Cloud](https://www.mathworks.com/help/install/license/licensing-for-mathworks-products-running-on-the-cloud.html). |
| 76 | + |
| 77 | +>**Note**: It may take up to a minute for MATLAB to start the first time. |
| 78 | +
|
| 79 | + |
| 80 | +# Additional Information |
| 81 | + |
| 82 | +## CloudWatch Logs |
| 83 | +CloudWatch logs enables you to access logs from all the resources in your stack in a single place. To use CloudWatch logs, launch the stack with the feature "Configure cloudwatch logging for the MATLAB instance" enabled. Once the stack deployment is complete, you can access your logs in the "Outputs" of the stack by clicking the link next to "CloudWatchLogs". Note that if you delete the stack, the CloudWatch log group is also deleted. For more information, see [What is Amazon CloudWatch Logs?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html). |
| 84 | + |
| 85 | +## Installing NVIDIA GRID Drivers |
| 86 | +If you are running a GPU instance that belongs to G3, G4dn or G5 instance type, you can install NVIDIA GRID Drivers using the `Install-NVIDIAGridDriver.ps1` script placed in the `C:\Windows\NVIDIADrivers\` directory. These drivers are certified to provide optimal performance for visualization applications that render content such as 3D models or high-resolution videos. Possible use cases include 4K resolution streaming via NICE DCV or using Automated Driving toolbox to run simulations in a rich 3D-environment. Please note that, for the installation of GRID drivers to complete, a machine restart is required. |
| 87 | + |
| 88 | +## Delete Your Cloud Resources |
| 89 | + |
| 90 | +Once you have finished using your stack, it is recommended that you delete all resources to avoid incurring further cost. To delete the stack, do the following: |
| 91 | +1. Log in to the AWS Console. |
| 92 | +1. Go to the AWS CloudFormation page and select the stack you created. |
| 93 | +1. Click the **Actions** button and click **Delete Stack** from the menu that appears. |
| 94 | + |
| 95 | +## Nested Stacks |
| 96 | + |
| 97 | +This CloudFormation template uses nested stacks to reference templates used by multiple reference architectures. For details, see the [MathWorks Infrastructure as Code Building Blocks](https://github.com/mathworks-ref-arch/iac-building-blocks) repository. |
| 98 | + |
| 99 | +---- |
| 100 | + |
| 101 | +Copyright 2020-2024 The MathWorks, Inc. |
| 102 | + |
| 103 | +---- |
0 commit comments