How to Configure the Console¶
As we saw in the previous steps, we have made some configuration decisions already such as networking and container and queue sizing. The remaining configuration revolves around enabling scanning on your preferred buckets. We've made this really simple for you. Now that we have subscribed to and deployed Antivirus for Amazon S3, let's jump into the Console to start scanning your buckets.
It may take a few minutes for DNS to propagate. If you are unable to load the URL provided in the email (and/or CloudFormation Outputs) then wait a few minutes. If it continues to be an issue, check the console access trouble shooting to see if it is another issue.
The email with the login credentials arrives in your inbox even before the CloudFormation deployment completes. Please wait until you see the stack creation process complete.
Step 1 - Launch the Console¶
Open your modern browser of choice (chrome, firefox, edge, safari) and place the
access URL you retrieved in the previous step into the address bar and hit
Enter. You will be taken to the Console Login page as seen below.
During deployment, you were sent an email with information on how to sign in to the console. This email contains the current
access URL as well. You can simply click that to launch the console.
Each additional user created through the console will also receive a similar email.
Sign in to the Console¶
As seen above, an email is sent to you to provide your
User Name and
Temporary Password. Place the username and temporary password into the appropriate fields and click
First thing you must do is replace the temporary password. Create a new password for your user.
Change Password will save your new password and pass you through to the console dashboard.
We'll get into greater details about what you see here, but just know this is the overall status view into your environment.
You can leverage SSO with our solution. Check out the SSO FAQ which discusses it.
You must have at least one internal user setup and usable to enable the SSO users (one time) within the console.
Step 2 - Enable Bucket Scanning¶
Notice the top information banner indicating:
The information banner has 5 steps to get you started. All 5 steps have links to useful spots in the documentation to quickly get you started. The second will also direct you to the
Bucket Protection page under Configuration where you will be able to enable your first bucket for scanning. Click the
Switch to the Protected Buckets page link to enable your first Amazon S3 Bucket.
You could also have selected
Bucket Protection from the left navigation.
Bucket Protection Page:
Displayed to you are all of the buckets within your AWS account. It is quite easy to enable scanning for a bucket, simply select one or multiple checkboxes (or leverage
Select Visible to select all currently shown) for the buckets you wish to protect and select
Turn On Selected from the
Actions drop down button at the top of the bucket list. To get started pick a bucket in the same region as your console and turn it on. This will enabled the bucket for new object, event-based scanning.
There are 3 types of protection we will be getting into more detail as we go. But, those 3 types are: event-based (this is real-time protection), schedule-based (protection on a schedule) and on-demand protection. As stated above, you enabled the event-based real-time protection with what you just did above.
You will also be prompted to scan the existing objects in the bucket(s). You have the choice to skip this by clicking the
Don't Scan button or follow the instructions to select some or all of the buckets you had turned on to scan the existing objects as well.
Once you are to this point, you should see a green shield () in the row for any bucket you "turned on" above.
More details about scanning existing objects will be covered.
Don't Scan will not turn off event based scanning for those buckets you turned on. It will only skip the scanning of existing objects.
Enabling a bucket(s) will automatically deploy the Agent Scanner in the region the bucket is located. If you selected buckets from multiple regions, you will get an Agent Scanner in each.
Account identifier shows as
Primary. This represents the default account you deployed the solution in. If you link accounts for cross-account scanning, you will see a different identifier for those buckets that come from other accounts.
You may see rows with a yellow, red or purple background color (you should not see purple on your initial installation) to them. Yellow and red colors (as seen above) indicate there could be a conflict with activating event-based scanning for those particular buckets and you may have to take additional steps to enable scanning.
For information on how to resolve conflicted buckets, please read the Trouble Shooting section.
"Conflicted" buckets have no barrier for scan existing object scans. Since
scan existing crawls the objects (read more here) and is not triggered by events, there are absolutely no conflicts. Scan existing away!
Which Buckets do I Enable?¶
Enable them all! As simple as that sounds, you can decide which buckets you do and don't want to protect. All buckets with any public aspects to them should be scanned. Any buckets you share with others (public or not) should generally be scanned as you want to ensure what is shared is clean. No matter whether you choose to enable all or a subset it is easy and you can feel comfortable your files will be clean. Buckets that may be written by trusted programs like CloudTrail may not need to be scanned, but can be if regulations require you to.
Enabling Buckets in Other Regions¶
This solution is designed to scan all of your buckets, whether in one or multiple regions. If you select buckets in regions other than the console for the first time, you will be prompted to select a VPC and Subnet(s) for that region. Because we'll be deploying the Agent Scanner container to that region you must identify the networking for it to run on.
Selecting a bucket in a different region prompts you as follows:
Select the VPC and Subnet(s). You will be presented with VPC and Subnet selections for each new region you are enabling buckets in. Click
Save and Close
The VPC and Subnets you choose must have an outbound path to reach Amazon ECR. If not, the agents will never boot properly. As discussed in the troubleshooting topic, you can do with outbound access to the internet or through VPC Endpoints that give you access to ECR and API.
We now show
Private next to each VPC to indicate whether or not the VPC is tied to an Internet Gateway and therefor likely to have an outbound path. We also show
Restricted next to each Subnet to indicate whether each Subnet appears to have outbound routing.
Some regions only support Fargate in some of the Availability Zones. Regions ap-south-1 and ca-central-1 have limited AZs. If you get a message saying the container task cannot start up due to capacity or a Fargate instance isn't available, that could indicate you have found another AZ not supported. Switch which AZ the Fargate Service is pointing at and you should be fixed.
You can get more information at this AWS Fargate page. * You'll notice ap-south-1 is called out, but ca-central-1 is not although we found the same issue in both regions.
You're all set! Optionally check out Step 3
Step 3 - Enable API Scanning (Optional)¶
API-based scanning is an alternative option where you can leverage an API to perform file scanning. It is not directly S3-integrated as Step 2 provides, but API scanning is very useful in many workflows where you want the file scanned before it is written to is destination.
Read more about API Based Scanning at that link.