---
myst:
  html_meta:
    "description lang=en": "AWS VM Provider Settings."
    "keywords": "Kasm, AWS"
    "property=og:locale": "en_US"
---

```{figure} /images/compute/vm_aws.webp
:align: center
**AWS Settings**
```

```{eval-rst}
.. table:: AWS VM Provider Settings
    :widths: 200

    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **Name**                                  | **Description**                                                                                                                                                                                                |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **Name**                                  | A name to use to identify the config.                                                                                                                                                                          |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS Access Key ID**                     | The AWS Access Key used for the AWS API. If the value `{IAM}` is defined, the service will query the local metadata instance on the Webapp host to utilize a an instance attached IAM Role.                    |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS Secret Access Key**                 | The AWS Secret Access Key used for the AWS API. This value is ignored if `{IAM}` is defined for **AWS Access Key ID**                                                                                          |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: Region**                           | The AWS Region the EC2 Nodes should be provisioned in. e.g (us-east-1)                                                                                                                                         |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 AMI ID**                       | The AMI ID to use for the provisioned EC2 nodes. This should be an OS that is supported by the Kasm installer.                                                                                                 |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 Instance Type**                | The EC2 Instance Type (e.g t3.micro). Note the Cores and Memory override settings don't necessarily have to match the instance configurations. This is to allow for over provisioning.                         |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: Max EC2 Nodes**                    | The maximum number of EC2 nodes to provision regardless of the need for available free slots                                                                                                                   |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 Security Group IDs**           | A Json list containg security group IDs to assign the EC2 nodes. e.g :code:`["sg-065ae66f2d", "sg-02522kdkas"]`                                                                                                |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 Subnet ID**                    | The subnet ID to place the EC2 nodes in.                                                                                                                                                                       |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 EBS Volume Size (GB)**         | The size of the root EBS Volume for the EC2 nodes.                                                                                                                                                             |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 EBS Volume Type**              | The EBS Volume Type (e.g gp2)                                                                                                                                                                                  |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 IAM**                          | The IAM to assign the EC2 Nodes. Administrators may want to assign CloudWatch IAM access.                                                                                                                      |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 Custom Tags**                  | A Json dictionary for custom tags to assigned on auto-scaled Agent EC2 Nodes. e.g :code:`{"foo":"bar", "bin":"baz"}`                                                                                           |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS: EC2 Startup Script**               | When the EC2 Nodes are provision this script is executed. The script is responsible for installing and configuring the Kasm Agent.                                                                             |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **Retrieve Windows VM Password from AWS** | When provisioning an AWS Windows VM Kasm can retrieve the password generated by AWS and store it in the :doc:`Server </guide/compute/servers>` configuration record created during the autoscale provision.    |
    |                                           | This will only happen if the **Connection Password** field from the attached Autoscale config is blank. When populated Kasm will use the defined value instead of what is returned from AWS.                   |
    |                                           | The Administrator may want to leave this field blank and disable retrieving the password from AWS if they wish the Kasm user to be presented with a login screen to manually enter credentials upon            |
    |                                           | connecting to the Windows Workspace. NOTE: This setting only affects Windows (RDP connection type) AWS instances.                                                                                              |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **SSH Keys**                              | The SSH Key pair to assign the EC2 node                                                                                                                                                                        |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **AWS Config Override (JSON)**            | Custom configuration may be added to the provision request for advanced use cases. Instance configuration is overridden in the 'instance_config' configuration block e.g.                                      |
    |                                           | :code:`{"instance_config":{"EbsOptimized": true}}` `See EC2 Documentation for available options. <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/run_instances.html>`__ |
    +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


```