id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
user-guide.pdf-024 | user-guide.pdf.pdf | 24 | send render jobs directly to Deadline Cloud. This integration streamlines your workflow by eliminating the need to switch between applications or manually transfer files. This saves time and reduces the potential for errors. Submitters are available for many popular DCC applications. Installing a submitter, adds Deadline Cloud specific options to your application's interface, typically in the render settings or export menu. With a Deadline Cloud submitter you can: • Configure render job parameters in your familiar DCC environment • Submit jobs to Deadline Cloud without leaving your application • Reduce the potential for errors associated with manual file transfers • Save time because you don't need to switch between applications To find a submitter for your DCC application, check the supported submitters list. Then follow the instructions in Set up Deadline Cloud submitters to install the submitter. If your application doesn't have a supported submitter, you can still run jobs for your application. There may be a sample job bundle available for it, or you can construct a simple submitter for the application's render CLI command. For more information, see Open Job Description (OpenJD) templates for Deadline Cloud in the Deadline Cloud Developor Guide. The examples in this topic use the Blender submitter, but the steps for using other submitters are similar. Note To use a submitter, you must be signed in to the Deadline Cloud monitor. The submitter has four tabs: Topics Using a submitter Version latest 60 AWS Deadline Cloud • Shared job settings tab • Job-specific settings tab • Job attachments tab • Host requirements tab User Guide Using a submitter Version latest 61 AWS Deadline Cloud Shared job settings tab User Guide The shared job settings tab contains the settings that are common to all jobs sent to Deadline Cloud using the submitter. The three sections are: Shared job settings tab Version latest 62 AWS Deadline Cloud User Guide • Job properties – Sets the overall properties of the job. These properties are present in submitters for all DCC applications. • Deadline Cloud settings – Shows the farm and queue that the job is sent to. To change the farm and queue, use the Settings... button at the bottom of the submitter. • Queue environment – Sets the parameter values defined in the queue environment. Deadline Cloud adds the default parameter values for your DCC application, you can add additional values if necessary. Shared job settings tab Version latest 63 AWS Deadline Cloud User Guide Job-specific settings tab The job-specific settings tab contains the setting specific to your DCC application. Specify these settings based on the options available in your application. Job-specific settings tab Version latest 64 AWS Deadline Cloud Job attachments tab User Guide The job attachments tab shows all of the files needed to complete a render. The submitter tries to find all of the files required for the render. The files that it identifies appear in the lists in italics. Job attachments tab Version latest 65 AWS Deadline Cloud User Guide You can add additional input files and directories that contain other assets required for the render that were not automatically detected. If your job writes files to multiple output directories, you must specify the directories here so that the are part of the job download. Job attachments tab Version latest 66 AWS Deadline Cloud Host requirements tab User Guide The host requirements tabs sets the fleet capabilities required to process the job. Capabilities are specified for the entire fleet, not individual workers in the fleet. Host requirements tab Version latest 67 AWS Deadline Cloud User Guide If your queue has associated resource limits, use the Add amount button to specify the limit. For more information, see Create resource limits for jobs Processing Deadline Cloud jobs When a job enters a queue, Deadline Cloud schedules it on one or more fleets associated with the queues. The fleet is chosen based on the capabilities configured for the fleet and the host requirements of a specific step. If a job has a requirement that can't be met by a any of the fleets associated with the queue, the job's status is set to "Not compatible" and the rest of the steps in the job are canceled. Next, Deadline Cloud sends instructions to the workers to set up a session for the step. The software required for the step must be available on the worker instance for the job to run. The service opens sessions on multiple workers if the fleets scaling settings allow. You can set up the software in an Amazon Machine Image (AMI), or your worker can load the software at runtime from a repository or package manager. You can use queue, job, or step environments to deploy the software that you prefer. The Deadline Cloud service uses the OpenJD template to identify |
user-guide.pdf-025 | user-guide.pdf.pdf | 25 | canceled. Next, Deadline Cloud sends instructions to the workers to set up a session for the step. The software required for the step must be available on the worker instance for the job to run. The service opens sessions on multiple workers if the fleets scaling settings allow. You can set up the software in an Amazon Machine Image (AMI), or your worker can load the software at runtime from a repository or package manager. You can use queue, job, or step environments to deploy the software that you prefer. The Deadline Cloud service uses the OpenJD template to identify the steps required for the job, and the tasks required for each step. Some steps have dependencies on other steps, so Deadline Cloud determines the order to complete the steps. Then, Deadline Cloud sends the tasks for each step to workers to process. When a task is finished, the service sends another task in the same session, or the worker can start a new session. After all tasks in each step are finished, the job is complete and the output is ready to download to your workstation. Even if the job didn't finish, the output from each step and task that finished is available to download. Note Deadline Cloud removes jobs 120 days after they were submitted. When a job is removed, all of the steps and tasks associated with the job are also removed. If you need to re-run the job, submit the OpenJD template for the job again. Monitoring Deadline Cloud jobs The AWS Deadline Cloud monitor provides you with an overall view of your jobs. Use it to: Processing jobs Version latest 68 AWS Deadline Cloud • Monitor and manage jobs • View worker activity on fleets • Track budgets and usage • Download a job's results. User Guide To monitor a specific job, select the farm and queue containing the job, then select the job from the list. You can use the search box to locate a specific job or jobs in the queue. Right click on a job, step, or task to see the options for the item. You can: • Change the status • Suspend and resume the item • Requeue the item • Download the output • For tasks: View task and worker logs. For more information, see Using the Deadline Cloud monitor. Each task in a job or step has a status. The status of a job or step depends on the status of its tasks. The status is determined by tasks that have these statuses, in order. Step statuses are determined the same as the job status. Monitoring jobs Version latest 69 AWS Deadline Cloud User Guide The following list describes the statuses: NOT_COMPATIBLE The job is not compatible with the farm because there are no fleets that can complete one of the tasks in the job. RUNNING One or more workers are running tasks from the job. As long as there is at least one running task, the job is marked RUNNING. Monitoring jobs Version latest 70 AWS Deadline Cloud ASSIGNED User Guide One or more workers are assigned tasks in the job as their next action. The environment, if any, is set up. STARTING One or more workers is setting up the environment for running tasks. SCHEDULED Tasks for the job are scheduled on one or more workers as the worker's next action. READY At least one task for the job is ready to be processed. INTERRUPTING At least one task in the job is being interrupted. Interruptions can happen when you manually update the job's status. It can also happen in response to an interruption due to Amazon Elastic Compute Cloud (Amazon EC2) Spot price changes. FAILED One or more tasks in the job didn't complete successfully. CANCELED One or more tasks in the job have been canceled. SUSPENDED At least one task in the job has been suspended. PENDING A task in the job is waiting on the availability of another resource. SUCCEEDED All tasks in the job were successfully processed. Monitoring jobs Version latest 71 AWS Deadline Cloud User Guide File storage for Deadline Cloud Workers must have access to the storage locations that contain the input files necessary to process a job, and to the locations that store the output. AWS Deadline Cloud provides two options for storage locations: • With job attachments, Deadline Cloud transfers the input and output files for your jobs back and forth between a workstation and Deadline Cloud workers. To enable the file transfers, Deadline Cloud uses an Amazon Simple Storage Service (Amazon S3) bucket in your AWS account. When you use job attachments with a service-managed fleet, you can set up a virtual file system (VFS) in your virtual private network (VPN). Then workers can load files only when |
user-guide.pdf-026 | user-guide.pdf.pdf | 26 | input files necessary to process a job, and to the locations that store the output. AWS Deadline Cloud provides two options for storage locations: • With job attachments, Deadline Cloud transfers the input and output files for your jobs back and forth between a workstation and Deadline Cloud workers. To enable the file transfers, Deadline Cloud uses an Amazon Simple Storage Service (Amazon S3) bucket in your AWS account. When you use job attachments with a service-managed fleet, you can set up a virtual file system (VFS) in your virtual private network (VPN). Then workers can load files only when needed. • With shared storage, you use file sharing with your operating system to provide access to files. When you use cross-platform shared storage, you can create a storage profile so that workers can map the path to files between two different operating systems. Topics • Job attachments in Deadline Cloud Job attachments in Deadline Cloud Job attachments enable you to transfer files back and forth between your workstation and AWS Deadline Cloud. With job attachments, you don't need to manually set up an Amazon S3 bucket for your files. Instead, when you create a queue with the Deadline Cloud console, you choose the bucket for your job attachments. The first time that you submit a job to Deadline Cloud, all of the files for the job are transferred to Deadline Cloud. For subsequent submissions, only the files that have changed are transferred, saving both time and bandwidth. After processing is complete, you can download the result from the job detail page, or by using the Deadline Cloud CLI deadline job download-output command. You can use the same S3 bucket for multiple queues. Set a different root prefix for each queue to organize the attachments in the bucket. Job attachments Version latest 72 AWS Deadline Cloud User Guide When you create a queue with the console, you can either choose an existing AWS Identity and Access Management (IAM) role or you can have the console create a new role. If the console creates the role, it sets permissions to access the bucket that's specified for the queue. If you choose an existing role, you must grant the role permissions to access the S3 bucket. Encryption for job attachment S3 buckets Job attachment files are encrypted in your S3 bucket by default. This helps secure your information from unauthorized access. You don't need to do anything to have your files encrypted with keys provided by Deadline Cloud. For more information, see Amazon S3 now automatically encrypts all new objects in the Amazon S3 User Guide. You can use your own customer managed AWS Key Management Service key to encrypt the S3 bucket that contains your job attachments. To do so, you must modify the IAM role for the queue associated with the bucket to allow access to the AWS KMS key. To open the IAM policy editor for the queue role 1. 2. 3. 4. Sign in to the AWS Management Console and open the Deadline Cloud console. From the main page, in the Get started section, choose View farms. From the list of farms, choose the farm that contains the queue to modify. From the list of queues, choose the queue to modify. In the Queue details section, choose the Service role to open the IAM console for the service role. Next, complete the following procedure. To update the role policy with permission for AWS KMS 1. 2. From the list of Permissions policies, choose the policy for the role. In the Permissions defined in this policy section, choose Edit. 3. Choose Add new statement. 4. Copy and paste the following policy into the editor. Change the Region, accountID, and keyID to your own values. { "Effect": "Allow", Encryption for job attachment S3 buckets Version latest 73 AWS Deadline Cloud User Guide "Action": [ "kms:Decrypt", "kms:DescribeKey", "kms:GenerateDataKey" ], "Resource": [ "arn:aws:kms:Region:accountID:key/keyID" ] } 5. Choose Next. 6. Review the changes to the policy, and then when you're satisfied, choose Save changes. Managing job attachments in S3 buckets Deadline Cloud stores the job attachment files required for your job in an S3 bucket. These files accumulate over time, leading to increased Amazon S3 costs. To reduce costs, you can apply an S3 Lifecycle configuration to your S3 bucket. This configuration can automatically delete files in the bucket. Because the S3 bucket is in your account, you can choose to modify or remove the S3 Lifecycle configuration at any time. For more information, see Examples of S3 Lifecycle configuration in the Amazon S3 User Guide. For a more granular S3 bucket management solution, you can set up your AWS account to expire objects in an S3 bucket based on the last time that they were accessed. For more information, see Expiring Amazon |
user-guide.pdf-027 | user-guide.pdf.pdf | 27 | Amazon S3 costs. To reduce costs, you can apply an S3 Lifecycle configuration to your S3 bucket. This configuration can automatically delete files in the bucket. Because the S3 bucket is in your account, you can choose to modify or remove the S3 Lifecycle configuration at any time. For more information, see Examples of S3 Lifecycle configuration in the Amazon S3 User Guide. For a more granular S3 bucket management solution, you can set up your AWS account to expire objects in an S3 bucket based on the last time that they were accessed. For more information, see Expiring Amazon S3 objects based on last accessed date to decrease costs on the AWS Architecture Blog. Deadline Cloud virtual file system Virtual file system support for job attachments in AWS Deadline Cloud enables client software on workers to communicate directly with Amazon Simple Storage Service. Workers can load files only when needed instead of downloading all files before processing. Files are stored locally. This approach avoids downloading assets used more than once multiple times. All files are removed after the job completes. • The virtual file system provides a significant performance boost for specific job profiles. In general, smaller subsets of total files with larger fleets of workers show the most benefit. Small numbers of files with fewer workers have roughly equivalent processing times. • Virtual file system support is only available for Linux workers in service-managed fleets. Managing job attachments in S3 buckets Version latest 74 AWS Deadline Cloud User Guide • The Deadline Cloud virtual file system supports the following operations, but is not POSIX compliant: • File create, delete, open, close, read, write, append, truncate, rename, move, copy, stat, fsync, and falloc • Directory create, delete, rename, move, copy, and stat • The virtual file system is designed to reduce data transfer and improve performance when your tasks access only part of a large data set, and is not optimized for all workloads. You should test your workload before running production jobs. Enable VFS support Virtual file system support (VFS) is enabled for each job. A job falls back to the default job attachments framework in these cases: • A worker instance profile does not support a virtual file system. • Problems prevent launching the virtual file system process. • The virtual file system can't be mounted. To enable virtual file system support using the submitter 1. When submitting a job, choose the Settings button to open the AWS Deadline Cloud workstation configuration panel. 2. From the Job attachments filesystem options dropdown, choose VIRTUAL. Virtual file system Version latest 75 AWS Deadline Cloud User Guide 3. To save your changes, choose OK. To enable virtual file system support using the AWS CLI • Use the following command when you submit a saved job: deadline bundle submit-job --job-attachments-file-system VIRTUAL Virtual file system Version latest 76 AWS Deadline Cloud User Guide To verify that the virtual file system launched successfully for a particular job, review your logs in Amazon CloudWatch Logs. Look for the following messages: Using mount_point mount_point Launching vfs with command command Launched vfs as pid PID number If the log contains the following message, virtual file system support is disabled: Virtual File System not found, falling back to COPIED for JobAttachmentsFileSystem. Troubleshooting virtual file system support You can view logs for your virtual file system using the Deadline Cloud monitor. For instructions, see View logs in Deadline Cloud. Virtual file system logs are also sent to the CloudWatch Logs group that's associated with the queue shared with the worker agent output. Virtual file system Version latest 77 AWS Deadline Cloud User Guide Track spending and usage for Deadline Cloud farms The AWS Deadline Cloud budget manager and usage explorer are cost management tools that provide the approximate cost of using Deadline Cloud based on available information about cost variables. The cost management tools don't guarantee the amount owed for your actual use of Deadline Cloud and other AWS services. To help you manage costs for Deadline Cloud, you can use the following features: • Budget manager – With the Deadline Cloud budget manager, you can create and edit budgets to help manage project costs. • Usage explorer – With the Deadline Cloud usage explorer, you can view how many AWS resources are used and the estimated costs for those resources. • AWS cost allocation tags – With cost allocation tags, you can track detailed costs for all of your AWS services. For more information, see Organizing and tracking costs using AWS cost allocation tags. Cost assumptions The basic calculation used by the Deadline Cloud cost management tools is: Cost per job = (CMF run time x CMF compute rate) + (SMF run time x SMF compute rate) + (License run time x license rate) • Run time |
user-guide.pdf-028 | user-guide.pdf.pdf | 28 | – With the Deadline Cloud usage explorer, you can view how many AWS resources are used and the estimated costs for those resources. • AWS cost allocation tags – With cost allocation tags, you can track detailed costs for all of your AWS services. For more information, see Organizing and tracking costs using AWS cost allocation tags. Cost assumptions The basic calculation used by the Deadline Cloud cost management tools is: Cost per job = (CMF run time x CMF compute rate) + (SMF run time x SMF compute rate) + (License run time x license rate) • Run time is the sum of all tasks in a job, from start time to end time. • Compute rate is determined by the AWS Deadline Cloud pricing for service-managed fleets. For customer-managed fleets, the compute rate is estimated to be $1 per worker hour. • License rate is determined by the Deadline Cloud base license price and is only available for service-managed fleets. Additional tiers are not included. For more information about license pricing, see AWS Deadline Cloud pricing. The cost estimate from the Deadline Cloud cost management tools may vary from your actual costs for a number of reasons. Common reasons include: Cost assumptions Version latest 78 AWS Deadline Cloud User Guide • Customer owned resources and their pricing. You can choose to bring your own resources, either from AWS or externally from on-premises or other cloud providers. Actual costs of these resources are not calculated. • Idle worker costs. Idle worker costs are not included when the worker status is IDLE. This can happen for fleets with a minimum instance count greater than zero, or when workers transition between jobs. Idle worker cost are not included in calculations. • Worker stop and start time. After workers complete a job, the cost for moving from IDLE to STOPPING and from STOPPING to STOPPED is not included in Deadline Cloud cost estimates. • Promotional credits, discounts, and custom pricing agreements. The cost management tools don't account for promotional credits, private pricing agreements, or other discounts. You may be eligible for other discounts that are not part of the estimate. • Asset storage. Asset storage is not included in the cost and usage estimates. • Changes in price. AWS offers pay-as-you-go pricing for most services. Prices may change over time. The cost management tools use the most up-to-date prices publicly available, but there may be delays after changes. • Taxes. The cost management tools don't include taxes applied to our purchase of the service. • Rounding. The cost management tool perform mathematical rounding of pricing data. • Currency. Cost estimates are made in U.S. dollars. Global exchange rates vary over time. If you translate estimates to a different currency base on the current exchange, changes in the exchange rate affect the estimate. • Outside licensing. If you choose to use pre-purchased licences (Software licensing for service- managed fleets), Deadline Cloud cost management tools can't account for this cost. Control costs with a budget The Deadline Cloud budget manager helps you control spending on a given resource, such as a queue, fleet, or farm. You can create budget amounts and limits, and set automated actions to help reduce or stop additional spending against the budget. The following sections provide you with the steps for using the Deadline Cloud budget manager. Topics • Prerequisite • Open the Deadline Cloud budget manager Control costs with a budget Version latest 79 AWS Deadline Cloud User Guide • Create a budget for a Deadline Cloud queue • View a Deadline Cloud queue budget • Edit a budget for a Deadline Cloud queue • Deactivate a budget for a Deadline Cloud queue • Monitor a budget with EventBridge events Prerequisite To use the Deadline Cloud budget manager, you must have OWNER access level. To grant OWNER permission, follow the steps in Managing users in Deadline Cloud. Open the Deadline Cloud budget manager To open the Deadline Cloud budget manager, use the following procedure. 1. Sign in to the AWS Management Console and open the Deadline Cloud console. 2. Choose View farms. 3. 4. Locate the farm that you want to get information about, then choose Manage jobs. In the Deadline Cloud monitor, in the left navigation pane, choose Budgets. The budget manager summary page displays a list of both active and inactive budgets: • Active budgets track against the selected resource (a queue). • Inactive budgets have either expired or been canceled by a user, and are no longer tracking costs against this budget's limits. After you choose a budget, the budget summary page contains basic information about the budget. Information provided includes the budget name, status, resources, remaining percentage, remaining amount, total budget, start date, and end date. Create a budget for a Deadline Cloud queue To |
user-guide.pdf-029 | user-guide.pdf.pdf | 29 | the Deadline Cloud monitor, in the left navigation pane, choose Budgets. The budget manager summary page displays a list of both active and inactive budgets: • Active budgets track against the selected resource (a queue). • Inactive budgets have either expired or been canceled by a user, and are no longer tracking costs against this budget's limits. After you choose a budget, the budget summary page contains basic information about the budget. Information provided includes the budget name, status, resources, remaining percentage, remaining amount, total budget, start date, and end date. Create a budget for a Deadline Cloud queue To create a budget, use the following procedure. 1. If you haven't already, sign in to the AWS Management Console, open the Deadline Cloud console, choose a farm, and then choose Manage jobs. Prerequisite Version latest 80 AWS Deadline Cloud User Guide 2. 3. 4. 5. From the Budget manager page, choose Create budget. In the details section, enter a Budget name for the budget. (Optional) In the description field, enter a brief description of the budget. From Resource, use the Queue dropdown to select the queue that you want to create a budget for. 6. For Period, set the start and end date for the budget by completing the following steps: a. For Start date, enter the first date of the budget tracking in YYYY/MM/DD format, or choose the calendar icon and select a date. The default start date is the date that the budget is created. b. For End date, enter the last date of the budget tracking in YYYY/MM/DD format or choose the calendar icon and select a date. 7. 8. The default end date is 120 days from the start date. For Budget amount, enter the dollar amount of the budget. (Optional) We recommend that you create limit alerts. In the Limit actions section, you can implement automated actions that occur when specific amounts remain in the budget. To do this, complete the following steps: a. b. c. Choose Add new action. For Remaining amount, enter the dollar amount that you want to start the action. In the Action dropdown, choose the action that you want. Actions include: • Stop after finishing current work – All work currently running when the threshold amount is met continue to run (and incur costs) until finished. • Immediately stop work – All work is canceled immediately when the threshold amount is met. d. To create additional limit alerts, choose Add new action and repeat the previous steps. 9. Choose Create budget. View a Deadline Cloud queue budget After you create a budget, you can view the budget on the Budget manager page. From there, you can view the budget’s total amount and the overall cost allocated to the specific budget. View a budget Version latest 81 AWS Deadline Cloud User Guide To view a budget, use the following procedure. 1. If you haven't already, sign in to the AWS Management Console, open the Deadline Cloud console, choose a farm, and then choose Manage jobs. 2. Choose Budgets from the left side navigation pane. The Budget Manager page appears. 3. 4. To view an active budget, choose the Active budgets tab, and choose the name of the budget that you want to view. The budget details page appears. To view the budget details for an expired budget, choose the Inactive budgets tab. Then, choose the name of the budget that you want to view. The budget details page appears. Edit a budget for a Deadline Cloud queue You can edit any active budget. To edit an active budget, use the following procedure. 1. 2. If you haven't already, sign in to the AWS Management Console, open the Deadline Cloud console, choose a farm, and then choose Manage jobs. From the Budget Manager page, in the Active budgets tab, choose the button next to the budget you want to edit. 3. From the Actions dropdown menu, select Edit budget. 4. Make the changes that you want, and then choose Update budget. Deactivate a budget for a Deadline Cloud queue You can deactivate any active budget. Deactivating a budget changes its status from Active to Inactive. When a budget is deactivated, it no longer tracks a resource to that budget’s amount. To deactivate a budget, use the following procedure. 1. 2. 3. If you haven't already, sign in to the AWS Management Console, open the Deadline Cloud console, choose a farm, and then choose Manage jobs. From the Budget manager page, in the Active Budgets tab, choose the button next to the budget that you want to deactivate. From the Actions dropdown menu, select Deactivate budget. In a few moments, the selected budget will change from Active to Inactive and will move from the Active Budgets tab to the Inactive Budgets tab. Edit |
user-guide.pdf-030 | user-guide.pdf.pdf | 30 | longer tracks a resource to that budget’s amount. To deactivate a budget, use the following procedure. 1. 2. 3. If you haven't already, sign in to the AWS Management Console, open the Deadline Cloud console, choose a farm, and then choose Manage jobs. From the Budget manager page, in the Active Budgets tab, choose the button next to the budget that you want to deactivate. From the Actions dropdown menu, select Deactivate budget. In a few moments, the selected budget will change from Active to Inactive and will move from the Active Budgets tab to the Inactive Budgets tab. Edit a budget Version latest 82 AWS Deadline Cloud User Guide Monitor a budget with EventBridge events Deadline Cloud sends budget-related events, using Amazon EventBridge, to your default EventBridge event bus. You can create custom functions that receive the events and act on them to send notifications to automatically notify users via email, Slack, or other channels when a budget reaches predefined levels. For example, you can send SMS messages when a budget reaches a certain threshold. This helps you stay on top of your spending and make informed decisions before your budget is exhausted. Deadline Cloud periodically aggregates usage and cost data for each render farm. Then it checks to see if any of the budget thresholds has been crossed. If a threshold is crossed, Deadline Cloud triggers an event to alert you so that you can take the appropriate action. An event is triggered whenever a budget crosses one of these thresholds, specified in percent of the budget used: • 10, 20, 30, 40, 50, 60, 70, 75, 80, 85, 90, 95, 96, 97, 98, 99, 100 The budget usage thresholds get closer together as a budget approaches 100 percent usage. This helps you closely monitor usage as the budget reaches its limit. You can also set your own budget thresholds. Deadline Cloud sends an event when usage passes your custom thresholds. After your budget reaches 100 percent, Deadline Cloud stops sending events. If you adjust your budget, Deadline Cloud sends events for your thresholds based on the new budget amount. You can use the EventBridge console (https://console.aws.amazon.com/events/) to create rules to send the Deadline Cloud events to the appropriate target for the event. For example, you can send the event to an Amazon Simple Queue Service queue and from there to multiple targets, such as AWS End User Messaging SMS or a Amazon Relational Database Service database for logging. For examples of an EventBridge rule, see the following topics: • Send an email when events happen using Amazon EventBridge. • Creating an Amazon EventBridge rule that sends notifications to Amazon Q Developer in chat applications. • Getting started with Amazon EventBridge. For more information about budget events, see the Budget Threshold Reached event in the Deadline Cloud Developer Guide. Monitor a budget with EventBridge events Version latest 83 AWS Deadline Cloud User Guide Track usage and costs with the Deadline Cloud usage explorer With the Deadline Cloud usage explorer, you can see real-time metrics on the activity happening on each farm. You can look at the farm’s costs by different variables, such as queue, job, license product, or instance types. Select various time frames to see usage during a specific period of time, and look at usage trends over the course of time. You can also see a detailed breakdown of selected data points, allowing for a closer look into metrics. Usage can be shown by time (minutes and hours) or by cost ($USD). The following sections show you the steps for accessing and using the Deadline Cloud usage explorer. Topics • Prerequisite • Open the usage explorer • Use the usage explorer Prerequisite To use the Deadline Cloud usage explorer, you must have either MANAGER or OWNER farm permissions. For more information, see Manage users and groups for farms, queues, and fleets. Note If your time zone doesn't align to a full hour, such as India Standard Time (UTC+5:30), the usage explorer doesn't show usage metrics. To see metrics, set your time zone to a zone that aligns to a full hour. Open the usage explorer To open the Deadline Cloud usage explorer, use the following procedure. 1. 2. 3. Sign in to the AWS Management Console and open the Deadline Cloud console. To see all available farms, choose View farms. Locate the farm that you want to get information about, then choose Manage jobs. The Deadline Cloud monitor opens in a new tab. Track usage and costs Version latest 84 AWS Deadline Cloud User Guide 4. In the Deadline Cloud monitor, from the left menu, select Usage explorer. Use the usage explorer From the usage explorer page, you can select specific parameters in which the data can be displayed. By default, you see total usage in |
user-guide.pdf-031 | user-guide.pdf.pdf | 31 | 1. 2. 3. Sign in to the AWS Management Console and open the Deadline Cloud console. To see all available farms, choose View farms. Locate the farm that you want to get information about, then choose Manage jobs. The Deadline Cloud monitor opens in a new tab. Track usage and costs Version latest 84 AWS Deadline Cloud User Guide 4. In the Deadline Cloud monitor, from the left menu, select Usage explorer. Use the usage explorer From the usage explorer page, you can select specific parameters in which the data can be displayed. By default, you see total usage in time (hours and minutes) within the last 7 days. You can change these parameters, and the information displayed changes dynamically in accordance to the parameter settings. You can group the results based on the queue, job, compute usage, instance type, or license product. If you choose license product, costs are calculated for specific licenses. For all other groups the time is calculated by adding up the time taken for each task to run. The usage explorer returns only 100 results based on the filter criteria that you set. The results are listed in descending order by the date created timestamp. If there are more than 100 results, you get an error message. You can refine your query to reduce the number of results: • Select a smaller time range • Select fewer queues • Select a different grouping, such as grouping by queue instead of job Topics • Use visual graphs to review data • View a breakdown of metrics • View approximate runtime of queues Use visual graphs to review data You can review data in a visual format to identify trends and potential areas that might need more analysis or attention. Usage explorer offers a pie chart that displays overall usage and cost with the option to group the totals into smaller subtotals. Note The chart only displays the top five results with other results combined in an "others" section. You can view all results in the breakdown section below the chart. Use the usage explorer Version latest 85 AWS Deadline Cloud User Guide View a breakdown of metrics Beneath the pie chart, usage explorer offers a more detailed breakdown of specific metrics, which will change as parameters change. By default, five results display in the usage explorer. You can scroll through results using the pagination arrows in the breakdown section. Breakdown is minimized by default. To expand and display the results, select the View all breakdown arrow. To download the breakdown, choose Download data. View approximate runtime of queues You can also view the approximate runtime of your queues based on different intervals that you specify. The interval options are hourly, daily, weekly, and monthly. After you select an interval, the graph displays the approximate runtime of your queues. Use the usage explorer Version latest 86 AWS Deadline Cloud User Guide Cost management AWS Deadline Cloud provides budgets and the usage explorer to help you control and visualize costs for your jobs. However, Deadline Cloud uses other AWS services, such as Amazon S3. Costs for those services are not reflected in Deadline Cloud budgets or the usage explorer and are charged separately based on usage. Depending on how you configure Deadline Cloud, you may use the following AWS services, as well as others: Service Pricing page Amazon CloudWatch Logs Amazon CloudWatch Logs pricing Amazon Elastic Compute Cloud Amazon Elastic Compute Cloud pricing AWS Key Management Service AWS Key Management Service pricing AWS PrivateLink AWS PrivateLink pricing Amazon Simple Storage Service Amazon Simple Storage Service pricing Cost management Version latest 87 AWS Deadline Cloud Service Pricing page User Guide Amazon Virtual Private Cloud Amazon Virtual Private Cloud pricing Cost management best practices Using the following best practices can help you understand and control your costs when using Deadline Cloud and the tradeoffs you can make between cost and efficiency. Note The final cost of using Deadline Cloud depends on the interaction between a number of AWS services, the amount of work that you process, and the AWS Region where you run your jobs. The following best practices are guidelines and may not significantly reduce costs. Best practices for CloudWatch Logs Deadline Cloud sends worker and task logs to CloudWatch Logs. You are charged to collect, store, and analyze these logs. You can reduce costs by logging only the minimum amount of data required to monitor your tasks. When you create a queue or fleet, Deadline Cloud creates a CloudWatch Logs log group with the following names: • /aws/deadline/<FARM_ID>/<FLEET_ID> • /aws/deadline/<FARM_ID>/<QUEUE_ID> By default, these logs never expire. You can adjust the retention policy of log groups to remove old logs and help reduce storage costs. You can also export logs to Amazon S3. Amazon S3 storage costs are lower |
user-guide.pdf-032 | user-guide.pdf.pdf | 32 | CloudWatch Logs Deadline Cloud sends worker and task logs to CloudWatch Logs. You are charged to collect, store, and analyze these logs. You can reduce costs by logging only the minimum amount of data required to monitor your tasks. When you create a queue or fleet, Deadline Cloud creates a CloudWatch Logs log group with the following names: • /aws/deadline/<FARM_ID>/<FLEET_ID> • /aws/deadline/<FARM_ID>/<QUEUE_ID> By default, these logs never expire. You can adjust the retention policy of log groups to remove old logs and help reduce storage costs. You can also export logs to Amazon S3. Amazon S3 storage costs are lower than those for CloudWatch. For more information, see Exporting log data to Amazon S3. Best practices for Amazon EC2 You can use Amazon EC2 instances for both service-managed and customer-managed fleets. There are three considerations: Cost management best practices Version latest 88 AWS Deadline Cloud User Guide • For service-managed fleets, you can choose to have one or more instances available at all times by setting the minimum worker count for the fleet. When you set the minimum worker count above 0, the fleet always has this many workers running. This can reduce the amount of time that it takes for Deadline Cloud to start processing jobs, however you are charged for the instance's idle time. • For service-managed fleets, set a maximum size for the fleet. This limits the number of instances that a fleet can auto scale to. Fleets won't grow past this size even if there are more jobs waiting to be processed. • For both service-managed and customer-managed fleets, you can specify the Amazon EC2 instance types in your fleets. Using smaller instances costs less per minute, but may take longer to complete a job. Conversely, a larger instance costs more per minute, but can reduce the time to complete a job. Understanding the demands that your jobs place on an instance can help reduce your costs. • When possible, choose Amazon EC2 Spot instances for your fleet. Spot instances are available for a reduced price, but may be interrupted by on-demand requests. On-demand instances are charged by the second and are not interrupted. Best practices for AWS KMS By default, Deadline Cloud encrypts you data with an AWS owned key. You are not charged for this key. You may choose to use a customer managed key to encrypt your data. When you use your own key, you are charged based on how your key is used. If you use an existing key, this will be an incremental cost for the additional use. Best practices for AWS PrivateLink You can use AWS PrivateLink to create a connection between your VPC and Deadline Cloud using an interface endpoint. When you create a connection, you can call all of the Deadline Cloud API actions. You are charged per hour for each endpoint that you create. If you use PrivateLink, you must create at least three endpoints, and depending on your configuration, you may need as many as five. Cost management best practices Version latest 89 AWS Deadline Cloud User Guide Best practices for Amazon S3 Deadline Cloud uses Amazon S3 to store assets for processing, job attachments, output, and logs. To reduce the costs associated with Amazon S3, reduce the amount of data that you store. Some suggestions: • Only store assets that are currently in use or that will be used shortly. • Use an S3 Lifecycle configuration to automatically delete unused files from an S3 bucket. Best practices for Amazon VPC When you use usage-based licensing for your customer-managed fleet, you create a Deadline Cloud license endpoint, which is a Amazon VPC endpoint created in your account. This endpoint is charged at an hourly rate. To reduce costs, remove the endpoints when you are not using usage- based licenses. Cost management best practices Version latest 90 AWS Deadline Cloud User Guide Security in Deadline Cloud Cloud security at AWS is the highest priority. As an AWS customer, you benefit from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Deadline Cloud, see AWS services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other |
user-guide.pdf-033 | user-guide.pdf.pdf | 33 | cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Deadline Cloud, see AWS services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Deadline Cloud. The following topics show you how to configure Deadline Cloud to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Deadline Cloud resources. Topics • Data protection in Deadline Cloud • Identity and Access Management in Deadline Cloud • Compliance validation for Deadline Cloud • Resilience in Deadline Cloud • Infrastructure security in Deadline Cloud • Configuration and vulnerability analysis in Deadline Cloud • Cross-service confused deputy prevention • Access AWS Deadline Cloud using an interface endpoint (AWS PrivateLink) • Security best practices for Deadline Cloud Version latest 91 AWS Deadline Cloud User Guide Data protection in Deadline Cloud The AWS shared responsibility model applies to data protection in AWS Deadline Cloud. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with Deadline Cloud or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. The data entered into name fields in Deadline Cloud job templates may also be included in billing or diagnostic logs and should not contain confidential or sensitive information. Data protection Version latest 92 User Guide AWS Deadline Cloud Topics • Encryption at rest • Encryption in transit • Key management • Inter-network traffic privacy • Opt out Encryption at rest AWS Deadline Cloud protects sensitive data by encrypting it at rest using encryption keys stored in AWS Key Management Service (AWS KMS). Encryption at rest is available in all AWS Regions where Deadline Cloud is available. Encrypting data means sensitive data saved on disks isn't readable by a user or application without a valid key. Only a party with a valid managed key can decrypt the data. For information about how Deadline Cloud uses AWS KMS for encrypting data at rest, see Key management. Encryption in transit For data in transit, AWS Deadline Cloud uses Transport Layer Security (TLS) 1.2 or 1.3 to encrypt data sent between the |
user-guide.pdf-034 | user-guide.pdf.pdf | 34 | it at rest using encryption keys stored in AWS Key Management Service (AWS KMS). Encryption at rest is available in all AWS Regions where Deadline Cloud is available. Encrypting data means sensitive data saved on disks isn't readable by a user or application without a valid key. Only a party with a valid managed key can decrypt the data. For information about how Deadline Cloud uses AWS KMS for encrypting data at rest, see Key management. Encryption in transit For data in transit, AWS Deadline Cloud uses Transport Layer Security (TLS) 1.2 or 1.3 to encrypt data sent between the service and workers. We require TLS 1.2 and recommend TLS 1.3. Additionally, if you use a virtual private cloud (VPC), you can use AWS PrivateLink to establish a private connection between your VPC and Deadline Cloud. Key management When creating a new farm, you can choose one of the following keys to encrypt your farm data: • AWS owned KMS key – Default encryption type if you don't specify a key when you create the farm. The KMS key is owned by AWS Deadline Cloud. You can't view, manage, or use AWS owned keys. However, you don't need to take any action to protect the keys that encrypt your data. For more information, see AWS owned keys in the AWS Key Management Service developer guide. • Customer managed KMS key – You specify a customer managed key when you create a farm. All of the content within the farm is encrypted with the KMS key. The key is stored in your account Encryption at rest Version latest 93 AWS Deadline Cloud User Guide and is created, owned, and managed by you and AWS KMS charges apply. You have full control over the KMS key. You can perform such tasks as: • Establishing and maintaining key polices • Establishing and maintaining IAM policies and grants • Enabling and disabling key policies • Adding tags • Creating key aliases You can't manually rotate a customer owned key used with a Deadline Cloud farm. Automatic rotation of the key is supported. For more information, see Customer owned keys in the AWS Key Management Service Developer Guide. To create a customer managed key, follow the steps for Creating symmetric customer managed keys in the AWS Key Management Service Developer Guide. How Deadline Cloud use AWS KMS grants Deadline Cloud requires a grant to use your customer managed key. When you create a farm encrypted with a customer managed key, Deadline Cloud creates a grant on your behalf by sending a CreateGrant request to AWS KMS to get access to the KMS key that you specified. Deadline Cloud uses multiple grants. Each grant is used by a different part of Deadline Cloud that needs to encrypt or decrypt your data. Deadline Cloud also uses grants to allow access to other AWS services used to store data on your behalf, such as Amazon Simple Storage Service, Amazon Elastic Block Store, or OpenSearch. Grants that enable Deadline Cloud to manage machines in a service-managed fleet include a Deadline Cloud account number and role in the GranteePrincipal instead of a service principal. While not typical, this is necessary to encrypt Amazon EBS volumes for workers in service-managed fleets using the customer managed KMS key specified for the farm. Customer managed key policy Key policies control access to your customer managed key. Each key must have exactly one key policy that contains statements that determine who can use the key and how they can use it. When Key management Version latest 94 AWS Deadline Cloud User Guide you create you customer managed key, you can specify a key policy. For more information, see Managing access to customer managed keys in the AWS Key Management Service Developer Guide. Minimal IAM policy for CreateFarm To use your customer managed key to create farms using the console or the CreateFarm API operation, the following AWS KMS API operations must be permitted: • kms:CreateGrant – Adds a grant to a customer managed key. Grants console access to a specified AWS KMS key. For more informations, see Using grants in the AWS Key Management Service developer guide. • kms:Decrypt – Allows Deadline Cloud to decrypt data in the farm. • kms:DescribeKey – Provides the customer managed key details to allow Deadline Cloud to validate the key. • kms:GenerateDataKey – Allows Deadline Cloud to encrypt data using a unique data key. The following policy statement grants the necessary permissions for the CreateFarm operation. { "Version": "2012-10-17", "Statement": [ { "Sid": "DeadlineCreateGrants", "Effect": "Allow", "Action": [ "kms:Decrypt", "kms:GenerateDataKey", "kms:CreateGrant", "kms:DescribeKey" ], "Resource": "arn:aws::kms:us-west-2:111122223333:key/1234567890abcdef0", "Condition": { "StringEquals": { "kms:ViaService": "deadline.us-west-2.amazonaws.com" } } } ] } Key management Version latest 95 AWS Deadline Cloud User Guide Minimal IAM policy for read-only operations To use your customer managed key |
user-guide.pdf-035 | user-guide.pdf.pdf | 35 | decrypt data in the farm. • kms:DescribeKey – Provides the customer managed key details to allow Deadline Cloud to validate the key. • kms:GenerateDataKey – Allows Deadline Cloud to encrypt data using a unique data key. The following policy statement grants the necessary permissions for the CreateFarm operation. { "Version": "2012-10-17", "Statement": [ { "Sid": "DeadlineCreateGrants", "Effect": "Allow", "Action": [ "kms:Decrypt", "kms:GenerateDataKey", "kms:CreateGrant", "kms:DescribeKey" ], "Resource": "arn:aws::kms:us-west-2:111122223333:key/1234567890abcdef0", "Condition": { "StringEquals": { "kms:ViaService": "deadline.us-west-2.amazonaws.com" } } } ] } Key management Version latest 95 AWS Deadline Cloud User Guide Minimal IAM policy for read-only operations To use your customer managed key for read-only Deadline Cloud operations, such getting information about farms, queues, and fleets. The following AWS KMS API operations must be permitted: • kms:Decrypt – Allows Deadline Cloud to decrypt data in the farm. • kms:DescribeKey – Provides the customer managed key details to allow Deadline Cloud to validate the key. The following policy statement grants the necessary permissions for read-only operations. { "Version": "2012-10-17", "Statement": [ { "Sid": "DeadlineReadOnly", "Effect": "Allow", "Action": [ "kms:Decrypt", "kms:DescribeKey" ], "Resource": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab- cdef-EXAMPLE11111", "Condition": { "StringEquals": { "kms:ViaService": "deadline.us-west-2.amazonaws.com" } } } ] } Minimal IAM policy for read-write operations To use your customer managed key for read-write Deadline Cloud operations, such as creating and updating farms, queues, and fleets. The following AWS KMS API operations must be permitted: • kms:Decrypt – Allows Deadline Cloud to decrypt data in the farm. • kms:DescribeKey – Provides the customer managed key details to allow Deadline Cloud to validate the key. Key management Version latest 96 AWS Deadline Cloud User Guide • kms:GenerateDataKey – Allows Deadline Cloud to encrypt data using a unique data key. The following policy statement grants the necessary permissions for the CreateFarm operation. { "Version": "2012-10-17", "Statement": [ { "Sid": "DeadlineReadWrite", "Effect": "Allow", "Action": [ "kms:Decrypt", "kms:DescribeKey", "kms:GenerateDataKey", ], "Resource": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab- cdef-EXAMPLE11111", "Condition": { "StringEquals": { "kms:ViaService": "deadline.us-west-2.amazonaws.com" } } } ] } Monitoring your encryption keys When you use an AWS KMS customer managed key with your Deadline Cloud farms, you can use AWS CloudTrail or Amazon CloudWatch Logs to track requests that Deadline Cloud sends to AWS KMS. CloudTrail event for grants The following example CloudTrail event occurs when grants are created, typically when you call the CreateFarm, CreateMonitor, or CreateFleet operation. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAIGDTESTANDEXAMPLE:SampleUser01", Key management Version latest 97 AWS Deadline Cloud User Guide "arn": "arn:aws::sts::111122223333:assumed-role/Admin/SampleUser01", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE3", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE", "arn": "arn:aws::iam::111122223333:role/Admin", "accountId": "111122223333", "userName": "Admin" }, "webIdFederationData": {}, "attributes": { "creationDate": "2024-04-23T02:05:26Z", "mfaAuthenticated": "false" } }, "invokedBy": "deadline.amazonaws.com" }, "eventTime": "2024-04-23T02:05:35Z", "eventSource": "kms.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-west-2", "sourceIPAddress": "deadline.amazonaws.com", "userAgent": "deadline.amazonaws.com", "requestParameters": { "operations": [ "CreateGrant", "Decrypt", "DescribeKey", "Encrypt", "GenerateDataKey" ], "constraints": { "encryptionContextSubset": { "aws:deadline:farmId": "farm-abcdef12345678900987654321fedcba", "aws:deadline:accountId": "111122223333" } }, "granteePrincipal": "deadline.amazonaws.com", "keyId": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111", "retiringPrincipal": "deadline.amazonaws.com" }, Key management Version latest 98 AWS Deadline Cloud "responseElements": { User Guide "grantId": "6bbe819394822a400fe5e3a75d0e9ef16c1733143fff0c1fc00dc7ac282a18a0", "keyId": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111" }, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "readOnly": false, "resources": [ { "accountId": "AWS Internal", "type": "AWS::KMS::Key", "ARN": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE44444" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } CloudTrail event for decryption The following example CloudTrail event occurs when decrypting values using the customer managed KMS key. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAIGDTESTANDEXAMPLE:SampleUser01", "arn": "arn:aws::sts::111122223333:assumed-role/SampleRole/SampleUser01", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE", "arn": "arn:aws::iam::111122223333:role/SampleRole", "accountId": "111122223333", "userName": "SampleRole" }, Key management Version latest 99 AWS Deadline Cloud User Guide "webIdFederationData": {}, "attributes": { "creationDate": "2024-04-23T18:46:51Z", "mfaAuthenticated": "false" } }, "invokedBy": "deadline.amazonaws.com" }, "eventTime": "2024-04-23T18:51:44Z", "eventSource": "kms.amazonaws.com", "eventName": "Decrypt", "awsRegion": "us-west-2", "sourceIPAddress": "deadline.amazonaws.com", "userAgent": "deadline.amazonaws.com", "requestParameters": { "encryptionContext": { "aws:deadline:farmId": "farm-abcdef12345678900987654321fedcba", "aws:deadline:accountId": "111122223333", "aws-crypto-public-key": "AotL+SAMPLEVALUEiOMEXAMPLEaaqNOTREALaGTESTONLY +p/5H+EuKd4Q==" }, "encryptionAlgorithm": "SYMMETRIC_DEFAULT", "keyId": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111" }, "responseElements": null, "requestID": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeffffff", "eventID": "ffffffff-eeee-dddd-cccc-bbbbbbaaaaaa", "readOnly": true, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } Key management Version latest 100 AWS Deadline Cloud CloudTrail event for encryption User Guide The following example CloudTrail event occurs when encrypting values using the customer managed KMS key. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAIGDTESTANDEXAMPLE:SampleUser01", "arn": "arn:aws::sts::111122223333:assumed-role/SampleRole/SampleUser01", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE", "arn": "arn:aws::iam::111122223333:role/SampleRole", "accountId": "111122223333", "userName": "SampleRole" }, "webIdFederationData": {}, "attributes": { "creationDate": "2024-04-23T18:46:51Z", "mfaAuthenticated": "false" } }, "invokedBy": "deadline.amazonaws.com" }, "eventTime": "2024-04-23T18:52:40Z", "eventSource": "kms.amazonaws.com", "eventName": "GenerateDataKey", "awsRegion": "us-west-2", "sourceIPAddress": "deadline.amazonaws.com", "userAgent": "deadline.amazonaws.com", "requestParameters": { "numberOfBytes": 32, "encryptionContext": { "aws:deadline:farmId": "farm-abcdef12345678900987654321fedcba", "aws:deadline:accountId": "111122223333", "aws-crypto-public-key": "AotL+SAMPLEVALUEiOMEXAMPLEaaqNOTREALaGTESTONLY +p/5H+EuKd4Q==" }, Key management Version latest 101 AWS Deadline Cloud User Guide "keyId": "arn:aws::kms:us- west-2:111122223333:key/abcdef12-3456-7890-0987-654321fedcba" }, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "readOnly": true, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE33333" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } Deleting a customer managed KMS key Deleting |
user-guide.pdf-036 | user-guide.pdf.pdf | 36 | "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE", "arn": "arn:aws::iam::111122223333:role/SampleRole", "accountId": "111122223333", "userName": "SampleRole" }, "webIdFederationData": {}, "attributes": { "creationDate": "2024-04-23T18:46:51Z", "mfaAuthenticated": "false" } }, "invokedBy": "deadline.amazonaws.com" }, "eventTime": "2024-04-23T18:52:40Z", "eventSource": "kms.amazonaws.com", "eventName": "GenerateDataKey", "awsRegion": "us-west-2", "sourceIPAddress": "deadline.amazonaws.com", "userAgent": "deadline.amazonaws.com", "requestParameters": { "numberOfBytes": 32, "encryptionContext": { "aws:deadline:farmId": "farm-abcdef12345678900987654321fedcba", "aws:deadline:accountId": "111122223333", "aws-crypto-public-key": "AotL+SAMPLEVALUEiOMEXAMPLEaaqNOTREALaGTESTONLY +p/5H+EuKd4Q==" }, Key management Version latest 101 AWS Deadline Cloud User Guide "keyId": "arn:aws::kms:us- west-2:111122223333:key/abcdef12-3456-7890-0987-654321fedcba" }, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "readOnly": true, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws::kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef- EXAMPLE33333" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } Deleting a customer managed KMS key Deleting a customer managed KMS key in AWS Key Management Service (AWS KMS) is destructive and potentially dangerous. It irreversibly deletes the key material and all metadata associated with the key. After a customer managed KMS key is deleted, you can no longer decrypt the data that was encrypted by that key. This means that the data becomes unrecoverable. This is why AWS KMS gives customers a waiting period of up to 30 days before deleting the KMS key. The default waiting period is 30 days. About the waiting period Because it's destructive and potentially dangerous to delete a customer managed KMS key, we require that you set a waiting period of 7–30 days. The default waiting period is 30 days. However, the actual waiting period might be up to 24 hours longer than the period you scheduled. To get the actual date and time when the key will be deleted, use the DescribeKey operation. You can also see the scheduled deletion date of a key in the AWS KMS console on the key’s detail page, in the General configuration section. Notice the time zone. During the waiting period, the customer managed key’s status and key state is Pending deletion. Key management Version latest 102 AWS Deadline Cloud User Guide • A customer managed KMS key that is pending deletion can’t be used in any cryptographic operations. • AWS KMS doesn’t rotate the backing keys of customer managed KMS keys that are pending deletion. For more information about deleting a customer managed KMS key, see Deleting customer master keys in the AWS Key Management Service Developer Guide. Inter-network traffic privacy AWS Deadline Cloud supports Amazon Virtual Private Cloud (Amazon VPC) to secure connections. Amazon VPC provides features that you can use to increase and monitor the security for your virtual private cloud (VPC). You can set up a customer-managed fleet (CMF) with Amazon Elastic Compute Cloud (Amazon EC2) instances that run inside a VPC. By deploying Amazon VPC endpoints to use AWS PrivateLink, traffic between workers in your CMF and the Deadline Cloud endpoint stays within your VPC. Furthermore, you can configure your VPC to restrict internet access to your instances. In service-managed fleets, workers aren't reachable from the internet, but they do have internet access and connect to the Deadline Cloud service over the internet. Opt out AWS Deadline Cloud collects certain operational information to help us develop and improve Deadline Cloud. The collected data includes things such as your AWS account ID and user ID, so that we can correctly identify you if you have an issue with the Deadline Cloud. We also collect Deadline Cloud specific information, such as Resource IDs (a FarmID or QueueID when applicable), the product name (for example, JobAttachments, WorkerAgent, and more) and the product version. You can choose to opt out from this data collection using application configuration. Each computer interacting with Deadline Cloud, both client workstations and fleet workers, needs to opt out separately. Deadline Cloud monitor - desktop Deadline Cloud monitor - desktop collects operational information, such as when crashes occur and when the application is opened, to help us know when you are having problems with the Inter-network traffic privacy Version latest 103 AWS Deadline Cloud User Guide application. To opt out from the collection of this operational information, go to the settings page and clear Turn on data collection to measure Deadline Cloud Monitor's performance. After you opt out, the desktop monitor no longer sends the operational data. Any previously collected data is retained and may still be used to improve the service. For more information, see Data Privacy FAQ. AWS Deadline Cloud CLI and Tools The AWS Deadline Cloud CLI, submitters, and worker agent all collect operational information such as when crashes occur and when jobs are submitted to help us know when you are having problems with these applications. To opt out from the collection of this operational information, use any of the following methods: • In the terminal, enter deadline config set telemetry.opt_out true. This will opt out the CLI, submitters, and worker agent when running as the current user. • When installing the Deadline Cloud worker agent, add the --telemetry-opt-out command line argument. For example, |
user-guide.pdf-037 | user-guide.pdf.pdf | 37 | FAQ. AWS Deadline Cloud CLI and Tools The AWS Deadline Cloud CLI, submitters, and worker agent all collect operational information such as when crashes occur and when jobs are submitted to help us know when you are having problems with these applications. To opt out from the collection of this operational information, use any of the following methods: • In the terminal, enter deadline config set telemetry.opt_out true. This will opt out the CLI, submitters, and worker agent when running as the current user. • When installing the Deadline Cloud worker agent, add the --telemetry-opt-out command line argument. For example, ./install.sh --farm-id $FARM_ID --fleet-id $FLEET_ID --telemetry-opt-out. • Before running the worker agent, CLI, or submitter, set an environment variable: DEADLINE_CLOUD_TELEMETRY_OPT_OUT=true After you opt out, the Deadline Cloud tools no longer send the operational data. Any previously collected data is retained and may still be used to improve the service. For more information, see Data Privacy FAQ. Identity and Access Management in Deadline Cloud AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Deadline Cloud resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience Identity and Access Management Version latest 104 AWS Deadline Cloud User Guide • Authenticating with identities • Managing access using policies • How Deadline Cloud works with IAM • Identity-based policy examples for Deadline Cloud • AWS managed policies for Deadline Cloud • Troubleshooting AWS Deadline Cloud identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in Deadline Cloud. Service user – If you use the Deadline Cloud service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Deadline Cloud features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Deadline Cloud, see Troubleshooting AWS Deadline Cloud identity and access. Service administrator – If you're in charge of Deadline Cloud resources at your company, you probably have full access to Deadline Cloud. It's your job to determine which Deadline Cloud features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Deadline Cloud, see How Deadline Cloud works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Deadline Cloud. To view example Deadline Cloud identity- based policies that you can use in IAM, see Identity-based policy examples for Deadline Cloud. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on Audience Version latest 105 AWS Deadline Cloud User Guide authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one |
user-guide.pdf-038 | user-guide.pdf.pdf | 38 | requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. Authenticating with identities Version latest 106 AWS Deadline Cloud User Guide For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider Authenticating with identities Version latest 107 AWS Deadline Cloud User Guide (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. |
user-guide.pdf-039 | user-guide.pdf.pdf | 39 | authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider Authenticating with identities Version latest 107 AWS Deadline Cloud User Guide (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile Authenticating with identities Version latest 108 AWS Deadline Cloud User Guide that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use |
user-guide.pdf-040 | user-guide.pdf.pdf | 40 | contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Managing access using policies Version latest 109 AWS Deadline Cloud Resource-based policies User Guide Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to Managing access using policies Version latest 110 AWS Deadline Cloud User Guide any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support |
user-guide.pdf-041 | user-guide.pdf.pdf | 41 | For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Deadline Cloud works with IAM Before you use IAM to manage access to Deadline Cloud, learn what IAM features are available to use with Deadline Cloud. IAM features you can use with AWS Deadline Cloud IAM feature Deadline Cloud support Identity-based policies Resource-based policies Policy actions Yes No Yes How Deadline Cloud works with IAM Version latest 111 AWS Deadline Cloud IAM feature Policy resources Policy condition keys (service-specific) ACLs ABAC (tags in policies) Temporary credentials Forward access sessions (FAS) Service roles Service-linked roles Deadline Cloud support User Guide Yes Yes No Yes Yes Yes Yes No To get a high-level view of how Deadline Cloud and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for Deadline Cloud Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for Deadline Cloud To view examples of Deadline Cloud identity-based policies, see Identity-based policy examples for Deadline Cloud. How Deadline Cloud works with IAM Version latest 112 AWS Deadline Cloud User Guide Resource-based policies within Deadline Cloud Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for Deadline Cloud Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy |
user-guide.pdf-042 | user-guide.pdf.pdf | 42 | the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for Deadline Cloud Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of Deadline Cloud actions, see Actions defined by AWS Deadline Cloud in the Service Authorization Reference. Policy actions in Deadline Cloud use the following prefix before the action: How Deadline Cloud works with IAM Version latest 113 AWS Deadline Cloud awsdeadlinecloud User Guide To specify multiple actions in a single statement, separate them with commas. "Action": [ "awsdeadlinecloud:action1", "awsdeadlinecloud:action2" ] To view examples of Deadline Cloud identity-based policies, see Identity-based policy examples for Deadline Cloud. Policy resources for Deadline Cloud Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of Deadline Cloud resource types and their ARNs, see Resources defined by AWS Deadline Cloud in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by AWS Deadline Cloud. To view examples of Deadline Cloud identity-based policies, see Identity-based policy examples for Deadline Cloud. How Deadline Cloud works with IAM Version latest 114 AWS Deadline Cloud User Guide Policy condition keys for Deadline Cloud Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of Deadline Cloud condition keys, see Condition keys for AWS Deadline Cloud in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by AWS Deadline Cloud. To view examples of Deadline Cloud identity-based policies, see Identity-based policy examples for Deadline Cloud. ACLs in Deadline Cloud Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with Deadline Cloud Supports ABAC (tags in policies): Yes How Deadline Cloud works with IAM Version latest 115 AWS Deadline Cloud User Guide Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, |
user-guide.pdf-043 | user-guide.pdf.pdf | 43 | by AWS Deadline Cloud. To view examples of Deadline Cloud identity-based policies, see Identity-based policy examples for Deadline Cloud. ACLs in Deadline Cloud Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with Deadline Cloud Supports ABAC (tags in policies): Yes How Deadline Cloud works with IAM Version latest 115 AWS Deadline Cloud User Guide Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with Deadline Cloud Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. How Deadline Cloud works with IAM Version latest 116 AWS Deadline Cloud User Guide Forward access sessions for Deadline Cloud Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for Deadline Cloud Supports service roles: Yes A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break Deadline Cloud functionality. Edit service roles only when Deadline Cloud provides guidance to do so. Service-linked roles for Deadline Cloud Supports service-linked roles: No A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. How Deadline Cloud works with IAM Version latest 117 AWS Deadline Cloud User Guide Identity-based policy examples for Deadline Cloud By default, users and roles don't have permission to create or modify Deadline |
user-guide.pdf-044 | user-guide.pdf.pdf | 44 | appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. How Deadline Cloud works with IAM Version latest 117 AWS Deadline Cloud User Guide Identity-based policy examples for Deadline Cloud By default, users and roles don't have permission to create or modify Deadline Cloud resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by Deadline Cloud, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for AWS Deadline Cloud in the Service Authorization Reference. Topics • Policy best practices • Using the Deadline Cloud console • Policy to submit jobs to a queue • Policy to allow creating a license endpoint • Policy to allow monitoring a specific farm queue Policy best practices Identity-based policies determine whether someone can create, access, or delete Deadline Cloud resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on Identity-based policy examples Version latest 118 AWS Deadline Cloud User Guide specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Deadline Cloud console To access the AWS Deadline Cloud console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Deadline Cloud resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and |
user-guide.pdf-045 | user-guide.pdf.pdf | 45 | must have a minimum set of permissions. These permissions must allow you to list and view details about the Deadline Cloud resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can still use the Deadline Cloud console, also attach the Deadline Cloud ConsoleAccess or ReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Identity-based policy examples Version latest 119 AWS Deadline Cloud User Guide Policy to submit jobs to a queue In this example, you create a scoped-down policy that grants permission to submit jobs to a specific queue in a specific farm. { "Version": "2012-10-17", "Statement": [ { "Sid": "SubmitJobsFarmAndQueue", "Effect": "Allow", "Action": "deadline:CreateJob", "Resource": "arn:aws:deadline:REGION:ACCOUNT_ID:farm/FARM_A/queue/QUEUE_B/ job/*" } ] } Policy to allow creating a license endpoint In this example, you create a scoped-down policy that grants the required permissions to create and manage license endpoints. Use this policy to create the license endpoint for the VPC associated with your farm. { "Version": "2012-10-17", "Statement": [{ "SID": "CreateLicenseEndpoint", "Effect": "Allow", "Action": [ "deadline:CreateLicenseEndpoint", "deadline:DeleteLicenseEndpoint", "deadline:GetLicenseEndpoint", "deadline:ListLicenseEndpoints", "deadline:PutMeteredProduct", "deadline:DeleteMeteredProduct", "deadline:ListMeteredProducts", "deadline:ListAvailableMeteredProducts", "ec2:CreateVpcEndpoint", "ec2:DescribeVpcEndpoints", "ec2:DeleteVpcEndpoints" ], Identity-based policy examples Version latest 120 AWS Deadline Cloud "Resource": "*" }] } User Guide Policy to allow monitoring a specific farm queue In this example, you create a scoped-down policy that grants permission to monitor jobs in a specific queue for a specific farm. { "Version": "2012-10-17", "Statement": [{ "Sid": "MonitorJobsFarmAndQueue", "Effect": "Allow", "Action": [ "deadline:SearchJobs", "deadline:ListJobs", "deadline:GetJob", "deadline:SearchSteps", "deadline:ListSteps", "deadline:ListStepConsumers", "deadline:ListStepDependencies", "deadline:GetStep", "deadline:SearchTasks", "deadline:ListTasks", "deadline:GetTask", "deadline:ListSessions", "deadline:GetSession", "deadline:ListSessionActions", "deadline:GetSessionAction" ], "Resource": [ "arn:aws:deadline:REGION:123456789012:farm/FARM_A/queue/QUEUE_B", "arn:aws:deadline:REGION:123456789012:farm/FARM_A/queue/QUEUE_B/*" ] }] } AWS managed policies for Deadline Cloud AWS managed policies Version latest 121 AWS Deadline Cloud User Guide An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your specific use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by defining customer managed policies that are specific to your use cases. You cannot change the permissions defined in AWS managed policies. If AWS updates the permissions defined in an AWS managed policy, the update affects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AWS managed policy: AWSDeadlineCloud-FleetWorker You can attach the AWSDeadlineCloud-FleetWorker policy to your AWS Identity and Access Management (IAM) identities. This policy grants workers in this fleet the permissions that are needed to connect to and receive tasks from the service. Permissions details This policy includes the following permissions: • deadline – Allows principals to manage workers in a fleet. For a JSON listing of the policy details, see AWSDeadlineCloud-FleetWorker in the AWS Managed Policy reference guide. AWS managed policy: AWSDeadlineCloud-WorkerHost You can attach the AWSDeadlineCloud-WorkerHost policy to your IAM identities. AWS managed policies Version latest 122 AWS Deadline Cloud User Guide This policy grants the permissions that are needed to initially connect to the service. It can be used as an Amazon Elastic Compute Cloud (Amazon EC2) instance profile. Permissions details This policy includes the following permissions: • deadline – Allows the user to create workers, assume the fleet role for workers, and apply tags to workers For a JSON listing of the policy details, see AWSDeadlineCloud-WorkerHost in the AWS Managed Policy reference guide. AWS managed policy: AWSDeadlineCloud-UserAccessFarms You can attach the AWSDeadlineCloud-UserAccessFarms policy to your IAM identities. This policy allows users to access farm data based on the farms that they are members of and their membership level. Permissions details This policy includes the following permissions: • deadline – Allows the user to access farm data. • ec2 – Allows users to see details about Amazon EC2 instance types. • identitystore – Allows users to see user and group names. For a JSON listing of the policy details, see AWSDeadlineCloud-UserAccessFarms in the AWS Managed Policy reference guide. AWS managed policy: AWSDeadlineCloud-UserAccessFleets You can attach the AWSDeadlineCloud-UserAccessFleets policy to your IAM identities. This policy allows users |
user-guide.pdf-046 | user-guide.pdf.pdf | 46 | IAM identities. This policy allows users to access farm data based on the farms that they are members of and their membership level. Permissions details This policy includes the following permissions: • deadline – Allows the user to access farm data. • ec2 – Allows users to see details about Amazon EC2 instance types. • identitystore – Allows users to see user and group names. For a JSON listing of the policy details, see AWSDeadlineCloud-UserAccessFarms in the AWS Managed Policy reference guide. AWS managed policy: AWSDeadlineCloud-UserAccessFleets You can attach the AWSDeadlineCloud-UserAccessFleets policy to your IAM identities. This policy allows users to access fleet data based on the farms that they are members of and their membership level. Permissions details AWS managed policies Version latest 123 AWS Deadline Cloud User Guide This policy includes the following permissions: • deadline – Allows the user to access farm data. • ec2 – Allows users to see details about Amazon EC2 instance types. • identitystore – Allows users to see user and group names. For a JSON listing of the policy details, see AWSDeadlineCloud-UserAccessFleets in the AWS Managed Policy reference guide. AWS managed policy: AWSDeadlineCloud-UserAccessJobs You can attach the AWSDeadlineCloud-UserAccessJobs policy to your IAM identities. This policy allows users to access job data based on the farms that they are members of and their membership level. Permissions details This policy includes the following permissions: • deadline – Allows the user to access farm data. • ec2 – Allows users to see details about Amazon EC2 instance types. • identitystore – Allows users to see user and group names. For a JSON listing of the policy details, see AWSDeadlineCloud-UserAccessJobs in the AWS Managed Policy reference guide. AWS managed policy: AWSDeadlineCloud-UserAccessQueues You can attach the AWSDeadlineCloud-UserAccessQueues policy to your IAM identities. This policy allows users to access queue data based on the farms that they are members of and their membership level. Permissions details This policy includes the following permissions: • deadline – Allows the user to access farm data. AWS managed policies Version latest 124 AWS Deadline Cloud User Guide • ec2 – Allows users to see details about Amazon EC2 instance types. • identitystore – Allows users to see user and group names. For a JSON listing of the policy details, see AWSDeadlineCloud-UserAccessQueues in the AWS Managed Policy reference guide. Deadline Cloud updates to AWS managed policies View details about updates to AWS managed policies for Deadline Cloud since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Deadline Cloud Document history page. Change Description Date AWSDeadlineCloud-W orkerHost – Change Deadline Cloud added May 30, 2025 new actions deadline: TagResource and deadline:ListTagsF to allow orResource you to add and view tags associated with workers in your fleet. AWSDeadlineCloud-U serAccessFarms – Change AWSDeadlineCloud-U serAccessJobs – Change AWSDeadlineCloud-U serAccessQueues – Change Deadline Cloud added October 7, 2024 new actions deadline: GetJobTemplate and deadline:ListJobPa rameterDefinitions to allow you to resubmit jobs. Deadline Cloud started tracking changes Deadline Cloud started tracking changes to its AWS April 2, 2024 managed policies. AWS managed policies Version latest 125 AWS Deadline Cloud User Guide Troubleshooting AWS Deadline Cloud identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with Deadline Cloud and IAM. Topics • I am not authorized to perform an action in Deadline Cloud • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my Deadline Cloud resources I am not authorized to perform an action in Deadline Cloud If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but doesn't have the fictional awsdeadlinecloud:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: awsdeadlinecloud:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the awsdeadlinecloud:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Deadline Cloud. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries |
user-guide.pdf-047 | user-guide.pdf.pdf | 47 | your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Deadline Cloud. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in Deadline Cloud. However, the action requires the service to have Troubleshooting Version latest 126 AWS Deadline Cloud User Guide permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my Deadline Cloud resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether Deadline Cloud supports these features, see How Deadline Cloud works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance validation for Deadline Cloud To learn whether an AWS service is within the scope of specific compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. Compliance validation Version latest 127 AWS Deadline Cloud User Guide You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in Deadline Cloud The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and |
user-guide.pdf-048 | user-guide.pdf.pdf | 48 | reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in Deadline Cloud The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with Resilience Version latest 128 AWS Deadline Cloud User Guide low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. AWS Deadline Cloud does not back up data stored in your job attachments S3 bucket. You can enable backups of your job attachments data using any standard Amazon S3 backup mechanism, such as S3 Versioning or AWS Backup. Infrastructure security in Deadline Cloud As a managed service, AWS Deadline Cloud is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access Deadline Cloud through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Deadline Cloud doesn't support using AWS PrivateLink virtual private cloud (VPC) endpoint policies. It uses the AWS PrivateLink default policy, which grants full access to the endpoint. For more information, see Default endpoint policy in the AWS PrivateLink user guide. Infrastructure security Version latest 129 AWS Deadline Cloud User Guide Configuration and vulnerability analysis in Deadline Cloud AWS handles basic security tasks like guest operating system (OS) and database patching, firewall configuration, and disaster recovery. These procedures have been reviewed and certified by the appropriate third parties. For more details, see the following resources: • Shared Responsibility Model • Amazon Web Services: Overview of Security Processes (whitepaper) AWS Deadline Cloud manages tasks on service-managed or customer-managed fleets: • For service-managed fleets, Deadline Cloud manages the guest operating system. • For customer-managed fleets, you are responsible for managing the operating system. For additional information about configuration and vulnerability analysis for AWS Deadline Cloud, see • Security best practices for Deadline Cloud Cross-service confused deputy prevention The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action. In AWS, cross-service impersonation can result in the confused deputy problem. Cross-service impersonation can occur when one service (the calling service) calls another service (the called service). The calling service can be manipulated to use its permissions to act on another customer's resources in a way it should not otherwise have permission to access. To prevent this, AWS provides tools that help you protect your data for all services with service principals that have been given access to resources in your account. We recommend using the aws:SourceArn and aws:SourceAccount global condition context keys in resource policies to limit the permissions that AWS Deadline Cloud gives another service to the resource. Use aws:SourceArn if you want only one resource to be associated with the cross- service access. Use aws:SourceAccount if you want to allow any resource in that account to be associated with the cross-service use. Configuration and vulnerability analysis Version latest 130 AWS Deadline Cloud User Guide The most effective way to protect against the confused deputy problem is to use the aws:SourceArn global condition context key with the full Amazon Resource Name (ARN) of the resource. If you don't know the full ARN of the resource or if you are specifying multiple resources, use the aws:SourceArn global context condition key with wildcard characters (*) for the unknown portions of the ARN. For example, arn:aws:awsdeadlinecloud:*:123456789012:*. If the aws:SourceArn value does not contain the account ID, such as an Amazon |
user-guide.pdf-049 | user-guide.pdf.pdf | 49 | be associated with the cross-service use. Configuration and vulnerability analysis Version latest 130 AWS Deadline Cloud User Guide The most effective way to protect against the confused deputy problem is to use the aws:SourceArn global condition context key with the full Amazon Resource Name (ARN) of the resource. If you don't know the full ARN of the resource or if you are specifying multiple resources, use the aws:SourceArn global context condition key with wildcard characters (*) for the unknown portions of the ARN. For example, arn:aws:awsdeadlinecloud:*:123456789012:*. If the aws:SourceArn value does not contain the account ID, such as an Amazon S3 bucket ARN, you must use both global condition context keys to limit permissions. The following example shows how you can use the aws:SourceArn and aws:SourceAccount global condition context keys in Deadline Cloud to prevent the confused deputy problem. { "Version": "2012-10-17", "Statement": { "Sid": "ConfusedDeputyPreventionExamplePolicy", "Effect": "Allow", "Principal": { "Service": "awsdeadlinecloud.amazonaws.com" }, "Action": "awsdeadlinecloud:ActionName", "Resource": [ "*" ], "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:awsdeadlinecloud:*:123456789012:*" }, "StringEquals": { "aws:SourceAccount": "123456789012" } } } } Access AWS Deadline Cloud using an interface endpoint (AWS PrivateLink) You can use AWS PrivateLink to create a private connection between your VPC and AWS Deadline Cloud. You can access Deadline Cloud as if it were in your VPC, without the use of an internet AWS PrivateLink Version latest 131 AWS Deadline Cloud User Guide gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to access Deadline Cloud. You establish this private connection by creating an interface endpoint, powered by AWS PrivateLink. We create an endpoint network interface in each subnet that you enable for the interface endpoint. These are requester-managed network interfaces that serve as the entry point for traffic destined for Deadline Cloud. Deadline Cloud also has dual-stack endpoints available. Dual-stack endpoints support requests over IPv6 and IPv4. For more information, see Access AWS services through AWS PrivateLink in the AWS PrivateLink Guide. Considerations for Deadline Cloud Before you set up an interface endpoint for Deadline Cloud, see Access an AWS service using an interface VPC endpoint in the AWS PrivateLink Guide. Deadline Cloud supports making calls to all of its API actions through the interface endpoint. By default, full access to Deadline Cloud is allowed through the interface endpoint. Alternatively, you can associate a security group with the endpoint network interfaces to control traffic to Deadline Cloud through the interface endpoint. Deadline Cloud also supports VPC endpoint policies. For more information, see Control access to VPC endpoints using endpoint policies in the AWS PrivateLink Guide. Deadline Cloud endpoints Deadline Cloud uses four endpoints for access to the service using AWS PrivateLink - two for IPv4 and two for IPv6. Workers use the scheduling.deadline.region.amazonaws.com endpoint to get tasks from the queue, report progress to Deadline Cloud, and to send task output back. If you are using a customer-managed fleet, the scheduling endpoint is the only endpoint that you need to create unless you are using management operations. For example, if a job creates more jobs, you need to enable the management endpoint to call the CreateJob operation. Considerations Version latest 132 AWS Deadline Cloud User Guide The Deadline Cloud monitor uses the management.deadline.region.amazonaws.com to manage the resources in your farm, such as creating and modifying queues and fleets or getting lists of jobs, steps, and tasks. Deadline Cloud also requires endpoints for the following AWS service endpoints: • Deadline Cloud uses AWS STS to authenticate workers so that they can access job assets. For more information about AWS STS, see Temporary security credentials in IAM in the AWS Identity and Access Management User Guide. • If you set up your customer-managed fleet in a subnet with no internet connection you must create a VPC endpoint for Amazon CloudWatch Logs so that workers can write logs. For more information, see Monitoring with CloudWatch. • If you use job attachments, you must create a VPC endpoint for Amazon Simple Storage Service (Amazon S3) so that workers can access the attachments. For more information, see Job attachments in Deadline Cloud. Create endpoints for Deadline Cloud You can create interface endpoints for Deadline Cloud using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Create an interface endpoint in the AWS PrivateLink Guide. Create management and scheduling endpoints for Deadline Cloud using the following service names. Replace region with the AWS Region where you've deployed Deadline Cloud. com.amazonaws.region.deadline.management com.amazonaws.region.deadline.scheduling Deadline Cloud supports dual-stack endpoints. If you enable private DNS for the interface endpoints, you can make API requests to Deadline Cloud using its default Regional DNS name. For example, scheduling.deadline.us- east-1.amazonaws.com for worker operations, or management.deadline.us- east-1.amazonaws.com for all other operations. You must also create an endpoint for AWS STS |
user-guide.pdf-050 | user-guide.pdf.pdf | 50 | VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Create an interface endpoint in the AWS PrivateLink Guide. Create management and scheduling endpoints for Deadline Cloud using the following service names. Replace region with the AWS Region where you've deployed Deadline Cloud. com.amazonaws.region.deadline.management com.amazonaws.region.deadline.scheduling Deadline Cloud supports dual-stack endpoints. If you enable private DNS for the interface endpoints, you can make API requests to Deadline Cloud using its default Regional DNS name. For example, scheduling.deadline.us- east-1.amazonaws.com for worker operations, or management.deadline.us- east-1.amazonaws.com for all other operations. You must also create an endpoint for AWS STS using the following service name: Create endpoints Version latest 133 AWS Deadline Cloud User Guide com.amazonaws.region.sts If your customer-managed fleet is on a subnet without an internet connection, you must create a CloudWatch Logs endpoint using the following service name: com.amazonaws.region.logs If you use job attachments to transfer files, you must create an Amazon S3 endpoint using the following service name: com.amazonaws.region.s3 Security best practices for Deadline Cloud AWS Deadline Cloud (Deadline Cloud) provides a number of security features to consider as you develop and implement your own security policies. The following best practices are general guidelines and don’t represent a complete security solution. Because these best practices might not be appropriate or sufficient for your environment, treat them as helpful considerations rather than prescriptions. Note For more information about the importance of many security topics, see the Shared Responsibility Model. Data protection For data protection purposes, we recommend that you protect AWS account credentials and set up individual accounts with AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. Security best practices Version latest 134 AWS Deadline Cloud User Guide • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing personal data that is stored in Amazon Simple Storage Service (Amazon S3). • If you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-2. We strongly recommend that you never put sensitive identifying information, such as your customers' account numbers, into free-form fields such as a Name field. This includes when you work with AWS Deadline Cloud or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into Deadline Cloud or other services might get picked up for inclusion in diagnostic logs. When you provide a URL to an external server, don’t include credentials information in the URL to validate your request to that server. AWS Identity and Access Management permissions Manage access to AWS resources using users, AWS Identity and Access Management (IAM) roles, and by granting the least privilege to users. Establish credential management policies and procedures for creating, distributing, rotating, and revoking AWS access credentials. For more information, see IAM Best Practices in the IAM User Guide. Run jobs as users and groups When using queue functionality in Deadline Cloud, it’s a best practice to specify an operating system (OS) user and its primary group so that the OS user has least-privilege permissions for the queue’s jobs. When you specify a “Run as user” (and group), any processes for jobs submitted to the queue will be run using that OS user and will inherit that user’s associated OS permissions. The fleet and queue configurations combine to establish a security posture. On the queue side, the “Job run as user” and IAM role can be specified to use the OS and AWS permissions for the queue’s jobs. The fleet defines the infrastructure (worker hosts, networks, mounted shared storage) that, when associated to a particular queue, run jobs within the queue. The data available on the worker hosts needs to be accessed by jobs from one or more associated queues. Specifying a user or group helps protect the data in jobs from other queues, other installed software, or other users with access to the worker hosts. When a queue is without a user, it runs as the agent user which can IAM permissions Version latest 135 AWS Deadline Cloud User Guide impersonate (sudo) any queue user. In this way, a queue without a user can escalate privileges to another queue. Networking To prevent traffic from being intercepted or redirected, it's essential to secure how |
user-guide.pdf-051 | user-guide.pdf.pdf | 51 | on the worker hosts needs to be accessed by jobs from one or more associated queues. Specifying a user or group helps protect the data in jobs from other queues, other installed software, or other users with access to the worker hosts. When a queue is without a user, it runs as the agent user which can IAM permissions Version latest 135 AWS Deadline Cloud User Guide impersonate (sudo) any queue user. In this way, a queue without a user can escalate privileges to another queue. Networking To prevent traffic from being intercepted or redirected, it's essential to secure how and where your network traffic is routed. We recommend that you secure your networking environment in the following ways: • Secure Amazon Virtual Private Cloud (Amazon VPC) subnet route tables to control how IP layer traffic is routed. • If you are using Amazon Route 53 (Route 53) as a DNS provider in your farm or workstation setup, secure access to the Route 53 API. • If you connect to Deadline Cloud outside of AWS such as by using on-premises workstations or other data centers, secure any on-premises networking infrastructure. This includes DNS servers and route tables on routers, switches, and other networking devices. Jobs and job data Deadline Cloud jobs run within sessions on worker hosts. Each session runs one or more processes on the worker host, which generally require that you input data to produce output. To secure this data, you can configure operating system users with queues. The worker agent uses the queue OS user to run session sub-processes. These sub-processes inherit the queue OS user's permissions. We recommend that you follow best practices to secure access to the data these sub-processes access. For more information, see Shared responsibility model. Farm structure You can arrange Deadline Cloud fleets and queues many ways. However, there are security implications with certain arrangements. A farm has one of the most secure boundaries because it can't share Deadline Cloud resources with other farms, including fleets, queues, and storage profiles. However, you can share external AWS resources within a farm, which compromises the security boundary. Networking Version latest 136 AWS Deadline Cloud User Guide You can also establish security boundaries between queues within the same farm using the appropriate configuration. Follow these best practices to create secure queues in the same farm: • Associate a fleet only with queues within the same security boundary. Note the following: • After job runs on the worker host, data may remain behind, such as in a temporary directory or the queue user's home directory. • The same OS user runs all the jobs on a service-owned fleet worker host, regardless of which queue you submit the job to. • A job might leave processes running on a worker host, making it possible for jobs from other queues to observe other running processes. • Ensure that only queues within the same security boundary share an Amazon S3 bucket for job attachments. • Ensure that only queues within the same security boundary share an OS user. • Secure any other AWS resources that are integrated into the farm to the boundary. Job attachment queues Job attachments are associated with a queue, which uses your Amazon S3 bucket. • Job attachments write to and read from a root prefix in the Amazon S3 bucket. You specify this root prefix in the CreateQueue API call. • The bucket has a corresponding Queue Role, which specifies the role that grants queue users access to the bucket and root prefix. When creating a queue, you specify the Queue Role Amazon Resource Name (ARN) alongside the job attachments bucket and root prefix. • Authorized calls to the AssumeQueueRoleForRead, AssumeQueueRoleForUser, and AssumeQueueRoleForWorker API operations return a set of temporary security credentials for the Queue Role. If you create a queue and reuse an Amazon S3 bucket and root prefix, there is a risk of information being disclosed to unauthorized parties. For example, QueueA and QueueB share the same bucket and root prefix. In a secure workflow, ArtistA has access to QueueA but not QueueB. However, when multiple queues share a bucket, ArtistA can access the data in QueueB data because it uses the same bucket and root prefix as QueueA. Job attachment queues Version latest 137 AWS Deadline Cloud User Guide The console sets up queues that are secure by default. Ensure that the queues have a distinct combination of Amazon S3 bucket and root prefix unless they're part of a common security boundary. To isolate your queues, you must configure the Queue Role to only allow queue access to the bucket and root prefix. In the following example, replace each placeholder with your resource- specific information. { "Version": "2012-10-17", "Statement": [ { "Action": [ "s3:GetObject", "s3:PutObject", "s3:ListBucket", "s3:GetBucketLocation" ], "Effect": "Allow", "Resource": |
user-guide.pdf-052 | user-guide.pdf.pdf | 52 | same bucket and root prefix as QueueA. Job attachment queues Version latest 137 AWS Deadline Cloud User Guide The console sets up queues that are secure by default. Ensure that the queues have a distinct combination of Amazon S3 bucket and root prefix unless they're part of a common security boundary. To isolate your queues, you must configure the Queue Role to only allow queue access to the bucket and root prefix. In the following example, replace each placeholder with your resource- specific information. { "Version": "2012-10-17", "Statement": [ { "Action": [ "s3:GetObject", "s3:PutObject", "s3:ListBucket", "s3:GetBucketLocation" ], "Effect": "Allow", "Resource": [ "arn:aws:s3:::JOB_ATTACHMENTS_BUCKET_NAME", "arn:aws:s3:::JOB_ATTACHMENTS_BUCKET_NAME/JOB_ATTACHMENTS_ROOT_PREFIX/*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "ACCOUNT_ID" } } }, { "Action": ["logs:GetLogEvents"], "Effect": "Allow", "Resource": "arn:aws:logs:REGION:ACCOUNT_ID:log-group:/aws/deadline/FARM_ID/*" } ] } You must also set a trust policy on the role. In the following example, replace the placeholder text with your resource-specific information. { "Version": "2012-10-17", "Statement": [ { Job attachment queues Version latest 138 AWS Deadline Cloud User Guide "Action": ["sts:AssumeRole"], "Effect": "Allow", "Principal": { "Service": "deadline.amazonaws.com" }, "Condition": { "StringEquals": { "aws:SourceAccount": "ACCOUNT_ID" }, "ArnEquals": { "aws:SourceArn": "arn:aws:deadline:REGION:ACCOUNT_ID:farm/FARM_ID" } } }, { "Action": ["sts:AssumeRole"], "Effect": "Allow", "Principal": { "Service": "credentials.deadline.amazonaws.com" }, "Condition": { "StringEquals": { "aws:SourceAccount": "ACCOUNT_ID" }, "ArnEquals": { "aws:SourceArn": "arn:aws:deadline:REGION:ACCOUNT_ID:farm/FARM_ID" } } } ] } Custom software Amazon S3 buckets You can add the following statement to your Queue Role to access custom software in your Amazon S3 bucket. In the following example, replace SOFTWARE_BUCKET_NAME with the name of your S3 bucket. "Statement": [ { "Action": [ "s3:GetObject", "s3:ListBucket" ], "Effect": "Allow", "Resource": [ "arn:aws:s3:::SOFTWARE_BUCKET_NAME", "arn:aws:s3:::SOFTWARE_BUCKET_NAME/*" ] } Custom software buckets Version latest 139 AWS Deadline Cloud ] User Guide For more information about Amazon S3 security best practices, see Security best practices for Amazon S3 in the Amazon Simple Storage Service User Guide. Worker hosts Secure worker hosts to help ensure that each user can only perform operations for their assigned role. We recommend the following best practices to secure worker hosts: • Using a host configuration script can change the security and operations of a worker. An incorrect configuration may cause the worker to be unstable or to stop working. It is your responsibility to debug such failures. • Don’t use the same jobRunAsUser value with multiple queues unless jobs submitted to those queues are within the same security boundary. • Don’t set the queue jobRunAsUser to the name of the OS user that the worker agent runs as. • Grant queue users least-privileged OS permissions required for the intended queue workloads. Ensure that they don't have filesystem write permissions to work agent program files or other shared software. • Ensure only the root user on Linux and the Administrator owns account on Windows owns and can modify the worker agent program files. • On Linux worker hosts, consider configuring a umask override in /etc/sudoers that allows the worker agent user to launch processes as queue users. This configuration helps ensure other users can't access files written to the queue. • Grant trusted individuals least-privileged access to worker hosts. • Restrict permissions to local DNS override configuration files (/etc/hosts on Linux and C: \Windows\system32\etc\hosts on Windows), and to route tables on workstations and worker host operating systems. • Restrict permissions to DNS configuration on workstations and worker host operating systems. • Regularly patch the operating system and all installed software. This approach includes software specifically used with Deadline Cloud such as submitters, adaptors, worker agents, OpenJD packages, and others. • Use strong passwords for the Windows queue jobRunAsUser. Worker hosts Version latest 140 AWS Deadline Cloud User Guide • Regularly rotate the passwords for your queue jobRunAsUser. • Ensure least privilege access to the Windows password secrets and delete unused secrets. • Don't give the queue jobRunAsUser permission the schedule commands to run in the future: • On Linux, deny these accounts access to cron and at. • On Windows, deny these accounts access to the Windows task scheduler. Note For more information about the importance of regularly patching the operating system and installed software, see the Shared Responsibility Model. Host configuration script • Using a host configuration script can change the security and operations of a worker. An incorrect configuration may cause the worker to be unstable or to stop working. It is your responsibility to debug such failures. Workstations It's important to secure workstations with access to Deadline Cloud. This approach helps ensure that any jobs you submit to Deadline Cloud can't run arbitrary workloads billed to your AWS account. We recommend the following best practice to secure artist workstations. For more information, see the Shared Responsibility Model. • Secure any persisted credentials that provide access to AWS, including Deadline Cloud. For more information, see Managing access keys for IAM users in the IAM User Guide. • Only install trusted, |
user-guide.pdf-053 | user-guide.pdf.pdf | 53 | cause the worker to be unstable or to stop working. It is your responsibility to debug such failures. Workstations It's important to secure workstations with access to Deadline Cloud. This approach helps ensure that any jobs you submit to Deadline Cloud can't run arbitrary workloads billed to your AWS account. We recommend the following best practice to secure artist workstations. For more information, see the Shared Responsibility Model. • Secure any persisted credentials that provide access to AWS, including Deadline Cloud. For more information, see Managing access keys for IAM users in the IAM User Guide. • Only install trusted, secure software. • Require users federate with an identity provider to access AWS with temporary credentials. • Use secure permissions on Deadline Cloud submitter program files to prevent tampering. • Grant trusted individuals least-privileged access to artist workstations. • Only use submitters and adaptors that you obtain through the Deadline Cloud Monitor. Host configuration script Version latest 141 AWS Deadline Cloud User Guide • Restrict permissions to local DNS override configuration files (/etc/hosts on Linux and macOS, and C:\Windows\system32\etc\hosts on Windows), and to route tables on workstations and worker host operating systems. • Restrict permissions to /etc/resolve.conf on workstations and worker host operating systems. • Regularly patch the operating system and all installed software. This approach includes software specifically used with Deadline Cloud such as submitters, adaptors, worker agents, OpenJD packages, and others. Verify the authenticity of downloaded software Verify your software's authenticity after downloading the installer to protect against file tampering. This procedure works for both Windows and Linux systems. Windows To verify the authenticity of your downloaded files, complete the following steps. 1. In the following command, replace file with the file that you want to verify. For example, C:\PATH\TO\MY\DeadlineCloudSubmitter-windows-x64-installer.exe . Also, replace signtool-sdk-version with the version of the SignTool SDK installed. For example, 10.0.22000.0. "C:\Program Files (x86)\Windows Kits\10\bin\signtool-sdk- version\x86\signtool.exe" verify /vfile 2. For example, you can verify the Deadline Cloud submitter installer file by running the following command: "C:\Program Files (x86)\Windows Kits\10\bin \10.0.22000.0\x86\signtool.exe" verify /v DeadlineCloudSubmitter- windows-x64-installer.exe Linux To verify the authenticity of your downloaded files, use the gpg command line tool. 1. Import the OpenPGP key by running the following command: Verify downloaded software Version latest 142 AWS Deadline Cloud User Guide gpg --import --armor <<EOF -----BEGIN PGP PUBLIC KEY BLOCK----- mQINBGX6GQsBEADduUtJgqSXI+q76O6fsFwEYKmbnlyL0xKvlq32EZuyv0otZo5L le4m5Gg52AzrvPvDiUTLooAlvYeozaYyirIGsK08Ydz0Ftdjroiuh/mw9JSJDJRI rnRn5yKet1JFezkjopA3pjsTBP6lW/mb1bDBDEwwwtH0x9lV7A03FJ9T7Uzu/qSh qO/UYdkafro3cPASvkqgDt2tCvURfBcUCAjZVFcLZcVD5iwXacxvKsxxS/e7kuVV I1+VGT8Hj8XzWYhjCZxOLZk/fvpYPMyEEujN0fYUp6RtMIXve0C9awwMCy5nBG2J eE2Ol5DsCpTaBd4Fdr3LWcSs8JFA/YfP9auL3NczOozPoVJt+fw8CBlVIXO0J7l5 hvHDjcC+5v0wxqAlMG6+f/SX7CT8FXK+L3iOJ5gBYUNXqHSxUdv8kt76/KVmQa1B Akl+MPKpMq+lhw++S3G/lXqwWaDNQbRRw7dSZHymQVXvPp1nsqc3hV7KlOM+6s6g 1g4mvFY4lf6DhptwZLWyQXU8rBQpojvQfiSmDFrFPWFi5BexesuVnkGIolQoklKx AVUSdJPVEJCteyy7td4FPhBaSqT5vW3+ANbr9b/uoRYWJvn17dN0cc9HuRh/Ai+I nkfECo2WUDLZ0fEKGjGyFX+todWvJXjvc5kmE9Ty5vJp+M9Vvb8jd6t+mwARAQAB tCxBV1MgRGVhZGxpbmUgQ2xvdWQgPGF3cy1kZWFkbGluZUBhbWF6b24uY29tPokC VwQTAQgAQRYhBLhAwIwpqQeWoHH6pfbNPOa3bzzvBQJl+hkLAxsvBAUJA8JnAAUL CQgHAgIiAgYVCgkICwIDFgIBAh4HAheAAAoJEPbNPOa3bzzvKswQAJXzKSAY8sY8 F6Eas2oYwIDDdDurs8FiEnFghjUEO6MTt9AykF/jw+CQg2UzFtEyObHBymhgmhXE 3buVeom96tgM3ZDfZu+sxi5pGX6oAQnZ6riztN+VpkpQmLgwtMGpSMLl3KLwnv2k WK8mrR/fPMkfdaewB7A6RIUYiW33GAL4KfMIs8/vIwIJw99NxHpZQVoU6dFpuDtE 1OuxGcCqGJ7mAmo6H/YawSNp2Ns80gyqIKYo7o3LJ+WRroIRlQyctq8gnR9JvYXX 42ASqLq5+OXKo4qh81blXKYqtc176BbbSNFjWnzIQgKDgNiHFZCdcOVgqDhwO15r NICbqqwwNLj/Fr2kecYx180Ktpl0jOOw5IOyh3bf3MVGWnYRdjvA1v+/CO+55N4g z0kf50Lcdu5RtqV10XBCifn28pecqPaSdYcssYSRl5DLiFktGbNzTGcZZwITTKQc af8PPdTGtnnb6P+cdbW3bt9MVtN5/dgSHLThnS8MPEuNCtkTnpXshuVuBGgwBMdb qUC+HjqvhZzbwns8dr5WI+6HWNBFgGANn6ageYl58vVp0UkuNP8wcWjRARciHXZx ku6W2jPTHDWGNrBQO2Fx7fd2QYJheIPPAShHcfJO+xgWCof45D0vAxAJ8gGg9Eq+ gFWhsx4NSHn2gh1gDZ41Ou/4exJ1lwPM =uVaX -----END PGP PUBLIC KEY BLOCK----- EOF 2. Determine whether to trust the OpenPGP key. Some factors to consider when deciding whether to trust the above key include the following: • The internet connection you’ve used to obtain the GPG key from this website is secure. • The device that you are accessing this website on is secure. • AWS has taken measures to secure the hosting of the OpenPGP public key on this website. 3. If you decide to trust the OpenPGP key, edit the key to trust with gpg similar to the following example: Verify downloaded software Version latest 143 AWS Deadline Cloud User Guide $ gpg --edit-key 0xB840C08C29A90796A071FAA5F6CD3CE6B76F3CEF gpg (GnuPG) 2.0.22; Copyright (C) 2013 Free Software Foundation, Inc. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. pub 4096R/4BF0B8D2 created: 2023-06-23 expires: 2025-06-22 usage: SCEA trust: unknown validity: unknown [ unknown] (1). AWS Deadline Cloud [email protected] gpg> trust pub 4096R/4BF0B8D2 created: 2023-06-23 expires: 2025-06-22 usage: SCEA trust: unknown validity: unknown [ unknown] (1). AWS Deadline Cloud [email protected] Please decide how far you trust this user to correctly verify other users' keys (by looking at passports, checking fingerprints from different sources, etc.) 1 = I don't know or won't say 2 = I do NOT trust 3 = I trust marginally 4 = I trust fully 5 = I trust ultimately m = back to the main menu Your decision? 5 Do you really want to set this key to ultimate trust? (y/N) y pub 4096R/4BF0B8D2 created: 2023-06-23 expires: 2025-06-22 usage: SCEA trust: ultimate validity: unknown [ unknown] (1). AWS Deadline Cloud [email protected] Please note that the shown key validity is not necessarily correct unless you restart the program. gpg> quit 4. Verify the Deadline Cloud submitter installer To verify the Deadline Cloud submitter installer, complete the following steps: Verify downloaded software Version latest 144 AWS Deadline Cloud User Guide a. Return to the Deadline Cloud console Downloads page and download the signature file for the Deadline Cloud submitter installer. b. Verify the signature of the Deadline Cloud submitter installer by running: gpg --verify ./DeadlineCloudSubmitter-linux-x64-installer.run.sig ./ DeadlineCloudSubmitter-linux-x64-installer.run 5. Verify the Deadline Cloud monitor Note You can verify the Deadline Cloud monitor download using signature files or platform specific methods. For platform specific methods, see the |
user-guide.pdf-054 | user-guide.pdf.pdf | 54 | you restart the program. gpg> quit 4. Verify the Deadline Cloud submitter installer To verify the Deadline Cloud submitter installer, complete the following steps: Verify downloaded software Version latest 144 AWS Deadline Cloud User Guide a. Return to the Deadline Cloud console Downloads page and download the signature file for the Deadline Cloud submitter installer. b. Verify the signature of the Deadline Cloud submitter installer by running: gpg --verify ./DeadlineCloudSubmitter-linux-x64-installer.run.sig ./ DeadlineCloudSubmitter-linux-x64-installer.run 5. Verify the Deadline Cloud monitor Note You can verify the Deadline Cloud monitor download using signature files or platform specific methods. For platform specific methods, see the Linux (Debian) tab, the Linux (RPM) tab, or the Linux (AppImage) tab based on your downloaded file type. To verify the Deadline Cloud monitor desktop application with signature files, complete the following steps: a. Return to the Deadline Cloud console Downloads page and download the corresponding .sig file, and then run For .deb: gpg --verify ./deadline-cloud-monitor_<APP_VERSION>_amd64.deb.sig ./ deadline-cloud-monitor_<APP_VERSION>_amd64.deb For .rpm: gpg --verify ./deadline-cloud-monitor_<APP_VERSION>_x86_64.deb.sig ./ deadline-cloud-monitor_<APP_VERSION>_x86_64.rpm For .AppImage: gpg --verify ./deadline-cloud-monitor_<APP_VERSION>_amd64.AppImage.sig ./ deadline-cloud-monitor_<APP_VERSION>_amd64.AppImage Verify downloaded software Version latest 145 AWS Deadline Cloud User Guide b. Confirm that the output looks similar to the following: gpg: Signature made Mon Apr 1 21:10:14 2024 UTC gpg: using RSA key B840C08C29A90796A071FAA5F6CD3CE6B7 If the output contains the phrase Good signature from "AWS Deadline Cloud", it means that the signature has successfully been verified and you can run the Deadline Cloud monitor installation script. Linux (AppImage) To verify packages that use a Linux .AppImage binary, first complete steps 1-3 in the Linux tab, then complete the following steps. 1. From the AppImageUpdate page in GitHub, download the validate-x86_64.AppImage file. 2. After downloading the file, to add execute permissions, run the following command. chmod a+x ./validate-x86_64.AppImage 3. To add execute permissions, run the following command. chmod a+x ./deadline-cloud-monitor_<APP_VERSION>_amd64.AppImage 4. To verify the Deadline Cloud monitor signature, run the following command. ./validate-x86_64.AppImage ./deadline-cloud-monitor_<APP_VERSION>_amd64.AppImage If the output contains the phrase Validation successful, it means that the signature has successfully been verified and you can safely run the Deadline Cloud monitor installation script. Linux (Debian) To verify packages that use a Linux .deb binary, first complete steps 1-3 in the Linux tab. dpkg is the core package management tool in most debian based Linux distributions. You can verify the .deb file with the tool. Verify downloaded software Version latest 146 AWS Deadline Cloud User Guide 1. From the Deadline Cloud console Downloads page, download the Deadline Cloud monitor .deb file. 2. Replace <APP_VERSION> with the version of the .deb file you want to verify. dpkg-sig --verify deadline-cloud-monitor_<APP_VERSION>_amd64.deb 3. The output will be similar to: ProcessingLinux deadline-cloud-monitor_<APP_VERSION>_amd64.deb... GOODSIG _gpgbuilder B840C08C29A90796A071FAA5F6CD3C 171200 4. To verify the .deb file, confirm that GOODSIG is present in the output. Linux (RPM) To verify packages that use a Linux .rpm binary, first complete steps 1-3 in the Linux tab. 1. From the Deadline Cloud console Downloads page, download the Deadline Cloud monitor .rpm file. 2. Replace <APP_VERSION> with the version of the .rpm file to verify. gpg --export --armor "Deadline Cloud" > key.pub sudo rpm --import key.pub rpm -K deadline-cloud-monitor-<APP_VERSION>-1.x86_64.rpm 3. The output will be similar to: deadline-cloud-monitor-deadline-cloud- monitor-<APP_VERSION>-1.x86_64.rpm-1.x86_64.rpm: digests signatures OK 4. To verify the .rpm file, confirm that digests signatures OK is in the output. Verify downloaded software Version latest 147 AWS Deadline Cloud User Guide Monitoring AWS Deadline Cloud Monitoring is an important part of maintaining the reliability, availability, and performance of AWS Deadline Cloud (Deadline Cloud) and your AWS solutions. Collect monitoring data from all of the parts of your AWS solution so that you can more easily debug a multi-point failure if one occurs. Before you start monitoring Deadline Cloud, you should create a monitoring plan that includes answers to the following questions: • What are your monitoring goals? • Which resources will you monitor? • How often will you monitor these resources? • Which monitoring tools will you use? • Who will perform the monitoring tasks? • Who should be notified when something goes wrong? AWS and Deadline Cloud provide tools that you can use to monitor your resources and respond to potential incidents. Some of these tools do the monitoring for you, some of the tools require manual intervention. You should automate monitoring tasks as much as possible. • Amazon CloudWatch monitors your AWS resources and the applications you run on AWS in real time. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a specified metric reaches a threshold that you specify. For example, you can have CloudWatch track CPU usage or other metrics of your Amazon EC2 instances and automatically launch new instances when needed. For more information, see the Amazon CloudWatch User Guide. Deadline Cloud has three CloudWatch metrics. • Amazon CloudWatch Logs enables you to |
user-guide.pdf-055 | user-guide.pdf.pdf | 55 | You should automate monitoring tasks as much as possible. • Amazon CloudWatch monitors your AWS resources and the applications you run on AWS in real time. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a specified metric reaches a threshold that you specify. For example, you can have CloudWatch track CPU usage or other metrics of your Amazon EC2 instances and automatically launch new instances when needed. For more information, see the Amazon CloudWatch User Guide. Deadline Cloud has three CloudWatch metrics. • Amazon CloudWatch Logs enables you to monitor, store, and access your log files from Amazon EC2 instances, CloudTrail, and other sources. CloudWatch Logs can monitor information in the log files and notify you when certain thresholds are met. You can also archive your log data in highly durable storage. For more information, see the Amazon CloudWatch Logs User Guide. • Amazon EventBridge can be used to automate your AWS services and respond automatically to system events, such as application availability issues or resource changes. Events from AWS services are delivered to EventBridge in near real time. You can write simple rules to indicate Version latest 148 AWS Deadline Cloud User Guide which events are of interest to you and which automated actions to take when an event matches a rule. For more information, see Amazon EventBridge User Guide. • AWS CloudTrail captures API calls and related events made by or on behalf of your AWS account and delivers the log files to an Amazon S3 bucket that you specify. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see the AWS CloudTrail User Guide. For more information, see the following topics in the Deadline Cloud Developer Guide: • CloudTrail logs • Managing events using EventBridge • Monitoring with CloudWatch Version latest 149 AWS Deadline Cloud User Guide Quotas for Deadline Cloud AWS Deadline Cloud provides resources, such as farms, fleets, and queues, that you can use to process jobs. When you create your AWS account, we set default quotas on these resources for each AWS Region. Service Quotas is a central location where you can view and manage your quotas for AWS services. You can also request a quota increase for many of the resources that you use. To view the quotas for Deadline Cloud, open the Service Quotas console. In the navigation pane, choose AWS services and select Deadline Cloud. To request a quota increase, see Requesting a quota increase in the Service Quotas User Guide. If the quota is not yet available in Service Quotas, use the service quota increase form. Version latest 150 AWS Deadline Cloud User Guide Creating AWS Deadline Cloud resources with AWS CloudFormation AWS Deadline Cloud is integrated with AWS CloudFormation, a service that helps you to model and set up your AWS resources so that you can spend less time creating and managing your resources and infrastructure. You create a template that describes all the AWS resources that you want (such as farms, queues, and fleets), and AWS CloudFormation provisions and configures those resources for you. When you use AWS CloudFormation, you can reuse your template to set up your Deadline Cloud resources consistently and repeatedly. Describe your resources once, and then provision the same resources over and over in multiple AWS accounts and Regions. Deadline Cloud and AWS CloudFormation templates To provision and configure resources for Deadline Cloud and related services, you must understand AWS CloudFormation templates. Templates are formatted text files in JSON or YAML. These templates describe the resources that you want to provision in your AWS CloudFormation stacks. If you're unfamiliar with JSON or YAML, you can use AWS CloudFormation Designer to help you get started with AWS CloudFormation templates. For more information, see What is AWS CloudFormation Designer? in the AWS CloudFormation User Guide. Deadline Cloud supports creating farms, queues, and fleets in AWS CloudFormation. For more information, including examples of JSON and YAML templates for farms, queues, and fleets, see the AWS Deadline Cloud in the AWS CloudFormation User Guide. Learn more about AWS CloudFormation To learn more about AWS CloudFormation, see the following resources: • AWS CloudFormation • AWS CloudFormation User Guide • AWS CloudFormation API Reference • AWS CloudFormation Command Line Interface User Guide Deadline Cloud and AWS CloudFormation templates Version latest 151 AWS Deadline Cloud User Guide Troubleshooting The following procedures and tips can help you troubleshoot issues with your AWS Deadline Cloud farms and resources. Topics • Why can a user not see my farm, fleet, or queue? • Why are workers not picking up my jobs? • Why is my worker stuck running? • Troubleshooting Deadline Cloud jobs • Additional |
user-guide.pdf-056 | user-guide.pdf.pdf | 56 | To learn more about AWS CloudFormation, see the following resources: • AWS CloudFormation • AWS CloudFormation User Guide • AWS CloudFormation API Reference • AWS CloudFormation Command Line Interface User Guide Deadline Cloud and AWS CloudFormation templates Version latest 151 AWS Deadline Cloud User Guide Troubleshooting The following procedures and tips can help you troubleshoot issues with your AWS Deadline Cloud farms and resources. Topics • Why can a user not see my farm, fleet, or queue? • Why are workers not picking up my jobs? • Why is my worker stuck running? • Troubleshooting Deadline Cloud jobs • Additional resources Why can a user not see my farm, fleet, or queue? User access When your users are not seeing your farms, fleets, or queues in the Deadline Cloud monitor, there might be an issue with their access to your farm and resources. Users without access to any farms receive the message "No farms available" in the Deadline Cloud monitor. To confirm you have the correct user or group assigned to your farm, fleet, or queue 1. In the AWS Deadline Cloud console, find your farm, fleet, or queue, and then choose Access management. 2. The groups tab is selected by default. If you're assigning permissions by groups, which is recommended, your group should display in the list and have an assigned access level. If the group is not in the list, choose Add group to assign permission for the group. 3. If you're assigning permissions by user, select the Users tab. Your user should display in the list and have an assigned access level. If your user is not in the list, choose Add user to assign permission for the user. Why can a user not see my farm, fleet, or queue? Version latest 152 AWS Deadline Cloud User Guide To confirm you have the user assigned to your group 1. 2. 3. In the AWS Deadline Cloud console, find your farm, fleet, or queue, and then choose Access management. The groups tab is selected by default. Select the group name to view its members. If the user is not listed in the group, they must be added. If you're using the default identity setup, you can directly add the user to the group in the Identity Center console. If you're connected to an external identity provider such as Okta or Google Workspace, you can add your user to the group in your identity provider. Note Some external identity providers sync users but not groups to Identity Center. In this case, consider assigning permissions to a user directly instead of by group. For more information about managing user access to Deadline Cloud, see Managing users in Deadline Cloud. Why are workers not picking up my jobs? Fleet role configuration Sometimes when workers are created but do not complete initialization and do not start working on jobs, it's because the fleet role was not configured correctly. To verify this is what is happening, check your CloudTrail logs for any access denied errors. After you confirm the access denied issue, go to your fleet and update the role configuration to the correct permissions. For more information, see CloudTrail logs in the Deadline Cloud developer guide. Why is my worker stuck running? Worker stuck exiting OpenJD environment Workers can get stuck in long-running envExit session actions. This might happen if you use a job template that overrides the OpenJD template and sets the environment exit actions timeout Why are workers not picking up my jobs? Version latest 153 AWS Deadline Cloud User Guide to more than 5 minutes. The Deadline Cloud monitor provides some visibility into workers stuck in this situation, but it requires cross-referencing RUNNING workers against available work in the associated queues. To find stuck workers, go through all fleets in the Deadline Cloud monitor and complete the following steps: 1. 2. 3. In the worker status column, find RUNNING workers. From the Fleet details section, navigate to each associated queue. In each associated queue, search for jobs that are RUNNING, READY, or PENDING. If all associated queues don't have any jobs in those states, then the worker is running an environment exit. To stop a worker stuck in this state, use the following AWS CLI command: aws deadline update-worker \ --farm-id $FARM_ID \ --fleet-id $FLEET_ID \ --worker-id $WORKER_ID \ --status STOPPED After running the command, the worker agent restarts when the program exits. Workers then come back online and run more jobs from associated queues. If the queue contains more jobs with environment exit action timeouts longer than 5 minutes, the worker will get stuck again. If this happens, you will need to repeat this process until no more workers are stuck exiting. To avoid this issue, set the timeout option to no more than 5 minutes when using |
user-guide.pdf-057 | user-guide.pdf.pdf | 57 | state, use the following AWS CLI command: aws deadline update-worker \ --farm-id $FARM_ID \ --fleet-id $FLEET_ID \ --worker-id $WORKER_ID \ --status STOPPED After running the command, the worker agent restarts when the program exits. Workers then come back online and run more jobs from associated queues. If the queue contains more jobs with environment exit action timeouts longer than 5 minutes, the worker will get stuck again. If this happens, you will need to repeat this process until no more workers are stuck exiting. To avoid this issue, set the timeout option to no more than 5 minutes when using a job template. Troubleshooting Deadline Cloud jobs For information about common problems with jobs in AWS Deadline Cloud, see the following topics. Why did creating my job fail? Some possible reasons that a job can fail validation checks include the following: • The job template doesn't follow the OpenJD specification. • The job contains too many steps. Troubleshooting jobs Version latest 154 AWS Deadline Cloud User Guide • The job contains too many total tasks. • There was an internal service error that prevents the job from being created. To see the quotas for the maximum number of steps and tasks in a job, use the Service Quotas console. For more information, see Quotas for Deadline Cloud. Why is my job not compatible? Common reasons that jobs are not compatible with queues include the following: • No fleets are associated with the queue that the job was submitted to. Open the Deadline Cloud monitor, and check that the queue has associated fleets. For more information about how to view queues, see View queue and fleet details in Deadline Cloud. • The job has host requirements that are not satisfied by any of the fleets associated with the queue. To check, compare the hostRequirements entry in the job template with the configuration of the fleets in your farm. Make sure that one of the fleets satisfies the host requirements. For more information about fleet compatibility, see Determine fleet compatibility. To view fleet configuration, see View queue and fleet details in Deadline Cloud. Why is my job stuck in ready? Possible reasons for your job appearing to be stuck in the READY state include the following: • The maximum worker count for fleets associated with the queue is set to zero. To check, see View queue and fleet details in Deadline Cloud. • There is a higher priority job in the queue. To check, see View queue and fleet details in Deadline Cloud. • For customer-managed fleets, check the auto scaling configuration. For more information, see Create fleet infrastructure with an Amazon EC2 Auto Scaling group in the Deadline Cloud Developer Guide. Why did my job fail? A job can fail for many reasons. To search for the issue, open the Deadline Cloud monitor and choose the failing job. Choose a task that failed and then view the logs for the task. For instructions, see View logs in Deadline Cloud. Why is my job not compatible? Version latest 155 AWS Deadline Cloud User Guide • If you see license errors or if you get a watermark that occurs because the software doesn't have a valid license, make sure that the worker can connect to the required license server. For more information, see Connect customer-managed fleets to a license endpoint in the Deadline Cloud Developer Guide. • The last session action message or the process exit code may provide information about why you job failed. If you are using Windows and your exit code is negative, try searching for the unsigned version of your exit code: 2,147,483,647 - |your exit code| Why is my step pending? Steps may stay in the PENDING state when one or more of their dependencies are not complete. You can check the state of dependencies using the Deadline Cloud monitor. For instructions, see View a step in Deadline Cloud. Additional resources You can find additional information and resources on GitHub. Why is my step pending? Version latest 156 AWS Deadline Cloud User Guide Document history for the Deadline Cloud user guide The following table describes important changes in each release of the AWS Deadline Cloud user guide. Change Description Date AWS Managed policy update May 30, 2025 Updated existing AWS AWSDeadlineCloud-W orkerHost managed policy. For more information, see AWS managed policies for Deadline Cloud. Adobe After Effects submitter installer Added instructions for adding the Adobe After Effects February 13, 2025 Troubleshooting Job resource limits Adobe After Effects UBL submitter installer to your digital content creation software. For more informati on, see Adobe After Effects. Added information for troubleshooting Deadline Cloud issues. For more information, see Troublesh ooting. Added documentation for new job resource limit and maximum number of worker hosts. For more information, see Create resource limits for |
user-guide.pdf-058 | user-guide.pdf.pdf | 58 | Description Date AWS Managed policy update May 30, 2025 Updated existing AWS AWSDeadlineCloud-W orkerHost managed policy. For more information, see AWS managed policies for Deadline Cloud. Adobe After Effects submitter installer Added instructions for adding the Adobe After Effects February 13, 2025 Troubleshooting Job resource limits Adobe After Effects UBL submitter installer to your digital content creation software. For more informati on, see Adobe After Effects. Added information for troubleshooting Deadline Cloud issues. For more information, see Troublesh ooting. Added documentation for new job resource limit and maximum number of worker hosts. For more information, see Create resource limits for jobs. Added information about Adobe After Effects usage- based licensing (UBL) for February 7, 2025 January 30, 2025 January 30, 2025 Version latest 157 AWS Deadline Cloud User Guide Deadline Cloud. For more information, see Connect to a license endpoint. Reorganized content from the user guide Moved developer focused content from the user guide January 6, 2025 to the developer guide: • Moved instructions for creating a customer- managed fleet to a new Customer-managed fleets chapter in the developer guide. • Moved information about using your own licenses to the new Using software licenses chapter in the developer guide. • Moved details about monitoring with CloudTrail, CloudWatch, and EventBrid ge to the Monitoring chapter in the developer guide. Added new budget threshold EventBridge event. For more information, see Deadline Cloud events detail reference. Added new job and task status EventBridge events. For more information, see Deadline Cloud events detail reference. October 30, 2024 October 24, 2024 Version latest 158 Budget threshold event Job status events AWS Deadline Cloud Resubmit job AWS Managed policy updates Bring your own license Autodesk 3ds Max UBL Added information about how to resubmit a job. For more information, see Resubmit a job. Updated existing AWS managed policies. For more information, see AWS managed policies for Deadline Cloud. Added information about how you can use your own license server or license proxy instance with Deadline Cloud. For more information, see Service-managed fleets. Added information about Autodesk 3ds Max usage- based licensing (UBL) for Deadline Cloud. For more information, see Connect to a license endpoint. User Guide October 7, 2024 October 7, 2024 July 26, 2024 June 18, 2024 Version latest 159 User Guide May 23, 2024 AWS Deadline Cloud Monitoring and cost management features You can use EventBridge to support monitoring in Deadline Cloud. For more information, see Acting on EventBridge events. Deadline Cloud provides budgets and the usage explorer to help you control and visualize costs for your jobs. Learn about some best practices to help manage those costs. For more information, see Cost management. Initial release This is the initial release of the Deadline Cloud user April 2, 2024 guide. Version latest 160 AWS Deadline Cloud User Guide AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. Version latest 161 |
userguide-001 | userguide.pdf | 1 | User Guide Amazon DevOps Guru Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon DevOps Guru User Guide Amazon DevOps Guru: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon DevOps Guru Table of Contents User Guide What is Amazon DevOps Guru? ...................................................................................................... 1 How does DevOps Guru work? .................................................................................................................. 1 High level DevOps Guru workflow ...................................................................................................... 2 Detailed DevOps Guru workflow .......................................................................................................... 3 How do I get started? ................................................................................................................................. 5 How do I stop incurring DevOps Guru charges? .................................................................................... 5 Concepts ......................................................................................................................................................... 5 Anomaly .................................................................................................................................................... 6 Insight ........................................................................................................................................................ 6 Metrics and operational events ............................................................................................................ 6 Log groups and log anomalies ............................................................................................................. 7 Recommendations ................................................................................................................................... 7 Coverage ......................................................................................................................................................... 8 Service coverage list ............................................................................................................................... 9 Setting up ...................................................................................................................................... 11 Sign up for AWS ......................................................................................................................................... 11 Sign up for an AWS account .............................................................................................................. 11 Create a user with administrative access ......................................................................................... 12 Determine coverage for DevOps Guru ................................................................................................... 13 Identify your notifications topic ............................................................................................................. 14 Permissions added to your topic ....................................................................................................... 15 Estimating your cost ..................................................................................................................... 16 Getting started .............................................................................................................................. 18 Step 1: Get set up ...................................................................................................................................... 18 Step 2: Enable DevOps Guru ................................................................................................................... 18 Monitor accounts across your organization .................................................................................... 18 Monitor your current account ............................................................................................................ 20 Step 3: Specify your DevOps Guru resource coverage ....................................................................... 21 Enabling AWS services for DevOps Guru analysis ....................................................................... 23 Working with insights ................................................................................................................... 24 Viewing insights ......................................................................................................................................... 24 Understanding insights in the DevOps Guru console ......................................................................... 25 Understanding how anomalous behaviors are grouped into insights ............................................. 28 Understanding insight severities ............................................................................................................. 29 iii Amazon DevOps Guru User Guide Monitoring databases .................................................................................................................... 30 Relational databases .................................................................................................................................. 30 Monitoring database operations in Amazon RDS .......................................................................... 30 Monitoring database operations in Amazon Redshift ................................................................... 32 Working with anomalies in DevOps Guru for RDS ......................................................................... 33 Non-relational databases .......................................................................................................................... 52 Monitoring database operations in Amazon DynamoDB .............................................................. 53 Monitoring database operations in Amazon ElastiCache ............................................................. 53 Integrating with CodeGuru Profiler ............................................................................................. 54 Defining applications using AWS resources ................................................................................. 55 Using tags to identify resources in your applications ........................................................................ 56 What is a tag? ....................................................................................................................................... 57 Defining an application using a tag .................................................................................................. 57 Using tags with DevOps Guru ............................................................................................................ 58 Adding tags to resources .................................................................................................................... 58 Using stacks to identify resources in your DevOps Guru applications ............................................ 59 Choosing stacks to analyze ................................................................................................................ 60 Working with EventBridge ............................................................................................................ 62 Events for DevOps Guru ........................................................................................................................... 62 DevOpsGuru New Insight Open Event ............................................................................................. 62 Custom sample event pattern for high severity new Insight ...................................................... 64 Updating settings .......................................................................................................................... 65 Updating your management account .................................................................................................... 65 Updating your AWS analysis coverage .................................................................................................. 65 Updating your notifications ..................................................................................................................... 66 Navigate to notification settings in the DevOps Guru console ................................................... 67 Adding Amazon SNS notification topics .......................................................................................... 67 Removing Amazon SNS notification topics ..................................................................................... 67 Updating Amazon SNS notification configurations ....................................................................... 68 Permissions added to your topic ....................................................................................................... 69 Filtering your notifications ....................................................................................................................... 69 Filtering notifications with a Amazon SNS subscription filter policy ......................................... 70 Example filtered Amazon SNS notification ..................................................................................... 70 Updating Systems Manager integration ................................................................................................ 72 Updating log anomaly detection ............................................................................................................ 72 Updating encryption .................................................................................................................................. 73 iv Amazon DevOps Guru User Guide Viewing notifications ..................................................................................................................... 74 New insight .................................................................................................................................................. 74 Closed insight .............................................................................................................................................. 75 New association .......................................................................................................................................... 77 New recommendation ............................................................................................................................... 78 Severity upgraded ...................................................................................................................................... 79 Resource validation failure ....................................................................................................................... 80 Viewing analyzed resources .......................................................................................................... 82 Updating your AWS analysis coverage .................................................................................................. 82 Removing analyzed resource view for users ........................................................................................ 84 Best practices ................................................................................................................................. 85 Security .......................................................................................................................................... 86 Data protection ........................................................................................................................................... 86 Data encryption ..................................................................................................................................... 87 How DevOps Guru uses grants in AWS KMS ................................................................................... 89 Monitoring your encryption keys in DevOps Guru ......................................................................... 89 Create a customer managed key ....................................................................................................... 90 Traffic privacy ........................................................................................................................................ 91 Identity and Access Management ........................................................................................................... 92 Audience .................................................................................................................................................. 92 Authenticating with identities ............................................................................................................ 93 Managing access using policies .......................................................................................................... 96 Policy updates ....................................................................................................................................... 99 How Amazon DevOps Guru works with IAM ................................................................................. 103 Identity-based policies ...................................................................................................................... 110 Using service-linked roles ................................................................................................................. 122 DevOps Guru permissions reference ............................................................................................... 128 Permissions for Amazon SNS topics ............................................................................................... 132 Permissions for encrypted Amazon SNS topics ........................................................................... 137 Troubleshooting .................................................................................................................................. 138 Monitoring DevOps Guru ........................................................................................................................ 142 Monitoring with CloudWatch ........................................................................................................... 142 Logging DevOps Guru API calls with AWS CloudTrail ................................................................. 145 VPC endpoints (AWS PrivateLink) ........................................................................................................ 148 Considerations for DevOps Guru VPC endpoints ......................................................................... 148 Creating an interface VPC endpoint for DevOps Guru ............................................................... 148 v Amazon DevOps Guru User |
userguide-002 | userguide.pdf | 2 | access using policies .......................................................................................................... 96 Policy updates ....................................................................................................................................... 99 How Amazon DevOps Guru works with IAM ................................................................................. 103 Identity-based policies ...................................................................................................................... 110 Using service-linked roles ................................................................................................................. 122 DevOps Guru permissions reference ............................................................................................... 128 Permissions for Amazon SNS topics ............................................................................................... 132 Permissions for encrypted Amazon SNS topics ........................................................................... 137 Troubleshooting .................................................................................................................................. 138 Monitoring DevOps Guru ........................................................................................................................ 142 Monitoring with CloudWatch ........................................................................................................... 142 Logging DevOps Guru API calls with AWS CloudTrail ................................................................. 145 VPC endpoints (AWS PrivateLink) ........................................................................................................ 148 Considerations for DevOps Guru VPC endpoints ......................................................................... 148 Creating an interface VPC endpoint for DevOps Guru ............................................................... 148 v Amazon DevOps Guru User Guide Creating a VPC endpoint policy for DevOps Guru ....................................................................... 149 Infrastructure security ............................................................................................................................. 149 Resilience ................................................................................................................................................... 150 Quotas and limits ........................................................................................................................ 151 Notifications .............................................................................................................................................. 151 AWS CloudFormation stacks .................................................................................................................. 151 DevOps Guru resource monitoring limits ............................................................................................ 151 DevOps Guru quotas for creating, deploying, and managing an API ............................................ 152 Document history ........................................................................................................................ 153 AWS Glossary ............................................................................................................................... 160 vi Amazon DevOps Guru User Guide What is Amazon DevOps Guru? Welcome to the Amazon DevOps Guru user guide. DevOps Guru is a fully managed operations service that makes it easy for developers and operators to improve the performance and availability of their applications. DevOps Guru lets you offload the administrative tasks associated with identifying operational issues so that you can quickly implement recommendations to improve your application. DevOps Guru creates reactive insights you can use to improve your application now. It also creates proactive insights to help you avoid operational issues that might affect your application in the future. DevOps Guru applies machine learning to analyze your operational data and application metrics and events to identify behaviors that deviate from normal operating patterns. You are notified when DevOps Guru detects an operational issue or risk. For each issue, DevOps Guru presents intelligent recommendations to address current and predicted future operational issues. To get started, see How do I get started with DevOps Guru? How does DevOps Guru work? The DevOps Guru workflow begins when you configure its coverage and notifications. After you set up DevOps Guru, it starts to analyze your operational data. When it detects anomalous behavior, it creates an insight that contains recommendations and lists of metrics, log groups, and events that are related to the issue. For each insight, DevOps Guru notifies you. If you enabled AWS Systems Manager OpsCenter, an OpsItem is created so you can use Systems Manager OpsCenter to track and manage addressing your insights. Each insight contains recommendations, metrics, log groups, and events related to anomalous behavior. Use information in an insight to help you understand and address the anomalous behavior. See High level DevOps Guru workflow for more detail about the three high-level workflow steps. See Detailed DevOps Guru workflow to learn about the more detailed DevOps Guru workflow, including how it interacts with other AWS services. Topics • High level DevOps Guru workflow • Detailed DevOps Guru workflow How does DevOps Guru work? 1 Amazon DevOps Guru User Guide High level DevOps Guru workflow The Amazon DevOps Guru workflow can be broken down into three high level steps. 1. Specify DevOps Guru coverage by telling it which AWS resources in your AWS account you want it to analyze. 2. DevOps Guru starts analyzing Amazon CloudWatch metrics, AWS CloudTrail, and other operational data to identify problems that you can fix to improve your operations. 3. DevOps Guru makes sure that you know about insights and important information by sending you a notification for each important DevOps Guru event. You can also configure DevOps Guru to create an OpsItem in AWS Systems Manager OpsCenter to help you track your insights. The following diagram shows this high-level workflow. 1. In the first step, you choose your coverage by specifying which AWS resources in your AWS account are analyzed. DevOps Guru can cover, or analyze, all the resources in an AWS account, or you can use AWS CloudFormation stacks or AWS tags to specify a subset of the resources in your account to analyze. Make sure that the resources you specify make up your business critical applications, workloads, and micro-services. For more information about the supported services and resources, see Amazon DevOps Guru pricing. 2. In the second step, DevOps Guru analyzes the resources to generate insights. This is an ongoing process. You can view the insights and see the recommendations and related information they contain in the DevOps Guru console. DevOps Guru analyzes the following data to find issues and create insights. High level DevOps Guru workflow 2 Amazon DevOps Guru User Guide • Individual Amazon CloudWatch metrics emitted by your AWS resources. When an issue is identified, DevOps Guru collects those metrics together. • Log anomalies from Amazon CloudWatch log groups. If you enable log anomaly detection, DevOps Guru displays related log anomalies when |
userguide-003 | userguide.pdf | 3 | the second step, DevOps Guru analyzes the resources to generate insights. This is an ongoing process. You can view the insights and see the recommendations and related information they contain in the DevOps Guru console. DevOps Guru analyzes the following data to find issues and create insights. High level DevOps Guru workflow 2 Amazon DevOps Guru User Guide • Individual Amazon CloudWatch metrics emitted by your AWS resources. When an issue is identified, DevOps Guru collects those metrics together. • Log anomalies from Amazon CloudWatch log groups. If you enable log anomaly detection, DevOps Guru displays related log anomalies when an issue occurs. • DevOps Guru pulls enrichment data from AWS CloudTrail management logs to find events that are related to the collected metrics. The events can be resource deployment events and configuration changes. • If you use AWS CodeDeploy, DevOps Guru analyzes deployment events to help generate insights. Events for all types of CodeDeploy deployments (on-premises server, Amazon EC2 server, Lambda, or Amazon EC2) are analyzed. • When DevOps Guru finds a specific pattern, it generates one or more recommendations to help mitigate or fix the identified issue. The recommendations are collected in one insight. The insight also contains a list of the metrics and events that are related to the issue. You use the insight data to address and understand the identified problem. 3. In the third step, DevOps Guru integrates insight notification into your workflow to help you manage issues and quickly address them. • Insights generated in your AWS account are published to the Amazon Simple Notification Service (Amazon SNS) topic chosen during DevOps Guru setup. This is how you are notified as soon as an insight is created. For more information, see Updating your notifications in DevOps Guru. • If you enabled AWS Systems Manager during DevOps Guru setup, each insight creates a corresponding OpsItem to help you track and manage the issues discovered. For more information, see Updating AWS Systems Manager integration in DevOps Guru. Detailed DevOps Guru workflow The DevOps Guru workflow integrates with several AWS services, including Amazon CloudWatch, AWS CloudTrail, Amazon Simple Notification Service, and AWS Systems Manager. The following diagram shows a detailed workflow that includes how it works with other AWS services. Detailed DevOps Guru workflow 3 Amazon DevOps Guru User Guide This diagram shows a scenario in which DevOps Guru coverage is specified by the AWS resources that are defined in AWS CloudFormation stacks or using AWS tags. If no stacks or tags are chosen, then DevOps Guru coverage analyzes all AWS resources in your account. For more information, see Defining applications using AWS resources and Determine coverage for DevOps Guru. 1. During setup, you specify one or two Amazon SNS topics that are used to notify you about important DevOps Guru events, such as when an insight is created. Next, you can specify AWS CloudFormation stacks that define the resources you want analyzed. You can also enable Systems Manager to generate an OpsItem for each insight to help you manage your insights. 2. After DevOps Guru is configured, it starts analyzing CloudWatch metrics, log groups, and events that are emitted from your resources and AWS CloudTrail data related to the CloudWatch metrics. If your operations include CodeDeploy deployments, DevOps Guru also analyzes deployment events. DevOps Guru creates insights when it identifies unusual, anomalous behavior in the analyzed data. Each insight contains one or more recommendations, a list of the metrics used to generate the insight, a list of related log groups, and a list of the events used to generate the insight. Use this information to address the identified problem. Detailed DevOps Guru workflow 4 Amazon DevOps Guru User Guide 3. After each insight is created, DevOps Guru sends a notification using the Amazon SNS topic or topics specified during DevOps Guru set up. If you enabled DevOps Guru to generate an OpsItem in Systems Manager OpsCenter, then each insight also triggers a new Systems Manager OpsItem. You can use Systems Manager to manage your insight OpsItems. How do I get started with DevOps Guru? We recommend that you complete the following steps: 1. Learn more about DevOps Guru by reading the information in DevOps Guru concepts. 2. Set up your AWS account, the AWS CLI, and an administrative user by following the steps in Setting up Amazon DevOps Guru. 3. Use DevOps Guru, following the instructions in Getting started with DevOps Guru. How do I stop incurring DevOps Guru charges? To disable Amazon DevOps Guru so that it stops incurring charges from analyzing resources in your AWS account and Region, update your coverage settings so that it doesn't analyze resources. To do this, follow the steps in Updating your AWS analysis coverage in DevOps Guru and choose None in step 4. You must do this for |
userguide-004 | userguide.pdf | 4 | 2. Set up your AWS account, the AWS CLI, and an administrative user by following the steps in Setting up Amazon DevOps Guru. 3. Use DevOps Guru, following the instructions in Getting started with DevOps Guru. How do I stop incurring DevOps Guru charges? To disable Amazon DevOps Guru so that it stops incurring charges from analyzing resources in your AWS account and Region, update your coverage settings so that it doesn't analyze resources. To do this, follow the steps in Updating your AWS analysis coverage in DevOps Guru and choose None in step 4. You must do this for each AWS account and Region where DevOps Guru analyzes resources. Note If you update your coverage to stop analyzing resources, you might continue to incur minor charges if you review existing insights generated by DevOps Guru in the past. These charges are associated with API calls used to retrieve and display insight information. For more information, see Amazon DevOps Guru pricing. DevOps Guru concepts The following concepts are important for understanding how Amazon DevOps Guru works. Topics • Anomaly • Insight How do I get started? 5 Amazon DevOps Guru • Metrics and operational events • Log groups and log anomalies • Recommendations Anomaly User Guide An anomaly represents one or more related metrics detected by DevOps Guru that are unexpected or unusual. DevOps Guru generates anomalies by using machine learning to analyze metrics and operational data that are related to your AWS resources. You specify the AWS resources that you want analyzed when you set up Amazon DevOps Guru. For more information, see Setting up Amazon DevOps Guru. Insight An insight is a collection of anomalies that are created during the analysis of the AWS resources you specify when you set up DevOps Guru. Each insight contains observations, recommendations, and analytical data you can use to improve your operational performance. There are two types of insights: • Reactive: A reactive insight identifies anomalous behavior as it occurs. It contains anomalies with recommendations, related metrics, and events to help you understand and address the issues now. • Proactive: A proactive insight lets you know about anomalous behavior before it occurs. It contains anomalies with recommendations to help you address the issues before they are predicted to happen. Metrics and operational events The anomalies that make up an insight are generated by analyzing the metrics returned by Amazon CloudWatch and operational events emitted by your AWS resources. You can view the metrics and the operational events that create an insight to help you better understand issues in your application. Anomaly 6 Amazon DevOps Guru User Guide Log groups and log anomalies When you enable log anomaly detection, relevant log groups are displayed on DevOps Guru insight pages in the DevOps Guru console. A log group lets you know about critical diagnostic information about how a resource is performing and being accessed. A log anomaly represents a cluster of similar anomalous log events found within a log group. Examples of anomalous log events that may be displayed in DevOps Guru include keyword anomalies, format anomalies, HTTP code anomalies, and more. You can use log anomalies to diagnose the root cause of an operational issue. DevOps Guru also references log lines in insight recommendations to provide more context for recommended solutions. Note DevOps Guru works with Amazon CloudWatch to enable log anomaly detection. When you enable log anomaly detection, DevOps Guru adds tags to your CloudWatch log groups. When you turn off log anomaly detection, DevOps Guru removes tags from your CloudWatch log groups. In addition, administrators should ensure that only users with permissions to view CloudWatch logs have permissions to view anomalous CloudWatch logs. We recommend that you use IAM policies to allow or deny access to the ListAnomalousLogs operation. For more information, see Identity and Access Management for DevOps Guru. Recommendations Each insight provides recommendations with suggestions to help you improve the performance of your application. The recommendation includes the following: • A description of the recommendation actions to address the anomalies that comprise the insight. • A list of the analyzed metrics in which DevOps Guru found anomalous behavior. Each metric includes the name of the AWS CloudFormation stack that generated the resource associated with the metrics, the resource's name, and the name of the AWS service associated with the resource. • A list of the events that are related to the anomalous metrics associated with the insight. Each related event contains the name of the AWS CloudFormation stack that generated the resource Log groups and log anomalies 7 Amazon DevOps Guru User Guide associated with the event, the name of the resource that generated the event, and the name of the AWS service associated with the event. • A list of log groups that are related to the anomalous |
userguide-005 | userguide.pdf | 5 | generated the resource associated with the metrics, the resource's name, and the name of the AWS service associated with the resource. • A list of the events that are related to the anomalous metrics associated with the insight. Each related event contains the name of the AWS CloudFormation stack that generated the resource Log groups and log anomalies 7 Amazon DevOps Guru User Guide associated with the event, the name of the resource that generated the event, and the name of the AWS service associated with the event. • A list of log groups that are related to the anomalous behavior associated with the insight. Each log group contains a sample log message, information about the kinds of log anomalies reported, the times the log anomalies occurred, and a link to view the log lines on CloudWatch. DevOps Guru coverage DevOps Guru addresses and creates insights for a number of different AWS services. For each service that DevOps Guru creates insights for, DevOps Guru displays a variety of analyzed metrics and generated insights. Example use case for reactive insights: Service Name Use Case Examples Metrics AWS Lambda Duration Throttles Detect latency or duration anomalies Code deployment: Amazon API Gateway for Lambda functions latency is affected caused by various by an increase in root causes like cold Lambda latency after starts, increased a recent Lambda requests, downstrea code deployment. m throttling, or Downstream throttlin code deployments. g: the operator Recommend ways to reduced capacity quickly mitigate. on read units for DynamoDB, causing increased retries. This results in throttlin g. Cold start: the Lambda function is under-provisioned, so Lambda takes longer when requests are made. Coverage 8 Amazon DevOps Guru User Guide Example use case for proactive insights: Service Name Use Case Metrics Amazon DynamoDB ConsumedReadCapacityUnits The DynamoDB table read consumed capacity is at risk of reaching table limit. Recommended action: if you are using provisioned capacity mode, use auto scaling to actively manage throughpu t capacity for tables or purchase reserved capacity in advance for tables. Switch to on-demand capacity mode to pay per read request, paying only for what is used. Detec tion time: 6 days Service coverage list For some services, DevOps Guru creates reactive insights. A reactive insight identifies anomalous behavior as it occurs. It contains anomalies with recommendations, related metrics, and events to help you understand and address the issues now. For some services, DevOps Guru creates proactive insights. A proactive insight lets you know about anomalous behavior before it occurs. It contains anomalies with recommendations to help you address the issues before they are predicted to happen. DevOps Guru creates reactive insights for services such as the following: • Amazon API Gateway • Amazon CloudFront • Amazon DynamoDB • Amazon EC2 Service coverage list 9 Amazon DevOps Guru Note User Guide DevOps Guru monitoring is at an Auto Scaling group level, and not at a single instance level. • Amazon ECS • Amazon EKS • AWS Elastic Beanstalk • Elastic Load Balancing • Amazon Kinesis • AWS Lambda • Amazon OpenSearch Service • Amazon RDS • Amazon Redshift • Amazon Route 53 • Amazon S3 • Amazon SageMaker AI • AWS Step Functions • Amazon SNS • Amazon SQS • Amazon SWF • Amazon VPC DevOps Guru creates proactive insights for services such as the following: • Amazon DynamoDB • Amazon Kinesis • AWS Lambda • Amazon RDS • Amazon SQS Service coverage list 10 Amazon DevOps Guru User Guide Setting up Amazon DevOps Guru Complete the tasks in this section to set up Amazon DevOps Guru for the first time. If you already have an AWS account, know which AWS account or accounts you want to analyze, and have an Amazon Simple Notification Service topic to use for insight notifications, you can skip ahead to Getting started with DevOps Guru. Optionally, you can use Quick Setup, a capability of AWS Systems Manager, to set up DevOps Guru and quickly configure its options. You can use Quick Setup to set up DevOps Guru for a standalone account or an organization. To use Quick Setup in Systems Manager to set up DevOps Guru for an organization, you must have the following prerequisites in place: • An organization with AWS Organizations. For more information, see AWS Organizations terminology and concepts in the AWS Organizations User Guide. • Two or more organizational units (OUs). • One or more target AWS accounts in each OU. • One administrator account with privileges to manage the target accounts. To learn how to set up DevOps Guru using Quick Setup, see Configure DevOps Guru with Quick Setup in the AWS Systems Manager User Guide. Use the following steps to set up DevOps Guru without Quick Setup. • Step 1 – Sign up for AWS • Step 2 – Determine coverage for DevOps Guru |
userguide-006 | userguide.pdf | 6 | with AWS Organizations. For more information, see AWS Organizations terminology and concepts in the AWS Organizations User Guide. • Two or more organizational units (OUs). • One or more target AWS accounts in each OU. • One administrator account with privileges to manage the target accounts. To learn how to set up DevOps Guru using Quick Setup, see Configure DevOps Guru with Quick Setup in the AWS Systems Manager User Guide. Use the following steps to set up DevOps Guru without Quick Setup. • Step 1 – Sign up for AWS • Step 2 – Determine coverage for DevOps Guru • Step 3 – Identify your Amazon SNS notifications topic Step 1 – Sign up for AWS Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. Sign up for AWS 11 Amazon DevOps Guru User Guide 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. Create a user with administrative access 12 Amazon DevOps Guru User Guide For a tutorial about using the IAM Identity Center directory as your identity source, see Configure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Step 2 – Determine coverage for DevOps Guru Your boundary coverage determines the AWS resources that are analyzed by Amazon DevOps Guru for anomalous behavior. We recommend that you group your resources into your operational applications. All the resources in your resource boundary should comprise one or more of your applications. If you have one operational solution, then your coverage boundary should include all of its resources. If you have multiple applications, choose the resources that make up each solution and group them together using AWS CloudFormation stacks or AWS tags. All of the combined resources you specify, whether they define one or more applications, are analyzed by DevOps Guru and make up its coverage boundary. Use one of the following methods to specify the resources in your operational solutions. Determine coverage for DevOps Guru 13 Amazon DevOps Guru User Guide • Choose to have your AWS Region and account define your coverage boundary. With this option, DevOps Guru analyzes all resources in your account and Region. This is a good option to choose if you use your account for only one application. • Use AWS CloudFormation stacks to define the |
userguide-007 | userguide.pdf | 7 | All of the combined resources you specify, whether they define one or more applications, are analyzed by DevOps Guru and make up its coverage boundary. Use one of the following methods to specify the resources in your operational solutions. Determine coverage for DevOps Guru 13 Amazon DevOps Guru User Guide • Choose to have your AWS Region and account define your coverage boundary. With this option, DevOps Guru analyzes all resources in your account and Region. This is a good option to choose if you use your account for only one application. • Use AWS CloudFormation stacks to define the resources in your operational application. AWS CloudFormation templates define and generate your resources for you. Specify the stacks that create your application resources when you configure DevOps Guru. You can update your stacks at any time. All of the resources in the stacks that you choose define your boundary coverage. For more information, see Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications. • Use AWS tags to specify AWS resources in your applications. DevOps Guru analyzes only the resources that contain the tags you choose. Those resources make up your boundary. An AWS tag consists of a tag key and a tag value. You can specify one tag key and you can specify one or more values with that key. Use one value for all the resources in one of your applications. If you have multiple applications, then use a tag with the same key for all of them, and group the resources into your applications using the tags' values. All of the resources with the tags that you choose make up the coverage boundary for DevOps Guru. For more information, see Using tags to identify resources in your DevOps Guru applications. If your boundary coverage includes resources that make up more than one application, you can use tags to filter your insights by to view them by one application at a time. For more information, see Step 4 in Viewing DevOps Guru insights. For more information, see Defining applications using AWS resources. For more information about the supported services and resources, see Amazon DevOps Guru pricing. Step 3 – Identify your Amazon SNS notifications topic You use one or two Amazon SNS topics to generate notifications about important DevOps Guru events, such as when an insight is created. This ensures you know about issues that DevOps Guru finds as soon as possible. Have your topics ready when you set up DevOps Guru. When you use the DevOps Guru console to set up DevOps Guru, you specify a notification topic using its name or its Amazon Resource Name (ARN). For more information, see Enable DevOps Guru. You can use the Amazon SNS console to view the name and ARN for each of your topics. If you don't have a topic, you can create one when you enable DevOps Guru using the DevOps Guru console. For more information, see Creating a topic in the Amazon Simple Notification Service Developer Guide. Identify your notifications topic 14 Amazon DevOps Guru User Guide Permissions added to your Amazon SNS topic An Amazon SNS topic is a resource that contains an AWS Identity and Access Management (IAM) resource policy. When you specify a topic here, DevOps Guru appends the following permissions to its resource policy. { "Sid": "DevOpsGuru-added-SNS-topic-permissions", "Effect": "Allow", "Principal": { "Service": "region-id.devops-guru.amazonaws.com" }, "Action": "sns:Publish", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Condition" : { "StringEquals" : { "AWS:SourceArn": "arn:aws:devops-guru:region-id:topic-owner-account- id:channel/devops-guru-channel-id", "AWS:SourceAccount": "topic-owner-account-id" } } } These permissions are required for DevOps Guru to publish notifications using a topic. If you prefer to not have these permissions on the topic, you can safely remove them and the topic will continue to work as it did before you chose it. However, if these appended permissions are removed, DevOps Guru cannot use the topic to generate notifications. Permissions added to your topic 15 Amazon DevOps Guru User Guide Estimating Amazon DevOps Guru resource analysis costs You can estimate your monthly cost for Amazon DevOps Guru to analyze your AWS resources. You pay for the number of hours analyzed for each active AWS resource in your specified resource coverage. A resource is active if it produces metrics, events, or logs within an hour. DevOps Guru scans your selected resources to create a monthly cost estimate. You can view the resources, their hourly billable price, and their estimated monthly charge. The cost estimator assumes as a default that the analyzed active resources are utilized 100 percent of the time. You can change this percentage for each analyzed service based on your estimated usage to create an updated monthly cost estimate. The estimate is for the cost to analyze your resources and does not include costs associated with DevOps Guru API calls. You can create one cost estimate at |
userguide-008 | userguide.pdf | 8 | events, or logs within an hour. DevOps Guru scans your selected resources to create a monthly cost estimate. You can view the resources, their hourly billable price, and their estimated monthly charge. The cost estimator assumes as a default that the analyzed active resources are utilized 100 percent of the time. You can change this percentage for each analyzed service based on your estimated usage to create an updated monthly cost estimate. The estimate is for the cost to analyze your resources and does not include costs associated with DevOps Guru API calls. You can create one cost estimate at a time. The time it takes to generate a cost estimate depends on the number of resources you specify when you create the cost estimate. When you specify a few resources, it can take 1 to 2 hours to complete. When you specify a lot of resources, it can take up to 4 hours to complete. Your actual costs vary and depend on the percentage of time your analyzed active resources are utilized. Note For a cost estimate, you can specify only one AWS CloudFormation stack. For your actual coverage boundary, you can specify up to 1000 stacks. To create a monthly resource analysis cost estimate 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Cost estimator in the navigation pane. 3. If you have not enabled DevOps Guru, you must create an IAM role. In the Create IAM role for DevOps Guru popup window that appears, choose Agree to create IAM role. This allows DevOps Guru to create an IAM service-linked role for you when you choose to begin the cost estimate analysis or begin using DevOps Guru. That way, DevOps Guru has the permissions needed to create the cost estimate. If you have already enabled DevOps Guru, the role has already been created and this option does not appear. 4. Choose the resources you want to use to create your estimate. 16 Amazon DevOps Guru User Guide • If you want to estimate the cost for DevOps Guru to analyze the resources defined by one AWS CloudFormation stack, do the following. 1. Choose CloudFormation stack in the current Region. 2. In Choose a CloudFormation stack, choose the name of an AWS CloudFormation stack in your AWS account. You can also enter the name of a stack to find it quickly. For information about working with and viewing your stacks, see Working with stacks in the AWS CloudFormation User Guide. 3. (Optional) If you use an AWS CloudFormation stack that you are currently not analyzing, choose Enable resource analysis to enable DevOps Guru to start analyzing its resources. This option is not available if you have not enabled DevOps Guru or if you are already analyzing the resources in the stack. • If you want to estimate the cost for DevOps Guru to analyze resources with a tag, do the following. 1. Choose Tags on AWS resources in the current Region 2. In Tag key choose your tag's key 3. In Tag value choose (all values) or choose one value. • If you want to estimate the cost for DevOps Guru to analyze the resource in your AWS account and Region, choose AWS account in the current Region. 5. Choose Estimate monthly cost. 6. (Optional) In the Active resource utilization % column, enter an updated percentage value for one or more AWS services. The default active resource utilization % is 100%. This means that DevOps Guru generates the estimate for the AWS service by calculating the cost of one hour of analyzing its resources, then extrapolating that over 30 days for a total of 720 hours. If a service is active less than 100% of the time, you can update the percentage based on your estimated usage for a more accurate estimate. For example, if you update a service's active resource utilization to 75%, the one hour cost of analyzing its resources is extrapolated over (720 x 0.75) hours, or 540 hours. If your estimate is zero dollars, then the resources you chose likely do not include resources supported by DevOps Guru. For more information about the supported services and resources, see Amazon DevOps Guru pricing. 17 Amazon DevOps Guru User Guide Getting started with DevOps Guru In this section, you learn how to get started with Amazon DevOps Guru so it can analyze your application's operational data and metrics to generate insights. Topics • Step 1: Get set up • Step 2: Enable DevOps Guru • Step 3: Specify your DevOps Guru resource coverage Step 1: Get set up Before you get started, prepare by running through the steps in Setting up Amazon DevOps Guru. Step 2: Enable DevOps Guru To configure Amazon DevOps Guru to use for the first time, you must choose how you |
userguide-009 | userguide.pdf | 9 | Amazon DevOps Guru User Guide Getting started with DevOps Guru In this section, you learn how to get started with Amazon DevOps Guru so it can analyze your application's operational data and metrics to generate insights. Topics • Step 1: Get set up • Step 2: Enable DevOps Guru • Step 3: Specify your DevOps Guru resource coverage Step 1: Get set up Before you get started, prepare by running through the steps in Setting up Amazon DevOps Guru. Step 2: Enable DevOps Guru To configure Amazon DevOps Guru to use for the first time, you must choose how you want to set up DevOps Guru. You can either monitor applications across your organization or monitor applications in your current account. You can either monitor your applications across your organization or enable DevOps Guru for exclusively the current account. The following procedures outline different ways to set up DevOps Guru based on your needs. Monitor accounts across your organization If you choose to monitor applications across your organization, log into your organization management account. You can optionally set up an organization member account as a delegated administrator. You can only have one delegated administrator at a time and can modify the administrator settings later. Both the management account and the delegated administrator account that you set up have access to all insights across all accounts in your organization. You can either add cross account support for your organization using the Console, or you can do so by using the AWS CLI. Onboard with the DevOps Guru Console You can use the Console to add support for accounts across your organization. Step 1: Get set up 18 Amazon DevOps Guru User Guide Use the Console to enable DevOps Guru to view aggregated insights 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Monitor applications across your organizations as the setup type. 3. Choose which account you'd like to use as your delegated administrator. Then, choose Register delegated administrator. This provides access to a consolidated view for any account that has DevOps Guru enabled. The delegated administrator has a consolidated view of all DevOps Guru insights and metrics across your organization. You can enable other accounts with SSM quick setup or AWS CloudFormation stack sets. To learn more about quick setup, see Configure DevOps Guru with Quick Setup. To learn more about setting up with stack sets, see Working with stacks in the AWS CloudFormation User Guide, and Step 2 – Determine coverage for DevOps Guru. and Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications. Onboard with the AWS CLI You can use the AWS CLI to enable DevOps Guru to view aggregated insights. Run the following commands. aws iam create-service-linked-role --aws-service-name devops-guru.amazonaws.com -- description "My service-linked role to support DevOps Guru" aws organizations enable-aws-service-access --service-principal devops- guru.amazonaws.com aws organizations register-delegated-administrator --account-id >ACCOUNT_ID< --service- principal devops-guru.amazonaws.com The following table describes the commands. Command Description create-service-linked-role Gives DevOps Guru permission to gather information about your organization. Don't proceed if this step is not successful. Onboards your organization to DevOps Guru. Monitor accounts across your organization 19 Amazon DevOps Guru Command enable-aws-service-access Description User Guide register-delegated-administrator Gives access to the member account to view insights. Monitor your current account If you choose to monitor applications in your current AWS account, choose which AWS resources in your account and Region are covered or analyzed and specify one or two Amazon Simple Notification Service topics that are used to notify you when an insight is created. You can update these settings later as needed. Enable DevOps Guru to monitor applications in your current AWS account 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Monitor applications in the current AWS account as the setup type. 3. In DevOps Guru analysis coverage, choose one of the following. • Analyze all AWS resources in the current AWS account: DevOps Guru analyzes all AWS resources in your account. • Choose AWS resources to analyze later: You choose your analysis boundary later. For more information, see Determine coverage for DevOps Guru and Updating your AWS analysis coverage in DevOps Guru. DevOps Guru can analyze any resource that is associated with the AWS account it supports. For more information about the supported services and resources, see Amazon DevOps Guru pricing. 4. You can add up to two topics. DevOps Guru uses the topic or topics to notify you about important DevOps Guru events, such as the creation of a new insight. If you don't specify a topic now, you can add one later by choosing Settings in the navigation pane. a. b. In Specify an Amazon SNS topic, choose a topic to use. To add an Amazon SNS topic, do one of the following. Monitor your current account 20 Amazon DevOps Guru User |
userguide-010 | userguide.pdf | 10 | account it supports. For more information about the supported services and resources, see Amazon DevOps Guru pricing. 4. You can add up to two topics. DevOps Guru uses the topic or topics to notify you about important DevOps Guru events, such as the creation of a new insight. If you don't specify a topic now, you can add one later by choosing Settings in the navigation pane. a. b. In Specify an Amazon SNS topic, choose a topic to use. To add an Amazon SNS topic, do one of the following. Monitor your current account 20 Amazon DevOps Guru User Guide • Choose Generate a new SNS topic using email. Then, from Specify the email address, enter the email address you want to receive notifications. To enter in additional email addresses, choose Add new email. • Choose Use an existing SNS topic. Then, from Choose a topic in your AWS account, choose the topic you want to use. • Choose Use an existing SNS topic ARN to specify an existing topic from another account. Then, in Enter an ARN for a topic, enter the topic ARN. The ARN is the topic's Amazon Resource Name. You can specify a topic in a different account. If you use a topic in another account, you must add a resource policy to the topic. For more information, see Permissions for Amazon SNS topics. 5. Choose Enable. To configure Amazon DevOps Guru to use for the first time, you must choose which AWS resources in your account and Region is covered, or analyzed, and specify one or two Amazon Simple Notification Service topics that are used to notify you when an insight is created. You can update these settings later as needed. Step 3: Specify your DevOps Guru resource coverage If you chose to specify AWS resources later when you enabled DevOps Guru, you need to choose the AWS CloudFormation stacks in your AWS account that create the resources you want analyzed. An AWS CloudFormation stack is a collection of AWS resources that you manage as a single unit. You can use one or more stacks to include all the resources required to run your operational applications, then specify them so that they are analyzed by DevOps Guru. If you don't specify stacks, then DevOps Guru analyzes all the AWS resources in your account. For more information, see Working with stacks in the AWS CloudFormation User Guide, and Determine coverage for DevOps Guru. and Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications. Note For more information about supported services and resources, see Amazon DevOps Guru pricing. Step 3: Specify your DevOps Guru resource coverage 21 Amazon DevOps Guru User Guide Specify DevOps Guru resource coverage 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. 3. Expand Settings in the navigation pane. In Analyzed resources, choose Edit analyzed resources. 4. Choose one of the following coverage options. • Choose All account resources if you want DevOps Guru to analyze all supported resources in your AWS account and Region. If you choose this option, your AWS account is your resource analysis coverage boundary. All resources in each stack in your account are grouped into their own application. Any remaining resources that are not in a stack are grouped into their own application. • Choose CloudFormation stacks if you want DevOps Guru to analyze the resources that are in stacks you choose, then choose one of the following options. • All resources – All resources that are in stacks in your account are analyzed. Resources in each stack are grouped into their own application. Any resources in your account that are not in a stack are not analyzed. • Select stacks – Select the stacks that you want DevOps Guru to analyze. The resources in each stack you select are grouped into their own application. You can enter the name of a stack in Find stacks to quickly locate a specific stack. You can select up to 1,000 stacks. For more information, see Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications. • Choose Tags if you want DevOps Guru to analyze all resources that contain the tags you choose. Choose a key, then choose one of the following options. • All account resources –Analyze all AWS resources in the current Region and account. Resources with the selected tag key are grouped by tag value, if any exist. Resources without this tag key are grouped and analyzed separately. • Choose specific tag values – All resources that contain a tag with the key you chose are analyzed. DevOps Guru groups your resources into applications by your tag's values. For more information, see Using tags to identify resources in your DevOps Guru applications. • Choose None if you do not want |
userguide-011 | userguide.pdf | 11 | Choose a key, then choose one of the following options. • All account resources –Analyze all AWS resources in the current Region and account. Resources with the selected tag key are grouped by tag value, if any exist. Resources without this tag key are grouped and analyzed separately. • Choose specific tag values – All resources that contain a tag with the key you chose are analyzed. DevOps Guru groups your resources into applications by your tag's values. For more information, see Using tags to identify resources in your DevOps Guru applications. • Choose None if you do not want DevOps Guru to analyze any resources. This option disables DevOps Guru so that you stop incurring charges from resource analyzation. 5. Choose Save. Step 3: Specify your DevOps Guru resource coverage 22 Amazon DevOps Guru User Guide Enabling AWS services for DevOps Guru analysis Amazon DevOps Guru can analyze the performance of any AWS resource that it supports. When it finds anomalous behavior, it generates an insight with details about the behavior and how to address it. For more information about the supported services and resources, see Amazon DevOps Guru pricing. DevOps Guru uses Amazon CloudWatch metrics, AWS CloudTrail events, and more to help analyze resources. Most of the resources it supports generate the metrics required for DevOps Guru analysis automatically. However, a few AWS services require extra action to generate the required metrics. For some services, enabling these metrics provides additional analysis to existing DevOps Guru coverage. For others, analysis is not possible until you enable these metrics. For more information, see Determine coverage for DevOps Guru and Updating your AWS analysis coverage in DevOps Guru. Services that require action for DevOps Guru analysis • Amazon Elastic Container Service – To generate additional metrics that improve DevOps Guru coverage of its resources, follow the steps in Setting up container insights on Amazon ECS. Doing this might incur Amazon CloudWatch charges. • Amazon Elastic Kubernetes Service – To generate metrics for DevOps Guru to analyze, follow the steps in Setting up container insights on Amazon EKS and Kubernetes. DevOps Guru doesn't analyze any Amazon EKS resources until generation of these metrics is set up. Doing this might incur Amazon CloudWatch charges. • Amazon Simple Storage Service – To generate metrics for DevOps Guru to analyze, you must enable request metrics. Follow the steps in Creating a CloudWatch metrics configuration for all the objects in your bucket. DevOps Guru doesn’t analyze any Amazon S3 resources until generation of these metrics is set up. Doing this might incur CloudWatch and Amazon S3 charges. For more information, see Amazon CloudWatch pricing. 23 Amazon DevOps Guru User Guide Working with insights in DevOps Guru Amazon DevOps Guru generates an insight when it detects anomalous behavior in your operational applications. DevOps Guru analyzes the metrics, events, and more in the AWS resources you specified when you set up DevOps Guru. Each insight contains one or more recommendations for you to take to mitigate the issue. It also contains a list of the metrics, a list of log groups, and a list of the events that were used to identify the unusual behavior. There are two insight types. • Reactive insights have recommendations you can take to address issues that are happening now. • Proactive insights have recommendations that address issues that DevOps Guru predicts will occur in the future. Topics • Viewing DevOps Guru insights • Understanding insights in the DevOps Guru console • Understanding how anomalous behaviors are grouped into insights • Understanding insight severities Viewing DevOps Guru insights You can view your insights using the AWS Management Console. View your DevOps Guru insights 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Open the navigation pane, then choose Insights. 3. On the Reactive tab, you can see a list of reactive insights. On the Proactive tab, you can see a list of proactive insights. 4. (Optional) Use one or more of the following filters to find the insights you are looking for. • Choose the Reactive or Proactive tab, depending on the type of insight for which you are looking. Viewing insights 24 Amazon DevOps Guru User Guide • Choose Filter insights, then choose an option to specify a filter. You can add a combination of status, severity, resource, and tag filters. Use an AWS tag filter to view insights generated by only resources with specific tags. To learn more, see Using tags to identify resources in your DevOps Guru applications. Note DevOps Guru can analyze the following resources, but can't filter their insights using tags. • Amazon API Gateway paths and routes • Amazon DynamoDB streams • Amazon EC2 Auto Scaling group instances • AWS Elastic Beanstalk environments • Amazon Redshift nodes • Choose or specify a time range to filter |
userguide-012 | userguide.pdf | 12 | then choose an option to specify a filter. You can add a combination of status, severity, resource, and tag filters. Use an AWS tag filter to view insights generated by only resources with specific tags. To learn more, see Using tags to identify resources in your DevOps Guru applications. Note DevOps Guru can analyze the following resources, but can't filter their insights using tags. • Amazon API Gateway paths and routes • Amazon DynamoDB streams • Amazon EC2 Auto Scaling group instances • AWS Elastic Beanstalk environments • Amazon Redshift nodes • Choose or specify a time range to filter by insight creation time. • 12h shows insights created in the past 12 hours. • 1d shows insights created in the past day. • 1w shows insights created in the past week. • 1m shows insights created in the past month. • Custom lets you specify another time range. The maximum time range you can use to filter insights is 180 days. 5. To view details about an insight, choose its name. Understanding insights in the DevOps Guru console Use the Amazon DevOps Guru console to view useful information in your insights to help you diagnose and address anomalous behavior. When DevOps Guru analyzes your resources and finds related Amazon CloudWatch metrics, AWS CloudTrail events, and operational data that indicate unusual behavior, it creates an insight that contains recommendations to address the issue and information about the related metrics and events. Use insight data with Best practices in DevOps Guru to address operational problems detected by DevOps Guru. Understanding insights in the DevOps Guru console 25 Amazon DevOps Guru User Guide To view an insight, follow the steps in Viewing insights to find one, then choose its name. The insight page contains the following details. Insight overview Use this section to get a high-level overview of the insight. You can see the status of the insight (Ongoing or Closed), how many AWS CloudFormation stacks are affected, when the insight started, ended, and was last updated, and the related operations item if there is one. If an insight is grouped at the stack level, then you can choose the number of affected stacks to see their names. The anomalous behavior that created the insight occurred in resources created by the affected stacks. If an insight is grouped at the account level, then the number is zero or does not appear. For more information, see Understanding how anomalous behaviors are grouped into insights. Insight name The name of an insight depends on whether it is grouped at the stack level or the account level. • Stack level insight names include the name of the stack that contains the resource with its anomalous behavior. • Account level insight names do not include a stack name. For more information, see Understanding how anomalous behaviors are grouped into insights. Aggregated metrics Choose the Aggregated metrics tab to view metrics that are related to the insight. In the table, each row represents one metric. You can see which AWS CloudFormation stack created the resource that emitted the metric, the name of the resource, and its type. Not all metrics are associated with an AWS CloudFormation stack or have a name. When there are multiple resources anomalous at the same time, the timeline view aggregates the resources and presents their anomalous metrics in a single timeline for easy analysis. The red lines on a timeline indicate spans of time when a metric emitted unusual values. To zoom in, use your mouse to choose a specific time range. You can also use the magnifying glass icons to zoom in and out. Choose a red line in the timeline to view detailed information. In the window that opens, you can: Understanding insights in the DevOps Guru console 26 Amazon DevOps Guru User Guide • Choose View in CloudWatch to see how the metric looks in the CloudWatch console. For more information, see Statistics and Dimensions in the Amazon CloudWatch User Guide. • Hover over the graph to view details about the anomalous metric data and when it occurred. • Choose the box with the downward arrow to download a PNG image of the graph. Graphed anomalies Choose the Graphed anomalies tab to view detailed graphs for each of the insight's anomalies. One tile appears for each anomaly with details about unusual behavior detected in related metrics. You can investigate and look at an anomaly at the resource level and per statistic. The graphs are grouped by metric name. In each tile, you can choose a specific time range in the timeline to zoom. You can also use the magnifying glass icons to zoom in and out, or choose a predefined duration in hours, days, or weeks (1H, 3H, 12H, 1D, 3D, 1W, or 2W). Choose View all statistics and |
userguide-013 | userguide.pdf | 13 | anomalies tab to view detailed graphs for each of the insight's anomalies. One tile appears for each anomaly with details about unusual behavior detected in related metrics. You can investigate and look at an anomaly at the resource level and per statistic. The graphs are grouped by metric name. In each tile, you can choose a specific time range in the timeline to zoom. You can also use the magnifying glass icons to zoom in and out, or choose a predefined duration in hours, days, or weeks (1H, 3H, 12H, 1D, 3D, 1W, or 2W). Choose View all statistics and dimensions to see details about the anomaly. In the window that opens, you can: • Choose View in CloudWatch to see how the metric looks in the CloudWatch console. • Hover over the graph to view details about the anomalous metric data and when it occurred. • Choose Statistics or Dimension to customize the graph's display. For more information, see Statistics and Dimensions in the Amazon CloudWatch User Guide. Log groups When you enable log anomaly detection, DevOps Guru tags your CloudWatch log groups so you can view log groups related to your insights. In the Log groups section on the insight details page, each row in the table represents one log group and lists the related resource. When there are multiple anomalous log groups at the same time, the timeline view aggregates them and presents them in a single timeline for easy analysis. The purple lines on a timeline indicate spans of time when a log group experienced log anomalies. Choose a purple line in the timeline to view a sample of log anomaly information such as keyword exceptions and numerical deviations. Choose View log group details to view log anomalies. In the window that opens, you can: • View a graph of log anomalies and relevant events. • Hover over the graph to view details about the anomalous log data and when it occurred. • View log anomalies in detail with sample messages, ocurrence frequency, related recommendations, and time of occurrence. Understanding insights in the DevOps Guru console 27 Amazon DevOps Guru User Guide • Click on View details in CloudWatch to view log lines from a log anomaly. Related events In Related events, view AWS CloudTrail events that are related to your insight. Use these events to help understand, diagnose, and address the underlying cause of the anomalous behavior. Recommendations In Recommendations, you can view suggestions that might help you resolve the underlying problem. When DevOps Guru detects anomalous behavior, it attempts to create recommendations. An insight might contain one, multiple, or zero recommendations. Understanding how anomalous behaviors are grouped into insights An insight is grouped at the stack level or the account level. If an insight is generated for a resource that is in an AWS CloudFormation stack, then it is a stack level insight. Otherwise, it is an account level insight. How a stack is grouped can depend on how you configured your resource analysis coverage in Amazon DevOps Guru. If your coverage is defined by AWS CloudFormation stacks All resources contained in the stacks you choose are analyzed, and all detected insights are grouped at the stack level. If your coverage is your current AWS account and Region All resources in your account and Region are analyzed, and there are three possible grouping scenarios for detected insights. • An insight generated from a resource that is not part of a stack is grouped at the account level. • An insight generated from a resource that is in one of the first 10,000 analyzed stacks is grouped at the stack level. • An insight generated from a resource that is not in one of the first 10,000 analyzed stacks is grouped at the account level. For example, an insight generated for a resource in the 10,001st analyzed stack is grouped at the account level. Understanding how anomalous behaviors are grouped into insights 28 Amazon DevOps Guru User Guide For more information, see Determine coverage for DevOps Guru. Understanding insight severities An insight can have one of three severities, high, medium, or low. An insight is created by Amazon DevOps Guru after it detects related anomalies and assigns each anomaly a severity. DevOps Guru assigns an anomaly a severity of high, medium, or low using domain knowledge and years of collective experience. An insight's severity is determined by the most severe anomaly that contributed to creating the insight. • If the severity of all the anomalies that generated the insight is low, then the insight's severity is low. • If the highest severity of all the anomalies that generated the insight is medium, then the insight's severity is medium. The severity of some of the anomalies that generated the insight might be low. • If the |
userguide-014 | userguide.pdf | 14 | and assigns each anomaly a severity. DevOps Guru assigns an anomaly a severity of high, medium, or low using domain knowledge and years of collective experience. An insight's severity is determined by the most severe anomaly that contributed to creating the insight. • If the severity of all the anomalies that generated the insight is low, then the insight's severity is low. • If the highest severity of all the anomalies that generated the insight is medium, then the insight's severity is medium. The severity of some of the anomalies that generated the insight might be low. • If the highest severity of all the anomalies that generated the insight is high, then the insight's severity is high. The severity of some of the anomalies that generated the insight might be low or medium. Understanding insight severities 29 Amazon DevOps Guru User Guide Monitoring databases using DevOps Guru DevOps Guru provides significant value for operating databases on AWS. By leveraging its machine learning algorithms, DevOps Guru can help optimize database performance, improve reliability, and reduce operational overhead. This section of the user guide provides a high-level overview of these database capabilities, including specific DevOps Guru use cases for different AWS database services. DevOps Guru can provide insights for relational databases such as Amazon RDS and Amazon Redshift. It can also provide insights for non-relational or NoSQL databases such as Amazon DynamoDB and Amazon ElastiCache. Topics • Monitoring relational databases using DevOps Guru • Monitoring non-relational databases using DevOps Guru Monitoring relational databases using DevOps Guru DevOps Guru pulls from two primary data sources to look for insights and anomalies in relational databases. For Amazon RDS and Amazon Redshift, CloudWatch vended metrics are analyzed for all instance types. For Amazon RDS, Performance Insights data is also ingested for the following engine types: RDS for PostgreSQL, Aurora PostgreSQL, and Aurora MySQL. Monitoring database operations in Amazon RDS This section includes specific information about use cases and metrics monitored in DevOps Guru for RDS, including data from CloudWatch vended metrics and Performance Insights. For more information about DevOps Guru for RDS, including key concepts, configurations, and benefits, see the section called “Working with anomalies in DevOps Guru for RDS”. Monitoring RDS using data from CloudWatch vended metrics DevOps Guru is capable of monitoring every type of RDS instance by ingesting default CloudWatch metrics, such as CPU utilization and read and write operation latency. Because these metrics are vended by default, when you monitor your RDS instances with DevOps Guru, no further configuration is required to gain insights. DevOps Guru automatically establishes a baseline Relational databases 30 Amazon DevOps Guru User Guide for these metrics based on historical patterns and compares them to real-time data to detect anomalies and potential issues in your database. The following table shows a list of potential reactive insights for Amazon RDS from CloudWatch vended metrics. AWS resource monitored by DevOps Guru Scenario that DevOps Guru identifies CloudWatch metrics monitored Amazon RDS (all instance types) CPU or memory reaching limits DBLoad, DBLoadCPU RDS for PostgreSQL High replication slot lag OldestReplicationSlotLag Additional CloudWatch vended metrics from Amazon RDS instances that DevOps Guru monitors: • CPUUtilization • DatabaseConnections • DiskQueueDepth • FailedSQLServerAgentJobsCount • ReadLatency • ReadThroughput • ReplicaLag • WriteLatency Monitoring RDS using data from Performance Insights For certain types of Amazon RDS instances, such as Aurora PostgreSQL, Aurora MySQL, and RDS for PostgreSQL, you unlock more capability from DevOps Guru monitoring by ensuring that Performance Insights is enabled on those instances. DevOps Guru provides reactive insights for a variety of situations, including the following scenarios: Scenario that DevOps Guru identifies to generate a reactive insight Locking contention issue Monitoring database operations in Amazon RDS 31 Amazon DevOps Guru User Guide Scenario that DevOps Guru identifies to generate a reactive insight Missing index Misconfiguration of application pool Suboptimal JDBC defaults DevOps Guru provides proactive insights for a variety of situations, including the following scenarios: AWS resource monitored by DevOps Guru Aurora MySQL Aurora MySQL RDS for PostgreSQL, Aurora PostgreSQL Scenario that DevOps Guru identifies to generate a proactive insight InnoDB history list growing too large, which can lead to degraded performance such as lengthy database shutdown time An increase in temporary tables created on disk that can impact database performance A connection that has been idle in transacti on for too long, potential impact of holding locks, blocking other queries, and preventing vacuum (including autovacuum) from cleaning up dead rows Monitoring database operations in Amazon Redshift DevOps Guru is capable of monitoring your Amazon Redshift resources by ingesting default CloudWatch metrics, including CPU utilization and the percentage of disk space used. Because these metrics are vended by default, no further configuration is required for DevOps Guru to automatically monitor your Amazon Redshift resources. DevOps Guru establishes a baseline for these metrics |
userguide-015 | userguide.pdf | 15 | tables created on disk that can impact database performance A connection that has been idle in transacti on for too long, potential impact of holding locks, blocking other queries, and preventing vacuum (including autovacuum) from cleaning up dead rows Monitoring database operations in Amazon Redshift DevOps Guru is capable of monitoring your Amazon Redshift resources by ingesting default CloudWatch metrics, including CPU utilization and the percentage of disk space used. Because these metrics are vended by default, no further configuration is required for DevOps Guru to automatically monitor your Amazon Redshift resources. DevOps Guru establishes a baseline for these metrics based on historical patterns and compares them to real-time data to detect anomalies. Monitoring database operations in Amazon Redshift 32 Amazon DevOps Guru User Guide Scenario that DevOps Guru identifies CloudWatch metrics monitored Detect high CPU utilization of an Amazon Redshift instance caused by factors such as cluster workload, skewed and unsorted data, or leader node tasks Detect when an Amazon Redshift instance is running out of disk space due to issues with query processing, distribution and sort key, maintenance operations, or tombstone blocks CPUUtilization PercentageDiskSpaceUsed Additional CloudWatch vended metrics from Amazon Redshift instances that DevOps Guru monitors: • DatabaseConnections • HealthStatus • MaintenanceMode • NumExceededSchemaQuotas • PercentageQuotaUsed • QueryDuration • QueryRuntimeBreakdown • ReadIOPS • ReadLatency • WLMQueueLength • WLMQueueWaitTime • WLMQueryDuration • WriteLatency Working with anomalies in DevOps Guru for RDS DevOps Guru detects, analyzes, and provides recommendations for supported AWS resources, including Amazon RDS engines. For Amazon Aurora and RDS for PostgreSQL database instances Working with anomalies in DevOps Guru for RDS 33 Amazon DevOps Guru User Guide with Performance Insights turned on, DevOps Guru for RDS provides detailed, database-specific analyses of performance issues and recommends corrective actions. Topics • Overview of DevOps Guru for RDS • Enabling DevOps Guru for RDS • Analyzing anomalies in Amazon RDS Overview of DevOps Guru for RDS Following, you can find a summary of the key benefits and features of DevOps Guru for RDS. For background on insights and anomalies, see DevOps Guru concepts. Topics • Benefits of DevOps Guru for RDS • Key concepts for database performance tuning • Key concepts for DevOps Guru for RDS • How DevOps Guru for RDS works • Supported database engines Benefits of DevOps Guru for RDS If you're responsible for an Amazon RDS database, you might not know that an event or regression that is affecting that database is occurring. When you learn about the issue, you might not know why it's occurring or what to do about it. Rather than turning to a database administrator (DBA) for help or relying on third-party tools, you can follow recommendations from DevOps Guru for RDS. You gain the following advantages from the detailed analysis of DevOps Guru for RDS: Fast diagnosis DevOps Guru for RDS continuously monitors and analyzes database telemetry. Performance Insights, Enhanced Monitoring, and Amazon CloudWatch collect telemetry data for your database instances. DevOps Guru for RDS uses statistical and machine learning techniques to mine this data and detect anomalies. To learn more about telemetry data for Amazon Aurora databases, see Monitoring DB load with Performance Insights on Amazon Aurora and Working with anomalies in DevOps Guru for RDS 34 Amazon DevOps Guru User Guide Monitoring the OS by using Enhanced Monitoring in the Amazon Aurora User Guide. To learn more about telemetry data for other Amazon RDS databases, see Monitoring DB load with Performance Insights on Amazon Relational Database Service and Monitoring OS metrics with Enhanced Monitoring in the Amazon RDS User Guide. Fast resolution Each anomaly identifies the performance issue and suggests avenues of investigation or corrective actions. For example, DevOps Guru for RDS might recommend that you investigate specific wait events. Or it might recommend that you tune your application pool settings to limit the number of database connections. Based on these recommendations, you can resolve performance issues more quickly than by troubleshooting manually. Proactive insights DevOps Guru for RDS uses metrics from your resources to detect potentially problematic behavior before it becomes a bigger problem. For example, it can detect when sessions connected to the database are not performing active work and might be keeping database resources blocked. DevOps Guru then provides recommendations to help you address issues before they become bigger problems. Deep knowledge of Amazon engineers and machine learning To detect performance issues and help you resolve bottlenecks, DevOps Guru for RDS relies on machine learning (ML) and advanced statistical analysis. Amazon database engineers contributed to the development of the DevOps Guru for RDS findings, which encapsulate many years of managing hundreds of thousands of databases. By drawing on this collective knowledge, DevOps Guru for RDS can teach you best practices. Key concepts for database performance tuning DevOps Guru for RDS assumes that you're familiar with a |
userguide-016 | userguide.pdf | 16 | Guru then provides recommendations to help you address issues before they become bigger problems. Deep knowledge of Amazon engineers and machine learning To detect performance issues and help you resolve bottlenecks, DevOps Guru for RDS relies on machine learning (ML) and advanced statistical analysis. Amazon database engineers contributed to the development of the DevOps Guru for RDS findings, which encapsulate many years of managing hundreds of thousands of databases. By drawing on this collective knowledge, DevOps Guru for RDS can teach you best practices. Key concepts for database performance tuning DevOps Guru for RDS assumes that you're familiar with a few key performance concepts. To learn more about these concepts, see Overview of Performance Insights in the Amazon Aurora User Guide or Overview of Performance Insights in the Amazon RDS User Guide. Topics • Metrics • Problem detection • DB load • Wait events Working with anomalies in DevOps Guru for RDS 35 Amazon DevOps Guru Metrics User Guide A metric represents a time-ordered set of data points. Think of a metric as a variable to monitor, and the data points as representing the values of that variable over time. Amazon RDS provides metrics in real time for the database and for the operating system (OS) that your DB instance runs on. You can view all the system metrics and process information for your Amazon RDS DB instances on the Amazon RDS console. DevOps Guru for RDS monitors and provides insights for some of these metrics. For more information, see Monitoring metrics in an Amazon Aurora cluster or Monitoring metrics in an Amazon Relational Database Service instance. Problem detection DevOps Guru for RDS employs database and operating system (OS) metrics to detect critical database performance issues, whether those issues are impending or ongoing. There are 2 primary ways DevOps Guru for RDS problem detection works: • Using thresholds • Using anomalies Detecting problems with thresholds Thresholds are the bounding values against which the monitored metrics are evaluated. You can think of a threshold as a horizontal line on a metric chart that separates normal behavior from potentially problematic behavior. DevOps Guru for RDS monitors specific metrics and creates thresholds by analyzing what levels are considered potentially problematic for a specified resource. DevOps Guru for RDS then creates insights in the DevOps Guru console when new metric values cross a specified threshold over a given period of time on a consistent basis. The insights contain recommendations to prevent future database performance impact. For example, DevOps Guru for RDS might monitor the number of temporary tables using disk over a period of 15 minutes and create an insight when the rate of temporary tables using disk per second is abnormally high. Increased levels of on-disk temporary table usage might impact the database performance. By exposing this situation before it becomes critical, DevOps Guru for RDS helps you take corrective actions to prevent problems. Detecting problems with anomalies While thresholds provide a simple and effective way to detect database problems, in some situations they are not sufficient. Consider a case where metric values are spiking and crossing into Working with anomalies in DevOps Guru for RDS 36 Amazon DevOps Guru User Guide potentially problematic behavior on a regular basis because of a known process, such as a daily reporting job. Since such spikes are expected, creating insights and notifications for each of them would be counterproductive and would likely lead to alert fatigue. However, it is still necessary to detect spikes that are highly unusual, since metrics that are much higher than the rest or last much longer could represent real database performance issues. To address this concern, DevOps Guru for RDS monitors certain metrics to detect when a metric’s behavior becomes highly unusual or anomalous. DevOps Guru then reports these anomalies in insights. For example, DevOps Guru for RDS might create an insight when DB load is not only high, but also significantly deviates from its usual behavior, which indicates a major unexpected slowdown of database operations. By recognizing only the anomalous DB load spikes, DevOps Guru for RDS lets you focus on the issues that are truly important. DB load The key concept for database tuning is the database load (DB load) metric. The DB load represents how busy your database is at any given time. An increase in DB load means an increase in database activity. A database session represents an application's dialogue with a relational database. An active session is a session that is in the process of running a database request. A session is active when it's either running on CPU or waiting for a resource to become available so that it can proceed. For example, an active session might wait for a page to be read into memory, and then consume CPU while it reads data from |
userguide-017 | userguide.pdf | 17 | load) metric. The DB load represents how busy your database is at any given time. An increase in DB load means an increase in database activity. A database session represents an application's dialogue with a relational database. An active session is a session that is in the process of running a database request. A session is active when it's either running on CPU or waiting for a resource to become available so that it can proceed. For example, an active session might wait for a page to be read into memory, and then consume CPU while it reads data from the page. The DBLoad metric in Performance Insights is measured in average active sessions (AAS). To calculate AAS, Performance Insights samples the number of active sessions every second. For a specific time period, the AAS is the total number of active sessions divided by the total number of samples. An AAS value of 2 means that, on average, 2 sessions were active in requests at any given time. An analogy for DB load is activity in a warehouse. Suppose that the warehouse employs 100 workers. If 1 order comes in, 1 worker fulfills the order while the other workers are idle. If 100 or more orders come in, all 100 workers fulfill orders simultaneously. If you periodically sample how many workers are active over a given time period, you can calculate the average number of active workers. The calculation shows that, on average, N workers are busy fulfilling orders at any given time. If the average was 50 workers yesterday and 75 workers today, the activity level in the warehouse increased. In the same way, DB load increases as session activity increases. Working with anomalies in DevOps Guru for RDS 37 Amazon DevOps Guru User Guide To learn more, see Database load in the Amazon Aurora User Guide or Database load in the Amazon RDS User Guide. Wait events A wait event is a type of database instrumentation that tells you which resource a database session is waiting for so it can proceed. When Performance Insights counts active sessions to calculate database load, it also records the wait events that are causing the active sessions to wait. This technique allows Performance Insights to show you which wait events are contributing to DB load. Every active session is either running on the CPU or waiting. For example, sessions consume CPU when they search memory, perform a calculation, or run procedural code. When sessions aren't consuming CPU, they might be waiting for a data file to be read or a log to be written to. The more time that a session waits for resources, the less time it runs on the CPU. When you tune a database, you often try to find the resources that sessions are waiting for. For example, two or three wait events might account for 90% of DB load. This measure means that, on average, active sessions are spending most of their time waiting for a small number of resources. If you can find out the cause of these waits, you can try to remedy the problem. Consider the analogy of a warehouse worker. An order comes in for a book. The worker might be delayed in fulfilling the order. For example, a different worker might be currently restocking the shelves, or a trolley might not be available. Or the system used to enter the order status might be slow. The longer the worker waits, the longer the order takes to fulfill. Waiting is a natural part of the warehouse workflow, but if wait time become excessive, productivity decreases. In the same way, repeated or lengthy session waits can degrade database performance. For more information about wait events in Amazon Aurora, see Tuning with wait events for Aurora PostgreSQL and Tuning with wait events for Aurora MySQL in the Amazon Aurora User Guide. For more information about wait events in other Amazon RDS databases, see Tuning with wait events for RDS for PostgreSQL in the Amazon RDS User Guide. Key concepts for DevOps Guru for RDS An insight is generated by DevOps Guru when it detects anomalous or problematic behavior in your operational applications. An insight contains anomalies for one or more resources. An anomaly represents one or more related metrics detected by DevOps Guru that are unexpected or unusual. An insight has a severity of high, medium, or low. The insight severity is determined by the most severe anomaly that contributed to creating the insight. For example, if the insight AWS- Working with anomalies in DevOps Guru for RDS 38 Amazon DevOps Guru User Guide ECS_MemoryUtilization_and_others includes one anomaly with low severity and another with high severity, the overall severity of the insight is high. If Amazon RDS DB instances have Performance Insights turned on, DevOps Guru |
userguide-018 | userguide.pdf | 18 | for one or more resources. An anomaly represents one or more related metrics detected by DevOps Guru that are unexpected or unusual. An insight has a severity of high, medium, or low. The insight severity is determined by the most severe anomaly that contributed to creating the insight. For example, if the insight AWS- Working with anomalies in DevOps Guru for RDS 38 Amazon DevOps Guru User Guide ECS_MemoryUtilization_and_others includes one anomaly with low severity and another with high severity, the overall severity of the insight is high. If Amazon RDS DB instances have Performance Insights turned on, DevOps Guru for RDS provides detailed analysis and recommendations in the anomalies for these instances. To identify an anomaly, DevOps Guru for RDS develops a baseline for database metric values. DevOps Guru for RDS then compares current metric values to the historical baseline. Topics • Proactive insights • Reactive insights • Recommendations Proactive insights A proactive insight lets you know about problematic behavior before it occurs. It contains anomalies with recommendations and related metrics to help you address the issues before they become bigger problems. Each proactive insight page provides details about one anomaly. Reactive insights A reactive insight identifies anomalous behavior as it occurs. It contains anomalies with recommendations, related metrics, and events to help you understand and address the issues now. Causal anomalies A causal anomaly is a top-level anomaly within a reactive insight. It is shown as the Primary metric on the anomaly details page in the DevOps Guru console.Database load (DB load) is the causal anomaly for DevOps Guru for RDS. For example, the insight AWS- ECS_MemoryUtilization_and_others could have several metric anomalies, one of which is Database load (DB load) for the resource AWS/RDS. Within an insight, the anomaly Database load (DB load) can occur for multiple Amazon RDS DB instances. The severity of the anomaly might be different for each DB instance. For example, the severity for one DB instance might be high while the severity for the others is low. The console defaults to the anomaly with the highest severity. Working with anomalies in DevOps Guru for RDS 39 Amazon DevOps Guru Contextual anomalies User Guide A contextual anomaly is a finding within Database load (DB load) that is related to a reactive insight. It is displayed in the Related metrics section of the anomaly details page in the DevOps Guru console. Each contextual anomaly describes a specific Amazon RDS performance issue that requires investigation. For example, a causal anomaly can include the following contextual anomalies: • CPU capacity exceeded – The CPU run queue or CPU utilization are above normal. • Database memory low – Processes don't have enough memory. • Database connections spiked – The number of database connections is above normal. Recommendations Each insight has at least one suggested action. The following examples are recommendations generated by DevOps Guru for RDS: • Tune SQL IDs list_of_IDs to reduce CPU usage, or upgrade the instance type to increase CPU capacity. • Review the associated spike of current database connections. Consider tuning the application pool settings to avoid frequent dynamic allocation of new database connections. • Look for SQL statements that perform excessive memory operations, such as in-memory sorting or large joins. • Investigate the heavy I/O usage for the following SQL IDs: list_of_IDs. • Check for statements that create large amounts of temporary data, for example those that perform large sorts or use large temporary tables. • Check applications to see what is causing the increase in database workload. • Consider enabling the MySQL Performance Schema. • Check for long-running transactions and end them with a commit or rollback. • Configure the idle_in_transaction_session_timeout parameter to end any session that has been in the 'idle in transaction' state for longer than the specified time. How DevOps Guru for RDS works DevOps Guru for RDS collects metric data, analyzes it, and then publishes anomalies in the dashboard. Working with anomalies in DevOps Guru for RDS 40 Amazon DevOps Guru Topics • Data collection and analysis • Anomaly publication Data collection and analysis User Guide DevOps Guru for RDS collects data about your Amazon RDS databases from Amazon RDS Performance Insights. This feature monitors Amazon RDS DB instances, collects metrics, and makes it possible for you to explore the metrics in a chart. The most important performance metric is DBLoad. DevOps Guru for RDS consumes Performance Insights metrics and analyzes them to detect anomalies. For more information about Performance Insights, see Monitoring DB load with Performance Insights on Amazon Aurora in the Amazon Aurora User Guide or Monitoring DB load with Performance Insights on Amazon RDS in the Amazon RDS User Guide. DevOps Guru for RDS uses machine learning and advanced statistical analysis to analyze the data that it collects from Performance Insights. If DevOps Guru for |
userguide-019 | userguide.pdf | 19 | instances, collects metrics, and makes it possible for you to explore the metrics in a chart. The most important performance metric is DBLoad. DevOps Guru for RDS consumes Performance Insights metrics and analyzes them to detect anomalies. For more information about Performance Insights, see Monitoring DB load with Performance Insights on Amazon Aurora in the Amazon Aurora User Guide or Monitoring DB load with Performance Insights on Amazon RDS in the Amazon RDS User Guide. DevOps Guru for RDS uses machine learning and advanced statistical analysis to analyze the data that it collects from Performance Insights. If DevOps Guru for RDS finds performance issues, it proceeds to the next step. Anomaly publication A database performance issue such as high DB load can degrade the quality of service for your database. When DevOps Guru detects an issue in an RDS database, it publishes an insight in the dashboard. The insight contains an anomaly for the resource AWS/RDS. If Performance Insights is turned on for your instances, the anomaly contains a detailed analysis of the problem. DevOps Guru for RDS also recommends that you perform an investigation or specific corrective action. For example, the recommendation might be to investigate a specific high-load SQL statement, consider increasing CPU capacity, or to close idle-in-transaction sessions. Supported database engines DevOps Guru for RDS is supported for the following database engines: Amazon Aurora with MySQL compatibility To learn more about this engine, see Working with Amazon Aurora MySQL in the Amazon Aurora User Guide. Working with anomalies in DevOps Guru for RDS 41 Amazon DevOps Guru User Guide Amazon Aurora with PostgreSQL compatibility To learn more about this engine, see Working with Amazon Aurora PostgreSQL in the Amazon Aurora User Guide. Amazon RDS for PostgreSQL compatibility To learn more about this engine, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide. DevOps Guru reports anomalies and gives basic analysis for other database engines. DevOps Guru for RDS gives detailed analysis and recommendations only for Amazon Aurora and RDS for PostgreSQL instances. Enabling DevOps Guru for RDS When you enable DevOps Guru for RDS, you enable DevOps Guru to analyze anomalies in resources such as DB instances. Amazon RDS makes it easy to discover and enable recommended functionality for an RDS DB instance or DB cluster. To achieve this, RDS makes API calls to other services, such as Amazon EC2, DevOps Guru, and IAM. When the RDS console makes these API calls, AWS CloudTrail logs them for visibility. To allow DevOps Guru to publish insights for an Amazon RDS database, complete the tasks in the following sections. Topics • Turning on Performance Insights for your Amazon RDS DB instances • Configuring access policies for DevOps Guru for RDS • Adding Amazon RDS DB instances to your DevOps Guru coverage Turning on Performance Insights for your Amazon RDS DB instances For DevOps Guru for RDS to analyze anomalies on a DB instance, make sure that Performance Insights is turned on. If Performance Insights isn't turned on for a DB instance, DevOps Guru for RDS notifies you in the following places: Dashboard If you view insights by resource type, the RDS tile alerts you that Performance Insights isn't turned on. Choose the link to turn on Performance Insights in the Amazon RDS console. Working with anomalies in DevOps Guru for RDS 42 Amazon DevOps Guru Insights User Guide In the Recommendations section at the bottom of the page, choose Enable Amazon RDS Performance Insights. Settings In the Service: Amazon RDS section, choose the link to turn on Performance Insights in the Amazon RDS console. For more information, see Turning Performance Insights on and off in the Amazon Aurora User Guide, or Turning Performance Insights on and off in the Amazon RDS User Guide. Configuring access policies for DevOps Guru for RDS For a user to access DevOps Guru for RDS, they must have permissions from either of the following policies: • The AWS managed policy AmazonRDSFullAccess • A customer managed policy that allows the following actions: • pi:GetResourceMetrics • pi:DescribeDimensionKeys • pi:GetDimensionKeyDetails For more information, see Configuring access policies for Performance Insights in the Amazon Aurora User Guide or Configuring access policies for Performance Insights in the Amazon RDS User Guide. Adding Amazon RDS DB instances to your DevOps Guru coverage You can configure DevOps Guru to monitor your Amazon RDS databases either in the DevOps Guru console or the Amazon RDS console. In the DevOps Guru console, you have the following options: • Turn on DevOps Guru at the account level. This is the default. When you choose this option, DevOps Guru analyzes all supported AWS resources in your AWS Region and AWS account, including Amazon RDS databases. • Specify AWS CloudFormation stacks for DevOps Guru for RDS. Working with anomalies in DevOps Guru for RDS |
userguide-020 | userguide.pdf | 20 | Amazon RDS User Guide. Adding Amazon RDS DB instances to your DevOps Guru coverage You can configure DevOps Guru to monitor your Amazon RDS databases either in the DevOps Guru console or the Amazon RDS console. In the DevOps Guru console, you have the following options: • Turn on DevOps Guru at the account level. This is the default. When you choose this option, DevOps Guru analyzes all supported AWS resources in your AWS Region and AWS account, including Amazon RDS databases. • Specify AWS CloudFormation stacks for DevOps Guru for RDS. Working with anomalies in DevOps Guru for RDS 43 Amazon DevOps Guru User Guide For more information, see Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications. • Tag your Amazon RDS resources. A tag is a custom attribute label that you assign to an AWS resource. Use tags to identify the AWS resources that make up your application. You can then filter your insights by tag to view only those created by your application. To view only insights generated by the Amazon RDS resources in your application, add a value such as Devops-guru-rds to your Amazon RDS resource tags. For more information, see Using tags to identify resources in your DevOps Guru applications. Note When you tag Amazon RDS resources, you must tag the database instance and not the cluster. To enable DevOps Guru monitoring from the Amazon RDS console, see Turning on DevOps Guru in the RDS console. Note that to enable DevOps Guru from the Amazon RDS console you must use tags. For more information about tags, see the section called “Using tags to identify resources in your applications”. Analyzing anomalies in Amazon RDS When DevOps Guru for RDS publishes a performance anomaly in the dashboard, you typically perform the following steps: 1. View the insight in the DevOps Guru dashboard. DevOps Guru for RDS reports both reactive and proactive insights. For more information, see Viewing insights. 2. View anomalies for AWS/RDS resources. For more information, see Viewing reactive anomalies and Viewing proactive anomalies. 3. Respond to DevOps Guru for RDS recommendations. For more information, see Responding to recommendations. Working with anomalies in DevOps Guru for RDS 44 Amazon DevOps Guru User Guide 4. Monitor the health of your DB instances to make sure that resolved performance problems don't recur. For more information, see Monitoring metrics in an Amazon Aurora DB cluster in the Amazon Aurora User Guide and Monitoring metrics in an Amazon RDS instance in the Amazon RDS User Guide. Viewing insights Access the Insights page in the DevOps Guru console to find reactive and proactive insights. From there, you can choose an insight from the list to view a detailed page of metrics, recommendations, and more information about the insight. To view an insight 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Open the navigation pane, and then choose Insights. 3. Choose the Reactive tab to view reactive insights, or choose Proactive to view proactive insights. 4. Choose the name of an insight, prioritizing by status and severity. The detailed insight page appears. Viewing reactive anomalies Within an insight, you can view anomalies for Amazon RDS resources. On a reactive insight page, in the Aggregated metrics section, you can view a list of anomalies with corresponding timelines. There are also sections that display information about log groups and events related to the anomalies. Causal anomalies in a reactive insight each have a corresponding page with details about the anomaly. Viewing the detailed analysis of an RDS reactive anomaly In this stage, drill down in the anomaly to get the detailed analysis and recommendations for your Amazon RDS DB instances. The detailed analysis is only available for Amazon RDS DB instances that have Performance Insights turned on. Working with anomalies in DevOps Guru for RDS 45 Amazon DevOps Guru User Guide To drill down to the anomaly details page 1. On the insight page, find an aggregated metric with the resource type AWS/RDS. 2. Choose View details. The anomaly details page appears. The title begins with Database performance anomaly and names the resource show. The console defaults to the anomaly with the highest severity, regardless of when the anomaly occurred. 3. (Optional) If multiple resources are affected, choose a different resource from the list at the top of the page. Following, you can find descriptions for the components of the details page. Resource overview The top section of the details page is Resource overview. This section summarizes the performance anomaly experienced by your Amazon RDS DB instance. This section has the following fields: • Resource name – The name of the DB instance that is experiencing the anomaly. In this example, the resource is named prod_db_678. • DB engine – The name of the DB instance that experiencing |
userguide-021 | userguide.pdf | 21 | anomaly occurred. 3. (Optional) If multiple resources are affected, choose a different resource from the list at the top of the page. Following, you can find descriptions for the components of the details page. Resource overview The top section of the details page is Resource overview. This section summarizes the performance anomaly experienced by your Amazon RDS DB instance. This section has the following fields: • Resource name – The name of the DB instance that is experiencing the anomaly. In this example, the resource is named prod_db_678. • DB engine – The name of the DB instance that experiencing the anomaly. In this example, the engine is Aurora MySQL. • Anomaly severity – The measure of the negative impact of the anomaly on your instance. Possible severities are High, Medium, and Low. • Anomaly summary – A brief summary of the issue. A typical summary is Unusually high DB load. • Start time and End time – The time when the anomaly began and ended. If the end time is Ongoing, the anomaly is still occurring. Working with anomalies in DevOps Guru for RDS 46 Amazon DevOps Guru User Guide • Duration – The duration of the anomalous behavior. In this example, the anomaly is ongoing and has been occurring for 3 hours and 2 minutes. Primary metric The Primary metric section summarizes the casual anomaly, which is the top-level anomaly within the insight. You can think of the causal anomaly as the general problem experienced by your DB instance. The left panel provides more details about the issue. In this example, the summary includes the following information: • Database load (DB load) – A categorization of the anomaly as a database load issue. The corresponding metric in Performance Insights is DBLoad. This metric is also published to Amazon CloudWatch. • db.r5.4xlarge – The DB instance class. The number of vCPUs, which is 16 in this example, corresponds to the dotted line in the Average active sessions (AAS) chart. • 24 (6x spike) – The DB load, measured in average active sessions (AAS) during the time interval reported in the insight. Thus, at any given time during the period of the anomaly, an average of 24 sessions were active on the database. The DB load is 6 times the normal DB load for this instance. • Typically: DB load up to 4 – The baseline of DB load, measured in AAS, during a typical workload. The value 4 means that, during normal operations, an average of 4 or fewer sessions are active on the database at any given time. By default, the load chart is sliced by wait events. This means that for each bar in the chart, the largest colored area represents the wait event that is contributing most to total DB load. The chart Working with anomalies in DevOps Guru for RDS 47 Amazon DevOps Guru User Guide shows the time (in red) when the issue began. Focus your attention on the wait events that take up the most space in the bar: • CPU • IO:wait/io/sql/table/handler The preceding wait events appear more than normal for this Aurora MySQL database. To learn how to tune performance using wait events in Amazon Aurora, see Tuning with wait events for Aurora MySQL and Tuning with wait events for Aurora PostgreSQL in the Amazon Aurora User Guide. To learn how to tune performance using wait events in RDS for PostgreSQL, see Tuning with wait events for RDS for PostgreSQL in the Amazon RDS User Guide. Related metrics The Related metrics section lists the contextual anomalies, which are specific findings within the causal anomaly. These findings give additional information about the performance issues. The Related metrics table has two columns: Metrics name and Timeline (UTC). Every row in the table corresponds to a specific metric. The first column of every row has the following pieces of information: • Name – The name of the metric. The first row identifies the metric as CPU running tasks. Working with anomalies in DevOps Guru for RDS 48 Amazon DevOps Guru User Guide • Currently – The current value of the metric. In the first row, the current value is 162 processes (3x). • Normally – The baseline of this metric for this database when it is functioning normally. DevOps Guru for RDS calculates the baseline as the 95th percentile value over 1 week of history. The first row indicates that 56 processes are typically running on the CPU. • Contributing to – The finding associated with this metric. In the first row, the CPU running tasks metric is associated with the CPU capacity exceeded anomaly. The Timeline column shows a line chart for the metric. The shaded area shows the time interval when DevOps Guru for RDS designated the finding as high severity. Analysis |
userguide-022 | userguide.pdf | 22 | – The baseline of this metric for this database when it is functioning normally. DevOps Guru for RDS calculates the baseline as the 95th percentile value over 1 week of history. The first row indicates that 56 processes are typically running on the CPU. • Contributing to – The finding associated with this metric. In the first row, the CPU running tasks metric is associated with the CPU capacity exceeded anomaly. The Timeline column shows a line chart for the metric. The shaded area shows the time interval when DevOps Guru for RDS designated the finding as high severity. Analysis and recommendations Whereas the causal anomaly describes the overall issue, a contextual anomaly describes a specific finding that requires investigation. Each finding corresponds to a set of related metrics. In the following example of an Analysis and recommendations section, the high DB load anomaly has two findings. The table has the following columns: • Anomaly – A general description of this contextual anomaly. In this example, the first anomaly is high-load wait events, and the second is CPU capacity exceeded. • Analysis – A detailed explanation of the anomaly. Working with anomalies in DevOps Guru for RDS 49 Amazon DevOps Guru User Guide In the first anomaly, three wait types contribute to 90% of DB load. In the second anomaly, the CPU run queue exceeded 150, which means that at any given time, more than 150 sessions were waiting for CPU time. CPU utilization was over 97%, which means that for the duration of the issue, the CPU was busy 97% of the time. Thus, the CPU was almost continually occupied while an average of 150 sessions waited to run on the CPU. • Recommendations – The suggested user response to the anomaly. In the first anomaly, DevOps Guru for RDS recommends that you investigate the wait events cpu and io/table/sql/handler. To learn how to tune your database performance based on these events, see cpu and io/table/sql/handler in the Amazon Aurora User Guide. In the second anomaly, DevOps Guru for RDS recommends that you reduce CPU consumption by tuning three SQL statements. You can hover over the links to see the SQL text. • Related metrics – Metrics that give you specific measurements for the anomaly. For more information about these metrics, see Metrics reference for Amazon Aurora in the Amazon Aurora User Guide or Metrics reference for Amazon RDS in the Amazon RDS User Guide. In the first anomaly, DevOps Guru for RDS recommends that compare DB load to the maximum CPU for your instance. In the second anomaly, the recommendation is to look at CPU run queue, CPU utilization, and SQL execution rate. Viewing proactive anomalies Within insights, you can view anomalies for Amazon RDS resources. Each proactive insight provides details about one proactive anomaly. On a proactive insight page, you can view an insight overview, detailed metrics about the anomaly, and recommendations to prevent future issues. To view a proactive anomaly, go to the proactive insight page. Insight overview The Insight overview section provides details about why the insight was created. It displays the severity of the insight as well as a description of the anomaly and a timeframe for when the anomaly occurred. It also lists the number of affected services and applications detected by DevOps Guru. Working with anomalies in DevOps Guru for RDS 50 Amazon DevOps Guru Metrics User Guide The Metrics section provides graphs of the anomaly. Each graph displays a threshold determined by the resource's baseline behavior, as well as data of the metric reported from the time of the anomaly. Recommendations for aggregated resources This section suggests actions that you can take to mitigate the reported issues before they become a bigger problem. Actions that you can take are presented in the Recommended custom change column. The rationale behind the recommendations is presented in the Why is DevOps Guru recommending this? column. For more information about how to respond to recommendations, see the section called “Responding to recommendations”. Responding to recommendations Recommendations are the most important part of the insight. In this stage of the analysis, you act to resolve the performance issue. Typically, you take the following steps: 1. Decide whether the reported performance issue indicates a real problem. In some cases, an issue might be expected and benign. For example, if you subject a test database to an extreme DB load, DevOps Guru for RDS reports the load as a performance anomaly. However, you don't need to remedy this anomaly because it's an expected result of your testing. If you determine that the issue needs a response, go to the next step. 2. Decide whether to implement the recommendation. In the table of recommendations, a column shows the recommended actions. For reactive insights, this is the What we recommend |
userguide-023 | userguide.pdf | 23 | whether the reported performance issue indicates a real problem. In some cases, an issue might be expected and benign. For example, if you subject a test database to an extreme DB load, DevOps Guru for RDS reports the load as a performance anomaly. However, you don't need to remedy this anomaly because it's an expected result of your testing. If you determine that the issue needs a response, go to the next step. 2. Decide whether to implement the recommendation. In the table of recommendations, a column shows the recommended actions. For reactive insights, this is the What we recommend column on a reactive anomaly detail page. For proactive insights, this is the Recommended custom change column on a proactive insight page. DevOps Guru for RDS offers a list of recommendations that cover several potential problematic scenarios. After reviewing this list, determine which recommendation is more relevant to your current situation and consider applying it. If a recommendation works for your situation, go to the next step. If not, skip the remaining step and troubleshoot the issue using manual techniques. 3. Perform the recommended actions. Working with anomalies in DevOps Guru for RDS 51 Amazon DevOps Guru User Guide DevOps Guru for RDS recommends that you do either of the following: • Perform a specific corrective action. For example, DevOps Guru for RDS might recommend that you upgrade CPU capacity, tune application pool settings, or enable the Performance Schema. • Investigate the cause of the issue. Typically, DevOps Guru for RDS recommends that you investigate specific SQL statements or wait events. For example, a recommendation might be to investigate the wait event io/ table/sql/handler. Look up the listed wait event in Tuning with wait events for Aurora PostgreSQL or Tuning with wait events for Aurora MySQL in the Amazon Aurora User Guide, or in Tuning with wait events for RDS for PostgreSQL in the Amazon RDS User Guide. Then perform the recommended actions. Important We recommend that you test any changes on a test instance before modifying a production instance. In this way, you understand the impact of the change. Monitoring non-relational databases using DevOps Guru DevOps Guru is capable of generating insights for your non-relational or NoSQL databases that help you keep your resources configured according to best practices. For example, DevOps Guru can help you stay on top of capacity planning by forecasting future needs based on existing traffic. DevOps Guru can identify if you are utilizing less resources than you configured and provide recommendations to improve application availability based on your historic usage. This can help you reduce unnecessary cost. Beyond capacity planning, DevOps Guru detects and helps you troubleshoot operational issues such as throttling, transaction conflicts, conditional check failures, and areas for improvement in SDK parameters. Databases are typically connected with multiple services and resources, and DevOps Guru can correlate your application structure for analysis using groups based on tagging or AWS CloudFormation aggregation. Anomalies can involve multiple resources that are all affected by the same solution. DevOps Guru is capable of correlating across different resource metrics, configurations, logs, and events. For example, DevOps Guru can analyze and relate data from a Lambda function that might be reading or writing data from a Amazon DynamoDB table. In this Non-relational databases 52 Amazon DevOps Guru User Guide way, DevOps Guru monitors multiple related resources to detect anomalies and provide useful insights for your database solutions. Monitoring database operations in Amazon DynamoDB The table below shows example scenarios and insights that DevOps Guru monitors for Amazon DynamoDB. Amazon DynamoDB use case Examples Metrics Detect when a large percentage of AccountPr Amazon DynamoDB table consumption capacities for AccountProvisioned ReadCapacityUtilization, ovisionedReadCapacityUtiliz read or write requests is reaching table-level limits. AccountProvisionedWriteCapa cityUtilization ation and AccountProvisioned WriteCapacityUtilization are being used, due to a large number of read and write requests. Detect conditional check failures in Amazon Conditional check failures are caused by bad data in ConditionalCheckFailedReque sts DynamoDB requests caused your table, a strict condition by a provided condition expression, or race conditions. expression not matching what is expected in the database. Monitoring database operations in Amazon ElastiCache The table below shows example scenarios and insights that DevOps Guru monitors for Amazon ElastiCache. Scenario that DevOps Guru identifies CloudWatch metrics monitored Detect when an Amazon ElastiCache cluster is reaching its compute limit for Redis or Memcached due to changing demands on your clusters. CPUUtilization, EngineCPUUtilization, Evictions Monitoring database operations in Amazon DynamoDB 53 Amazon DevOps Guru User Guide Integrating with CodeGuru Profiler This section provides an overview of how Amazon DevOps Guru integrates with Amazon CodeGuru Profiler. You can view recommendations from CodeGuru Profiler as insights in the DevOps Guru console. Amazon DevOps Guru integrates with Amazon CodeGuru Profiler with an EventBridge managed rule. CodeGuru Profiler sends events to EventBridge. The managed |
userguide-024 | userguide.pdf | 24 | ElastiCache. Scenario that DevOps Guru identifies CloudWatch metrics monitored Detect when an Amazon ElastiCache cluster is reaching its compute limit for Redis or Memcached due to changing demands on your clusters. CPUUtilization, EngineCPUUtilization, Evictions Monitoring database operations in Amazon DynamoDB 53 Amazon DevOps Guru User Guide Integrating with CodeGuru Profiler This section provides an overview of how Amazon DevOps Guru integrates with Amazon CodeGuru Profiler. You can view recommendations from CodeGuru Profiler as insights in the DevOps Guru console. Amazon DevOps Guru integrates with Amazon CodeGuru Profiler with an EventBridge managed rule. CodeGuru Profiler sends events to EventBridge. The managed rule routes events that are sent with the default event bus. Each inbound event from CodeGuru Profiler is a proactive anomaly report. For more information, see Working with EventBridge with CodeGuru Profiler. DevOps Guru supports inbound events with EventBridge. An event indicates a change in a recommendation that DevOps Guru identified. CodeGuru Profiler sends a heartbeat event every 24 hours to show the continuity of the event. Events carry CodeGuru Profiler recommendation information as well as metadata for your compute resources. For information on an event lifecycle, see Amazon EventBridge Events. When you set up DevOps Guru, DevOps Guru creates the EventBridge Managed Rule in your account that routes events from another service. This rule routes to DevOps Guru. Notifications are sent when there is an inbound event. An event bus receives events from a source such as DevOps Guru and routes them to rules associated with that event bus. For more information on event buses, see Event buses. For information on some of the parameters, see Amazon EventBridge events. To receive CodeGuru Profiler insights in DevOps Guru, you must have the following. • CodeGuru Profiler must be enabled. For information on enabling CodeGuru Profiler, see Setting up CodeGuru Profiler. • DevOps Guru must be enabled. For information on enabling DevOps Guru, see Enable DevOps Guru. • The same resources must be monitored in the same Region in both CodeGuru Profiler and DevOps Guru. 54 Amazon DevOps Guru User Guide Defining applications using AWS resources Amazon DevOps Guru groups the resources that are in the coverage boundary that specifies which resources it analyzes for operational insights. The resources are grouped by resources in AWS CloudFormation stacks or by resources with tags. You choose the stacks or tags when you set up DevOps Guru. You can also update the stacks or tags later. We recommend that you think of your resource groups as applications. For example, you might have all resources that you use for a monitoring application defined in one stack. Or you might add the same tag to all the resources that you use in a database application. the boundary that defines which resources DevOps Guru analyzes. All the resources in the collection are inside this boundary. Any resources in your account that are not in your resource collection are outside the boundary and are not analyzed. For more information about the supported services and resources, see Amazon DevOps Guru pricing. You can define your coverage boundary that contains the resources in your applications three ways. • Specify that all supported AWS resources in your AWS account and Region. This makes your account and Region your resource boundary. With this option, DevOps Guru analyzes every supported resource in your account and Region. All resources that are in one stack are grouped into an application. Any resources that are not in a stack are grouped into their own application. • Use AWS CloudFormation stacks to specify the resources in your applications. A stack contains resources that are generated using AWS CloudFormation. In DevOps Guru, you choose stacks in your account. The resources you in each stack you choose are grouped into an application. All resources in the stacks are analyzed by DevOps Guru for insights. • Use AWS tags to specify the resources in your applications. An AWS tag contains a key and a value. In DevOps Guru, choose one tag key and optionally choose one or more values that are paired with that key. You can use the values to group your resources into applications. For more information, see Updating your AWS analysis coverage in DevOps Guru. Topics • Using tags to identify resources in your DevOps Guru applications • Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications 55 Amazon DevOps Guru User Guide Using tags to identify resources in your DevOps Guru applications You can use tags to identify the AWS resources that Amazon DevOps Guru analyzes and to specify which resources are grouped for monitoring with the selected tag key and tag values. You can edit these configurations when you set up DevOps Guru or when you choose Edit analyzed resources from the Analyzed resources page. After you select Tags, you choose a |
userguide-025 | userguide.pdf | 25 | Using tags to identify resources in your DevOps Guru applications • Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications 55 Amazon DevOps Guru User Guide Using tags to identify resources in your DevOps Guru applications You can use tags to identify the AWS resources that Amazon DevOps Guru analyzes and to specify which resources are grouped for monitoring with the selected tag key and tag values. You can edit these configurations when you set up DevOps Guru or when you choose Edit analyzed resources from the Analyzed resources page. After you select Tags, you choose a specific tag key that you want Amazon DevOps Guru to monitor. To analyze all resources in the account and use tag values to group the resources, select All Account Resources. To use tag values to specify the resources for DevOps Guru to analyze, select Choose specific tag values. Note When All Account Resources is selected and no tag value exists, resources without the tag key are grouped and analyzed separately. You use a tag's key to identify the resources, then use values with that key to group resources into your applications. For example, you can tag your resources with the key devops-guru- applications, then use that key with a different value for each of your applications. You might use the tag key-value pairs devops-guru-applications/database, devops-guru- applications/cicd, and devops-guru-applications/monitoring to identify three applications in your account. Each application is made up of related resources that contain the same tag key-value pair. You add tags to your resources using the AWS service to which they belong. For more information, see Adding AWS tags to AWS resources. After you add a tag to the resources in your application, you can filter your insights by the tags on resources that generated them. For more information about how to filter your insights using a tag, see Viewing DevOps Guru insights. For more information about the supported services and resources, see Amazon DevOps Guru pricing. Topics • What is an AWS tag? • Defining a DevOps Guru application using a tag • Using tags with DevOps Guru Using tags to identify resources in your applications 56 Amazon DevOps Guru User Guide • Adding AWS tags to AWS resources What is an AWS tag? Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper. Each AWS tag has two parts. • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case- sensitive. • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. Together these are known as key-value pairs. Defining a DevOps Guru application using a tag To define your Amazon DevOps Guru application using a tag, add that tag to the AWS resources in your account that make up your application. Your tag contains a key and a value. We recommend that you add a tag to each of your AWS resources analyzed by DevOps Guru that has the same key. Use a different value in the tag to group resources into your applications. For example, you might assign tags with the key devops-guru-analysis-boundary to all the AWS resources in your coverage boundary. Use different values with that key to identify applications in your account. You might use the values containers, database, and monitoring for three applications. For more information, see Updating your AWS analysis coverage in DevOps Guru. If you use AWS tags to specify which resources to analyze, you can use tags with only one key. You can pair your tags' key paired with any value. Use the value to group the resources that contain your key into your operational applications. What is a tag? 57 Amazon DevOps Guru Important User Guide When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production- application/RDS or Devops-Guru-production-application/containers. Using tags with DevOps Guru Specify the AWS tags that identify the AWS resources that you want Amazon DevOps Guru to analyze, or specify tag values that identify which resources will be grouped. These resources are your resource coverage boundary. You can choose one key and |
userguide-026 | userguide.pdf | 26 | the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production- application/RDS or Devops-Guru-production-application/containers. Using tags with DevOps Guru Specify the AWS tags that identify the AWS resources that you want Amazon DevOps Guru to analyze, or specify tag values that identify which resources will be grouped. These resources are your resource coverage boundary. You can choose one key and zero or more values. To choose your tags 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Open the navigation pane, then expand Settings. 3. In Analyzed resources, choose Edit. 4. Choose Tags if you want DevOps Guru to analyze all resources that contain the tags you choose. Choose a key, then choose one of the following options. • All account resources – Analyze all AWS resources in the current Region and account. Resources with the selected tag key are grouped by tag value, if any exist. Resources without this tag key are grouped and analyzed separately. • Choose specific tag values – All resources that contain a tag with the key you chose are analyzed. DevOps Guru groups your resources into applications by your tag's values. 5. Choose Save. Adding AWS tags to AWS resources When you specify the AWS tags that identify the AWS resources that you want DevOps Guru to analyze, choose tags that have resources associated with them. You can add tags to your resources using the AWS service to which each resource belongs, or using the AWS Tag Editor. Using tags with DevOps Guru 58 Amazon DevOps Guru User Guide • To manage tags using your resources' service, use the console, AWS Command Line Interface, or SDK of the service to which a resource belongs. For example, you can tag an Amazon Kinesis stream resource or an Amazon CloudFront distribution resource. These are two examples of services with resources that can be tagged. Most resources that DevOps Guru can analyze support tags. For more information, see Tagging your streams in the Amazon Kinesis Developer Guide and Tagging a distribution in the Amazon CloudFront Developer Guide. To learn how to add tags to other types of resources, see the user guide or developer guide for the AWS service to which they belong. Note When you tag Amazon RDS resources, you must tag the database instance and not the cluster. • You can use the AWS Tag Editor to manage tags by resources in your Region and by resources in specific AWS services. For more information, see Tag editor in the AWS Resource Group and Tags User Guide. When you add a tag to a resource, you can add the key only, or the key and a value. For example, you can create a tag with the key devops-guru- for all the resources that are part of your DevOps application. You can also add a tag with the key devops-guru- and the value RDS, then add that key-value pair to only the Amazon RDS resources in your application. This is useful if you want to view insights in the console that are generated from only the Amazon RDS resources in your application. Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications You can use AWS CloudFormation stacks to specify which AWS resources you want DevOps Guru to analyze. A stack is a collection of AWS resources that are managed as a single unit. The resources in the stacks you choose make up your DevOps Guru coverage boundary. For each stack you choose, operational data in its supported resources are analyzed for anomalous behavior. Those issues are then grouped into related anomalies to create insights. Each insight includes one or more recommendations to help you address them. The maximum number of stacks you can specify is 1000. For more information, see Working with stacks in the AWS CloudFormation User Guide and Updating your AWS analysis coverage in DevOps Guru. Using stacks to identify resources in your DevOps Guru applications 59 Amazon DevOps Guru User Guide After you choose a stack, DevOps Guru immediately starts to analyze any resource you add to it. If you remove a resource from a stack, it is no longer analyzed. If you choose to have DevOps Guru analyze all supported resources in your account (this means your AWS account and Region is your DevOps Guru coverage boundary), then DevOps Guru analyzes and creates insights for every supported resource in your account, including those in stacks. An insight created from anomalies in a resource that is not in a stack is grouped at the account level. If an insight is |
userguide-027 | userguide.pdf | 27 | Guide After you choose a stack, DevOps Guru immediately starts to analyze any resource you add to it. If you remove a resource from a stack, it is no longer analyzed. If you choose to have DevOps Guru analyze all supported resources in your account (this means your AWS account and Region is your DevOps Guru coverage boundary), then DevOps Guru analyzes and creates insights for every supported resource in your account, including those in stacks. An insight created from anomalies in a resource that is not in a stack is grouped at the account level. If an insight is created from anomalies in a resource that is in a stack,then it is grouped at the stack level. For more information, see Understanding how anomalous behaviors are grouped into insights. Choosing stacks for DevOps Guru to analyze Specify the resources that you want Amazon DevOps Guru to analyze by choosing the AWS CloudFormation stacks that create them. You can do this using the AWS Management Console or the SDK. Topics • Choosing stacks for DevOps Guru to analyze (console) • Choosing stacks for DevOps Guru to analyze (DevOps Guru SDK) Choosing stacks for DevOps Guru to analyze (console) You can add AWS CloudFormation stacks using the console. To choose the stacks that contain the resources to analyze 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Open the navigation pane, then choose Settings. 3. In DevOps Guru analysis coverage, choose Manage. 4. Choose CloudFormation stacks if you want DevOps Guru to analyze the resources that are in stacks you choose, then choose one of the following options. • All resources – All resources that are in stacks in your account are analyzed. Resources in each stack are grouped into their own application. Any resources in your account that are not in a stack are not analyzed. Choosing stacks to analyze 60 Amazon DevOps Guru User Guide • Select stacks – Select the stacks that you want DevOps Guru to analyze. The resources in each stack you select are grouped into their own application. You can enter the name of a stack in Find stacks to quickly locate a specific stack. You can select up to 1,000 stacks. 5. Choose Save. Choosing stacks for DevOps Guru to analyze (DevOps Guru SDK) To specify AWS CloudFormation stacks using the Amazon DevOps Guru SDK, use the UpdateResourceCollection method. For more information, see UpdateResourceCollection in the Amazon DevOps Guru API Reference. Choosing stacks to analyze 61 Amazon DevOps Guru User Guide Working with Amazon EventBridge Amazon DevOps Guru integrates with Amazon EventBridge to notify you of certain events relating to insights and corresponding insight updates. Events from AWS services are delivered to EventBridge in near real time. You can write simple rules to indicate which events are of interest to you and what automated actions to take when an event matches a rule. The actions that can be automatically initiated include the following examples: • Invoking an AWS Lambda function • Invoking an Amazon Elastic Compute Cloud run command • Relaying the event to Amazon Kinesis Data Streams • Activating a Step Functions state machine • Notifying an Amazon SNS or an Amazon SQS You can select any of the following predefined patterns to filter events or create a custom pattern rule to initiate actions in a supported AWS resources. • DevOps Guru New Insight Open • DevOps Guru New Anomaly Association • DevOps Guru Insight Severity Upgraded • DevOps Guru New Recommendation Created • DevOps Guru Insight Closed Events for DevOps Guru The following are example events from DevOps Guru. Events are emitted on a best-effort basis. To learn more about event patterns, see Getting started with Amazon EventBridge or Amazon EventBridge event patterns. DevOpsGuru New Insight Open Event When DevOps Guru opens a new insight, it sends the following event. { "version" : "0", Events for DevOps Guru 62 Amazon DevOps Guru User Guide "id" : "08108845-ef90-00b8-1ad6-2ee5570ac6c4", "detail-type" : "DevOps Guru New Insight Open", "source" : "aws.devops-guru", "account" : "123456789012", "time" : "2021-11-01T17:06:10Z", "region" : "us-east-1", "resources" : [ ], "detail" : { "insightSeverity" : "high", "insightDescription" : "ApiGateway 5XXError Anomalous In Stack TestStack", "insightType" : "REACTIVE", "anomalies" : [ { "startTime" : "1635786000000", "id" : "AL41JDFFQPYlZlXD8cpREkAAAAF83HGGgC9TmTr9lbfJ7sCiISlWMeFCbHY_XXXX", "sourceDetails" : [ { "dataSource" : "CW_METRICS", "dataIdentifiers" : { "period" : "60", "stat" : "Average", "unit" : "None", "name" : "5XXError", "namespace" : "AWS/ApiGateway", "dimensions" : [ { "name" : "ApiName", "value" : "Test API Service" }, { "name" : "Stage", "value" : "prod" } ] } } ] } ], "accountId" : "123456789012", "messageType" : "NEW_INSIGHT", "insightUrl" : "https://us-east-1.console.aws.amazon.com/devops-guru/#/insight/ reactive/AIYH6JxdbgkcG0xJmypiL4MAAAAAAAAAL0SLEjkxiNProXWcsTJbLU07EZ7XXXX", "startTime" : "1635786120000", DevOpsGuru New Insight Open Event 63 Amazon DevOps Guru User Guide "insightId" : "AIYH6JxdbgkcG0xJmypiL4MAAAAAAAAAL0SLEjkxiNProXWcsTJbLU07EZ7XXXX", "region" : "us-east-1" } }, Custom sample event pattern for high severity new Insight Rules |
userguide-028 | userguide.pdf | 28 | "startTime" : "1635786000000", "id" : "AL41JDFFQPYlZlXD8cpREkAAAAF83HGGgC9TmTr9lbfJ7sCiISlWMeFCbHY_XXXX", "sourceDetails" : [ { "dataSource" : "CW_METRICS", "dataIdentifiers" : { "period" : "60", "stat" : "Average", "unit" : "None", "name" : "5XXError", "namespace" : "AWS/ApiGateway", "dimensions" : [ { "name" : "ApiName", "value" : "Test API Service" }, { "name" : "Stage", "value" : "prod" } ] } } ] } ], "accountId" : "123456789012", "messageType" : "NEW_INSIGHT", "insightUrl" : "https://us-east-1.console.aws.amazon.com/devops-guru/#/insight/ reactive/AIYH6JxdbgkcG0xJmypiL4MAAAAAAAAAL0SLEjkxiNProXWcsTJbLU07EZ7XXXX", "startTime" : "1635786120000", DevOpsGuru New Insight Open Event 63 Amazon DevOps Guru User Guide "insightId" : "AIYH6JxdbgkcG0xJmypiL4MAAAAAAAAAL0SLEjkxiNProXWcsTJbLU07EZ7XXXX", "region" : "us-east-1" } }, Custom sample event pattern for high severity new Insight Rules use event patterns to select events and route them to targets. The following is a sample DevOps Guru event pattern. { "source": [ "aws.devops-guru" ], "detail-type": [ "DevOps Guru New Insight Open" ], "detail": { "insightSeverity": [ "high" ] } } Custom sample event pattern for high severity new Insight 64 Amazon DevOps Guru User Guide Updating DevOps Guru settings You can update the following Amazon DevOps Guru settings: • Your DevOps Guru coverage. This determines which resources in your account are analyzed. • Your notifications. This determines which Amazon Simple Notification Service topics are used to notify you of important DevOps Guru events. • Features for enhanced insights. This includes log anomaly detection, encryption, and your AWS Systems Manager integration settings. This determines whether DevOps Guru displays log data, whether you use additional security keys, and whether an OpsItem is created in Systems Manager OpsCenter for each new insight. Topics • Updating your management account settings • Updating your AWS analysis coverage in DevOps Guru • Updating your notifications in DevOps Guru • Filtering your DevOps Guru notifications • Updating AWS Systems Manager integration in DevOps Guru • Updating log anomaly detection in DevOps Guru • Updating encryption settings in DevOps Guru Updating your management account settings You can configure DevOps Guru for accounts in your organization. If you haven't registered a delegated administrator, you can do so by choosing Register delegated administrator. For more information on registering a delegated administrator, see Enable DevOps Guru. Updating your AWS analysis coverage in DevOps Guru You can update which AWS resources in your account DevOps Guru analyzes. To do this, navigate to the Analyzed resources page in the console and then choose Edit. For more information, see Viewing analyzed resources. Updating your management account 65 Amazon DevOps Guru User Guide Updating your notifications in DevOps Guru Set up Amazon Simple Notification Service topics that are used to notify you about important Amazon DevOps Guru events. You can choose from a list of topic names that already exist in your AWS account, enter the name for a new topic that DevOps Guru creates in your account, or enter the Amazon Resource Name (ARN) of an existing topic in any AWS account in your Region. If you specify the ARN of a topic that is not in your account, you must grant permission for DevOps Guru to access that topic by adding an IAM policy to it. For more information, see Permissions for Amazon SNS topics. You can specify up to two topics. DevOps Guru sends notifications for the following updates: • A new insight is created. • A new anomaly is added to an insight. • The severity of an insight is upgraded from Low or Medium to High. • The status of an insight changes from ongoing to resolved. • A recommendation for an insight is identified. DevOps Guru also sends notifications if a selected AWS CloudFormation stack or tag key is invalid when you are attempting to add resources to your DevOps Guru account. You can choose to receive Amazon SNS notifications for all kinds of updates to an issue or to receive Amazon SNS notifications only when the issue is opened, closed, or has a change in severity. By default, you receive notifications for all updates. To update your notifications, first navigate to the notifications page and then choose whether to add, remove, or update configurations for Amazon SNS notification topics. Topics • Navigate to notification settings in the DevOps Guru console • Adding Amazon SNS notification topics in the DevOps Guru console • Removing Amazon SNS notification topics in the DevOps Guru console • Updating Amazon SNS notification configurations • Permissions added to your Amazon SNS topic Updating your notifications 66 Amazon DevOps Guru User Guide Navigate to notification settings in the DevOps Guru console To update notifications, you must first navigate to the notification settings section. To navigate to the notification settings section 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Settings in the navigation pane. The Settings page includes the Notifications section, with information about configured Amazon SNS topics. Adding Amazon SNS notification topics in the DevOps Guru console To add an Amazon |
userguide-029 | userguide.pdf | 29 | in the DevOps Guru console • Updating Amazon SNS notification configurations • Permissions added to your Amazon SNS topic Updating your notifications 66 Amazon DevOps Guru User Guide Navigate to notification settings in the DevOps Guru console To update notifications, you must first navigate to the notification settings section. To navigate to the notification settings section 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Settings in the navigation pane. The Settings page includes the Notifications section, with information about configured Amazon SNS topics. Adding Amazon SNS notification topics in the DevOps Guru console To add an Amazon SNS notification topic in the DevOps Guru console 1. the section called “Navigate to notification settings in the DevOps Guru console”. 2. Choose Add notification. 3. To add an Amazon SNS topic, do one of the following. • Choose Generate a new SNS topic using email. Then, from Specify the email address, enter the email address you want to receive notifications. To enter in additional email addresses, choose Add new email. • Choose Use an existing SNS topic. Then, from Choose a topic in your AWS account, choose the topic you want to use. • Choose Use an existing SNS topic ARN to specify an existing topic from another account. Then, in Enter an ARN for a topic, enter the topic ARN. The ARN is the topic's Amazon Resource Name. You can specify a topic in a different account. If you use a topic in another account, you must add a resource policy to the topic. For more information, see Permissions for Amazon SNS topics. 4. Choose Save. Removing Amazon SNS notification topics in the DevOps Guru console To remove Amazon SNS topics in the DevOps Guru console 1. the section called “Navigate to notification settings in the DevOps Guru console”. Navigate to notification settings in the DevOps Guru console 67 Amazon DevOps Guru 2. Choose Select existing topic. 3. From the drop-down menu, select the topic you want to remove. User Guide 4. Choose Remove. 5. Choose Save. Updating Amazon SNS notification configurations There are two types of notification configurations for Amazon SNS notification topics in DevOps Guru. You can choose to receive notifications of all severity levels or only notifications with High and Medium severity levels. You can also choose to receive notifications for all kinds of updates or only some kinds of updates. When you choose to receive Amazon SNS notifications for all kinds of updates to the issue, DevOps Guru sends notifications for the following updates: • A new insight is created. • A new anomaly is added to an insight. • The severity of an insight is upgraded from Low or Medium to High. • The status of an insight changes from ongoing to resolved. • A recommendation for an insight is identified. By default, you receive only High and Medium severity level notifications, and you receive notifications for all kinds of updates. To update notification configurations for Amazon SNS notification topics 1. the section called “Navigate to notification settings in the DevOps Guru console”. 2. Choose Select existing topic. 3. From the drop-down menu, select the topic you want to make updates to. 4. Choose All severity levels to receive notifications with High, Medium, and Low severity levels, or choose Only High and Medium to receive notifications with High and Medium severity levels. 5. Choose Notify me on all updates to the insight, or choose Notify me when an insight is opened or closed, or the severity level changes from Low or Medium to High. Updating Amazon SNS notification configurations 68 Amazon DevOps Guru 6. Choose Save. User Guide Permissions added to your Amazon SNS topic An Amazon SNS topic is a resource that contains an AWS Identity and Access Management (IAM) resource policy. When you specify a topic here, DevOps Guru appends the following permissions to its resource policy. { "Sid": "DevOpsGuru-added-SNS-topic-permissions", "Effect": "Allow", "Principal": { "Service": "region-id.devops-guru.amazonaws.com" }, "Action": "sns:Publish", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Condition" : { "StringEquals" : { "AWS:SourceArn": "arn:aws:devops-guru:region-id:topic-owner-account- id:channel/devops-guru-channel-id", "AWS:SourceAccount": "topic-owner-account-id" } } } These permissions are required for DevOps Guru to publish notifications using a topic. If you prefer to not have these permissions on the topic, you can safely remove them and the topic will continue to work as it did before you chose it. However, if these appended permissions are removed, DevOps Guru cannot use the topic to generate notifications. Filtering your DevOps Guru notifications You can filter your DevOps Guru notifications by the section called “Updating Amazon SNS notification configurations” or by using a Amazon SNS subscription filter policy. Topics • Filtering notifications with a Amazon SNS subscription filter policy • Example filtered Amazon SNS notification for Amazon DevOps Guru Permissions added to your topic 69 Amazon DevOps Guru User Guide Filtering notifications with a Amazon |
userguide-030 | userguide.pdf | 30 | safely remove them and the topic will continue to work as it did before you chose it. However, if these appended permissions are removed, DevOps Guru cannot use the topic to generate notifications. Filtering your DevOps Guru notifications You can filter your DevOps Guru notifications by the section called “Updating Amazon SNS notification configurations” or by using a Amazon SNS subscription filter policy. Topics • Filtering notifications with a Amazon SNS subscription filter policy • Example filtered Amazon SNS notification for Amazon DevOps Guru Permissions added to your topic 69 Amazon DevOps Guru User Guide Filtering notifications with a Amazon SNS subscription filter policy You can create an Amazon Simple Notification Service (Amazon SNS) subscription filter policy to reduce the number of notifications you receive from Amazon DevOps Guru. Use a filter policy to specify the types of notifications you receive. You can filter your Amazon SNS messages using the following keywords. • NEW_INSIGHT — Receive a notification when a new insight is created. • CLOSED_INSIGHT — Receive a notification when an existing insight is closed. • NEW_RECOMMENDATION — Receive a notification when a new recommendation is created from an insight. • NEW_ASSOCIATION — Receive a notification when a new anomaly is detected from an insight. • CLOSED_ASSOCIATION — Receive a notification when an existing anomaly is closed. • SEVERITY_UPGRADED — Receive a notification when the severity of an insight is upgraded For information about how to create an Amazon SNS subscription filter policy, see Amazon SNS subscription filter policies in the Amazon Simple Notification Service Developer Guide. In your filter policy, you specify one of the keywords with the policy's MessageType. For example, the following would appear in a filter that specifies the Amazon SNS topic only deliver notifications when a new anomaly is detected from an insight. { "MessageType":["NEW_ ASSOCIATION"] } Example filtered Amazon SNS notification for Amazon DevOps Guru The following is an example of an Amazon Simple Notification Service (Amazon SNS) notification from an Amazon SNS topic with a filter policy. Its MessageType is set to NEW_ASSOCIATION, so it sends notifications only when a new anomaly is detected from an insight. { "accountId": "123456789012", "region": "us-east-1", "messageType": "NEW_ASSOCIATION", "insightId": "ADyf4FvaVNDzu9MA2-IgFDkAAAAAAAAAEGpJd5sjicgauU2wmAlnWUyyI2hiO5it", Filtering notifications with a Amazon SNS subscription filter policy 70 Amazon DevOps Guru User Guide "insightName": "Repeated Insight: Anomalous increase in Lambda ApigwLambdaDdbStack-22-Function duration due to increased number of invocations", "insightUrl": "https://us-east-1.console.aws.amazon.com/devops-guru/insight/ reactive/ADyf4FvaVNDzu9MA2-IgFDkAAAAAAAAAEGpJd5sjicgauU2wmAlnWUyyI2hiO5it", "insightType": "REACTIVE", "insightDescription": "At March 29, 2023 22:02 GMT, Lambda function ApigwLambdaDdbStack-22-Function had\n an increased duration anomaly possibly caused by the Lambda function invocation increase. DevOps Guru has detected this is a repeated insight. DevOps Guru treats repeated insights as 'Low Severity'.", "startTime": 1628767500000, "startTimeISO": "2023-03-29T22:00:00Z", "anomalies": [ { "id": "AG2n8ljW74BoI1CHu-m_oAgAAAF7Ohu24N4Yro69ZSdUtn_alzPH7VTpaL30JXiF", "startTime": 1628767500000, "startTimeISO": "2023-03-29T22:00:00Z", "openTime": 1680127740000, "openTimeISO": "2023-03-29T22:09:00Z", "sourceDetails": [ { "dataSource": "CW_METRICS", "dataIdentifiers": { "namespace": "AWS/SQS", "name": "ApproximateAgeOfOldestMessage", "stat": "Maximum", "unit": "None", "period": "60", "dimensions": "{\"QueueName\":\"FindingNotificationsDLQ\"}" } } ], "associatedResourceArns":[ "arn:aws:sns:us-east-1:123456789012:DevOpsGuru-insights-sns" ] } ], "resourceCollection":{ "cloudFormation":{ "stackNames":[ "CapstoneNotificationPublisherEcsApplicationInfrastructure" ] } } Example filtered Amazon SNS notification 71 Amazon DevOps Guru } User Guide Updating AWS Systems Manager integration in DevOps Guru You can enable the creation of an OpsItem for each new insight in AWS Systems Manager OpsCenter. OpsCenter is a centralized system where you can view, investigate, and review operational work items (OpsItems). The OpsItems for your insights can help you manage work that addresses the anomalous behavior that triggered the creation of each insight. For more information, see AWS Systems Manager OpsCenter and Working with OpsItem in the AWS Systems Manager User Guide. Note If you change the key or value of the tag field of an OpsItem, then DevOps Guru is not able to update that OpsItem. For example, if you change a tag of an OpsItem from "aws:RequestTag/DevOps-GuruInsightSsmOpsItemRelated": "true" to something else, then DevOps Guru cannot update that OpsItem. To manage your Systems Manager integration 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Settings in the navigation pane. 3. In AWS Systems Manager integration, select Enable DevOps Guru to create an AWS OpstItem in OpsCenter for each insight to have an OpsItem created for each new insight. Deselect it to stop having an OpsItem created for each new insight. You are charged for OpsItems created in your account. For more information, see AWS Systems Manager pricing. Updating log anomaly detection in DevOps Guru To manage your log anomaly detection settings 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Settings in the navigation pane. Updating Systems Manager integration 72 Amazon DevOps Guru User Guide 3. In Log anomaly detection, select Enable log anomaly detection by granting DevOps Guru permissions to display log data associated with an insight. to have DevOps Guru display log data related to insights. Updating encryption settings in DevOps Guru You can update encryption settings to use AWS owned |
userguide-031 | userguide.pdf | 31 | created in your account. For more information, see AWS Systems Manager pricing. Updating log anomaly detection in DevOps Guru To manage your log anomaly detection settings 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Settings in the navigation pane. Updating Systems Manager integration 72 Amazon DevOps Guru User Guide 3. In Log anomaly detection, select Enable log anomaly detection by granting DevOps Guru permissions to display log data associated with an insight. to have DevOps Guru display log data related to insights. Updating encryption settings in DevOps Guru You can update encryption settings to use AWS owned keys or AWS KMS customer managed keys. When switching to a new customer managed AWS KMS key from an existing customer managed AWS KMS key, DevOps Guru automatically starts encrypting newly ingested metadata using the new key. The historical data will remain encrypted with the previous configured customer managed AWS KMS key. Note If you revoke the grant, or disable or delete the previous AWS KMS key, DevOps Guru won't be able to access any of the data encrypted by this key and you might see the AccessDeniedException when performing a read operation. To manage your encryption settings 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Choose Settings in the navigation pane. 3. 4. In the Encryption section, choose Edit encryption. Select the encrpytion type you would like to use to protect your data. You can use a default AWS owned key, choose an existing customer managed key, or create a new customer managed AWS KMS key. 5. Choose Save. Encryption is an important part of DevOps Guru security. For more information, see the section called “Data protection”. Updating encryption 73 Amazon DevOps Guru User Guide Viewing notifications There are different types of notifications in DevOps Guru. Topics • New insight • Closed insight • New association • New recommendation • Severity upgraded • Resource validation failure The sections on this page show examples of each type of notification. New insight Notifications for new insights contain the following information: { "accountId":"123456789101", "region":"eu-west-1", "messageType":"NEW_INSIGHT", "insightId":"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "insightName": "Repeated Insight: ApiGateway 5XXError Anomalous In Application CanaryCommonResources-123456789101-LogAnomaly-4", "insightUrl":"https://eu-west-1.console.aws.amazon.com/devops-guru/insight/reactive/ a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "insightType":"REACTIVE", "insightDescription":"DevOps Guru has detected this is a repeated insight. DevOps Guru treats repeated insights as 'Low Severity'.", "insightSeverity":"medium", "startTime": 1680148920000, "startTimeISO": "2023-03-30T04:02:00Z", "anomalies":[ { "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "startTime": 1680148800000, "startTimeISO": "2023-03-30T04:00:00Z", New insight 74 Amazon DevOps Guru User Guide "openTime": 1680148920000, "openTimeISO": "2023-03-30T04:02:00Z", "sourceDetails":[ { "dataSource":"CW_METRICS", "dataIdentifiers":{ "name":"ApproximateAgeOfOldestMessage", "namespace":"AWS/SQS", "period":"60", "stat":"Maximum", "unit":"None", "dimensions":"{\"QueueName\":\"SampleQueue\"}" } } ], "associatedResourceArns":[ "arn:aws:sqs:eu-west-1:123456789101:SampleQueue" ] } ], "resourceCollection":{ "cloudFormation":{ "stackNames":[ "SampleApplication" ] }, } } Closed insight Notifications for closed insights contain the following information: { "accountId":"123456789101", "region":"us-east-1", "messageType":"CLOSED_INSIGHT", "insightId":"a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "insightName": "DynamoDB table writes are under utilized in mock-stack", "insightUrl":"https://us-east-1.console.aws.amazon.com/devops-guru/insight/ proactive/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "insightType":"PROACTIVE", "insightDescription":"DynamoDB table writes are under utilized", Closed insight 75 Amazon DevOps Guru User Guide "insightSeverity":"medium", "startTime": 1670612400000, "startTimeISO": "2022-12-09T19:00:00Z", "endTime": 1679994000000, "endTimeISO": "2023-03-28T09:00:00Z", "anomalies":[ { "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "startTime": 1665428400000, "startTimeISO": "2022-10-10T19:00:00Z", "endTime": 1679986800000, "endTimeISO": "2023-03-28T07:00:00Z", "openTime": 1670612400000, "openTimeISO": "2022-12-09T19:00:00Z", "closeTime": 1679994000000, "closeTimeISO": "2023-03-28T09:00:00Z", "description":"Empty receives while messages are available", "anomalyResources":[ { "type":"AWS::SQS::Queue", "name":"SampleQueue" } ], "sourceDetails":[ { "dataSource":"CW_METRICS", "dataIdentifiers":{ "name":"NumberOfEmptyReceives", "namespace":"AWS/SQS", "period":"60", "stat":"Sum", "unit":"COUNT", "dimensions":"{\"QueueName\":\"SampleQueue\"}" } } ], "associatedResourceArn": [ "arn:aws:sqs:us-east-1:123456789101:SampleQueue" ] } ], "resourceCollection":{ "cloudFormation":{ "stackNames":[ Closed insight 76 Amazon DevOps Guru User Guide "SampleApplication" ] } } } New association Notifications for new associations contain the following information: { "accountId":"123456789101", "region":"eu-west-1", "messageType":"NEW_ASSOCIATION", "insightId":"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "insightName": "Repeated Insight: Anomalous increase in Lambda ApigwLambdaDdbStack-22-GetOneFunction duration due to increased number of invocations", "insightUrl":"https://eu-west-1.console.aws.amazon.com/devops-guru/insight/reactive/ a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "insightType":"REACTIVE", "insightDescription":"At March 29, 2023 22:02 GMT, Lambda function ApigwLambdaDdbStack-22-GetOneFunction had\nan increased duration anomaly possibly caused by the Lambda function invocation increase. DevOps Guru has detected this is a repeated insight. DevOps Guru treats repeated insights as 'Low Severity'.", "insightSeverity":"medium", "startTime": 1680127200000, "startTimeISO": "2023-03-29T22:00:00Z", "anomalies":[ { "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "startTime":1672945500000, "startTimeISO": "2023-03-29T22:00:00Z", "openTime": 1680127740000, "openTimeISO": "2023-03-29T22:09:00Z", "sourceDetails":[ { "dataSource":"CW_METRICS", "dataIdentifiers":{ "namespace":"AWS/SQS", "name":"ApproximateAgeOfOldestMessage", "stat":"Maximum", "unit":"None", New association 77 Amazon DevOps Guru User Guide "period":"60", "dimensions":"{\"QueueName\":\"SampleQueue\"}" } } ], "associatedResourceArns":[ "arn:aws:sqs:eu-west-1:123456789101:SampleQueue" ] } ], "resourceCollection":{ "cloudFormation":{ "stackNames":[ "SampleApplication" ] } } } New recommendation Notifications for new recommendations contain the following information: { "accountId":"123456789101", "region":"us-east-1", "messageType":"NEW_RECOMMENDATION", "insightId":"a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "insightName": "Recreation of AWS SDK Service Clients", "insightUrl":"https://us-east-1.console.aws.amazon.com/devops-guru/insight/ proactive/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "insightType":"PROACTIVE", "insightDescription": "Usually for a given service you can create one [AWS SDK service client](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/creating- clients.html) and reuse that client across your entire service.\n\nWhen instead you create a new AWS SDK service client for each call (e.g. for DynamoDB) it\u0027s generally a waste of CPU time.", "insightSeverity":"medium", "startTime": 1680125893576, "startTimeISO": "2023-03-29T21:38:13.576Z", "recommendations":[ { "name":"Tune Availability Zones of your Lambda Function", New recommendation 78 Amazon DevOps Guru User Guide "description":"Based on your configurations, we recommend that you set SampleFunction to be deployed in at least 3 Availability Zones to maintain Multi Availability Zone Redundancy.", "reason":"Lambda Function SampleFunction is currently only deployed to 2 unique Availability zones in a region with 7 total Availability zones.", "link":"https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html", "relatedAnomalies":[ |
userguide-032 | userguide.pdf | 32 | clients.html) and reuse that client across your entire service.\n\nWhen instead you create a new AWS SDK service client for each call (e.g. for DynamoDB) it\u0027s generally a waste of CPU time.", "insightSeverity":"medium", "startTime": 1680125893576, "startTimeISO": "2023-03-29T21:38:13.576Z", "recommendations":[ { "name":"Tune Availability Zones of your Lambda Function", New recommendation 78 Amazon DevOps Guru User Guide "description":"Based on your configurations, we recommend that you set SampleFunction to be deployed in at least 3 Availability Zones to maintain Multi Availability Zone Redundancy.", "reason":"Lambda Function SampleFunction is currently only deployed to 2 unique Availability zones in a region with 7 total Availability zones.", "link":"https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html", "relatedAnomalies":[ { "sourceDetails":{ "cloudWatchMetrics":null }, "resources":[ { "name":"SampleFunction", "type":"AWS::Lambda::Function" } ], "associatedResourceArns": [ "arn:aws:lambda:arn:123456789101:SampleFunction" ] } ] } ], "resourceCollection": { "cloudFormation": { "stackNames":[ "SampleApplication" ] } } } Severity upgraded Notifications for severity upgrades contain the following information: { "accountId":"123456789101", "region":"eu-west-1", "messageType":"SEVERITY_UPGRADED", "insightId":"a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", Severity upgraded 79 Amazon DevOps Guru User Guide "insightName": "Repeated Insight: ApiGateway 5XXError Anomalous In Application CanaryCommonResources-123456789101-LogAnomaly-11", "insightUrl":"https://eu-west-1.console.aws.amazon.com/devops-guru/insight/reactive/ a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "insightType":"REACTIVE", "insightDescription": "DevOps Guru has detected this is a repeated insight. DevOps Guru will treat future occurrences of this insight as 'Low Severity' for the next 7 days.", "insightSeverity":"high", "startTime": 1680127320000, "startTimeISO": "2023-03-29T22:02:00Z", "resourceCollection":{ "cloudFormation":{ "stackNames":[ "SampleApplication" ] } } } Resource validation failure You can use AWS CloudFormation stacks and AWS tags to filter and identify the AWS resources that you want DevOps Guru to analyze. When you choose an invalid stack or tag for DevOps Guru to identify resources with, DevOps Guru creates a SELECTED_RESOURCE_FILTER_VALIDATION_FAILURE notification. This can happen when the tag or stack name that you specify does not have resources associated with it. To get the most out of DevOps Guru filtering methods, choose stacks and tags that have resources associated with them. { "accountId":"123456789101", "region":"eu-west-1", "messageType":"SELECTED_RESOURCE_FILTER_VALIDATION_FAILURE", "ResourceFilterType": "Tags", "InvalidResourceNames": [ "Devops-Guru-tag-key-tag-value" ], "awsInsightSource": "aws.devopsguru" } Resource validation failure 80 Amazon DevOps Guru User Guide Resource validation failure 81 Amazon DevOps Guru User Guide Viewing resources analyzed by DevOps Guru DevOps Guru provides a list of resource names and their application boundaries under analysis using the ListMonitoredResources action. This information is collected from Amazon CloudWatch, AWS CloudTrail, and other AWS services using the DevOps Guru service linked role. Note that even if a user does not have explicit permission to access the APIs for another service such as AWS Lambda or Amazon RDS, DevOps Guru still provides a list of resources from that service as long as the ListMonitoredResources action is allowed. Topics • Updating your AWS analysis coverage in DevOps Guru • Removing analyzed resource view for users Updating your AWS analysis coverage in DevOps Guru You can update which AWS resources in your account DevOps Guru analyzes. The resources that are analyzed make up your DevOps Guru coverage boundary. When you specify your boundary, your resources are grouped in applications. You have four boundary coverage options. • Choose to have DevOps Guru analyze all supported resources in your account. All resources in your account that are in a stack are grouped into an application. If you have multiple stacks in your account, then the resources in each stack make up their own application. If any resources in your account are not in a stack, they are grouped into their own application. • Specify resources by choosing AWS CloudFormation stacks that define those resources. If you do this, DevOps Guru analyzes every resource specified in the stacks you choose. If a resource in your account is not defined by a stack you choose, it is not analyzed. For more information, see Working with stacks in the AWS CloudFormation User Guide and Determine coverage for DevOps Guru. • Specify resources by using AWS tags. DevOps Guru either analyzes all the resources in your account and Region or all the resources that contain the tag key that you choose. Resources are grouped based on selected tag values. For more information, see Using tags to identify resources in your DevOps Guru applications. • Specify to have no resources analyzed so that you stop incurring charges from resource analyzation. Updating your AWS analysis coverage 82 Amazon DevOps Guru Note User Guide If you update your coverage to stop analyzing resources, you might continue to incur minor charges if you review existing insights generated by DevOps Guru in the past. These charges are associated with API calls used to retrieve and display insight information. For more information, see Amazon DevOps Guru pricing. DevOps Guru supports all resources that are associated with supported services. For more information about the supported services and resources, see Amazon DevOps Guru pricing. To manage your DevOps Guru analysis coverage 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Expand Analyzed resources in the navigation pane. 3. Choose Edit. 4. Choose one of the following coverage options. • Choose All account resources if |
userguide-033 | userguide.pdf | 33 | if you review existing insights generated by DevOps Guru in the past. These charges are associated with API calls used to retrieve and display insight information. For more information, see Amazon DevOps Guru pricing. DevOps Guru supports all resources that are associated with supported services. For more information about the supported services and resources, see Amazon DevOps Guru pricing. To manage your DevOps Guru analysis coverage 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Expand Analyzed resources in the navigation pane. 3. Choose Edit. 4. Choose one of the following coverage options. • Choose All account resources if you want DevOps Guru to analyze all supported resources in your AWS account and Region. If you choose this option, your AWS account is your resource analysis coverage boundary. All resources in each stack in your account are grouped into their own application. Any remaining resources that are not in a stack are grouped into their own application. • Choose CloudFormation stacks if you want DevOps Guru to analyze the resources that are in stacks you choose, then choose one of the following options. • All resources – All resources that are in stacks in your account are analyzed. Resources in each stack are grouped into their own application. Any resources in your account that are not in a stack are not analyzed. • Select stacks – Select the stacks that you want DevOps Guru to analyze. The resources in each stack you select are grouped into their own application. You can enter the name of a stack in Find stacks to quickly locate a specific stack. You can select up to 1,000 stacks. For more information, see Using AWS CloudFormation stacks to identify resources in your DevOps Guru applications. • Choose Tags if you want DevOps Guru to analyze all resources that contain the tags you choose. Choose a key, then choose one of the following options. Updating your AWS analysis coverage 83 Amazon DevOps Guru User Guide • All account resources –Analyze all AWS resources in the current Region and account. Resources with the selected tag key are grouped by tag value, if any exist. Resources without this tag key are grouped and analyzed separately. • Choose specific tag values – All resources that contain a tag with the key you chose are analyzed. DevOps Guru groups your resources into applications by your tag's values. For more information, see Using tags to identify resources in your DevOps Guru applications. • Choose None if you do not want DevOps Guru to analyze any resources. This option disables DevOps Guru so that you stop incurring charges from resource analyzation. 5. Choose Save. Removing analyzed resource view for users Even if a user does not have explicit permission to access the APIs for another service such as Lambda or Amazon RDS, DevOps Guru still provides a list of resources from that service as long as the ListMonitoredResources action is allowed. To change this behavior, you can update your AWS IAM policy to deny this action. { "Sid": "DenyListMonitoredResources", "Effect": "Deny", "Action": [ "devops-guru:ListMonitoredResources" ] } Removing analyzed resource view for users 84 Amazon DevOps Guru User Guide Best practices in DevOps Guru The following best practices can help you understand, diagnose, and fix anomalous behavior detected by Amazon DevOps Guru. Use best practices with Understanding insights in the DevOps Guru console to address operational problems detected by DevOps Guru. • In an insight's timeline view, look at the highlighted metrics first. They are often key indicators of the problem. • Use Amazon CloudWatch to view metrics that occurred immediately before the first highlighted metric in an insight to pinpoint when and how behavior changed. This can help you diagnose and fix the problem. • For Amazon RDS resources, look at Performance Insights metrics. By correlating counter metrics with database load, you can get detailed information about performance issues. For more information, see Analyzing performance anomalies with DevOps Gurufor Amazon RDS. • Multiple dimensions of the same metric can often be anomalous. Look at the dimensions in the graphed view to get a deeper understanding of the problem. • Look in the events section of an insight for deployment or infrastructure events that happened around the time the insight was created. Knowing which events occurred when an insight's anomalous behavior occurred can help you understand and diagnose the problem. • Look for tickets in your operational system that happened around the same time as an insight for clues. • In an insight, read the recommendations and visit the links in recommendations. These often have troubleshooting steps that can help you diagnose and solve problems quickly. • Don't ignore resolved insights unless you have already solved the problem. Once a day, look at new insights, even if they have been resolved. Try to |
userguide-034 | userguide.pdf | 34 | that happened around the time the insight was created. Knowing which events occurred when an insight's anomalous behavior occurred can help you understand and diagnose the problem. • Look for tickets in your operational system that happened around the same time as an insight for clues. • In an insight, read the recommendations and visit the links in recommendations. These often have troubleshooting steps that can help you diagnose and solve problems quickly. • Don't ignore resolved insights unless you have already solved the problem. Once a day, look at new insights, even if they have been resolved. Try to understand the root cause behind as many of the insights as you can. Look for a pattern that might be the sign of a systemic problem. If a systemic problem is left unresolved, it could cause more serious problems in the future. Fixing transient issues now can help prevent future, more serious, incidents. 85 Amazon DevOps Guru User Guide Security in Amazon DevOps Guru Cloud security at AWS is the highest priority. As an AWS customer, you benefit from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third-party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to Amazon DevOps Guru, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using DevOps Guru. The following topics show you how to configure DevOps Guru to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your DevOps Guru resources. Topics • Data protection in Amazon DevOps Guru • Identity and Access Management for Amazon DevOps Guru • Logging and monitoring DevOps Guru • DevOps Guru and interface VPC endpoints (AWS PrivateLink) • Infrastructure security in DevOps Guru • Resilience in Amazon DevOps Guru Data protection in Amazon DevOps Guru The AWS shared responsibility model applies to data protection in Amazon DevOps Guru. As described in this model, AWS is responsible for protecting the global infrastructure that runs all Data protection 86 Amazon DevOps Guru User Guide of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with DevOps Guru or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If |
userguide-035 | userguide.pdf | 35 | AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with DevOps Guru or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data encryption in DevOps Guru Encryption is an important part of DevOps Guru security. Some encryption, such as for data in transit, is provided by default and does not require you to do anything. Other encryption, such as for data at rest, you can configure when you create your project or build. Data encryption 87 Amazon DevOps Guru User Guide • Encryption of data in-transit: All communication between customers and DevOps Guru and between DevOps Guru and its downstream dependencies is protected using TLS and authenticated using the Signature Version 4 signing process. All DevOps Guru endpoints use certificates managed by AWS Private Certificate Authority. For more information, see Signature Version 4 signing process and What is ACM PCA. • Encryption of data at-rest: For all AWS resources analyzed by DevOps Guru, the Amazon CloudWatch metrics and data, resource IDs, and AWS CloudTrail events are stored using Amazon S3, Amazon DynamoDB, and Amazon Kinesis. If AWS CloudFormation stacks are used to define the analyzed resources, then stack data is also collected. DevOps Guru uses the data retention policies of Amazon S3, DynamoDB, and Kinesis. Data stored in Kinesis can be retained for up to one year and depends on the policies set. Data stored in Amazon S3 and DynamoDB is stored for one year. Stored data is encrypted using the data-at-rest encryption capabilities of Amazon S3, DynamoDB, and Kinesis. Customer managed keys: DevOps Guru supports encrypting customer content and sensitive metadata such as log anomalies generated from CloudWatch Logs with customer managed keys. This feature provides you the option of adding a self-managed security layer to help you meet the compliance and regulatory requirements of your organization. For information on enabling customer managed keys in your DevOps Guru settings, see the section called “Updating encryption”. Because you have full control of this layer of encryption, you can perform such tasks as: • Establishing and maintaining key policies • Establishing and maintaining IAM policies and grants • Enabling and disabling key policies • Rotating key cryptographic material • Adding tags • Creating key aliases • Scheduling keys for deletion For more information, see Customer managed keys in the AWS Key Management Service Developer Guide. Data encryption 88 Amazon DevOps Guru Note User Guide DevOps Guru automatically enables encryption at rest using AWS owned keys to protect sensitive metadata at no charge. However, AWS KMS charges apply for using a customer managed key. For more information about pricing, see the AWS Key Management Service pricing. How DevOps Guru uses grants in AWS KMS DevOps Guru requires a grant to use your customer managed key. When you choose to enable encryption with a customer managed key, DevOps Guru creates a grant on your behalf by sending a CreateGrant request to AWS KMS. Grants in AWS KMS are used to give DevOps Guru access to a AWS KMS key in a customer account. DevOps Guru requires the grant to use your customer managed key for the following internal operations: • Send DescribeKey requests to AWS KMS to verify that the symmetric customer managed KMS key ID entered when creating a tracker or geofence collection is valid. • Send GenerateDataKey requests to AWS KMS to generate data keys encrypted by your customer managed key. • Send Decrypt requests to AWS KMS to decrypt the encrypted data keys so that they can be used to encrypt your data. You can revoke access to the grant, or remove the service's access to the customer managed key at any time. If you do, DevOps Guru won't be able to access any of the data encrypted by the customer managed key, which affects operations that are dependent on that data. For example, if you attempt to get encrypted log anomaly information that DevOps Guru can't access, then the operation would return an AccessDeniedException error. Monitoring your encryption keys in DevOps Guru When you use an AWS KMS customer managed key with your DevOps Guru resources, you can use AWS CloudTrail or CloudWatch Logs to track requests that DevOps Guru sends to |
userguide-036 | userguide.pdf | 36 | service's access to the customer managed key at any time. If you do, DevOps Guru won't be able to access any of the data encrypted by the customer managed key, which affects operations that are dependent on that data. For example, if you attempt to get encrypted log anomaly information that DevOps Guru can't access, then the operation would return an AccessDeniedException error. Monitoring your encryption keys in DevOps Guru When you use an AWS KMS customer managed key with your DevOps Guru resources, you can use AWS CloudTrail or CloudWatch Logs to track requests that DevOps Guru sends to AWS KMS. How DevOps Guru uses grants in AWS KMS 89 Amazon DevOps Guru User Guide Create a customer managed key You can create a symmetric customer managed key by using the AWS Management Console or the AWS KMS APIs. To create a symmetric customer managed key, see Creating symmetric encryption KMS keys. Key policy Key policies control access to your customer managed key. Every customer managed key must have exactly one key policy, which contains statements that determine who can use the key and how they can use it. When you create your customer managed key, you can specify a key policy. For more information, see Authentication and access control for AWS KMS in the AWS Key Management Service Developer Guide. To use your customer managed key with your DevOps Guru resources, the following API operations must be permitted in the key policy: • kms:CreateGrant – Adds a grant to a customer managed key. Grants control access to a specified AWS KMS key, which allows access to grant operations DevOps Guru requires. For more information about using grants, see the AWS Key Management Service Developer Guide. This allows DevOps Guru to do the following: • Call GenerateDataKey to generate an encrypted data key and store it, because the data key isn't immediately used to encrypt. • Call Decrypt to use the stored encrypted data key to access encrypted data. • Set up a retiring principal to allow the service to RetireGrant. • Use kms:DescribeKey to provide the customer managed key details to allow DevOps Guru to validate the key. The following statement includes policy statement examples you can add for DevOps Guru: "Statement" : [ { "Sid" : "Allow access to principals authorized to use DevOps Guru", "Effect" : "Allow", "Principal" : { Create a customer managed key 90 User Guide Amazon DevOps Guru "AWS" : "*" }, "Action" : [ "kms:DescribeKey", "kms:CreateGrant" ], "Resource" : "*", "Condition" : { "StringEquals" : { "kms:ViaService" : "devops-guru.Region.amazonaws.com", "kms:CallerAccount" : "111122223333" } }, { "Sid": "Allow access for key administrators", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action" : [ "kms:*" ], "Resource": "arn:aws:kms:region:111122223333:key/key_ID" }, { "Sid" : "Allow read-only access to key metadata to the account", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::111122223333:root" }, "Action" : [ "kms:Describe*", "kms:Get*", "kms:List*" ], "Resource" : "*" } ] Traffic privacy You can improve the security of your resource analysis and insight generation by configuring DevOps Guru to use an interface VPC endpoint. To do this, you do not need an internet gateway, Traffic privacy 91 Amazon DevOps Guru User Guide NAT device, or virtual private gateway. It also is not required to configure PrivateLink, though it is recommended. For more information, see DevOps Guru and interface VPC endpoints (AWS PrivateLink). For more information about PrivateLink and VPC endpoints, see AWS PrivateLink and Accessing AWS services through PrivateLink. Identity and Access Management for Amazon DevOps Guru AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use DevOps Guru resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • DevOps Guru updates to AWS managed policies and service-linked role • How Amazon DevOps Guru works with IAM • Identity-based policies for Amazon DevOps Guru • Using service-linked roles for DevOps Guru • Amazon DevOps Guru permissions reference • Permissions for Amazon SNS topics • Permissions for AWS KMS–encrypted Amazon SNS topics • Troubleshooting Amazon DevOps Guru identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in DevOps Guru. Service user – If you use the DevOps Guru service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more DevOps Guru features to do your work, you might need additional permissions. Understanding how access is managed can Identity and Access Management 92 Amazon DevOps Guru User Guide help you request the right permissions from your administrator. If you |
userguide-037 | userguide.pdf | 37 | topics • Troubleshooting Amazon DevOps Guru identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in DevOps Guru. Service user – If you use the DevOps Guru service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more DevOps Guru features to do your work, you might need additional permissions. Understanding how access is managed can Identity and Access Management 92 Amazon DevOps Guru User Guide help you request the right permissions from your administrator. If you cannot access a feature in DevOps Guru, see Troubleshooting Amazon DevOps Guru identity and access. Service administrator – If you're in charge of DevOps Guru resources at your company, you probably have full access to DevOps Guru. It's your job to determine which DevOps Guru features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with DevOps Guru, see How Amazon DevOps Guru works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to DevOps Guru. To view example DevOps Guru identity-based policies that you can use in IAM, see Identity-based policies for Amazon DevOps Guru. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in Authenticating with identities 93 Amazon DevOps Guru User Guide the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity |
userguide-038 | userguide.pdf | 38 | provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier Authenticating with identities 94 Amazon DevOps Guru User Guide to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. Authenticating with identities 95 Amazon DevOps Guru User Guide • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or |
userguide-039 | userguide.pdf | 39 | role, or using a service-linked role. Authenticating with identities 95 Amazon DevOps Guru User Guide • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. Managing access using policies 96 Amazon DevOps Guru User Guide By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. |
userguide-040 | userguide.pdf | 40 | customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Managing access using policies 97 Amazon DevOps Guru Access control lists (ACLs) User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's Managing access using policies 98 Amazon DevOps Guru User Guide permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. DevOps Guru updates to AWS managed policies and service-linked role View details about updates to AWS managed policies and service-linked role for DevOps Guru since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the DevOps Guru Amazon DevOps Guru document history. Change Description Date AmazonDevOpsGuruCo nsoleFullAccess – Update to an existing policy. AmazonDevOpsGuruRe adOnlyAccess – Update to an existing policy AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. The AmazonDevOpsGuruFu llAccess managed policy now supports Amazon SNS subscriptions. The AmazonDevOpsGuruRe managed adOnlyAccess policy now supports read- only access to Amazon SNS subscription lists. The AWSServiceRoleForD evOpsGuru service-linked role now supports access to API Gateway GET actions on REST APIs. August 9, 2023 |
userguide-041 | userguide.pdf | 41 | since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the DevOps Guru Amazon DevOps Guru document history. Change Description Date AmazonDevOpsGuruCo nsoleFullAccess – Update to an existing policy. AmazonDevOpsGuruRe adOnlyAccess – Update to an existing policy AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. The AmazonDevOpsGuruFu llAccess managed policy now supports Amazon SNS subscriptions. The AmazonDevOpsGuruRe managed adOnlyAccess policy now supports read- only access to Amazon SNS subscription lists. The AWSServiceRoleForD evOpsGuru service-linked role now supports access to API Gateway GET actions on REST APIs. August 9, 2023 August 9, 2023 January 11, 2023 AmazonDevOpsGuruSe rviceRolePolicy – Update to The AWSServiceRoleForD evOpsGuru service-linked October 19, 2022 an existing policy. Policy updates 99 Amazon DevOps Guru User Guide Change Description Date role now supports several Amazon Simple Storage Service and Service Quotas actions. AmazonDevOpsGuruFu llAccess – Update to an existing policy The AmazonDevOpsGuruFu llAccess managed policy August 30, 2022 AmazonDevOpsGuruCo nsoleFullAccess – Update to an existing policy AmazonDevOpsGuruRe adOnlyAccess – Update to an existing policy AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. now supports access to the CloudWatch FilterLog Events action. The AmazonDevOpsGuruCo August 30, 2022 nsoleFullAccess managed policy now supports access to the CloudWatch FilterLogEvents action. The AmazonDevOpsGuruRe managed adOnlyAccess policy now supports read- only access to the CloudWatc h FilterLogEvents a ction. The AWSServiceRoleForD evOpsGuru service-l inked role now supports the CloudWatch logs actions FilterLogEvents , DescribeLogGroups , and DescribeLogStreams . August 30, 2022 July 12, 2022 Identity-based policies for DevOps Guru – New managed policy. The AmazonDevOpsGuruCo policy nsoleFullAccess has been added. December 16, 2021 Policy updates 100 Amazon DevOps Guru User Guide Change Description Date AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. AmazonDevOpsGuruRe adOnlyAccess – Update to an existing policy AmazonDevOpsGuruFu llAccess – Update to an existing policy December 1, 2021 December 1, 2021 December 1, 2021 The AWSServiceRoleForD evOpsGuru service-l inked role now supports Performance Insights DescribeMetricsKey s , and Amazon RDS DescribeDBInstances actions. The AmazonDevOpsGuruRe managed adOnlyAccess policy now supports read- only access to Amazon RDS DescribeDBInstances actions. The AmazonDevOpsGuruFu llAccess managed policy now supports access to Amazon RDS DescribeD BInstances actions. Policy updates 101 Amazon DevOps Guru User Guide Change Description Date Identity-based policies for A mazon DevOps Guru – New policy added. AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. Service-linked role permissio ns for DevOps Guru – Update to an existing policy. November 16, 2021 November 4, 2021 October 11, 2021 June 14, 2021 The AWSServiceRoleForD evOpsGuru service-l inked role now supports access to Amazon RDS DescribeDBInstances and Performance Insights GetResourceMetrics actions. The AmazonDevOpsGuruOr ganizationsAccess managed policy provides access to DevOps Guru within an organization. The AWSServiceRoleForD evOpsGuru service-l inked role now supports AWS Organizations. The AWSServiceRoleForD evOpsGuru service-l inked role now contains new conditions on the ssm:CreateOpsItem and ssm:AddTagsToResou rce actions. The AWSServiceRoleForD evOpsGuru service-l inked role now contains new conditions on the ssm:CreateOpsItem and ssm:AddTagsToResou rce actions. Policy updates 102 Amazon DevOps Guru User Guide Change Description Date AmazonDevOpsGuruRe adOnlyAccess – Update to an existing policy AmazonDevOpsGuruRe adOnlyAccess – Update to an existing policy June 14, 2021 April 27, 2021 The AmazonDevOpsGuruRe managed adOnlyAccess policy now allows read-only access to the AWS Identity and Access Managemen t GetRole and the DevOps Guru DescribeF eedback actions. The AmazonDevOpsGuruRe managed adOnlyAccess policy now allows read-only access to the DevOps Guru GetCostEstimation and StartCostEstimation actions. AmazonDevOpsGuruSe rviceRolePolicy – Update to an existing policy. The AWSServiceRoleForD evOpsGuru role now allows access to the AWS April 27, 2021 Systems Manager AddTagsTo Resource and Amazon EC2 Auto Scaling DescribeA utoScalingGroups actions. DevOps Guru started tracking changes DevOps Guru started tracking changes for its AWS managed policies. December 10, 2020 How Amazon DevOps Guru works with IAM Before you use IAM to manage access to DevOps Guru, learn what IAM features are available to use with DevOps Guru. How Amazon DevOps Guru works with IAM 103 Amazon DevOps Guru User Guide IAM features you can use with Amazon DevOps Guru IAM feature DevOps Guru support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys ACLs ABAC (tags in policies) Temporary credentials Principal permissions Service roles Service-linked roles Yes No Yes Yes Yes No No Yes Yes No Yes To get a high-level view of how DevOps Guru and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for DevOps Guru Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create |
userguide-042 | userguide.pdf | 42 | Service roles Service-linked roles Yes No Yes Yes Yes No No Yes Yes No Yes To get a high-level view of how DevOps Guru and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for DevOps Guru Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all How Amazon DevOps Guru works with IAM 104 Amazon DevOps Guru User Guide of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for DevOps Guru To view examples of DevOps Guru identity-based policies, see Identity-based policies for Amazon DevOps Guru. Resource-based policies within DevOps Guru Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for DevOps Guru Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API How Amazon DevOps Guru works with IAM 105 Amazon DevOps Guru User Guide operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of DevOps Guru actions, see Actions defined by Amazon DevOps Guru in the Service Authorization Reference. Policy actions in DevOps Guru use the following prefix before the action: aws To specify multiple actions in a single statement, separate them with commas. "Action": [ "aws:action1", "aws:action2" ] To view examples of DevOps Guru identity-based policies, see Identity-based policies for Amazon DevOps Guru. Policy resources for DevOps Guru Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" How Amazon DevOps Guru works with IAM 106 Amazon DevOps Guru User Guide To see a list of DevOps Guru resource types and their ARNs, see Resources defined by Amazon DevOps Guru in the Service Authorization Reference. To learn with which actions you can specify the ARN of |
userguide-043 | userguide.pdf | 43 | practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" How Amazon DevOps Guru works with IAM 106 Amazon DevOps Guru User Guide To see a list of DevOps Guru resource types and their ARNs, see Resources defined by Amazon DevOps Guru in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon DevOps Guru. To view examples of DevOps Guru identity-based policies, see Identity-based policies for Amazon DevOps Guru. Policy condition keys for DevOps Guru Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of DevOps Guru condition keys, see Condition keys for Amazon DevOps Guru in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by Amazon DevOps Guru. To view examples of DevOps Guru identity-based policies, see Identity-based policies for Amazon DevOps Guru. Access control lists (ACLs) in DevOps Guru Supports ACLs: No How Amazon DevOps Guru works with IAM 107 Amazon DevOps Guru User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Attribute-based access control (ABAC) with DevOps Guru Supports ABAC (tags in policies): No Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using Temporary credentials with DevOps Guru Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then How Amazon DevOps Guru works with IAM 108 Amazon DevOps Guru User Guide switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You |
userguide-044 | userguide.pdf | 44 | IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then How Amazon DevOps Guru works with IAM 108 Amazon DevOps Guru User Guide switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for DevOps Guru Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for DevOps Guru Supports service roles: No A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break DevOps Guru functionality. Edit service roles only when DevOps Guru provides guidance to do so. Service-linked roles for DevOps Guru Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS How Amazon DevOps Guru works with IAM 109 Amazon DevOps Guru User Guide account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policies for Amazon DevOps Guru By default, users and roles don't have permission to create or modify DevOps Guru resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by DevOps Guru, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for Amazon DevOps Guru in the Service Authorization Reference. Topics • Policy best practices • Using the DevOps Guru console • Allow users to view their own permissions • AWS managed (predefined) policies for DevOps Guru Policy best practices Identity-based policies determine whether someone can create, access, or delete DevOps Guru resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies Identity-based policies 110 Amazon DevOps Guru User Guide that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific |
userguide-045 | userguide.pdf | 45 | policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies Identity-based policies 110 Amazon DevOps Guru User Guide that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the DevOps Guru console To access the Amazon DevOps Guru console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the DevOps Guru resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. Identity-based policies 111 Amazon DevOps Guru User Guide To ensure that users and roles can still use the DevOps Guru console, also attach the DevOps Guru AmazonDevOpsGuruReadOnlyAccess or AmazonDevOpsGuruFullAccess AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] } Identity-based policies 112 Amazon DevOps Guru User Guide AWS managed (predefined) policies for DevOps Guru AWS addresses many common use cases by providing standalone IAM policies that are created and administered by AWS. These AWS-managed policies grant necessary permissions for common use cases so you can avoid having to investigate what permissions are needed. For more information, see AWS Managed Policies in the IAM User Guide. To create and manage DevOps Guru service roles, you must also attach the AWS-managed policy named IAMFullAccess. You can also create your own custom IAM policies to allow permissions for DevOps Guru actions and resources. You can attach these custom policies to the users or groups that require those permissions. The following AWS-managed policies, which you can attach to users in your account, are specific to DevOps Guru. Topics • AmazonDevOpsGuruFullAccess • AmazonDevOpsGuruConsoleFullAccess • AmazonDevOpsGuruReadOnlyAccess • AmazonDevOpsGuruOrganizationsAccess AmazonDevOpsGuruFullAccess AmazonDevOpsGuruFullAccess – Provides full access to DevOps Guru, including permissions to create Amazon SNS topics, access Amazon CloudWatch metrics, and access AWS CloudFormation stacks. Apply this only to administrative-level users to whom you want to grant full control over DevOps Guru. The AmazonDevOpsGuruFullAccess policy |
userguide-046 | userguide.pdf | 46 | own custom IAM policies to allow permissions for DevOps Guru actions and resources. You can attach these custom policies to the users or groups that require those permissions. The following AWS-managed policies, which you can attach to users in your account, are specific to DevOps Guru. Topics • AmazonDevOpsGuruFullAccess • AmazonDevOpsGuruConsoleFullAccess • AmazonDevOpsGuruReadOnlyAccess • AmazonDevOpsGuruOrganizationsAccess AmazonDevOpsGuruFullAccess AmazonDevOpsGuruFullAccess – Provides full access to DevOps Guru, including permissions to create Amazon SNS topics, access Amazon CloudWatch metrics, and access AWS CloudFormation stacks. Apply this only to administrative-level users to whom you want to grant full control over DevOps Guru. The AmazonDevOpsGuruFullAccess policy contains the following statement. { "Version": "2012-10-17", "Statement": [ { "Sid": "DevOpsGuruFullAccess", "Effect": "Allow", "Action": [ "devops-guru:*" Identity-based policies 113 User Guide Amazon DevOps Guru ], "Resource": "*" }, { "Sid": "CloudFormationListStacksAccess", "Effect": "Allow", "Action": [ "cloudformation:DescribeStacks", "cloudformation:ListStacks" ], "Resource": "*" }, { "Sid": "CloudWatchGetMetricDataAccess", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData" ], "Resource": "*" }, { "Sid": "SnsListTopicsAccess", "Effect": "Allow", "Action": [ "sns:ListTopics", "sns:ListSubscriptionsByTopic" ], "Resource": "*" }, { "Sid": "SnsTopicOperations", "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:GetTopicAttributes", "sns:SetTopicAttributes", "sns:Subscribe", "sns:Publish" ], "Resource": "arn:aws:sns:*:*:DevOps-Guru-*" }, { "Sid": "DevOpsGuruSlrCreation", "Effect": "Allow", Identity-based policies 114 Amazon DevOps Guru User Guide "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/devops- guru.amazonaws.com/AWSServiceRoleForDevOpsGuru", "Condition": { "StringLike": { "iam:AWSServiceName": "devops-guru.amazonaws.com" } } }, { "Sid": "DevOpsGuruSlrDeletion", "Effect": "Allow", "Action": [ "iam:DeleteServiceLinkedRole", "iam:GetServiceLinkedRoleDeletionStatus" ], "Resource": "arn:aws:iam::*:role/aws-service-role/devops- guru.amazonaws.com/AWSServiceRoleForDevOpsGuru" }, { "Sid": "RDSDescribeDBInstancesAccess", "Effect": "Allow", "Action": [ "rds:DescribeDBInstances" ], "Resource": "*" }, { "Sid": "CloudWatchLogsFilterLogEventsAccess", "Effect": "Allow", "Action": [ "logs:FilterLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:*", "Condition": { "StringEquals": { "aws:ResourceTag/DevOps-Guru-Analysis": "true" } } } ] } Identity-based policies 115 Amazon DevOps Guru User Guide AmazonDevOpsGuruConsoleFullAccess AmazonDevOpsGuruConsoleFullAccess – Provides full access to DevOps Guru, including permissions to create Amazon SNS topics, access Amazon CloudWatch metrics, and access AWS CloudFormation stacks. This policy has additional performance insights permissions so you can view detailed analysis related to anomalous Amazon RDS Aurora DB instances in the console. Apply this only to administrative-level users to whom you want to grant full control over DevOps Guru. The AmazonDevOpsGuruConsoleFullAccess policy contains the following statement. { "Version": "2012-10-17", "Statement": [ { "Sid": "DevOpsGuruFullAccess", "Effect": "Allow", "Action": [ "devops-guru:*" ], "Resource": "*" }, { "Sid": "CloudFormationListStacksAccess", "Effect": "Allow", "Action": [ "cloudformation:DescribeStacks", "cloudformation:ListStacks" ], "Resource": "*" }, { "Sid": "CloudWatchGetMetricDataAccess", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData" ], "Resource": "*" }, { "Sid": "SnsListTopicsAccess", "Effect": "Allow", "Action": [ "sns:ListTopics", Identity-based policies 116 Amazon DevOps Guru User Guide "sns:ListSubscriptionsByTopic" ], "Resource": "*" }, { "Sid": "SnsTopicOperations", "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:GetTopicAttributes", "sns:SetTopicAttributes", "sns:Subscribe", "sns:Publish" ], "Resource": "arn:aws:sns:*:*:DevOps-Guru-*" }, { "Sid": "DevOpsGuruSlrCreation", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/devops- guru.amazonaws.com/AWSServiceRoleForDevOpsGuru", "Condition": { "StringLike": { "iam:AWSServiceName": "devops-guru.amazonaws.com" } } }, { "Sid": "DevOpsGuruSlrDeletion", "Effect": "Allow", "Action": [ "iam:DeleteServiceLinkedRole", "iam:GetServiceLinkedRoleDeletionStatus" ], "Resource": "arn:aws:iam::*:role/aws-service-role/devops- guru.amazonaws.com/AWSServiceRoleForDevOpsGuru" }, { "Sid": "RDSDescribeDBInstancesAccess", "Effect": "Allow", "Action": [ "rds:DescribeDBInstances" ], Identity-based policies 117 User Guide Amazon DevOps Guru "Resource": "*" }, { "Sid": "PerformanceInsightsMetricsDataAccess", "Effect": "Allow", "Action": [ "pi:GetResourceMetrics", "pi:DescribeDimensionKeys" ], "Resource": "*" }, { "Sid": "CloudWatchLogsFilterLogEventsAccess", "Effect": "Allow", "Action": [ "logs:FilterLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:*", "Condition": { "StringEquals": { "aws:ResourceTag/DevOps-Guru-Analysis": "true" } } } ] } AmazonDevOpsGuruReadOnlyAccess AmazonDevOpsGuruReadOnlyAccess – Grants read-only access to DevOps Guru and related resources in other AWS services. Apply this policy to users to whom you want to grant the ability to view insights, but not to make any updates to DevOps Guru's analysis coverage boundary, Amazon SNS topics, or Systems Manager OpsCenter integration. The AmazonDevOpsGuruReadOnlyAccess policy contains the following statement. { "Version": "2012-10-17", "Statement": [ { "Sid": "DevOpsGuruReadOnlyAccess", "Effect": "Allow", Identity-based policies 118 Amazon DevOps Guru "Action": [ User Guide "devops-guru:DescribeAccountHealth", "devops-guru:DescribeAccountOverview", "devops-guru:DescribeAnomaly", "devops-guru:DescribeEventSourcesConfig", "devops-guru:DescribeFeedback", "devops-guru:DescribeInsight", "devops-guru:DescribeResourceCollectionHealth", "devops-guru:DescribeServiceIntegration", "devops-guru:GetCostEstimation", "devops-guru:GetResourceCollection", "devops-guru:ListAnomaliesForInsight", "devops-guru:ListEvents", "devops-guru:ListInsights", "devops-guru:ListAnomalousLogGroups", "devops-guru:ListMonitoredResources", "devops-guru:ListNotificationChannels", "devops-guru:ListRecommendations", "devops-guru:SearchInsights", "devops-guru:StartCostEstimation" ], "Resource": "*" }, { "Sid": "CloudFormationListStacksAccess", "Effect": "Allow", "Action": [ "cloudformation:DescribeStacks", "cloudformation:ListStacks" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:GetRole" ], "Resource": "arn:aws:iam::*:role/aws-service-role/devops- guru.amazonaws.com/AWSServiceRoleForDevOpsGuru" }, { "Sid": "CloudWatchGetMetricDataAccess", "Effect": "Allow", "Action": [ Identity-based policies 119 Amazon DevOps Guru User Guide "cloudwatch:GetMetricData" ], "Resource": "*" }, { "Sid": "RDSDescribeDBInstancesAccess", "Effect": "Allow", "Action": [ "rds:DescribeDBInstances" ], "Resource": "*" }, { "Sid": "SnsListTopicsAccess", "Effect": "Allow", "Action": [ "sns:ListTopics", "sns:ListSubscriptionsByTopic" ], "Resource": "*" }, { "Sid": "CloudWatchLogsFilterLogEventsAccess", "Effect": "Allow", "Action": [ "logs:FilterLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:*", "Condition": { "StringEquals": { "aws:ResourceTag/DevOps-Guru-Analysis": "true" } } } ] } AmazonDevOpsGuruOrganizationsAccess AmazonDevOpsGuruOrganizationsAccess – Provides Organizations administrators access to the DevOps Guru multi-account view within an organization. Apply this policy to your organization's administrator-level users for whom you want to grant full access to DevOps Guru within an organization. You can apply this policy in your organization's Identity-based policies 120 Amazon DevOps Guru User Guide management account and delegated administrator account for DevOps Guru. You can apply AmazonDevOpsGuruReadOnlyAccess or AmazonDevOpsGuruFullAccess in addition to this policy to provide read-only or full access to DevOps Guru. The AmazonDevOpsGuruOrganizationsAccess policy contains the following statement. { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonDevOpsGuruOrganizationsAccess", "Effect": "Allow", "Action": |
userguide-047 | userguide.pdf | 47 | AmazonDevOpsGuruOrganizationsAccess – Provides Organizations administrators access to the DevOps Guru multi-account view within an organization. Apply this policy to your organization's administrator-level users for whom you want to grant full access to DevOps Guru within an organization. You can apply this policy in your organization's Identity-based policies 120 Amazon DevOps Guru User Guide management account and delegated administrator account for DevOps Guru. You can apply AmazonDevOpsGuruReadOnlyAccess or AmazonDevOpsGuruFullAccess in addition to this policy to provide read-only or full access to DevOps Guru. The AmazonDevOpsGuruOrganizationsAccess policy contains the following statement. { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonDevOpsGuruOrganizationsAccess", "Effect": "Allow", "Action": [ "devops-guru:DescribeOrganizationHealth", "devops-guru:DescribeOrganizationResourceCollectionHealth", "devops-guru:DescribeOrganizationOverview", "devops-guru:ListOrganizationInsights", "devops-guru:SearchOrganizationInsights" ], "Resource": "*" }, { "Sid": "OrganizationsDataAccess", "Effect": "Allow", "Action": [ "organizations:DescribeAccount", "organizations:DescribeOrganization", "organizations:ListAWSServiceAccessForOrganization", "organizations:ListAccounts", "organizations:ListChildren", "organizations:ListOrganizationalUnitsForParent", "organizations:ListRoots" ], "Resource": "arn:aws:organizations::*:" }, { "Sid": "OrganizationsAdminDataAccess", "Effect": "Allow", "Action": [ "organizations:DeregisterDelegatedAdministrator", "organizations:RegisterDelegatedAdministrator", "organizations:ListDelegatedAdministrators", "organizations:EnableAWSServiceAccess", Identity-based policies 121 Amazon DevOps Guru User Guide "organizations:DisableAWSServiceAccess" ], "Resource": "*", "Condition": { "StringEquals": { "organizations:ServicePrincipal": [ "devops-guru.amazonaws.com" ] } } } ] } Using service-linked roles for DevOps Guru Amazon DevOps Guru uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to DevOps Guru. Service- linked roles are predefined by DevOps Guru and include all the permissions that the service requires to call AWS CloudTrail, Amazon CloudWatch, AWS CodeDeploy, AWS X-Ray, and AWS Organizations on your behalf. A service-linked role makes setting up DevOps Guru easier because you don’t have to manually add the necessary permissions. DevOps Guru defines the permissions of its service-linked roles, and unless defined otherwise, only DevOps Guru can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete a service-linked role only after first deleting its related resources. This protects your DevOps Guru resources because you can't inadvertently remove permission to access the resources. Service-linked role permissions for DevOps Guru DevOps Guru uses the service-linked role named AWSServiceRoleForDevOpsGuru. This is an AWS managed policy with scoped permissions that DevOps Guru needs to run in your account. The AWSServiceRoleForDevOpsGuru service-linked role trusts the following service to assume the role: • devops-guru.amazonaws.com Using service-linked roles 122 Amazon DevOps Guru User Guide The role permissions policy, AmazonDevOpsGuruServiceRolePolicy allows DevOps Guru to complete the following actions on the specified resources. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "autoscaling:DescribeAutoScalingGroups", "cloudtrail:LookupEvents", "cloudwatch:GetMetricData", "cloudwatch:ListMetrics", "cloudwatch:DescribeAnomalyDetectors", "cloudwatch:DescribeAlarms", "cloudwatch:ListDashboards", "cloudwatch:GetDashboard", "cloudformation:GetTemplate", "cloudformation:ListStacks", "cloudformation:ListStackResources", "cloudformation:DescribeStacks", "cloudformation:ListImports", "codedeploy:BatchGetDeployments", "codedeploy:GetDeploymentGroup", "codedeploy:ListDeployments", "config:DescribeConfigurationRecorderStatus", "config:GetResourceConfigHistory", "events:ListRuleNamesByTarget", "xray:GetServiceGraph", "organizations:ListRoots", "organizations:ListChildren", "organizations:ListDelegatedAdministrators", "pi:GetResourceMetrics", "tag:GetResources", "lambda:GetFunction", "lambda:GetFunctionConcurrency", "lambda:GetAccountSettings", "lambda:ListProvisionedConcurrencyConfigs", "lambda:ListAliases", "lambda:ListEventSourceMappings", "lambda:GetPolicy", "ec2:DescribeSubnets", "application-autoscaling:DescribeScalableTargets", Using service-linked roles 123 Amazon DevOps Guru User Guide "application-autoscaling:DescribeScalingPolicies", "sqs:GetQueueAttributes", "kinesis:DescribeStream", "kinesis:DescribeLimits", "dynamodb:DescribeTable", "dynamodb:DescribeLimits", "dynamodb:DescribeContinuousBackups", "dynamodb:DescribeStream", "dynamodb:ListStreams", "elasticloadbalancing:DescribeLoadBalancers", "elasticloadbalancing:DescribeLoadBalancerAttributes", "rds:DescribeDBInstances", "rds:DescribeDBClusters", "rds:DescribeOptionGroups", "rds:DescribeDBClusterParameters", "rds:DescribeDBInstanceAutomatedBackups", "rds:DescribeAccountAttributes", "logs:DescribeLogGroups", "logs:DescribeLogStreams", "s3:GetBucketNotification", "s3:GetBucketPolicy", "s3:GetBucketPublicAccessBlock", "s3:GetBucketTagging", "s3:GetBucketWebsite", "s3:GetIntelligentTieringConfiguration", "s3:GetLifecycleConfiguration", "s3:GetReplicationConfiguration", "s3:ListAllMyBuckets", "s3:ListStorageLensConfigurations", "servicequotas:GetServiceQuota", "servicequotas:ListRequestedServiceQuotaChangeHistory", "servicequotas:ListServiceQuotas" ], "Resource": "*" }, { "Sid": "AllowPutTargetsOnASpecificRule", "Effect": "Allow", "Action": [ "events:PutTargets", "events:PutRule" ], "Resource": "arn:aws:events:*:*:rule/DevOps-Guru-managed-*" }, Using service-linked roles 124 User Guide Amazon DevOps Guru { "Sid": "AllowCreateOpsItem", "Effect": "Allow", "Action": [ "ssm:CreateOpsItem" ], "Resource": "*" }, { "Sid": "AllowAddTagsToOpsItem", "Effect": "Allow", "Action": [ "ssm:AddTagsToResource" ], "Resource": "arn:aws:ssm:*:*:opsitem/*" }, { "Sid": "AllowAccessOpsItem", "Effect": "Allow", "Action": [ "ssm:GetOpsItem", "ssm:UpdateOpsItem" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/DevOps-GuruInsightSsmOpsItemRelated": "true" } } }, { "Sid": "AllowCreateManagedRule", "Effect": "Allow", "Action": "events:PutRule", "Resource": "arn:aws:events:*:*:rule/DevOpsGuruManagedRule*" }, { "Sid": "AllowAccessManagedRule", "Effect": "Allow", "Action": [ "events:DescribeRule", "events:ListTargetsByRule" ], "Resource": "arn:aws:events:*:*:rule/DevOpsGuruManagedRule*" Using service-linked roles 125 Amazon DevOps Guru }, { "Sid": "AllowOtherOperationsOnManagedRule", User Guide "Effect": "Allow", "Action": [ "events:DeleteRule", "events:EnableRule", "events:DisableRule", "events:PutTargets", "events:RemoveTargets" ], "Resource": "arn:aws:events:*:*:rule/DevOpsGuruManagedRule*", "Condition": { "StringEquals": { "events:ManagedBy": "devops-guru.amazonaws.com" } } }, { "Sid": "AllowTagBasedFilterLogEvents", "Effect": "Allow", "Action": [ "logs:FilterLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:*", "Condition": { "StringEquals": { "aws:ResourceTag/DevOps-Guru-Analysis": "true" } } }, { "Sid": "AllowAPIGatewayGetIntegrations", "Effect": "Allow", "Action": "apigateway:GET", "Resource": [ "arn:aws:apigateway:*::/restapis/??????????", "arn:aws:apigateway:*::/restapis/*/resources", "arn:aws:apigateway:*::/restapis/*/resources/*/methods/*/integration" ] } ] } Using service-linked roles 126 Amazon DevOps Guru User Guide Creating a service-linked role for DevOps Guru You don't need to manually create a service-linked role. When you create an insight in the AWS Management Console, the AWS CLI, or the AWS API, DevOps Guru creates the service-linked role for you. Important This service-linked role can appear in your account if you completed an action in another service that uses the features supported by this role; for example, it can appear if you added DevOps Guru to a repository from AWS CodeCommit. Editing a service-linked role for DevOps Guru DevOps Guru does not allow you to edit the AWSServiceRoleForDevOpsGuru service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a Service-Linked Role in the IAM User Guide. Deleting a |
userguide-048 | userguide.pdf | 48 | your account if you completed an action in another service that uses the features supported by this role; for example, it can appear if you added DevOps Guru to a repository from AWS CodeCommit. Editing a service-linked role for DevOps Guru DevOps Guru does not allow you to edit the AWSServiceRoleForDevOpsGuru service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a Service-Linked Role in the IAM User Guide. Deleting a service-linked role for DevOps Guru If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must disassociate from all repositories before you can manually delete it. Note If the DevOps Guru service is using the role when you try to delete the resources, the deletion might fail. If that happens, wait for a few minutes and try the operation again. To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForDevOpsGuru service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Using service-linked roles 127 Amazon DevOps Guru User Guide Amazon DevOps Guru permissions reference You can use AWS-wide condition keys in your DevOps Guru policies to express conditions. For a list, see IAM JSON Policy Elements Reference in the IAM User Guide. You specify the actions in the policy's Action field. To specify an action, use the devops-guru: prefix followed by the API operation name (for example, devops-guru:SearchInsights and devops-guru:ListAnomalies). To specify multiple actions in a single statement, separate them with commas (for example, "Action": [ "devops-guru:SearchInsights", "devops- guru:ListAnomalies" ]). Using wildcard characters You specify an Amazon Resource Name (ARN), with or without a wildcard character (*), as the resource value in the policy's Resource field. You can use a wildcard to specify multiple actions or resources. For example, devops-guru:* specifies all DevOps Guru actions and devops- guru:List* specifies all DevOps Guru actions that begin with the word List. The following example refers to all insights with a universally unique identifier (UUID) that begins with 12345. arn:aws:devops-guru:us-east-2:123456789012:insight:12345* You can use the following table as a reference when you are setting up Authenticating with identities and writing permissions policies that you can attach to an IAM identity (identity-based policies). DevOps Guru API operations and required permissions for actions AddNotificationChannel Action: devops-guru:AddNotificationChannel Required to add a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. Resource: * DevOps Guru permissions reference 128 Amazon DevOps Guru RemoveNotificationChannel devops-guru:RemoveNotificationChannel User Guide Required to remove a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. Resource: * ListNotificationChannels Action: devops-guru:ListNotificationChannels Required to return a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one notification type supported is Amazon Simple Notification Service. Resource: * UpdateResourceCollectionFilter Action: devops-guru:UpdateResourceCollectionFilter Required to update the list of AWS CloudFormation stacks that are used to specify which AWS resources in your account are analyzed by DevOps Guru. The analysis generates insights that include recommendations, operational metrics, and operational events that you can use to improve the performance of your operations. This method also creates the IAM roles required for you to use CodeGuru OpsAdvisor. Resource: * GetResourceCollectionFilter Action: devops-guru:GetResourceCollectionFilter Required to return the list of AWS CloudFormation stacks that are used to specify which AWS resources in your account are analyzed by DevOps Guru. The analysis generates insights that include recommendations, operational metrics, and operational events that you can use to improve the performance of your operations. Resource: * DevOps Guru permissions reference 129 Amazon DevOps Guru ListInsights Action: devops-guru:ListInsights User Guide Required to return a list of insights in your AWS account. You can specify which insights are returned by their start time, status (ongoing or any), and type (reactive or predictive). Resource: * DescribeInsight Action: devops-guru:DescribeInsight Required to return details about an insight that you specify using its ID. Resource: * SearchInsights Action: devops-guru:SearchInsights Required to return a list of insights in your AWS account. You can specify which insights are returned by their start time, filters, and type (reactive or predictive). Resource: * ListAnomalies Action: devops-guru:ListAnomalies Required to return a list of the anomalies that belong to an |
userguide-049 | userguide.pdf | 49 | Guide Required to return a list of insights in your AWS account. You can specify which insights are returned by their start time, status (ongoing or any), and type (reactive or predictive). Resource: * DescribeInsight Action: devops-guru:DescribeInsight Required to return details about an insight that you specify using its ID. Resource: * SearchInsights Action: devops-guru:SearchInsights Required to return a list of insights in your AWS account. You can specify which insights are returned by their start time, filters, and type (reactive or predictive). Resource: * ListAnomalies Action: devops-guru:ListAnomalies Required to return a list of the anomalies that belong to an insight that you specify using its ID. Resource: * DescribeAnomaly Action: devops-guru:DescribeAnomaly Required to return details about an anomaly that you specify using its ID. Resource: * ListEvents Action: devops-guru:ListEvents DevOps Guru permissions reference 130 Amazon DevOps Guru User Guide Required to return a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned. Resource: * ListRecommendations Action: devops-guru:ListRecommendations Required to return a list of a specified insight's recommendations. Each recommendation includes a list of metrics and a list of events that are related to the recommendations. Resource: * DescribeAccountHealth Action: devops-guru:DescribeAccountHealth Required to return the number of open reactive insights, the number of open predictive insights, and the number of metrics analyzed in your AWS account. Use these numbers to gauge the health of operations in your AWS account. Resource: * DescribeAccountOverview Action: devops-guru:DescribeAccountOverview Required to return the following that happened during a time range: the number of open reactive insights that were created, the number of open predictive insights that were created, and the mean time to recover (MTTR) for all reactive insights that were closed. Resource: * DescribeResourceCollectionHealthOverview Action: devops-guru:DescribeResourceCollectionHealthOverview Required to return the number of open predictive insights, open reactive insights, and mean time to recover (MTTR) for all insights for each AWS CloudFormation stack specified in DevOps Guru. Resource: * DevOps Guru permissions reference 131 Amazon DevOps Guru DescribeIntegratedService Action: devops-guru:DescribeIntegratedService User Guide Required to return the integration status of services that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight. Resource: * UpdateIntegratedServiceConfig Action: devops-guru:UpdateIntegratedServiceConfig Required to enable or disable integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Systems Manager, which can be used to create an OpsItem for each generated insight. Resource: * Permissions for Amazon SNS topics Use the information in this topic only if you want to configure Amazon DevOps Guru to deliver notifications to Amazon SNS topics owned by another AWS account. For DevOps Guru to deliver notifications to an Amazon SNS topic owned by a different account, you must attach a policy to the Amazon SNS topic that grants DevOps Guru permissions to send notifications to it. If you configure DevOps Guru to deliver notifications to Amazon SNS topics owned by the same account you use for DevOps Guru, then DevOps Guru adds a policy to the topics for you. After you attach a policy to configure permissions for an Amazon SNS topic in another account, you can add the Amazon SNS topic in DevOps Guru. You can also update your Amazon SNS policy with a notification channel to make it more secure. Note DevOps Guru currently only supports cross-account access in the same Region. Topics Permissions for Amazon SNS topics 132 Amazon DevOps Guru User Guide • Configuring permissions for an Amazon SNS topic in another account • Adding an Amazon SNS topic from another account • Updating your Amazon SNS policy with a notification channel (recommended) Configuring permissions for an Amazon SNS topic in another account Adding permissions as an IAM role To use an Amazon SNS topic from another account after logging in with an IAM role, you must attach a policy to the Amazon SNS topic you want to use. To attach a policy to an Amazon SNS topic from another account while using an IAM role, you need to have the following permissions for that account resource as part of your IAM role: • sns:CreateTopic • sns:GetTopicAttributes • sns:SetTopicAttributes • sns:Publish Attach the following policy to the Amazon SNS topic you want to use. For the Resource key, topic-owner-account-id is the account ID of the topic owner, topic-sender-account-id is the account ID of the user who set up DevOps Guru, and devops-guru-role is the IAM role of the individual user involved. You must substitute appropriate values for region-id (for example, us- west-2), and my-topic-name. { "Version": "2012-10-17", "Statement": [{ "Sid": "EnableDevOpsGuruServicePrincipal", "Action": "sns:Publish", "Effect": "Allow", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Principal": { "Service": "region-id.devops-guru.amazonaws.com" }, "Condition": |
userguide-050 | userguide.pdf | 50 | for that account resource as part of your IAM role: • sns:CreateTopic • sns:GetTopicAttributes • sns:SetTopicAttributes • sns:Publish Attach the following policy to the Amazon SNS topic you want to use. For the Resource key, topic-owner-account-id is the account ID of the topic owner, topic-sender-account-id is the account ID of the user who set up DevOps Guru, and devops-guru-role is the IAM role of the individual user involved. You must substitute appropriate values for region-id (for example, us- west-2), and my-topic-name. { "Version": "2012-10-17", "Statement": [{ "Sid": "EnableDevOpsGuruServicePrincipal", "Action": "sns:Publish", "Effect": "Allow", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Principal": { "Service": "region-id.devops-guru.amazonaws.com" }, "Condition": { "StringEquals": { "AWS:SourceAccount": "topic-sender-account-id" Permissions for Amazon SNS topics 133 Amazon DevOps Guru } } }, { User Guide "Sid": "EnableAccountPrincipal", "Action": "sns:Publish", "Effect": "Allow", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Principal": { "AWS": ["arn:aws:iam::topic-sender-account-id:role/devops-guru-role"] } } ] } Adding permissions as an IAM user To use an Amazon SNS topic from another account as an IAM user, attach the following policy to the Amazon SNS topic you want to use. For the Resource key, topic-owner-account-id is the account ID of the topic owner, topic-sender-account-id is the account ID of the user who set up DevOps Guru, and devops-guru-user-name is the individual IAM user involved. You must substitute appropriate values for region-id (for example, us-west-2) and my-topic-name. Note Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. { "Version": "2012-10-17", "Statement": [{ "Sid": "EnableDevOpsGuruServicePrincipal", "Action": "sns:Publish", "Effect": "Allow", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Principal": { "Service": "region-id.devops-guru.amazonaws.com" Permissions for Amazon SNS topics 134 Amazon DevOps Guru }, "Condition": { "StringEquals": { "AWS:SourceAccount": "topic-sender-account-id" User Guide } } }, { "Sid": "EnableAccountPrincipal", "Action": "sns:Publish", "Effect": "Allow", "Resource": "arn:aws:sns:region-id:topic-owner-account-id:my-topic-name", "Principal": { "AWS": ["arn:aws:iam::topic-sender-account-id:user/devops-guru-user- name"] } } ] } Adding an Amazon SNS topic from another account After you configure permissions for an Amazon SNS topic in another account, you can add that Amazon SNS topic to your DevOps Guru notification settings. You can add the Amazon SNS topic using the AWS CLI or the DevOps Guru console. • When you use the console, you must select the option Use an SNS topic ARN to specify an existing topic in order to use a topic from another account. • When you use the AWS CLI operation add-notification-channel, you must specify the TopicArn within the NotificationChannelConfig object. Add an Amazon SNS topic from another account using the console 1. Open the Amazon DevOps Guru console at https://console.aws.amazon.com/devops-guru/. 2. Open the navigation pane, and then choose Settings. 3. Go to the Notifications section and choose Edit. 4. Choose Add SNS topic. 5. Choose Use an SNS topic ARN to specify an existing topic. Permissions for Amazon SNS topics 135 Amazon DevOps Guru User Guide 6. Enter the ARN of the Amazon SNS topic you want to use. You should have already configured permissions for this topic by attaching a policy to it. 7. (Optional) Choose Notification configuration to edit notification frequency settings. 8. Choose Save. After you add the Amazon SNS topic to your notification settings, DevOps Guru uses that topic to notify you of important events, such as when a new insight is created. Updating your Amazon SNS policy with a notification channel (recommended) After you add a topic, we recommend that you make your policy more secure by specifying permissions for only the DevOps Guru notification channel that contains your topic. Update your Amazon SNS topic policy with a notification channel (recommended) 1. Run the list-notification-channels DevOps Guru AWS CLI command in your account that you want to send notifications from. aws devops-guru list-notification-channels 2. In the list-notification-channels response, make a note of the channel ID that contains your Amazon SNS topic's ARN. The channel ID is a guid. For example, in the following response, the channel ID for the topic with the ARN arn:aws:sns:region-id:111122223333:topic-name is e89be5f7-989d-4c4c-b1fe- e7145037e531 { "Channels": [ { "Id": "e89be5f7-989d-4c4c-b1fe-e7145037e531", "Config": { "Sns": { "TopicArn": "arn:aws:sns:region-id:111122223333:topic-name" }, "Filters": { "MessageTypes": ["CLOSED_INSIGHT", "NEW_INSIGHT", "SEVERITY_UPGRADED"], "Severities": ["HIGH", "MEDIUM"] } } Permissions for Amazon SNS topics 136 Amazon DevOps Guru } ] } User Guide 3. Go to the policy that you created in another account using the topic owner ID in the section called “Configuring permissions for an Amazon SNS topic in another account”. In the Condition statement of the policy, add the line that specifies the SourceArn. The ARN contains your Region ID (for example, us-east-1), the AWS account number of the topic's sender, and the channel ID you made a note of. Your updated Condition statement looks like the following. "Condition" : { "StringEquals" : { "AWS:SourceArn": "arn:aws:devops-guru:us- east-1:111122223333:channel/e89be5f7-989d-4c4c-b1fe-e7145037e531", "AWS:SourceAccount": "111122223333" } } If AddNotificationChannel is unable to add your SNS Topic, |
userguide-051 | userguide.pdf | 51 | 3. Go to the policy that you created in another account using the topic owner ID in the section called “Configuring permissions for an Amazon SNS topic in another account”. In the Condition statement of the policy, add the line that specifies the SourceArn. The ARN contains your Region ID (for example, us-east-1), the AWS account number of the topic's sender, and the channel ID you made a note of. Your updated Condition statement looks like the following. "Condition" : { "StringEquals" : { "AWS:SourceArn": "arn:aws:devops-guru:us- east-1:111122223333:channel/e89be5f7-989d-4c4c-b1fe-e7145037e531", "AWS:SourceAccount": "111122223333" } } If AddNotificationChannel is unable to add your SNS Topic, check that your IAM policy has the following permissions. { "Version": "2012-10-17", "Statement": [{ "Sid": "DevOpsGuruTopicPermissions", "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:GetTopicAttributes", "sns:SetTopicAttributes", "sns:Publish" ], "Resource": "arn:aws:sns:region-id:account-id:my-topic-name" }] } Permissions for AWS KMS–encrypted Amazon SNS topics Permissions for encrypted Amazon SNS topics 137 Amazon DevOps Guru User Guide The Amazon SNS topic you specify might be encrypted by AWS Key Management Service. To allow DevOps Guru to work with encrypted topics, you must first create a AWS KMS key and then add the following statement to the policy of the KMS key. For more information, see Encrypting messages published to Amazon SNS with AWS KMS, Key identifiers (KeyId) in the AWS KMS User Guide, and Data encryption in the Amazon Simple Notification Service Developer Guide. { "Version": "2012-10-17", "Id": "your-kms-key-policy", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "region-id.devops-guru.amazonaws.com" }, "Action": [ "kms:GenerateDataKey*", "kms:Decrypt" ], "Resource": "*" } ] } Note DevOps Guru currently supports encrypted topics for use within a single account. Using an encrypted topic across multiple accounts is not supported at this time. Troubleshooting Amazon DevOps Guru identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with DevOps Guru and IAM. Topics • I am not authorized to perform an action in DevOps Guru • I want to give users programmatic access • I am not authorized to perform iam:PassRole Troubleshooting 138 Amazon DevOps Guru User Guide • I want to allow people outside of my AWS account to access my DevOps Guru resources I am not authorized to perform an action in DevOps Guru If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. The following example error occurs when the user mateojackson tries to use the console to view details about a fictional my-example-widget resource but does not have the fictional aws:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: aws:GetWidget on resource: my-example-widget In this case, Mateo asks his administrator to update his policies to allow him to access the my- example-widget resource using the aws:GetWidget action. I want to give users programmatic access Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic access, choose one of the following options. Which user needs programmatic access? To By Workforce identity (Users managed in IAM Identity Center) Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. Following the instructions for the interface that you want to use. • For the AWS CLI, see Configuring the AWS CLI to use AWS IAM Identity Center in the AWS Command Line Interface User Guide. Troubleshooting 139 Amazon DevOps Guru User Guide Which user needs programmatic access? To By IAM IAM • For AWS SDKs, tools, and AWS APIs, see IAM Identity Center authentication in the AWS SDKs and Tools Reference Guide. Use temporary credentials to sign programmatic requests Following the instructions in Using temporary credentia to the AWS CLI, AWS SDKs, or ls with AWS resources in the AWS APIs. IAM User Guide. (Not recommended) Use long-term credentials to Following the instructions for the interface that you want to sign programmatic requests use. to the AWS CLI, AWS SDKs, or AWS APIs. • For the AWS CLI, see Authenticating using IAM user credentials in the AWS Command Line Interface User Guide. • For AWS SDKs and tools, see Authenticate using long-term credentials in the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to DevOps Guru. Troubleshooting 140 Amazon DevOps Guru User Guide Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to |
userguide-052 | userguide.pdf | 52 | long-term credentials in the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to DevOps Guru. Troubleshooting 140 Amazon DevOps Guru User Guide Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in DevOps Guru. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my DevOps Guru resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether DevOps Guru supports these features, see How Amazon DevOps Guru works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Troubleshooting 141 Amazon DevOps Guru User Guide Logging and monitoring DevOps Guru Monitoring is an important part of maintaining the reliability, availability, and performance of DevOps Guru and your other AWS solutions. AWS provides the following monitoring tools to watch DevOps Guru, report when something is wrong, and take automatic actions when appropriate: • Amazon CloudWatch monitors your AWS resources and the applications you run on AWS in real time. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a specified metric reaches a threshold that you specify. For example, you can have CloudWatch track CPU usage or other metrics of your Amazon EC2 instances and automatically launch new instances when needed. For more information, see the Amazon CloudWatch User Guide. • AWS CloudTrail captures API calls and related events made by or on behalf of your AWS account and delivers the log files to an Amazon S3 bucket that you specify. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see the AWS CloudTrail User Guide. Topics • Monitoring DevOps Guru with Amazon CloudWatch • Logging Amazon DevOps Guru API calls with AWS CloudTrail Monitoring DevOps Guru with Amazon CloudWatch You can monitor DevOps Guru using CloudWatch, which collects raw data and processes it into readable, near real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on how your web application or service is performing. You can also set alarms that watch for certain thresholds and send notifications or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. For DevOps Guru, you can track metrics for insights and metrics for your DevOps Guru usage. You might want to watch for a large number of created Insights to help you determine if your operational solutions are experiencing anomalous behavior. Or you might want to watch your DevOps Guru usage to help track your costs. The DevOps Guru service reports the following metrics in the AWS/DevOps-Guru namespace. Monitoring DevOps Guru 142 Amazon DevOps Guru Topics • Insight metrics • DevOps Guru usage metrics Insight metrics User Guide You can use CloudWatch to track a metric |
userguide-053 | userguide.pdf | 53 | the Amazon CloudWatch User Guide. For DevOps Guru, you can track metrics for insights and metrics for your DevOps Guru usage. You might want to watch for a large number of created Insights to help you determine if your operational solutions are experiencing anomalous behavior. Or you might want to watch your DevOps Guru usage to help track your costs. The DevOps Guru service reports the following metrics in the AWS/DevOps-Guru namespace. Monitoring DevOps Guru 142 Amazon DevOps Guru Topics • Insight metrics • DevOps Guru usage metrics Insight metrics User Guide You can use CloudWatch to track a metric to show you how many insights are created in your AWS account. You can specify the Type dimension to track proactive or reactive insights. Do not specify a dimension if you want to track all insights. Metrics Metric Description Insight The number of insights created in an AWS account. Valid dimensions: Type Valid statistics: Sample count, Sum Units: Count The following dimension is supported for the DevOps Guru Insight metric. Dimensions Dimension Description Type This is the type of the insight. Do not specify a dimension for the Insights metric if you want to track all insights. Valid values are: proactive , reactive. DevOps Guru usage metrics You can use CloudWatch to track your Amazon DevOps Guru usage. Monitoring with CloudWatch 143 Amazon DevOps Guru Metrics Metric Description User Guide CallCount The number of calls made by one of the following DevOps Guru methods. • • • • • • • ListInsights ListAnomaliesForInsight ListRecommendations ListEvents SearchInsights DescribeInsight DescribeAnomaly Valid dimensions: Service, Class, Type, Resource Valid statistics: Sample count, Sum Units: Count The following dimensions are supported for the DevOps Guru usage metrics. Dimensions Dimension Description Service This is the name of the AWS service that contains the resource. For example, for DevOps Guru, this value is DevOps-Guru . Monitoring with CloudWatch 144 Amazon DevOps Guru User Guide Dimension Description Class Type This is the class of the resource that is tracked. DevOps Guru uses this dimension with the value None. This is type of the resource that is tracked. DevOps Guru uses this dimension with the value API. Resource This is the name of the DevOps Guru operation. Valid values are: ListInsights , ListAnomaliesForInsight , ListRecommendations , ListEvents , SearchIns ights , DescribeInsight , DescribeAnomaly . Logging Amazon DevOps Guru API calls with AWS CloudTrail Amazon DevOps Guru is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in DevOps Guru. CloudTrail captures API calls for DevOps Guru as events. The calls captured include calls from the DevOps Guru console and code calls to the DevOps Guru API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for DevOps Guru. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to DevOps Guru, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. DevOps Guru information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in DevOps Guru, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail Event history. For an ongoing record of events in your AWS account, including events for DevOps Guru, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Logging DevOps Guru API calls with AWS CloudTrail 145 Amazon DevOps Guru User Guide Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for creating a trail • CloudTrail supported services and integrations • Configuring Amazon SNS notifications for CloudTrail • Receiving CloudTrail log files from multiple regions and Receiving CloudTrail log files from multiple accounts DevOps Guru supports logging all of its actions as events in CloudTrail log files. For more information, see Actions in the DevOps Guru API Reference. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the |
userguide-054 | userguide.pdf | 54 | analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for creating a trail • CloudTrail supported services and integrations • Configuring Amazon SNS notifications for CloudTrail • Receiving CloudTrail log files from multiple regions and Receiving CloudTrail log files from multiple accounts DevOps Guru supports logging all of its actions as events in CloudTrail log files. For more information, see Actions in the DevOps Guru API Reference. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. For more information, see the CloudTrail userIdentity element. Understanding DevOps Guru log file entries A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order. The following example shows a CloudTrail log entry that demonstrates the UpdateResourceCollection action. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AAAAAAAAAEXAMPLE:TestSession", "arn": "arn:aws:sts::123456789012:assumed-role/TestRole/TestSession", Logging DevOps Guru API calls with AWS CloudTrail 146 Amazon DevOps Guru User Guide "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::123456789012:role/TestRole", "accountId": "123456789012", "userName": "sample-user-name" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2020-12-03T15:29:51Z" } } }, "eventTime": "2020-12-01T16:14:31Z", "eventSource": "devops-guru.amazonaws.com", "eventName": "UpdateResourceCollection", "awsRegion": "us-east-1", "sourceIPAddress": "sample-ip-address", "userAgent": "aws-internal/3 aws-sdk-java/1.11.901 Linux/4.9.217-0.3.ac.206.84.332.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.275-b01 java/1.8.0_275 vendor/Oracle_Corporation", "requestParameters": { "Action": "REMOVE", "ResourceCollection": { "CloudFormation": { "StackNames": [ "*" ] } } }, "responseElements": null, "requestID": " cb8c167e-EXAMPLE ", "eventID": " e3c6f4ce-EXAMPLE ", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "123456789012" Logging DevOps Guru API calls with AWS CloudTrail 147 Amazon DevOps Guru } User Guide DevOps Guru and interface VPC endpoints (AWS PrivateLink) You can use VPC endpoints when you call Amazon DevOps Guru APIs. When you use VPC endpoints, your API calls are more secure because they are contained within your VPC and do not access the internet. For more information, see Actions in the Amazon DevOps Guru API Reference. You establish a private connection between your VPC and DevOps Guru by creating an interface VPC endpoint. Interface endpoints are powered by AWS PrivateLink, a technology that enables you to privately access DevOps Guru APIs without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to communicate with DevOps Guru APIs. Traffic between your VPC and DevOps Guru does not leave the Amazon network. Each interface endpoint is represented by one or more Elastic Network Interfaces in your subnets. For more information, see Interface VPC endpoints (AWS PrivateLink) in the Amazon VPC User Guide. Considerations for DevOps Guru VPC endpoints Before you set up an interface VPC endpoint for DevOps Guru, ensure that you review Interface endpoint properties and limitations in the Amazon VPC User Guide. DevOps Guru supports making calls to all of its API actions from your VPC. Creating an interface VPC endpoint for DevOps Guru You can create a VPC endpoint for the DevOps Guru service using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Creating an interface endpoint in the Amazon VPC User Guide. Create a VPC endpoint for DevOps Guru using the following service name: • com.amazonaws.region.devops-guru If you enable private DNS for the endpoint, you can make API requests to DevOps Guru using its default DNS name for the Region, for example, devops-guru.us-east-1.amazonaws.com. VPC endpoints (AWS PrivateLink) 148 Amazon DevOps Guru User Guide For more information, see Accessing a service through an interface endpoint in the Amazon VPC User Guide. Creating a VPC endpoint policy for DevOps Guru You can attach an endpoint policy to your VPC endpoint that controls access to DevOps Guru. The policy specifies the following information: • The principal that can perform actions. • The actions that can be performed. • The resources on which actions can be performed. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. Example: VPC endpoint policy for DevOps Guru actions The following is an example of an endpoint policy for DevOps Guru. When attached to an endpoint, this policy grants access to the listed DevOps Guru actions for all principals on all resources. { "Statement":[ { "Principal":"*", |
userguide-055 | userguide.pdf | 55 | your VPC endpoint that controls access to DevOps Guru. The policy specifies the following information: • The principal that can perform actions. • The actions that can be performed. • The resources on which actions can be performed. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. Example: VPC endpoint policy for DevOps Guru actions The following is an example of an endpoint policy for DevOps Guru. When attached to an endpoint, this policy grants access to the listed DevOps Guru actions for all principals on all resources. { "Statement":[ { "Principal":"*", "Effect":"Allow", "Action":[ "devops-guru:AddNotificationChannel", "devops-guru:ListInsights", "devops-guru:ListRecommendations" ], "Resource":"*" } ] } Infrastructure security in DevOps Guru As a managed service, Amazon DevOps Guru is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Creating a VPC endpoint policy for DevOps Guru 149 Amazon DevOps Guru User Guide Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access DevOps Guru through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Resilience in Amazon DevOps Guru The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. DevOps Guru operates in multiple Availability Zones and stores artifact data and metadata in Amazon S3 and Amazon DynamoDB. Your encrypted data is redundantly stored across multiple facilities and multiple devices in each facility, making it highly available and highly durable. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience 150 Amazon DevOps Guru User Guide Quotas and limits for Amazon DevOps Guru The following table lists the current quota in Amazon DevOps Guru. This quota is for each supported AWS Region for each AWS account. Notifications Maximum number of Amazon Simple Notificat ion Service topics you can specify at once 2 AWS CloudFormation stacks Maximum number of AWS CloudFormation stacks you can specify 1000 DevOps Guru resource monitoring limits Resource description Default limit for monitorin g Amazon Simple Queue Service (Amazon SQS) queues Limit 100* Can be increased Yes** *For new DevOps Guru accounts created on or after June 29, 2023, and for existing accounts that were active as of the same date and have less than 100 Amazon SQS queues. **To request a change in this limit, contact Support at https://aws.amazon.com/contact-us. You can request an Amazon SQS queue monitoring limit of 100, 500, 1,000, 5,000, or 10,000. Notifications 151 Amazon DevOps Guru User Guide DevOps Guru quotas for creating, deploying, and managing an API The following fixed quotas apply to creating, deploying, and managing an API in DevOps Guru, using the AWS CLI, the API Gateway console, or the API Gateway REST API and its SDKs. For a list of all DevOps Guru APIs, see Amazon DevOps Guru Actions. Default quota Can be increased 20 requests every 1 second per account Yes DevOps Guru quotas for creating, deploying, and managing an API 152 Amazon DevOps Guru User Guide Amazon DevOps Guru document history The following table describes the documentation for this release of DevOps Guru. • API version: latest • Latest documentation update: August 9, 2023 Change Description Date Managed policy updates August 9, 2023 Amazon SNS subscriptions and subscription list access have been added to the AmazonDevOpsGuruCo nsoleFullAccess Subscription list access has policy. also been added to the AmazonDevOpsGuruRe adOnlyAccess For more information, see policy. Identity-based policies for Amazon DevOps Guru. Customer managed encryptio n keys DevOps Guru now supports encryption with customer July 5, 2023 DevOps Guru for RDS supports RDS PostgreSQL managed keys using AWS KMS. For more informati on, see Data protection in DevOps Guru. DevOps Guru for RDS can detect performance bottlenec ks and other insights in PostgreSQL databases. For more information, see Benefits of DevOps Guru for RDS. March 30, 2023 153 Amazon DevOps Guru User Guide DevOps Guru for RDS supports proactive insights DevOps Guru for RDS publishes proactive insights February 28, 2023 Analyzed resources page with recommendations to help you address issues in your Aurora databases before they become bigger problems. For more informati on, |
userguide-056 | userguide.pdf | 56 | customer July 5, 2023 DevOps Guru for RDS supports RDS PostgreSQL managed keys using AWS KMS. For more informati on, see Data protection in DevOps Guru. DevOps Guru for RDS can detect performance bottlenec ks and other insights in PostgreSQL databases. For more information, see Benefits of DevOps Guru for RDS. March 30, 2023 153 Amazon DevOps Guru User Guide DevOps Guru for RDS supports proactive insights DevOps Guru for RDS publishes proactive insights February 28, 2023 Analyzed resources page with recommendations to help you address issues in your Aurora databases before they become bigger problems. For more informati on, see Working with anomalies in DevOps Guru for RDS. A new page in the DevOps Guru console lists resources in your account that are analyzed by DevOps Guru. For more information, see Viewing resources analyzed by DevOps Guru. October 20, 2022 New notification configura tion settings You can now choose whether to receive all notifications September 30, 2022 or to only receive notificat ions for certain severities and events. For more informati on, see Updating Amazon Amazon SNS notification configurations. 154 Amazon DevOps Guru User Guide Log anomaly analysis addition to managed policies AWS managed policies for DevOps Guru ahave August 30, 2022 Log anomaly analysis added CodeGuru Profiler Integration been updated in the IAM console to support access to the CloudWatch action FilterLogEvents . For more information, see DevOps Guru updates to AWS managed policies and service- linked role. You can view detailed information about log groups related to insights in the DevOps Guru console. There is also an expanded service- linked role available to d escribe CloudWatch logs and streams. For more informati on, see Understanding insights in the DevOps Guru console and DevOps Guru updates to AWS managed policies and service-linked role. DevOps Guru now integrate s with Amazon CodeGuru Profiler with an EventBridge managed rule. Each inbound event from CodeGuru Profiler is a proactive anomaly report. For more information, see Integrating with CodeGuru Profiler. July 12, 2022 March 7, 2022 155 Amazon DevOps Guru User Guide Service-linked role and managed policy updates New managed policy added Support to define your application with AWS tags December 21, 2021 December 6, 2021 December 1, 2021 Expanded policies available in the IAM console. The changes allow DevOps Guru to support enhanced integration with Amazon Relational Database Service (Amazon RDS). For more information, see Using service-linked roles and AWS managed (predefined) policies for DevOps Guru. The AmazonDevOpsGuruCo policy nsoleFullAccess has been added. For more information, see Identity- based policies for Amazon DevOps Guru. You can now use AWS tags to identify the resources you want DevOps Guru to a nalyze, identify the resources in your applications, and filter insights in the console. For more information, see Use tags to identify resources in your applications. 156 Amazon DevOps Guru User Guide Service-linked role and managed policy updates Amazon RDS support December 1, 2021 December 1, 2021 Expanded policies available in the IAM console. The changes allow DevOps Guru to support enhanced integration with Amazon Relational Database Service (Amazon RDS). For more information, see Using service-linked roles and AWS managed (predefined) policies for DevOps Guru. DevOps Guru now provides comprehensive analysis and insights for Amazon Relational Database Service (Amazon RDS) resource s in your application. For more information, see Working with anomalies in DevOps Guru for Amazon RDS. Amazon EventBridge integrati on DevOps Guru now integrate s with EventBridge to notify November 18, 2021 you of certain events relating to your DevOps Guru insights. For more information, see Working with EventBridge. AWS managed policy added New AWS managed policy November 16, 2021 added. The AmazonDev OpsGuruOrganizatio nsAccess policy provides access to DevOps Guru within an organization. For more information, see identity- based policies. 157 Amazon DevOps Guru User Guide Service-linked role policy update Expanded policy available in the IAM console. The change November 4, 2021 Cross account support allows DevOps Guru to s upport the multi account view. For more informati on, see Using service-linked roles. You can now view insights and metrics across multiple accounts in your organiza tion. For more informati on, see What is Amazon DevOps Guru. November 4, 2021 General availability release Amazon DevOps Guru is now generally available (GA). May 4, 2021 New topic VPC Endpoint support April 27, 2021 April 15, 2021 You can now generate a monthly cost estimate for DevOps Guru to analyze your resources. For more information, see Estimate your Amazon DevOps Guru costs. You can now use VPC endpoints to improve the security of your resource anal ysis and insight generation. For more information, see DevOps Guru and interface VPC endpoints (AWS PrivateLi nk). 158 Amazon DevOps Guru New topic Preview release User Guide December 11, 2020 December 1, 2020 A new topic about how to monitor DevOps Guru with Amazon CloudWatch |
userguide-057 | userguide.pdf | 57 | available (GA). May 4, 2021 New topic VPC Endpoint support April 27, 2021 April 15, 2021 You can now generate a monthly cost estimate for DevOps Guru to analyze your resources. For more information, see Estimate your Amazon DevOps Guru costs. You can now use VPC endpoints to improve the security of your resource anal ysis and insight generation. For more information, see DevOps Guru and interface VPC endpoints (AWS PrivateLi nk). 158 Amazon DevOps Guru New topic Preview release User Guide December 11, 2020 December 1, 2020 A new topic about how to monitor DevOps Guru with Amazon CloudWatch was added. For more information, see Monitoring DevOps Guru with Amazon CloudWatch. This is the preview release of the Amazon DevOps Guru User Guide. 159 Amazon DevOps Guru User Guide AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. 160 |
verified-access-ug-001 | verified-access-ug.pdf | 1 | User Guide AWS Verified Access Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Verified Access User Guide AWS Verified Access: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Verified Access Table of Contents User Guide What is AWS Verified Access? ......................................................................................................... 1 Benefits of Verified Access ......................................................................................................................... 1 Accessing Verified Access ............................................................................................................................ 1 Pricing ............................................................................................................................................................. 2 How Verified Access works ............................................................................................................. 3 Key components of Verified Access .......................................................................................................... 3 Get started tutorial ......................................................................................................................... 5 Prerequisites .................................................................................................................................................. 5 Create a trust provider ................................................................................................................................ 6 Create an instance ........................................................................................................................................ 6 Create a group .............................................................................................................................................. 7 Create an endpoint ...................................................................................................................................... 7 Configure DNS for the endpoint ............................................................................................................... 8 Test connectivity to the application ......................................................................................................... 9 Add an access policy .................................................................................................................................... 9 Clean up ......................................................................................................................................................... 9 Verified Access instances ............................................................................................................... 11 Create and manage a Verified Access instance .................................................................................... 11 Create a Verified Access instance ..................................................................................................... 11 Attach a trust provider to a Verified Access instance .................................................................... 12 Detach a trust provider from a Verified Access instance .............................................................. 12 Add a custom subdomain ................................................................................................................... 13 Delete a Verified Access instance ........................................................................................................... 13 Integrate with AWS WAF .......................................................................................................................... 14 Required IAM permissions ................................................................................................................... 15 Associate an AWS WAF web ACL ....................................................................................................... 15 Check the status of the association .................................................................................................. 16 Disassociate an AWS WAF web ACL .................................................................................................. 16 FIPS compliance .......................................................................................................................................... 17 Existing environment ........................................................................................................................... 17 New environment ................................................................................................................................. 18 Trust providers ............................................................................................................................... 19 User-identity ................................................................................................................................................ 19 IAM Identity Center .............................................................................................................................. 19 iii AWS Verified Access User Guide OIDC trust provider .............................................................................................................................. 21 Device-based ............................................................................................................................................... 24 Supported device trust providers ...................................................................................................... 24 Create a device-based trust provider ............................................................................................... 24 Modify a device-based trust provider ............................................................................................... 25 Delete a device-based trust provider ............................................................................................... 26 Verified Access groups .................................................................................................................. 27 Create and manage a Verified Access group ........................................................................................ 27 Create a Verified Access group .......................................................................................................... 28 Modify a Verified Access group ......................................................................................................... 28 Modify a Verified Access group policy ................................................................................................... 29 Share a group with another account ..................................................................................................... 29 Considerations ....................................................................................................................................... 30 Resource shares ..................................................................................................................................... 31 Delete a Verified Access group ................................................................................................................ 31 Verified Access endpoints ............................................................................................................. 33 Verified Access endpoint types ............................................................................................................... 33 How Verified Access works with shared VPCs and subnets ............................................................... 34 Create a load balancer endpoint ............................................................................................................ 34 Create a network interface endpoint ..................................................................................................... 36 Create a network CIDR endpoint ............................................................................................................ 37 Create an Amazon Relational Database Service endpoint ................................................................. 38 Allow traffic from your endpoint ............................................................................................................ 40 Modify a Verified Access endpoint ......................................................................................................... 41 Modify a Verified Access endpoint policy ............................................................................................. 41 Delete a Verified Access endpoint .......................................................................................................... 42 Verified Access trust data ............................................................................................................. 43 Default context ........................................................................................................................................... 43 HTTP request ......................................................................................................................................... 44 TCP flow .................................................................................................................................................. 45 AWS IAM Identity Center context ........................................................................................................... 46 Third-party context .................................................................................................................................... 48 Browser extension ................................................................................................................................. 48 Jamf ......................................................................................................................................................... 49 CrowdStrike ............................................................................................................................................ 51 JumpCloud .............................................................................................................................................. 53 iv AWS Verified Access User Guide User claims passing ................................................................................................................................... 54 JWT for OIDC user claims ................................................................................................................... 55 JWT for IAM Identity Center user claims ......................................................................................... 56 Public keys .............................................................................................................................................. 57 Retrieving and decoding JWT ............................................................................................................ 57 Verified Access policies ................................................................................................................. 59 Policy statements ....................................................................................................................................... 59 Policy components ............................................................................................................................... 60 Comments ............................................................................................................................................... 60 Multiple clauses ..................................................................................................................................... 61 Reserved characters .............................................................................................................................. 61 Built-in operators ....................................................................................................................................... 61 Policy evaluation ........................................................................................................................................ 63 Policy logic short circuit ........................................................................................................................... 64 Example policies ......................................................................................................................................... 65 Grant access to a group in IAM Identity Center ............................................................................. 65 Grant access to a group in a third-party provider ......................................................................... 66 Grant access using CrowdStrike ......................................................................................................... 66 Allow or deny a specific IP address .................................................................................................. 66 Policy assistant ........................................................................................................................................... 67 Step 1: Specify your resources ........................................................................................................... 67 Step 2: Test and edit policies ............................................................................................................. 68 Step 3: Review and apply changes ................................................................................................... 68 Connectivity Client ........................................................................................................................ 69 Prerequisites ................................................................................................................................................ 69 Download the Connectivity Client .......................................................................................................... 70 Export the client configuration file ........................................................................................................ 70 Connect to the application ...................................................................................................................... 70 Uninstall the client .................................................................................................................................... 71 Best practices .............................................................................................................................................. 71 Troubleshooting .......................................................................................................................................... 72 When signing in, the browser doesn't open to complete authentication by the IdP ............... 72 After authentication, the client status is "not connected" ........................................................... 72 Can't connect using a Chrome or Edge browser ............................................................................ 72 Version history ............................................................................................................................................ 72 Security .......................................................................................................................................... 74 v AWS Verified Access User Guide Data protection ........................................................................................................................................... 74 Encryption in transit ............................................................................................................................ 75 Inter-network traffic privacy .............................................................................................................. 76 Data encryption at rest ....................................................................................................................... 76 Identity and access management ........................................................................................................... 90 Audience .................................................................................................................................................. 91 Authenticating |
verified-access-ug-002 | verified-access-ug.pdf | 2 | configuration file ........................................................................................................ 70 Connect to the application ...................................................................................................................... 70 Uninstall the client .................................................................................................................................... 71 Best practices .............................................................................................................................................. 71 Troubleshooting .......................................................................................................................................... 72 When signing in, the browser doesn't open to complete authentication by the IdP ............... 72 After authentication, the client status is "not connected" ........................................................... 72 Can't connect using a Chrome or Edge browser ............................................................................ 72 Version history ............................................................................................................................................ 72 Security .......................................................................................................................................... 74 v AWS Verified Access User Guide Data protection ........................................................................................................................................... 74 Encryption in transit ............................................................................................................................ 75 Inter-network traffic privacy .............................................................................................................. 76 Data encryption at rest ....................................................................................................................... 76 Identity and access management ........................................................................................................... 90 Audience .................................................................................................................................................. 91 Authenticating with identities ............................................................................................................ 91 Managing access using policies .......................................................................................................... 95 How Verified Access works with IAM ................................................................................................ 97 Identity-based policy examples ....................................................................................................... 103 Troubleshooting .................................................................................................................................. 107 Use service-linked roles ..................................................................................................................... 108 AWS managed policies ...................................................................................................................... 110 Compliance validation ............................................................................................................................ 112 Resilience ................................................................................................................................................... 113 Multiple subnets for high availability ............................................................................................ 113 Monitoring ................................................................................................................................... 114 Verified Access logs ................................................................................................................................. 114 Logging versions ................................................................................................................................. 115 Logging permissions .......................................................................................................................... 115 Enable or disable logs ....................................................................................................................... 116 Enable or disable trust context ....................................................................................................... 118 OCSF version 0.1 log examples ....................................................................................................... 119 OCSF version 1.0.0-rc.2 log examples ........................................................................................... 131 CloudTrail logs .......................................................................................................................................... 138 Management events ........................................................................................................................... 140 Event examples ................................................................................................................................... 140 Quotas .......................................................................................................................................... 142 Document history ........................................................................................................................ 144 vi AWS Verified Access User Guide What is AWS Verified Access? With AWS Verified Access, you can provide secure access to your applications without requiring the use of a virtual private network (VPN). Verified Access evaluates each application request and helps ensure that users can access each application only when they meet the specified security requirements. Benefits of Verified Access • Improved security posture – A traditional security model evaluates access once and grants the user access to all applications. Verified Access evaluates each application access request in real time. This makes it difficult for bad actors to move from one application to another. • Integration with security services – Verified Access integrates with identity and device management services, including both AWS and third-party services. Using data from these services, Verified Access verifies the trustworthiness of users and devices against a set of security requirements and determines whether the user should have access to an application. • Improved user experience – Verified Access removes the need for users to use a VPN to access your applications. This helps reduce the number of support cases arising from VPN-related issues. • Simplified troubleshooting and audits – Verified Access logs all access attempts, providing centralized visibility into application access, to help you quickly respond to security incidents and audit requests. Accessing Verified Access You can use any of the following interfaces to work with Verified Access: • AWS Management Console – Provides a web interface that you can use to create and manage Verified Access resources. Sign in to the AWS Management Console and open the Amazon VPC console at https://console.aws.amazon.com/vpc/. • AWS Command Line Interface (AWS CLI) – Provides commands for a broad set of AWS services, including AWS Verified Access. The AWS CLI is supported on Windows, macOS, and Linux. To get the AWS CLI, see AWS Command Line Interface. Benefits of Verified Access 1 AWS Verified Access User Guide • AWS SDKs – Provide language-specific APIs. The AWS SDKs take care of many of the connection details, such as calculating signatures, and handling request retries and errors. For more information, see AWS SDKs. • Query API – Provides low-level API actions that you call using HTTPS requests. Using the Query API is the most direct way to access Verified Access. However, it requires your application to handle low-level details such as generating the hash to sign the request and handling errors. For more information, see Verified Access actions in the Amazon EC2 API Reference. This guide describes how to use the AWS Management Console to create, access, and manage Verified Access resources. Pricing You are charged hourly for each application on Verified Access, and you are charged for the amount of data processed by Verified Access. For more information, see AWS Verified Access pricing. Pricing 2 AWS Verified Access User Guide How Verified Access works AWS Verified Access evaluates each application request from your users and allows access based on: • Trust data sent by your chosen trust provider (from AWS or a third party). • Access policies that you create in Verified Access. When a user tries to access an application, Verified Access gets their data from the trust provider and evaluates it against the policies that you set for the application. Verified Access grants access to the requested application only if the user meets your specified security requirements. All application requests are denied by default, until a policy is defined. In addition, Verified Access logs every access attempt, to help you respond quickly to security incidents |
verified-access-ug-003 | verified-access-ug.pdf | 3 | based on: • Trust data sent by your chosen trust provider (from AWS or a third party). • Access policies that you create in Verified Access. When a user tries to access an application, Verified Access gets their data from the trust provider and evaluates it against the policies that you set for the application. Verified Access grants access to the requested application only if the user meets your specified security requirements. All application requests are denied by default, until a policy is defined. In addition, Verified Access logs every access attempt, to help you respond quickly to security incidents and audit requests. Key components of Verified Access The following diagram provides a high-level overview of Verified Access. Users send requests to access an application. Verified Access evaluates the request against the access policy for the group and any application-specific endpoint policies. If access is allowed, the request is sent to the application through the endpoint. Key components of Verified Access 3 AWS Verified Access User Guide • Verified Access instances – An instance evaluates application requests and grants access only when your security requirements are met. • Verified Access endpoints – Each endpoint represents an application. In the diagram above, the application is hosted on EC2 instances that are targets of a load balancer. • Verified Access group – A collection of Verified Access endpoints. We recommend that you group the endpoints for applications with similar security requirements to simplify policy administration. For example, you can group the endpoints for all your sales applications together. • Access policies – A set of user-defined rules that determine whether to allow or deny access to an application. You can specify a combination of factors, including user identity and device security state. You create a group access policy for each Verified Access group, which is inherited by all endpoints in the group. You can optionally create application-specific policies and attach them to specific endpoints. • Trust providers – A service that manages user identities or device security state. Verified Access works with both AWS and third-party trust providers. You must attach at least one trust provider to each Verified Access instance. You can attach a single identity trust provider and multiple device trust providers to each Verified Access instance. • Trust data – The security-related data for users or devices that your trust provider sends to Verified Access. Also referred to as user claims or trust context. For example, the email address of a user or the operating system version of a device. Verified Access evaluates this data against your access policies when it receives each request to access an application. Key components of Verified Access 4 AWS Verified Access User Guide Tutorial: Get started with Verified Access Use this tutorial to get started with AWS Verified Access. You'll learn how to create and configure Verified Access resources. As a part of this tutorial, you'll add an application to Verified Access. At the end of the tutorial, specific users can access that application over the internet, without using VPN. Instead, you'll use AWS IAM Identity Center as an identity trust provider. Note that this tutorial doesn't also use a device trust provider. Tasks • Verified Access tutorial prerequisites • Step 1: Create a Verified Access trust provider • Step 2: Create a Verified Access instance • Step 3: Create a Verified Access group • Step 4: Create a Verified Access endpoint • Step 5: Configure DNS for the Verified Access endpoint • Step 6: Test connectivity to the application • Step 7: Add a Verified Access group-level access policy • Clean up your Verified Access resources Verified Access tutorial prerequisites The following are the prerequisites for completing this tutorial: • AWS IAM Identity Center enabled in the AWS Region that you're working in. You can then use IAM Identity Center as a trust provider with Verified Access. For more information, see Enable AWS IAM Identity Center in the AWS IAM Identity Center User Guide. • A security group to control access to the application. Allow all inbound traffic from the VPC CIDR and all outbound traffic. • An application running behind an internal load balancer from Elastic Load Balancing. Associate your security group with the load balancer. • A self-signed or public TLS certificate in AWS Certificate Manager. Use an RSA certificate with a key length of 1,024 or 2,048. Prerequisites 5 AWS Verified Access User Guide • A public hosted domain and the permissions required to update DNS records for the domain. • An IAM policy with the permissions required to create an AWS Verified Access instance. For more information, see Policy for creating Verified Access instances. Step 1: Create a Verified Access trust provider Use the following procedure to set up AWS IAM Identity Center as your trust provider. To |
verified-access-ug-004 | verified-access-ug.pdf | 4 | group with the load balancer. • A self-signed or public TLS certificate in AWS Certificate Manager. Use an RSA certificate with a key length of 1,024 or 2,048. Prerequisites 5 AWS Verified Access User Guide • A public hosted domain and the permissions required to update DNS records for the domain. • An IAM policy with the permissions required to create an AWS Verified Access instance. For more information, see Policy for creating Verified Access instances. Step 1: Create a Verified Access trust provider Use the following procedure to set up AWS IAM Identity Center as your trust provider. To create an IAM Identity Center trust provider 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. In the navigation pane, choose Verified Access trust providers. 3. Choose Create Verified Access trust provider. 4. 5. 6. 7. (Optional) For Name tag and Description, enter a name and description for the Verified Access trust provider. Enter a custom identifier to use later when working with policy rules for Policy reference name. For example, you can enter idc. For Trust provider type, choose User trust provider. For User trust provider type, choose IAM Identity Center. 8. Choose Create Verified Access trust provider. Step 2: Create a Verified Access instance Use the following procedure to create a Verified Access instance. To create a Verified Access instance 1. In the navigation pane, choose Verified Access instances. 2. Choose Create Verified Access instance. 3. (Optional) For Name and Description, enter a name and description for the Verified Access instance. 4. For Verified Access trust provider, choose your trust provider. 5. Choose Create Verified Access instance. Create a trust provider 6 AWS Verified Access User Guide Step 3: Create a Verified Access group Use the following procedure to create a Verified Access group. To create a Verified Access group 1. In the navigation pane, choose Verified Access groups. 2. Choose Create Verified Access group. 3. 4. (Optional) For Name tag and Description, enter a name and description for the group. For Verified Access instance, choose your Verified Access instance. 5. Keep Policy definition blank. You will add a group-level policy in a later step. 6. Choose Create Verified Access group. Step 4: Create a Verified Access endpoint Use the following procedure to create a Verified Access endpoint. This step assumes that you have an application running behind an internal load balancer from Elastic Load Balancing and a public domain certificate in AWS Certificate Manager. To create a Verified Access endpoint 1. In the navigation pane, choose Verified Access endpoints. 2. Choose Create Verified Access endpoint. 3. 4. 5. (Optional) For Name tag and Description, enter a name and description for the endpoint. For Verified Access group, choose your Verified Access group. For Endpoint details, do the following: a. b. c. d. For Protocol, select HTTPS or HTTP, depending on the configuration of your load balancer. For Attachment type, choose VPC. For Endpoint type, choose Load balancer. For Port, enter the port number used by your load balancer listener. For example, 443 for HTTPS or 80 for HTTP. e. For Load balancer ARN, choose your load balancer. Create a group 7 AWS Verified Access User Guide f. g. h. For Subnets, select the subnets associated with your load balancer. For Security groups, select your security group. Using the same security group for your load balancer and endpoint allows traffic between them. If you prefer not to use the same security group, be sure to reference the endpoint security group from your load balancer so that it accepts traffic from the endpoint. For Endpoint domain prefix, enter a custom identifier. For example, my-ava-app. This prefix is prepended to the DNS name that Verified Access generates. 6. For Application details, do the following: a. b. For Application domain, enter the DNS name for your application. This domain must match the one in your domain certificate. For Domain certificate ARN, select the Amazon Resource Name (ARN) of your domain certificate in AWS Certificate Manager. 7. Keep Policy details blank. You will add a group-level access policy in a later step. 8. Choose Create Verified Access endpoint. Step 5: Configure DNS for the Verified Access endpoint For this step, you map your application's domain name (for example, www.myapp.example.com) to the domain name of your Verified Access endpoint. To complete the DNS mapping, create a Canonical Name Record (CNAME) with your DNS provider. After you create the CNAME record, all requests from users to your application will be sent to Verified Access. To get the domain name of your endpoint 1. 2. In the navigation pane, choose Verified Access endpoints. Select your endpoint. 3. Choose the Details tab. 4. Copy the domain from Endpoint domain. The following is an example endpoint domain name: my-ava-app.edge-1a2b3c4d5e6f7g.vai-1a2b3c4d5e6f7g.prod.verified- access.us-west-2.amazonaws.com. Follow the directions provided by your DNS provider |
verified-access-ug-005 | verified-access-ug.pdf | 5 | application's domain name (for example, www.myapp.example.com) to the domain name of your Verified Access endpoint. To complete the DNS mapping, create a Canonical Name Record (CNAME) with your DNS provider. After you create the CNAME record, all requests from users to your application will be sent to Verified Access. To get the domain name of your endpoint 1. 2. In the navigation pane, choose Verified Access endpoints. Select your endpoint. 3. Choose the Details tab. 4. Copy the domain from Endpoint domain. The following is an example endpoint domain name: my-ava-app.edge-1a2b3c4d5e6f7g.vai-1a2b3c4d5e6f7g.prod.verified- access.us-west-2.amazonaws.com. Follow the directions provided by your DNS provider to create a CNAME record. Use the domain name of your application as the record name and the domain name of the Verified Access endpoint as the record value. Configure DNS for the endpoint 8 AWS Verified Access User Guide Step 6: Test connectivity to the application You can now test connectivity to your application. Enter your application's domain name into your web browser. The default behavior of Verified Access is to deny all requests. Because we did not add a Verified Access policy to the group or the endpoint, all requests are denied. Step 7: Add a Verified Access group-level access policy Use the following procedure to modify the Verified Access group and configure an access policy that allows connectivity to your application. The details of the policy will depend on the users and groups that are configured in IAM Identity Center. For information, see Verified Access policies. To modify a Verified Access group 1. 2. In the navigation pane, choose Verified Access groups. Select your group. 3. Choose Actions, Modify Verified Access group policy. 4. 5. Turn on Enable policy. Enter a policy that allows users from your IAM Identity Center to access your application. For examples, see the section called “Example policies”. 6. Choose Modify Verified Access group policy. 7. Now that your group policy is in place, repeat the test from the previous step to verify that the request is allowed. If the request is allowed, you are prompted to sign in through the IAM Identity Center sign-in page. After you provide the user name and password, you can access your application. Clean up your Verified Access resources After you are finished with this tutorial, use the following procedure to delete your Verified Access resources. To delete your Verified Access resources 1. In the navigation pane, choose Verified Access endpoints. Select the endpoint and choose Actions, Delete Verified Access endpoint. Test connectivity to the application 9 AWS Verified Access User Guide 2. 3. 4. 5. In the navigation pane, choose Verified Access groups. Select the group and choose Actions, Delete Verified Access group. You might need to wait until the endpoint deletion process is complete. In the navigation pane, choose Verified Access instances. Select your instance and choose Actions, Detach Verified Access trust provider. Select the trust provider and choose Detach Verified Access trust provider. In the navigation pane, choose Verified Access trust providers. Select your trust provider and choose Actions, Delete Verified Access trust provider. In the navigation pane, choose Verified Access instances. Select your instance and choose Actions, Delete Verified Access instance. Clean up 10 AWS Verified Access User Guide Verified Access instances An AWS Verified Access instance is an AWS resource that helps you organize your trust providers and Verified Access groups. An instance evaluates application requests and grants access only when your security requirements are met. Tasks • Create and manage a Verified Access instance • Delete a Verified Access instance • Integrate Verified Access with AWS WAF • FIPS compliance for Verified Access Create and manage a Verified Access instance You use a Verified Access instance to organize your trust providers and Verified Access groups. Use the following procedures to create a Verified Access instance, and then attach a trust provider to Verified Access or detach a trust provider from Verified Access. Tasks • Create a Verified Access instance • Attach a trust provider to a Verified Access instance • Detach a trust provider from a Verified Access instance • Add a custom subdomain Create a Verified Access instance Use the following procedure to create a Verified Access instance. To create a Verified Access instance using the console 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. In the navigation pane, choose Verified Access instances, and then Create Verified Access instance. (Optional) For Name and Description, enter a name and description for the Verified Access instance. Create and manage a Verified Access instance 11 AWS Verified Access User Guide 4. 5. 6. (Network CIDR endpoints) For Custom subdomain for network CIDR endpoint, enter a custom subdomain. (Optional) Choose Enable for Federal Information Process Standards (FIPS) if you require Verified Access to be FIPS compliant. (Optional) For Verified Access trust provider, |
verified-access-ug-006 | verified-access-ug.pdf | 6 | a Verified Access instance using the console 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. In the navigation pane, choose Verified Access instances, and then Create Verified Access instance. (Optional) For Name and Description, enter a name and description for the Verified Access instance. Create and manage a Verified Access instance 11 AWS Verified Access User Guide 4. 5. 6. (Network CIDR endpoints) For Custom subdomain for network CIDR endpoint, enter a custom subdomain. (Optional) Choose Enable for Federal Information Process Standards (FIPS) if you require Verified Access to be FIPS compliant. (Optional) For Verified Access trust provider, choose a trust provider to attach to the Verified Access instance. 7. (Optional) To add a tag, choose Add new tag and enter the tag key and the tag value. 8. Choose Create Verified Access instance. To create a Verified Access instance using the AWS CLI Use the create-verified-access-instance command. Attach a trust provider to a Verified Access instance Use the following procedure to attach a trust provider to a Verified Access instance. To attach a trust provider to a Verified Access instance using the console 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. In the navigation pane, choose Verified Access instances. Select the instance. 4. Choose Actions, Attach Verified Access trust provider. 5. For Verified Access trust provider, choose a trust provider. 6. Choose Attach Verified Access trust provider. To attach a trust provider to a Verified Access instance using the AWS CLI Use the attach-verified-access-trust-provider command. Detach a trust provider from a Verified Access instance Use the following procedure to detach a trust provider from a Verified Access instance. To detach a trust provider from a Verified Access instance using the console 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. Attach a trust provider to a Verified Access instance 12 AWS Verified Access User Guide 2. 3. In the navigation pane, choose Verified Access instances. Select the instance. 4. Choose Actions, Detach Verified Access trust provider. 5. For Verified Access trust provider, choose the trust provider. 6. Choose Detach Verified Access trust provider. To detach a trust provider from a Verified Access instance using the AWS CLI Use the detach-verified-access-trust-provider command. Add a custom subdomain Use the following procedure to add or update a custom subdomain. This subdomain is used only when you create a network CIDR endpoint. To add a custom subdomain using the console 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. In the navigation pane, choose Verified Access instances. Select the instance. 4. Choose Actions, Modify Verified Access instance. 5. For Custom subdomain for network CIDR endpoint, enter a custom subdomain. 6. Choose Modify Verified Access instance. 7. Update the nameservers for your subdomain, entering the nameservers provided by Verified Access. This list is available under Nameservers on the Details tab for the instance. To add a custom subdomain using the AWS CLI Use the modify-verified-access-instance command. Delete a Verified Access instance When you are finished with a Verified Access instance, you can delete it. Before you can delete an instance, you must remove any associated trust providers or Verified Access groups. Add a custom subdomain 13 AWS Verified Access User Guide To delete a Verified Access instance using the console 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. In the navigation pane, choose Verified Access instances. Select the Verified Access instance. 4. Choose Actions, Delete Verified Access instance. 5. When prompted for confirmation, enter delete, and then choose Delete. To delete a Verified Access instance using the AWS CLI Use the delete-verified-access-instance command. Integrate Verified Access with AWS WAF In addition to the authentication and authorization rules enforced by Verified Access, you might also want to apply perimeter protection. This can help you protect your applications from additional threats. You can accomplish this by integrating AWS WAF into your Verified Access deployment. AWS WAF is a web application firewall that lets you monitor the HTTP requests that are forwarded to your protected web application resources. For more information, see the AWS WAF Developer Guide. You can integrate AWS WAF with Verified Access by associating an AWS WAF web access control list (ACL) with a Verified Access instance. A web ACL is a AWS WAF resource that gives you fine- grained control over all of the HTTP web requests that your protected resource responds to. While the AWS WAF association or disassociation request is being processed, the status of any Verified Access endpoints attached to the instance are shown as updating. After the request is complete, the status returns to active. You can view the status in the AWS Management Console or by describing the endpoint with the AWS CLI. The user-identity trust provider determines when AWS WAF inspects the traffic. If you use IAM Identity Center, AWS WAF |
verified-access-ug-007 | verified-access-ug.pdf | 7 | web ACL is a AWS WAF resource that gives you fine- grained control over all of the HTTP web requests that your protected resource responds to. While the AWS WAF association or disassociation request is being processed, the status of any Verified Access endpoints attached to the instance are shown as updating. After the request is complete, the status returns to active. You can view the status in the AWS Management Console or by describing the endpoint with the AWS CLI. The user-identity trust provider determines when AWS WAF inspects the traffic. If you use IAM Identity Center, AWS WAF inspects the traffic before user authentication. If you use OpenID Connect (OIDC), AWS WAF inspects the traffic after user authentication. Contents • Required IAM permissions • Associate an AWS WAF web ACL Integrate with AWS WAF 14 AWS Verified Access User Guide • Check the status of the association • Disassociate an AWS WAF web ACL Required IAM permissions Integrating AWS WAF with Verified Access includes permission-only actions that don't directly correspond to an API operation. These actions are indicated in the AWS Identity and Access Management Service Authorization Reference with [permission only]. See Actions, resources, and condition keys for Amazon EC2 in the Service Authorization Reference. To work with a web ACL, your AWS Identity and Access Management principal must have the following permissions. • ec2:AssociateVerifiedAccessInstanceWebAcl • ec2:DisassociateVerifiedAccessInstanceWebAcl • ec2:DescribeVerifiedAccessInstanceWebAclAssociations • ec2:GetVerifiedAccessInstanceWebAcl Associate an AWS WAF web ACL The following steps demonstrate how to associate an AWS WAF web access control list (ACL) with a Verified Access instance using the Verified Access console. Prerequisite Before you begin, create a AWS WAF web ACL. For more information, see Create a web ACL in the AWS WAF Developer Guide. To associate an AWS WAF web ACL to a Verified Access instance 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Verified Access instances. Select the Verified Access instance. Select the Integrations tab. 5. Choose Actions, then Associate Web ACL. 6. For Web ACL, choose an existing web ACL, then choose Associate Web ACL. Required IAM permissions 15 AWS Verified Access User Guide Alternatively, you can use the AWS WAF console. If you use the AWS WAF console or API, you need the Amazon Resource Name (ARN) of your Verified Access instance. An AVA ARN has the following format: arn:${Partition}:ec2:${Region}:${Account}:verified-access-instance/ ${VerifiedAccessInstanceId}. For more information, see Associate a web ACL with an AWS resource in the AWS WAF Developer Guide. Check the status of the association You can verify whether an AWS WAF web access control list (ACL) is associated with a Verified Access instance or not by using the Verified Access console. To view the status of AWS WAF integration with a Verified Access instance 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Verified Access instances. Select the Verified Access instance. Select the Integrations tab. 5. Check the details listed under WAF integration status. The status will be shown as Associated or Not associated, along with the web ACL identifier, if in the Associated state. Disassociate an AWS WAF web ACL The following steps demonstrate how to disassociate an AWS WAF web access control list (ACL) from a Verified Access instance using the Verified Access console. To disassociate an AWS WAF web ACL from a Verified Access instance 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Verified Access instances. Select the Verified Access instance. Select the Integrations tab. 5. Choose Actions, then Disassociate Web ACL. 6. Confirm by choosing Disassociate Web ACL. Alternatively, you can use the AWS WAF console. For more information, see Disassociate a web ACL from an AWS resource in the AWS WAF Developer Guide. Check the status of the association 16 AWS Verified Access User Guide FIPS compliance for Verified Access Federal Information Processing Standard (FIPS) is a US and Canadian government standard that specifies security requirements for cryptographic modules that protect sensitive information. AWS Verified Access provides the option to configure your environment to adhere to FIPS Publication 140-2. FIPS compliance for Verified Access is available in the following AWS Regions: • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Canada (Central) • AWS GovCloud (US) West • AWS GovCloud (US) East This page shows you how to configure a new, or an existing Verified Access environment, to be FIPS compliant. Contents • Configure an existing Verified Access environment for FIPS compliance • Configure a new Verified Access environment for FIPS compliance Configure an existing Verified Access environment for FIPS compliance If you have an existing Verified Access environment and you want to configure it to be FIPS compliant, some of the resources will |
verified-access-ug-008 | verified-access-ug.pdf | 8 | (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Canada (Central) • AWS GovCloud (US) West • AWS GovCloud (US) East This page shows you how to configure a new, or an existing Verified Access environment, to be FIPS compliant. Contents • Configure an existing Verified Access environment for FIPS compliance • Configure a new Verified Access environment for FIPS compliance Configure an existing Verified Access environment for FIPS compliance If you have an existing Verified Access environment and you want to configure it to be FIPS compliant, some of the resources will need to be deleted and re-created in order to turn on FIPS compliance. To re-configure an existing AWS Verified Access environment to be FIPS compliant, follow the steps below. 1. Delete your original Verified Access endpoint(s), group(s), and instance. Your configured trust providers can be re-used. 2. Create a Verified Access instance, making sure to enable Federal Information Process Standards (FIPS) during creation. Also during creation, attach the Verified Access trust provider you want to use, by selecting it from the drop down list. FIPS compliance 17 AWS Verified Access User Guide 3. Create a Verified Access group. During creation of the group, you associate it with the Verified Access instance just created. 4. Create one or more Verified Access endpoints. During the creation of your endpoint(s), you associate them with the group created in the previous step. Configure a new Verified Access environment for FIPS compliance To configure a new AWS Verified Access environment that is FIPS compliant, follow the steps below. 1. Configure a trust provider. You will need to create a user identity trust provider and (optionally) a device-based trust provider, depending on your needs. 2. Create a Verified Access instance, making sure to enable Federal Information Process Standards (FIPS) during the process. Also during creation, attach the Verified Access trust provider you created in the previous step, by selecting it from the drop down list. 3. Create a Verified Access group. During creation of the group, you associate it with the Verified Access instance just created. 4. Create one or more Verified Access endpoints. During the creation of your endpoint(s), you associate them with the group created in the previous step. New environment 18 AWS Verified Access User Guide Trust providers for Verified Access A trust provider is a service that sends information about users and devices to AWS Verified Access. This information is called trust context. It can include attributes based on user identity, such as an email address or membership in the "sales" organization, or device information such as installed security patches or anti-virus software version. Verified Access supports the following categories of trust providers: • User identity – An identity provider (IdP) service that stores and manages digital identities for users. • Device management – A device management system for devices such as laptops, tablets, and smartphones. Contents • User-identity trust providers for Verified Access • Device-based trust providers for Verified Access User-identity trust providers for Verified Access You can choose to use either AWS IAM Identity Center or an OpenID Connect-compatible user- identity trust provider. Contents • Using IAM Identity Center as a trust provider • Use an OpenID Connect trust provider Using IAM Identity Center as a trust provider You can use AWS IAM Identity Center as your user-identity trust provider with AWS Verified Access. Prerequisites and considerations • Your IAM Identity Center instance must be an AWS Organizations instance. A standalone AWS account IAM Identity Center instance will not work. User-identity 19 AWS Verified Access User Guide • Your IAM Identity Center instance must be enabled in the same AWS Region that you want to create the Verified Access trust provider in. • Verified Access can provide access to users in IAM Identity Center who are assigned to up to 1,000 groups. See Manage organization and account instances of IAM Identity Center in the AWS IAM Identity Center User Guide for details on the different instance types. Create an IAM Identity Center trust provider After IAM Identity Center is enabled on your AWS account, you can use the following procedure to set up IAM Identity Center as your trust provider for Verified Access. To create an IAM Identity Center trust provider (AWS console) 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Verified Access trust providers, and then Create Verified Access trust provider. (Optional) For Name tag and Description, enter a name and description for the trust provider. For Policy reference name, enter an identifier to use later when working with policy rules. 5. Under Trust provider type, select User trust provider. 6. Under User trust provider type, select IAM Identity Center. 7. (Optional) To add a tag, choose Add new tag and |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.