Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
sir-ug-003	sir-ug.pdf	3	or groups, with predeﬁned permission policies. Feature Summary Version December 1, 2024 3 AWS Security Incident Response User Guide Concepts and Terminology The following terms and concepts are important for understanding the AWS Security Incident Response service and how it works. Scope: AWS Security Incident Response aligns with the National Institute of Standards and Techology (NIST) 800-61 Computer Security Incident Handling Guide, providing a consistent approach to security event management as related to industry best practices. Analysis: The detailed investigation and examination of a security event to understand its scope, impact, and root cause. AWS Security Incident Response service portal: A self-service portal for you to initiate and manage security event cases. Ongoing communication and reporting facilitated through the ticketing system, automated notiﬁcations, and direct engagement with the service team. Communication: The ongoing dialog and information sharing between the AWS Security Incident Response team and the customer during the incident response process. Containment, Eradication, and Recovery: The prevention of additional unauthorized activity (containment), coupled with the removal of unauthorized resources and the original vulnerability (eradication), and recovering resources to get back to business as normal. Continuous Improvement: AWS Security Incident Response incorporates feedback and lessons learned from prior engagements to enhance its detection capabilities, investigative processes, and remediation actions. AWS Security Incident Response also stays up-to-date with the latest security threats and best practices to address evolving security challenges. Cybersecurity Event: An action that uses an information system or network to produce an adverse eﬀect on the system, network, or information it contains. Cybersecurity Incident: A violation or imminent threat of violation of computer security policies, acceptable use policies, or standard security practices. Incident Response Team: A group of individuals who provide support during active security events. For AWS supported cases, this is the AWS Customer Incident Response Team (CIRT). Incident Response Workﬂow: The deﬁned sequence of steps and activities involved in the end-to- end management of a security event, aligned with the NIST 800-61 standard. Version December 1, 2024 4 AWS Security Incident Response User Guide Investigative Tooling: AWS Security Incident Response tools and service-linked roles used to review the operational health of your account and resources. Lessons Learned: The review and documentation of a security event response to identify areas for improvement and inform future incident response planning. Monitoring and Investigation: AWS Security Incident Response rapidly reviews security alerts from Amazon GuardDuty, bringing to the forefront the most important alerts your team needs to analyze. It conﬁgures suppression rules based on the speciﬁcs of your environment to prevent unnecessary alerts. Preparation: The activities undertaken to get an organization ready to eﬀectively respond to and manage security events, such as developing incident response plans and testing procedures. Reporting and Communication: The processes used to keep you informed throughout the incident response process, including automated notiﬁcations, call bridges, and the delivery of investigation artifacts. AWS Security Incident Response provides a single, centralized dashboard in the AWS Management Console to manage all your AWS Security Incident Response eﬀorts. Responder Generated Intelligence: indicators of compromise; tactics, techniques, and procedures; and associated patterns observed by AWS CIRT investigations. Security Event Expertise: The specialized knowledge and skills required to eﬀectively respond to and manage security events, particularly in the context of the AWS cloud. Shared Responsibility Model: The division of security responsibilities between AWS and the customer, where AWS is responsible for security of the cloud, and the customer is responsible for security in the cloud. Threat Intelligence: Internal and external data feeds containing details of unauthorized activity to help identify and respond to evolving security threats. Ticketing System: A dedicated case management platform that allows you to onboard and manage security event cases, add attachments, and track the incident response lifecycle. Triage: The initial assessment and prioritization of a security event to determine the appropriate response and next steps. Workﬂow: The deﬁned sequence of steps and activities involved in the end-to-end management of a security event. Version December 1, 2024 5 AWS Security Incident Response User Guide Getting Started Contents • Select a membership account • Setup membership details • Associate accounts with AWS Organizations • Setup proactive response and alert triaging workﬂows Select a membership account A membership account is the AWS account used to conﬁgure account details, add and remove details for your incident response team, and where all active and historical security events can be created and managed. It is recommended that you align your AWS Security Incident Response membership account to the same account that you have enabled for services such as Amazon GuardDuty and AWS Security Hub. You have two options for selecting your AWS Security Incident Response membership account using AWS Organizations. You can either create a membership in the Organizations management account or in an Organizations delegated administrator account. Use the delegated administrator account: AWS Security
sir-ug-004	sir-ug.pdf	4	account used to conﬁgure account details, add and remove details for your incident response team, and where all active and historical security events can be created and managed. It is recommended that you align your AWS Security Incident Response membership account to the same account that you have enabled for services such as Amazon GuardDuty and AWS Security Hub. You have two options for selecting your AWS Security Incident Response membership account using AWS Organizations. You can either create a membership in the Organizations management account or in an Organizations delegated administrator account. Use the delegated administrator account: AWS Security Incident Response administrative tasks and case management are located in the delegated administrator account. We recommend using the same delegated administrator you've set for other AWS security and compliance services. Provide the 12-digit delegated administrator account ID and then log in to that account to proceed. Important When you use a delegated administrator account as part of setup, AWS Security Incident Response cannot automatically create the required triage service linked role in your AWS Organizations management account. You can use the IAM to create this role in your AWS Organizations management account To create a service-linked role (console) 1. Login to your AWS Organizations management account. 2. Access the AWS CloudShell window or access the account via CLI in your preferred method. Select a membership account Version December 1, 2024 6 AWS Security Incident Response User Guide 3. Use the CLI command aws iam create-service-linked-role --aws- service-name triage.security-ir.amazonaws.com 4. (Optional) To verify the command worked you can execute the command aws iam get-role --role-name AWSServiceRoleForSecurityIncidentResponse_Triage 5. Review the role and then choose Create role. Use the currently logged in account: Selecting this account means the current account will be designated as the central membership account for your AWS Security Incident Response membership. Individuals within your organization will need to access the service through this account to create, access, and manage active and resolved cases. Ensure you have suﬃcient permissions to administer AWS Security Incident Response. Refer to Adding and removing IAM identity permissions for speciﬁc steps to add permissions. Refer to AWS Security Incident Response managed policies. To verify IAM permissions, you can follow these steps: • Check the IAM Policy: Review the IAM policy attached to your user, group, or role to ensure it grants the necessary permissions. You can do this by navigating to the https:// console.aws.amazon.com/iam/, select the Users option, choose the speciﬁc user, and then on their summary page, go to the Permissions tab where you can see a list of all attached policies; you can expand each policy row to view its details. • Test the Permissions: Try to perform the action you need to verify the permissions. For example, if you need to access a case, try to ListCases. If you don't have the necessary permissions, you'll receive an error message. • Use the AWS CLI or SDK: You can use the AWS Command Line Interface or an AWS SDK in your preferred programming language to test the permissions. For example, with the AWS Command Line Interface, you can run the aws sts get-caller-identity command to verify your current user permissions. • Check the AWS CloudTrail logs: Review the CloudTrail logs to see if the actions you're trying to perform are being logged. This can help you identify any permission issues. • Use the IAM policy simulator: The IAM policy simulator is a tool that allows you to test IAM policies and see the eﬀect they have on your permissions. Select a membership account Version December 1, 2024 7 AWS Security Incident Response User Guide Note The speciﬁc steps may vary depending on the AWS service and the actions you're trying to perform. Setup membership details • Select an AWS Region where your membership and cases will be stored. Warning You can't change the default AWS Region after initial membership registration. • You may optionally select a name for this membership. • A Primary and Secondary contact must be supplied as part of the create membership workﬂow. These contacts are automatically included as part of you incident response team. At least two contacts must exist for a single membership which also ensures a minimum of two contacts are included in the incident response team. • Deﬁne optional tags for your membership. Tags help you to track AWS costs and search for resources. Associate accounts with AWS Organizations Your membership entitles coverage on all linked AWS accounts in AWS Organizations. Associated accounts will automatically update as accounts get added or removed from your organization. Setup proactive response and alert triaging workﬂows Proactive response and alert triaging workﬂow is an optional feature to enable within your organization for monitoring enabled security services. Select the toggle next to the feature to enable. If you experience any onboarding
sir-ug-005	sir-ug.pdf	5	of two contacts are included in the incident response team. • Deﬁne optional tags for your membership. Tags help you to track AWS costs and search for resources. Associate accounts with AWS Organizations Your membership entitles coverage on all linked AWS accounts in AWS Organizations. Associated accounts will automatically update as accounts get added or removed from your organization. Setup proactive response and alert triaging workﬂows Proactive response and alert triaging workﬂow is an optional feature to enable within your organization for monitoring enabled security services. Select the toggle next to the feature to enable. If you experience any onboarding issues, then please create an AWS Support case for additional assistance. Make sure to include details including the AWS account ID and any errors you may have seen during the setup process. Set up membership details Version December 1, 2024 8 AWS Security Incident Response User Guide Proactive response and alert triaging: AWS Security Incident Response monitors and investigates alerts generated from Amazon GuardDuty and Security Hub integrations. To use this feature, Amazon GuardDuty must be enabled. AWS Security Incident Response triages low-priority alerts with service automation so your team can focus on the most critical issues. For additional information on how AWS Security Incident Response works with Amazon GuardDuty and AWS Security Hub, please review the Detect and Analyze section of the user guide. This feature enables AWS Security Incident Response to monitor and investigate ﬁndings across all accounts and active supported AWS Regions in your organization. To facilitate this functionality, AWS Security Incident Response automatically creates a service-linked role in all member accounts within your AWS Organizations. However, for the management account, you must manually create the service-linked role to enable monitoring. The service cannot create the service-linked role in the management account. You must create this role manually in the management account by working with AWS CloudFormation stack sets. Containment: In the event of a security incident, AWS Security Incident Response can execute containment actions to quickly mitigate the impact, such as isolating compromised hosts or rotating credentials. Security Incident Response does not enable containment capabilities by default. To execute these containment actions, you must ﬁrst grant the necessary permissions to the service. This can be done by deploying an AWS CloudFormation StackSet, which creates the required roles. Set up proactive response and alert triaging workﬂows Version December 1, 2024 9 AWS Security Incident Response User Guide User tasks Contents • Dashboard • Managing my Incident Response Team • Account association to AWS Organizations • Monitoring and investigation • Cases • Managing Cases • Working with AWS CloudFormation stacksets • Cancel Membership Dashboard On the AWS Security Incident Response console, the dashboard provides you with an overview of your incident response team, your proactive response status, and a four-week rolling count of cases. Select View incident response team to access details of your incident response teammates. Select proactive response to identify if alert triaging is enabled. If you don’t have the alert triaging workﬂow enabled, you can monitor its status and choose Proactive Response to enable it. The My Cases section of the dashboard shows the number of opened and closed AWS supported cases, along with self-managed cases assigned to you within a deﬁned period. It also shows the mean time it took to resolve the closed cases in hours. Managing my Incident Response Team Your incident response teams contains stakeholders for the incident response process. You can conﬁgure up to ten stakeholders as part of your membership. Examples for internal stakeholders include members of your incident response team, security analysts, application owners, and your security leadership team. Dashboard Version December 1, 2024 10 AWS Security Incident Response User Guide Examples for external stakeholders include individuals from independent software vendors (ISV) and managed service providers (MSP) that you want to include in an incident response process. Note Setting up your incident response team does not automatically grant teammates access to service resources such as membership and cases. You can use AWS managed policies for AWS Security Incident Response to grant read and write access to resources. Click here to learn more. Your incident response teammates speciﬁed on a membership level will be automatically added to any case. You can add or remove individual teammates at any time after a case has been created. The incident response team will receive an email notiﬁcation on the following events: • Case (create, delete, update) • Comment (create, delete, update) • Attachment (create, delete, update) • Membership (create, update, cancel, resume) Account association to AWS Organizations When you enable AWS Security Incident Response, the membership will be created and aligned to your AWS Organizations. All accounts within your Organizations are aligned to your AWS Security Incident Response membership. For more detail, please see Managing AWS Security Incident Response accounts with AWS
sir-ug-006	sir-ug.pdf	6	You can add or remove individual teammates at any time after a case has been created. The incident response team will receive an email notiﬁcation on the following events: • Case (create, delete, update) • Comment (create, delete, update) • Attachment (create, delete, update) • Membership (create, update, cancel, resume) Account association to AWS Organizations When you enable AWS Security Incident Response, the membership will be created and aligned to your AWS Organizations. All accounts within your Organizations are aligned to your AWS Security Incident Response membership. For more detail, please see Managing AWS Security Incident Response accounts with AWS Organizations. Monitoring and investigation AWS Security Incident Response reviews and triages security alerts from Amazon GuardDuty and AWS Security Hub, then conﬁgures suppression rules based on your environment to prevent unnecessary alerts. The AWS CIRT team investigates non-triaged ﬁndings and quickly escalates and guides your team to rapidly contain potential issues. If desired, you can grant AWS Security Incident Response permission to implement containment actions on your behalf. Account association to AWS Organizations Version December 1, 2024 11 AWS Security Incident Response User Guide AWS Security Incident Response aligns to the NIST 800-61r2 Computer Security event Handling Guide for Security event Response. By aligning to this industry standard, AWS Security Incident Response provides a consistent approach to security event management and adhere to best practices in securing and responding to security events in your AWS environment. When the AWS Security Incident Response service identiﬁes a security alert or you request security assistance, the AWS CIRT investigates. The team collects log events and service data such as GuardDuty alerts, triages and analyzes that data, performs remediation and containment activities, and provides post-incident reporting. Contents • Prepare • Detect and Analyze • Contain • Eradicate • Recover • Post incident report Prepare The AWS Security Incident Response team investigates and partners with you throughout the security event response lifecycle. It is recommended that you set up this team and assign the necessary permissions before a security event occurs. Detect and Analyze AWS Security Incident Response monitors, triages, investigates security ﬁndings from Amazon GuardDuty and integrations through AWS Security Hub. Additional actions that can signiﬁcantly enhance the scope and eﬀectiveness of AWS Security Incident Response's monitoring and investigation capabilities include: Enabling supported sources of detection Prepare Version December 1, 2024 12 AWS Security Incident Response User Guide Note AWS Security Incident Response service costs do not include usage and other costs and fees associated with supported sources of detection or use of other AWS services. Please refer to individual feature or service pages for cost details. Amazon GuardDuty GuardDuty is a threat detection service that continuously monitors, analyzes, and processes data sources and logs in your AWS environment. Enabling GuardDuty is not required to use AWS Security Incident Response; however, to use the proactive response and alert triaging feature Amazon GuardDuty must be enabled. To enable GuardDuty across your organization, please see the Setting up GuardDuty section of the Amazon GuardDuty User Guide. We highly recommend that you enable GuardDuty in all supported AWS Regions. This enables GuardDuty to generate ﬁndings about unauthorized or unusual activity even in regions that you are not actively using. For more information, reference Amazon GuardDuty Regions and endpoints Enabling GuardDuty provides AWS Security Incident Response access to critical threat detection data, enhancing its ability to identify and respond to potential security issues in your AWS environment. AWS Security Hub Security Hub can ingest security ﬁndings from several AWS services and supported third-party security solutions. These integrations can help AWS Security Incident Response monitor and investigate ﬁndings coming from other detection tools. To enable Security Hub with Organizations integration please refer to the AWS Security Hub User Guide. There are multiple ways of enabling integrations on Security Hub. For third-party product integrations, you may need to purchase the integration from the AWS Marketplace, and then conﬁgure the integration. The integration information provides links to complete these tasks. Learn more about how to enable AWS Security Hub integrations. AWS Security Incident Response can monitor and investigate ﬁndings from the following tools when they're integrated with AWS Security Hub: Detect and Analyze Version December 1, 2024 13 AWS Security Incident Response User Guide • CrowdStrike – CrowdStrike Falcon • Lacework – Lacework • Trend Micro – Cloud One By enabling these integrations, you can signiﬁcantly enhance the scope and eﬀectiveness of AWS Security Incident Response's monitoring and investigation capabilities. Analyzing ﬁndings. AWS Security Incident Response automations and AWS CIRT service team will analyze all ﬁndings from the supported tools. We will start learning about your environment by communicating with you using AWS Support Cases. For example, when we need to understand whether a ﬁnding is expected behavior or should be escalated to an incident. As we learn more from your
sir-ug-007	sir-ug.pdf	7	Response User Guide • CrowdStrike – CrowdStrike Falcon • Lacework – Lacework • Trend Micro – Cloud One By enabling these integrations, you can signiﬁcantly enhance the scope and eﬀectiveness of AWS Security Incident Response's monitoring and investigation capabilities. Analyzing ﬁndings. AWS Security Incident Response automations and AWS CIRT service team will analyze all ﬁndings from the supported tools. We will start learning about your environment by communicating with you using AWS Support Cases. For example, when we need to understand whether a ﬁnding is expected behavior or should be escalated to an incident. As we learn more from your environment, we will customize the service and to reduce the number of communications. Reporting an event. You can raise a security event through the AWS Security Incident Response service portal. It's important not to wait during a security event. AWS Security Incident Response uses automated and manual techniques to investigate security events, analyze logs, and look for anomalous patterns. Your partnership and understanding of your environment accelerates this analysis. Communicate. AWS Security Incident Response keeps you informed during the investigation by engaging your security contacts through the event case. Multiple teammates may support your event, all using the event ticket for customer-provided content and AWS updates. Communication may include automated notiﬁcations when a security alert is generated; communication during event analysis; establishing call bridges; the ongoing analysis of artifacts such as log ﬁles; and getting investigation results to you during the security event. The service will create AWS Security Incident Response cases to communicate with your teams. We will create cases against your membership account. This approach centralizes communication from all your accounts into a single place. The "[Proactive case]" preﬁx helps identify cases initiated by AWS Security Incident Response. By engaging actively with these communications and providing timely responses, you can help the AWS Security Incident Response service to: Detect and Analyze Version December 1, 2024 14 AWS Security Incident Response User Guide • Better understand your environment and expected behaviors. • Reduce false positives over time. • Improve the accuracy and relevance of alerts. • Ensure rapid response to genuine security incidents. • Remember, the eﬀectiveness of the AWS Security Incident Response service improves with your collaboration, leading to a more secure and eﬃciently monitored AWS environment. Contain AWS Security Incident Response partners with you to contain events. You can conﬁgure a service role for AWS Security Incident Response to take automated and manual actions in your account as a response to alerts. You can also perform containment yourself or in partnership with your third party relationships by using SSM documents. An essential part of containment is decision-making; such as whether to shut down a system, isolate a resource from the network, turn oﬀ access, or end sessions. These decisions are made easier when there are predetermined strategies and procedures to contain the event. AWS Security Incident Response provides the containment strategy, informs you of potential impact, and guides you on impementing the solution only after you have considered and agreed to the risks involved. AWS Security Incident Response executes supported containment actions on your behalf to expedite response and reduce the time a threat actor has to potentially cause damage in your environment. This capability allows for faster mitigation of identiﬁed threats, minimizing potential impact and enhancing your overall security posture. There are diﬀerent containment options depending on the resources under analysis. The supported containment actions are: • EC2 Containment: The AWSSupport-ContainEC2Instance containment automation performs a reversible network containment of an EC2 instance, leaving the instance intact and running, but isolating it from any new network activity and preventing it from communicating with resources within and outside your VPC. Important It is important to note that existing tracked connections won’t be shut down as a result of changing security groups – only future traﬃc will be eﬀectively blocked by the new security group and this SSM document. More information is available in the source containment section of the service technical guide. Contain Version December 1, 2024 15 AWS Security Incident Response User Guide • IAM Containment: The AWSSupport-ContainIAMPrincipal containment automation performs a reversible network containment of an IAM user or role, leaving the user or role in IAM, but isolating it from communicating with resources within your account. • S3 Containment: The AWSSupport-ContainS3Resource containment automation performs a reversible containment of a S3 bucket, leaving the objects in the bucket, and isolating the Amazon S3 bucket or object by modifying its access policies. Important AWS Security Incident Response does not enable containment capabilities by default, to execute these containment actions, you must ﬁrst grant the necessary permissions to the service using roles. You can create these roles individually per account or across your entire organization by Working with AWS CloudFormation stacksets, which create the required roles. AWS Security
sir-ug-008	sir-ug.pdf	8	IAM, but isolating it from communicating with resources within your account. • S3 Containment: The AWSSupport-ContainS3Resource containment automation performs a reversible containment of a S3 bucket, leaving the objects in the bucket, and isolating the Amazon S3 bucket or object by modifying its access policies. Important AWS Security Incident Response does not enable containment capabilities by default, to execute these containment actions, you must ﬁrst grant the necessary permissions to the service using roles. You can create these roles individually per account or across your entire organization by Working with AWS CloudFormation stacksets, which create the required roles. AWS Security Incident Response encourages you to consider containment strategies for each major event type that ﬁt within your risk appetite. Document clear criteria to help with decision-making during an event. Criteria to consider include: • Potential damage to resources • Preservation of evidence and regulatory requirements • Service unavailability (for example, network connectivity, services provided to external parties) • Time and resources needed to implement the strategy • Eﬀectiveness of the strategy (for example, partial vs. full containment) • Permanence of the solution (for example, reversible vs. irreversible) • Duration of the solution (for example, emergency workaround, temporary workaround, permanent solution) Apply security controls that can lower risk and allow time to deﬁne and implement a more eﬀective containment strategy. AWS Security Incident Response advises a staged approach to achieve eﬃcient and eﬀective containment, involving short-term and long-term strategies based on the resource type. • Containment strategy • Can AWS Security Incident Response identify the scope of the security event? Contain Version December 1, 2024 16 AWS Security Incident Response User Guide • If yes, identify all the resources (users, systems, resources). • If no, investigate in parallel with executing the next step on identiﬁed resources. • Can the resource be isolated? • If yes, then proceed to isolate the aﬀected resources. • If no, then work with system owners and managers to determine further actions necessary to contain the problem. • Are all aﬀected resources isolated from non-aﬀected resources? • If yes, then continue to the next step. • If no, then continue to isolate aﬀected resources to complete short-term containment and prevent the event from escalating further. • System backup • Were backup copies of aﬀected systems created for further analysis? • Are the forensic copies encrypted and stored in a secure location? • If yes, then continue to the next step. • If no, encrypt the forensic images, then store them in a secure location to prevent accidental usage, damage, and tampering. Eradicate During the eradication phase, it is important to identify and address all aﬀected accounts, resources, and instances - such as by deleting malware, removing compromised user accounts, and mitigating any discovered vulnerabilities - to apply uniform remediation across the environment. It is a best practice to use a phased approach to eradication and recovery, and to prioritize remediation steps. The purpose of the early phases is to increase the overall security quickly (days to weeks) with high-value changes to prevent future events. The later phases can focus on longer- term changes (for example, infrastructure changes), and ongoing work to keep the enterprise as secure as possible. Each case is unique and AWS CIRT will work with you to assess necessary actions. Consider the following: • Can you re-image the system and harden it with patches or other countermeasures to prevent or reduce the risk of attacks? Eradicate Version December 1, 2024 17 AWS Security Incident Response User Guide • Can you replace the infected system with a new instance or resource, enabling a clean baseline while terminating the infected item? • Have you removed all malware and other artifacts left behind by the unauthorized use, and hardened the aﬀected systems against further attacks? • Is there a requirement for forensics on the impacted resources? Recover AWS Security Incident Response provides you guidance to help restore systems to normal operation, conﬁrm they are functioning properly, and remediate any vulnerabilities to prevent similar events in the future. AWS Security Incident Response does not directly help with recovery of systems. Key considerations include: • Are the aﬀected systems patched and hardened against the recent attack? • What is the feasible timeline to restore the systems to production? • What tools will you use to test, monitor, and verify the restored systems? Post incident report AWS Security Incident Response provides a summary of the event after the conclusion of security activities between your team and ours. At the end of each month, the AWS Security Incident Response service will send monthly reports to the primary point of contact for each customer via email. The reports will be delivered in a PDF format using the metrics described below. Customers will receive one report per AWS Organizations. Case metrics • Cases
sir-ug-009	sir-ug.pdf	9	the feasible timeline to restore the systems to production? • What tools will you use to test, monitor, and verify the restored systems? Post incident report AWS Security Incident Response provides a summary of the event after the conclusion of security activities between your team and ours. At the end of each month, the AWS Security Incident Response service will send monthly reports to the primary point of contact for each customer via email. The reports will be delivered in a PDF format using the metrics described below. Customers will receive one report per AWS Organizations. Case metrics • Cases created • Dimension name: Type • Dimension values: AWS supported, self supported • Unit: Count • Description: The number of cases created. • Cases closed • Dimension name: Type Recover Version December 1, 2024 18 AWS Security Incident Response User Guide • Dimension values: AWS supported, self-managed • Unit: Count • Description: A measure of the total number of cases closed. • Opened cases • Dimension name: Type • Dimension values: AWS supported, self supported • Unit: Count • Description: The number of open cases. Triaging metrics • Findings received • Unit: Count • Description: The number of ﬁndings sent to triaging. • Findings archived • Unit: Count • Description: The number of ﬁndings archived after processed without manual investigation. • Findings Manually investigated • Unit: Count • Description: The number of ﬁndings with manual investigation performed. • Investigations archived • Unit: Count • Description: The number of manual investigations resulting in false positive and sent for archiving • Investigations escalated • Unit: Count • Description: The number of manual investigations resulting in a security incident Cases AWS Security Incident Response allows you to create two types of cases - AWS supported or self- managed cases. Cases Version December 1, 2024 19 AWS Security Incident Response User Guide Create an AWS supported case You can create an AWS supported case for AWS Security Incident Response through the Console, the API, or the AWS Command Line Interface. AWS supported cases allow you to receive support from the AWS Customer Incident Response Team (CIRT). Note AWS CIRT will respond to your case within 15 minutes. Response time is for a ﬁrst response from AWS CIRT. We will make every reasonable eﬀort to respond to your initial request within this time frame. This response time does not apply to subsequent responses. The following example covers use of the console. 1. Sign in to the AWS Management Console. Open the Security Incident Response console at https://console.aws.amazon.com/security-ir/. 2. Choose Create Case 3. Choose Resolve case with AWS 4. Select the type of request a. Active Security Incident: This type is for urgent incident response support and services. b. Investigations: Investigations allow you to get support for perceived security incidents where the AWS CIRT can support in log dive and secondary conﬁrmation of incident response investigation. 5. Set the start date estimate to the date of your earliest indicator of the incident. For example, when you experienced abnormal behavior for the ﬁrst time or when you received the ﬁrst related security alert. 6. Deﬁne a title for the case 7. Provide a detailed description of the case. Consider the following aspects which can help incident responders with the case resolution: a. What happened? b. Who discovered and reported the incident? c. Who is aﬀected by the case? d. What is the known impact? e. What is the urgency for this case? Create an AWS supported case Version December 1, 2024 20 AWS Security Incident Response User Guide f. Add one or multiple AWS account IDs that are in scope of the case. 8. Add optional case details: a. Select the main services that are impacted from the drop-down list. b. Select the main regions that are impacted from the drop-down list. c. Add one or many threat actor IP addresses that you identiﬁed as part of this case. 9. Add optional additional incident responders to the case that will receive notiﬁcations. To add an individual, do the following: a. Add an email address. b. Add an optional ﬁrst and last name. c. Choose Add new to add another individual. d. To remove an individual, choose the Remove option for an individual. e. Choose Add to add all listed individuals to the case. i. You can select multiple individuals and choose Remove to delete them from the list. 10.Add optional tags to the case. a. To add a tag, do the following: b. Choose Add new tag. c. For Key, enter the name of the tag. d. For Value, enter the value of the tag. e. To remove a tag, choose the Remove option for that tag. After a AWS supported case has been created, the AWS CIRT and your incident response team are immediately notiﬁed. Create
sir-ug-010	sir-ug.pdf	10	Remove option for an individual. e. Choose Add to add all listed individuals to the case. i. You can select multiple individuals and choose Remove to delete them from the list. 10.Add optional tags to the case. a. To add a tag, do the following: b. Choose Add new tag. c. For Key, enter the name of the tag. d. For Value, enter the value of the tag. e. To remove a tag, choose the Remove option for that tag. After a AWS supported case has been created, the AWS CIRT and your incident response team are immediately notiﬁed. Create a self-managed case You can create a self-managed for AWS Security Incident Response through the Console, API, or AWS Command Line Interface. This type of case DOES NOT engage the AWS CIRT. The following example covers use of the console. 1. Sign in to the AWS Management Console. Open the Security Incident Response console at https://console.aws.amazon.com/security-ir/. 2. Choose Create Case. 3. Choose Resolve case with my own incident response team. Create a self-managed case Version December 1, 2024 21 AWS Security Incident Response User Guide 4. Set the start date estimate to the date of your earliest indicator of the incident. For example, when you experienced abnormal behavior for the ﬁrst time or when you received the ﬁrst related security alert. 5. Deﬁne a title for the case. It is recommended to include the data into the case title as suggested when selecting the Generate Title option. 6. Enter AWS account IDs that are part of the case. To add an account ID, do the following: a. Enter the 12-digit account ID and choose Add account. b. To remove an account, choose Remove next to the account you want to remove from the case. 7. Provide a detailed description of the case. a. Consider the following aspects which can help incident responders with the case resolution: i. What happened? ii. Who discovered and reported the incident? iii. Who is aﬀected by the case? iv. What is the known impact? v. What is the urgency for this case? 8. Add optional case details: a. Select the main services that are impacted from the drop-down list. b. Select the main regions that are impacted from the drop-down list. c. Add one or many threat actor IP addresses that you identiﬁed as part of this case. 9. Add optional additional incident responders to the case that will receive notiﬁcations. To add an individual, do the following: a. Add an email address. b. Add an optional ﬁrst and last name. c. Choose Add new to add another individual. d. To remove an individual, choose the Remove option for an individual. e. Choose Add to add all listed individuals to the case. You can select multiple individuals and choose Remove to delete them from the list. 10.Add optional tags to the case. To add a tag, do the following: a. Choose Add new tag. b. For Key, enter the name of the tag. c. For Value, enter the value of the tag. Create a self-managed case Version December 1, 2024 22 AWS Security Incident Response User Guide d. To remove a tag, choose the Remove option for that tag. The incident response team will be notiﬁed by e-mail after the case is created. Responding to an AWS generated case AWS Security Incident Response may create an outbound notiﬁcation or case when you need to act on or be aware of something that might impact your account or resources. This will only occur if you have enabled the proactive response and alert triaging workﬂows as part of your subscription. These notiﬁcations will appear as Security Incident Response cases with the preﬁx "[Proactive case]" in the AWS Security Incident Response console. To view and manage these cases: • Open the Security Incident Response console at https://console.aws.amazon.com/security-ir/ • Click "Cases" in the menu. • You should be able to see all the cases, including those with the "[Proactive case]" preﬁx. These cases allow you to update, resolve, and reopen them as needed. You can communicate directly with the AWS Security Incident Response team through these cases, ensuring eﬃcient handling of potential security issues. Managing Cases Contents • Changing the case status • Changing the resolver • Action Items • Edit a case • Communications • Permissions • Attachments • Tags • Case activities • Closing a case Responding to an AWS generated case Version December 1, 2024 23 AWS Security Incident Response User Guide Changing the case status A case will be in one of the following states: • Submitted: This is the initial status of a case. Cases in this status have been submitted by a requested, but are not yet being worked on. • Detection and Analysis: This status indicates an incident responder has started work
sir-ug-011	sir-ug.pdf	11	the case status • Changing the resolver • Action Items • Edit a case • Communications • Permissions • Attachments • Tags • Case activities • Closing a case Responding to an AWS generated case Version December 1, 2024 23 AWS Security Incident Response User Guide Changing the case status A case will be in one of the following states: • Submitted: This is the initial status of a case. Cases in this status have been submitted by a requested, but are not yet being worked on. • Detection and Analysis: This status indicates an incident responder has started work on the case. This phase includes data gathering, triaging the event, and performing analysis to create data driven conclusions. • Containment, Eradication and Recovery: In this status the incident responder has identiﬁed suspicious activity that requires additional eﬀort to remove. The incident responder will provide recommendations to you for business risk analysis and additional actions. If you have enabled the opt-in features for the service, then an AWS incident responder will seek your consent to perform containment actions with SSM documents in the impacted account(s). • Post-incident activities: In this status the primary security event has been contained. The focus now is to recover and return business operations to normal. A summary and root cause analysis is provided if the resolver for the case is AWS-supported. • Closed: This is the ﬁnal status of the workﬂow. Cases in a closed status indicate work has been completed. Closed cases cannot be reopened, so ensure all actions are complete before transitioning to this status. Choose Action/Update Status to change the status of the case for self-managed cases. For AWS supported cases, the status is set by the AWS CIRT responder. Changing the resolver For self-managed cases, your incident response team can request help from AWS. Choose Get help from AWS to change the resolver for this case to AWS. Once the case is updated to AWS supported, the status is changed to Submitted. The existing case history will be available to AWS CIRT. Once you have requested help from AWS you will not be able to change it back to self-managed. Action Items An AWS CIRT responder working on the case may request actions from your internal team. Action items that appear after a case has been created include: • Request to provide permissions for an incident responder to access a case Changing the case status Version December 1, 2024 24 AWS Security Incident Response User Guide • Request to provide more information about the case Action item when a customer action is pending: • Request to act on a new comment to proceed the case Action items when a case is ready to close: • Request to review the case report • Request to close the case Edit a case Choose Edit to change the details of a case. For AWS supported and self-managed cases: You can change the following case details after a case has been created: • Title • Description For AWS supported cases only: You can change the additional ﬁelds: • Request type: • Active Security Incident: This type is for urgent incident response support and services. • Investigations: Investigations allow you to get support for perceived security incidents where the AWS CIRT can support in log dive and secondary conﬁrmation of the security event. • Start date estimate: Change this ﬁeld if you received indicators for this case that pre-date the initial provided start date. Consider providing additional details in regards to the newly detected indicator in the description ﬁeld or add a comment in the communications tab. Edit a case Version December 1, 2024 25 AWS Security Incident Response User Guide Communications AWS CIRT can add comments to document their activities when working on a case. Diﬀerent AWS CIRT responders can work on a case at the same time. They are represented as AWS Responder within the communication log. Permissions The permissions tab lists all individuals that will be notiﬁed for any change to the case. You can add and remove individuals from the list until the case is closed. Note Individual cases allow you to include up to 30 total stakeholders. Additional permission conﬁguration is required to grant case-level access to these stakeholders. Provide access to a case in the console To provide access to the case in the AWS Management Console, you can copy the IAM permission policy template and add this permission to a user or role. Adding the IAM policy to a user or a role: 1. Copy the IAM permission policy. 2. Open IAM in the via https://console.aws.amazon.com/iam/. 3. In the navigation pane, choose User or Roles. 4. Select a user or role to open the details page. 5. In the permissions tab, choose Add permissions. 6. Choose Attach policy. 7.
sir-ug-012	sir-ug.pdf	12	required to grant case-level access to these stakeholders. Provide access to a case in the console To provide access to the case in the AWS Management Console, you can copy the IAM permission policy template and add this permission to a user or role. Adding the IAM policy to a user or a role: 1. Copy the IAM permission policy. 2. Open IAM in the via https://console.aws.amazon.com/iam/. 3. In the navigation pane, choose User or Roles. 4. Select a user or role to open the details page. 5. In the permissions tab, choose Add permissions. 6. Choose Attach policy. 7. Select the appropriate AWS Security Incident Response managed policy. 8. Choose Add policy. Attachments Your incident responders can add attachments to a case that help other incident responders with their investigation for self-managed cases. Communications Version December 1, 2024 26 AWS Security Incident Response User Guide Note If you choose an AWS supported case, AWS cannot view attachments. All details for AWS supported cases must be shared via case comments or through you providing a screenshare using your preferred communications technology. Choose Upload to select a ﬁle from your computer to be added to the case. Note Any uploaded attachments are deleted seven days after a case has been Closed. Tags A tag is an optional label that you can assign to your cases to hold metadata about that resource. Each tag is a label consisting of a key and an optional value. You can use tags to search, allocate costs, and authenticate permissions for the resource. To add a tag, do the following: 1. Choose Add new tag. 2. For Key, enter the name of the tag. 3. For Value, enter the value of the tag. To remove a tag, choose the Remove option for that tag. Case activities Audit trails provide detailed chronological records of all case activities. They provide important information in post-event activities and help to identify potential improvements. The time, user, action, and details of any case change are logged in the case audit trail. Closing a case For AWS supported cases, choose Close Case on the case details page to permanently close the case at any status. A case typically reaches the status Ready to Close before it is permanently Tags Version December 1, 2024 27 AWS Security Incident Response User Guide closed. If you close a case prematurely at any other status than Ready to Close, you are requesting that AWS CIRT will stop working on this AWS supported case. If your incident response team is the responder, select Action/Close Case on the case details page. Note The "Ready to Close" status signiﬁes that a case can be permanently closed and that there is no additional work to be done on a case. A case cannot be re-opened again after it has been permanently closed. All information will be available read-only. To prevent accidental closure, you will be asked to conﬁrm that you want to close the case. Working with AWS CloudFormation stacksets Important AWS Security Incident Response does not enable containment capabilities by default, to execute these containment actions, you must ﬁrst grant the necessary permissions to the service using roles. You can create these roles individually per account or across your entire organization by deploying AWS CloudFormation StackSets, which create the required roles. You can ﬁnd speciﬁc instructions on how to Create a stack set with service-managed permissions. Following are template stacksets to create the AWSSecurityIncidentResponseContainment and AWSSecurityIncidentResponseContainmentExecution roles. AWSTemplateFormatVersion: '2010-09-09' Description: 'Template for AWS Security Incident Response containment roles' Resources: AWSSecurityIncidentResponseContainment: Type: 'AWS::IAM::Role' Properties: RoleName: AWSSecurityIncidentResponseContainment AssumeRolePolicyDocument: { Working with AWS CloudFormation stacksets Version December 1, 2024 28 AWS Security Incident Response User Guide 'Version': '2012-10-17', 'Statement': [ { 'Effect': 'Allow', 'Principal': { 'Service': 'containment.security-ir.amazonaws.com' }, 'Action': 'sts:AssumeRole', 'Condition': { 'StringEquals': { 'sts:ExternalId': !Sub '${AWS::AccountId}' } }, }, { 'Effect': 'Allow', 'Principal': { 'Service': 'containment.security-ir.amazonaws.com' }, 'Action': 'sts:TagSession', }, ], } Policies: - PolicyName: AWSSecurityIncidentResponseContainmentPolicy PolicyDocument: { 'Version': '2012-10-17', 'Statement': [ { 'Effect': 'Allow', 'Action': ['ssm:StartAutomationExecution'], 'Resource': [ !Sub 'arn:${AWS::Partition}:ssm:::automation-definition/ AWSSupport-ContainEC2Instance:$DEFAULT', !Sub 'arn:${AWS::Partition}:ssm:::automation-definition/ AWSSupport-ContainS3Resource:$DEFAULT', !Sub 'arn:${AWS::Partition}:ssm:::automation-definition/ AWSSupport-ContainIAMPrincipal:$DEFAULT', ], }, { 'Effect': 'Allow', 'Action': ['ssm:DescribeInstanceInformation', 'ssm:GetAutomationExecution', 'ssm:ListCommandInvocations'], 'Resource': '*', }, Working with AWS CloudFormation stacksets Version December 1, 2024 29 AWS Security Incident Response User Guide { 'Effect': 'Allow', 'Action': ['iam:PassRole'], 'Resource': !GetAtt AWSSecurityIncidentResponseContainmentExecution.Arn, 'Condition': { 'StringEquals': { 'iam:PassedToService': 'ssm.amazonaws.com' } }, }, ], } AWSSecurityIncidentResponseContainmentExecution: Type: 'AWS::IAM::Role' Properties: RoleName: AWSSecurityIncidentResponseContainmentExecution AssumeRolePolicyDocument: { 'Version': '2012-10-17', 'Statement': [{ 'Effect': 'Allow', 'Principal': { 'Service': 'ssm.amazonaws.com' }, 'Action': 'sts:AssumeRole' }], } ManagedPolicyArns: - !Sub arn:${AWS::Partition}:iam::aws:policy/SecurityAudit Policies: - PolicyName: AWSSecurityIncidentResponseContainmentExecutionPolicy PolicyDocument: { 'Version': '2012-10-17', 'Statement': [ { 'Sid': 'AllowIAMContainment', 'Effect': 'Allow', 'Action': [ 'iam:AttachRolePolicy', 'iam:AttachUserPolicy', 'iam:DeactivateMFADevice', 'iam:DeleteLoginProfile', 'iam:DeleteRolePolicy', 'iam:DeleteUserPolicy', 'iam:GetLoginProfile', 'iam:GetPolicy', 'iam:GetRole', Working with AWS CloudFormation stacksets Version December 1, 2024 30 AWS Security Incident Response User Guide 'iam:GetRolePolicy', 'iam:GetUser', 'iam:GetUserPolicy', 'iam:ListAccessKeys', 'iam:ListAttachedRolePolicies', 'iam:ListAttachedUserPolicies', 'iam:ListMfaDevices',
sir-ug-013	sir-ug.pdf	13	Security Incident Response User Guide { 'Effect': 'Allow', 'Action': ['iam:PassRole'], 'Resource': !GetAtt AWSSecurityIncidentResponseContainmentExecution.Arn, 'Condition': { 'StringEquals': { 'iam:PassedToService': 'ssm.amazonaws.com' } }, }, ], } AWSSecurityIncidentResponseContainmentExecution: Type: 'AWS::IAM::Role' Properties: RoleName: AWSSecurityIncidentResponseContainmentExecution AssumeRolePolicyDocument: { 'Version': '2012-10-17', 'Statement': [{ 'Effect': 'Allow', 'Principal': { 'Service': 'ssm.amazonaws.com' }, 'Action': 'sts:AssumeRole' }], } ManagedPolicyArns: - !Sub arn:${AWS::Partition}:iam::aws:policy/SecurityAudit Policies: - PolicyName: AWSSecurityIncidentResponseContainmentExecutionPolicy PolicyDocument: { 'Version': '2012-10-17', 'Statement': [ { 'Sid': 'AllowIAMContainment', 'Effect': 'Allow', 'Action': [ 'iam:AttachRolePolicy', 'iam:AttachUserPolicy', 'iam:DeactivateMFADevice', 'iam:DeleteLoginProfile', 'iam:DeleteRolePolicy', 'iam:DeleteUserPolicy', 'iam:GetLoginProfile', 'iam:GetPolicy', 'iam:GetRole', Working with AWS CloudFormation stacksets Version December 1, 2024 30 AWS Security Incident Response User Guide 'iam:GetRolePolicy', 'iam:GetUser', 'iam:GetUserPolicy', 'iam:ListAccessKeys', 'iam:ListAttachedRolePolicies', 'iam:ListAttachedUserPolicies', 'iam:ListMfaDevices', 'iam:ListPolicies', 'iam:ListRolePolicies', 'iam:ListUserPolicies', 'iam:ListVirtualMFADevices', 'iam:PutRolePolicy', 'iam:PutUserPolicy', 'iam:TagMFADevice', 'iam:TagPolicy', 'iam:TagRole', 'iam:TagUser', 'iam:UntagMFADevice', 'iam:UntagPolicy', 'iam:UntagRole', 'iam:UntagUser', 'iam:UpdateAccessKey', 'identitystore:CreateGroupMembership', 'identitystore:DeleteGroupMembership', 'identitystore:IsMemberInGroups', 'identitystore:ListUsers', 'identitystore:ListGroups', 'identitystore:ListGroupMemberships', ], 'Resource': '', }, { 'Sid': 'AllowOrgListAccounts', 'Effect': 'Allow', 'Action': 'organizations:ListAccounts', 'Resource': '', }, { 'Sid': 'AllowSSOContainment', 'Effect': 'Allow', 'Action': [ 'sso:CreateAccountAssignment', 'sso:DeleteAccountAssignment', Working with AWS CloudFormation stacksets Version December 1, 2024 31 AWS Security Incident Response User Guide 'sso:DeleteInlinePolicyFromPermissionSet', 'sso:GetInlinePolicyForPermissionSet', 'sso:ListAccountAssignments', 'sso:ListInstances', 'sso:ListPermissionSets', 'sso:ListPermissionSetsProvisionedToAccount', 'sso:PutInlinePolicyToPermissionSet', 'sso:TagResource', 'sso:UntagResource', ], 'Resource': '', }, { 'Sid': 'AllowSSORead', 'Effect': 'Allow', 'Action': ['sso-directory:SearchUsers', 'sso- directory:DescribeUser'], 'Resource': '', }, { 'Sid': 'AllowS3Read', 'Effect': 'Allow', 'Action': [ 's3:GetAccountPublicAccessBlock', 's3:GetBucketAcl', 's3:GetBucketLocation', 's3:GetBucketOwnershipControls', 's3:GetBucketPolicy', 's3:GetBucketPolicyStatus', 's3:GetBucketPublicAccessBlock', 's3:GetBucketTagging', 's3:GetEncryptionConfiguration', 's3:GetObject', 's3:GetObjectAcl', 's3:GetObjectTagging', 's3:GetReplicationConfiguration', 's3:ListBucket', 's3express:GetBucketPolicy', ], 'Resource': '', }, { 'Sid': 'AllowS3Write', Working with AWS CloudFormation stacksets Version December 1, 2024 32 AWS Security Incident Response User Guide 'Effect': 'Allow', 'Action': [ 's3:CreateBucket', 's3:DeleteBucketPolicy', 's3:DeleteObjectTagging', 's3:PutAccountPublicAccessBlock', 's3:PutBucketACL', 's3:PutBucketOwnershipControls', 's3:PutBucketPolicy', 's3:PutBucketPublicAccessBlock', 's3:PutBucketTagging', 's3:PutBucketVersioning', 's3:PutObject', 's3:PutObjectAcl', 's3express:CreateSession', 's3express:DeleteBucketPolicy', 's3express:PutBucketPolicy', ], 'Resource': '', }, { 'Sid': 'AllowAutoScalingWrite', 'Effect': 'Allow', 'Action': [ 'autoscaling:CreateOrUpdateTags', 'autoscaling:DeleteTags', 'autoscaling:DescribeAutoScalingGroups', 'autoscaling:DescribeAutoScalingInstances', 'autoscaling:DescribeTags', 'autoscaling:EnterStandby', 'autoscaling:ExitStandby', 'autoscaling:UpdateAutoScalingGroup', ], 'Resource': '', }, { 'Sid': 'AllowEC2Containment', 'Effect': 'Allow', 'Action': [ 'ec2:AuthorizeSecurityGroupEgress', 'ec2:AuthorizeSecurityGroupIngress', Working with AWS CloudFormation stacksets Version December 1, 2024 33 AWS Security Incident Response User Guide 'ec2:CopyImage', 'ec2:CreateImage', 'ec2:CreateSecurityGroup', 'ec2:CreateSnapshot', 'ec2:CreateTags', 'ec2:DeleteSecurityGroup', 'ec2:DeleteTags', 'ec2:DescribeImages', 'ec2:DescribeInstances', 'ec2:DescribeSecurityGroups', 'ec2:DescribeSnapshots', 'ec2:DescribeTags', 'ec2:ModifyNetworkInterfaceAttribute', 'ec2:RevokeSecurityGroupEgress', ], 'Resource': '', }, { 'Sid': 'AllowKMSActions', 'Effect': 'Allow', 'Action': [ 'kms:CreateGrant', 'kms:DescribeKey', 'kms:GenerateDataKeyWithoutPlaintext', 'kms:ReEncryptFrom', 'kms:ReEncryptTo', ], 'Resource': '', }, { 'Sid': 'AllowSSMActions', 'Effect': 'Allow', 'Action': ['ssm:DescribeAutomationExecutions'], 'Resource': '', }, ], } Working with AWS CloudFormation stacksets Version December 1, 2024 34 AWS Security Incident Response User Guide Cancel Membership A role having the CancelMembership permission for AWS Security Incident Response can cancel the membership from the console, the API, or AWS Command Line Interface. Important Once a membership has been canceled, you will be unable to view historic case data. If you cancel during the month, your membership will be available until the end of the month. Any resources or investigations that are Active or ready to close will be terminated upon ﬁnal membership cancellation at the end of the billing cycle. Important AWS Security Incident Response does not follow standard anniversary billing cycle that happens every month. Service billing runs month to month. Some examples: • Dec 29, Jan 29 • Jan 29, Feb 26 (Non leap year) • Feb 26, March 29 Important If you resubscribe to the service, a new membership will be created and the case resources that lived under the prior membership are only accessible if you downloaded them prior to cancellation. After the membership has been canceled, everyone in the membership incident response team are notiﬁed by email. Cancel Membership Version December 1, 2024 35 AWS Security Incident Response User Guide Important If you created a membership using a delegated administrator account and you use the AWS Organizations API to remove the delegated administrator designation from the account, the membership will be terminated immediately. Cancel Membership Version December 1, 2024 36 AWS Security Incident Response User Guide Tagging AWS Security Incident Response resources A tag is a metadata label that you assign or that AWS assigns to an AWS resource. Each tag consists of a key and a value. For tags that you assign, you deﬁne the key and value. For example, you might deﬁne the key as stage and the value for one resource as test. Tags help you do the following: • Identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from diﬀerent services to indicate that the resources are related. • Track your AWS costs. You activate these tags on the AWS Billing dashboard. AWS uses the tags to categorize your costs and deliver a monthly cost allocation report to you. For more information, see Use cost allocation tags in the AWS Billing User Guide. • Control access to your AWS resources. For more information, see Controlling access using tags in the IAM User Guide. Refer to the AWS Security Incident Response API reference for tagging. Version December 1, 2024 37 AWS Security Incident Response User Guide Using AWS CloudShell to work with AWS Security Incident Response AWS CloudShell is a browser-based, pre-authenticated shell that you can launch
sir-ug-014	sir-ug.pdf	14	tags on the AWS Billing dashboard. AWS uses the tags to categorize your costs and deliver a monthly cost allocation report to you. For more information, see Use cost allocation tags in the AWS Billing User Guide. • Control access to your AWS resources. For more information, see Controlling access using tags in the IAM User Guide. Refer to the AWS Security Incident Response API reference for tagging. Version December 1, 2024 37 AWS Security Incident Response User Guide Using AWS CloudShell to work with AWS Security Incident Response AWS CloudShell is a browser-based, pre-authenticated shell that you can launch directly from the AWS Management Console. You can run AWS CLI commands against AWS services (including AWS Security Incident Response) using your preferred shell (Bash, PowerShell or Z shell). And you can do this without needing to download or install command line tools. You launch AWS CloudShell from the AWS Management Console, and the AWS credentials you used to sign in to the console are automatically available in a new shell session. This pre- authentication of AWS CloudShell users allows you to skip conﬁguring credentials when interacting with AWS services such as Security Incident Response using AWS CLI version 2 (pre-installed on the shell's compute environment). Contents • Obtaining IAM permissions for AWS CloudShell • Interacting with Security Incident Response using AWS CloudShell Obtaining IAM permissions for AWS CloudShell Using the access management resources provided by AWS Identity and Access Management, administrators can grant permissions to IAM users so they can access AWS CloudShell and use the environment's features. The quickest way for an administrator to grant access to users is through an AWS managed policy. An AWS managed policy is a standalone policy that's created and administered by AWS. The following AWS managed policy for CloudShell can be attached to IAM identities: • AWSCloudShellFullAccess: Grants permission to use AWS CloudShell with full access to all features. If you want to limit the scope of actions that an IAM user can perform with AWS CloudShell, you can create a custom policy that uses the AWSCloudShellFullAccess managed policy as a template. For more information about limiting the actions that are available to users in CloudShell, see Managing AWS CloudShell access and usage with IAM policies in the AWS CloudShell User Guide. Obtaining IAM permissions for AWS CloudShell Version December 1, 2024 38 AWS Security Incident Response User Guide Note Your IAM identity also requires a policy that grants permission to make calls to Security Incident Response. Interacting with Security Incident Response using AWS CloudShell After you launch AWS CloudShell from the AWS Management Console, you can immediately start to interact with Security Incident Response using the command line interface. Note When using AWS CLI in AWS CloudShell, you don't need to download or install any additional resources. Moreover, because you're already authenticated within the shell, you don't need to conﬁgure credentials before making calls. Working with AWS CloudShell and Security Incident Response • From the AWS Management Console, you can launch CloudShell by choosing the following options available on the navigation bar: • Choose the CloudShell icon. • Start typing "cloudshell" in Search box and then choose the CloudShell option. Interacting with Security Incident Response using AWS CloudShell Version December 1, 2024 39 AWS Security Incident Response User Guide Logging AWS Security Incident Response API calls using AWS CloudTrail AWS Security Incident Response is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Security Incident Response. CloudTrail captures all API calls for Security Incident Response as events. The calls captured include calls from the Security Incident Response console and code calls to the Security Incident Response API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Incident Response. If you don't conﬁgure 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 Security Incident Response, 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. Security Incident Response information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Security Incident Response, 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 past 90 days, create a trail or a CloudTrail Lake event data
sir-ug-015	sir-ug.pdf	15	and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. Security Incident Response information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Security Incident Response, 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 past 90 days, create a trail or a CloudTrail Lake event data store. CloudTrail trails A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. All trails created using the AWS Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the AWS CLI. Creating a multi-Region trail is recommended because you capture activity in all AWS Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's AWS Region. For more information about trails, see Creating a trail for your AWS account and Creating a trail for an organization in the AWS CloudTrail User Guide. You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For Security Incident Response information in CloudTrail Version December 1, 2024 40 AWS Security Incident Response User Guide more information about CloudTrail pricing, see AWS CloudTrail Pricing. For information about Amazon S3 pricing, see Amazon S3 Pricing. CloudTrail Lake event data stores CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control which events persist and are available for you to query. For more information about CloudTrail Lake, see Working with AWS CloudTrail Lake in the AWS CloudTrail User Guide. CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the pricing option you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention period for the event data store. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. All Security Incident Response actions are logged by CloudTrail and are documented in the AWS Security Incident Response API Reference. For example, calls to the CreateMembership, CreateCase and UpdateCase actions generate entries in the CloudTrail log ﬁles. 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 AWS Identity and Access Management (IAM) 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 Security Incident Response log ﬁle entries A trail is a conﬁguration that enables delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles 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 Understanding Security Incident Response log ﬁle entries Version December 1, 2024 41 AWS Security Incident Response User Guide the action, request parameters, and so on. CloudTrail log ﬁles aren't an ordered stack trace of the public API calls, so they don't appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the CreateCase action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "AROA00000000000000000:user", "arn": "arn:aws:sts::123412341234:assumed-role/Admin/user", "accountId": "123412341234", "accessKeyId": "**", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROA00000000000000000", "arn": "arn:aws:iam::123412341234:role/Admin", "accountId": "123412341234", "userName": "Admin" }, "attributes": { "creationDate": "2024-10-13T06:32:53Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-10-13T06:40:45Z", "eventSource": "security-ir.amazonaws.com", "eventName": "CreateCase", "awsRegion": "us-east-1", "sourceIPAddress": "1.2.3.4", "userAgent": "aws-cli/2.17.23 md/awscrt#0.20.11 ua/2.0 os/macos#23.6.0 md/ arch#x86_64 lang/python#3.11.9 md/pyimpl#CPython cfg/retry-mode#standard md/ installer#exe md/prompt#off md/command#security-ir.create-case", "requestParameters": { "impactedServices": [ "Amazon GuardDuty" ], "impactedAccounts": [], "clientToken": "testToken112345679", "resolverType": "Self", "description": "", "engagementType": "Investigation", Understanding Security Incident Response log ﬁle entries Version December 1, 2024 42 AWS Security Incident Response User Guide "watchers": [ { "email": "", "name": "", "jobTitle": "" } ], "membershipId": "m-r1abcdabcd", "title": "", "impactedAwsRegions": [ { "region": "ap-southeast-1" } ], "reportedIncidentStartDate": 1711553521, "threatActorIpAddresses": [ { "ipAddress": "**", "userAgent": "browser" } ] }, "responseElements": { "caseId": "0000000001" }, "requestID":
sir-ug-016	sir-ug.pdf	16	}, "eventTime": "2024-10-13T06:40:45Z", "eventSource": "security-ir.amazonaws.com", "eventName": "CreateCase", "awsRegion": "us-east-1", "sourceIPAddress": "1.2.3.4", "userAgent": "aws-cli/2.17.23 md/awscrt#0.20.11 ua/2.0 os/macos#23.6.0 md/ arch#x86_64 lang/python#3.11.9 md/pyimpl#CPython cfg/retry-mode#standard md/ installer#exe md/prompt#off md/command#security-ir.create-case", "requestParameters": { "impactedServices": [ "Amazon GuardDuty" ], "impactedAccounts": [], "clientToken": "testToken112345679", "resolverType": "Self", "description": "*", "engagementType": "Investigation", Understanding Security Incident Response log ﬁle entries Version December 1, 2024 42 AWS Security Incident Response User Guide "watchers": [ { "email": "", "name": "", "jobTitle": "" } ], "membershipId": "m-r1abcdabcd", "title": "", "impactedAwsRegions": [ { "region": "ap-southeast-1" } ], "reportedIncidentStartDate": 1711553521, "threatActorIpAddresses": [ { "ipAddress": "", "userAgent": "browser" } ] }, "responseElements": { "caseId": "0000000001" }, "requestID": "2db4b08d-94a9-457a-9474-5892e6c8191f", "eventID": "b3fa3990-db82-43be-b120-c81262cc2f19", "readOnly": false, "resources": [ { "accountId": "123412341234", "type": "AWS::SecurityResponder::Case", "ARN": "arn:aws:security-ir:us-east-1:123412341234:case/" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123412341234", "eventCategory": "Management" } Understanding Security Incident Response log ﬁle entries Version December 1, 2024 43 AWS Security Incident Response User Guide Managing AWS Security Incident Response accounts with AWS Organizations AWS Security Incident Response is integrated with AWS Organizations. The AWS Organizations management account for the organization can designate an account as the delegated administrator for AWS Security Incident Response. This action enables AWS Security Incident Response as a trusted service in AWS Organizations. For information about how these permissions are granted, see Using AWS Organizations with other AWS services. The following sections will walk you through various tasks that you may perform as a delegated Security Incident Response administrator account. Contents • Considerations and recommendations for using AWS Security Incident Response with AWS Organizations • Enabling trusted access for AWS Account Management • Permissions required to designate a delegated Security Incident Response administrator account • Designating a delegated administrator for AWS Security Incident Response • Adding members to AWS Security Incident Response • Removing members from AWS Security Incident Response Considerations and recommendations for using AWS Security Incident Response with AWS Organizations The following considerations and recommendations can help you understand how a delegated Security Incident Response administrator account operates in AWS Security Incident Response: A delegated Security Incident Response administrator account is regional. The delegated Security Incident Response administrator account and member accounts must be added through AWS Organizations. Delegated administrator account for AWS Security Incident Response. You may designate one member account as the delegated Security Incident Response administrator account. For example, if you designate a member account 111122223333 in Considerations and recommendations Version December 1, 2024 44 AWS Security Incident Response User Guide Europe (Ireland), you can't designate another member account 555555555555 in Canada (Central). It is required that you use the same account as delegated Security Incident Response administrator account in all other Regions. It is not recommended to set your organization's management as the delegated Security Incident Response administrator account. Your organization's management can be the delegated Security Incident Response administrator account. However, the AWS security best practices follow the principle of least privilege and doesn't recommend this conﬁguration. Removing a delegated Security Incident Response administrator account from a live subscription cancels the subscription immediately. If you remove a delegated Security Incident Response administrator account, AWS Security Incident Response removes all the member accounts associated with this delegated Security Incident Response administrator account. AWS Security Incident Response will not longer be enabled for all these member accounts. Enabling trusted access for AWS Account Management Enabling trusted access for AWS Security Incident Response allows the delegated administrator of the management account to modify the information and metadata (for example, primary or alternate contact details) speciﬁc to each member account in AWS Organizations. Use the following procedure to enable trusted access for AWS Security Incident Response in your organization. Minimum permissions To perform these tasks, you must meet the following requirements: • You can perform this only from the organization's management account. • Your organization must have all features enabled. Trusted access Version December 1, 2024 45 AWS Security Incident Response User Guide Console To enable trusted access for AWS Security Incident Response 1. Sign in to the AWS Organizations console. You must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization’s management account. 2. Choose Services in the navigation pane. 3. Choose AWS Security Incident Response in the list of services. 4. Choose Enable trusted access. 5. In the Enable trusted access for AWS Security Incident Response dialog box, type enable to conﬁrm it, and then choose Enable trusted access. API/CLI To enable trusted access for AWS Account Management After running the following command, you can use credentials from the organization's management account to call Account Management API operations that use the --accountId parameter to reference member accounts in an organization. • AWS CLI: enable-aws-service-access The following example enables trusted access for AWS Security Incident Response in the calling account's organization. $ aws organizations enable-aws-service-access \ --service-principal security- ir.amazonaws.com This
sir-ug-017	sir-ug.pdf	17	services. 4. Choose Enable trusted access. 5. In the Enable trusted access for AWS Security Incident Response dialog box, type enable to conﬁrm it, and then choose Enable trusted access. API/CLI To enable trusted access for AWS Account Management After running the following command, you can use credentials from the organization's management account to call Account Management API operations that use the --accountId parameter to reference member accounts in an organization. • AWS CLI: enable-aws-service-access The following example enables trusted access for AWS Security Incident Response in the calling account's organization. $ aws organizations enable-aws-service-access \ --service-principal security- ir.amazonaws.com This command produces no output if it's successful. Trusted access Version December 1, 2024 46 AWS Security Incident Response User Guide Permissions required to designate a delegated Security Incident Response administrator account You can chose to set up your AWS Security Incident Response membership using delegated administrator for AWS Organizations. For information about how these permissions are granted, see Using AWS Organizations with other AWS services. Note AWS Security Incident Response automatically enables the AWS Organizations trusted relationship when using the console for setup and management. If you use the CLI/SDK then you have to manually enable this by using the EnableAWSServiceAccess API to trust security-ir.amazonaws.com. As the AWS Organizations manager, before you designate the delegated Security Incident Response administrator account for your organization, verify that you can perform the following AWS Security Incident Response actions: security-ir:CreateMembership and security- ir:UpdateMembership. These actions allow you to designate the delegated Security Incident Response administrator account for your organization by using AWS Security Incident Response. You must also ensure that you are allowed to perform the AWS Organizations actions that help you retrieve information about your organization. To grant these permissions, include the following statement in an AWS Identity and Access Management (IAM) policy for your account: { "Sid": "PermissionsForSIRAdmin", "Effect": "Allow", "Action": [ "security-ir:CreateMembership", "security-ir:UpdateMembership", "organizations:EnableAWSServiceAccess", "organizations:RegisterDelegatedAdministrator", "organizations:ListDelegatedAdministrators", "organizations:ListAWSServiceAccessForOrganization", "organizations:DescribeOrganizationalUnit", "organizations:DescribeAccount", "organizations:DescribeOrganization", Permissions required to designate a delegated Security Incident Response administrator account Version December 1, 2024 47 AWS Security Incident Response User Guide "organizations:ListAccounts" ], "Resource": "*" } If you want to designate your AWS Organizations management account as the delegated Security Incident Response administrator account, your account will also need the IAM action: CreateServiceLinkedRole. Review Considerations and recommendations for using AWS Security Incident Response with AWS Organizations before you proceed to add the permissions. To continue with designating your AWS Organizations management account as the delegated Security Incident Response administrator account, add the following statement to the IAM policy and replace 111122223333 with the AWS account ID of your AWS Organizations management account: { "Sid": "PermissionsToEnableSecurityIncidentResponse" "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": "arn:aws:iam::111122223333:role/aws-service-role/security- ir.amazonaws.com/AWSServiceRoleForSecurityIncidentResponse", "Condition": { "StringLike": { "iam:AWSServiceName": "security-ir.amazonaws.com" } } } Designating a delegated administrator for AWS Security Incident Response This section provides steps to designate a delegated administrator in the AWS Security Incident Response organization. As a manager of the AWS organization, make sure that you read through the Considerations and recommendations on how a delegated Security Incident Response administrator account operates. Designating a delegated administrator AWS Security Incident Response Version December 1, 2024 48 AWS Security Incident Response User Guide Before proceeding, ensure that you have Permissions required to designate a delegated Security Incident Response administrator account. Choose a preferred access method to designate a delegated Security Incident Response administrator account for your organization. Only a management can perform this step. Console 1. Open the Security Incident Response console at https://console.aws.amazon.com/security- ir/ To sign in, use the management credentials for your AWS Organizations organization. 2. By using the AWS Region selector in the upper-right corner of the page, select the Region in which you want to designate the delegated Security Incident Response administrator account for your organization. 3. Follow the setup wizard to create your membership, including the delegated administrator account. API/CLI • Run CreateMembership using the credentials of the AWS account of the organization's management. • Alternatively, you can use AWS Command Line Interface to do this. The following AWS CLI command designates a delegated Security Incident Response administrator account. Following are the string options available for conﬁguring your membership: { "customerAccountId": "stringstring", "membershipName": "stringstring", "customerType": "Standalone", "organizationMetadata": { "organizationId": "string", "managementAccountId": "stringstring", "delegatedAdministrators": [ "stringstring" ] }, "membershipAccountsConfigurations": { "autoEnableAllAccounts": true, Designating a delegated administrator AWS Security Incident Response Version December 1, 2024 49 AWS Security Incident Response User Guide "organizationalUnits": [ "string" ] }, "incidentResponseTeam": [ { "name": "string", "jobTitle": "stringstring", "email": "stringstring" } ], "internalIdentifier": "string", "membershipId": "stringstring", "optInFeatures": [ { "featureName": "RuleForwarding", "isEnabled": true } ] } If AWS Security Incident Response is not enabled for your delegated Security Incident Response administrator account, it won't be able to take any action. If not already done so, make sure to enable AWS Security Incident Response for the newly designated delegated Security Incident
sir-ug-018	sir-ug.pdf	18	"stringstring" ] }, "membershipAccountsConfigurations": { "autoEnableAllAccounts": true, Designating a delegated administrator AWS Security Incident Response Version December 1, 2024 49 AWS Security Incident Response User Guide "organizationalUnits": [ "string" ] }, "incidentResponseTeam": [ { "name": "string", "jobTitle": "stringstring", "email": "stringstring" } ], "internalIdentifier": "string", "membershipId": "stringstring", "optInFeatures": [ { "featureName": "RuleForwarding", "isEnabled": true } ] } If AWS Security Incident Response is not enabled for your delegated Security Incident Response administrator account, it won't be able to take any action. If not already done so, make sure to enable AWS Security Incident Response for the newly designated delegated Security Incident Response administrator account. Adding members to AWS Security Incident Response There is a one to one relationship with AWS Organizations and your AWS Security Incident Response membership. As accounts are added (or removed) from your Organizations, this will be reﬂected in the covered accounts for your AWS Security Incident Response membership. To add an account to your membership, follow one of the options for Managing accounts in an organization with AWS Organizations. Removing members from AWS Security Incident Response To remove an account from your membership, follow the procedures for removing a member account from an organization. Adding members to AWS Security Incident Response Version December 1, 2024 50 AWS Security Incident Response User Guide Troubleshooting When you experience issues related to performing an action speciﬁc to AWS Security Incident Response, consult the topics in this section. An ERROR is a status of an operation denoting a fault in some or all of the operations. Alternatively, you receive warnings when an issue occurs but the task still completes. Contents • Issues • Errors • Support Issues Not sending requests from the correct context. All calls to AWS Security Incident Response APIs must originate from an IAM principal in the service delegated administrator or membership account. Ensure that you are operating from the correct IAM principal in the AWS account that is your organization's AWS Security Incident Response delegated administrator or membership account. Errors AccessDeniedException You do not have suﬃcient access to perform this action. Please work with your AWS administrator to ensure that you have permission to assume an IAM Role in your AWS Security Incident Response delegated administrator or membership account. Also check the role has a an IAM policy that permits the requested action. For more information see AWS Security Incident Response IAM. ConﬂictException The request causes an inconsistent state. Please check that any case attachment ﬁle names or default response team members that you have speciﬁed are unique. Also check that your AWS Security Incident Response service Issues Version December 1, 2024 51 AWS Security Incident Response User Guide membership has not already been conﬁgured. Open the Security Incident Response console at https://console.aws.amazon.com/security-ir/ and navigate to Membership Details. InternalServerException An unexpected error occurred during the processing of the request. Please try again in a few minutes. If the issue persists, raise a case with Support. ResourceNotFoundException The request references a resource that does not exist. One or more of the resources speciﬁed in your request does not exist. Please check that all given resource ARNs or IDs are correct. This applies to AWS Organizations IDs, account IDs, IAM roles, memberships, cases, response team members, cases, case responders, case attachments, and case comments. ThrottlingException The request was denied due to request throttling. Too many requests have been made by your IAM principal to that API function in a speciﬁed period. Wait a minute and try again. If the issue persists, please consider implementing an exponential backoﬀ and retry algorithm. ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. One or more of the data ﬁelds in your request did not meet validation and/or logical combination requirements. Please check that all resource ARNs complete, and that text values meet size and format constraints from the AWS Security Incident Response API Reference Guide. Also check that any value updates are permitted. For example, changing a case from AWS supported to self- managed is not possible. Support If you need additional assistance, contact Support Center for troubleshooting purposes. Please have the following information available: • The AWS Region that you used Support Version December 1, 2024 52 AWS Security Incident Response User Guide • The AWS account ID of the membership • Your source content, if applicable and available • Any other details about the problem that might assist with troubleshooting Support Version December 1, 2024 53 AWS Security Incident Response User Guide Security Contents • Data Protection in AWS Security Incident Response • Inter-network traﬃc privacy • Identity and Access Management • Troubleshooting AWS Security Incident Response identity and access • Using service roles • Using service-linked roles • AWS Managed Policies • Incident response • Compliance validation • Logging and monitoring in AWS Security Incident
sir-ug-019	sir-ug.pdf	19	AWS Security Incident Response User Guide • The AWS account ID of the membership • Your source content, if applicable and available • Any other details about the problem that might assist with troubleshooting Support Version December 1, 2024 53 AWS Security Incident Response User Guide Security Contents • Data Protection in AWS Security Incident Response • Inter-network traﬃc privacy • Identity and Access Management • Troubleshooting AWS Security Incident Response identity and access • Using service roles • Using service-linked roles • AWS Managed Policies • Incident response • Compliance validation • Logging and monitoring in AWS Security Incident Response • Resilience • Infrastructure security • Conﬁguration and vulnerability analysis • Cross-service confused deputy prevention Data Protection in AWS Security Incident Response Contents • Data encryption The AWS shared responsibility model applies to data protection for the AWS Security Incident Response service. As described in this model, AWS is responsible for protecting the infrastructure that runs the services oﬀered in 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 conﬁguration 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, AWS security best practices state that you should protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Data Protection in AWS Security Incident Response Version December 1, 2024 54 AWS Security Incident Response User Guide Access Management (IAM). This way, each user is given only the permissions necessary to fulﬁll 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. • Use AWS encryption solutions, along with all default security controls within AWS services. • FIPS 140-3 is currently not supported by the service. You should never put conﬁdential or sensitive information, such as your email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with AWS Support or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter tags or free-form text ﬁelds 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 Contents • Encryption at rest • Encryption in transit • Key management Encryption at rest Data is encrypted at rest using transparent server-side encryption. This helps reduce the operational burden and complexity involved in protecting sensitive data. With encryption at rest, you can build security-sensitive applications that meet encryption compliance and regulatory requirements. Encryption in transit Data gathered and accessed by AWS Security Incident Response is exclusively over a Transport Layer Security (TLS) protected channel. Data encryption Version December 1, 2024 55 AWS Security Incident Response User Guide Key management AWS Security Incident Response implements integrations with AWS KMS to provide encryption at rest for case and attachment data. AWS Security Incident Response does not support customer managed keys. Inter-network traﬃc privacy Traﬃc between service and on-premises clients and applications You have two connectivity options between your private network and AWS: • An AWS Site-to-Site VPN connection. For more information, see What is AWS Site-to-Site VPN? in the AWS Site-to-Site VPN User Guide. • An AWS Direct Connect connection. For more information, see What is AWS Direct Connect? in the AWS Direct Connect User Guide. Access to AWS Security Incident Response via the network is through AWS published APIs. Clients must support Transport Layer Security (TLS) 1.2. We recommend TLS 1.3. Clients must also support cipher suites with Perfect Forward Secrecy (PFS), such as Ephemeral Diﬃe-Hellman (DHE) or Elliptic Curve Diﬃe-Hellman Ephemeral (ECDHE). Most modern systems such as Java 7 and later support these modes. Additionally, you must sign requests using an access key ID and a secret access key that are associated with an IAM principal, or you can use the AWS Security Token Service (STS) to generate temporary security credentials to sign requests. Traﬃc between AWS resources in the same Region An Amazon Virtual Private Cloud (Amazon VPC) endpoint for AWS Security Incident Response is a logical entity within a VPC that allows connectivity only to AWS Security Incident Response. The Amazon VPC routes requests to AWS Security Incident Response and routes responses back
sir-ug-020	sir-ug.pdf	20	such as Java 7 and later support these modes. Additionally, you must sign requests using an access key ID and a secret access key that are associated with an IAM principal, or you can use the AWS Security Token Service (STS) to generate temporary security credentials to sign requests. Traﬃc between AWS resources in the same Region An Amazon Virtual Private Cloud (Amazon VPC) endpoint for AWS Security Incident Response is a logical entity within a VPC that allows connectivity only to AWS Security Incident Response. The Amazon VPC routes requests to AWS Security Incident Response and routes responses back to the VPC. For more information, see VPC endpoints in the Amazon VPC User Guide. For example policies that you can use to control access from VPC endpoints, see Using IAM policies to control access to DynamoDB. Note Amazon VPC endpoints are not accessible via AWS Site-to-Site VPN or AWS Direct Connect. Inter-network traﬃc privacy Version December 1, 2024 56 AWS Security Incident Response User Guide Identity and Access Management AWS Identity and Access Management (IAM) is an AWS service that helps an administrator control access to AWS resources. IAM administrators control authenticated (signed in) and authorized (have permissions) principals to use AWS Security Incident Response resources. IAM is an AWS service that you can use with no additional charge. Contents • Authenticating with identities • How AWS Security Incident Response Works with IAM Audience How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in AWS Security Incident Response. Security Administrators These users are suggested to use the AWSSecurityIncidentResponseFullAccess managed policy to ensure they have read and write access to membership and case resources. Case Watchers These individuals do not have authoritative access to all cases but individual cases that you grant explicit permission for. Incident Response Team members Members of the team can be given both full membership and case access. It is recommended that not all individuals have authoritative action on service membership but should have access to any and all cases that are created and managed through the service. For more information, refer to AWS Security Incident Response managed policies. 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 Identity and Access Management Version December 1, 2024 57 AWS Security Incident Response 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 Signing AWS API requests in the IAM User Guide. Regardless of the authentication method that you use, you may 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 Using multi-factor authentication (MFA) in AWS 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 e-mail address and password that you used to create the account. Never use the root user for your everyday tasks and take steps to safeguard your root user credentials. Only use them to perform 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 It is best practice to require human users, including those that need administrator access, to use federation with an identity provider to access AWS services by using temporary credentials.
sir-ug-021	sir-ug.pdf	21	address and password that you used to create the account. Never use the root user for your everyday tasks and take steps to safeguard your root user credentials. Only use them to perform 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 It is best practice to require human users, including those that need 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 December 1, 2024 58 AWS Security Incident Response 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 speciﬁc permissions for a single person or application. We recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. If you have a speciﬁc use case that requires 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 speciﬁes 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 diﬀerent 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 When to create an IAM user (instead of a role) in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. You can temporarily assume an IAM role in the AWS Management Console by switching roles. 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 Using IAM roles 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 deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Creating a role for a third-party Identity Provider in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control Authenticating with identities Version December 1, 2024 59 AWS Security Incident Response User Guide 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 diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent 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 diﬀerence 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
sir-ug-022	sir-ug.pdf	22	to allow someone (a trusted principal) in a diﬀerent 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 diﬀerence 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. • 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 Creating 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 its applications, you create an instance proﬁle that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. To learn whether to use IAM roles or IAM users, see When to create an IAM role (instead of a user) in the IAM User Guide. Authenticating with identities Version December 1, 2024 60 AWS Security Incident Response User Guide How AWS Security Incident Response Works with IAM 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 AWS Security Incident Response resources. IAM is an AWS service that you can use with no additional charge. IAM features that you can use with AWS Security Incident Response IAM feature Identity-based policies Resource-based policies Policy actions Policy resources Service alignment Yes No Yes Yes Policy conditions keys Yes (global) ACLs ABAC (tags in policies) Temporary credentials Forward access sessions (FAS) Service roles Service-linked roles Contents No Yes Yes Yes No Yes • Identity-based policies for AWS Security Incident Response • Policy condition keys for AWS Security Incident Response • Access control lists (ACLs) in AWS Security Incident Response How AWS Security Incident Response Works with IAM Version December 1, 2024 61 AWS Security Incident Response User Guide Identity-based policies for AWS Security Incident Response 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 Creating IAM 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. Contents • Identity-based policy examples • Policy best practices • Using the AWS Security Incident Response console • Allow users to view their own permissions • Resource-Based Policies • Policy Actions Identity-based policy examples By default, users and roles don't have permission to create or modify AWS Security Incident Response resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. An IAM administrator can create IAM policies to grant users permission to perform actions on the resources they need. The administrator can then add the IAM policies to roles, and users
sir-ug-023	sir-ug.pdf	23	Identity-based policy examples • Policy best practices • Using the AWS Security Incident Response console • Allow users to view their own permissions • Resource-Based Policies • Policy Actions Identity-based policy examples By default, users and roles don't have permission to create or modify AWS Security Incident Response resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. An IAM administrator can create IAM policies to grant users permission to perform actions on the resources they need. 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 Creating IAM policies in the IAM User Guide. For details about actions and resource types deﬁned by AWS Security Incident Response, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for AWS Security Incident Response in the Service Authorization Reference. How AWS Security Incident Response Works with IAM Version December 1, 2024 62 AWS Security Incident Response User Guide Policy best practices Identity-based policies determine whether someone can create, access, or delete AWS Security Incident Response 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 deﬁning AWS customer managed policies that are speciﬁc 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 deﬁning the actions that can be taken on speciﬁc resources under speciﬁc 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 speciﬁc 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 IAM Access Analyzer policy validation 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 Conﬁguring MFA-protected API access in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. How AWS Security Incident Response Works with IAM Version December 1, 2024 63 AWS Security Incident Response User Guide Using the AWS Security Incident Response console To access https://console.aws.amazon.com/security-ir/, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS Security Incident Response 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. Attach the AWS Security Incident Response Access or ReadOnly AWS managed policy to ensure that users and roles can use the service console. 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.
sir-ug-024	sir-ug.pdf	24	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. Attach the AWS Security Incident Response Access or ReadOnly AWS managed policy to ensure that users and roles can use the service console. 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", How AWS Security Incident Response Works with IAM Version December 1, 2024 64 AWS Security Incident Response User Guide "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Resource-Based Policies Resource-based policies within AWS Security Incident Response 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 speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed 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. For more information, refer to Cross account resource access in IAM in the IAM User Guide. Policy Actions Policy actions for AWS Security Incident Response Support 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. How AWS Security Incident Response Works with IAM Version December 1, 2024 65 AWS Security Incident Response User Guide Include actions in a policy to grant permissions to perform the associated operation. To see a list of AWS Security Incident Response actions, see Actions deﬁned by AWS Security Incident Response in the Service Authorization Reference. Policy actions in AWS Security Incident Response use the following preﬁx before the action: AWS Security Incident Response -identity To specify multiple actions in a single statement, separate them with commas. "Action": [ "AWS Security Incident Response -identity:action1", "AWS Security Incident Response - identity:action2" ] Policy resources for Amazon AWS Security Incident Response 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 speciﬁes 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 speciﬁc 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": "" Policy condition keys for AWS Security Incident Response Supports service-speciﬁc policy condition keys: No 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 eﬀect. 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. How AWS Security Incident Response Works with IAM Version December 1, 2024 66 AWS Security Incident Response User Guide 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
sir-ug-025	sir-ug.pdf	25	as equals or less than, to match the condition in the policy with values in the request. How AWS Security Incident Response Works with IAM Version December 1, 2024 66 AWS Security Incident Response User Guide 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-speciﬁc condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Access control lists (ACLs) in AWS Security Incident Response 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. Attribute-based access control (ABAC) with AWS Security Incident Response Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that deﬁnes 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 ﬁrst 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 What is ABAC? 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. Temporary credentials with Amazon AWS Security Incident Response How AWS Security Incident Response Works with IAM Version December 1, 2024 67 AWS Security Incident Response User Guide Supports temporary credentials: Yes 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 Switching to a 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. Forward access sessions for AWS Security Incident Response 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 diﬀerent 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. Troubleshooting AWS Security Incident Response identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with AWS Security Incident Response and IAM. Topics • I am not authorized to perform an action • I am not authorized to perform iam:PassRole Troubleshooting AWS Security Incident Response identity and access Version December 1, 2024 68 AWS Security Incident Response User Guide • I want to allow people outside
sir-ug-026	sir-ug.pdf	26	complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Troubleshooting AWS Security Incident Response identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with AWS Security Incident Response and IAM. Topics • I am not authorized to perform an action • I am not authorized to perform iam:PassRole Troubleshooting AWS Security Incident Response identity and access Version December 1, 2024 68 AWS Security Incident Response User Guide • I want to allow people outside of my AWS account to access my AWS Security Incident Response resources I am not authorized to perform an action 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 ﬁctional my-example-widget resource but doesn't have the ﬁctional AWS Security Incident Response :GetWidget permissions. User: arn:AWS:iam::123456789012:user/mateojackson is not authorized to perform: AWS Security Incident Response :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 AWS Security Incident Response :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 AWS Security Incident Response . 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 AWS Security Incident Response . 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 AWS Security Incident Response resources Troubleshooting AWS Security Incident Response identity and access Version December 1, 2024 69 AWS Security Incident Response User Guide 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. To learn more, consult the following: • To learn whether Amazon AWS Security Incident Response supports these features, see How AWS Security Incident Response 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 diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Using service roles 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 Creating a role to delegate permissions to an AWS service in the IAM User Guide. Using service-linked roles Service-linked roles for AWS Security Incident Response Contents • AWS SLR: AWSServiceRoleForSecurityIncidentResponse • AWS SLR: AWSServiceRoleForSecurityIncidentResponse_Triage • Supported regions for AWS Security Incident Response service-linked roles 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 Using service roles Version December 1, 2024 70 AWS Security Incident Response User Guide account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. A service-linked role makes setting up AWS Security Incident Response easier because you don’t
sir-ug-027	sir-ug.pdf	27	AWS SLR: AWSServiceRoleForSecurityIncidentResponse_Triage • Supported regions for AWS Security Incident Response service-linked roles 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 Using service roles Version December 1, 2024 70 AWS Security Incident Response User Guide account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. A service-linked role makes setting up AWS Security Incident Response easier because you don’t have to manually add the necessary permissions. AWS Security Incident Response deﬁnes the permissions of its service-linked roles, and unless deﬁned otherwise, only AWS Security Incident Response can assume its roles. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked roles column. Choose a Yes with a link to view the service-linked role documentation for that service. AWS SLR: AWSServiceRoleForSecurityIncidentResponse AWS Security Incident Response uses the service-linked role (SLR) named AWSServiceRoleForSecurityIncidentResponse – AWS Security Incident Response policy to identify accounts subscribed, create cases, and tag related resources. Permissions The AWSServiceRoleForSecurityIncidentResponse service-linked role trusts the following service to assume the role: • triage.security-ir.amazonaws.com Attached to this role is the AWS managed policy named AWSSecurityIncidentResponseServiceRolePolicy. The service uses the role to perform actions on the following resources: • AWS Organizations: Allows the service to lookup membership accounts for use with the service. • CreateCase: Allows the service create service cases on behalf of membership accounts. • TagResource: Allows the service tag resources conﬁgured as part of the service. Managing the role You don't need to manually create a service-linked role. When you onboard to to AWS Security Incident Response in the AWS Management Console, the AWS CLI, or the AWS API, the service creates the service-linked role for you. AWSServiceRoleForSecurityIncidentResponse Version December 1, 2024 71 AWS Security Incident Response User Guide Note If you created a membership using a delegated administrator account, then service-linked roles need to be manually created in AWS Organizations Management accounts. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you onboard to the service it creates the service-linked role for you again. You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. AWS SLR: AWSServiceRoleForSecurityIncidentResponse_Triage AWS Security Incident Response uses the service-linked role (SLR) named AWSServiceRoleForSecurityIncidentResponse_Triage – AWS Security Incident Response policy to continuously monitor your environment for security threats, tune security services to reduce alert noise, and gather information to investigate potential incidents. Permissions The AWSServiceRoleForSecurityIncidentResponse_Triage service-linked role trusts the following service to assume the role: • triage.security-ir.amazonaws.com Attached to this role is the AWS managed policy AWSSecurityIncidentResponseTriageServiceRolePolicy. The service uses the role to perform actions on the following resources: • Events: Allows the service to create an Amazon EventBridge managed rule. This rule is the infrastructure required in your AWS account to deliver events from your account to the service. This action is performed on any AWS resource managed by triage.security- ir.amazonaws.com. • Amazon GuardDuty: Allows the service to tune security services to reduce alert noise and gather information to investigate potential incidents. This action is performed on any AWS resource. AWSServiceRoleForSecurityIncidentResponse_Triage Version December 1, 2024 72 AWS Security Incident Response User Guide • AWS Security Hub: Allows the service to tune security services to reduce alert noise and gather information to investigate potential incidents. This action is performed on any AWS resource. Managing the role You don't need to manually create a service-linked role. When you onboard to to AWS Security Incident Response in the AWS Management Console, the AWS CLI, or the AWS API, the service creates the service-linked role for you. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you onboard to the service it creates the service-linked role for you again. You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. Supported regions for AWS Security Incident Response service-linked roles AWS Security Incident Response supports using service-linked roles in all of the regions where the service is available. • US East
sir-ug-028	sir-ug.pdf	28	and then need to create it again, you can use the same process to recreate the role in your account. When you onboard to the service it creates the service-linked role for you again. You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. Supported regions for AWS Security Incident Response service-linked roles AWS Security Incident Response supports using service-linked roles in all of the regions where the service is available. • US East (Ohio) • US West (Oregon) • US East (Virginia) • EU (Frankfurt) • EU (Ireland) • EU (London) • EU (Paris) • EU (Stockholm) • Asia Paciﬁc (Mumbai) • Asia Paciﬁc (Seoul) • Asia Paciﬁc (Singapore) • Asia Paciﬁc (Sydney) • Asia Paciﬁc (Tokyo) Supported regions for SLRs Version December 1, 2024 73 AWS Security Incident Response User Guide • Canada (Central) • South America (São Paulo) AWS Managed Policies 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. To add permissions to users, groups, and roles, it is easier to use AWS managed policies than to write policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. To get started quickly, you can use our AWS managed policies. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update their associated AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide. Contents • AWS managed policy: AWSSecurityIncidentResponseServiceRolePolicy • AWS managed policy: AWSSecurityIncidentResponseFullAccess • AWS managed policy: AWSSecurityIncidentResponseReadOnlyAccess • AWS managed policy: AWSSecurityIncidentResponseCaseFullAccess • AWS managed policy: AWSSecurityIncidentResponseTriageServiceRolePolicy • AWS Security Incident Response updates to SLRs and managed policies AWS Managed Policies Version December 1, 2024 74 AWS Security Incident Response User Guide AWS managed policy: AWSSecurityIncidentResponseServiceRolePolicy AWS Security Incident Response uses the AWSSecurityIncidentResponseServiceRolePolicy AWS managed policy. This AWS managed policy is attached to the AWSServiceRoleForSecurityIncidentResponse service-linked role. The policy provides access for AWS Security Incident Response to identify accounts subscribed, create cases, and tag related resources. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. AWS Security Incident Response uses tags to provide you with administration services. Tags are not intended to be used for private or sensitive data Permissions details The service uses this policy to perform actions on the following resources: • AWS Organizations: Allows the service to lookup membership accounts for use with the service. • CreateCase: Allows the service create service cases on behalf of membership accounts. • TagResource: Allows the service tag resources conﬁgured as part of the service. You can view the permissions associated with this policy in AWS managed policies for AWSSecurityIncidentResponseServiceRolePolicy. AWS managed policy: AWSSecurityIncidentResponseFullAccess AWS Security Incident Response uses the AWSSecurityIncidentResponseAdmin AWS managed policy. This policy grants full access to service resources and access to related AWS services. You can use this policy with your IAM principals to quickly add permissions for AWS Security Incident Response. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. AWS Security Incident Response uses tags to provide you with administration services. Tags are not intended to be used for private or sensitive data managed policy: AWSSecurityIncidentResponseServiceRolePolicy Version December 1, 2024 75 AWS Security Incident Response User Guide Permissions details The service uses this policy to perform actions on the following resources: • IAM principal read-only access: Grants a service user the ability to perform read-only actions against existing AWS Security Incident Response resources. • IAM principal write access: Grants a service user the ability to update,
sir-ug-029	sir-ug.pdf	29	store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. AWS Security Incident Response uses tags to provide you with administration services. Tags are not intended to be used for private or sensitive data managed policy: AWSSecurityIncidentResponseServiceRolePolicy Version December 1, 2024 75 AWS Security Incident Response User Guide Permissions details The service uses this policy to perform actions on the following resources: • IAM principal read-only access: Grants a service user the ability to perform read-only actions against existing AWS Security Incident Response resources. • IAM principal write access: Grants a service user the ability to update, modify, delete, and create AWS Security Incident Response resources. You can view the permissions associated with this policy in AWS managed policies for AWSSecurityIncidentResponseFullAccess. AWS managed policy: AWSSecurityIncidentResponseReadOnlyAccess AWS Security Incident Response uses the AWSSecurityIncidentResponseReadOnlyAccess AWS managed policy. The policy grants read-only access to service case resources. You can use this policy with your IAM principals to quickly add permissions for AWS Security Incident Response. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. AWS Security Incident Response uses tags to provide you with administration services. Tags are not intended to be used for private or sensitive data Permissions details The service uses this policy to perform actions on the following resources: • IAM principal read-only access: Grants a service user the ability to perform read-only actions against existing AWS Security Incident Response resources. You can view the permissions associated with this policy in AWS managed policies for AWSSecurityIncidentResponseReadOnlyAccess. managed policy: AWSSecurityIncidentResponseReadOnlyAccess Version December 1, 2024 76 AWS Security Incident Response User Guide AWS managed policy: AWSSecurityIncidentResponseCaseFullAccess AWS Security Incident Response uses the AWSSecurityIncidentResponseCaseFullAccess AWS managed policy. The policy grants full access to service case resources. You can use this policy with your IAM principals to quickly add permissions for AWS Security Incident Response. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. AWS Security Incident Response uses tags to provide you with administration services. Tags are not intended to be used for private or sensitive data Permissions details The service uses this policy to perform actions on the following resources: • IAM principal case read-only access: Grants a service user the ability to perform read-only actions against existing AWS Security Incident Response cases. • IAM principal case write access: Grants a service user the ability to update, modify, delete, and create AWS Security Incident Response cases. You can view the permissions associated with this policy in AWS managed policies for AWSSecurityIncidentResponseCaseFullAccess. AWS managed policy: AWSSecurityIncidentResponseTriageServiceRolePolicy AWS Security Incident Response uses the AWSSecurityIncidentResponseTriageServiceRolePolicy AWS managed policy. This AWS managed policy is attached to the AWSServiceRoleForSecurityIncidentResponse_Triage service-linked role. The policy provides access to AWS Security Incident Response to continuously monitor your environment for security threats, tune security services to reduce alert noise, and gather information to investigate potential incidents. You can't attach this policy to your IAM entities. managed policy: AWSSecurityIncidentResponseCaseFullAccess Version December 1, 2024 77 AWS Security Incident Response User Guide Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. AWS Security Incident Response uses tags to provide you with administration services. Tags are not intended to be used for private or sensitive data Permissions details The service uses this policy to perform actions on the following resources: • Events: Allows the service to create an Amazon EventBridge managed rule. This rule is the infrastructure required in your AWS account to deliver events from your account to the service. This action is performed on any AWS resource managed by triage.security- ir.amazonaws.com. • Amazon GuardDuty: Allows the service to tune security services to reduce alert noise and gather information to investigate potential incidents. This action is performed on any AWS resource. • AWS Security Hub: Allows the service to tune security services to reduce alert noise and gather information to investigate potential incidents. This action is performed on any AWS resource. You can view the permissions associated with this policy in AWS managed policies for AWSSecurityIncidentResponseTriageServiceRolePolicy. AWS Security Incident Response updates to SLRs and managed policies View details about updates to AWS Security Incident Response SLRs and managed policies roles since this service began tracking these changes. Change Description Updates to SLR adding permissions to support service entitlements. AWSSecurityIncidentResponseTriageServiceRolePolicy has been updated to add security-ir:GetMembership, security-ir:ListMemberships, security-ir:UpdateCase, guardduty:ListFilters, guarduty:UpdateFilter, guardduty :DeleteFilter, and guardduty:GetAdministratorAccount permissions. guardduty:GetAdministratorAccount was Date March 11, 2025 Updates for SLRs and managed policies Version December 1, 2024 78 AWS Security Incident Response User Guide Change Description Date added to facilitate management of GuardDuty Auto- Archival ﬁlters in delegated accounts. New service linked role and attached policy allowing service access into your AWS Organizations accounts to December 1, 2024 identify membership. New service linked role and attached policy
sir-ug-030	sir-ug.pdf	30	since this service began tracking these changes. Change Description Updates to SLR adding permissions to support service entitlements. AWSSecurityIncidentResponseTriageServiceRolePolicy has been updated to add security-ir:GetMembership, security-ir:ListMemberships, security-ir:UpdateCase, guardduty:ListFilters, guarduty:UpdateFilter, guardduty :DeleteFilter, and guardduty:GetAdministratorAccount permissions. guardduty:GetAdministratorAccount was Date March 11, 2025 Updates for SLRs and managed policies Version December 1, 2024 78 AWS Security Incident Response User Guide Change Description Date added to facilitate management of GuardDuty Auto- Archival ﬁlters in delegated accounts. New service linked role and attached policy allowing service access into your AWS Organizations accounts to December 1, 2024 identify membership. New service linked role and attached policy allowing service access into your AWS Organizations accounts to December 1, 2024 perform triage of security events. New SLR – AWSServic eRoleForS ecurityIn cidentResponse New managed policy – AWSSecuri tyInciden tResponse ServiceRo lePolicy. New SLR – AWSServic eRoleForS ecurityIn cidentRes ponse_Triage New managed policy – AWSSecuri tyInciden tResponse TriageSer viceRolePolicy Updates for SLRs and managed policies Version December 1, 2024 79 AWS Security Incident Response User Guide Change Description Date New managed policy – AWS Security Incident Response add a new SLR to attach to IAM principals for read and write actions for December 1, 2024 the service. AWSSecuri tyInciden tResponse FullAccess New managed policy role – AWS Security Incident Response add a new SLR to attach to IAM principals for read actions December 1, 2024 AWSSecuri tyInciden tResponse ReadOnlyAccess New managed policy role – AWS Security Incident Response add a new SLR to attach to IAM principals for read and write actions for December 1, 2024 service cases. AWSSecuri tyInciden tResponse CaseFullAccess Started tracking changes. Started tracking changes for AWS Security Incident Response SLRs and managed policies December 1, 2024 Incident response Security and Compliance is a shared responsibility between AWS and the customer. This shared model can help relieve the customer’s operational burden as AWS operates, manages and controls the components from the host operating system and virtualization layer down to the physical security of the facilities in which the service operates. The customer assumes responsibility and management of the guest operating system (including updates and security patches), other associated application software as well as the conﬁguration of the AWS provided security group ﬁrewall. For additional information refer to the AWS shared responsibility model. Incident response Version December 1, 2024 80 AWS Security Incident Response User Guide By establishing a security baseline that meets the objectives for your applications running in the cloud, you're able to detect deviations that you can respond to. Since security incident response can be a complex topic, we encourage you to review the following resources so that you are better able to understand the impact that incident response and your choices have on your corporate goals: AWS Security Best Practices whitepaper, and the Security Perspective of the AWS Cloud Adoption Framework (CAF) white paper. Compliance validation Third-party auditors assess the security and compliance of AWS services as part of multiple AWS compliance programs. These include SOC, PCI, FedRAMP, HIPAA, and others. AWS Security Incident Response has not been evaluated for compliance with aforementioned programs. For a list of AWS services in scope of speciﬁc compliance programs, see AWS services in scope by compliance program. For general information, see AWS compliance programs. 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 and compliance quick start guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • Architecting for HIPAA security and compliance whitepaper – This whitepaper describes how companies can use AWS to create HIPAA-compliant applications. • AWS compliance resources – A collection of workbooks and guides that apply by industry and/or location. • Evaluating resources with AWS Conﬁg Rules in the AWS Conﬁg Developer Guide – AWS Conﬁg; assesses how well your resource conﬁgurations 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 validation Version December 1, 2024 81 AWS Security Incident Response User Guide 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
sir-ug-031	sir-ug.pdf	31	AWS. Security Hub uses security controls to evaluate your AWS resources and to check your Compliance validation Version December 1, 2024 81 AWS Security Incident Response User Guide 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. Logging and monitoring in AWS Security Incident Response Monitoring is an important part of maintaining the reliability, availability, and performance of AWS Security Incident Response and your other AWS solutions. AWS Security Incident Response currently supports the following AWS services to monitor your organization and the activity that happens within it. AWS CloudTrail – With CloudTrail you can capture API calls from the AWS Security Incident Response console. For example, when a user authenticates, CloudTrail can record details such as the IP address in the request, who made the request, and when it was made. Amazon CloudWatch Metrics – With CloudWatch metrics you can monitor, report, and take automatic actions in case of an event in near real time. For example, you can create CloudWatch dashboards on the provided metrics to monitor your AWS Security Incident Response usage, or you can create CloudWatch alarms on the provided metrics to notify you on breach of a set threshold. The namespace for the service is AWS/Usage/ServiceName. The metric names available are ActiveManagedCases and SelfManagedCases. In accordance with the AWS Service Terms, The AWS Security Incident Response responder team will have access to your history of CloudTrail, VPC, DNS and S3 log data. This data may be utilized during active security incidents when a case is open in the AWS Security Incident Response service portal. Resilience The AWS global infrastructure is built around AWS Regions and Availability Zones. Regions provide multiple physically separated and isolated Availability Zones, which are connected through Logging and monitoring in AWS Security Incident Response Version December 1, 2024 82 AWS Security Incident Response 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. Infrastructure security AWS Security Incident Response 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 AWS Security Incident Response 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 Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-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. Conﬁguration and vulnerability analysis You are responsible for managing the service containment roles and the associated AWS CloudFormation stack sets. AWS handles basic security tasks, such as guest operating system (OS) and database patching, ﬁrewall conﬁguration, and disaster recovery. These procedures have been reviewed and certiﬁed by the appropriate third parties. For more details, see the following AWS resources: • Shared responsibility model • Best practices for security, identity, & compliance Infrastructure security Version December 1, 2024 83 AWS Security Incident Response User Guide 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
sir-ug-032	sir-ug.pdf	32	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 Amazon Connect gives another service to the resource. If you use both global condition context keys, the AWS:SourceAccount value and the account in the AWS:SourceArn value must use the same account ID when used in the same policy statement. The most eﬀective way to protect against the confused deputy problem is to use the exact Amazon Resource Name (ARN) of the resource you want to allow. 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 wildcards () for the unknown portions of the ARN. For example, arn:AWS:servicename::region-name::your AWS account ID:. For an example of an assume role policy that shows how you can prevent a confused deputy issue, see Confused deputy prevention policy. Cross-service confused deputy prevention Version December 1, 2024 84 AWS Security Incident Response User Guide Service Quotas AWS Security Incident Response The following tables list the quotas, for AWS Security Incident Response resources for your AWS account. Some quotas may be increased above those stated below with service manager approval. Unless indicated otherwise, these quotas are per Region. Name Default Adjustable Comments 1 2 3 4 Active AWS supported cases 10 Yes (up to 50) Active self-mana ged cases 50 Yes (up to 100) 10 No Service supported cases created within 24 hours Maximum number of entities in 10 No The number of active cases requesting assistance from AWS CIRT. The number number of active cases using the platform without assistance from AWS CIRT. The number of cases created requesting assistance from AWS CIRT created in a 24- hour rolling window. The maximum number of entities in the AWS Security Incident Response Version December 1, 2024 85 AWS Security Incident Response User Guide Name Default Adjustable Comments 5 6 7 8 default incident response team Maximum number of additional members on a case 30 No Maximum Number of Case Attachments 50 Yes (up to 100) Maximum case comment size 1000 No Maximum Case Attachment ﬁlename size 255 No default incident response team. The maximum number of entities associated with a case. This will initially be populated with entities from your default incident response team. The maximum number of ﬁles that can be attached to a case. The maximum number of characters in a case comment. The maximum number of characters in a ﬁlename. AWS Security Incident Response Version December 1, 2024 86 AWS Security Incident Response User Guide AWS Security Incident Response Technical Guide Contents • Abstract • Are you Well-Architected? • Introduction • Preparation • Operations • Post-incident activity • Conclusion • Contributors • Appendix A: Cloud capability deﬁnitions • Appendix B: AWS incident response resources • Notices Abstract This guide presents an overview of the fundamentals of responding to security incidents within a customer’s Amazon Web Services (AWS) Cloud environment. It provides an overview of cloud security and incident response concepts and identiﬁes cloud capabilities, services, and mechanisms that are available to customers who respond to security issues. This guide is intended for those in technical roles and assumes that you are familiar with the general principles of information security, have a basic understanding of security incident response in your current on-premises environments, and have some familiarity with cloud services. Are you Well-Architected? The AWS Well-Architected Framework helps you understand the pros and cons of the decisions you make when building systems in the cloud. The six pillars of the Framework allow you to learn architectural best practices for designing and operating reliable, secure, eﬃcient, cost-eﬀective, and sustainable systems. Using the AWS Well-Architected Tool, available at no charge in the AWS Abstract Version December 1, 2024 87 AWS Security Incident Response User Guide Well-Architected Tool console, you can review your workloads against these best practices by answering a set of questions for each pillar. For more expert guidance and best practices for your cloud architecture—reference architecture deployments, diagrams, and whitepapers—refer to the AWS Architecture Center. Introduction Security is the top priority at AWS. AWS customers beneﬁt from data centers and network architecture built to help support the needs of
sir-ug-033	sir-ug.pdf	33	designing and operating reliable, secure, eﬃcient, cost-eﬀective, and sustainable systems. Using the AWS Well-Architected Tool, available at no charge in the AWS Abstract Version December 1, 2024 87 AWS Security Incident Response User Guide Well-Architected Tool console, you can review your workloads against these best practices by answering a set of questions for each pillar. For more expert guidance and best practices for your cloud architecture—reference architecture deployments, diagrams, and whitepapers—refer to the AWS Architecture Center. Introduction Security is the top priority at AWS. AWS customers beneﬁt from data centers and network architecture built to help support the needs of the most security-sensitive organizations. AWS has a shared responsibility model: AWS manages the security of the cloud, and customers are responsible for security in the cloud. This means that you have full control of your security implementation, including access to several tools and services to help meet your security objectives. These capabilities help you establish a security baseline for applications running in the AWS Cloud. When a deviation from the baseline occurs, such as by a misconﬁguration or changing external factors, you will need to respond and investigate. To successfully do so, you need to understand the basic concepts of security incident response within your AWS environment and the requirements to prepare, educate, and train cloud teams before security issues occur. It is important to know which controls and capabilities you can use, review topical examples for resolving potential concerns, and identify remediation methods that use automation to improve response speed and consistency. Additionally, you should understand your compliance and regulatory requirements as they relate to building a security incident response program to fulﬁll those requirements. Security incident response can be complex, so we encourage you to implement an iterative approach: begin with the core security services, build foundational detection and response capabilities, then develop playbooks to create an initial library of incident response mechanisms upon which to iterate and improve. Before you begin Before you begin learning about incident response for security events in AWS, familiarize yourself with the relevant standards and frameworks for AWS security and incident response. These foundations will help you understand the concepts and best practices presented in this guide. AWS security standards and frameworks To start, we encourage you to review the Best Practices for Security, Identity, and Compliance, Security Pillar - AWS Well-Architected Framework and the Security Perspective of the Overview of the AWS Cloud Adoption Framework (AWS CAF) whitepaper. Introduction Version December 1, 2024 88 AWS Security Incident Response User Guide The AWS CAF provides guidance supporting coordination between diﬀerent parts of organizations moving to the cloud. The AWS CAF guidance is divided into several focus areas, referred to as perspectives, that are relevant to building cloud-based IT systems. The security perspective describes how to implement a security program across workstreams, one of which is incident response. This document is a product of our experiences working with customers to help them build eﬀective and eﬃcient security incident response programs and capabilities. Industry incident response standards and frameworks This whitepaper follows the incident response standards and best practices from the Computer Security Incident Handling Guide SP 800-61 r2, which was created by the National Institute of Standards and Technology (NIST). Reading and understanding the concepts introduced by NIST is a helpful prerequisite. Concepts and best practices from this NIST guide will be applied to AWS technologies in this paper. However, on-premises incident scenarios are out of scope for this guide. AWS incident response overview To start, it’s important to understand how security operations and incident response are diﬀerent in the cloud. To build response capabilities that are eﬀective in AWS, you will need to understand the deviations from traditional on-premises response and their impact to your incident response program. Each of these diﬀerences, as well as core AWS incident response design principles, are detailed in this section. Aspects of AWS incident response All AWS users within an organization should have a basic understanding of security incident response processes, and security staﬀ should understand how to respond to security issues. Education, training, and experience are vital to a successful cloud incident response program and are ideally implemented well in advance of having to handle a possible security incident. The foundation of a successful incident response program in the cloud is Preparation, Operations, and Post-Incident Activity. To understand each of these aspects, consider the following descriptions: • Preparation – Prepare your incident response team to detect and respond to incidents within AWS by enabling detective controls and verifying appropriate access to the necessary tools and cloud services. Additionally, prepare the necessary playbooks, both manual and automated, to verify reliable and consistent responses. • Operations – Operate on security events and potential incidents following NIST’s phases of incident response: detect, analyze, contain, eradicate, and recover. AWS
sir-ug-034	sir-ug.pdf	34	a possible security incident. The foundation of a successful incident response program in the cloud is Preparation, Operations, and Post-Incident Activity. To understand each of these aspects, consider the following descriptions: • Preparation – Prepare your incident response team to detect and respond to incidents within AWS by enabling detective controls and verifying appropriate access to the necessary tools and cloud services. Additionally, prepare the necessary playbooks, both manual and automated, to verify reliable and consistent responses. • Operations – Operate on security events and potential incidents following NIST’s phases of incident response: detect, analyze, contain, eradicate, and recover. AWS incident response overview Version December 1, 2024 89 AWS Security Incident Response User Guide • Post-incident activity – Iterate on the outcome of your security events and simulations to improve the eﬃcacy of your response, increase value derived from response and investigation, and further reduce risk. You have to learn from incidents and have strong ownership of improvement activities. Each of these aspects are explored and detailed in this guide. The following diagram shows the ﬂow of these aspects, aligning with the previously mentioned NIST incident response lifecycle, but with operations encompassing detection and analysis with containment, eradication, and recovery. Aspects of AWS incident response AWS incident response principles and design goals While the general processes and mechanisms of incident response as deﬁned by the NIST SP 800-61 Computer Security Incident Handling Guide are sound, we encourage you to also consider these speciﬁc design goals that are relevant to responding to security incidents in a cloud environment: • Establish response objectives – Work with stakeholders, legal counsel, and organizational leadership to determine the goal of responding to an incident. Some common goals include containing and mitigating the issue, recovering the aﬀected resources, preserving data for forensics, returning to known safe operations, and ultimately learning from incidents. • Respond using the cloud – Implement response patterns within the cloud, where the event and data occurs. • Know what you have and what you need – Preserve logs, resources, snapshots, and other evidence by copying and storing them in a centralized cloud account dedicated to response. Use tags, metadata, and mechanisms that enforce retention policies. You’ll need to understand what services you use and then identify the requirements for investigating those services. To help you AWS incident response overview Version December 1, 2024 90 AWS Security Incident Response User Guide understand your environment, you can also use tagging, which is covered later in this document in the the section called “Develop and implement a tagging strategy” section. • Use redeployment mechanisms – If a security anomaly can be attributed to a misconﬁguration, the remediation might be as simple as removing the variance by redeploying resources with the proper conﬁguration. If a possible compromise is identiﬁed, verify that your redeployment includes successful and veriﬁed mitigation of the root causes. • Automate where possible – As issues arise or incidents repeat, build mechanisms to programmatically triage and respond to common events. Use human responses for unique, complex, or sensitive incidents where automations are insuﬃcient. • Choose scalable solutions – Strive to match the scalability of your organization's approach to cloud computing. Implement detection and response mechanisms that scale across your environments to eﬀectively reduce the time between detection and response. • Learn and improve your process – Be proactive in identifying gaps in your processes, tools, or people, and implement a plan to ﬁx them. Simulations are safe methods to ﬁnd gaps and improve processes. Refer to the the section called “Post-incident activity” section of this document for details on how to iterate on your processes. These design goals are a reminder to review your architecture implementation for the ability to conduct both incident response and threat detection. As you plan your cloud implementations, think about responding to an incident, ideally with a forensically sound response methodology. In some cases, this means you might have multiple organizations, accounts, and tools speciﬁcally set up for these response tasks. These tools and functions should be made available to the incident responder by deployment pipeline. They should not be static because it can cause a larger risk. Cloud security incident domains To eﬀectively prepare for and respond to security events in your AWS environment, you need to understand the commons types of cloud security incidents. There are three domains within the customer's responsibility where security incidents might occur: service, infrastructure, and application. Diﬀerent domains require diﬀerent knowledge, tools, and response processes. Consider these domains: • Service domain – Incidents in the service domain might aﬀect your AWS account, AWS Identity and Access Management (IAM) permissions, resource metadata, billing, or other areas. A service domain event is one that you respond to exclusively with AWS API mechanisms, or where you have root causes associated with your conﬁguration or
sir-ug-035	sir-ug.pdf	35	to security events in your AWS environment, you need to understand the commons types of cloud security incidents. There are three domains within the customer's responsibility where security incidents might occur: service, infrastructure, and application. Diﬀerent domains require diﬀerent knowledge, tools, and response processes. Consider these domains: • Service domain – Incidents in the service domain might aﬀect your AWS account, AWS Identity and Access Management (IAM) permissions, resource metadata, billing, or other areas. A service domain event is one that you respond to exclusively with AWS API mechanisms, or where you have root causes associated with your conﬁguration or resource permissions, and might have related service-oriented logging. AWS incident response overview Version December 1, 2024 91 AWS Security Incident Response User Guide • Infrastructure domain – Incidents in the infrastructure domain include data or network-related activity, such as processes and data on your Amazon Elastic Compute Cloud (Amazon EC2) instances, traﬃc to your Amazon EC2 instances within the virtual private cloud (VPC), and other areas, such as containers or other future services. Your response to infrastructure domain events often involves acquiring incident-related data for forensic analysis. It likely includes interaction with the operating system of an instance, and, in various cases, might also involve AWS API mechanisms. In the infrastructure domain, you can use a combination of AWS APIs and digital forensics/incident response (DFIR) tooling within a guest operating system, such as an Amazon EC2 instance dedicated to performing forensic analysis and investigations. Infrastructure domain incidents might involve analyzing network packet captures, disk blocks on an Amazon Elastic Block Store (Amazon EBS) volume, or volatile memory acquired from an instance. • Application domain – Incidents in the application domain occur in the application code or in software deployed to the services or infrastructure. This domain should be included in your cloud threat detection and response playbooks and might incorporate similar responses to those in the infrastructure domain. With an appropriate and thoughtful application architecture, you can manage this domain with cloud tools by using automated acquisition, recovery, and deployment. In these domains, consider the actors who might act against AWS accounts, resources, or data. Whether internal or external, use a risk framework to determine speciﬁc risks to the organization and prepare accordingly. Additionally, you should develop threat models, which can help with your incident response planning and thoughtful architecture building. Key diﬀerences of incident response in AWS Incident response is an integral part of a cyber security strategy either on-premises or in the cloud. Security principles such as least privilege and defense in depth intend to protect the conﬁdentiality, integrity, and availability of data both on-premises and in the cloud. Several incident response patterns that support these security principles follow suit, including log retention, alert selection derived from threat modeling, playbook development, and security information and event management (SIEM) integration. The diﬀerences begin when customers start architecting and engineering these patterns in the cloud. The following are the key diﬀerences of incident response in AWS. Diﬀerence #1: Security as a shared responsibility The responsibility for security and compliance is shared between AWS and its customers. This shared responsibility model relieves some of the customer’s operational burden because AWS operates, manages, and controls the components from the host operating system and AWS incident response overview Version December 1, 2024 92 AWS Security Incident Response User Guide virtualization layer down to the physical security of the facilities in which the service operates. For more details on the shared responsibility model, refer to the Shared Responsibility Model documentation. As your shared responsibility in the cloud changes, your options for incident response also change. Planning for and understanding these tradeoﬀs and matching them with your governance needs is a crucial step in incident response. In addition to the direct relationship you have with AWS, there might be other entities that have responsibilities in your particular responsibility model. For example, you might have internal organizational units that take responsibility for some aspects of your operations. You might also have relationships with other parties that develop, manage, or operate some of your cloud technology. Creating and testing an appropriate incident response plan and appropriate playbooks that match your operating model is extremely important. Diﬀerence #2: Cloud service domain Because of the diﬀerences in security responsibility that exist in cloud services, a new domain for security incidents was introduced: the service domain, which was explained earlier in the Incident domain section. The service domain encompasses a customer's AWS account, IAM permissions, resource metadata, billing, and other areas. This domain is diﬀerent for incident response because of how you respond. Response within the service domain is typically done by reviewing and issuing API calls, rather than traditional host-based and network-based response. In the service domain, you won’t interact with an aﬀected resource’s operating system. The following diagram
sir-ug-036	sir-ug.pdf	36	Cloud service domain Because of the diﬀerences in security responsibility that exist in cloud services, a new domain for security incidents was introduced: the service domain, which was explained earlier in the Incident domain section. The service domain encompasses a customer's AWS account, IAM permissions, resource metadata, billing, and other areas. This domain is diﬀerent for incident response because of how you respond. Response within the service domain is typically done by reviewing and issuing API calls, rather than traditional host-based and network-based response. In the service domain, you won’t interact with an aﬀected resource’s operating system. The following diagram shows an example of a security event in the service domain based on an architectural anti-pattern. In this event, an unauthorized user obtains the long-term security credentials of an IAM user. The IAM user has an IAM policy that allows them to retrieve objects from an Amazon Simple Storage Service (Amazon S3) bucket. To respond to this security event, you would use AWS APIs to analyze AWS logs such as AWS CloudTrail and Amazon S3 access logs. You would also use AWS APIs to contain and recover from the incident. AWS incident response overview Version December 1, 2024 93 AWS Security Incident Response User Guide Service domain example Diﬀerence #3: APIs for provisioning infrastructure Another diﬀerence comes from the Cloud characteristic of on-demand self-service. The main facility customers interact with the AWS Cloud by using a RESTful API through public and private endpoints available in many geographical locations around the globe. Customers can access these APIs with AWS credentials. In contrast to on-premises access control, these credentials are not necessarily bound by a network or a Microsoft Active Directory domain. Credentials are instead associated with an IAM principal inside of an AWS account. These API endpoints can be accessed outside of your corporate network, which will be important to understand when you respond to an incident where credentials are used outside of your expected network or geography. Because of the API-based nature of AWS, an important log source for responding to security events is AWS CloudTrail, which tracks the management API calls made in your AWS accounts and where you can ﬁnd information about the source location of the API calls. Diﬀerence #4: Dynamic nature of the cloud The cloud is dynamic; it allows you to quickly create and delete resources. With automatic scaling, resources can be spun up and spun down based on increases in traﬃc. With short-lived infrastructure and fast-paced changes, a resource that you’re investigating might no longer exist or might have been modiﬁed. Understanding the ephemeral nature of AWS resources and how you can track the creation and deletion of AWS resources will be important for incident analysis. You can use AWS Conﬁg to track the conﬁguration history of your AWS resources. AWS incident response overview Version December 1, 2024 94 AWS Security Incident Response User Guide Diﬀerence #5: Data access Data access is also diﬀerent in the cloud. You can’t plug into a server in order to collect the data you need for a security investigation. Data is collected over the wire and through API calls. You’ll need to practice and understand how to perform data collection over APIs in order to be prepared for this shift, and verify appropriate storage for eﬀective collection and access. Diﬀerence #6: Importance of automation For customers to fully realize the beneﬁts of cloud adoption, their operational strategy must embrace automation. Infrastructure as code (IaC) is a pattern of highly eﬃcient automated environments where AWS services are deployed, conﬁgured, re-conﬁgured, and destroyed using code facilitated by native IaC services such as AWS CloudFormation or third-party solutions. This pushes the implementation of incident response to be highly automated, which is desirable to avoid human mistakes, especially when handling evidence. While automation is used on-premises, it is essential and simpler in the AWS Cloud. Addressing these diﬀerences To address these diﬀerences, follow the steps outlined in the next section to verify that your incident response program across people, processes, and technology is well prepared. Preparation Preparing for an incident is critical for timely and eﬀective incident response. Preparation is done across three domains: • People – Preparing your people for a security incident involves identifying the relevant stakeholders for incident response and training them on incident response and cloud technologies. • Process – Preparing your processes for a security incident involves documenting architectures, developing thorough incident response plans, and creating playbooks for consistent response to security events. • Technology – Preparing your technology for a security incident involves setting up access, aggregating and monitoring necessary logs, implementing eﬀective alerting mechanisms, and developing response and investigative capabilities. Preparation Version December 1, 2024 95 AWS Security Incident Response User Guide Each of these domains are equally important for eﬀective incident response. No incident
sir-ug-037	sir-ug.pdf	37	security incident involves identifying the relevant stakeholders for incident response and training them on incident response and cloud technologies. • Process – Preparing your processes for a security incident involves documenting architectures, developing thorough incident response plans, and creating playbooks for consistent response to security events. • Technology – Preparing your technology for a security incident involves setting up access, aggregating and monitoring necessary logs, implementing eﬀective alerting mechanisms, and developing response and investigative capabilities. Preparation Version December 1, 2024 95 AWS Security Incident Response User Guide Each of these domains are equally important for eﬀective incident response. No incident response program is complete or eﬀective without all three. You will need to prepare people, processes, and technologies with tight integration in order to be prepared for an incident. People To respond to a security event, you need to identify the stakeholders who would support the response to a security event. Additionally, it is critical for an eﬀective response to have them trained on AWS technologies and your AWS environment. Deﬁne roles and responsibilities Handling security events requires cross-organizational discipline and an inclination for action. Within your organizational structure, there should be many people who are responsible, accountable, consulted, or kept informed during an incident, such as representatives from human resources (HR), the executive team, and legal. Consider these roles and responsibilities, and whether any third parties must be involved. Note that in many geographies, there are local laws that govern what should and should not be done. Although it might seem bureaucratic to build a responsible, accountable, consulted, and informed (RACI) chart for your security response plans, doing so enables quick and direct communication and clearly outlines the leadership across diﬀerent stages of the event. During an incident, including the owners/developers of impacted applications and resources is key because they are subject matter experts (SMEs) that can provide information and context to aid in measuring impact. Make sure to practice and build relationships with the developers and application owners before you rely on their expertise for incident response. Application owners or SMEs, such as your cloud administrators or engineers, might need to act in situations where the environment is unfamiliar or has complexity, or where the responders don’t have access. Lastly, trusted relationships might be involved in the investigation or response because they can provide additional expertise and valuable scrutiny. When you don’t have these skills on your own team, you might want to hire an external party for assistance. Train incident response staﬀ Training your incident response staﬀ on the technologies their organization uses will be crucial for them to adequately respond to a security event. Responses might be prolonged if your staﬀ members don’t understand the underlying technologies. In addition to traditional incident response concepts, it’s also important that they understand AWS services and their AWS People Version December 1, 2024 96 AWS Security Incident Response User Guide environment. There are a number of traditional mechanisms to train your incident staﬀ, such as online training and classroom training. You should also consider running gamedays or simulations as a mechanism for training. For details on how to run simulations, see the the section called “Run regular simulations” section of this document. Understand AWS Cloud technologies To reduce dependencies and decrease response time, ensure that your security teams and responders are educated about cloud services and have opportunities for hands-on practice with the speciﬁc cloud environment that your organization uses. For incident responders to be eﬀective, it’s important to understand AWS foundations, IAM, AWS Organizations, AWS logging and monitoring services, and AWS security services. AWS provides online security workshops (refer to AWS Security Workshops) where you can get hands-on experiences with AWS security and monitoring services. AWS also provides a number of training options and learning paths through digital training, classroom training, AWS training partners, and certiﬁcations. To learn more, refer to AWS Training and Certiﬁcation. AWS provides both free and subscription based training supporting multiple personas and areas of focus. Visit AWS Skillbuilder to learn more. Understand your AWS environment In addition to understanding AWS services, their use cases, and how they integrate with each other, it’s equally important to understand how your organization’s AWS environment is actually architected and what operational processes are in place. Often, internal knowledge such as this is not documented and is understood by only a few domain experts, which can create dependencies, hinder innovation, and slow response time. To avoid these dependencies and quicken response times, internal knowledge of your AWS environment should be documented, accessible, and understood by your security analysts. Understanding your complete cloud footprint will require collaboration between relevant security stakeholders and cloud administrators. Part of preparing your processes for incident response includes documenting and centralizing architecture diagrams, which is the section called “Document and centralize architecture diagrams” later
sir-ug-038	sir-ug.pdf	38	architected and what operational processes are in place. Often, internal knowledge such as this is not documented and is understood by only a few domain experts, which can create dependencies, hinder innovation, and slow response time. To avoid these dependencies and quicken response times, internal knowledge of your AWS environment should be documented, accessible, and understood by your security analysts. Understanding your complete cloud footprint will require collaboration between relevant security stakeholders and cloud administrators. Part of preparing your processes for incident response includes documenting and centralizing architecture diagrams, which is the section called “Document and centralize architecture diagrams” later in this whitepaper. However, from a people perspective, it’s important that your analysts can access and understand the diagrams and operational processes related to your AWS environment. People Version December 1, 2024 97 AWS Security Incident Response User Guide Understand AWS response teams and support Support Support oﬀers a range of plans that provide access to tools and expertise that support the success and operational health of your AWS solutions. If you need technical support and more resources to help plan, deploy, and optimize your AWS environment, you can select a support plan that best aligns with your AWS use case. Consider the Support Center in the AWS Management Console (sign-in required) as the central point of contact to get support for issues that aﬀect your AWS resources. Access to Support is controlled by IAM. For more information about getting access to AWS Support features, refer to Getting started with Support. Additionally, if you need to report abuse, contact the AWS Tust and Safety team. AWS Customer Incident Response Team (CIRT) The AWS Customer Incident Response Team (CIRT) is a specialized always available global AWS team that provides support to customers during active security events on the customer side of the AWS Shared Responsibility Model. When the AWS CIRT supports you, you will receive assistance with triage and recovery for an active security event on AWS. They will assist in root cause analysis through the use of AWS service logs and provide you with recommendations for recovery. They will also provide security recommendations and best practices to help you avoid security events in the future. AWS customers can engage the AWS CIRT through an AWS support case. • All Customers: 1. Account and billing 2. Service: Account 3. Category: Security 4. Severity: General question • Customers with Developer Support plans: 1. Account and billing 2. Service: Account 3. Category: Security People Version December 1, 2024 98 AWS Security Incident Response User Guide 4. Severity: Important question • Customers with Business Support plans: 1. Account and billing 2. Service: Account 3. Category: Security 4. Severity: Urgent business impacting question • Customers with Enterprise Support plans: 1. Account and billing 2. Service: Account 3. Category: Security 4. Severity: Critical business risk question • Customers with AWS Security Incident Response subscriptions: Open the Security Incident Response console at https://console.aws.amazon.com/security-ir/ DDoS response support AWS oﬀers AWS Shield, which provides a managed distributed denial of service (DDoS) protection service that safeguards web applications running on AWS. AWS Shield provides always-on detection and automatic inline mitigations that can minimize application downtime and latency, so there is no need to engage Support to beneﬁt from DDoS protection. There are two tiers of AWS Shield: Shield Standard and Shield Advanced. To learn about the diﬀerences between these two tiers, refer to the Shield features documentation. AWS Managed Services (AMS) AWS Managed Services (AMS) provides ongoing management of your AWS infrastructure so you can focus on your applications. By implementing best practices to maintain your infrastructure, AMS helps reduce your operational overhead and risk. AMS automates common activities such as change requests, monitoring, patch management, security, and backup services, and provides full- lifecycle services to provision, run, and support your infrastructure. AMS takes responsibility for deploying a suite of security detective controls and provides an every day ﬁrst line of response to alerts. When an alert is initiated, AMS follows a standard set of People Version December 1, 2024 99 AWS Security Incident Response User Guide automated and manual playbooks to verify a consistent response. These playbooks are shared with AMS customers during onboarding so that they can develop and coordinate a response with AMS. Process Developing thorough and clearly deﬁned incident response processes is key to a successful and scalable incident response program. When a security event occurs, clear steps and workﬂows will help you to respond in a timely manner. You might already have an existing incident response processes. Regardless of your current state, it’s important to update, iterate, and test your incident response processes regularly. Develop and test an incident response plan The ﬁrst document to develop for incident response is the incident response plan. The incident response plan is designed to be the foundation for
sir-ug-039	sir-ug.pdf	39	and coordinate a response with AMS. Process Developing thorough and clearly deﬁned incident response processes is key to a successful and scalable incident response program. When a security event occurs, clear steps and workﬂows will help you to respond in a timely manner. You might already have an existing incident response processes. Regardless of your current state, it’s important to update, iterate, and test your incident response processes regularly. Develop and test an incident response plan The ﬁrst document to develop for incident response is the incident response plan. The incident response plan is designed to be the foundation for your incident response program and strategy. An incident response plan is a high-level document that typically includes these sections: • An incident response team overview – Outlines the goals and functions of the incident response team • Roles and responsibilities – Lists the incident response stakeholders and details their roles when an incident occurs • A communication plan – Details contact information and how you will communicate during an incident It’s a best practice to have out-of-band communication as a backup for incident communication. An example of an application that provides a secure out-of-band communications channel is AWS Wickr. • Phases of incident response and actions to take – Enumerates the phases of incident response – for example, detect, analyze, eradicate, contain, and recover – including high-level actions to take within those phases • Incident severity and prioritization deﬁnitions – Details how to classify the severity of an incident, how to prioritize the incident, and then how the severity deﬁnitions aﬀect escalation procedures While these sections are common throughout companies of diﬀerent sizes and industries, each organization’s incident response plan is unique. You will need to build an incident response plan that works best for your organization. Process Version December 1, 2024 100 AWS Security Incident Response User Guide Document and centralize architecture diagrams To quickly and accurately respond to a security event, you need to understand how your systems and networks are architected. Understanding these internal patterns is not only important for incident response, but also for verifying consistency across applications that the patterns are architected with, according to best practices. You should also verify that this documentation is up to date and regularly updated in accordance with new architecture patterns. You should develop documentation and internal repositories that detail items such as: • AWS account structure - You need to know: • How many AWS accounts do you have? • How are those AWS accounts organized? • Who are the business owners of the AWS accounts? • Do you use Service Control Policies (SCPs)? If so, what organizational guardrails are implemented by using SCPs? • Do you limit the Regions and services that can be used? • What diﬀerences are there between business units and environments (dev/test/prod)? • AWS service patterns • What AWS services do you use? • What are the most widely used AWS services? • Architecture patterns • What cloud architectures do you use? • AWS authentication patterns • How do your developers typically authenticate to AWS? • Do you use IAM roles or users (or both)? Is your authentication to AWS connected to an identity provider (IdP)? • How do you map an IAM role or user to an employee or system? • How does access get revoked when someone is no longer authorized? • AWS authorization patterns • What IAM policies do your developers use? • Do you use resource-based policies? • Logging and monitoring Process • What logging sources do you use and where are they stored? Version December 1, 2024 101 AWS Security Incident Response User Guide • Do you aggregate AWS CloudTrail logs? If so, where are they stored? • How do you query CloudTrail logs? • Do you have Amazon GuardDuty enabled? • How do you access GuardDuty ﬁndings (for example, console, ticketing system, SIEM)? • Are ﬁndings or events aggregated in a SIEM? • Are tickets automatically created? • What tooling is in place to analyze logs for an investigation? • Network topology • How are devices, endpoints, and connections on your network physically or logically arranged? • How does your network connect with AWS? • How is network traﬃc ﬁltered between environments? • External infrastructure • How are externally-facing applications deployed? • What AWS resources are publicly accessible? • What AWS accounts contain infrastructure that is externally facing? • What DDoS or external ﬁltering is there? Documenting internal technical diagrams and processes eases the incident response analyst’s job, helping them quickly obtain the institutional knowledge to respond to a security event. Thorough documentation of internal technical processes not only simpliﬁes security investigations, but also adjusts for rationalization and evaluation of the processes. Develop incident response playbooks A key part of preparing your incident response processes is developing
sir-ug-040	sir-ug.pdf	40	network traﬃc ﬁltered between environments? • External infrastructure • How are externally-facing applications deployed? • What AWS resources are publicly accessible? • What AWS accounts contain infrastructure that is externally facing? • What DDoS or external ﬁltering is there? Documenting internal technical diagrams and processes eases the incident response analyst’s job, helping them quickly obtain the institutional knowledge to respond to a security event. Thorough documentation of internal technical processes not only simpliﬁes security investigations, but also adjusts for rationalization and evaluation of the processes. Develop incident response playbooks A key part of preparing your incident response processes is developing playbooks. Incident response playbooks provide a series of prescriptive guidance and steps to follow when a security event occurs. Having clear structure and steps simpliﬁes the response and reduces the likelihood for human error. What to create playbooks for Playbooks should be created for incident scenarios such as: • Expected incidents – Playbooks should be created for incidents you anticipate. This includes threats like denial of service (DoS), ransomware, and credential compromise. Process Version December 1, 2024 102 AWS Security Incident Response User Guide • Known security ﬁndings or alerts – Playbooks should be created for your known security ﬁndings and alerts, such as GuardDuty ﬁndings. You might receive a GuardDuty ﬁnding and think, “Now what?” To prevent mishandling of a GuardDuty ﬁnding or ignoring the ﬁnding, create a playbook for each potential GuardDuty ﬁnding. Some remediation details and guidance can be found in the GuardDuty documentation. It’s worth noting that GuardDuty is not enabled by default and does incur a cost. More details on GuardDuty can be found in Appendix A: Cloud capability deﬁnitions - the section called “Visibility and alerting”. What to include in playbooks Playbooks should contain technical steps for a security analyst to complete in order to adequately investigate and respond to a potential security incident. Items to include in a playbook include: • Playbook overview – What risk or incident scenario does this playbook address? What is the goal of the playbook? • Prerequisites – What logs and detection mechanisms are required for this incident scenario? What is the expected notiﬁcation? • Stakeholder information – Who is involved and what is their contact information? What are each of the stakeholders’ responsibilities? • Response steps – Across phases of incident response, what tactical steps should be taken? What queries should an analyst run? What code should be run to achieve the desired outcome? • Detect – How will the incident be detected? • Analyze – How will the scope of impact be determined? • Contain – How will the incident be isolated to limit scope? • Eradicate – How will the threat be removed from the environment? • Recover – How will the aﬀected system or resource be brought back into production? • Expected outcomes – After queries and code are run, what is the expected result of the playbook? To verify consistent information in each playbook, it can be helpful to create a playbook template to use across your other security playbooks. Some of the previously listed items, such as stakeholder information, can be shared across multiple playbooks. If that is the case, you can create centralized documentation for that information and reference it in the playbook, then enumerate the explicit diﬀerences in the playbook. This will prevent you from having to Process Version December 1, 2024 103 AWS Security Incident Response User Guide update the same information in all of your individual playbooks. Through creating a template and identifying common or shared information in playbooks, you can simplify and speed up playbook development. Lastly, your playbooks will likely evolve over time; once you have conﬁrmed that the steps are consistent, this forms the requirements for automation. Sample playbooks A number of sample playbooks can be found in Appendix B in the section called “Playbook resources”. The examples here can be used to guide you on what playbooks to create and what to include in your playbooks. However, it’s important you craft playbooks that incorporate the risks most relevant to your business. You need to verify that the steps and workﬂows within your playbooks include your technologies and processes. Run regular simulations Organizations grow and evolve over time, as does the threat landscape. Because of this, it’s important to continually review your incident response capabilities. Simulations are one method that can be used to perform this assessment. Simulations use real-world security event scenarios designed to mimic a threat actor’s tactics, techniques, and procedures (TTPs) and allow an organization to exercise and evaluate their incident response capabilities by responding to these mock cyber events as they might occur in reality. Simulations have a variety of beneﬁts, including: • Validating cyber readiness and developing the conﬁdence of your incident responders. • Testing the accuracy and eﬃciency of
sir-ug-041	sir-ug.pdf	41	evolve over time, as does the threat landscape. Because of this, it’s important to continually review your incident response capabilities. Simulations are one method that can be used to perform this assessment. Simulations use real-world security event scenarios designed to mimic a threat actor’s tactics, techniques, and procedures (TTPs) and allow an organization to exercise and evaluate their incident response capabilities by responding to these mock cyber events as they might occur in reality. Simulations have a variety of beneﬁts, including: • Validating cyber readiness and developing the conﬁdence of your incident responders. • Testing the accuracy and eﬃciency of tools and workﬂows. • Reﬁning communication and escalation methods aligned with your incident response plan. • Providing an opportunity to respond to less common vectors. Types of simulations There are three main types of simulations: • Tabletop exercises – The tabletop approach to simulations is strictly a discussion-based session involving the various incident response stakeholders to practice roles and responsibilities and use established communication tools and playbooks. Exercise facilitation can typically be accomplished in a full day in a virtual venue, a physical venue, or a combination. Because of its discussion-based nature, the tabletop exercise focuses on processes, people, and collaboration. Process Version December 1, 2024 104 AWS Security Incident Response User Guide Technology is an integral part of the discussion; however, the actual use of incident response tools or scripts is generally not a part of the tabletop exercise. • Purple Team exercises – Purple Team exercises increase the level of collaboration between the incident responders (Blue Team) and simulated threat actors (Red Team). The Blue Team is generally comprised of members of the Security Operations Center (SOC), but can also include other stakeholders that would be involved during an actual cyber event. The Red Team is generally comprised of a penetration testing team or key stakeholders that are trained in oﬀensive security. The Red Team works collaboratively with the exercise facilitators when designing a scenario so that the scenario is accurate and feasible. During Purple Team exercises, the primary focus is on the detection mechanisms, the tools, and the standard operating procedures (SOPs) supporting the incident response eﬀorts. • Red Team exercises – During a Red Team exercise, the oﬀense (Red Team) conducts a simulation to achieve a certain objective or set of objectives from a pre-determined scope. The defenders (Blue Team) will not necessarily know the scope and duration of the exercise, which provides a more realistic assessment of how they would respond to an actual incident. Because Red Team exercises can be invasive tests, you should be cautious and implement controls to verify that the exercise does not cause actual harm to your environment. Note AWS requires customers to review the policy for penetration testing available on the Penetration Testing website before they conduct Purple Team or Red Team exercises. Table 1 summarizes a few key diﬀerences in these types of simulations. It’s important to note that the deﬁnitions are generally considered loose deﬁnitions and can be customized to ﬁt the needs of your organization. Table 1 – Types of simulations Summary Tabletop exercise Purple Team exercise Red Team exercise Paper-driven exercises that focus on one speciﬁc security incident A more realistic oﬀering compared to tabletop exercises . During Purple Team Generally a more advanced simulatio n oﬀering. There is usually a high level scenario. These can exercises, facilitators of covertness, where Process Version December 1, 2024 105 AWS Security Incident Response User Guide Tabletop exercise Purple Team exercise Red Team exercise be either high-level work collaboratively the participants or technical, and are driven by a series of with the participants to increase exercise might not know all of the details of the paper injects. engagement and exercise. oﬀer training where necessary. Resources required Limited technical resources required Various stakeholders required and high Various stakeholders required and high level of technical level of technical resources needed resources needed Complexity Low Medium High Consider facilitating cyber simulations at a regular interval. Each exercise type can provide unique beneﬁts to the participants and the organization as a whole, so you might choose to start with less complex simulation types (such as tabletop exercises) and progress to more complex simulation types (Red Team exercises). You should select a simulation type based on your security maturity, resources, and your desired outcomes. Some customers might not choose to perform Red Team exercises due to complexity and cost. Exercise lifecycle Regardless of the type of simulation you choose, simulations generally follow these steps: 1. Deﬁne core exercise elements – Deﬁne the simulation scenario and the objectives of the simulation. Both of these should have leadership acceptance. 2. Identify key stakeholders – At a minimum, an exercise needs exercise facilitators and participants. Depending on the scenario, additional stakeholders such as legal, communications, or
sir-ug-042	sir-ug.pdf	42	simulation types (Red Team exercises). You should select a simulation type based on your security maturity, resources, and your desired outcomes. Some customers might not choose to perform Red Team exercises due to complexity and cost. Exercise lifecycle Regardless of the type of simulation you choose, simulations generally follow these steps: 1. Deﬁne core exercise elements – Deﬁne the simulation scenario and the objectives of the simulation. Both of these should have leadership acceptance. 2. Identify key stakeholders – At a minimum, an exercise needs exercise facilitators and participants. Depending on the scenario, additional stakeholders such as legal, communications, or executive leadership might be involved. 3. Build and test the scenario – The scenario might need to be redeﬁned as it is being built if speciﬁc elements aren’t feasible. A ﬁnalized scenario is expected as the output of this stage. 4. Facilitate the simulation – The type of simulation determines the facilitation used (paper- based scenario compared to highly technical, simulated scenario). The facilitators should align their facilitation tactics to the exercise objects and they should engage all exercise participants wherever possible to provide the most beneﬁt. Process Version December 1, 2024 106 AWS Security Incident Response User Guide 5. Develop the after action report (AAR) – Identify areas that went well, those that can use improvement, and potential gaps. The AAR should measure the eﬀectiveness of the simulation as well as the team’s response to the simulated event so that progress can be tracked over time with future simulations. Technology If you develop and implement the appropriate technologies before a security incident, your incident response staﬀ will be able to investigate, understand the scope, and take action in a timely manner. Develop AWS account structure AWS Organizations helps centrally manage and govern an AWS environment as you grow and scale AWS resources. An AWS organization consolidates your AWS accounts so that you can administer them as a single unit. You can use organizational units (OUs) to group accounts together to administer as a single unit. For incident response, it’s helpful to have an AWS account structure that supports the functions of incident response, which includes a security OU and a forensics OU. Within the security OU, you should have accounts for: • Log archival – Aggregate logs in a log archival AWS account. • Security tooling – Centralize security services in a security tool AWS account. This account operates as the delegated administrator for security services. Within the forensics OU, you have the option to implement a single forensics account or accounts for each Region that you operate in, depending on which works best for your business and operational model. For an example of a per-Region account approach, if you only operate in US East (N. Virginia) (us-east-1) and US West (Oregon) (us-west-2), then you would have two accounts in the forensics OU: one for us-east-1 and one for us-west-2. Because it takes time to provision new accounts, it is imperative to create and instrument the forensics accounts well ahead of an incident so that responders can be prepared to eﬀectively use them for response. The following diagram displays a sample account structure including a forensics OU with per- Region forensics accounts: Technology Version December 1, 2024 107 AWS Security Incident Response User Guide Per-region account structure for incident response Develop and implement a tagging strategy Obtaining contextual information on the business use case and relevant internal stakeholders surrounding an AWS resource can be diﬃcult. One way to do this is in the form of tags, which assign metadata to your AWS resources and consist of a user-deﬁned key and value. You can create tags to categorize resources by purpose, owner, environment, type of data processed, and other criteria of your choice. Having a consistent tagging strategy can speed up response times by allowing you to quickly identify and discern contextual information about an AWS resource. Tags can also serve as a mechanism to initiate response automations. For further information on what to tag, refer to the documentation on tagging AWS resources. You’ll want to ﬁrst deﬁne the tags you want to implement across your organization. After that, you’ll implement and enforce this tagging strategy. Details on implementation and enforcement can be found in the AWS blog Implement AWS resource tagging strategy using AWS Tag Policies and Service Control Policies (SCPs). Technology Version December 1, 2024 108 AWS Security Incident Response User Guide Update AWS account contact information For each of your AWS accounts, it’s important to have accurate and up-to-date contact information so that the correct stakeholders receive important notiﬁcations from AWS on topics like security, billing, and operations. For each AWS account, you have a primary contact and alternate contacts for security, billing, and operations. Diﬀerences between these contacts can be found in the AWS Account Management
sir-ug-043	sir-ug.pdf	43	enforcement can be found in the AWS blog Implement AWS resource tagging strategy using AWS Tag Policies and Service Control Policies (SCPs). Technology Version December 1, 2024 108 AWS Security Incident Response User Guide Update AWS account contact information For each of your AWS accounts, it’s important to have accurate and up-to-date contact information so that the correct stakeholders receive important notiﬁcations from AWS on topics like security, billing, and operations. For each AWS account, you have a primary contact and alternate contacts for security, billing, and operations. Diﬀerences between these contacts can be found in the AWS Account Management Reference Guide. For details on managing alternate contacts, refer to the AWS documentation on adding, changing, or removing alternate contacts. It’s a best practice to use an email distribution list if your team manages billing, operations, and security-related issues. An email distribution list removes dependencies on one person, which can cause blockages if they are out of the oﬃce or leave the company. You should also verify that the email and account contact information, including the phone number, are well protected to defend against root account password resets and multi-factor authentication (MFA) resets. For customers using AWS Organizations, organization administrators can centrally manage alternate contacts for member accounts using the management account or a delegated administrator account without requiring credentials for each AWS account. You will also need to verify that newly created accounts have accurate contact information. Refer to the Automatically update alternate contacts for newly created AWS accounts blog post. Prepare access to AWS accounts During an incident, your incident response teams must have access to the environments and resources involved in the incident. Ensure that your teams have appropriate access to perform their duties before an event occurs. To do that, you should know what level of access your team members require (for example, what kinds of actions they are likely to take) and should provision least privilege access in advance. To implement and provision this access, you should identify and discuss the AWS account strategy and cloud identity strategy with your organization's cloud architects to understand what authentication and authorization methods are conﬁgured. Due to the privileged nature of these credentials, you should consider using approval ﬂows or retrieving credentials from a vault or safe as part of your implementation. After implementation, you should document and test the team members’ access well before an event occurs to make sure they can respond without delays. Lastly, users that are created speciﬁcally to respond to a security incident are often privileged in order to provide suﬃcient access. Therefore, use of these credentials should be restricted, monitored, and not used for daily activities. Technology Version December 1, 2024 109 AWS Security Incident Response User Guide Understand the threat landscape Develop threat models By developing threat models, organizations can identify threats and mitigations before an unauthorized user can. There are a number of strategies and approaches to threat modeling; refer to the How to approach threat modeling blog post. For incident response, a threat model can help identify the attack vectors a threat actor might have used during an incident. Understanding what you’re defending against will be crucial in order to respond in a timely manner. You can also use an AWS Partner for threat modeling. To search for an AWS partner, use the AWS Partner Network. Integrate and use cyber threat intelligence Cyber threat intelligence is the data and analysis of a threat actor’s intent, opportunity, and capability. Obtaining and using threat intelligence is helpful to detect an incident early and to better understand threat actor behavior. Cyber threat intelligence includes static indicators like IP addresses or ﬁle hashes of malware. It also includes high-level information, like behavioral patterns and intent. You can collect threat intelligence from a number of cyber security vendors and from open-source repositories. To integrate and maximize threat intelligence for your AWS environment, you can use some out-of- the-box capabilities and integrate your own threat intelligence lists. Amazon GuardDuty uses AWS internal and third-party threat intelligence sources. Other AWS services, such as a DNS ﬁrewall and AWS WAF rules, also take inputs from AWS' advanced threat intelligence group. Some GuardDuty ﬁndings are mapped to the MITRE ATT&CK Framework, which provides information on real-world observations on adversary tactics and techniques. Select and set up logs for analysis and alerting During a security investigation, you need to be able to review relevant logs to record and understand the full scope and timeline of the incident. Logs are also required for alert generation, indicating certain actions of interest have happened. It is critical to select, enable, store, and set up querying and retrieval mechanisms, and set up alerting. Each of these actions are reviewed in this section. For more details, see the Logging strategies for security incident response
sir-ug-044	sir-ug.pdf	44	MITRE ATT&CK Framework, which provides information on real-world observations on adversary tactics and techniques. Select and set up logs for analysis and alerting During a security investigation, you need to be able to review relevant logs to record and understand the full scope and timeline of the incident. Logs are also required for alert generation, indicating certain actions of interest have happened. It is critical to select, enable, store, and set up querying and retrieval mechanisms, and set up alerting. Each of these actions are reviewed in this section. For more details, see the Logging strategies for security incident response AWS blog post. Select and enable log sources Ahead of a security investigation, you need to capture relevant logs to retroactively reconstruct activity in an AWS account. Select and enable log sources relevant to their AWS account workloads. Technology Version December 1, 2024 110 AWS Security Incident Response User Guide AWS CloudTrail is a logging service that tracks API calls made against an AWS account capturing AWS service activity. It is enabled by default with 90-day retention of management events that can be retrieved through CloudTrail’s Event History facility using AWS Management Console, the AWS CLI, or an AWS SDK. For longer retention and visibility of data events, you need to create a CloudTrail Trail and associated with an Amazon S3 bucket, and optionally, with a CloudWatch log group. Alternatively, you can create a CloudTrail Lake, which retains CloudTrail logs for up to seven years and provides a SQL-based querying facility. AWS recommends that customers using a VPC enable network traﬃc and DNS logs using, respectively, VPC Flow Logs and Amazon Route 53 resolver query logs, streaming them to either an Amazon S3 bucket or a CloudWatch log group. You can create a VPC ﬂow log for a VPC, a subnet, or a network interface. For VPC Flow Logs, you can be selective on how and where you enable Flow Logs to reduce cost. AWS CloudTrail Logs, VPC Flow Logs, and Route 53 resolver query logs are the basic logging trifecta to support security investigations in AWS. AWS services can generate logs not captured by the basic logging trifecta, such as Elastic Load Balancing logs, AWS WAF logs, AWS Conﬁg recorder logs, Amazon GuardDuty ﬁndings, Amazon Elastic Kubernetes Service (Amazon EKS) audit logs, and Amazon EC2 instance operating system and application logs. Refer to the section called “Appendix A: Cloud capability deﬁnitions” for the full list of logging and monitoring options. Select log storage The choice of log storage is generally related to which querying tool you use, retention capabilities, familiarity, and cost. When you enable AWS service logs, provide a storage facility; usually an Amazon S3 bucket or CloudWatch log group. An Amazon S3 bucket provides cost-eﬀective durable storage with an optional lifecycle policy. Logs stored in Amazon S3 buckets can be natively queried using services such as Amazon Athena. A CloudWatch log group provides durable storage and a built-in query facility through CloudWatch Logs Insights. Identify appropriate log retention When you use an S3 bucket or CloudWatch log group to store logs, you must establish adequate lifecycles for each log source to optimize storage and retrieval costs. Customers generally have between 3 and 12 months of logs readily available for querying, with retention of up to seven Technology Version December 1, 2024 111 AWS Security Incident Response User Guide years. The choice of availability and retention should align with your security requirements and a composite of statutory, regulatory, and business mandates. Select and implement querying mechanisms for logs In AWS, the main services you can use to query logs are CloudWatch Logs Insights for data stored in CloudWatch log groups, and Amazon Athena and Amazon OpenSearch Service for data stored in Amazon S3. You can also use third-party querying tools such as a security information and event management (SIEM). The process for selecting a log querying tool should consider the people, process, and technology aspects of your security operations. Select a tool that fulﬁlls operational, business, and security requirements, and is both accessible and maintainable in the long term. Keep in mind that log querying tools work optimally when the number of logs to be scanned is kept within the tool’s limits. It is not uncommon for customers to have multiple querying tools because of cost or technical constraints. For example, customers might use a third-party SIEM to perform queries for the last 90 days of data, and use Athena to perform queries beyond 90 days because of the log ingestion cost of a SIEM. No matter the implementation, verify that your approach minimizes the number of tools required to maximize operational eﬃciency, especially during a security event investigation. Use logs for alerting AWS natively provides alerting through security services, such as Amazon GuardDuty, AWS Security Hub, and
sir-ug-045	sir-ug.pdf	45	within the tool’s limits. It is not uncommon for customers to have multiple querying tools because of cost or technical constraints. For example, customers might use a third-party SIEM to perform queries for the last 90 days of data, and use Athena to perform queries beyond 90 days because of the log ingestion cost of a SIEM. No matter the implementation, verify that your approach minimizes the number of tools required to maximize operational eﬃciency, especially during a security event investigation. Use logs for alerting AWS natively provides alerting through security services, such as Amazon GuardDuty, AWS Security Hub, and AWS Conﬁg. You can also use custom alert generation engines for security alerts not covered by these services or for speciﬁc alerts relevant to your environment. Building these alerts and detections is covered in the section called the section called “Detection” in this document. Develop forensics capabilities Ahead of a security incident, consider developing forensics capabilities to support security event investigations. The Guide to Integrating Forensic Techniques into Incident Response by NIST provides such guidance. Forensics on AWS Concepts from traditional on-premises forensics apply to AWS. The Forensic investigation environment strategies in the AWS Cloud blog post provides you with key information to start migrating their forensic expertise to AWS. Technology Version December 1, 2024 112 AWS Security Incident Response User Guide Once you have your environment and AWS account structure set up for forensics, you’ll want to deﬁne the technologies required to eﬀectively perform forensically sound methodologies across the four phases: • Collection – Collect relevant AWS logs, such as AWS CloudTrail, AWS Conﬁg, VPC Flow Logs, and host-level logs. Collect snapshots, backups, and memory dumps of impacted AWS resources. • Examination – Examine the data collected by extracting and assessing the relevant information. • Analysis – Analyze the data collected in order to understand the incident and draw conclusions from it. • Reporting – Present the information resulting from the analysis phase. Capture backups and snapshots Setting up backups of key systems and databases are critical for recovering from a security incident and for forensics purposes. With backups in place, you can restore your systems to their previous safe state. On AWS, you can take snapshots of various resources. Snapshots provide you with point- in-time backups of those resources. There are many AWS services that can support you in backup and recovery. Refer to the Backup and Recovery Prescriptive Guidance for details on these services and approaches for backup and recovery. For more details, see the Use backups to recover from security incidents blog post. Especially when it comes to situations such as ransomware, it’s critical for your backups to be well protected. Refer to the Top 10 security best practices for securing backups in AWS blog post for guidance on securing your backups. In addition to securing your backups, you should regularly test your backup and restore processes to verify that the technology and processes you have in place work as expected. Automation of forensics on AWS During a security event, your incident response team must be able to collect and analyze evidence quickly while maintaining accuracy for the time period surrounding the event. It’s both challenging and time consuming for the incident response team to manually collect the relevant evidence in a cloud environment, especially across a large number of instances and accounts. Additionally, manual collection can be prone to human error. For these reasons, customers should develop and implement automation for forensics. AWS oﬀers a number of automation resources for forensics, which are consolidated in the Appendix under the section called “Forensic resources”. These resources are examples of forensics patterns that we have developed and customers have implemented. While they might be a useful Technology Version December 1, 2024 113 AWS Security Incident Response User Guide reference architecture to start with, consider modifying them or creating new forensics automation patterns based on your environment, requirements, tools, and forensics processes. Summary of preparation items Thorough preparation for responding to security events is critical for timely and eﬀective incident response. Incident response preparation involves people, processes, and technology. All three of these domains are equally important to preparation. You should prepare and evolve your incident response program across all three domains. Table 2 summarizes the preparation items detailed in this section. Table 2 – Incident response preparation items Domain People Preparation item Action items Deﬁne roles and responsib ilities. • Identify relevant incident response stakeholders. • Develop a responsible, accountable, informed, consulted (RACI) chart for an incident. People Train incident response staﬀ on AWS. • Train incident response stakeholders on AWS foundations. • Train incident response stakeholders on AWS security and monitoring services. • Train incident response stakeholders on your AWS environment and how it is architected. People Understand AWS support options. • Understand diﬀerences in AWS
sir-ug-046	sir-ug.pdf	46	across all three domains. Table 2 summarizes the preparation items detailed in this section. Table 2 – Incident response preparation items Domain People Preparation item Action items Deﬁne roles and responsib ilities. • Identify relevant incident response stakeholders. • Develop a responsible, accountable, informed, consulted (RACI) chart for an incident. People Train incident response staﬀ on AWS. • Train incident response stakeholders on AWS foundations. • Train incident response stakeholders on AWS security and monitoring services. • Train incident response stakeholders on your AWS environment and how it is architected. People Understand AWS support options. • Understand diﬀerences in AWS support, Customer Incident Response Team Summary of preparation items Version December 1, 2024 114 AWS Security Incident Response User Guide Domain Preparation item Action items Process Develop an incident response plan. (CIRT), DDoS response team (DRT) and AMS. • Understand the triage and escalation path to reach the CIRT during an active security event if needed. • Create a high-level document that deﬁnes your incident response program and strategy. • Include a RACI, communica tion plan, incident deﬁnitio ns, and phases of incident response to the incident response plan. Process Document and centralize architecture diagrams. • Document details on how your AWS environment is conﬁgured across account structure, service usages, IAM patterns, and other core functionality to your AWS conﬁguration. • Develop architecture diagrams of your cloud architectures. Process Develop incident response playbooks. • Create a template for the structure of your playbooks. • Build playbooks for expected security events. • Build playbooks for known security alerts, such as GuardDuty ﬁndings. Summary of preparation items Version December 1, 2024 115 AWS Security Incident Response User Guide Domain Process Preparation item Action items Run regular simulations. • Develop a regular cadence to run incident simulations. • Use the outputs and lessons learned to iterate on your incident response program. Technology Develop an AWS account structure. • Plan an account structure for how workloads are separated by AWS accounts. • Create a security OU with a security tooling and log archival account. • Create a forensics OU with forensics accounts for each Region in which you operate. Technology Develop and implement a tagging strategy that • Plan a strategy for tagging and what tags you want helps responders to identify associated with your AWS ownership and context for resources. ﬁndings. • Implement and enforce the tagging strategy. Summary of preparation items Version December 1, 2024 116 AWS Security Incident Response User Guide Domain Technology Preparation item Action items Update AWS account contact information. • Verify that AWS accounts have contact information Technology Prepare access to AWS accounts. listed. • Create email distribut ion lists for the contact information to remove single points of failure. • Protect the email accounts that are associated with the AWS account information. • Deﬁne what access incident responders will require to respond to an incident. • Implement, test, and monitor the access. Technology Understand the threat landscape. • Develop threat models of your environment and applications. • Integrate and use cyber threat intelligence. Technology Select and set up logs. • Identify and enable logs for investigations. • Select log storage. • Identify and implement log retention. • Develop a mechanism to retrieve and query logs and artifacts. • Use logs for alerting. Summary of preparation items Version December 1, 2024 117 AWS Security Incident Response User Guide Domain Preparation item Action items Technology Develop forensics capabilities. • Identify artifacts required for forensics collection. • Capture and secure backups of key systems. • Deﬁne mechanisms for analysis of identiﬁed logs and artifacts. • Implement automation for forensics analysis. An iterative approach is recommended for incident response preparation. All of these preparation items cannot be done overnight; you should create a plan to start small and continuously improve your incident response capabilities over time. Operations Operations is the core of performing incident response. This is where the actions of responding and remediating security incidents occur. Operations includes the following ﬁve phases: detection, analysis, containment, eradication, and recovery. Descriptions of these phases and the goals can be found in Table 3. Table 3 – Operations phases Phase Detection Analysis Containment Goal Identify a potential security event. Determine if a security event is an incident and assess the scope of the incident. Minimize and limit the scope of the security event. Operations Version December 1, 2024 118 AWS Security Incident Response User Guide Phase Eradication Recovery Goal Remove unauthorized resources or artifacts related to the security event. Implement mitigations that caused the security incident. Restore systems to a known safe state and monitor these systems to verify that the threat does not return. The phases should serve as guidance when you respond to and operate on security incidents in order to respond in an eﬀective and robust way. The actual actions
sir-ug-047	sir-ug.pdf	47	event is an incident and assess the scope of the incident. Minimize and limit the scope of the security event. Operations Version December 1, 2024 118 AWS Security Incident Response User Guide Phase Eradication Recovery Goal Remove unauthorized resources or artifacts related to the security event. Implement mitigations that caused the security incident. Restore systems to a known safe state and monitor these systems to verify that the threat does not return. The phases should serve as guidance when you respond to and operate on security incidents in order to respond in an eﬀective and robust way. The actual actions you take will vary depending on the incident. An incident involving ransomware, for example, will have a diﬀerent set of response steps to follow than an incident involving a public Amazon S3 bucket. Additionally, these phases do not necessarily happen sequentially. After containment and eradication, you might need to return to analysis to understand if your actions were eﬀective. Detection An alert is the main component of the detection phase. It generates a notiﬁcation to initiate the incident response process based on AWS account activity of interest. Alerting accuracy is challenging; it’s not always possible to determine with complete certainty if an incident has occurred, is in progress, or if it will happen in the future. Here are a few reasons: • Detection mechanisms are based on baseline deviation, known patterns, and notiﬁcation from internal or external entities. • Because of the unpredictable nature of technology and people, respectively the means and the actors of security incidents, baselines change over time. Rogue patterns emerge through novel or modiﬁed threat actor tactics, techniques, and procedures (TTPs). • Changes to people, technology, and processes are not immediately incorporated into the incident response process. Some are discovered during the progress of an investigation. Alert sources You should consider using the following sources to deﬁne alerts: Detection Version December 1, 2024 119 AWS Security Incident Response User Guide • Findings – AWS services such as Amazon GuardDuty, AWS Security Hub, Amazon Macie, Amazon Inspector, AWS Conﬁg, IAM Access Analyzer, and Network Access Analyzer generate ﬁndings that can be used to craft alerts. • Logs – AWS service, infrastructure, and application logs stored in Amazon S3 buckets and CloudWatch log groups can be parsed and correlated to generate alerts. • Billing activity – A sudden change in billing activity can indicate a security event. Follow the documentation on Creating a billing alarm to monitor your estimated AWS charges to monitor for this. • Cyber threat intelligence – If you subscribe to a third-party cyber threat intelligence feed, you can correlate that information with other logging and monitoring tools to identify potential indicators of events. • Partner tools – Partners in the AWS Partner Network (APN) oﬀer top-tier products that can help you meet your security objectives. For incident response, partner products with endpoint detection and response (EDR) or SIEM can help support your incident response objectives. For more information, see Security Partner Solutions and Security Solutions in the AWS Marketplace. • AWS trust and safety – Support might contact customers if we identify abusive or malicious activity. • One-time contact – Because it can be your customers, developers, or other staﬀ in your organization who notice something unusual, it’s important to have a well-known, well-publicized method of contacting your security team. Popular choices include ticketing systems, contact email addresses, and web forms. If your organization works with the general public, you might also need a public-facing security contact mechanism. For more information about cloud capabilities that you can use during your investigations, refer to the section called “Appendix A: Cloud capability deﬁnitions” in this document. Detection as part of security control engineering Detection mechanisms are an integral part of security control development. As directive and preventative controls are deﬁned, related detective and responsive controls should be constructed. As an example, an organization establishes a directive control related to the root user of an AWS account, which should only be used for speciﬁc and very well-deﬁned activities. They associate it with a preventative control implemented by using an AWS organization’s service control policy (SCP). If root user activity beyond the expected baseline happens, a detective control implemented with an EventBridge rule and SNS topic will alert the security operations center (SOC). The Detection Version December 1, 2024 120 AWS Security Incident Response User Guide responsive control entails the SOC selecting the appropriate playbook, performing analysis, and working until the incident is resolved. Security controls are best deﬁned by threat modeling of workloads running in AWS. The criticality of detective controls will be set by looking at the business impact analysis (BIA) for the particular workload. Alerts generated by detective controls are not handled as they come in, but rather based on its initial criticality, to be
sir-ug-048	sir-ug.pdf	48	implemented with an EventBridge rule and SNS topic will alert the security operations center (SOC). The Detection Version December 1, 2024 120 AWS Security Incident Response User Guide responsive control entails the SOC selecting the appropriate playbook, performing analysis, and working until the incident is resolved. Security controls are best deﬁned by threat modeling of workloads running in AWS. The criticality of detective controls will be set by looking at the business impact analysis (BIA) for the particular workload. Alerts generated by detective controls are not handled as they come in, but rather based on its initial criticality, to be adjusted during analysis. The initial criticality set is an aid for prioritization; the context in which the alert happened will determine its true criticality. As an example, an organization uses Amazon GuardDuty as a component of the detective control used for EC2 instances that are part of a workload. The ﬁnding Impact:EC2/ SuspiciousDomainRequest.Reputation is generated, informing you that the listed Amazon EC2 instance within your workload is querying a domain name that is suspected of being malicious. This alert is set by default as low severity, and as the analysis phase progresses, it was determined that several hundred EC2 instances of type p4d.24xlarge have been deployed by an unauthorized actor, signiﬁcantly increasing the organization’s operating cost. At this point, the incident response team makes the decision to adjust the criticality of this alert to high, increasing the sense of urgency and expediting further actions. Note that the GuardDuty ﬁnding severity cannot be changed. Detective control implementations It is important to understand how detective controls are implemented because they help determine how the alert will be used for the particular event. There are two main implementations of technical detective controls: • Behavioral detection relies on mathematical models commonly referred to as machine learning (ML) or artiﬁcial intelligence (AI). The detection is made by inference; therefore, the alert might not necessarily reﬂect an actual event. • Rule-based detection is deterministic; customers can set the exact parameters of what activity to be alerted on, and that is certain. Modern implementations of detective systems, such as an intrusion detection system (IDS), generally come with both mechanisms. Following are some examples for rule-based and behavioral detections with GuardDuty. • When the ﬁnding Exfiltration:IAMUser/AnomalousBehavior is generated, it informs you that “an anomalous API request was observed in your account.” As you look further into the documentation, it tells you that “The ML model evaluates all API requests in your account and Detection Version December 1, 2024 121 AWS Security Incident Response User Guide identiﬁes anomalous events that are associated with techniques used by adversaries,” indicating that this ﬁnding is of a behavioral nature. • For the ﬁnding Impact:S3/MaliciousIPCaller, GuardDuty is analyzing API calls from the Amazon S3 service in CloudTrail, comparing the SourceIPAddress log element with a table of public IP addresses that includes threat intelligence feeds. Once it ﬁnds a direct match to an entry, it generates the ﬁnding. We recommend implementing a mix of both behavioral and rule-based alerting because it is not always possible to implement rule-based alerting for every activity within your threat model. People-based detection Up to this point, we have discussed technology-based detection. The other important source of detection comes from people inside or outside the customer’s organization. Insiders can be deﬁned as an employee or contractor, and outsiders are entities such as security researchers, law enforcement, the news, and social media. Though technology-based detection can be systematically conﬁgured, people-based detection comes in a variety of forms such as emails, tickets, mail, news posts, telephone calls, and in-person interactions. Technology-based detection notiﬁcations can be expected to be delivered in near real-time, but there are no timeline expectations for people-based detection. It is imperative that the security culture incorporates, facilitates, and empowers people-based detection mechanisms for a defense in depth approach to security. Summary With detection, it’s important to have a mix of rule-based and behavioral driven alerting. Additionally, you should have mechanisms in place for people both internally and externally to submit a ticket about a security issue. Humans can be one of the most valuable sources for security events, so it’s important to have processes in place for people to escalate concerns. You should use threat models of your environment to get started with building detections. Threat models will help you build alerts based on threats that are most relevant to your environment. Lastly, you can use frameworks such as MITRE ATT&CK to understand threat actor tactics, techniques, and procedures (TTPs). The MITRE ATT&CK framework can be helpful to use as a common language across your various detection mechanisms. Detection Version December 1, 2024 122 AWS Security Incident Response User Guide Analysis Logs, query capabilities, and threat intelligence are a few of the supporting components required by the analysis
sir-ug-049	sir-ug.pdf	49	to escalate concerns. You should use threat models of your environment to get started with building detections. Threat models will help you build alerts based on threats that are most relevant to your environment. Lastly, you can use frameworks such as MITRE ATT&CK to understand threat actor tactics, techniques, and procedures (TTPs). The MITRE ATT&CK framework can be helpful to use as a common language across your various detection mechanisms. Detection Version December 1, 2024 122 AWS Security Incident Response User Guide Analysis Logs, query capabilities, and threat intelligence are a few of the supporting components required by the analysis phase. Many of the same logs used for detection are also used for analysis and will require onboarding and conﬁguration of querying tools. Validate, scope, and assess impact of alert During the analysis phase, comprehensive log analysis is performed with the goal to validate alerts, deﬁne scope, and assess the impact of the possible compromise. • Validation of the alert is the entry point of the analysis phase. Incident responders will be looking for log entries from various sources and directly engaging with owners of the aﬀected workload. • Scoping is the next step, when all resources involved are inventoried and alert criticality is adjusted after stakeholders agree that it is unlikely to be a false-positive. • Finally, impact analysis details the actual business disruption. Once the aﬀected workload components are identiﬁed, scoping results can be correlated with the related workload’s recovery point objective (RPO) and recovery time objective (RTO), adjusting for alert criticality, which will initiate resource allocation and all activity happening next. Not all incidents will directly disrupt operations of a workload supporting a business process. Incidents such as sensitive data disclosure, intellectual property theft, or resource hijacking (as in cryptocurrency mining) might not stop or debilitate a business process immediately, but can result in consequences at a later time. Enrich security logs and ﬁndings Enrichment with threat intelligence and organizational context During the course of analysis, observables of interest require enrichment for enhanced contextualization of the alert. As stated in the Preparation section, integrating and leveraging cyber threat intelligence can be helpful to understand more about a security ﬁnding. Threat intelligence services are used to assign reputation and attribute ownership to public IP addresses, domain names, and ﬁle hashes. These tools are available as paid and no charge services. Customers adopting Amazon Athena as a log querying tool gain the advantage of AWS Glue jobs to load threat intelligence information as tables. The threat intelligence tables can be used in SQL Analysis Version December 1, 2024 123 AWS Security Incident Response User Guide queries to correlate log elements such as IP addresses and domain names, providing an enriched view of the data to be analyzed. AWS does not provide threat intelligence directly to customers, but services such as Amazon GuardDuty makes use of threat intelligence for enrichment and ﬁnding generation. You can also upload custom threat lists to GuardDuty based on your own threat intelligence. Enrichment with automation Automation is an integral part of AWS Cloud governance. It can be used throughout the various phases of the incident response lifecycle. For the detection phase, rule-based automation matches patterns of interest from the threat model in logs and takes appropriate action, such as sending notiﬁcations. The analysis phase can leverage the detection mechanism and forward the alert body to an engine capable of querying logs and enriching observables for contextualization of the event. The alert body, in its fundamental form, is comprised of a resource and an identity. As an example, you could implement an automation to query CloudTrail for AWS API activity performed by the alert body’s identity or resource around the time of the alert, providing additional insights including eventSource, eventName, SourceIPAddress, and userAgent of identiﬁed API activity. By performing these queries in an automated way, responders can save time during triage and get additional context to help make better informed decisions. Refer to the How to enrich AWS Security Hub ﬁndings with account metadata blog post for an example on how to use automation to enrich security ﬁndings and simplify analysis. Collect and analyze forensic evidence Forensics, as mentioned in the the section called “Preparation” section of this document, is the process of collecting and analyzing artifacts during incident response. On AWS, it is applicable to infrastructure domain resources such as network traﬃc packet captures, operating system memory dump, and for service domain resources such as AWS CloudTrail logs. The forensics process has the following fundamental characteristics: • Consistent – It follows the exact steps documented, without deviations. • Repeatable – It produces the exact same results when repeated against the same artifact. • Customary – It’s publicly documented and widely adopted. Analysis Version December 1, 2024 124 AWS Security Incident Response User Guide It
sir-ug-050	sir-ug.pdf	50	section of this document, is the process of collecting and analyzing artifacts during incident response. On AWS, it is applicable to infrastructure domain resources such as network traﬃc packet captures, operating system memory dump, and for service domain resources such as AWS CloudTrail logs. The forensics process has the following fundamental characteristics: • Consistent – It follows the exact steps documented, without deviations. • Repeatable – It produces the exact same results when repeated against the same artifact. • Customary – It’s publicly documented and widely adopted. Analysis Version December 1, 2024 124 AWS Security Incident Response User Guide It is important to maintain a chain of custody for artifacts collected during incident response. Using automation and having automatic documentation of this collection generated can help, in addition to storing the artifacts in read-only repositories. Analysis should only be performed on exact replicas of the collected artifacts to maintain integrity. Collect relevant artifacts With these characteristics in mind, and based on the relevant alerts and assessment of impact and scope, you will need to collect the data that will be relevant to further investigation and analysis. Various types and sources of data that might be relevant to investigation, including service/control plane logs (CloudTrail, Amazon S3 data events, VPC Flow Logs), data (Amazon S3 metadata and objects), and resources (databases, Amazon EC2 instances). Service/control plane logs can be collected for local analysis or, ideally, directly queried using native AWS services (where applicable). Data (including metadata) can be directly queried to obtain relevant information or to acquire the source objects; for example, use the AWS CLI to acquire Amazon S3 bucket and object metadata and directly acquire source objects. Resources need to be collected in a manner consistent with the resource type and intended method of analysis. For example, databases can be collected by creating a copy/snapshot of the system running the database, creating a copy/snapshot of the entire database itself, or querying and extracting certain data and logs from the database relevant to the investigation. For Amazon EC2 instances, there is a speciﬁc set of data that should be collected and a speciﬁc order to collection that should be performed in order to acquire and preserve the most amount of data for analysis and investigation. Speciﬁcally, the order for response to acquire and preserve the most amount of data from an Amazon EC2 instance is the following: 1. Acquire instance metadata – Acquire instance metadata relevant to the investigation and data queries (instance ID, type, IP address, VPC/subnet ID, Region, Amazon Machine Image (AMI) ID, security groups attached, launch time). 2. Enable instance protections and tags – Enable instance protections like termination protection, setting shutdown behavior to stop (if set to terminate), disabling Delete on Termination attributes for the attached EBS volumes, and applying appropriate tags for both visual denotation and use in possible response automations (for example, upon applying a tag with name of Status and value of Quarantine, perform forensic acquisition of data and isolate the instance). Analysis Version December 1, 2024 125 AWS Security Incident Response User Guide 3. Acquire disk (EBS snapshots) – Acquire an EBS snapshot of the attached EBS volumes. Each snapshot contains the information that you need to restore your data (from the moment when the snapshot was taken) to a new EBS volume. See the step to perform live response/artifact collection if you’re using instance store volumes. 4. Acquire memory – Because EBS snapshots only capture data that has been written to your Amazon EBS volume, which might exclude data that is stored or cached in memory by your applications or OS, it is imperative to acquire a system memory image using an appropriate third-party open-source or commercial tool in order to acquire available data from the system. 5. (Optional) Perform live response/artifact collection – Perform targeted data collection (disk/ memory/logs) through live response on the system only if disk or memory is unable to be acquired otherwise, or there is a valid business or operational reason. Doing this will modify valuable system data and artifacts. 6. Decommission the instance – Detach the instance from Auto Scaling groups, deregister the instance from load balancers, and adjust or apply a pre-built instance proﬁle with minimized or no permissions. 7. Isolate or contain the instance – Verify that the instance is eﬀectively isolated from other systems and resources within the environment by ending and preventing current and future connections to and from the instance. Refer to the the section called “Containment” section of this document for more details. 8. Responder’s choice – Based on the situation and goals, select one of the following: • Decommission and shut down the system (recommended). Shut down the system once the available evidence has been acquired in order to verify the most eﬀective mitigation against a possible future impact
sir-ug-051	sir-ug.pdf	51	minimized or no permissions. 7. Isolate or contain the instance – Verify that the instance is eﬀectively isolated from other systems and resources within the environment by ending and preventing current and future connections to and from the instance. Refer to the the section called “Containment” section of this document for more details. 8. Responder’s choice – Based on the situation and goals, select one of the following: • Decommission and shut down the system (recommended). Shut down the system once the available evidence has been acquired in order to verify the most eﬀective mitigation against a possible future impact to the environment by the instance. • Continue running the instance within an isolated environment instrumented for monitoring. Though it is not recommended as a standard approach, if a situation merits continued observation of the instance (such as when additional data or indicators are needed to perform comprehensive investigation and analysis of the instance), you might consider shutting down the instance, creating an AMI of the instance, and re-launching the instance in your dedicated forensics account within a sandbox environment that is pre-instrumented to be completely isolated and conﬁgured with instrumentation to facilitate nearly continuous monitoring of the instance (for example, VPC Flow Logs or VPC Traﬃc Mirroring). Analysis Version December 1, 2024 126 AWS Security Incident Response User Guide Note It is essential to capture memory before live response activities or system isolation or shutdown in order to capture available volatile (and valuable) data. Develop narratives During analysis and investigation, document the actions taken, analysis performed, and information identiﬁed, to be used by the subsequent phases and ultimately a ﬁnal report. These narratives should be succinct and precise, conﬁrming that relevant information is included to verify eﬀective understanding of the incident and to maintain an accurate timeline. They are also helpful when you engage people outside of the core incident response team. Here is an example: The marketing and sales department received a ransom note on March 15th, 2022 demanding payment in cryptocurrency to avoid public posting of possible sensitive data. The SOC determined that the Amazon RDS database belonging to marketing and sales was publicly accessible on February 20th, 2022. The SOC queried RDS access logs and determined that IP address 198.51.100.23 was used on February 20th, 2022 with the credentials mm03434 belonging to Major Mary, one of the web developers. The SOC queried VPC Flow Logs and determined that approximately 256MB of data egressed to the same IP address at the same date (time stamp 2022-02-20T15:50+00Z). The SOC determined through open- source threat intelligence that the credentials are currently available in plain text in the public repository https[:]//example[.]com/majormary/rds-utils. Containment One deﬁnition of containment, as it relates to incident response, is the process or implementation of a strategy during the handling of a security event that acts to minimize the scope of the security event and contain the eﬀects of unauthorized usage within the environment. A containment strategy depends on a myriad of factors and can be diﬀerent from one organization to another in terms of application of containment tactics, timing, and purpose. The NIST SP 800-61 Computer Security Incident Handling Guide outlines several criteria for determining the appropriate containment strategy, which includes: • Potential damage to and theft of resources Containment Version December 1, 2024 127 AWS Security Incident Response User Guide • Need for evidence preservation • Service availability (network connectivity, services provided to external parties) • Time and resources needed to implement the strategy • Eﬀectiveness of the strategy (partial or full containment) • Duration of the solution (emergency workaround to be removed in four hours, temporary workaround to be removed in two weeks, permanent solution) Regarding services on AWS, however, the fundamental containment steps can be distilled down to three categories: • Source containment – Use ﬁltering and routing to prevent access from a certain source. • Technique and access containment – Remove access to prevent unauthorized access to the aﬀected resources. • Destination containment – Use ﬁltering and routing to prevent access to a target resource. Source containment Source containment is the use and application of ﬁltering or routing within an environment to prevent access to resources from a speciﬁc source IP address or network range. Examples of source containment using AWS services are highlighted here: • Security groups – Creating and applying isolation security groups to Amazon EC2 instances or removing rules from an existing security group can help to contain unauthorized traﬃc to an Amazon EC2 instance or AWS resource. It is important to note that existing tracked connections won’t be shut down as a result of changing security groups – only future traﬃc will be eﬀectively blocked by the new security group (refer to this Incident Response Playbook and Security group connection tracking for additional information on tracked and untracked
sir-ug-052	sir-ug.pdf	52	or network range. Examples of source containment using AWS services are highlighted here: • Security groups – Creating and applying isolation security groups to Amazon EC2 instances or removing rules from an existing security group can help to contain unauthorized traﬃc to an Amazon EC2 instance or AWS resource. It is important to note that existing tracked connections won’t be shut down as a result of changing security groups – only future traﬃc will be eﬀectively blocked by the new security group (refer to this Incident Response Playbook and Security group connection tracking for additional information on tracked and untracked connections). • Policies – Amazon S3 bucket policies can be conﬁgured to block or allow traﬃc from an IP address, a network range, or a VPC endpoint. Policies create the ability to block suspicious addresses and access to the Amazon S3 bucket. Additional information on bucket policies can be found at Adding a bucket policy using the Amazon S3 console. • AWS WAF – Web access control lists (web ACLs) can be conﬁgured on AWS WAF to provide ﬁne-grained control over web requests that resources respond to. You can add an IP address or network range to an IP set conﬁgured on AWS WAF, and apply match conditions, such as block, to the IP set. This will block web requests to a resource if the IP address or network ranges from the originating traﬃc match those conﬁgured in the IP set rules. Containment Version December 1, 2024 128 AWS Security Incident Response User Guide An example of source containment can be seen in the following diagram with an incident response analyst modifying a security group of an Amazon EC2 instance in order to restrict new connections to only certain IP addresses. As stated in the security groups bullet, existing tracked connections won’t be shut down as a result of changing security groups. Source containment example Note Security Groups and Network ACLs do not ﬁlter traﬃc to Amazon Route 53. When containing an EC2 instance, if you want to prevent it from contacting external hosts, ensure you also explicitly block DNS communications. Technique and access containment Prevent unauthorized use of a resource by limiting the functions and IAM principals with access to the resource. This includes restricting the permissions of IAM principals that have access to the resource; it also includes temporary security credentials revocation. Examples of technique and access containment using AWS services are highlighted here: • Restrict permissions – Permissions assigned to an IAM principal should follow the Principle of Least Privilege. However, during an active security event, you might need to restrict access to a targeted resource from a speciﬁc IAM principal even further. In this case, it is possible to contain access to a resource by removing the permissions from the IAM principal to be contained. This is done with the IAM service and can be applied using the AWS Management Console, the AWS CLI, or an AWS SDK. Containment Version December 1, 2024 129 AWS Security Incident Response User Guide • Revoke keys – IAM access keys are used by IAM principals to access or manage resources. These are long-term static credentials to sign programmatic requests to the AWS CLI or AWS API and begin with the preﬁx AKIA (for additional information, refer to the Understanding unique ID preﬁxes section in IAM identiﬁers). To contain access for an IAM principal where an IAM access key has been compromised, the access key can be deactivated or deleted. It is important to note the following: • An access key can be reactivated after it has been deactivated. • An access key is not recoverable once it has been deleted. • An IAM principal can have up to two access keys at any given time. • Users or applications using the access key will lose access once the key is either deactivated or deleted. • Revoke temporary security credentials – Temporary security credentials can be employed by an organization to control access to AWS resources and begin with the preﬁx ASIA (for additional information, see the Understanding unique ID preﬁxes section in IAM identiﬁers). Temporary credentials are typically used by IAM roles and do not have to be rotated or explicitly revoked because they have a limited lifetime. In cases where a security event occurs involving a temporary security credential before the temporary security credential expiration, you might need to alter the eﬀective permissions of the existing temporary security credentials. This can be completed using the IAM service within AWS Management Console. Temporary security credentials can also be issued to IAM users (as opposed to IAM roles); however, as of the time of this writing, there is no option to revoke the temporary security credentials for an IAM user within the AWS Management Console. For security events where a
sir-ug-053	sir-ug.pdf	53	or explicitly revoked because they have a limited lifetime. In cases where a security event occurs involving a temporary security credential before the temporary security credential expiration, you might need to alter the eﬀective permissions of the existing temporary security credentials. This can be completed using the IAM service within AWS Management Console. Temporary security credentials can also be issued to IAM users (as opposed to IAM roles); however, as of the time of this writing, there is no option to revoke the temporary security credentials for an IAM user within the AWS Management Console. For security events where a user’s IAM access key is compromised by an unauthorized user who created temporary security credentials, the temporary security credentials can be revoked using two methods: • Attach an inline policy to the IAM user that prevents access based on the security token issue time (refer to the Denying access to temporary security credentials issued before a speciﬁc time section in Disabling permissions for temporary security credentials for more detail). • Delete the IAM user that owns the compromised access keys. Re-create the user if needed. • AWS WAF - Certain techniques employed by unauthorized users include common malicious traﬃc patterns, such as requests that contain SQL injection and cross-site scripting (XSS). AWS WAF can be conﬁgured to match and deny traﬃc employing these techniques using the AWS WAF built-in rule statements. Containment Version December 1, 2024 130 AWS Security Incident Response User Guide An example of technique and access containment can be seen in the following diagram, with an incident responder rotating access keys or removing an IAM policy to prevent an IAM user from accessing an Amazon S3 bucket. Technique and access containment example Destination containment Destination containment is the application of ﬁltering or routing within an environment to prevent access to a targeted host or resource. In some cases, destination containment also involves a form of resiliency to verify that legitimate resources are replicated for availability; resources should be detached from these forms of resiliency for isolation and containment. Examples of destination containment using AWS services include: • Network ACLs – Network ACLs (network ACLs) that are conﬁgured on subnets that contain AWS resources can have deny rules added. These deny rules can be applied to prevent access to a particular AWS resource; however, applying network access control list (network ACL) will aﬀect every resource on the subnet, not only the resources that are being accessed without authorization. Rules listed within an network ACL are processed in top-down order, so the ﬁrst rule in an existing network ACL should be conﬁgured to deny unauthorized traﬃc to the targeted resource and subnet. Alternatively, a completely new network ACL can be created with a single deny rule for both inbound and outbound traﬃc and associated with the subnet containing the targeted resource to prevent access to the subnet using the new network ACL. • Shutdown – Shutting down a resource completely can be eﬀective at containing the eﬀects of unauthorized use. Shutting down a resource will also prevent legitimate access for business Containment Version December 1, 2024 131 AWS Security Incident Response User Guide needs and prevent volatile forensic data from being obtained, so this should be a purposeful decision and should be judged against an organization’s security policies. • Isolation VPCs – Isolation VPCs can be used to provide eﬀective containment of resources while providing access to legitimate traﬃc (such as anti-virus (AV) or EDR solutions that require access to the internet or an external management console). Isolation VPCs can be preconﬁgured in advance of a security event to permit valid IP addresses and ports, and targeted resources can immediately be moved into this isolation VPC during an active security event to contain the resource while allowing legitimate traﬃc to be sent and received by the targeted resource during subsequent phases of incident response. An important aspect of using an isolation VPC is that resources, such as EC2 instances, need to be shut down and relaunched in the new isolation VPC prior to use. Existing EC2 instances cannot be moved to another VPC or another Availability Zone. To do so, follow the steps outlined in How do I move my Amazon EC2 instance to another subnet, Availability Zone, or VPC? • Auto Scaling groups and load balancers – AWS resources attached to Auto Scaling groups and load balancers should be detached and deregistered as part of destination containment procedures. Detachment and deregistration of AWS resources can be performed using the AWS Management Console, AWS CLI, and AWS SDK. An example of destination containment is demonstrated in the following diagram with an incident response analyst adding an network ACL to a subnet in order to block a network connection request from an unauthorized host. Destination containment example Containment Version December
sir-ug-054	sir-ug.pdf	54	my Amazon EC2 instance to another subnet, Availability Zone, or VPC? • Auto Scaling groups and load balancers – AWS resources attached to Auto Scaling groups and load balancers should be detached and deregistered as part of destination containment procedures. Detachment and deregistration of AWS resources can be performed using the AWS Management Console, AWS CLI, and AWS SDK. An example of destination containment is demonstrated in the following diagram with an incident response analyst adding an network ACL to a subnet in order to block a network connection request from an unauthorized host. Destination containment example Containment Version December 1, 2024 132 AWS Security Incident Response User Guide Summary Containment is one step of the incident response process and can be manual or automated. The overall containment strategy should align with an organization’s security policies and business needs, and verify that negative eﬀects are mitigated as eﬃciently as possible prior to eradication and recovery. Eradication Eradication, in relation to security incident response, is the removal of suspicious or unauthorized resources in eﬀorts to return the account to a known safe state. The eradication strategy depends on multiple factors, which depend on the business requirements for your organization. The NIST SP 800-61 Computer Security Incident Handling Guide provides several steps for eradication: 1. Identify and mitigate all vulnerabilities that were exploited. 2. Remove malware, inappropriate materials, and other components. 3. If more aﬀected hosts are discovered (for example, new malware infections), repeat the detection and analysis steps to identify all other aﬀected hosts, then contain and eradicate the incident for them. For AWS resources, this can be further reﬁned through those events detected and analyzed through available logs or automated tooling such as CloudWatch Logs and Amazon GuardDuty. Those events should be the basis to determine which remediations should be performed to properly restore the environment to a known safe state. The ﬁrst step of eradication is determining which resources have been aﬀected within the AWS account. This is accomplished through analysis of your available log data sources, resources, and automated tooling. • Identify unauthorized actions taken by the IAM identities in your account. • Identify unauthorized access or changes to your account. • Identify the creation of unauthorized resources or IAM users. • Identify systems or resources with unauthorized changes. Once the list of resources is identiﬁed, you should assess each to determine the business impact if the resource is deleted or restored. As an example, if a web server is hosting your business Eradication Version December 1, 2024 133 AWS Security Incident Response User Guide application and deleting it would cause down time, then you should consider recovering the resource from veriﬁed safe backups or re-launching the system from a clean AMI before deleting the impacted server. Once you have concluded your business impact analysis, then, using the events from your log analysis, you should go into the accounts and perform the appropriate remediations, such as: • Rotate or delete keys - this step removes the ability of the actor to continue performing activities within the account. • Rotate potentially unauthorized IAM user credentials. • Delete unrecognized or unauthorized resources. Important If you must keep resources for your investigation, consider backing up those resources. For example, if you must retain an Amazon EC2 instance for regulatory, compliance, or legal reasons, then create an Amazon EBS snapshot before removing the instance. • For malware infections, you might need to reach out to an AWS Partner or other vendor. AWS does not oﬀer native tools for malware analysis or removal. However, if you’re using the GuardDuty Malware module for Amazon EBS, then recommendations might be available for provided ﬁndings. Once you have eradicated the identiﬁed aﬀected resources, AWS recommends you perform a security review of your account. This can be done using AWS Conﬁg rules, using open-source solutions such as Prowler and ScoutSuite, or through other vendors. You should also consider performing vulnerability scans against your public-(internet) facing resources to assess residual risk. Eradication is one step of the incident response process and can be manual or automated, depending on the incident and aﬀected resources. The overall strategy should align with an organization’s security policies and business needs, and verify that negative eﬀects are mitigated as inappropriate resources or conﬁgurations are removed. Eradication Version December 1, 2024 134 AWS Security Incident Response User Guide Recovery Recovery is the process of restoring systems to a known safe state, validating that backups are safe or unaﬀected by the incident prior to restoration, testing to verify that the systems are working properly post-restoration, and addressing vulnerabilities associated with the security event. The order of recovery depends on your organization’s requirements. As part of the process of recovery, you should perform a business impact analysis to determine, at minimum: • Business or dependency priorities
sir-ug-055	sir-ug.pdf	55	that negative eﬀects are mitigated as inappropriate resources or conﬁgurations are removed. Eradication Version December 1, 2024 134 AWS Security Incident Response User Guide Recovery Recovery is the process of restoring systems to a known safe state, validating that backups are safe or unaﬀected by the incident prior to restoration, testing to verify that the systems are working properly post-restoration, and addressing vulnerabilities associated with the security event. The order of recovery depends on your organization’s requirements. As part of the process of recovery, you should perform a business impact analysis to determine, at minimum: • Business or dependency priorities • The restoration plan • Authentication and authorization The NIST SP 800-61 Computer Security Incident Handling Guide provides several steps to recover systems, including: • Restoring systems from clean backups. • Verify that backups are evaluated before restoring to systems to make sure that the infection is not present and to prevent a resurgence of the security event. Backups should be evaluated on a regular basis as part of disaster recovery testing to verify that the backup mechanism is working properly and the data integrity meets recovery point objectives. • If possible, use backups from before the ﬁrst event timestamp identiﬁed as part of root cause analysis. • Rebuilding systems from scratch, including redeploying from trusted source using automation, sometime in a new AWS account. • Replacing compromised ﬁles with clean versions. You should exercise great caution when doing this. You must be absolutely certain the ﬁle you are recovering is known safe and unaﬀected by the incident • Installing patches. • Changing passwords. • This includes passwords for IAM principals that might have been abused. • If possible, we recommend using roles for IAM principals and federation as part of a least privilege strategy. Recovery Version December 1, 2024 135 AWS Security Incident Response User Guide • Tightening network perimeter security (ﬁrewall rulesets, boundary router access control lists). Once the resources have been recovered, it is important to capture lessons learned to update incident response policies, procedures, and guides. In summary, it is imperative to implement a recovery process that facilitates a return to known safe operations. Recovery can take a long time and requires a close linkage with containment strategies to balance business impact against risk of reinfection. Recovery procedures should include steps for restoring resources and services, IAM principals, and performing a security review of the account to assess residual risk. Conclusion Each operations phase has unique goals, techniques, methodologies, and strategies. Table 4 summarizes these phases and some of the techniques and methodologies covered in this section. Table 4 – Operations phases: Goals, techniques, and methodologies Phase Goal Techniques and methodolo gies Detection Identify a potential security event. • Security controls for detection Analysis Determine if the security event is an incident and assess the scope of the incident. • Behavior and rule-based detection • People-based detection • Validate and scope alert • Query logs • Threat intelligence • Automation Containment Minimize and limit the impact of the security event. • Source containment • Technique and access containment • Destination containment Conclusion Version December 1, 2024 136 AWS Security Incident Response User Guide Phase Goal Techniques and methodolo gies Eradication Remove unauthorized resources or artifacts related • Compromised or unauthori zed credential rotation or to the security event. deletion • Unauthorized resource deletion • Malware removal • Security scans Recovery Restore systems to a known good state and monitor these systems to ensure the threat does not return. • System restoration from backups • Systems rebuilt from scratch • Compromised ﬁles replaced with clean versions Post-incident activity The threat landscape is constantly changing and it is important to be equally dynamic in your organization’s ability to eﬀectively protect your environments. The key to continuous improvement is iterating on the outcomes of your incidents and simulations in order to improve your capabilities to eﬀectively detect, respond to, and investigate possible security incidents, reducing your possible vulnerabilities, time to response, and return to safe operations. The following mechanisms can help you verify that your organization remains prepared with the latest capabilities and knowledge to eﬀectively respond, no matter the situation. Establish a framework for learning from incidents Implementing a lessons learned framework and methodology will not only help to improve incident response capabilities, but also help to prevent the incident from recurring. By learning from each incident, you can help to avoid repeating the same mistakes, exposures, or misconﬁgurations, not only improving your security posture, but also minimizing time lost to preventable situations. Post-incident activity Version December 1, 2024 137 AWS Security Incident Response User Guide It's important to implement a lessons learned framework that establishes and achieves, at a high level, the following points: • When is a lessons learned held? • What is involved in the
sir-ug-056	sir-ug.pdf	56	a lessons learned framework and methodology will not only help to improve incident response capabilities, but also help to prevent the incident from recurring. By learning from each incident, you can help to avoid repeating the same mistakes, exposures, or misconﬁgurations, not only improving your security posture, but also minimizing time lost to preventable situations. Post-incident activity Version December 1, 2024 137 AWS Security Incident Response User Guide It's important to implement a lessons learned framework that establishes and achieves, at a high level, the following points: • When is a lessons learned held? • What is involved in the lessons learned process? • How is a lessons learned performed? • Who is involved in the process and how? • How will areas of improvement be identiﬁed? • How will you ensure the improvements are eﬀectively tracked and implemented? Aside from these high-level outcomes listed, it is important to make sure that you ask the right questions to derive the most value (information that leads to actionable improvements) from the process. Consider these questions to help get you started in fostering your lessons learned discussions: • What was the incident? • When was the incident ﬁrst identiﬁed? • How was it identiﬁed? • What systems alerted on the activity? • What systems, services, and data were involved? • What speciﬁcally occurred? • What worked well? • What didn't work well? • Which process or procedures failed or failed to scale to respond to the incident? • What can be improved within the following areas: • People • Were the people who were needed to be contacted actually available and was the contact list up to date? • Were people missing training or capabilities needed to eﬀectively respond and investigate the incident? • Were the appropriate resources ready and available? • Process • Were processes and procedures followed? Establish a framework for learning from incidents Version December 1, 2024 138 AWS Security Incident Response User Guide • Were processes and procedures documented and available for this (type of) incident? • Were required processes and procedures missing? • Were the responders able to gain timely access to the required information to respond to the issue? • Technology • Did existing alerting systems eﬀectively identify and alert on the activity? • Do existing alerts need improvement or new alerts need to be built for this (type of) incident? • Did existing tooling allow for eﬀective investigation (search/analysis) of the incident? • What can be done to help identify this (type of) incident sooner? • What can be done to help prevent this (type of) incident from occurring again? • Who owns the improvement plan and how will you test that it has been implemented? • What is the timeline for the additional monitoring/preventative controls/process to be implemented and tested? This list isn’t all-inclusive; it is intended to serve as a starting point for identifying what the organization and business needs are and how you can analyze them in order to most eﬀectively learn from incidents and continuously improve your security posture. Most important is getting started by incorporating lessons learned as a standard part of your incident response process, documentation, and expectations across the stakeholders. Establish metrics for success Metrics are necessary to eﬀectively measure, assess, and improve your incident response capabilities. Without metrics, there is no reference against which to accurately measure or even identify how well your organization is (or is not) performing. There are a few metrics common to incident response that are a good starting point for an organization looking to establish expectations and references for working toward operational excellence. Mean time to detect Mean time to detect is the average time it takes to discover a possible security incident. Speciﬁcally, this is the time between the occurrence of the ﬁrst indicator of compromise and the initial identiﬁcation or alert. Establish metrics for success Version December 1, 2024 139 AWS Security Incident Response User Guide You can use this metric to track how eﬀective your detection and alerting systems are performing. Eﬀective detection and alerting mechanisms are key to verifying that possible security incidents don’t linger within your environments. The higher the mean time to detect, the greater the need to build additional or more eﬀective alerts and mechanisms to identify and discover possible security incidents. The lower the mean time to detect, the better your detection and alerting mechanisms are functioning. Mean time to acknowledge Mean time to acknowledge is the average time it takes to acknowledge and prioritize a possible security incident. Speciﬁcally, this is the time between the generation of an alert and a member of your SOC or incident response staﬀ identifying and prioritizing the alert for processing. You can use this metric to track how well your team is processing and prioritizing alerts. If
sir-ug-057	sir-ug.pdf	57	need to build additional or more eﬀective alerts and mechanisms to identify and discover possible security incidents. The lower the mean time to detect, the better your detection and alerting mechanisms are functioning. Mean time to acknowledge Mean time to acknowledge is the average time it takes to acknowledge and prioritize a possible security incident. Speciﬁcally, this is the time between the generation of an alert and a member of your SOC or incident response staﬀ identifying and prioritizing the alert for processing. You can use this metric to track how well your team is processing and prioritizing alerts. If your team is unable to eﬀectively identify and prioritize alerts, then responses will be delayed and ineﬀective. The higher the mean time to acknowledge, the greater the need to verify that your team is both properly resourced and trained to quickly acknowledge and prioritize a possible security incident for response. The lower the mean time to acknowledge, the better your team is at responding to security alerts, showing that they are eﬀectively prepared and able to prioritize them well. Mean time to respond Mean time to respond is the average time it takes to begin the initial response to a possible security incident. Speciﬁcally, this is the time between the initial alert or discovery of a possible security incident and ﬁrst actions taken to respond. This is similar to mean time to acknowledge, but is the measurement of speciﬁc responsive actions (for example, acquire system data, contain the system) compared to simple recognition or acknowledgement of the situation. You can use this metric to track your preparedness to respond to security incidents. As mentioned, preparation is key to an eﬀective response. Refer to the the section called “Preparation” section of this document. The higher the mean time to respond, the greater the need to verify that your team is both properly trained on how to respond so that response processes are eﬀectively documented and utilized. The lower the mean time to respond, the better your team is at identifying an appropriate response to identiﬁed alerts and performing the required responsive actions to begin the journey back to safe operations. Establish metrics for success Version December 1, 2024 140 AWS Security Incident Response User Guide Mean time to contain Mean time to contain is the average time it takes to contain a possible security incident. Speciﬁcally, this is the time between the initial alert or discovery of a possible security incident and the completion of responsive actions that eﬀectively prevents the attacker or compromised systems from doing further harm. You can use this metric to track how well your team is able to mitigate or contain possible security incidents. Inability to quickly and eﬀectively contain possible security incidents increases the impact, scope, and exposure to possible further compromise. The higher the mean time to contain, the greater the need to build both knowledge and capabilities to quickly and eﬀectively mitigate and contain the security incidents you are experiencing. The lower the mean time to contain, the better your team is at understanding and employing the necessary measures to mitigate and contain identiﬁed threats to reduce impact, scope, and risk to the business. Mean time to recover Mean time to recover is the average time it takes to fully return so safe operations from a possible security incident. Speciﬁcally, this is the time between the initial alert or discovery of a possible security incident and when the business is back to operating normally and safely without being aﬀected by the incident. You can use this metric to track how eﬀective your teams are at returning systems, accounts, and environments back to safe operations after a security incident. Inability to return to safe operations swiftly or eﬀectively can not only have an impact on security but can also increase impact and expense to the business and its operations. The higher the mean time to recover, the greater the need to prepare your teams and environments to have the appropriate mechanisms (for example, failover processes and CI/CD pipelines to safe redeploy clean systems) to minimize the impact of security incidents to operations and the business. The lower the mean time to recover, the more eﬀective your teams are at minimizing the impact of security incidents on your operations and business. Attacker dwell time Attacker dwell time is the average time that an unauthorized user has access to a systems or environment. This is similar to mean time to contain, except the time frame begins with the initial Establish metrics for success Version December 1, 2024 141 AWS Security Incident Response User Guide time the attacker gained access to the system or environments, which might be earlier than the initial alert or discovery. You can use this metric to track how well many of your
sir-ug-058	sir-ug.pdf	58	eﬀective your teams are at minimizing the impact of security incidents on your operations and business. Attacker dwell time Attacker dwell time is the average time that an unauthorized user has access to a systems or environment. This is similar to mean time to contain, except the time frame begins with the initial Establish metrics for success Version December 1, 2024 141 AWS Security Incident Response User Guide time the attacker gained access to the system or environments, which might be earlier than the initial alert or discovery. You can use this metric to track how well many of your systems and mechanisms are all working together to reduce the amount of time, access, and opportunity an attacker or threat has to impact your environment. Reducing attacker dwell time should be a top priority for your teams and business. The higher the attacker dwell time, the greater the need to identify which parts of the incident response process need improvement to ensure your teams’ abilities to minimize the impact and scope of threats or attacks in your environments. The lower the attacker dwell time, the better your teams are at minimizing the time and opportunity that a threat or attacker has within your environments, ultimately reducing the risk and impact to your operations and business. Metrics summary Establishing and tracking metrics for incident response allows you to eﬀectively measure, assess, and improve your incident response capabilities. To achieve this, there are a number of common incident response metrics that were highlighted in this section. Table 5 summarizes these metrics. Table 5 – Incident response metrics Metric Description Mean time to detect Mean time to acknowledge Mean time to respond Mean time to contain Mean time to recover Average time it takes to discover a possible security incident Average time it takes to acknowledge (and prioritize) a possible security incident Average time it takes to begin the initial response to a possible security incident Average time it takes to contain a possible security incident Average time it takes to fully return so safe operations from a possible security incident Establish metrics for success Version December 1, 2024 142 AWS Security Incident Response User Guide Metric Attacker dwell time Description Average time an attacker has access to a systems or environment Use indicators of compromise (IOCs) An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of conﬁdence) identify malicious activity or a security incident. IOCs can exist in a variety of forms, including IP addresses, domains, network-level artifacts such as TCP ﬂags or payloads, system or host-level artifacts such as executables, ﬁle names and hashes, log ﬁle entries, or registry entries, and more. They can also be a combination of items or activities, such as the existence of speciﬁc items or artifacts on a system (a certain ﬁle or set of ﬁles and registry items), actions performed in certain order (a login to a system from a certain IP followed by speciﬁc anomalous commands), or network activity (anomalous inbound or outbound traﬃc to or from certain domains) that can indicate a speciﬁc threat, attack, or attacker methodology. As you work to iteratively improve your incident response program, you should implement a framework to collect, manage, and utilize IOCs as a mechanism to continuously build and improve detections and alerting and improve the speed and eﬃcacy of investigations. You can start by incorporating the collection and management of IOCs into the analysis and investigation phases of your incident response processes. By proactively identifying, collecting, and storing IOCs as a standard part of your process, you can build a repository of data (as part of a more comprehensive threat intelligence program) that in turn can be used to improve existing detections and alerts, build additional detections and alerts, identify where and when an artifact was seen before, build and reference documentation of how investigations were previously done involving matching IOCs, and more. Continuous education and training Education and training are both evolving and continual eﬀorts that should be purposefully pursued and maintained. There are a variety of mechanisms to verify that your team is maintaining awareness, knowledge, and capabilities commensurate with the evolving state of technology as well as the threat landscape. One mechanism is to employ continuing education as a standard part of your teams’ goals and operations. As mentioned in the Preparation section, your incident response staﬀ and stakeholders must be eﬀectively trained on detecting, responding to, and investigating incidents within AWS. Use indicators of compromise Version December 1, 2024 143 AWS Security Incident Response User Guide However, education isn’t a “one and done” eﬀort. Education must be continuously pursued to verify that your team maintains awareness of the latest technological advances, updates, and improvements that can be
sir-ug-059	sir-ug.pdf	59	with the evolving state of technology as well as the threat landscape. One mechanism is to employ continuing education as a standard part of your teams’ goals and operations. As mentioned in the Preparation section, your incident response staﬀ and stakeholders must be eﬀectively trained on detecting, responding to, and investigating incidents within AWS. Use indicators of compromise Version December 1, 2024 143 AWS Security Incident Response User Guide However, education isn’t a “one and done” eﬀort. Education must be continuously pursued to verify that your team maintains awareness of the latest technological advances, updates, and improvements that can be leveraged to improve the eﬃcacy and eﬃciency of response, as well as additions or updates to data that can be leveraged for improving investigation and analysis. Another mechanism is to verify that simulations are performed on a regular basis (for example, quarterly) and focused on speciﬁc outcomes for the business. Refer to the the section called “Run regular simulations” section of this document. Though running initial tabletop exercises are an excellent way to generate an initial baseline for improvement, continuous testing is key to sustained improvements and maintaining an up-to- date and accurate reﬂection of the current state of operations. Testing against the latest and most critical security situations and the most important or newest capabilities for response, and incorporating the lessons learned back into education, operations, and processes/procedures will verify that you are able to continuously improve your response processes and program as a whole. Conclusion As you continue your cloud journey, it is important for you to consider the fundamental security incident response concepts for your AWS environment. You can combine the available controls, cloud capabilities, and remediation options to help you improve the security of your cloud environment. You can also start small and iterate as you adopt automation capabilities that improve your response speed, so you are better prepared when security events occur. Contributors Current and past contributors to this document include: • Anna McAbee, Senior Security Solutions Architect, Amazon Web Services • Freddy Kasprzykowski, Senior Security Consultant, Amazon Web Services • Jason Hurst, Senior Security Engineer, Amazon Web Services • Jonathon Poling, Principal Security Consultant, Amazon Web Services • Josh Du Lac, Senior Manager, Security Solutions Architecture, Amazon Web Services • Paco Hope, Principal Security Engineer, Amazon Web Services • Ryan Tick, Senior Security Engineer, Amazon Web Services • Steve de Vera, Senior Security Engineer, Amazon Web Services Conclusion Version December 1, 2024 144 AWS Security Incident Response User Guide Appendix A: Cloud capability deﬁnitions AWS oﬀers over 200 cloud services and thousands of features. Many of these provide native detective, preventative, and responsive capabilities, and others can be used to architect custom security solutions. This section includes a subset of those services that are most relevant to incident response in the cloud. Topics • Logging and events • Visibility and alerting • Automation • Secure storage • Future and Custom Security Capabilities Logging and events AWS CloudTrail – AWS CloudTrail service enabling governance, compliance, operational auditing, and risk auditing of AWS accounts. With CloudTrail, you can log, continuously monitor, and retain account activity related to actions across AWS services. CloudTrail provides event history of your AWS account activity, including actions taken through the AWS Management Console, AWS SDKs, command line tools, and other AWS services. This event history simpliﬁes security analysis, resource change tracking, and troubleshooting. CloudTrail logs two diﬀerent types of AWS API actions: • CloudTrail management events (also known as control plane operations) show management operations that are performed on resources in your AWS account. This includes actions such as creating an Amazon S3 bucket and setting up logging. • CloudTrail data events (also known as data plane operations) show the resource operations performed on or within a resource in your AWS account. These operations are often high- volume activities. This includes actions such as Amazon S3 object-level API activity (for example, GetObject, DeleteObject, and PutObject API operations) and Lambda function invocation activity. AWS Conﬁg – AWS Conﬁg is a service enabling customers assess, audit, and evaluate the conﬁgurations of your AWS resources. AWS Conﬁg continuously monitors and records your AWS resource conﬁgurations and enables you to automate the evaluation of recorded conﬁgurations Appendix A: Cloud capability deﬁnitions Version December 1, 2024 145 AWS Security Incident Response User Guide against desired conﬁgurations. With AWS Conﬁg, customers can review changes in conﬁgurations and relationships between AWS resources, manually or automatically, detailed resource conﬁguration history, and determine overall compliance against the conﬁgurations speciﬁed in customer’s guidelines. This enables simpliﬁcation of compliance auditing, security analysis, change management, and operational troubleshooting. Amazon EventBridge – Amazon EventBridge delivers a near real-time stream of system events that describe changes in AWS resources, or when API calls are published by AWS CloudTrail. Using simple rules that you can quickly
sir-ug-060	sir-ug.pdf	60	conﬁgurations Appendix A: Cloud capability deﬁnitions Version December 1, 2024 145 AWS Security Incident Response User Guide against desired conﬁgurations. With AWS Conﬁg, customers can review changes in conﬁgurations and relationships between AWS resources, manually or automatically, detailed resource conﬁguration history, and determine overall compliance against the conﬁgurations speciﬁed in customer’s guidelines. This enables simpliﬁcation of compliance auditing, security analysis, change management, and operational troubleshooting. Amazon EventBridge – Amazon EventBridge delivers a near real-time stream of system events that describe changes in AWS resources, or when API calls are published by AWS CloudTrail. Using simple rules that you can quickly set up, you can match events and route them to one or more target functions or streams. EventBridge becomes aware of operational changes as they occur. EventBridge can respond to these operational changes and take corrective action as necessary, by sending messages to respond to the environment, activating functions, making changes, and capturing state information. Some security services, such as Amazon GuardDuty, produce their output in the form of EventBridge events. Many security services also provide an option to send their outputs to Amazon S3. Amazon S3 access logs – If sensitive information is stored in an Amazon S3 bucket, customers can enable Amazon S3 access logs to record every upload, download, and modiﬁcation to that data. This log is separate from, and in addition to, the CloudTrail logs that record changes to the bucket itself (such as changing access policies and lifecycle policies). It’s worth noting that access log records are delivered on a best eﬀort basis. Most requests for a bucket that is properly conﬁgured for logging result in a delivered log record. The completeness and timeliness of server logging is not guaranteed. Amazon CloudWatch Logs – Customers can use Amazon CloudWatch Logs to monitor, store, and access log ﬁles originating from operating systems, applications, and other sources running in Amazon EC2 instances with a CloudWatch Logs agent. CloudWatch Logs can be a destination for AWS CloudTrail, Route 53 DNS Queries, VPC Flow Logs, Lambda functions, and others. Customers can then retrieve the associated log data from CloudWatch Logs. Amazon VPC Flow Logs – VPC Flow Logs enables customers to capture information about IP traﬃc going to and from network interfaces in VPCs. After enabling ﬂow logs, they can be streamed to Amazon CloudWatch Logs and Amazon S3. VPC Flow Logs helps customers with a number of tasks such as troubleshooting why speciﬁc traﬃc is not reaching an instance, diagnosing overly restrictive security group rules, and using it as a security tool to monitor the traﬃc to EC2 instances. Use the most current version of VPC ﬂow logging to get the most robust ﬁelds. AWS WAF Logs – AWS WAF supports full logging of all web requests inspected by the service. Customers can store these in Amazon S3 to fulﬁll compliance and auditing requirements, as well as Logging and events Version December 1, 2024 146 AWS Security Incident Response User Guide debugging and forensics. These logs help customers determine the root cause of initiated rules and blocked web requests. Logs can be integrated with third-party SIEM and log analysis tools. Route 53 Resolver query logs – Route 53 Resolver query logs will let you log all DNS queries made by resources within Amazon Virtual Private Cloud (Amazon VPC). Whether it’s an Amazon EC2 instance, an AWS Lambda function, or a container, if it lives in your Amazon VPC and makes a DNS query, then this feature will log it; you are then able to explore and better understand how your applications are operating. Other AWS logs – AWS continuously releases service features and capabilities for customers with new logging and monitoring capabilities. For information about features available for each AWS service, refer to our public documentation. Visibility and alerting AWS Security Hub – AWS Security Hub provides customers with a comprehensive view of high- priority security alerts and compliance statuses across AWS accounts. Security Hub aggregates, organizes, and prioritizes ﬁndings from AWS services such as Amazon GuardDuty, Amazon Inspector, Amazon Macie, and AWS Partner solutions. Findings are visually summarized on integrated dashboards with actionable graphs and tables. You can also continuously monitor your environment using automated compliance checks based on the AWS best practices and industry standards your organization follows. Amazon GuardDuty – Amazon GuardDuty is a managed threat detection service continuously monitoring malicious or unauthorized behavior to help customers protect AWS accounts and workloads. It monitors activity such as unusual API calls or potentially unauthorized deployments indicating possible account or resource compromise of Amazon EC2 instances, Amazon S3 buckets, or reconnaissance by bad actors. GuardDuty identiﬁes suspected bad actors through integrated threat intelligence feeds using machine learning to detect anomalies in account and workload activity. When a potential threat is detected, the service delivers a detailed security
sir-ug-061	sir-ug.pdf	61	based on the AWS best practices and industry standards your organization follows. Amazon GuardDuty – Amazon GuardDuty is a managed threat detection service continuously monitoring malicious or unauthorized behavior to help customers protect AWS accounts and workloads. It monitors activity such as unusual API calls or potentially unauthorized deployments indicating possible account or resource compromise of Amazon EC2 instances, Amazon S3 buckets, or reconnaissance by bad actors. GuardDuty identiﬁes suspected bad actors through integrated threat intelligence feeds using machine learning to detect anomalies in account and workload activity. When a potential threat is detected, the service delivers a detailed security alert to the GuardDuty console and CloudWatch Events. This makes alerts actionable and simple to integrate into existing event management and workﬂow systems. GuardDuty also oﬀers two add-ons to monitor for threats with speciﬁc services: Amazon GuardDuty for Amazon S3 protection and Amazon GuardDuty for Amazon EKS protection. Amazon S3 protection enables GuardDuty to monitor object-level API operations to identify potential security risks for data within Amazon S3 buckets. Kubernetes protection enables GuardDuty to detect suspicious activities and potential compromises of Kubernetes clusters within Amazon EKS. Visibility and alerting Version December 1, 2024 147 AWS Security Incident Response User Guide Amazon Macie – Amazon Macie is an AI-powered security service that helps prevent data loss by automatically discovering, classifying, and protecting sensitive data stored in AWS. Macie uses machine learning (ML) to recognize sensitive data such as personally identiﬁable information (PII) or intellectual property, assign a business value, and provide visibility into where this data is stored and how it is being used in your organization. Amazon Macie continuously monitors data access activity for anomalies, and delivers alerts when it detects a risk of unauthorized access or inadvertent data leaks. AWS Conﬁg Rules – An AWS Conﬁg rule represents the preferred conﬁgurations for a resource and is evaluated against conﬁguration changes on the relevant resources, as recorded by AWS Conﬁg. You can see the results of evaluating a rule against the conﬁguration of a resource on a dashboard. Using AWS Conﬁg rules, you can assess your overall compliance and risk status from a conﬁguration perspective, view compliance trends over time, and ﬁnd which conﬁguration change caused a resource to be out of compliance with a rule. AWS Trusted Advisor – AWS Trusted Advisor is an online resource to help you reduce cost, increase performance, and improve security by optimizing your AWS environment. Trusted Advisor provides real time guidance to help you provision your resources by following AWS best practices. The full set of Trusted Advisor checks, including CloudWatch Events integration, is available to Business and Enterprise Support plan customers. Amazon CloudWatch – Amazon CloudWatch is a monitoring service for AWS Cloud resources and the applications you run on AWS. You can use CloudWatch to collect and track metrics, collect and monitor log ﬁles, set alarms, and automatically react to changes in your AWS resources. CloudWatch can monitor AWS resources, such as Amazon EC2 instances, Amazon DynamoDB tables, and Amazon RDS DB instances, as well as custom metrics generated by your applications and services, and any log ﬁles your applications generate. You can use Amazon CloudWatch to get system-wide visibility into resource utilization, application performance, and operational health. You can use these insights to react accordingly and keep your application running smoothly. Amazon Inspector – Amazon Inspector is an automated security assessment service that helps improve the security and compliance of applications deployed on AWS. Amazon Inspector automatically assesses applications for vulnerabilities or deviations from best practices. After performing an assessment, Amazon Inspector produces a detailed list of security ﬁndings prioritized by level of severity. These ﬁndings can be reviewed directly or as part of detailed assessment reports which are available through the Amazon Inspector console or API. Amazon Detective – Amazon Detective is a security service that automatically collects log data from your AWS resources and uses machine learning, statistical analysis, and graph theory to build Visibility and alerting Version December 1, 2024 148 AWS Security Incident Response User Guide a linked set of data that enables you to conduct faster and more eﬃcient security investigations. Detective can analyze trillions of events from multiple data sources such as VPC Flow Logs, CloudTrail, and GuardDuty, and automatically creates a uniﬁed, interactive view of your resources, users, and the interactions between them over time. With this uniﬁed view, you can visualize all the details and context in one place to identify the underlying reasons for the ﬁndings, drill down into relevant historical activities, and quickly determine the root cause. Automation AWS Lambda – AWS Lambda is a serverless compute service that runs your code in response to events, and automatically manages the underlying compute resources for you. You can use Lambda to extend other AWS services with custom logic, or create your
sir-ug-062	sir-ug.pdf	62	Logs, CloudTrail, and GuardDuty, and automatically creates a uniﬁed, interactive view of your resources, users, and the interactions between them over time. With this uniﬁed view, you can visualize all the details and context in one place to identify the underlying reasons for the ﬁndings, drill down into relevant historical activities, and quickly determine the root cause. Automation AWS Lambda – AWS Lambda is a serverless compute service that runs your code in response to events, and automatically manages the underlying compute resources for you. You can use Lambda to extend other AWS services with custom logic, or create your own backend services that operate at AWS scale, performance, and security. Lambda runs your code on high-availability compute infrastructure and performs the administration of the compute resources for you. This includes server and operating system maintenance, capacity provisioning and automatic scaling, code and security patch deployment, and code monitoring and logging. All you have to do is supply the code. AWS Step Functions – AWS Step Functions makes it simple to coordinate the components of distributed applications and microservices using visual workﬂows. Step Functions provides a graphical console for you to arrange and visualize the components of your application as a series of steps. This makes it simple to build and run multistep applications. Step Functions automatically starts and tracks each step, and retries when there are errors, so your application runs in order and as expected. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly. You can change and add steps without writing code, so you can evolve your application and innovate faster. AWS Step Functions is part of AWS Serverless, and makes it simple to orchestrate AWS Lambda functions for serverless applications. You can also use Step Functions for microservices orchestration using compute resources such as Amazon EC2 and Amazon ECS. AWS Systems Manager – AWS Systems Manager gives you visibility and control of your infrastructure on AWS. Systems Manager provides a uniﬁed user interface so you can view operational data from multiple AWS services, and enables you to automate operational tasks across your AWS resources. With Systems Manager, you can group resources by application, view operational data for monitoring and troubleshooting, and act on your groups of resources. Systems Manager can keep your instances in their deﬁned state, perform on-demand changes, such as updating applications or running shell scripts, and perform other automation and patching tasks. Automation Version December 1, 2024 149 AWS Security Incident Response User Guide Secure storage Amazon Simple Storage Service – Amazon S3 is object storage built to store and retrieve any amount of data from anywhere. It is designed to deliver 99.999999999% durability, and stores data for millions of applications used by market leaders in every industry. Amazon S3 provides comprehensive security and is designed to help you meet your regulatory requirements. It gives customers ﬂexibility in the methods that they use to manage data for cost optimization, access control, and compliance. Amazon S3 provides query-in-place functionality, which enables you to run powerful analytics directly on your data at rest in Amazon S3. Amazon S3 is a highly supported cloud storage service, with integration from one of the largest communities of third- party solutions, systems integrator partners, and other AWS services. Amazon S3 Glacier – Amazon S3 Glacier is a secure, durable, and extremely low-cost cloud storage service for data archiving and long-term backup. It is designed to deliver 99.999999999% durability, provides comprehensive security, and is designed to help you meet your regulatory requirements. S3 Glacier provides query-in-place functionality, which enables you to run powerful analytics directly on your archive data at rest. To keep costs low yet suitable for varying retrieval needs, S3 Glacier provides three options for access to archives, from a few minutes to several hours. Future and Custom Security Capabilities The aforementioned services and features are not an exhaustive list. AWS is continuously adding new capabilities. For more information, we encourage you to review the What's New at AWS and AWS Cloud Security pages. In addition to the security services that AWS oﬀers as native cloud services, you might be interested in building your own capabilities on top of AWS services. Although we recommend enabling a base set of security services within your accounts, such as AWS CloudTrail, Amazon GuardDuty, and Amazon Macie, you might eventually want to extend these capabilities to derive additional value from your log assets. There are a number of partner tools available, such as those listed in our APN Security Competency program. You might also want to write your own queries to search your logs. With the extensive number of managed services that AWS oﬀers, this has never been easier. There are many additional AWS services that can assist you with
sir-ug-063	sir-ug.pdf	63	on top of AWS services. Although we recommend enabling a base set of security services within your accounts, such as AWS CloudTrail, Amazon GuardDuty, and Amazon Macie, you might eventually want to extend these capabilities to derive additional value from your log assets. There are a number of partner tools available, such as those listed in our APN Security Competency program. You might also want to write your own queries to search your logs. With the extensive number of managed services that AWS oﬀers, this has never been easier. There are many additional AWS services that can assist you with investigation that are outside the scope of this paper, such as Amazon Athena, Amazon OpenSearch Service, Amazon QuickSight, Amazon Machine Learning, and Amazon EMR. Secure storage Version December 1, 2024 150 AWS Security Incident Response User Guide Appendix B: AWS incident response resources AWS publishes resources to assist customers with developing incident response capabilities. Most example code and procedures can be found at the AWS external GitHub public repository. Following are some resources that provide examples of how to perform incident response. Playbook resources • Framework for Incident Response Playbooks - An example framework for customers to create, develop, and integrate security playbooks in preparation for potential attack scenarios when using AWS services. • Develop your own Incident Response Playbooks - This workshop is designed to help you get familiar with developing incident response playbooks for AWS. • Incident Response Playbook Samples - Playbooks covering common scenarios faced by AWS customers. • Building an AWS incident response runbook using Jupyter playbooks and CloudTrail Lake - This workshop guides you through building an incident response playbook for your AWS environment using Jupyter notebooks and CloudTrail Lake. Forensic resources • Automated Incident Response and Forensics Framework – This framework and solution provides a standard digital forensic process, consisting of the following phases: containment, acquisition, examination, and analysis. It leverages AWS Λ functions to trigger the incident response process in an automated repeatable way. It provides segregation of accounts to operate the automation steps, store artifacts and create forensic environments. • Automated Forensics Orchestrator for Amazon EC2 – This implementation guide provides a self-service solution to capture and examine data from EC2 instances and attached volumes for forensic analysis in the event of a potential security issue being detected. There is an AWS CloudFormation template to deploy the solution. • How to automate forensic disk collection in AWS – This AWS blog details how to set up an automation workﬂow to capture the disk evidence for analysis in order to determine the scope and the impact of potential security incidents. There is also an AWS CloudFormation template included to deploy the solution. Appendix B: AWS incident response resources Version December 1, 2024 151 AWS Security Incident Response User Guide Notices Customers are responsible for making their own independent assessment of the information in this document. This document: (a) is for informational purposes only, (b) represents current AWS product oﬀerings and practices, which are subject to change without notice, and (c) does not create any commitments or assurances from AWS and its aﬃliates, suppliers or licensors. AWS products or services are provided “as is” without warranties, representations, or conditions of any kind, whether express or implied. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers. © 2024 Amazon Web Services, Inc. or its aﬃliates. All rights reserved. Notices Version December 1, 2024 152 AWS Security Incident Response User Guide Document history Change Description Date Service supports Japanese language. Updated supported conﬁgura tions to identify Japanese May 13, 2025 Content updates and customer feedback. Adding three new supported regions. language support in Japan local time. English is supported globally. Added a note to https://d ocs.aws.amazon.com/security -ir/latest/userguide/select- a-membership-account.html to reﬂect an additional task when using a delegated administrator account as part of setup. Updated the customer experience when working with a service generated case and Detect and Analyze. Updated account cancellat ion details to provide better clarity on billing implications in cancelling a membership. Added three new new regions to https://docs.aws.a mazon.com/security-ir/lates t/userguide/supported-conﬁ gs.html. Mumbai, Paris, and São Paulo. 9 May, 2025 7 May, 2025 Version December 1, 2024 153 AWS Security Incident Response User Guide Change Description Date Updated: Updates from customer comments on docs. Spelling and grammar errors on multiple pages correct. February 7, 2025 Updated https://docs.aws.a mazon.com/en_us/security- ir/latest/userguide/organizat ions_permissions.html to accurately reﬂect security-ir as the service preﬁx. Added a note to https://d ocs.aws.amazon.com/security -ir/latest/userguide/source- containment.html regarding Route53 and DNS. Version December 1, 2024 154 AWS Security Incident Response User Guide Change Description Date Updated: Updates from customer comments on docs. Updated https://docs.aws.a mazon.com/security-ir/lates December 20, 2024 t/userguide/setup-monitorin g-and-investigation-workﬂo ws.html to
sir-ug-064	sir-ug.pdf	64	gs.html. Mumbai, Paris, and São Paulo. 9 May, 2025 7 May, 2025 Version December 1, 2024 153 AWS Security Incident Response User Guide Change Description Date Updated: Updates from customer comments on docs. Spelling and grammar errors on multiple pages correct. February 7, 2025 Updated https://docs.aws.a mazon.com/en_us/security- ir/latest/userguide/organizat ions_permissions.html to accurately reﬂect security-ir as the service preﬁx. Added a note to https://d ocs.aws.amazon.com/security -ir/latest/userguide/source- containment.html regarding Route53 and DNS. Version December 1, 2024 154 AWS Security Incident Response User Guide Change Description Date Updated: Updates from customer comments on docs. Updated https://docs.aws.a mazon.com/security-ir/lates December 20, 2024 t/userguide/setup-monitorin g-and-investigation-workﬂo ws.html to stackset template. Corrected entries triage.se curity-ir.com to triage.se curity-ir.amazonaws.com Added tracked connections note for AWSSupport-Contain EC2Reversible on https://d ocs.aws.amazon.com/security -ir/latest/userguide/contai n.html. Fixed broken link on https://d ocs.aws.amazon.com/security -ir/latest/userguide/managi ng-associated-accounts.html. Added a deﬁnition for membership account at https://docs.aws.amazon.com /security-ir/latest/userguide/ select-a-membership-acco unt.html. Added a clariﬁcation note to https://docs.aws.amazon.com /en_us/security-ir/latest/ userguide/using-service- linked-roles.html for AWS Organizations management accounts. Version December 1, 2024 155 AWS Security Incident Response User Guide Change Description Date Updated: Updates from customer comments on docs. Removed multiple duplicate AWS AWS in text. December 10, 2024 Fixed broken links on https:// docs.aws.amazon.com/ security-ir/latest/usergui de/sir_tagging.html and https://docs.aws.amazon.com /security-ir/latest/usergui de/service-name-info-in-clo udtrail.html . Updates to https://d ocs.aws.amazon.com/ security-ir/latest/usergui de/contain.html. Removed the > from ﬁrst paragraph . Replaced AWSSuppor t-ContainEC2Revers ible with AWSSuppor t-ContainEC2Instance. Replaced AWSSupport- ContainIAMReversible with AWSSupport-Contain IAMPrincipal. Replaced AWSSupport-Contain S3Reversible with AWSSuppor t-ContainS3Resource. Updated formatting on https://docs.aws.amazon.com /en_us/security-ir/latest/u serguide/issues.html When telling customers to contact CIRT via a support Version December 1, 2024 156 AWS Security Incident Response User Guide Change Description Date ticket, https://docs.aws.a mazon.com/security-ir/ latest/userguide/unders tand-response-teams-and- support.html now provides options to select in the support forms. Removed CloudWatch Events and replaced with EventBrid ge on https://docs.aws.a mazon.com/security-ir/lates t/userguide/logging-and-eve nts.html . Grammar updates on https:// docs.aws.amazon.com/ security-ir/latest/userguide/ technique-access-contain ment.html . Removed publication date from https://docs.aws.a mazon.com/security-ir/lates t/userguide/security-incide nt-response-guide.html, replaced by updates in this table. Updated: AWS managed policies and service-linked roles. Service Launch Updates to managed policies and service-linked roles. December 1, 2024 Initial service docs for service launch at re:Invent 2024 December 1, 2024 Version December 1, 2024 157
sm-admin-001	sm-admin.pdf	1	Administrator Guide Amazon DCV Session Manager Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon DCV Session Manager Administrator Guide Amazon DCV Session Manager: Administrator Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. Amazon DCV Session Manager Table of Contents Administrator Guide What is Session Manager? ............................................................................................................... 1 How Session Manager works ..................................................................................................................... 1 Features .......................................................................................................................................................... 3 Limitations ...................................................................................................................................................... 4 Pricing ............................................................................................................................................................. 4 Requirements ................................................................................................................................................. 4 Networking and connectivity requirements ...................................................................................... 6 Setting up Session Manager ........................................................................................................... 7 Step 1: Prepare the Amazon DCV servers ............................................................................................... 7 Step 2: Set up the broker ........................................................................................................................... 8 Step 3: Set up the agent .......................................................................................................................... 11 Step 4: Conﬁgure the Amazon DCV server .......................................................................................... 16 Step 5: Verify the installations ............................................................................................................... 18 Verify the agent .................................................................................................................................... 18 Verify the broker ................................................................................................................................... 19 Conﬁguring the Session Manager ................................................................................................ 21 Scaling Session Manager .......................................................................................................................... 21 Step 1: Create an instance proﬁle ..................................................................................................... 22 Step 2: Prepare the SSL certiﬁcate for the load balancer ............................................................ 23 Step 3: Create the Broker application load balancer .................................................................... 24 Step 4: Launch the Brokers ................................................................................................................ 25 Step 5: Create the Agent application load balancer ..................................................................... 26 Step 6: Launch the Agents ................................................................................................................. 27 Using tags on Amazon DCV servers ....................................................................................................... 28 Conﬁguring an external authorization server ...................................................................................... 30 Conﬁguring broker persistence ............................................................................................................... 35 Conﬁgure the broker to persist on DynamoDB .............................................................................. 36 Conﬁgure the broker to persist on MariaDB/MySQL ..................................................................... 37 Integrating with the Amazon DCV Connection Gateway ................................................................... 38 Set up the Session Manager Broker as a Session Resolver for the Amazon DCV Connection Gateway .................................................................................................................................................. 38 Optional - Enable TLS client authentication ................................................................................... 39 Amazon DCV server - DNS mapping reference .............................................................................. 41 Integrating with Amazon CloudWatch .................................................................................................. 42 iii Amazon DCV Session Manager Administrator Guide Upgrading the Session Manager .................................................................................................. 45 Upgrading the Amazon DCV Session Manager agent ........................................................................ 45 Upgrading the Amazon DCV Session Manager broker ....................................................................... 48 Broker CLI reference ...................................................................................................................... 51 register-auth-server ................................................................................................................................... 52 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Example ................................................................................................................................................... 52 list-auth-servers .......................................................................................................................................... 53 Syntax ...................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 unregister-auth-server ............................................................................................................................... 54 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 register-api-client ....................................................................................................................................... 55 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 describe-api-clients .................................................................................................................................... 56 Syntax ...................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 unregister-api-client .................................................................................................................................. 58 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Example ................................................................................................................................................... 52 renew-auth-server-api-key ....................................................................................................................... 59 Syntax ...................................................................................................................................................... 52 Example ................................................................................................................................................... 52 generate-software-statement .................................................................................................................. 59 Syntax ...................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 iv Amazon DCV Session Manager Administrator Guide Example ................................................................................................................................................... 52 describe-software-statements ................................................................................................................. 61 Syntax ...................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 deactivate-software-statement ............................................................................................................... 62 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Example ................................................................................................................................................... 52 describe-agent-clients ............................................................................................................................... 63 Syntax ...................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 unregister-agent-client .............................................................................................................................. 64 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Example ................................................................................................................................................... 52 register-server-dns-mappings .................................................................................................................. 65 Syntax ...................................................................................................................................................... 52 Options .................................................................................................................................................... 52 Example ................................................................................................................................................... 52 describe-server-dns-mappings ................................................................................................................ 66 Syntax ...................................................................................................................................................... 52 Output ..................................................................................................................................................... 53 Example ................................................................................................................................................... 52 Conﬁguration File Reference ........................................................................................................ 69 Broker conﬁguration ﬁle ........................................................................................................................... 69 Agent Conﬁguration File .......................................................................................................................... 86 Release Notes and Document History .......................................................................................... 92 Release Notes .............................................................................................................................................. 92 2024.0-504— March 31, 2025 .......................................................................................................... 93 2024.0-493— January 15, 2025 ....................................................................................................... 93 2024.0-457— October 1, 2024 ......................................................................................................... 93 2023.1-17652— August 1, 2024 ....................................................................................................... 94 2023.1-16388— June 26, 2024 ........................................................................................................ 94 2023.1— November 9, 2023 .............................................................................................................. 94 v Amazon DCV Session Manager Administrator Guide 2023.0-15065— May 4, 2023 ............................................................................................................ 95 2023.0-14852— March 28, 2023 ...................................................................................................... 95 2022.2-13907— November 11, 2022 .............................................................................................. 95 2022.1-13067— June 29, 2022 ........................................................................................................ 95 2022.0-11952— February 23, 2022 ................................................................................................. 96 2021.3-11591— December 20, 2021 ............................................................................................... 96 2021.2-11445— November 18, 2021 .............................................................................................. 96 2021.2-11190— October 11, 2021 .................................................................................................. 96 2021.2-11042— September 01, 2021 ............................................................................................. 97 2021.1-10557— May 31, 2021 ......................................................................................................... 97 2021.0-10242— April 12, 2021 ........................................................................................................ 97 2020.2-9662— December 04, 2020 ................................................................................................. 98 .................................................................................................................................................................. 99 Document history ....................................................................................................................................... 99 vi Amazon DCV Session Manager Administrator Guide What is Amazon DCV Session Manager? Note Amazon DCV was previously known as NICE DCV. Amazon DCV Session Manager is set of installable software packages (an Agent and a Broker) and an application programming interface (API) that makes it easy for developers and independent software vendors (ISVs) to build front-end applications that programmatically create and manage the lifecycle of Amazon DCV sessions across a ﬂeet of Amazon DCV servers. This guide
sm-admin-002	sm-admin.pdf	2	31, 2021 ......................................................................................................... 97 2021.0-10242— April 12, 2021 ........................................................................................................ 97 2020.2-9662— December 04, 2020 ................................................................................................. 98 .................................................................................................................................................................. 99 Document history ....................................................................................................................................... 99 vi Amazon DCV Session Manager Administrator Guide What is Amazon DCV Session Manager? Note Amazon DCV was previously known as NICE DCV. Amazon DCV Session Manager is set of installable software packages (an Agent and a Broker) and an application programming interface (API) that makes it easy for developers and independent software vendors (ISVs) to build front-end applications that programmatically create and manage the lifecycle of Amazon DCV sessions across a ﬂeet of Amazon DCV servers. This guide explains how to install and conﬁgure the Session Manager Agent and Broker. For more information about using the Session Manager APIs, see the Amazon DCV Session Manager Developer Guide. Topics • How Session Manager works • Features • Limitations • Pricing • Amazon DCV Session Manager requirements How Session Manager works The following diagram shows the high-level components of Session Manager. How Session Manager works 1 Amazon DCV Session Manager Administrator Guide Broker The Broker is a web server that hosts and exposes the Session Manager APIs. It receives and processes API requests to manage Amazon DCV sessions from the client, and then passes the instructions to the relevant Agents. The Broker must be installed on a host that is separate from your Amazon DCV servers, but it must be accessible to the client, and it must be able to access the Agents. Agent The Agent is installed on each Amazon DCV server in the ﬂeet. The Agents receive instructions from the Broker and run them on their respective Amazon DCV servers. The Agents also monitor the state of the Amazon DCV servers, and send periodic status updates back to the Broker. APIs Session Manager exposes a set of REST application programming interfaces (APIs) that can be used to manage Amazon DCV sessions on a ﬂeet of Amazon DCV servers. The APIs are hosted on and exposed by the Broker. Developers can build custom session management clients that call the APIs. Client The client is the front-end application or portal that you develop to call the Session Manager APIs that are exposed by the Broker. End users use the client to manage the sessions hosted on the Amazon DCV servers in the ﬂeet. How Session Manager works 2 Amazon DCV Session Manager Access token Administrator Guide In order to make an API request, you must provide an access token. Tokens can be requested from the Broker, or an external authorization server, by registered client APIs. To request and access token, the client API must provide valid credentials. Client API The client API is generated from the Session Manager API deﬁnition YAML ﬁle, using Swagger Codegen. The client API is used to make API requests. Amazon DCV session An Amazon DCV session is a span of time when the Amazon DCV server is able to accept connections from a client. Before your clients can connect to an Amazon DCV session, you must create an Amazon DCV session on the Amazon DCV server. Amazon DCV supports both console and virtual sessions, and each session has a speciﬁed owner and set of permissions. You use the Session Manager APIs to manage the lifecycle of Amazon DCV sessions. Amazon DCV sessions can be in one of the following states: • CREATING—the Broker is in the process of creating the session. • READY—the session is ready to accept client connections. • DELETING—the session is being deleted. • DELETED—the session has been deleted. • UNKNOWN—unable to determine the session's state. The Broker and the Agent might be unable to communicate. Features DCV Session Manager oﬀers the following features: • Provides Amazon DCV session information—get information about the sessions running on multiple Amazon DCV servers. • Manage the lifecycle for multiple Amazon DCV sessions—create or delete multiple sessions for multiple users across multiple Amazon DCV servers with one API request. • Supports tags—use custom tags to target a group of Amazon DCV servers when creating sessions. Features 3 Amazon DCV Session Manager Administrator Guide • Manages permissions for multiple Amazon DCV sessions—modify user permissions for multiple sessions with one API request. • Provides connection information—retrieve client connection information for Amazon DCV sessions. • Supports for cloud and on-premises—use Session Manager on AWS, on-premises, or with alternative cloud-based servers. Limitations Session Manager does not provide resource provisioning capabilities. If you are running Amazon DCV on Amazon EC2 instances, you might need to use additional AWS services, such as Amazon EC2 Auto Scaling to manage the scaling of your infrastructure. Pricing Session Manager is available at no cost for AWS customers running EC2 instances. On-premises customers require a Amazon DCV Plus or Amazon DCV Professional Plus license. For information about how to purchase a Amazon DCV Plus or Amazon
sm-admin-003	sm-admin.pdf	3	information for Amazon DCV sessions. • Supports for cloud and on-premises—use Session Manager on AWS, on-premises, or with alternative cloud-based servers. Limitations Session Manager does not provide resource provisioning capabilities. If you are running Amazon DCV on Amazon EC2 instances, you might need to use additional AWS services, such as Amazon EC2 Auto Scaling to manage the scaling of your infrastructure. Pricing Session Manager is available at no cost for AWS customers running EC2 instances. On-premises customers require a Amazon DCV Plus or Amazon DCV Professional Plus license. For information about how to purchase a Amazon DCV Plus or Amazon DCV Professional Plus license, see How to Buy on the Amazon DCV website and ﬁnd a Amazon DCV distributor or reseller in your region. To allow all on-premises customers to experiment with the Amazon DCV Session Manager, the licensing requirements will only be enforced starting with Amazon DCV version 2021.0. For more information, see Licensing the Amazon DCV Server in the Amazon DCV Administrator Guide. Amazon DCV Session Manager requirements The Amazon DCV Session Manager Agent and Broker have the following requirements. Broker Operating system • Amazon Linux 2 • Amazon Linux 2023 • CentOS Stream 9 • RHEL 7.6 or later Agent • Windows • Windows Server 2022 • Windows Server 2019 Limitations 4 Amazon DCV Session Manager Administrator Guide Broker • RHEL 8.x • RHEL 9.x • Rocky Linux 8.5 or later • Rocky Linux 9.x • Ubuntu 20.04 • Ubuntu 22.04 • Ubuntu 24.04 Architect ure • 64-bit x86 • 64-bit ARM Memory 8 GB Agent • Windows Server 2016 • Linux server • Amazon Linux 2 • Amazon Linux 2023 • CentOS Stream 9 • RHEL 8.x • RHEL 9.x • Rocky Linux 8.5 or later • Rocky Linux 9.x • Ubuntu 20.04 • Ubuntu 22.04 • Ubuntu 24.04 • SUSE Linux Enterprise 12 with SP4 or later • SUSE Linux Enterprise 15 • 64-bit x86 • 64-bit ARM (Amazon Linux 2, Amazon Linux 2023, CentOS 9.x, RHEL 8.x/9.x and Rocky 8.x/9.x only) • 64-bit ARM (Ubuntu 22.04 and 24.04) 4 GB Amazon DCV 2020.2 and later Amazon DCV 2020.2 and later Java 11 - Amazon DCV version Additional requireme nts Requirements 5 Amazon DCV Session Manager Administrator Guide Networking and connectivity requirements The following diagram provides a high-level overview of the Session Manager networking and connectivity requirements. The Broker must be installed on a separate host, but it must have network connectivity with the Agents on the Amazon DCV servers. If you choose to have multiple Brokers to improve availability, then you must install and conﬁgure each broker on a separate host, and use one or more load balancers to manage the traﬃc between the client and the Brokers, and the Brokers and the Agents. The Brokers should also be able to communicate with each other in order to exchange information about the Amazon DCV servers and sessions. The Brokers can store their keys and status data on an external database and have this information available after reboot or termination. This helps mitigate the risk of losing important Broker information by persisting it on the external database. You can retrieve it later. If you choose to have it, then you must set up the external database and conﬁgure the brokers. DynamoDB, MariaDB, and MySQL are supported. You can ﬁnd conﬁguration parameters are listed on the Broker Conﬁguration File. The Agents must be able to initiate secure, persistent, bi-directional HTTPs connections with the Broker. Your client, or frontend application, must be able to access the Broker in order to call the APIs. The client should also be able to access your authentication server. Networking and connectivity requirements 6 Amazon DCV Session Manager Administrator Guide Setting up Amazon DCV Session Manager The following section explains how to install Session Manager with a single broker and multiple agents. You can use multiple brokers to improve scalability and performance. For more information, see Scaling Session Manager. To set up Amazon DCV Session Manager, do the following: Steps • Step 1: Prepare the Amazon DCV servers • Step 2: Set up the Amazon DCV Session Manager broker • Step 3: Set up the Amazon DCV Session Manager agent • Step 4: Conﬁgure the Amazon DCV server to use the broker as the authentication server • Step 5: Verify the installations Step 1: Prepare the Amazon DCV servers You must have a ﬂeet of Amazon DCV servers with which you intend to use Session Manager. For more information about installing Amazon DCV servers, see Installing the Amazon DCV server in the Amazon DCV Administrator Guide. On Linux Amazon DCV servers, Session Manager uses a local service user named dcvsmagent. This user is automatically created when the Session Manager agent is installed. You must grant this service user administrator privileges for Amazon
sm-admin-004	sm-admin.pdf	4	4: Conﬁgure the Amazon DCV server to use the broker as the authentication server • Step 5: Verify the installations Step 1: Prepare the Amazon DCV servers You must have a ﬂeet of Amazon DCV servers with which you intend to use Session Manager. For more information about installing Amazon DCV servers, see Installing the Amazon DCV server in the Amazon DCV Administrator Guide. On Linux Amazon DCV servers, Session Manager uses a local service user named dcvsmagent. This user is automatically created when the Session Manager agent is installed. You must grant this service user administrator privileges for Amazon DCV so that it can perform actions on behalf of other users. To grant the Session Manager service user administrator privileges, do the following: To add the local service user for Linux Amazon DCV servers 1. Open /etc/dcv/dcv.conf using your preferred text editor. 2. Add the administrators parameter to the [security] section and specify the Session Manager user. For example: [security] administrators=["dcvsmagent"] 3. Save and close the ﬁle. Step 1: Prepare the Amazon DCV servers 7 Amazon DCV Session Manager Administrator Guide 4. Stop and restart the Amazon DCV server. Session Manager is only able to create Amazon DCV sessions on behalf of users that already exist on the Amazon DCV server. If a request is made to create a session for a user that doesn't exist, the request fails. Therefore, you must ensure that each intended end user has a valid system user on the Amazon DCV server. Tip If you intend to use multiple broker hosts or Amazon DCV servers with agents, we recommend that you conﬁgure only one broker and one Amazon DCV server with an agent by performing the following steps, creating Amazon Machine Images (AMI) of the hosts with the completed conﬁgurations, and then using the AMIs to launch the remaining brokers and Amazon DCV servers. Alternatively, you can use AWS Systems Manager to run the commands on multiple instances remotely. Step 2: Set up the Amazon DCV Session Manager broker The broker must be installed on a Linux host. For more information about the supported Linux distributions, see Amazon DCV Session Manager requirements. Install the broker on a host that is separate from the agent and the Amazon DCV server host. The host can be installed on a diﬀerent private network, but it must be able to connect to and communicate with the agent. To install and start the broker 1. Connect to the host on which you intend to install the broker. 2. The packages are digitally signed with a secure GPG signature. To allow the package manager to verify the package signature, you must import the Amazon DCV GPG key. Run the following command to import the Amazon DCV GPG key. • Amazon Linux 2, RHEL, CentOS, and Rocky Linux $ sudo rpm --import https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY • Ubuntu $ wget https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY Step 2: Set up the broker 8 Amazon DCV Session Manager Administrator Guide $ gpg --import NICE-GPG-KEY 3. Download the installation package. • Amazon Linux 2 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el7.noarch.rpm • Amazon Linux 2023 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.amzn2023.noarch.rpm • RHEL 8.x, and Rocky Linux 8.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el8.noarch.rpm • CentOS 9.x, RHEL 9.x, and Rocky Linux 9.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el9.noarch.rpm • Ubuntu 20.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker_2024.0.504-1_all.ubuntu2004.deb • Ubuntu 22.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker_2024.0.504-1_all.ubuntu2204.deb • Ubuntu 24.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker_2024.0.504-1_all.ubuntu2404.deb 4. Install the package. Step 2: Set up the broker 9 Amazon DCV Session Manager • Amazon Linux 2 Administrator Guide $ sudo yum install -y ./nice-dcv-session-manager- broker-2024.0.504-1.el7.noarch.rpm • Amazon Linux 2023 $ sudo yum install -y ./nice-dcv-session-manager- broker-2024.0.504-1.amzn2023.noarch.rpm • RHEL 8.x and Rocky Linux 8.x $ sudo yum install -y ./nice-dcv-session-manager- broker-2024.0.504-1.el8.noarch.rpm • CentOS 9.x, RHEL 9.x, and Rocky Linux 9.x $ sudo yum install -y ./nice-dcv-session-manager- broker-2024.0.504-1.el9.noarch.rpm • Ubuntu 20.04 $ sudo apt install -y ./nice-dcv-session-manager- broker_2024.0.504-1_all.ubuntu2004.deb • Ubuntu 22.04 $ sudo apt install -y ./nice-dcv-session-manager- broker_2024.0.504-1_all.ubuntu2204.deb • Ubuntu 24.04 $ sudo apt install -y ./nice-dcv-session-manager- broker_2024.0.504-1_all.ubuntu2404.deb 5. Check that the default Java environment version is 11 $ java -version Step 2: Set up the broker 10 Amazon DCV Session Manager Administrator Guide If not, you can explicitly set the Java home directory that the broker will use to target the right Java version. This is done setting the parameter broker-java-home in the broker conﬁguration ﬁle. For more information, see broker Conﬁguration File. 6. Start the broker service and ensure that it starts automatically every time the instance starts. $ sudo systemctl start dcv-session-manager-broker && sudo systemctl enable dcv- session-manager-broker 7. Place a copy of the broker's self-signed certiﬁcate in your user directory. You'll need it when you install the agents in the next step. sudo cp /var/lib/dcvsmbroker/security/dcvsmbroker_ca.pem $HOME Step 3: Set up the Amazon DCV Session Manager agent The agent must be installed on all of
sm-admin-005	sm-admin.pdf	5	use to target the right Java version. This is done setting the parameter broker-java-home in the broker conﬁguration ﬁle. For more information, see broker Conﬁguration File. 6. Start the broker service and ensure that it starts automatically every time the instance starts. $ sudo systemctl start dcv-session-manager-broker && sudo systemctl enable dcv- session-manager-broker 7. Place a copy of the broker's self-signed certiﬁcate in your user directory. You'll need it when you install the agents in the next step. sudo cp /var/lib/dcvsmbroker/security/dcvsmbroker_ca.pem $HOME Step 3: Set up the Amazon DCV Session Manager agent The agent must be installed on all of the Amazon DCV server hosts in the ﬂeet. The agent can be installed on both Windows and Linux servers. For more information about the supported operating systems, see Amazon DCV Session Manager requirements. Prerequisites The Amazon DCV server must be installed on the host before installing the agent. Linux host Note The Session Manager agent is available for the Linux distributions and architectures listed in Requirements: The following instructions are for installing the agent on 64-bit x86 hosts. To install the agent on 64-bit ARM hosts replace x86_64 with aarch64. For Ubuntu, replace amd64 with arm64. Step 3: Set up the agent 11 Amazon DCV Session Manager Administrator Guide To install the agent on a Linux host 1. The packages are digitally signed with a secure GPG signature. To allow the package manager to verify the package signature, you must import the Amazon DCV GPG key. Run the following command to import the Amazon DCV GPG key. • Amazon Linux 2, RHEL, CentOS, and SUSE Linux Enterprise $ sudo rpm --import https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY • Ubuntu $ wget https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY $ gpg --import NICE-GPG-KEY 2. Download the installation package. • Amazon Linux 2 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.801-1.el7.x86_64.rpm • Amazon Linux 2023 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.amzn2023.x86_64.rpm • RHEL 8.x and Rocky Linux 8.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.el8.x86_64.rpm • CentOS 9.x, RHEL 9.x, and Rocky Linux 9.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.el9.x86_64.rpm • Ubuntu 20.04 Step 3: Set up the agent 12 Amazon DCV Session Manager Administrator Guide $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent_2024.0.817-1_amd64.ubuntu2004.deb • Ubuntu 22.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent_2024.0.817-1_amd64.ubuntu2204.deb • Ubuntu 24.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent_2024.0.817-1_amd64.ubuntu2404.deb • SUSE Linux Enterprise 12 $ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.sles12.x86_64.rpm • SUSE Linux Enterprise 15 $ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.sles15.x86_64.rpm 3. Install the package. • Amazon Linux 2 $ sudo yum install -y ./nice-dcv-session-manager- agent-2024.0.817-1.el7.x86_64.rpm • Amazon Linux 2023 $ sudo yum install -y ./nice-dcv-session-manager- agent-2024.0.817-1.amzn2023.x86_64.rpm • RHEL 8.x and Rocky Linux 8.x $ sudo yum install -y ./nice-dcv-session-manager- agent-2024.0.817-1.el8.x86_64.rpm • CentOS 9.x, RHEL 9.x, and Rocky Linux 9.x Step 3: Set up the agent 13 Amazon DCV Session Manager Administrator Guide $ sudo yum install -y ./nice-dcv-session-manager- agent-2024.0.817-1.el9.x86_64.rpm • Ubuntu 20.04 $ sudo apt install ./nice-dcv-session-manager- agent_2024.0.817-1_amd64.ubuntu2004.deb • Ubuntu 22.04 $ sudo apt install ./nice-dcv-session-manager- agent_2024.0.817-1_amd64.ubuntu2204.deb • Ubuntu 24.04 $ sudo apt install ./nice-dcv-session-manager- agent_2024.0.817-1_amd64.ubuntu2404.deb • SUSE Linux Enterprise 12 $ sudo zypper install ./nice-dcv-session-manager- agent-2024.0.817-1.sles12.x86_64.rpm • SUSE Linux Enterprise 15 $ sudo zypper install ./nice-dcv-session-manager- agent-2024.0.817-1.sles15.x86_64.rpm 4. Place a copy of the broker's self-signed certiﬁcate (that you copied in the previous step) in the /etc/dcv-session-manager-agent/ directory on the agent. 5. Open /etc/dcv-session-manager-agent/agent.conf using your preferred text editor and do the following. • For broker_host, specify the DNS name of the host on which the broker is installed. Important If the broker is running on an Amazon EC2 instance, for broker_host you must specify the instance's private Ipv4 address. Step 3: Set up the agent 14 Amazon DCV Session Manager Administrator Guide • (Optional) For broker_port, specify the port over which to communicate with the broker. By default the agent and the broker communicate over port 8445. Only change this if you need to use a diﬀerent port. If you do change it, ensure that the broker is conﬁgured to use the same port. • For ca_file, specify the full path the certiﬁcate ﬁle that you copied in the previous step. For example: ca_file = '/etc/dcv-session-manager-agent/broker_cert.pem' Alternatively, if you want to disable TLS veriﬁcation, set tls_strict to false. 6. Save and close the ﬁle. 7. Run the following command to start the agent. $ sudo systemctl start dcv-session-manager-agent Windows host To install the agent on a Windows host 1. Download the agent installer. 2. Run the installer. On the Welcome screen, choose Next. 3. On the EULA screen, carefully read the license agreement, and if you agree, select I accept the terms and choose Next. 4. To begin the installation, choose Install. 5. Place a copy of the broker's self-signed certiﬁcate (that you copied in the previous step) in the C:\Program Files\NICE\DCVSessionManagerAgent\conf\ folder on the agent. 6. Open C:\Program Files\NICE\DCVSessionManagerAgent\conf\agent.conf using your preferred text editor, and then do the following: • For broker_host, specify the DNS name of the host on which the broker is installed. Important If the
sm-admin-006	sm-admin.pdf	6	Download the agent installer. 2. Run the installer. On the Welcome screen, choose Next. 3. On the EULA screen, carefully read the license agreement, and if you agree, select I accept the terms and choose Next. 4. To begin the installation, choose Install. 5. Place a copy of the broker's self-signed certiﬁcate (that you copied in the previous step) in the C:\Program Files\NICE\DCVSessionManagerAgent\conf\ folder on the agent. 6. Open C:\Program Files\NICE\DCVSessionManagerAgent\conf\agent.conf using your preferred text editor, and then do the following: • For broker_host, specify the DNS name of the host on which the broker is installed. Important If the broker is running on an Amazon EC2 instance, for broker_host you must specify the instance's private IPv4 address. Step 3: Set up the agent 15 Amazon DCV Session Manager Administrator Guide • (Optional) For broker_port, specify the port over which to communicate with the broker. By default the agent and the broker communicate over port 8445. Only change this if you need to use a diﬀerent port. If you do change it, ensure that the broker is conﬁgured to use the same port. • For ca_file, specify the full path the certiﬁcate ﬁle that you copied in the previous step. For example: ca_file = 'C:\Program Files\NICE\DCVSessionManagerAgent\conf\broker_cert.pem' 7. 8. Alternatively, if you want to disable TLS veriﬁcation, set tls_strict to false. Save and close the ﬁle. Stop and restart the agent service for the changes to take eﬀect. Run the following commands at the command prompt. C:\> sc stop DcvSessionManagerAgentService C:\> sc start DcvSessionManagerAgentService Step 4: Conﬁgure the Amazon DCV server to use the broker as the authentication server Conﬁgure the Amazon DCV server to use the broker as the external authentication server for validating client connection tokens. You must also conﬁgure the Amazon DCV server to trust the broker's self-signed CA. Linux Amazon DCV server To add the local service user for Linux Amazon DCV servers 1. Open /etc/dcv/dcv.conf using your preferred text editor. 2. Add the ca-file and auth-token-verifier parameters to the [security] section. • For ca-file, specify the path to the broker's self-signed CA that you copied to the host in the previous step. Step 4: Conﬁgure the Amazon DCV server 16 Amazon DCV Session Manager Administrator Guide • For auth-token-verifier, specify the URL for the token veriﬁer on the broker in the following format: https://broker_ip_or_dns:port/agent/validate- authentication-token. Specify the port used for broker-agent communication, which is 8445 by default. If you are running the broker on an Amazon EC2 instance, you must use the private DNS or private IP address. For example [security] ca-file="/etc/dcv-session-manager-agent/broker_cert.pem" auth-token-verifier="https://my-sm-broker.com:8445/agent/validate- authentication-token" 3. 4. Save and close the ﬁle. Stop and restart the Amazon DCV server. For more information, see Stopping the Amazon DCV Server and Starting the Amazon DCV Server in the Amazon DCV Administrator Guide. Windows Amazon DCV server On Windows Amazon DCV servers 1. Open the Windows Registry Editor and navigate to the HKEY_USERS/S-1-5-18/Software/ GSettings/com/nicesoftware/dcv/security/ key. 2. Open the ca-ﬁle parameter. 3. For Value data, specify the path to the broker's self-signed CA that you copied to the host in the previous step. Note If the parameter does not exist, create a new string parameter and name it ca- file. 4. Open the auth-token-veriﬁer parameter. 5. For Value data, specify the URL for the token veriﬁer on the broker in the following format: https://broker_ip_or_dns:port/agent/validate-authentication-token. Step 4: Conﬁgure the Amazon DCV server 17 Amazon DCV Session Manager Administrator Guide 6. Specify the port used for broker-agent communication, which is 8445 by default. If you are running the broker on an Amazon EC2 instance, you must use the private DNS or private IP address. Note If the parameter does not exist, create a new string parameter and name it auth- token-verifier. 7. Choose OK and close the Windows Registry Editor. 8. Stop and restart the Amazon DCV server. For more information, see Stopping the Amazon DCV Server and Starting the Amazon DCV Server in the Amazon DCV Administrator Guide. Step 5: Verify the installations After you have set up the agent, set up the broker, and conﬁgured both on the Amazon DCV server, you need to verify that the installations are functioning properly. Topics • Verify the agent • Verify the broker Verify the agent After you have installed the broker and the agent, make sure that the agent is running and that it's able to connect to the broker. Linux agent host The command to run depends on the version. • Since version 2022.0 From the agent host, run the following command: $ grep 'sessionsUpdateResponse' /var/log/dcv-session-manager-agent/agent.log \| tail -1 \| grep -o success Step 5: Verify the installations 18 Amazon DCV Session Manager • Versions prior to 2022.0 Administrator Guide From the agent host, run the following command, and specify the current year, month, and day. $ grep 'sessionsUpdateResponse' /var/log/dcv-session-manager-agent/ agent.log.yyyy-mm-dd \|
sm-admin-007	sm-admin.pdf	7	the agent After you have installed the broker and the agent, make sure that the agent is running and that it's able to connect to the broker. Linux agent host The command to run depends on the version. • Since version 2022.0 From the agent host, run the following command: $ grep 'sessionsUpdateResponse' /var/log/dcv-session-manager-agent/agent.log \| tail -1 \| grep -o success Step 5: Verify the installations 18 Amazon DCV Session Manager • Versions prior to 2022.0 Administrator Guide From the agent host, run the following command, and specify the current year, month, and day. $ grep 'sessionsUpdateResponse' /var/log/dcv-session-manager-agent/ agent.log.yyyy-mm-dd \| tail -1 \| grep -o success For example $ grep 'sessionsUpdateResponse' /var/log/dcv-session-manager-agent/ agent.log.2020-11-19 \| tail -1 \| grep -o success If the agent is running and it's able to connect to the broker, the command should return success. If the command returns diﬀerent output, inspect the agent log ﬁle for more information. The log ﬁles are located here: /var/log/dcv-session-manager-agent/. Windows agent host Open the agent log ﬁle, which is located in C:\ProgramData\NICE\DCVSessionManagerAgent \log. If the log ﬁle includes a line similar to the one below, the agent is running and it's able to connect to the broker. 2020-11-02 12:38:03,996919 INFO ThreadId(05) dcvsessionmanageragent::agent:Processing broker message "{\n \"sessionsUpdateResponse\" : {\n \"requestId\" : \"69c24a3f5f6d4f6f83ffbb9f7dc6a3f4\",\n \"result\" : {\n \"success\" : true\n }\n }\n}" If your log ﬁle doesn’t have a similar line, inspect the log ﬁle for errors. Verify the broker After you have installed the broker and agent, make sure that your broker is running and that it's reachable from your users and front-end applications. From a computer that should be able to reach the broker, run the following command: Verify the broker 19 Amazon DCV Session Manager Administrator Guide $ curl -X GET https://broker_host_ip:port/sessionConnectionData/aSession/aOwner -- insecure If the veriﬁcation is successful, the broker returns the following: { "error": "No authorization header" } Verify the broker 20 Amazon DCV Session Manager Administrator Guide Conﬁguring Amazon DCV Session Manager To provide a seamless and secure experience, it is important to properly conﬁgure Session Manager according to your organization's needs and requirements. This section walks you through the key steps involved in setting up and conﬁguring the Session Manager, including managing user access, conﬁguring network settings, and customizing session settings. Topics • Scaling Session Manager • Using tags to target Amazon DCV servers • Conﬁguring an external authorization server • Conﬁguring broker persistence • Integrating with the Amazon DCV Connection Gateway • Integrating with Amazon CloudWatch Scaling Session Manager To enable high availability and improve performance, you can conﬁgure Session Manager to use multiple Agents and Brokers. If you do intend to use multiple Agents and Brokers, we recommend that you install and conﬁgure only one Agent and Broker host, create Amazon Machines Images (AMI) from those hosts, and then launch the remaining hosts from the AMIs. By default, Session Manager supports the use of multiple Agents without any additional conﬁguration. However, if you intend to use multiple Brokers, you must use a load balancer to balance the traﬃc between the frontend client and the Brokers, and between the Brokers and the Agents. Load balancer setup and conﬁguration is entirely owned and managed by you. The following section explains how to conﬁgure Session Manager to use multiple hosts with an Application Load Balancer. Steps • Step 1: Create an instance proﬁle • Step 2: Prepare the SSL certiﬁcate for the load balancer • Step 3: Create the Broker application load balancer • Step 4: Launch the Brokers Scaling Session Manager 21 Amazon DCV Session Manager Administrator Guide • Step 5: Create the Agent application load balancer • Step 6: Launch the Agents Step 1: Create an instance proﬁle You must attach an instance proﬁle to the Broker and Agent hosts that give them permission to use the Elastic Load Balancing APIs. For more information, see IAM roles for Amazon EC2 in the Amazon EC2 User Guide. To create an instance proﬁle 1. Create an AWS Identity and Access Management (IAM) role that deﬁnes the permissions to use in the instance proﬁle. Use the following trust policy: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } Then attach the following policy: { "Version": "2012-10-17", "Statement": [ { "Action": [ "ec2:DescribeInstances" ], "Effect": "Allow", "Resource": "" }, { "Action": [ Step 1: Create an instance proﬁle 22 Amazon DCV Session Manager Administrator Guide "elasticloadbalancing:DescribeTargetHealth" ], "Effect": "Allow", "Resource": "" } ] } For more information, see Creating an IAM role in the IAM User Guide. 2. Create a new instance proﬁle. For more information, see create-instance-proﬁle in the AWS CLI Command Reference. 3. Add the IAM role to the instance proﬁle. For more information, see add-role-to-instance- proﬁle in the AWS CLI Command Reference. 4. Attach the instance proﬁle
sm-admin-008	sm-admin.pdf	8	attach the following policy: { "Version": "2012-10-17", "Statement": [ { "Action": [ "ec2:DescribeInstances" ], "Effect": "Allow", "Resource": "" }, { "Action": [ Step 1: Create an instance proﬁle 22 Amazon DCV Session Manager Administrator Guide "elasticloadbalancing:DescribeTargetHealth" ], "Effect": "Allow", "Resource": "" } ] } For more information, see Creating an IAM role in the IAM User Guide. 2. Create a new instance proﬁle. For more information, see create-instance-proﬁle in the AWS CLI Command Reference. 3. Add the IAM role to the instance proﬁle. For more information, see add-role-to-instance- proﬁle in the AWS CLI Command Reference. 4. Attach the instance proﬁle to the Broker hosts. For more information, see Attaching an IAM role to an instance in the Amazon EC2 User Guide. Step 2: Prepare the SSL certiﬁcate for the load balancer When you use HTTPS for your load balancer listener, you must deploy an SSL certiﬁcate on your load balancer. The load balancer uses this certiﬁcate to terminate the connection and decrypt requests from clients before sending them to the targets. To prepare the SSL certiﬁcate 1. Create a private certiﬁcate authority (CA) AWS Certiﬁcate Manager Private Certiﬁcate Authority (ACM PCA). For more information, see Procedures for Creating a CA in the AWS Certiﬁcate Manager Private Certiﬁcate Authority User Guide. 2. Install the CA. For more information, see Installing a Root CA Certiﬁcate in the AWS Certiﬁcate Manager Private Certiﬁcate Authority User Guide. 3. Request a new private certiﬁcate signed by the CA. For the domain name, use *.region.elb.amazonaws.com and specify the Region in which you intend to create the load balancer. For more information, see Requesting a Private Certiﬁcate in the AWS Certiﬁcate Manager Private Certiﬁcate Authority User Guide. Step 2: Prepare the SSL certiﬁcate for the load balancer 23 Amazon DCV Session Manager Administrator Guide Step 3: Create the Broker application load balancer Create an application load balancer to balance the traﬃc between your front-end clients and the Brokers. To create the load balancer 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. In the navigation pane, choose Load Balancers and then choose Create Load Balancer. For load balancer type, choose Application Load Balancer. 2. For Step 1: Conﬁgure Load Balancer, do the following: a. b. c. d. e. For Name, enter a descriptive name for the load balancer. For Scheme, select internet-facing. For Load Balancer Protocol, select HTTPS, and for Load Balancer Port, enter 8443. For VPC, select the VPC to use and then select all of the subnets in that VPC. Choose Next. 3. For Step 2: Conﬁgure Security Settings, do the following: a. b. c. For Certiﬁcate type, choose Choose a certiﬁcate from ACM. For Certiﬁcate name, select the private certiﬁcate that you requested earlier. Choose Next. 4. For Step 3: Conﬁgure Security Groups, create a new security group, or select an existing security group that allows inbound and outbound traﬃc between your frontend client and the Brokers over HTTPS and port 8443. Choose Next. 5. For Step 4: Conﬁgure Routing, do the following: a. b. c. d. e. f. For Target group, select New target group. For Name, enter a name for the target group. For Target type, choose Instance. For Protocol, select HTTPS. For Port, enter 8443. For Protocol version, choose HTTP1. For the health check Protocol, choose HTTPS, and for Path, enter /health. Choose Next. Step 3: Create the Broker application load balancer 24 Amazon DCV Session Manager Administrator Guide 6. For Step 5: Register Targets, choose Next. 7. Choose Create. Step 4: Launch the Brokers Create an initial Broker and conﬁgure it to use the load balancer, create an AMI from the Broker, and then use the AMI to launch the remaining Brokers. This ensures that all of the Brokers are conﬁgure to use the same CA and the same load balancer conﬁguration. To launch the Brokers 1. Launch and conﬁgure the initial Broker host. For more information about installing and conﬁguring the Broker, see Step 2: Set up the Amazon DCV Session Manager broker. Note Broker's self signed certiﬁcate is not needed since we are using an application load balancer. 2. Connect to the Broker, open /etc/dcv-session-manager-broker/session-manager- broker.properties using your preferred text editor, and do the following: a. b. c. Comment out the broker-to-broker-discovery-addresses parameter by placing a hash (#) at the start of the line. For broker-to-broker-discovery-aws-region, enter the Region in which you created the application load balancer. For broker-to-broker-discovery-aws-alb-target-group-arn, enter the ARN of the target group associated with the Broker load balancer. d. Save and close the ﬁle. 3. Stop the Broker instance. 4. Create an AMI from the stopped Broker instance. For more information, see Creating a Linux AMI from an instance in the Amazon EC2 User Guide for Linux Instances. 5. Use the AMI to launch the remaining Brokers. 6. Assign the instance proﬁle that you created
sm-admin-009	sm-admin.pdf	9	out the broker-to-broker-discovery-addresses parameter by placing a hash (#) at the start of the line. For broker-to-broker-discovery-aws-region, enter the Region in which you created the application load balancer. For broker-to-broker-discovery-aws-alb-target-group-arn, enter the ARN of the target group associated with the Broker load balancer. d. Save and close the ﬁle. 3. Stop the Broker instance. 4. Create an AMI from the stopped Broker instance. For more information, see Creating a Linux AMI from an instance in the Amazon EC2 User Guide for Linux Instances. 5. Use the AMI to launch the remaining Brokers. 6. Assign the instance proﬁle that you created to all of the Broker instances. Step 4: Launch the Brokers 25 Amazon DCV Session Manager Administrator Guide 7. Assign a security group which allows Broker to Broker and Broker to load balancer network traﬃc to all of the Broker instances. For more information about network ports, see Broker Conﬁguration File. 8. Register all of the Broker instances as targets for the Broker load balancer. For more information, see Register targets with your target group in the User Guide for Application Load Balancers. Step 5: Create the Agent application load balancer Create an application load balancer to balance the Agents and the Brokers. To create the load balancer 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. In the navigation pane, choose Load Balancers and then choose Create Load Balancer. For load balancer type, choose Application Load Balancer. 2. For Step 1: Conﬁgure Load Balancer, do the following: a. b. c. d. e. For Name, enter a descriptive name for the load balancer. For Scheme, select internet-facing. For Load Balancer Protocol, select HTTPS, and for Load Balancer Port, enter 8445. For VPC, select the VPC to use and then select all of the subnets in that VPC. Choose Next. 3. For Step 2: Conﬁgure Security Settings, do the following: a. b. c. For Certiﬁcate type, choose Choose a certiﬁcate from ACM. For Certiﬁcate name, select the private certiﬁcate that you requested earlier. Choose Next. 4. For Step 3: Conﬁgure Security Groups, create a new security group, or select an existing security group that allows inbound and outbound traﬃc the Agents and the Brokers over HTTPS and port 8445. Choose Next. 5. For Step 4: Conﬁgure Routing, do the following: Step 5: Create the Agent application load balancer 26 Amazon DCV Session Manager Administrator Guide a. b. c. d. e. f. For Target group, select New target group. For Name, enter a name for the target group. For Target type, choose Instance. For Protocol, select HTTPS. For Port, enter 8445. For Protocol version, choose HTTP1. For the health check Protocol, choose HTTPS, and for Path, enter /health. Choose Next. 6. For Step 5: Register Targets, select all of the Broker instances and choose Add to registered. Choose Next: Review. 7. Choose Create. Step 6: Launch the Agents Create an initial Agent and conﬁgure it to use the load balancer, create an AMI from the Agent, and then use the AMI to launch the remaining Agents. This ensures that all of the Agents are conﬁgured to use the same load balancer conﬁguration. To launch the Agents 1. Prepare the Amazon DCV server. For more information, see Step 1: Prepare the Amazon DCV servers. 2. Place a copy of the CA public key created in Step 2: Prepare the SSL certiﬁcate for the load balancer. Choose or create a directory readable by any user. The CA public key ﬁle must be readable by any user as well. 3. Install and conﬁgure the Agent. For more information about installing and conﬁguring the Agent, see Step 3: Set up the Amazon DCV Session Manager agent. Important When modifying the Agent conﬁguration ﬁle: • for the broker_host parameter, enter the Agent load balancer's DNS • for the ca_file parameter, enter the path to the CA public key ﬁle created in the previous step Step 6: Launch the Agents 27 Amazon DCV Session Manager Administrator Guide 4. Conﬁgure the Amazon DCV server to use the Broker as the authentication server. For more information, see Step 4: Conﬁgure the Amazon DCV server to use the broker as the authentication server. Important When modifying the Amazon DCV server conﬁguration ﬁle: • for the ca-file parameter, enter the same path to the CA public key ﬁle used in the previous step • for the auth-token-verifier parameter, use the Agent load balancer's DNS for broker_ip_or_dns 5. Stop the Agent instance. 6. Create an AMI from the stopped Agent instance. For more information, see Creating a Linux AMI from an instance in the Amazon EC2 User Guide for Linux Instances. 7. Use the AMI to launch the remaining Agents and assign the instance proﬁle that you created to all of them. 8. Assign a security group which allows Agent to load balancer network
sm-admin-010	sm-admin.pdf	10	• for the ca-file parameter, enter the same path to the CA public key ﬁle used in the previous step • for the auth-token-verifier parameter, use the Agent load balancer's DNS for broker_ip_or_dns 5. Stop the Agent instance. 6. Create an AMI from the stopped Agent instance. For more information, see Creating a Linux AMI from an instance in the Amazon EC2 User Guide for Linux Instances. 7. Use the AMI to launch the remaining Agents and assign the instance proﬁle that you created to all of them. 8. Assign a security group which allows Agent to load balancer network traﬃc to all of the Agent instances. For more information about network ports, see Agent Conﬁguration File. Using tags to target Amazon DCV servers You can assign custom tags to Session Manager Agents to help identify and categorize them and the Amazon DCV servers with which they are associated. When creating a new Amazon DCV session, you can target a group of Amazon DCV servers based on the tags that are assigned to their respective Agents. For more information about how to target Amazon DCV servers based on Agent tags, see CreateSessionRequests in the Session Manager Developer Guide. A tag consists of a tag key and value pair, and you can use any information pair that makes sense for your use case or environment. You can choose to tag Agents based on their host's hardware conﬁguration. For example, you can tag all Agents with hosts that have 4 GB of memory with ram=4GB. Or you can tag Agents based on purpose. For example, you can tag all Agents running on production hosts with purpose=production. Using tags on Amazon DCV servers 28 Amazon DCV Session Manager To assign tags to an Agent Administrator Guide 1. Using your preferred text editor, create a new ﬁle and give it a descriptive name, for example agent_tags.toml. The ﬁle type must be .toml, and the ﬁle contents must be speciﬁed in the TOML ﬁle format. 2. In the ﬁle, add each new tag key and value pair on a new line using the key=value format. For example: tag1="abc" tag2="xyz" 3. Open the Agent conﬁguration ﬁle (/etc/dcv-session-manager-agent/agent.conf for Linux or C:\Program Files\NICE\DCVSessionManagerAgent\conf\agent.conf for Windows). For tags_folder, and specify the path to the directory in which the tag ﬁle is located. If the directory contains multiple tag ﬁles, all of the tags deﬁned across the ﬁles apply the Agent. The ﬁles are read in alphabetical order. If multiple ﬁles contain a tag with the same key, the value is overwritten with the value from the last read ﬁle. 4. 5. Save and close the ﬁle. Stop and restart the Agent. • Windows C:\> sc stop DcvSessionManagerAgentService C:\> sc start DcvSessionManagerAgentService • Linux $ sudo systemctl stop dcv-session-manager-agent $ sudo systemctl start dcv-session-manager-agent Using tags on Amazon DCV servers 29 Amazon DCV Session Manager Administrator Guide Conﬁguring an external authorization server The authorization server is the server that is responsible for authenticating and authorizing the client SDKs and Agents. By default, Session Manager uses the Broker as the authorization server to generate OAuth 2.0 access tokens for client SDKs and software statements for Agents. If you use the Broker as the authorization server, no additional conﬁguration is required. You can conﬁgure Session Manager to use Amazon Cognito as an external authorization server instead of the Broker. For more information, about Amazon Cognito, see the Amazon Cognito Developer Guide. To use Amazon Cognito as the authorization server 1. Create a new Amazon Cognito user pool. For more information about user pools, see Features of Amazon Cognito in the Amazon Cognito Developer Guide. Use the create-user-pool command, and specify a pool name and the Region in which to create it. In this example, we name the pool dcv-session-manager-client-app and we create it in us-east-1. $ aws cognito-idp create-user-pool --pool-name dcv-session-manager-client-app -- region us-east-1 Example output { "UserPoolClient": { "UserPoolId": "us-east-1_QLEXAMPLE", "ClientName": "dcv-session-manager-client-app", "ClientId": "15hhd8jij74hf32f24uEXAMPLE", "LastModifiedDate": 1602510048.054, "CreationDate": 1602510048.054, "RefreshTokenValidity": 30, "AllowedOAuthFlowsUserPoolClient": false } } Conﬁguring an external authorization server 30 Amazon DCV Session Manager Administrator Guide Make a note of the userPoolId, you'll need it in the next step. 2. Create a new domain for your user pool. Use the create-user-pool-domain command, and specify a domain name and the userPoolId of the user pool that you created in the previous step. In this example, the domain name is mydomain-544fa30f-c0e5-4a02-8d2a- a3761EXAMPLE and we create it in us-east-1. $ aws cognito-idp create-user-pool-domain --domain mydomain-544fa30f- c0e5-4a02-8d2a-a3761EXAMPLE --user-pool-id us-east-1_QLEXAMPLE --region us-east-1 Example output { "DomainDescription": { "UserPoolId": "us-east-1_QLEXAMPLE", "AWSAccountId": "123456789012", "Domain": "mydomain-544fa30f-c0e5-4a02-8d2a-a3761EXAMPLE", "S3Bucket": "aws-cognito-prod-pdx-assets", "CloudFrontDistribution": "dpp0gtexample.cloudfront.net", "Version": "20201012133715", "Status": "ACTIVE", "CustomDomainConfig": {} } } The format of the user pool domain is as follows: https://domain_name.auth.region.amazoncognito.com. In this example, the user pool domain is https://mydomain-544fa30f-c0e5-4a02-8d2a- a3761EXAMPLE.auth.us-east-1.amazoncognito.com. 3. Create a user pool client. Use the create-user-pool-client
sm-admin-011	sm-admin.pdf	11	create-user-pool-domain command, and specify a domain name and the userPoolId of the user pool that you created in the previous step. In this example, the domain name is mydomain-544fa30f-c0e5-4a02-8d2a- a3761EXAMPLE and we create it in us-east-1. $ aws cognito-idp create-user-pool-domain --domain mydomain-544fa30f- c0e5-4a02-8d2a-a3761EXAMPLE --user-pool-id us-east-1_QLEXAMPLE --region us-east-1 Example output { "DomainDescription": { "UserPoolId": "us-east-1_QLEXAMPLE", "AWSAccountId": "123456789012", "Domain": "mydomain-544fa30f-c0e5-4a02-8d2a-a3761EXAMPLE", "S3Bucket": "aws-cognito-prod-pdx-assets", "CloudFrontDistribution": "dpp0gtexample.cloudfront.net", "Version": "20201012133715", "Status": "ACTIVE", "CustomDomainConfig": {} } } The format of the user pool domain is as follows: https://domain_name.auth.region.amazoncognito.com. In this example, the user pool domain is https://mydomain-544fa30f-c0e5-4a02-8d2a- a3761EXAMPLE.auth.us-east-1.amazoncognito.com. 3. Create a user pool client. Use the create-user-pool-client command and specify the userPoolId of the user pool that you created, a name for the client, and the Region in which to create it. Also, include the --generate-secret option to specify that you want to generate a secret for the user pool client being created. In this case, the client name is dcv-session-manager-client-app and we create it in the us-east-1 Region. Conﬁguring an external authorization server 31 Amazon DCV Session Manager Administrator Guide $ aws cognito-idp create-user-pool-client --user-pool-id us-east-1_QLEXAMPLE -- client-name dcv-session-manager-client-app --generate-secret --region us-east-1 Example output { "UserPoolClient": { "UserPoolId": "us-east-1_QLEXAMPLE", "ClientName": "dcv-session-manager-client-app", "ClientId": "2l9273hp6k2ut5cugg9EXAMPLE", "ClientSecret": "1vp5e8nec7cbf4m9me55mbmht91u61hlh0a78rq1qki1lEXAMPLE", "LastModifiedDate": 1602510291.498, "CreationDate": 1602510291.498, "RefreshTokenValidity": 30, "AllowedOAuthFlowsUserPoolClient": false } } Note Make a note of the ClientId and ClientSecret. You'll need to provide this information to the developers for when they request access tokens for the API requests. 4. Create a new OAuth2.0 resource server for the user pool. A resource server is a server for access-protected resources. It handles authenticated requests for access tokens. Use the create-resource-server command and specify the userPoolId of the user pool, a unique identiﬁer and name for the resource server, the scope, and the Region in which to create it. In this example, we use dcv-session-manager as the identiﬁer and the name, and we use sm_scope as the scope name and description. $ aws cognito-idp create-resource-server --user-pool-id us-east-1_QLEXAMPLE --identifier dcv-session-manager --name dcv-session-manager --scopes ScopeName=sm_scope,ScopeDescription=sm_scope --region us-east-1 Example output Conﬁguring an external authorization server 32 Amazon DCV Session Manager Administrator Guide { "ResourceServer": { "UserPoolId": "us-east-1_QLEXAMPLE", "Identifier": "dcv-session-manager", "Name": "dcv-session-manager", "Scopes": [ { "ScopeName": "sm_scope", "ScopeDescription": "sm_scope" }] } } 5. Update the user pool client. Use the update-user-pool-client command. Specify the userPoolId of the user pool, the ClientId of the user pool client, and the Region. For --allowed-o-auth-flows, specify client_credentials to indicate that the client should get access tokens from the token endpoint by using a combination of a client ID and a client secret. For --allowed- o-auth-scopes, specify the resource server identiﬁer and the scope name as follows: resource_server_identifier/scope_name. Include the --allowed-o-auth-flows- user-pool-client to indicate that the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. $ aws cognito-idp update-user-pool-client --user-pool-id us-east-1_QLEXAMPLE -- client-id 2l9273hp6k2ut5cugg9EXAMPLE --allowed-o-auth-flows client_credentials -- allowed-o-auth-scopes dcv-session-manager/sm_scope --allowed-o-auth-flows-user- pool-client --region us-east-1 Example output { "UserPoolClient": { "UserPoolId": "us-east-1_QLEXAMPLE", "ClientName": "dcv-session-manager-client-app", "ClientId": "2l9273hp6k2ut5cugg9EXAMPLE", "ClientSecret": "1vp5e8nec7cbf4m9me55mbmht91u61hlh0a78rq1qki1lEXAMPLE", "LastModifiedDate": 1602512103.099, "CreationDate": 1602510291.498, "RefreshTokenValidity": 30, Conﬁguring an external authorization server 33 Amazon DCV Session Manager Administrator Guide "AllowedOAuthFlows": [ "client_credentials" ], "AllowedOAuthScopes": [ "dcv-session-manager/sm_scope" ], "AllowedOAuthFlowsUserPoolClient": true } } Note The user pool is now ready to provide and authenticate access tokens. In this example, the URL for the authorization server is https://cognito-idp.us- east-1.amazonaws.com/us-east-1_QLEXAMPLE/.well-known/jwks.json. 6. Test the conﬁguration. $ curl -H "Authorization: Basic `echo - n 2l9273hp6k2ut5cugg9EXAMPLE:1vp5e8nec7cbf4m9me55mbmht91u61hlh0a78rq1qki1lEXAMPLE \| base64`" -H "Content-Type: application/x-www-form-urlencoded" -X POST "https://mydomain-544fa30f-c0e5-4a02-8d2a-a3761EXAMPLE.auth.us- east-1.amazoncognito.com/oauth2/token?grant_type=client_credentials&scope=dcv- session-manager/sm_scope" Example output { "access_token":"eyJraWQiOiJGQ0VaRFpJUUptT3NSaW41MmtqaDdEbTZYb0RnSTQ5b2VUT0cxUUI1Q2VJPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiIybDkyNzNocDZrMnV0NWN1Z2c5dWg4ZGx0cCIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGN2LXNlc3Npb24tbWFuYWdlclwvcGVybWlzc2lvbnMiLCJhdXRoX3RpbWUiOjE2MDI1MTMyODMsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbVwvdXMtd2VzdC0yX1FMZTA3SU9GViIsImV4cCI6MTYwMjUxNjg4MywiaWF0IjoxNjAyNTEzMjgzLCJ2ZXJzaW9uIjoyLCJqdGkiOiIyMDk2YTg4NS04YWQ0LTRmYjgtYjI2Mi1hMmNkNDk0OGZjNjYiLCJjbGllbnRfaWQiOiIybDkyNzNocDZrMnV0NWN1Z2c5dWg4ZGx0cCJ9.ZLZpS4CiiLq1X_VSm911hNT4g8A0FKZXScVJyyV0ijcyOfUOBcpgSMGqJagLYORFuYwLS5c7g4eO04wIwnw21ABGIDcOMElDPCJkrzjfLEPS_eyK3dNmlXDEvdS- Zkfi0HIDsd6audjTXKzHlZGScr6ROdZtId5dThkpEZiSx0YwiiWe9crAlqoazlDcCsUJHIXDtgKW64pSj3- uQQGg1Jv_tyVjhrA4JbD0k67WS2V9NW- uZ7t4zwwaUmOi3KzpBMi54fpVgPaewiVlUm_aS4LUFcWT6hVJjiZF7om7984qb2gOa14iZxpXPBJTZX_gtG9EtvnS9uW0QygTJRNgsw", "expires_in":3600, "token_type":"Bearer" } 7. Register the external authorization server for use with the broker by using the register-auth- server command. Conﬁguring an external authorization server 34 Amazon DCV Session Manager Administrator Guide $ sudo -u root dcv-session-manager-broker register-auth-server --url https:// cognito-idp.us-east-1.amazonaws.com/us-east-1_QLEXAMPLE/.well-known/jwks.json Developers can now use the server to request access tokens. When requesting access tokens, provide the client ID, client secret, and server URL generated here. For more information about requesting access tokens, see Create get an access token and make an API request in theAmazon DCV Session Manager Developer Guide. Conﬁguring broker persistence Session Manager brokers support integration with external databases. The external database allows Session Manager to persist status data and keys so they are available afterwards. In fact the broker data is distributed over the cluster, making it susceptible to data loss if a host needs to reboot or a cluster is terminated. With this feature enabled, you can add and remove broker nodes. Also, you can stop a cluster and restart it, without the need to regenerate keys or lose information about which Amazon DCV Server is open or closed. The following types of information can be set to persist: • Keys for setting up sessions to establish connection with clients • In-ﬂight sessions data • Amazon DCV server status Amazon DCV Session Manager supports DynamoDB, MariaDB, and MySQL databases. You must set
sm-admin-012	sm-admin.pdf	12	the cluster, making it susceptible to data loss if a host needs to reboot or a cluster is terminated. With this feature enabled, you can add and remove broker nodes. Also, you can stop a cluster and restart it, without the need to regenerate keys or lose information about which Amazon DCV Server is open or closed. The following types of information can be set to persist: • Keys for setting up sessions to establish connection with clients • In-ﬂight sessions data • Amazon DCV server status Amazon DCV Session Manager supports DynamoDB, MariaDB, and MySQL databases. You must set up and manage one of these databases to use this feature. If your broker machines are hosted on Amazon EC2, we recommend using DynamoDB as the external database, since it does not require any additional setup. Note You may incur additional costs when running an external database. To see information on DynamoDB pricing, see Pricing for Provisioned Capacity. Conﬁguring broker persistence 35 Amazon DCV Session Manager Administrator Guide Conﬁgure the broker to persist on DynamoDB Conﬁgure the brokers to start storing their data on DynamoDB: 1. Open /etc/dcv-session-manager-broker/session-manager-broker.properties using your preferred text editor and make the following edits: • Set enable-persistence = true • Set persistence-db = dynamodb • For dynamodb-region specify the &aws; Region where you want to store the tables containing the broker data. For the list of supported Regions, see DynamoDB service endpoints. • For dynamodb-table-rcu specify the amount of Read Capacity Units (RCU) that each table supports. For more information about RCU, see DynamoDB provisioned capacity. • For dynamodb-table-wcu specify the amount of Write Capacity Units (WCU) that each table supports. For more info on WCU, see DynamoDB provisioned capacity. • For dynamodb-table-name-preﬁx specify the preﬁx that is added to each DynamoDB table (useful to distinguish multiple broker clusters using the same account). Only alphanumeric characters, dot, dash, and underscore are allowed. 2. Stop all the brokers in the cluster. For each broker, run the following command: sudo systemctl stop dcv-session-manager-broker 3. Ensure all brokers in the cluster are stopped and then restart all of them. Start each broker by running the following command: sudo systemctl start dcv-session-manager-broker The broker host must have permission to call the DynamoDB APIs. On Amazon EC2 instances, the credentials are automatically retrieved using the Amazon EC2 metadata service. If you need to specify diﬀerent credentials, you can set them using one of the supported credential retrieval techniques (such as Java system properties or environment variables). For more information, see Supplying and Retrieving &aws; Credentials. Conﬁgure the broker to persist on DynamoDB 36 Amazon DCV Session Manager Administrator Guide Conﬁgure the broker to persist on MariaDB/MySQL Note The /etc/dcv-session-manager-broker/session-manager-broker.properties ﬁle contains sensitive data. By default, its write access is restricted to root and its read access is restricted to root and to the user running the Broker. By default, this is the dcvsmbroker user. The Broker checks at startup that the ﬁle has the expected permissions. Conﬁgure the brokers to start persisting their data on MariaDB/MySQL: 1. Open /etc/dcv-session-manager-broker/session-manager-broker.properties with your preferred text editor and make the following edits: • Set enable-persistence = true • Set persistence-db = mysql • Set jdbc-connection-url = jdbc:mysql://<db_endpoint>:<db_port>/<db_name>? createDatabaseIfNotExist=true In this conﬁguration, <db_endpoint> is the database endpoint, <db_port> is the database port, and <db_name> is the database name. • For jdbc-user specify the name of the user that has access to the database. • For jdbc-password specify the password of the user that has access to the database. 2. Stop all the brokers in the cluster. For each broker, run the following command: sudo systemctl stop dcv-session-manager-broker 3. Ensure all brokers in the cluster are stopped, and then restart all of them. For each broker, run the following command: sudo systemctl start dcv-session-manager-broker Conﬁgure the broker to persist on MariaDB/MySQL 37 Amazon DCV Session Manager Administrator Guide Integrating with the Amazon DCV Connection Gateway Amazon DCV Connection Gateway is an installable software package that enables users to access a ﬂeet of Amazon DCV servers through a single access point to a LAN or VPC. If your infrastructure includes Amazon DCV servers that are accessible through the Amazon DCV Connection Gateway, you can conﬁgure the Session Manager to integrate the Amazon DCV Connection Gateway. By following the steps outlined in the following section, the broker will act as a Session Resolver for the Connection Gateway. In other words, the broker will expose an additional HTTP endpoint. The Connection Gateway will make API calls to the endpoint to retrieve the information needed to route Amazon DCV connections to the host selected by the broker. Topics • Set up the Session Manager Broker as a Session Resolver for the Amazon DCV Connection Gateway • Optional - Enable TLS client authentication • Amazon DCV Session Manager Amazon DCV server
sm-admin-013	sm-admin.pdf	13	Manager to integrate the Amazon DCV Connection Gateway. By following the steps outlined in the following section, the broker will act as a Session Resolver for the Connection Gateway. In other words, the broker will expose an additional HTTP endpoint. The Connection Gateway will make API calls to the endpoint to retrieve the information needed to route Amazon DCV connections to the host selected by the broker. Topics • Set up the Session Manager Broker as a Session Resolver for the Amazon DCV Connection Gateway • Optional - Enable TLS client authentication • Amazon DCV Session Manager Amazon DCV server - DNS mapping reference Set up the Session Manager Broker as a Session Resolver for the Amazon DCV Connection Gateway Session Manager Broker side 1. Open /etc/dcv-session-manager-broker/session-manager-broker.properties using your preferred text editor and apply the following changes: • Set enable-gateway = true • Set gateway-to-broker-connector-https-port to a free TCP port (default is 8447) • Set gateway-to-broker-connector-bind-host to the IP address of the host where the Broker binds for Amazon DCV Connection Gateway connections (default is 0.0.0.0) 2. Then run the following commands to stop and restart the Broker: sudo systemctl stop dcv-session-manager-broker sudo systemctl start dcv-session-manager-broker Integrating with the Amazon DCV Connection Gateway 38 Amazon DCV Session Manager Administrator Guide 3. Retrieve a copy of the Broker's self-signed certiﬁcate and place it in your user directory. sudo cp /var/lib/dcvsmbroker/security/dcvsmbroker_ca.pem $HOME You'll need it when you install the Amazon DCV Connection Gateway in the next step. Amazon DCV Connection Gateway side • Please follow the section in the Amazon DCV Connection Gateway documentation. Since the Amazon DCV Connection Gateway makes HTTP API calls to the broker, if the broker is using a self-signed certiﬁcate, you will need to copy the broker certiﬁcate to the Amazon DCV Connection Gateway host (retrieved in the previous step) and set the ca-file parameter in the [resolver] section of the Amazon DCV Connection Gateway conﬁguration. Optional - Enable TLS client authentication Once you have completed the previous step, the Session Manager and the Connection Gateway can communicate over a secure channel, where the Connection Gateway can verify the identity of the Session Manager Brokers. If you require that also the Session Manager Brokers validate the identity of the Connection Gateway before establishing the secure channel, you need to enable the TLS client authentication feature, following the steps in the next section. Note If the Session Manager is behind a load balancer, TLS client authentication cannot be enabled with load balancers that have TLS connection termination, such as Application Load Balancers (ALBs) or Gateway Load Balancers (GLBs). Only load balancers without TLS termination can be supported, such as Network Load Balancers (NLBs). If you use ALBs or GLBs, you can enforce that only speciﬁc security groups can contact the load balancers, ensuring an additional level of security; more info about security groups here: Security groups for your VPC Session Manager Broker side 1. To enable the TLS client authentication for the communication between the Session Manager Brokers and the Amazon DCV Connection Gateway, please follow the next steps: Optional - Enable TLS client authentication 39 Amazon DCV Session Manager Administrator Guide 2. Generate the required keys and certiﬁcates by running: The output of the command will tell you the folder where the credentials have been generated and the password used for creating the TrustStore ﬁle. sudo /usr/share/dcv-session-manager-broker/bin/gen-gateway-certificates.sh 3. Place a copy of the Amazon DCV Connection Gateway's private key and self-signed certiﬁcate in your user directory. You'll need it when you enable the TLS client authentication in the Amazon DCV Connection Gateway in the next step. sudo cp /etc/dcv-session-manager-broker/resolver-creds/dcv_gateway_key.pem $HOME sudo cp /etc/dcv-session-manager-broker/resolver-creds/dcv_gateway_cert.pem $HOME 4. Then open /etc/dcv-session-manager-broker/session-manager-broker.properties using your preferred text editor and do the following: • Set enable-tls-client-auth-gateway to true • Set gateway-to-broker-connector-trust-store-file to the path of the TrustStore ﬁle created in the previous step • Set gateway-to-broker-connector-trust-store-pass to the password used for creating the TrustStore ﬁle in the previous step 5. Then run the following command to stop and restart the Broker: sudo systemctl stop dcv-session-manager-broker sudo systemctl start dcv-session-manager-broker Amazon DCV Connection Gateway side • Please follow the section in the Amazon DCV Connection Gateway documentation. • use the full path of the certiﬁcate ﬁle that you copied in the previous step when setting the cert-file parameter in the [resolver] section • use the full path of the key ﬁle that you copied in the previous step when setting the cert- key-file parameter in the [resolver] section Optional - Enable TLS client authentication 40 Amazon DCV Session Manager Administrator Guide Amazon DCV Session Manager Amazon DCV server - DNS mapping reference The Amazon DCV Connection Gateway requires the Amazon DCV servers’ DNS names in order to connect to the DCV server instances. This section illustrates how you can deﬁne a JSON ﬁle containing
sm-admin-014	sm-admin.pdf	14	certiﬁcate ﬁle that you copied in the previous step when setting the cert-file parameter in the [resolver] section • use the full path of the key ﬁle that you copied in the previous step when setting the cert- key-file parameter in the [resolver] section Optional - Enable TLS client authentication 40 Amazon DCV Session Manager Administrator Guide Amazon DCV Session Manager Amazon DCV server - DNS mapping reference The Amazon DCV Connection Gateway requires the Amazon DCV servers’ DNS names in order to connect to the DCV server instances. This section illustrates how you can deﬁne a JSON ﬁle containing the mapping between each DCV Server and its associated DNS name. File structure The mapping consists of a list of JSON objects with the following ﬁelds: [ { “ServerIdType”: "Ip", “ServerId”: "192.168.0.1", “DnsNames”: { “InternalDnsName”: "internal" } }, ... ] Where: ServerIdType: Identiﬁes which type of id the value refers to; currently the available values are ipAddress, agentServerId, and instanceId: Ip: Available for both Amazon EC2 and on premise infrastructures; can be quickly retrieved by system administrators with an ifconﬁg (Linux) or ipconﬁg (Windows) command. This info is also available in the DescribeServers API response. Id: Available for both Amazon EC2 and on premise infrastructures; the Session Manager Agent creates a new UUID every time the hostname or the ip address changes. This info is available in the DescribeServers API response. Amazon DCV server - DNS mapping reference 41 Amazon DCV Session Manager Administrator Guide Host.Aws.Ec2InstanceId: Available only for Amazon EC2 instances, it uniquely identiﬁes a machine; it does not change after an instance reboot. Can be retrieved on the host by contacting http://169.254.169.254/latest/meta-data/instance-id. This info is also available in the DescribeServers API response. ServerId: An Id of the speciﬁed type that uniquely identiﬁes each Amazon DCV server in the network. DnsNames: The object containing the DNS names associated with the Amazon DCV server this object will contain: InternalDnsNames: The DNS name used by the Amazon DCV Connection Gateway to connect to the instance. Please use the Session Manager Broker CLI commands register-server-dns-mapping to load the mapping from a ﬁle (command page reference: register-server-dns-mapping) and describe- server-dns-mappings to list the mappings currently loaded in the Session Manager Broker (command page reference: describe-server-dns-mappings). Persistence We strongly recommend that you enable the persistence feature of the Session Manager Broker, to protect against the mapping loss when multiple brokers or the entire cluster go down. For more information about enabling data persistence, see Conﬁgure Broker Persistence Integrating with Amazon CloudWatch Session Manager supports integration with Amazon CloudWatch for Brokers running on Amazon EC2 instances, and also Brokers running on on-premises hosts. Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are variables you can measure for your resources and applications. For more information, see the Amazon CloudWatch User Guide. Integrating with Amazon CloudWatch 42 Amazon DCV Session Manager Administrator Guide You can conﬁgure the Session Manager Broker to send the following metric data to Amazon CloudWatch: • Number of DCV servers—The number of DCV servers managed by the Broker. • Number of ready DCV servers—The number of DCV servers that are in the READY state managed by the Broker. • Number of DCV sessions—The number of DCV sessions managed by the Broker. • Number of DCV console sessions—The number of DCV console sessions managed by the Broker. • Number of DCV virtual sessions—The number of DCV virtual sessions managed by the Broker. • Heap memory used—The amount of heap memory used by the Broker. • Off-heap memory used—The amount of oﬀ-heap memory used by the Broker. • Describe sessions request time—The amount of time taken to complete DescribeSessions API requests. • Delete sessions request time—The amount of time taken to complete DeleteSessions API requests. • Create sessions request time—The amount of time taken to complete CreateSessions API requests. • Get session connection data request time—The amount of time taken to complete GetSessionConnectionData API requests. • Update session permissions sequest time—The amount of time taken to complete UpdateSessionPermissions API requests. To conﬁgure the Broker to send metric data to the Amazon CloudWatch 1. Open /etc/dcv-session-manager-broker/session-manager-broker.properties using your preferred text editor and do the following: • Set enable-cloud-watch-metrics to true • For cloud-watch-region, specify the Region in which to collect the metric data. Integrating with Amazon CloudWatch 43 Amazon DCV Session Manager Administrator Guide Note If your Broker is running on an Amazon EC2 instance, this parameter is optional. The Region is automatically retrieved from the Instance Metadata Service (IMDS). If you are running the Broker on an on-premises host, this parameter is mandatory. 2. Stop and restart the Broker. $ sudo systemctl stop dcv-session-manager-broker $ sudo systemctl start dcv-session-manager-broker The Broker host must also
sm-admin-015	sm-admin.pdf	15	/etc/dcv-session-manager-broker/session-manager-broker.properties using your preferred text editor and do the following: • Set enable-cloud-watch-metrics to true • For cloud-watch-region, specify the Region in which to collect the metric data. Integrating with Amazon CloudWatch 43 Amazon DCV Session Manager Administrator Guide Note If your Broker is running on an Amazon EC2 instance, this parameter is optional. The Region is automatically retrieved from the Instance Metadata Service (IMDS). If you are running the Broker on an on-premises host, this parameter is mandatory. 2. Stop and restart the Broker. $ sudo systemctl stop dcv-session-manager-broker $ sudo systemctl start dcv-session-manager-broker The Broker host must also have permission to call the cloudwatch:PutMetricData API. AWS credentials can be retrieved using one of the supported credential retrieval techniques. For more information, see Supplying and Retrieving AWS Credentials. Integrating with Amazon CloudWatch 44 Amazon DCV Session Manager Administrator Guide Upgrading the Amazon DCV Session Manager As Amazon DCV systems grow in scale and complexity, it is important to ensure the Session Manager remains up-to-date and able to handle increasing demands. Both the agent and broker packages will require upgrading from time to time. This section outlines the process for upgrading the Amazon DCV Session Manager, covering the upgrade procedure and recommendations for maintaining your system. The following topic describes how to upgrade the Session Manager. Note We strongly recommend that you upgrade all the Session Manager agents before upgrading the Session Manager brokers to avoid incompatibility issues when new features are introduced. Topics • Upgrading the Amazon DCV Session Manager agent • Upgrading the Amazon DCV Session Manager broker Upgrading the Amazon DCV Session Manager agent Amazon DCV Session Manager agents receive instructions from the broker and run them on their respective Amazon DCV servers. As part of routine maintenance, agents need to be upgraded to meet new standards and requirements. This section walks you through the upgrading process of your Session Manager agents. Linux host Note The following instructions are for installing the agent on 64-bit x86 hosts. To install the agent on 64-bit ARM hosts, for Amazon Linux, RHEL, and Centos, replace x86_64 with aarch64, and for Ubuntu, replace amd64 with arm64. Upgrading the Amazon DCV Session Manager agent 45 Amazon DCV Session Manager Administrator Guide To update the agent on a Linux host 1. Run the following command to stop the agent. $ sudo systemctl stop dcv-session-manager-agent 2. Download the installation package. • Amazon Linux 2 and RHEL 7.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.el7.x86_64.rpm • RHEL 8.x and Rocky Linux 8.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.el8.x86_64.rpm • Ubuntu 20.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent_2024.0.817-1_amd64.ubuntu2004.deb • Ubuntu 22.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent_2024.0.817-1_amd64.ubuntu2204.deb • Ubuntu 24.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent_2024.0.817-1_amd64.ubuntu2404.deb • SUSE Linux Enterprise 12 $ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.sles12.x86_64.rpm • SUSE Linux Enterprise 15 Upgrading the Amazon DCV Session Manager agent 46 Amazon DCV Session Manager Administrator Guide $ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerAgents/ nice-dcv-session-manager-agent-2024.0.817-1.sles15.x86_64.rpm 3. Install the package. • Amazon Linux 2 and RHEL 7.x $ sudo yum install -y nice-dcv-session-manager- agent-2024.0.817-1.el7.x86_64.rpm • RHEL 8.x and Rocky Linux 8.x $ sudo yum install -y nice-dcv-session-manager- agent-2024.0.817-1.el8.x86_64.rpm • Ubuntu 20.04 $ sudo apt install ./nice-dcv-session-manager- agent_2024.0.817-1_amd64.ubuntu2004.deb • Ubuntu 22.04 $ sudo apt install ./nice-dcv-session-manager- agent_2024.0.817-1_amd64.ubuntu2204.deb • Ubuntu 24.04 $ sudo apt install ./nice-dcv-session-manager- agent_2024.0.817-1_amd64.ubuntu2404.deb • SUSE Linux Enterprise 12 $ sudo zypper install nice-dcv-session-manager- agent-2024.0.817-1.sles12.x86_64.rpm • SUSE Linux Enterprise 15 $ sudo zypper install nice-dcv-session-manager- agent-2024.0.817-1.sles15.x86_64.rpm 4. Run the following command to start the agent. Upgrading the Amazon DCV Session Manager agent 47 Amazon DCV Session Manager Administrator Guide $ sudo systemctl start dcv-session-manager-agent Windows host To update the agent on a Windows host 1. Stop the agent service. Run the following commands at the command prompt. C:\> sc start DcvSessionManagerAgentService 2. Download the agent installer. 3. Run the installer. On the Welcome screen, choose Next. 4. On the EULA screen, carefully read the license agreement, and if you agree, select I accept the terms and choose Next. 5. To begin the installation, choose Install. 6. Restart the agent service. Run the following commands at the command prompt. C:\> sc stop DcvSessionManagerAgentService Upgrading the Amazon DCV Session Manager broker Amazon DCV Session Manager brokers pass API requests to their relevant agents. They are installed on a host separate from the Amazon DCV servers. As part of routine maintenance, brokers need to be upgraded to meet new standards and requirements. This section walks you through the upgrading process of your Session Manager brokers. To upgrade the broker 1. Connect to the host on which you intend to upgrade the broker. 2. Stop the broker service. $ sudo systemctl stop dcv-session-manager-broker 3. Download the installation package. • Amazon Linux 2 and RHEL 7.x Upgrading the Amazon DCV Session Manager broker 48 Amazon DCV Session Manager Administrator Guide $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el7.noarch.rpm • RHEL 8.x and Rocky Linux 8.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el8.noarch.rpm • Ubuntu
sm-admin-016	sm-admin.pdf	16	servers. As part of routine maintenance, brokers need to be upgraded to meet new standards and requirements. This section walks you through the upgrading process of your Session Manager brokers. To upgrade the broker 1. Connect to the host on which you intend to upgrade the broker. 2. Stop the broker service. $ sudo systemctl stop dcv-session-manager-broker 3. Download the installation package. • Amazon Linux 2 and RHEL 7.x Upgrading the Amazon DCV Session Manager broker 48 Amazon DCV Session Manager Administrator Guide $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el7.noarch.rpm • RHEL 8.x and Rocky Linux 8.x $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1.el8.noarch.rpm • Ubuntu 20.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1_all.ubuntu2004.deb • Ubuntu 22.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1_all.ubuntu2204.deb • Ubuntu 24.04 $ wget https://d1uj6qtbmh3dt5.cloudfront.net/2024.0/SessionManagerBrokers/nice- dcv-session-manager-broker-2024.0.504-1_all.ubuntu2404.deb 4. Install the package. • Amazon Linux 2 and RHEL 7.x $ sudo yum install -y nice-dcv-session-manager- broker-2024.0.504-1.el7.noarch.rpm • RHEL 8.x and Rocky Linux 8.x $ sudo yum install -y nice-dcv-session-manager- broker-2024.0.504-1.el8.noarch.rpm • Ubuntu 20.04 $ sudo apt install -y nice-dcv-session-manager- broker-2024.0.504-1_all.ubuntu2004.deb • Ubuntu 22.04 Upgrading the Amazon DCV Session Manager broker 49 Amazon DCV Session Manager Administrator Guide $ sudo apt install -y nice-dcv-session-manager- broker-2024.0.504-1_all.ubuntu2204.deb • Ubuntu 24.04 $ sudo apt install -y nice-dcv-session-manager- broker-2024.0.504-1_all.ubuntu2404.deb 5. Start the broker service and ensure that it starts automatically every time the instance starts. $ sudo systemctl start dcv-session-manager-broker && sudo systemctl enable dcv- session-manager-broker Upgrading the Amazon DCV Session Manager broker 50 Amazon DCV Session Manager Administrator Guide Broker CLI reference The Amazon DCV Session Manager broker is a command-line interface (CLI) tool that provides administrative control over the Session Manager. This reference covers the complete set of CLI commands available for managing sessions, users, resources, and other aspects of the Session Manager. Administrators can automate routine management tasks, troubleshoot issues, and optimize the performance of their Amazon DCV infrastructure. Use the following commands if you use an external authentication server to generate OAuth 2.0 access tokens: • register-auth-server • list-auth-servers • unregister-auth-server Use the following commands if you use the Session Manager broker as the OAuth 2.0 authentication server. • register-api-client • describe-api-clients • unregister-api-client • renew-auth-server-api-key Use the following commands to manage the Session Manager agent. • generate-software-statement • describe-software-statements • deactivate-software-statement • describe-agent-clients • unregister-agent-client Use the following commands to manage the DCV server - DNS names mapping ﬁle. • register-server-dns-mappings 51 Amazon DCV Session Manager Administrator Guide • describe-server-dns-mappings register-auth-server Registers an external authentication server for use with the broker. By default, Session Manager uses the broker as the authentication server to generate OAuth 2.0 access tokens. If you use the broker as the authentication server, no additional conﬁguration is required. However, if you choose to use an external authentication server, such as Active Directory or Amazon Cognito, you must use this command to register the external authentication server. Topics • Syntax • Options • Example Syntax sudo -u root dcv-session-manager-broker register-auth-server --url server_url.well- known/jwks.json Options --url The URL of the external authentication server to be used. You must append .well-known/ jwks.json to the authentication server URL. Type: String Required: Yes Example The following example registers an external authentication server with a URL of https://my- auth-server.com/. register-auth-server 52 Amazon DCV Session Manager Command Administrator Guide sudo -u root dcv-session-manager-broker register-auth-server --url https://my-auth- server.com/.well-known/jwks.json Output Jwk url registered. list-auth-servers Lists the external authentication servers that have been registered. Topics • Syntax • Output • Example Syntax sudo -u root dcv-session-manager-broker list-auth-servers Output Urls The URLs of the registered external authentication servers. Example The following example lists all external authentication servers that have been registered. Command sudo -u root dcv-session-manager-broker list-auth-servers list-auth-servers 53 Amazon DCV Session Manager Output Administrator Guide Urls: [ "https://my-auth-server.com/.well-known/jwks.json" ] unregister-auth-server Unregisters an external authentication server. After you unregister an external authentication server, it can no longer be used to generate OAuth 2.0 access tokens. Topics • Syntax • Options • Output • Example Syntax sudo -u root dcv-session-manager-broker unregister-auth-server --url server_url.well- known/jwks.json Options --url The URL of the external authentication server to unregister. You must append .well-known/ jwks.json to the authentication server URL. Type: String Required: Yes Output Url The URL of the unregistered external authentication server. unregister-auth-server 54 Amazon DCV Session Manager Example Administrator Guide The following example registers an external authentication server with a URL of https://my- auth-server.com/. Command sudo -u root dcv-session-manager-broker unregister-auth-server --url https://my-auth- server.com/.well-known/jwks.json Output Jwk urlhttps://my-auth-server.com/.well-known/jwks.json unregistered register-api-client Registers a Session Manager client with the broker and generates client credentials that can be used by the client to retrieve an OAuth 2.0 access token, which is needed to make API requests. Important Ensure that you store the credentials in a safe place. They can't be recovered later. This command is used only if the broker is used as the OAuth 2.0 authentication server. Topics • Syntax • Options • Output • Example Syntax sudo -u root dcv-session-manager-broker register-api-client --client-name
sm-admin-017	sm-admin.pdf	17	a URL of https://my- auth-server.com/. Command sudo -u root dcv-session-manager-broker unregister-auth-server --url https://my-auth- server.com/.well-known/jwks.json Output Jwk urlhttps://my-auth-server.com/.well-known/jwks.json unregistered register-api-client Registers a Session Manager client with the broker and generates client credentials that can be used by the client to retrieve an OAuth 2.0 access token, which is needed to make API requests. Important Ensure that you store the credentials in a safe place. They can't be recovered later. This command is used only if the broker is used as the OAuth 2.0 authentication server. Topics • Syntax • Options • Output • Example Syntax sudo -u root dcv-session-manager-broker register-api-client --client-name client_name Example 55 Amazon DCV Session Manager Administrator Guide Options --name A unique name used to identify the Session Manager client. Type: String Required: Yes Output client-id The unique client ID to be used by the Session Manager client to retrieve an OAuth 2.0 access token. client-password The password to be used by the Session Manager client to retrieve an OAuth 2.0 access token. Example The following example registers a client named my-sm-client. Command sudo -u root dcv-session-manager-broker register-api-client --client-name my-sm-client Output client-id: 21cfe9cf-61d7-4c53-b1b6-cf248EXAMPLE client-password: NjVmZDRlN2ItNjNmYS00M2QxLWFlZmMtZmNmMDNkMEXAMPLE describe-api-clients Lists the Session Manager clients that have been registered with the broker. Topics Options 56 Amazon DCV Session Manager Administrator Guide • Syntax • Output • Example Syntax sudo -u root dcv-session-manager-broker describe-api-clients Output name The unique name of the Session Manager client. id The unique ID of the Session Manager client. active Indicates the status of the Session Manager client. If the client is active, the value is true; otherwise, it's false. Example The following example lists the registered Session Manager clients. Command sudo -u root dcv-session-manager-broker describe-api-clients Output Api clients [ { "name" : "client-abc", "id" : "f855b54b-40d4-4769-b792-b727bEXAMPLE", "active" : false Syntax 57 Amazon DCV Session Manager }, { "name" : "client-xyz", "id" : "21cfe9cf-61d7-4c53-b1b6-cf248EXAMPLE", "active" : true }] unregister-api-client Administrator Guide Deactivates a registered Session Manager client. A deactivated Session Manager client can no longer use its credentials to retrieve OAuth 2.0 access tokens. Topics • Syntax • Options • Example Syntax sudo -u root dcv-session-manager-broker unregister-api-client --client-id client_id Options --client -id The client ID of the Session Manager client to deactivate. Type: String Required: Yes Example The following example deactivates a Session Manager client with a client ID of f855b54b-40d4-4769-b792-b727bEXAMPLE. Command unregister-api-client 58 Amazon DCV Session Manager Administrator Guide sudo -u root dcv-session-manager-broker unregister-api-client --client-id f855b54b-40d4-4769-b792-b727bEXAMPLE Output Client f855b54b-40d4-4769-b792-b727bEXAMPLE unregistered. renew-auth-server-api-key Renews the public and private keys used by the broker to sign the OAuth 2.0 access tokens that are vended to the Session Manager client. If you renew the keys, then you must provide the new private key to the developer, as it is needed to make API requests. Topics • Syntax • Example Syntax sudo -u root dcv-session-manager-broker renew-auth-server-api-key Example The following example renews the public and private keys. Command sudo -u root dcv-session-manager-broker renew-auth-server-api-key Output Keys renewed. generate-software-statement Generates a software statement. renew-auth-server-api-key 59 Amazon DCV Session Manager Administrator Guide Agents must be registered with the broker to enable communication. Agents need a software statement in order to register with the broker. After the agent has a software statement, it can automatically register itself with the broker by using the OAuth 2.0 Dynamic Client Registration Protocol. After the agent has registered with the broker, it receives a client ID and client secret that it uses to authenticate with the broker. The broker and agent receive and use a default software statement when they're ﬁrst installed. You can continue to use the default software statement, or you can choose to generate a new one. If you generate a new software statement, you must place the software statement into a new ﬁle on the agent, and then add the ﬁle path to the agent.software_statement_path parameter in the agent.conf ﬁle. After you have done this, stop and restart the agent so that it can use the new software statement to register with the broker. Topics • Syntax • Output • Example Syntax sudo -u root dcv-session-manager-broker generate-software-statement Output software-statement The software statement. Example The following example generates a software statement. Command sudo -u root dcv-session-manager-broker generate-software-statement Output Syntax 60 Amazon DCV Session Manager Administrator Guide software-statement: ewogICJpZCIgOiAiYjc1NTVhN2QtNWI0MC00OTJhLWJjOTUtNmUzOWNhYzkxMDcxIiwKICAiYWN0aXZlIiA6IHRydWUsCiAgImlzc3VlZEF0IiA6IDE1OTY3OTU4ODEuMDYxMDAwMDAwLAogICJicm9rZXJWZXJzaW9uIiA6ICIxLjAuMCIKfQ== describe-software-statements Describes the existing software statements. Topics • Syntax • Output • Example Syntax sudo -u root dcv-session-manager-broker describe-software-statements Output software-statement The software statement. issued-at The date and time the software was generated. is-active The current state of the software statement. true if the software statement is active; otherwise it's false. Example The following example generates a software statement. Command sudo -u root dcv-session-manager-broker describe-software-statements describe-software-statements 61 Amazon DCV Session Manager Output Software Statements [ { "software-statement" : Administrator Guide "ewogICJpZCIgOiAiYmEEXAMPLEYtNzUwNy00YmFhLTliZWItYTA1MmJjZTE3NDJjIiwKICAiaXNzdWVkQXQiIDogMTU5NjY0MTkxMiEXAMPLEDAwMDAsCiAgImJyb2tlclZlcnNpb24iIDogIjEuMC4wIiwKICAiYWN0aXZlEXAMPLEydWUKfQ==", "issued-at" : "2020.08.05 15:38:32 +0000", "is-active" : "true" }, { "software-statement" : "EXAMPLEpZCIgOiAiYjc1NTVhN2QtNWI0MC00OTJhLWJjOTUtNmUzOWNhYzkxMDcxIiwKICAiaXNzdWEXAMPLEDogMTU5Njc5NTg4MS4wNjEwMDAwMDAsCiAgImJyb2tlclZlcnNpb24iIDogIjEuMC4wIiwKICAiYWN0aXZlIiA6IHRydEXAMPLE", "issued-at" : "2020.08.07 10:24:41 +0000", "is-active" : "true"
sm-admin-018	sm-admin.pdf	18	the existing software statements. Topics • Syntax • Output • Example Syntax sudo -u root dcv-session-manager-broker describe-software-statements Output software-statement The software statement. issued-at The date and time the software was generated. is-active The current state of the software statement. true if the software statement is active; otherwise it's false. Example The following example generates a software statement. Command sudo -u root dcv-session-manager-broker describe-software-statements describe-software-statements 61 Amazon DCV Session Manager Output Software Statements [ { "software-statement" : Administrator Guide "ewogICJpZCIgOiAiYmEEXAMPLEYtNzUwNy00YmFhLTliZWItYTA1MmJjZTE3NDJjIiwKICAiaXNzdWVkQXQiIDogMTU5NjY0MTkxMiEXAMPLEDAwMDAsCiAgImJyb2tlclZlcnNpb24iIDogIjEuMC4wIiwKICAiYWN0aXZlEXAMPLEydWUKfQ==", "issued-at" : "2020.08.05 15:38:32 +0000", "is-active" : "true" }, { "software-statement" : "EXAMPLEpZCIgOiAiYjc1NTVhN2QtNWI0MC00OTJhLWJjOTUtNmUzOWNhYzkxMDcxIiwKICAiaXNzdWEXAMPLEDogMTU5Njc5NTg4MS4wNjEwMDAwMDAsCiAgImJyb2tlclZlcnNpb24iIDogIjEuMC4wIiwKICAiYWN0aXZlIiA6IHRydEXAMPLE", "issued-at" : "2020.08.07 10:24:41 +0000", "is-active" : "true" } ] deactivate-software-statement Deactivates a software statement. When you deactivate a software statement, it can no longer be used for agent registrations. Topics • Syntax • Options • Example Syntax sudo -u root dcv-session-manager-broker deactivate-software-statement --software- statement software_statement Options --software-statement The software statement to deactivate. Type: String Required: Yes deactivate-software-statement 62 Amazon DCV Session Manager Example The following example deactivates a software statement. Command Administrator Guide sudo -u root dcv-session-manager-broker deactivate-software-statement --software- statement EXAMPLEpZCIgOiAiYjc1NTVhN2QtNWI0MC00OTJhLWJjOTUtNmUzOWNhYzkxMDcxIiwKICAiaXNEXAMPLEQiIDogMTU5Njc5NTg4MS4wNjEwMDAwMDAsCiAgImJyb2tlclZlEXAMPLEiIDogIjEuMC4wIiwKICAiYWN0aXZlIiA6IHRydEXAMPLE Output Software statement EXAMPLEpZCIgOiAiYjc1NTVhN2QtNWI0MC00OTJhLWJjOTUtNmUzOWNhYzkxMDcxIiwKICAiaXNEXAMPLEQiIDogMTU5Njc5NTg4MS4wNjEwMDAwMDAsCiAgImJyb2tlclZlEXAMPLEiIDogIjEuMC4wIiwKICAiYWN0aXZlIiA6IHRydEXAMPLE deactivated describe-agent-clients Describes the agents that are registered with the broker. Topics • Syntax • Output • Example Syntax sudo -u root dcv-session-manager-broker describe-agent-clients Output name The name of the agent. id The unique ID of the agent. Example 63 Amazon DCV Session Manager active Administrator Guide The state of the agent. true if the agent is active; otherwise it's false. Example The following example describes the agents. Command sudo -u root dcv-session-manager-broker describe-agent-clients Output Session manager agent clients [ { "name" : "test", "id" : "6bc05632-70cb-4410-9e54-eaf9bEXAMPLE", "active" : true }, { "name" : "test", "id" : "27131cc2-4c71-4157-a4ca-bde38EXAMPLE", "active" : true }, { "name" : "test", "id" : "308dd275-2b66-443f-95af-33f63EXAMPLE", "active" : false }, { "name" : "test", "id" : "ce412d1b-d75c-4510-a11b-9d9a3EXAMPLE", "active" : true } ] unregister-agent-client Unregister an agent from the broker. Topics • Syntax • Options Example 64 Amazon DCV Session Manager Administrator Guide • Example Syntax sudo -u root dcv-session-manager-broker unregister-agent-client --client-id client_id Options --client-id The ID of the agent to unregister. Type: String Required: Yes Example The following example unregisters an agent. Command sudo -u root dcv-session-manager-broker unregister-agent-client --client-id 3b0d7b1d-78c7-4e79-b2e1-b976dEXAMPLE Output agent client 3b0d7b1d-78c7-4e79-b2e1-b976dEXAMPLE unregistered register-server-dns-mappings Register the DCV Servers - DNS names mappings coming from a JSON ﬁle. Syntax sudo -u root dcv-session-manager-broker register-server-dns-mappings --file- path file_path Syntax 65 Amazon DCV Session Manager Administrator Guide Options --file-path The path of the ﬁle containing the DCV Servers - DNS names mappings. Type: String Required: Yes Example The following example registers the DCV Servers - DNS names mappings from ﬁle /tmp/ mappings.json. Command sudo -u root dcv-session-manager-broker register-server-dns-mappings --file-path /tmp/ mappings.json Output Successfully loaded 2 server id - dns name mappings from file /tmp/mappings.json describe-server-dns-mappings Describe the currently available DCV Servers - DNS names mappings. Syntax sudo -u root dcv-session-manager-broker describe-server-dns-mappings Output serverIdType The type of the server Id. Options 66 Amazon DCV Session Manager serverId The unique ID of the Server. dnsNames The internal and external dns names internalDnsNames The internal dns names externalDnsNames The external dns names Example The following example lists the registered DCV Servers - DNS names mappings. Command sudo -u root dcv-session-manager-broker describe-server-dns-mappings Output [ { "serverIdType" : "Id", "serverId" : "192.168.0.1", "dnsNames" : { "internalDnsName" : "internal1", "externalDnsName" : "external1" } }, { "serverIdType" : "Host.Aws.Ec2InstanceId", "serverId" : "i-0648aee30bc78bdff", "dnsNames" : { "internalDnsName" : "internal2", "externalDnsName" : "external2" } } Example Administrator Guide 67 Amazon DCV Session Manager ] Administrator Guide Example 68 Amazon DCV Session Manager Administrator Guide Conﬁguration File Reference This reference section provides an overview of available conﬁguration options for the Session Manager. Conﬁgurations include changes to both the agent and broker ﬁle. Each conﬁguration includes an explanation of purpose, accepted values, and impact on the overall system behavior. Amazon DCV Session Manager can be customized to meet the unique requirements of a Amazon DCV system. Topics • Broker conﬁguration ﬁle • Agent Conﬁguration File Broker conﬁguration ﬁle The broker conﬁguration ﬁle (/etc/dcv-session-manager-broker/session-manager- broker.properties) includes parameters that can be conﬁgured to customize the Session Manager functionality. You can edit the conﬁguration ﬁle using your preferred text editor. Note The /etc/dcv-session-manager-broker/session-manager-broker.properties ﬁle contains sensitive data. By default, its write access is restricted to root and its read access is restricted to root and to the user running the broker. By default, this is the dcvsmbroker user. The broker checks at startup that the ﬁle has the expected permissions. The following table lists the parameters in the broker conﬁguration ﬁle. Parameter name Required Default value Description broker- No ja va- home Speciﬁes the path to the Java home directory the broker will use instead of the system default one. If set, the broker will use Broker conﬁguration ﬁle 69 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description <broker-java-home> /bin/java
sm-admin-019	sm-admin.pdf	19	to root and its read access is restricted to root and to the user running the broker. By default, this is the dcvsmbroker user. The broker checks at startup that the ﬁle has the expected permissions. The following table lists the parameters in the broker conﬁguration ﬁle. Parameter name Required Default value Description broker- No ja va- home Speciﬁes the path to the Java home directory the broker will use instead of the system default one. If set, the broker will use Broker conﬁguration ﬁle 69 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description <broker-java-home> /bin/java at startup. Tip: the broker requires Java Runtime Environme nt 11 and it is installed if missing as a dependency upon successfull installat ion. If version 11 is not set as default Java environme nt, its home directory can be grabbed using the following command: $ sudo alternatives --display java Speciﬁes the maximum width, in pixels, of session screenshots taken using the GetSessionScreensh ots API. Speciﬁes the maximum height, in pixels, of session screenshots taken using the GetSessionScreensh ots API. 160 100 session- No s creenshot - max- widt h session- No s creenshot - max- heig ht Broker conﬁguration ﬁle 70 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description png 1000 1800 session- No s creenshot - format create- No se ssions- qu eue- max-s ize create- No se ssions- qu eue- max-t ime- secon ds session- Yes /tmp m anager- wo rking- path The image ﬁle format of session screenshots taken using the GetSessio nScreenshots API. The maximum number of unfulﬁlled CreateSes sions API requests that can be queued. When the queue is full, new unfulﬁll ed requests are rejected. The maximum of time, in seconds, that an unfulﬁll ed CreateSessions API request can remain in the queue. If the request cannot be fulﬁlled within the speciﬁed amount of time, it fails. Speciﬁes the path to the directory where the broker writes the ﬁles needed to operate. This directory must be accessible only to the broker. Broker conﬁguration ﬁle 71 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description true true true enable- Yes au thorizati on- server enable- Yes au thorizati on enable- Yes ag ent- autho rization Speciﬁes whether the broker is the authentic ation server used to generate OAuth 2.0 access tokens for client APIs. Enables or disables client authorization. if you enable client authoriza tion, the client API must provide an access token when making API requests. If you disable client authorization, client APIs can make requests without access tokens. Enables or disables agent authorization. If you enable agent authoriza tion, the agent must provide an access token when communicating with the broker. Broker conﬁguration ﬁle 72 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description delete- No 1 se ssion- dur ation- hou rs delete- No 3600 se ssion- dur ation- sec onds Speciﬁes the number of hours after which deleted sessions become invisible and are no longer returned by DescribeSession API calls. Deprecated: delete-session-dur ation-hours change to delete-session- duration-seconds — Available since version 2024.0-493. Speciﬁes the number of seconds after which deleted sessions become invisible and are no longer returned by DescribeS ession API calls. This parameter replaces the deprecated delete-se ssion-duration- hours parameter — Available since version 2024.0-493. Broker conﬁguration ﬁle 73 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description 60 8443 Speciﬁes the number of minutes for which the ConnectSession token remains valid. Speciﬁes the HTTPS port where the broker listens for client connections. 0.0.0.0 Speciﬁes the IP address of the host where the broker binds for client connectio ns. Speciﬁes the key store used for TLS client connections. connect- No s ession- to ken- durat ion- minut es client- Yes to- broker- c onnector- https- port client- No to- broker- c onnector- bind- host client- Yes to- broker- c onnector- key- store - file Broker conﬁguration ﬁle 74 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description client- Yes to- broker- c onnector- key- store - pass agent- Yes 8445 Speciﬁes the key store pass. Speciﬁes the HTTPS port where the broker listens for agent connections. 0.0.0.0 Speciﬁes the IP address of the host where the broker binds for agent connectio ns. to- broker- co nnector- h ttps- port agent- No to- broker- co nnector- b ind- host Broker conﬁguration ﬁle 75 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description agent- Yes to- broker- co nnector- key- store- file agent- Yes to- broker- co nnector- key- store- pass broker- Yes to- broker- port broker- No to- broker- b ind- host Speciﬁes the key store used for TLS agent connections. Speciﬁes the key store pass. 47100 0.0.0.0 Speciﬁes the
sm-admin-020	sm-admin.pdf	20	listens for agent connections. 0.0.0.0 Speciﬁes the IP address of the host where the broker binds for agent connectio ns. to- broker- co nnector- h ttps- port agent- No to- broker- co nnector- b ind- host Broker conﬁguration ﬁle 75 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description agent- Yes to- broker- co nnector- key- store- file agent- Yes to- broker- co nnector- key- store- pass broker- Yes to- broker- port broker- No to- broker- b ind- host Speciﬁes the key store used for TLS agent connections. Speciﬁes the key store pass. 47100 0.0.0.0 Speciﬁes the port used for broker-to-broker connections. Speciﬁes the IP address of the host where the broker binds for broker-to-broker connections. Broker conﬁguration ﬁle 76 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description broker- Yes to- broker- d iscovery- port broker- No to- broker- d iscovery- addresses 47500 Speciﬁes the port used by brokers to discover each other. Speciﬁes the IP addresses and ports of the other brokers in the ﬂeet in the ip_address :port format. If there are multiple brokers, separate the values with a comma. If you specify broker-to -broker-discovery- multicast-group , broker-to-broker-d iscovery-multicast -port , broker-to- broker-discovery- AWS-region , or broker-to-broker-d iscovery-AWS-alb- target-group-arn omit this parameter. , Broker conﬁguration ﬁle 77 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description broker- No to- broker- d iscovery- multicast - group broker- No to- broker- d iscovery- multicast - port Speciﬁes the multicast group for broker-to-roker discovery. If you specify broker-to-broker-d iscovery-addresses , broker-to-broker- discovery-aws- region , or broker-to -broker-discovery- AWS-alb-target- group-arn , omit this parameter. Speciﬁes the multicast port for broker-to-broker discovery. If you specify broker-to-broker-d iscovery-addresses , broker-to-broker- discovery-AWS- region , or broker-to -broker-discovery- AWS-alb-target- group-arn , omit this parameter. Broker conﬁguration ﬁle 78 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description broker- No to- broker- d iscovery- AWS- regio n broker- No to- broker- d iscovery- AWS- alb-t arget- gro up- arn Speciﬁes the AWS Region of the application load balancer used for broker to broker discovery. If you specify broker-to- broker-discovery- , multicast-group broker-to-broker-d iscovery-multicast -port , or broker-to- broker-discovery- addresses , omit this parameter. The ARN of the application load balancer target group user for broker-to-broker discovery. If you specify broker-to-broker-d iscovery-multicast -group , broker-to- broker-discovery- multicast-port , or broker-to-broker-d iscovery-addresses , omit this parameter. Broker conﬁguration ﬁle 79 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description 4096 Speciﬁes the maximum amount of oﬀ -heap memory to be used by a single broker to store Amazon DCV session data. broker- No to- broker- d istribute d- memory- max- size- mb broker- Yes to- broker- key- store- file broker- Yes to- broker- key- store- pass enable- No false cl oud- watch - metrics Speciﬁes the key store used for TLS broker connections. Speciﬁes the key store pass. Enables or disables Amazon CloudWatch metrics. If you enable CloudWatch Metrics, you might need to specify a value for cloud-watch- region . Broker conﬁguration ﬁle 80 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description cloud- No wat ch- region max- No api-r equests- per- second enable- No th rottling- forwarded - for- head er create- No se ssions- nu mber- of-r etries- on- failure The AWS region where the CloudWatch metrics are posted. Only required if enable- cloud-watch- metrics is set to true. If the broker is installed on an Amazon EC2 instance, the region is retrieved from the IMDS. 1000 false 2 Speciﬁes the maximum number of requests that the broker api can process each second before being throttled. If set to true the throttlin g retrieves the caller ip from the X-Forwared-For header if present. Speciﬁes the maximum number of retries to be performed after a create session request fails on a Amazon DCV server host. Set to 0 to never perform retries on failures. Broker conﬁguration ﬁle 81 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description autorun- No 50 f ile- argum ents- max- size autorun- No 150 Speciﬁes the maximum number of arguments that can be passed to the autorun ﬁle. Speciﬁes the maximum length in chars of each autorun ﬁle argument. f ile- argum ents- max- argument- length enable- Yes pe rsistence No persisten ce- db No dynamodb- region false Only required if enable- persistence is set to true. Only required if enable- persistence is set to true and persistence-db is set to dynamodb. If set to true, the broker status data is persisted on an external database. Speciﬁes which database is used for persistence. The only supported values are: dynamodb and mysql. Speciﬁes the region where the DynamoDB tables are created and accessed. Broker conﬁguration ﬁle 82 Amazon DCV Session Manager
sm-admin-021	sm-admin.pdf	21	maximum length in chars of each autorun ﬁle argument. f ile- argum ents- max- argument- length enable- Yes pe rsistence No persisten ce- db No dynamodb- region false Only required if enable- persistence is set to true. Only required if enable- persistence is set to true and persistence-db is set to dynamodb. If set to true, the broker status data is persisted on an external database. Speciﬁes which database is used for persistence. The only supported values are: dynamodb and mysql. Speciﬁes the region where the DynamoDB tables are created and accessed. Broker conﬁguration ﬁle 82 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description No dynamodb- table- rcu No dynamodb- table- wcu No dynamodb- table- nam e- prefix Only required if enable- persistence is set to true and persistence-db is set to dynamodb. Speciﬁes the Read Capacity Units (RCU) for each DynamoDB table For more information on RCU, see Pricing for Provisioned Only required if enable- persistence is set to true and persistence-db is set to dynamodb. Only required if enable- persistence is set to true and persistence-db is set to dynamodb. Capacity. Speciﬁes the Write Capacity Units (WCU) for each DynamoDB table. For more information on WCU, see Pricing for Provisioned Capacity. Speciﬁes the preﬁx that is added to each DynamoDB table (useful to distinguish multiple broker clusters using the same AWS account). Only alphanumeric characters, dot, dash and underscore are allowed. Broker conﬁguration ﬁle 83 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description No jdbc- conn ection- url Only required if enable- persistence is set to true and persisten ce-db is set to mysql. Speciﬁes the connectio n URL to the MariaDB/M ySQL database; it contains the endpoint and the database name. The url should have this format: jdbc:mysql://<db_e ndpoint>:<db_port> /<db_name>?createD atabaseIfNotExist= true Where <db_endpoint> is the MariaDB/MySQL database endpoint, <db_port> is the database port and <db_name> is the database name. jdbc- No user No jdbc- pass word Only required if enable- persistence is set to true and persisten ce-db is set to mysql. Speciﬁes the name of the user that has access to the MariaDB/MySQL database. Only required if enable- persistence is set to true and persisten ce-db is set to mysql. Speciﬁes the password of the user that has access to the MariaDB/MySQL database. Broker conﬁguration ﬁle 84 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description seconds- No 1800 b efore- del eting- unr eachable- dcv- serve r seconds- No b efore- del eting- ses sions- unr eachable- server Speciﬁes the number of seconds after which an unreachable Amazon DCV server is deleted from the system. Speciﬁes the number of seconds after which sessions on an unreachab le Amazon DCV server are deleted from the system. The removal of sessions from an unreachable server is disabled by default. To enable removal of sessions from unreachable servers, provide a valid value. Broker conﬁguration ﬁle 85 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description 160 100 session- No s creenshot - max- widt h session- No s creenshot - max- heig ht Speciﬁes the maximum width, in pixels, of session screenshots taken using the GetSessionScreensh ots API. If session-s creenshot-max- width is set in the Web Client conﬁguration ﬁle, it takes precedence and overrides this default value. Note that this is the maximum width, so the actual screenshot resolutio n may be lower. Speciﬁes the maximum height, in pixels, of session screenshots taken using the GetSessionScreensh ots API. If session-s creenshot-max- height is set in the Web Client conﬁguration ﬁle, it takes precedence and overrides this default value. Note that this is the maximum height, so the actual screenshot resolutio n may be lower. Agent Conﬁguration File The agent conﬁguration ﬁle (/etc/dcv-session-manager-agent/agent.conf for Linux and C:\Program Files\NICE\DCVSessionManagerAgent\conf\agent.conf for Windows) Agent Conﬁguration File 86 Amazon DCV Session Manager Administrator Guide includes parameters that can be conﬁgured to customize the Session Manager functionality. You can edit the conﬁguration ﬁle using your preferred text editor. The following table lists the parameters in the agent conﬁguration ﬁle. Parameter name Required Default value Description Yes agent.bro ker_host Yes agent.bro ker_port No agent.ca_ file 8445 No agent.ini t_folder • /var/lib/dcv- session-manager- agent/init (Linux) Speciﬁes the DNS name of the broker host. Speciﬁes the port over which to communicate with the broker. Only needed if tls_strict is set to true. Speciﬁes the path to the certiﬁcate (.pem) ﬁle needed to validate the TLS certiﬁcate. Copy the self-signed certiﬁca te from the broker to the agent. Speciﬁes the path to a folder on the host server used to store custom scripts allowed to initializ e Amazon DCV server sessions when they are created. You must specify an absolute path. The folder must be accessibl e and the ﬁles must be
sm-admin-022	sm-admin.pdf	22	• /var/lib/dcv- session-manager- agent/init (Linux) Speciﬁes the DNS name of the broker host. Speciﬁes the port over which to communicate with the broker. Only needed if tls_strict is set to true. Speciﬁes the path to the certiﬁcate (.pem) ﬁle needed to validate the TLS certiﬁcate. Copy the self-signed certiﬁca te from the broker to the agent. Speciﬁes the path to a folder on the host server used to store custom scripts allowed to initializ e Amazon DCV server sessions when they are created. You must specify an absolute path. The folder must be accessibl e and the ﬁles must be executable by users who make use of the InitFile request parameter of the CreateSessions API. Agent Conﬁguration File 87 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description No agent.tls _strict No agent.sof tware_sta tement_pa th No agent.tag s_folder No agent.aut orun_fold er true • /etc/dcv-session- manager-agent (Linux) • C:\Program Files \NICE\DCVSess ionManagerAgent \conf\tags (Windows) • /var/lib/dcv- session-manage r-agent/autorun (Linux) • C:\ProgramData \NICE\DcvSess ionManagerAgent \autorun (Windows) Indicates whether strict TLS validation should be used. Only needed if the default software statement is not used. Speciﬁes the path to the software statement ﬁle. For more information, see generate-software- statement. Speciﬁes the path to the folder in which the tag ﬁles are located. For more information, see Using tags to target Amazon DCV servers. Speciﬁes the path to a folder on the host server used to store scripts and apps that are allowed to be automatically run at session startup. You must specify an absolute path. The folder must be accessible and the ﬁles must be executabl e by users who make use of the AutorunFile request parameter of the CreateSessions API. Agent Conﬁguration File 88 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description No agent.max _virtual_ sessions No agent.max _concurre nt_sessio ns_per_us er No agent.bro ker_updat e_interva l -1 (no limit) 1 30 The maximum number of virtual sessions that can be created on a Amazon DCV server using Amazon DCV Session Manager. The maximum number of virtual sessions that can be created on a Amazon DCV server by a single user using Amazon DCV Session Manager. Speciﬁes the amount of seconds to wait before sending updated data to the broker. Sent data includes Amazon DCV server and host status, as well as updated session information. Lower values make the Session Manager more aware of changes happening on the system where the agent runs, but increase system load and network traﬃc. Higher values decrease system and network load, but the Session Manager becomes less responsive to system changes, thus values higher than 120 are not recommended. Agent Conﬁguration File 89 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description log.levelNo info No log.direc tory • /var/log/dcv- session-manager- agent/ (Linux) • C:\ProgramData \NICE\DCVSess ionManagerAgent \log (Windows) Speciﬁes the verbosity level of the log ﬁles. The following verbosity levels are available: • error—Provides the least detail. Includes errors only. • warning—Includes errors and warnings. • info—The default verbosity level. Includes errors, warnings, and information messages. • debug—Provides the most detail. Provides detailed informati on that is useful for debugging issues. Speciﬁes the directory in which to create log ﬁles. Agent Conﬁguration File 90 Amazon DCV Session Manager Administrator Guide Parameter name Required Default value Description No log.rotat ion daily log.max- No 10485760 f ile- size No log.rotat e 9 Speciﬁes the log ﬁle rotation. Valid values are: • hourly—Log ﬁles are rotated hourly. • daily—Log ﬁles are rotated daily. When a log ﬁle size reaches the speciﬁed size in bytes, it will be rotated. A new log ﬁle will be created and further log events will be placed in the new ﬁle. The maximum number of log ﬁles preserved in the rotation. Each time a rotation happens and this number is reached, the oldest log ﬁle will be deleted. Agent Conﬁguration File 91 Amazon DCV Session Manager Administrator Guide Release notes and document history for Amazon DCV Session Manager This page provides the release notes and document history for Amazon DCV Session Manager. Topics • Amazon DCV Session Manager release notes • Document history Amazon DCV Session Manager release notes This section provides an overview of the major updates, feature releases, and bug ﬁxes for Amazon DCV Session Manager. All the updates are organized by release date. We update the documentation frequently to address the feedback that you send us. Topics • 2024.0-504— March 31, 2025 • 2024.0-493— January 15, 2025 • 2024.0-457— October 1, 2024 • 2023.1-17652— August 1, 2024 • 2023.1-16388— June 26, 2024 • 2023.1— November 9, 2023 • 2023.0-15065— May 4, 2023 • 2023.0-14852— March 28, 2023 • 2022.2-13907— November 11, 2022 • 2022.1-13067— June 29, 2022 • 2022.0-11952— February 23, 2022 • 2021.3-11591— December 20, 2021 • 2021.2-11445—
sm-admin-023	sm-admin.pdf	23	an overview of the major updates, feature releases, and bug ﬁxes for Amazon DCV Session Manager. All the updates are organized by release date. We update the documentation frequently to address the feedback that you send us. Topics • 2024.0-504— March 31, 2025 • 2024.0-493— January 15, 2025 • 2024.0-457— October 1, 2024 • 2023.1-17652— August 1, 2024 • 2023.1-16388— June 26, 2024 • 2023.1— November 9, 2023 • 2023.0-15065— May 4, 2023 • 2023.0-14852— March 28, 2023 • 2022.2-13907— November 11, 2022 • 2022.1-13067— June 29, 2022 • 2022.0-11952— February 23, 2022 • 2021.3-11591— December 20, 2021 • 2021.2-11445— November 18, 2021 • 2021.2-11190— October 11, 2021 • 2021.2-11042— September 01, 2021 • 2021.1-10557— May 31, 2021 Release Notes 92 Amazon DCV Session Manager Administrator Guide • 2021.0-10242— April 12, 2021 • 2020.2-9662— December 04, 2020 • 2020.2-9508— November 11, 2020 2024.0-504— March 31, 2025 Build numbers Changes and bug ﬁxes • Broker: 504 • Added support for AL2023. • Agent: 817 • Bug ﬁxes and performance improvements. • CLI: 154 2024.0-493— January 15, 2025 Build numbers Changes and bug ﬁxes • Broker: 493 • Agent: 801 • CLI: 152 • Added parameters to the GetSessionScreenshot request to specify the maximum height and width of the screenshot. • Added parameter to the Broker conﬁguration ﬁle that speciﬁes the number of seconds after which session on an unreachable Amazon DCV server are deleted from the system. • Fixed an issue where the seconds-before-deleting-unr eachable-dcv-server ﬁle was not being honored. parameter in the Broker conﬁguration • Bug ﬁxes and performance improvements. 2024.0-457— October 1, 2024 Build numbers Changes and bug ﬁxes • Broker: 457 • Rebranded NICE DCV to Amazon DCV. • Agent: 748 • Added support for Ubuntu 24.04. 2024.0-504— March 31, 2025 93 Amazon DCV Session Manager Administrator Guide Build numbers Changes and bug ﬁxes • CLI: 140 2023.1-17652— August 1, 2024 Build numbers Changes and bug ﬁxes • Broker: 426 • Bug ﬁxes and performance improvements. • Agent: 748 • CLI: 140 2023.1-16388— June 26, 2024 Build numbers Changes and bug ﬁxes • Broker: 417 • Fixed a bug that showed memory incorrectly as TB, not GB. • Agent: 748 • Bug ﬁxes and performance improvements. • CLI: 140 2023.1— November 9, 2023 Build numbers Changes and bug ﬁxes • Broker: 410 • Bug ﬁxes and performance improvements • Agent: 732 • CLI: 140 2023.1-17652— August 1, 2024 94 Amazon DCV Session Manager Administrator Guide 2023.0-15065— May 4, 2023 Build numbers Changes and bug ﬁxes • Broker: 392 • Added support for Red Hat Enterprise Linux 9, Rocky Linux 9, and • Agent: 675 • CLI: 132 CentOS Stream 9 on ARM platforms. 2023.0-14852— March 28, 2023 Build numbers Changes and bug ﬁxes • Broker: 392 • Added support for Red Hat Enterprise Linux 9, Rocky Linux 9, and • Agent: 642 • CLI: 132 CentOS Stream 9. 2022.2-13907— November 11, 2022 Build numbers Changes and bug ﬁxes • Broker: 382 • Agent: 612 • CLI: 123 • Added a Substate ﬁeld in DescribeSessions response. • Fixed a problem that could cause the CLI to fail to connect to the broker depending on the URL in use. 2022.1-13067— June 29, 2022 Build numbers Changes and bug ﬁxes • Broker: 355 • Added support to run the broker on AWS Graviton instances. • Agent: 592 • Added agent and broker support for Ubuntu 22.04. • CLI: 114 2023.0-15065— May 4, 2023 95 Amazon DCV Session Manager Administrator Guide 2022.0-11952— February 23, 2022 Build numbers Changes and bug ﬁxes • Broker: 341 • Added log rotation capability to the Agent. • Agent: 520 • Added conﬁguration parameter to set Java home in the Broker. • CLI: 112 • Improved data ﬂushing from cache to disk in the Broker. • Fixed URL validation in the CLI. 2021.3-11591— December 20, 2021 Build numbers New features • Broker: 307 • Added support for integrating with the Amazon DCV Connection • Agent: 453 • CLI: 92 Gateway. • Added Broker support for Ubuntu 18.04 and Ubuntu 20.04. 2021.2-11445— November 18, 2021 Build numbers Changes and bug ﬁxes • Broker: 288 • Fixed a problem with the validation of login names which include a • Agent: 413 • CLI: 54 Windows domain. 2021.2-11190— October 11, 2021 Build numbers Changes and bug ﬁxes • Broker: 254 • Fixed a problem in the command line interface which prevented from • Agent: 413 • CLI: 54 launching Windows sessions. 2022.0-11952— February 23, 2022 96 Amazon DCV Session Manager Administrator Guide 2021.2-11042— September 01, 2021 Build numbers New features Changes and bug ﬁxes • Broker: 254 • Agent: 413 • Amazon DCV Session Manager now oﬀers command line interface (CLI) • When registering an external authorization server, you can now • CLI: 37 support. You can create and manage
sm-admin-024	sm-admin.pdf	24	Agent: 413 • CLI: 54 Windows domain. 2021.2-11190— October 11, 2021 Build numbers Changes and bug ﬁxes • Broker: 254 • Fixed a problem in the command line interface which prevented from • Agent: 413 • CLI: 54 launching Windows sessions. 2022.0-11952— February 23, 2022 96 Amazon DCV Session Manager Administrator Guide 2021.2-11042— September 01, 2021 Build numbers New features Changes and bug ﬁxes • Broker: 254 • Agent: 413 • Amazon DCV Session Manager now oﬀers command line interface (CLI) • When registering an external authorization server, you can now • CLI: 37 support. You can create and manage specify the algorithm that the Amazon DCV sessions in the CLI, authorization server uses to sign instead of calling APIs. JSON-formatted Web Tokens. With • Amazon DCV Session Manager introduced Broker data persistence. For higher availability, brokers can persist server state information on an external data store and restore the data at startup. this change, you can use Azure AD as an external authorization server. 2021.1-10557— May 31, 2021 Build numbers New features Changes and bug ﬁxes • Broker: 214 • Agent: 365 • Amazon DCV Session Manager added support for input parameters passed to the autorun ﬁle on Linux. • We ﬁxed a problem with the autorun ﬁle on Windows. • Server properties can now be passed as requirements to the CreateSes sions API. 2021.0-10242— April 12, 2021 Build numbers Changes and bug ﬁxes • Broker: 183 • Amazon DCV Session Manager introduced the following new APIs: 2021.2-11042— September 01, 2021 97 Amazon DCV Session Manager Administrator Guide Build numbers Changes and bug ﬁxes • Agent: 318 • OpenServers • CloseServers • DescribeServers • GetSessionScreenshots • It also introduced the following new conﬁguration parameters: • Broker parameters: session-screenshot-max-widt h , session-screenshot-max-height , session-s , create-sessions-queue-max-s creenshot-format ize , and create-sessions-queue-max-time-seconds . • Agent parameters: agent.autorun_folder , max_virtu al_sessions , and max_concurrent_sessions_per _user . Agent parameters: agent.autorun_folder al_sessions , and max_concurrent_sessions_per _user . ,max_virtu Agent parameters: agent.autorun_folder al_sessions , and max_concurrent_sessions_per _user . ,max_virtu 2020.2-9662— December 04, 2020 Build numbers Changes and bug ﬁxes • Broker: 114 • We ﬁxed a problem with the auto-generated TLS certiﬁcates that • Agent: 211 prevented the Broker from starting. 2020.2-9662— December 04, 2020 98 Amazon DCV Session Manager Administrator Guide 2020.2-9508— November 11, 2020 Build numbers Changes and bug ﬁxes • Broker: 78 • Agent: 183 • The initial release of Amazon DCV Session Manager. Document history The following table describes the documentation for this release of Amazon DCV Session Manager. Change Description Date Amazon DCV Version Amazon DCV Session Manager has been updated for Amazon DCV 2024.0-504. For more information, see March 31, 2025 2024.0-50 ???. 4 Amazon DCV Version Amazon DCV Session Manager has been updated for Amazon DCV 2024.0-493. For more information, see January 15, 2025 2024.0-49 2024.0-493— January 15, 2025. 3 Amazon DCV Version 2024.0-45 7 Amazon DCV Version 2023.1-17 652 Amazon DCV Session Manager has been updated for Amazon DCV 2024.0-457. For more information, see 2024.0-457— October 1, 2024. September 30, 2024 Amazon DCV Session Manager has been updated for Amazon DCV 2023.1-17652. For more information, see 2023.1-17652— August 1, 2024. August 1, 2024 99 Amazon DCV Session Manager Administrator Guide Change Description Date Amazon DCV Version Amazon DCV Session Manager has been updated for Amazon DCV 2023.1-16388. For more information, 2023.1-16 see 2023.1-16388— June 26, 2024. June 26, 2024 388 Amazon DCV Version 2023.1 Amazon DCV Version 2023.0 Amazon DCV Version 2022.2 Amazon DCV Version 2022.1 Amazon DCV Version 2022.0 Amazon DCV Version 2021.3 Amazon DCV Session Manager has been updated for Amazon DCV 2023.1. For more information, see 2023.1— November 9, 2023. Amazon DCV Session Manager has been updated for Amazon DCV 2023.0. For more information, see 2023.0-14 852— March 28, 2023. Amazon DCV Session Manager has been updated for Amazon DCV 2022.2. For more information, see 2022.2-13 907— November 11, 2022. Amazon DCV Session Manager has been updated for Amazon DCV 2022.1. For more information, see 2022.1-13 067— June 29, 2022. Amazon DCV Session Manager has been updated for Amazon DCV 2022.0. For more information, see 2022.0-11 952— February 23, 2022. Amazon DCV Session Manager has been updated for Amazon DCV 2021.3. For more information, see 2021.3-11 591— December 20, 2021. November 9, 2023 March 28, 2023 November 11, 2022 June 29, 2022 February 23, 2022 December 20, 2021 Document history 100 Amazon DCV Session Manager Administrator Guide Change Description Date Amazon DCV Session Manager has been updated for Amazon DCV 2021.2. For more information, see 2021.2-11 042— September 01, 2021. Amazon DCV Session Manager has been updated for Amazon DCV 2021.1. For more information, see 2021.1-10 557— May 31, 2021. Amazon DCV Session Manager has been updated for Amazon DCV 2021.0. For more information, see 2021.0-10 242— April 12, 2021. September 01, 2021 May
sm-admin-025	sm-admin.pdf	25	see 2021.3-11 591— December 20, 2021. November 9, 2023 March 28, 2023 November 11, 2022 June 29, 2022 February 23, 2022 December 20, 2021 Document history 100 Amazon DCV Session Manager Administrator Guide Change Description Date Amazon DCV Session Manager has been updated for Amazon DCV 2021.2. For more information, see 2021.2-11 042— September 01, 2021. Amazon DCV Session Manager has been updated for Amazon DCV 2021.1. For more information, see 2021.1-10 557— May 31, 2021. Amazon DCV Session Manager has been updated for Amazon DCV 2021.0. For more information, see 2021.0-10 242— April 12, 2021. September 01, 2021 May 31, 2021 April 12, 2021 The ﬁrst publication of this content. November 11, 2020 Amazon DCV Version 2021.2 Amazon DCV Version 2021.1 Amazon DCV Version 2021.0 Initial release of Amazon DCV Session Manager Document history 101
sm-cli-001	sm-cli.pdf	1	CLI Guide Amazon DCV Session Manager Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon DCV Session Manager CLI Guide Amazon DCV Session Manager: CLI Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. Amazon DCV Session Manager Table of Contents CLI Guide What is Session Manager CLI? ........................................................................................................ 1 Installing the Session Manager CLI ................................................................................................ 2 Prerequisites for installing Amazon DCV Session Manager CLI .......................................................... 2 Installing Amazon DCV Session Manager CLI ......................................................................................... 2 Conﬁguring the Session Manager CLI ............................................................................................ 4 Conﬁguration basics ..................................................................................................................................... 4 Conﬁguring the CLI settings ...................................................................................................................... 4 Command line options ........................................................................................................................... 5 Environment variables ............................................................................................................................ 6 Conﬁguration ﬁle .................................................................................................................................... 8 Working with the CLI .................................................................................................................... 10 Getting help with commands .................................................................................................................. 10 Parameter types .................................................................................................................................... 12 Using the command structure ................................................................................................................. 13 Syntax reference ................................................................................................................................... 13 Using return codes ..................................................................................................................................... 14 CLI command reference ................................................................................................................ 16 close-servers ................................................................................................................................................ 16 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 create-session .............................................................................................................................................. 17 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 delete-session .............................................................................................................................................. 20 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 describe-servers .......................................................................................................................................... 22 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 describe-sessions ........................................................................................................................................ 23 iii Amazon DCV Session Manager CLI Guide Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 get-session-connection-data .................................................................................................................... 24 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 get-session-screenshots ............................................................................................................................ 25 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 open-servers ................................................................................................................................................ 26 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 update-session-permissions ..................................................................................................................... 27 Synopsis .................................................................................................................................................. 17 Options .................................................................................................................................................... 17 Example ................................................................................................................................................... 17 Release Notes and Document History .......................................................................................... 29 Release Notes .............................................................................................................................................. 29 2024.0-504— March 31, 2025 .......................................................................................................... 30 2024.0-493— January 15, 2025 ....................................................................................................... 30 2024.0-457— October 1, 2024 ......................................................................................................... 30 2023.1-17652— August 1, 2024 ....................................................................................................... 31 2023.1-16388— June 26, 2024 ........................................................................................................ 31 2023.1— November 9, 2023 .............................................................................................................. 31 2023.0-15065— May 4, 2023 ............................................................................................................ 32 2023.0-14852— March 28, 2023 ...................................................................................................... 32 2022.2-13907— November 11, 2022 .............................................................................................. 32 2022.1-13067— June 29, 2022 ........................................................................................................ 32 2022.0-11952— February 23, 2022 ................................................................................................. 33 2021.3-11591— December 20, 2021 ............................................................................................... 33 2021.2-11445— November 18, 2021 .............................................................................................. 33 2021.2-11190— October 11, 2021 .................................................................................................. 33 2021.2-11042— September 01, 2021 ............................................................................................. 34 iv Amazon DCV Session Manager CLI Guide 2021.1-10557— May 31, 2021 ......................................................................................................... 34 2021.0-10242— April 12, 2021 ........................................................................................................ 34 2020.2-9662— December 04, 2020 ................................................................................................. 35 .................................................................................................................................................................. 36 Document history ....................................................................................................................................... 36 v Amazon DCV Session Manager CLI Guide What is Amazon DCV Session Manager command line interface? Note Amazon DCV was previously known as NICE DCV. Amazon DCV Session Manager is set of installable software packages (an Agent and a Broker) and an application programming interface (API) that makes it easy for developers and independent software vendors (ISVs) to build front-end applications that programmatically create and manage the lifecycle of Amazon DCV sessions across a ﬂeet of Amazon DCV servers. You can use Amazon DCV Session Manager Command Line Interface (CLI) to interact with a DCV Session Manager broker using commands in your command-line shell. • Linux shells — Use common shell programs such as bash, zsh, and tcsh to run commands in Linux or macOS. • Windows command line — Run commands at the Windows command prompt or PowerShell. You can use Amazon DCV Session Manager CLI to create and manage the lifecycle of Amazon DCV sessions. These are managed by a Amazon DCV Session Manager. 1 Amazon DCV Session Manager CLI Guide Installing Amazon DCV Session Manager Command Line Interface The Amazon DCV Session Manager Command Line Interface (CLI) is a powerful tool for managing remote desktop sessions on the Amazon DCV platform. To get started, you'll need to install the CLI on your local system. This section describes how to install the Session Manager CLI on Linux, macOS, and Windows. Topics • Prerequisites for installing Amazon DCV Session Manager CLI • Installing Amazon DCV Session Manager CLI Prerequisites for installing Amazon DCV Session Manager CLI This section includes prerequisites for installing Amazon DCV Session Manager CLI on Linux, macOS, and Windows. Linux and macOS • Python version 3.6 or later. • Ability to extract or unzip a downloaded, compressed ﬁle. If your operating system doesn't have the built-in unzip command, use an equivalent. Windows • Python version 3.6 or later. • Python must be properly set in the PATH environment variable to run Amazon DCV Session Manager CLI using the startup script.
sm-cli-002	sm-cli.pdf	2	Prerequisites for installing Amazon DCV Session Manager CLI • Installing Amazon DCV Session Manager CLI Prerequisites for installing Amazon DCV Session Manager CLI This section includes prerequisites for installing Amazon DCV Session Manager CLI on Linux, macOS, and Windows. Linux and macOS • Python version 3.6 or later. • Ability to extract or unzip a downloaded, compressed ﬁle. If your operating system doesn't have the built-in unzip command, use an equivalent. Windows • Python version 3.6 or later. • Python must be properly set in the PATH environment variable to run Amazon DCV Session Manager CLI using the startup script. Installing Amazon DCV Session Manager CLI This section describes the process to install Amazon DCV Session Manager CLI on Linux, macOS, and Windows. Prerequisites for installing Amazon DCV Session Manager CLI 2 Amazon DCV Session Manager Linux and macOS CLI Guide To Install Amazon DCV Session Manager CLI on Linux and macOS 1. Download the zipped package from the Amazon DCV website. 2. Unzip the downloaded package. If your Linux distribution doesn't have a built-in unzip command, use an equivalent to unzip it. The following example command unzips the package and creates a directory that's named nice-dcv-session-manager- cli-1.0.0-37 under the current directory. $ unzip nice-dcv-session-manager-cli-1.0.0-37.zip 3. To validate the content of the zip ﬁle, run the following command inside the folder extracted in the previous step: ./dcvsm --version Windows Amazon DCV server To install Amazon DCV Session Manager CLI on Windows 1. Download the zipped package from the Amazon DCV website. 2. Unzip the downloaded package. 3. To validate the content of the zip ﬁle, run the following command: C:\> dcvsm --version Installing Amazon DCV Session Manager CLI 3 Amazon DCV Session Manager CLI Guide Conﬁguring the Amazon DCV Session Manager command line interface This section provides instructions for conﬁguring the settings of the Session Manager command line interface (CLI) for use with the Broker. Once you have conﬁgured these settings, you can perform session management tasks from the command line and able to automate remote desktop workﬂows in Amazon DCV servers. To work with the CLI, you must register a Session Manager client with the broker and generate client credentials. Follow the process that's described in the Broker CLI reference. Topics • Conﬁguration basics • Conﬁguring the CLI settings Conﬁguration basics The Amazon DCV Session Manager CLI has a set of conﬁguration parameters that the user can specify. The following parameters are required: • Broker URL • Client ID • Client password The conﬁguration parameters can be deﬁned in the following three ways: • Command line • Environment variables • Conﬁguration ﬁle Conﬁguring the CLI settings The Amazon DCV Session Manager uses credentials and conﬁguration settings that are located in multiple places. These include user environment variables, local Amazon DCV Session Manager Conﬁguration basics 4 Amazon DCV Session Manager CLI Guide conﬁguration ﬁle, or explicitly declared on the command line as a parameter. Certain locations take precedence over others. The Amazon DCV Session Manager CLI credentials and conﬁguration settings take precedence in the following order: • Command line options– Overrides settings in any other location. • Environment variables– Some values can be stored in your system's environment variables. • CLI conﬁguration ﬁle– Specify options in the conﬁguration ﬁle. Topics • Command line options • Environment variables • Conﬁguration ﬁle Command line options In the Amazon DCV Session Manager, you can use the following command line options to override the default conﬁguration settings, any corresponding proﬁle setting, or environment variable setting for that single command. You can't use command line options to directly specify credentials. Each option that takes an argument requires a space or equals sign (=) separating the argument from the option name. --conf Speciﬁes the path of the conﬁguration ﬁle. If it’s not deﬁned the CLI will use the default conﬁguration ﬁle. For more information about the conﬁgureation ﬁle, see Conﬁguration ﬁle. Type: String --broker-url Speciﬁes the URL to send the request to. Type: String --debug A Boolean switch that enables debug logging. By default, the DCV SM CLI provides cleaned up information regarding any successes or failures regarding command outcomes in the command Command line options 5 Amazon DCV Session Manager CLI Guide output. The --debug option provides the full logs. This includes additional stderr diagnostic information about the operation of the command that can be useful when troubleshooting why a command provides unexpected results. Type: Boolean Type: String --no-verify-ssl With this option, you can disable SSL certiﬁcate veriﬁcation, but it's discouraged for security reasons. By default, the DCV SM CLI uses SSL when communicating with broker services. Type: Boolean --ca-bundle Speciﬁes the path to a custom certiﬁcate bundle (a ﬁle with a .pem extension) of CA to use when establishing SSL/TLS connections --auth-server-url Speciﬁes the hostname of the authentication server that's used to request the
sm-cli-003	sm-cli.pdf	3	option provides the full logs. This includes additional stderr diagnostic information about the operation of the command that can be useful when troubleshooting why a command provides unexpected results. Type: Boolean Type: String --no-verify-ssl With this option, you can disable SSL certiﬁcate veriﬁcation, but it's discouraged for security reasons. By default, the DCV SM CLI uses SSL when communicating with broker services. Type: Boolean --ca-bundle Speciﬁes the path to a custom certiﬁcate bundle (a ﬁle with a .pem extension) of CA to use when establishing SSL/TLS connections --auth-server-url Speciﬁes the hostname of the authentication server that's used to request the OAuth 2.0 access token. If it’s not speciﬁed, the broker url is used. Type: String --version Displays the current version of the DCV SM CLI program that's running. Type: String --help Display the list of options and commands of the DCV SM CLI. Type: String Environment variables Environment variables provide another way to specify some conﬁguration options and credentials. The following examples describe how you can conﬁgure environment variables for the default user. Environment variables 6 Amazon DCV Session Manager CLI Guide Set environment variables on Linux or macOS Run the following commands to set environment variables on Linux or macOS: $ export DCV_SM_AUTH_SERVER_URL=https://example.com $ export DCV_SM_CLIENT_ID=ExampleClientID Setting the environment variable changes the value that's used until the end of your shell session, or until you set the variable to a diﬀerent value. You can make the variables persistent across future sessions by setting them in the startup script of your shell. Set environment variables on Windows Run the following commands to set environment variables on Windows Command Prompt: $ setx DCV_SM_AUTH_SERVER_URL https://example.com $ setx DCV_SM_CLIENT_ID ExampleClientID Using set to set an environment variable changes the value that's used until the end of the current command prompt session. Or, it's until you set the variable to a diﬀerent value. Using setx to set an environment variable changes the value that's used in both the current command prompt session and all command prompt sessions. These sessions you create after running the command. It doesn't aﬀect other command shells that are already running at the time you run the command. Set environment variables using PowerShell Run the following commands to set environment variables using PowerShell: $ $Env:DCV_SM_AUTH_SERVER_URL="https://example.com" $ $Env:DCV_SM_CLIENT_ID="ExampleClientID" If you set an environment variable at the PowerShell prompt as shown in the previous examples, it saves the value for only the duration of the current session. To make the environment variable setting persistent across all PowerShell and Command Prompt sessions, store it by using the System application in Control Panel. Alternatively, you can set the variable for all future Environment variables 7 Amazon DCV Session Manager CLI Guide PowerShell sessions by adding it to your PowerShell proﬁle. For more information about storing environment variables or persisting them across session, see the PowerShell documentation. Amazon DCV Session Manager supported environment variables Amazon DCV Session Manager supports the following environment variables: • DCV_SM_AUTH_SERVER_URL Speciﬁes the hostname of the authentication server that's used to request the OAuth 2.0 access token. If deﬁned, this environment variable overrides the value of the conﬁguration ﬁle. • DCV_SM_CLIENT_ID The unique client ID that's used by the Session Manager client to retrieve an OAuth 2.0 access token. • DCV_SM_CLIENT_PASSWORD The password that's used by the Session Manager client to retrieve an OAuth 2.0 access token. • DCV_SM_OAUTH2_TOKEN The access token that's used to make an API request. Conﬁguration ﬁle The conﬁguration ﬁle is the third way to specify some conﬁguration options and credentials. By default, it's provided in the zip ﬁle at /conf/dcvsmcli.conf. The user can specify the path of the conﬁguration ﬁle at command line. If the user does not specify it explicitly the conﬁg ﬁle it will be read by default from a speciﬁc folder depending on the operating systems: • Unix based systems: $XDG_CONFIG_HOME/dcvsmcli.conf • Windows systems: %UserProfile%\dcvsmcli.conf If the conﬁguration ﬁle isn't found, the CLI reads the ﬁle from the path /conf/dcvsmcli.conf provided with the zip ﬁle. The conﬁguration ﬁle is structured as follows: Conﬁguration ﬁle 8 CLI Guide Amazon DCV Session Manager [output] # The formatting style for command output. output-format = json # Turn on debug logging debug = true [security] # Disable SSL certificates verification. no-verify-ssl = true # CA certificate bundle to use when verifying SSL certificates. ca-bundle = ca-bundle.pem [authentication] # hostname of the authentication server used to request the token auth-server-url = https://broker-host:broker-port/oauth2/token? grant_type=client_credentials # The client ID client-id = username # The client password client-password = password [broker] # hostname or IP of the broker url = https://broker-host:broker-port Conﬁguration ﬁle 9 Amazon DCV Session Manager CLI Guide Working with the Amazon DCV Session Manager CLI Working with the CLI allows you to programmatically create, list, and control Amazon DCV sessions from the command line or within scripts. You
sm-cli-004	sm-cli.pdf	4	SSL certificates verification. no-verify-ssl = true # CA certificate bundle to use when verifying SSL certificates. ca-bundle = ca-bundle.pem [authentication] # hostname of the authentication server used to request the token auth-server-url = https://broker-host:broker-port/oauth2/token? grant_type=client_credentials # The client ID client-id = username # The client password client-password = password [broker] # hostname or IP of the broker url = https://broker-host:broker-port Conﬁguration ﬁle 9 Amazon DCV Session Manager CLI Guide Working with the Amazon DCV Session Manager CLI Working with the CLI allows you to programmatically create, list, and control Amazon DCV sessions from the command line or within scripts. You can automate session management tasks, integrate Amazon DCV into custom workﬂows, and manage sessions at scale across multiple hosts. This section introduces many of the common features and options available in the DCV SM Command Line Interface (DCV SM CLI). Some of the topics covered in this section are: Topics • Getting help with commands • Using the command structure • Using return codes Getting help with commands You can get help with any command when using the Amazon DCV Session Manager CLI. To do so, simply type --help at the end of a command name. Example For example, the following command displays help for the general DCV SM CLI options and the available top-level commands. dcvsm --help The following example shows the output of the CLI help. Usage: dcvsm [OPTIONS] COMMAND [ARGS]... Amazon DCV Session Manager CLI Options: --conf TEXT Name of the configuration file to read the configuration parameters --broker-url TEXT The URL of the broker --debug Specify to enable the debug mode. By default is Getting help with commands 10 Amazon DCV Session Manager CLI Guide disabled --no-verify-ssl Specify to disable the verification of SSL certification. By default is enabled --output-format TEXT Specify the format of the output --ca-bundle TEXT Specifies the path to a custom certificate bundle (a file with a .pem extension) of CA to use when establishing SSL/TLS connections --auth-server TEXT URL of the authentication server used to request the token --version Show the version and exit. -h, --help Show this message and exit. Commands: close-servers Closes one or more Amazon DCV server create-session Creates a new Amazon DCV session delete-session Deletes the specified Amazon DCV session describe-servers Describes one or more Amazon DCV servers describe-sessions Describes one or more Amazon DCV sessions get-session-connection-data Gets connection data for a specific Amazon DCV session. get-session-screenshots Gets screenshots of one or more Amazon DCV sessions. open-servers Opens one or more Amazon DCV servers update-session-permissions Updates the user permissions for a specific Amazon DCV session. All commands accept --help for contextual help information. For example, the following command displays help for the create-session command. dcvsm create-session --help The following example shows the output for the create-session --help command. Usage: dcvsm create-session [OPTIONS] Create sessions API Options: --name TEXT The name for the session [required] --owner TEXT The name of the session owner [required] --type TEXT Session type: CONSOLE\|VIRTUAL [required] --init-file-path TEXT Supported with virtual sessions on Linux Amazon DCV servers --autorun-file TEXT The path to a file on the host server that is to be run inside the session Getting help with commands 11 Amazon DCV Session Manager CLI Guide --autorun-file-arguments TEXT Command-line arguments passed to AutorunFile upon its execution inside the session --max-concurrent-clients INTEGER RANGE The maximum number of concurrent Amazon DCV clients, if provided must be between 1 and 100 [1<=x<=100] --dcv-gl-enabled Indicates whether the virtual session is configured to use hardware-based OpenGL. Specify to enable it, by default is disabled --permissions-file TEXT The Base64-encoded contents of the permissions file --requirements TEXT The requirements that the server must satisfy in order to place the session --storage-root TEXT Specifies the path to the folder used for session storage -h, --help Show this message and exit. The Amazon DCV SM CLI Command Reference also contains the help content for all Amazon DCV SM CLI commands. All commands in the Amazon DCV SM CLI correspond to requests made to the APIs of the broker. Each API has an API reference that can be found on the Amazon DCV Session Manager Developer Guide section. Parameter types If you're having trouble formatting an option or argument for a speciﬁc command, the help for each command describes its function and options accepted. String String parameters can contain letters, numbers,and white space. Strings that contain white space must be surrounded by quotation marks. Strings can be surrounded by single quotation marks, double quotation marks, or without them. We recommend that you don't use symbols because it can cause unexpected results. List One or more strings separated by comma and surrounded by quotation marks. The following example shows a list of --session-ids. dcvsm describe-sessions --session-ids "session123,session456" Parameter types 12 Amazon DCV Session Manager Boolean CLI Guide Binary ﬂag that turns an option on
sm-cli-005	sm-cli.pdf	5	the help for each command describes its function and options accepted. String String parameters can contain letters, numbers,and white space. Strings that contain white space must be surrounded by quotation marks. Strings can be surrounded by single quotation marks, double quotation marks, or without them. We recommend that you don't use symbols because it can cause unexpected results. List One or more strings separated by comma and surrounded by quotation marks. The following example shows a list of --session-ids. dcvsm describe-sessions --session-ids "session123,session456" Parameter types 12 Amazon DCV Session Manager Boolean CLI Guide Binary ﬂag that turns an option on or oﬀ. For example, --debug describe-sessions has a Boolean -- debug option that, when speciﬁed, calls the API enabling the debugging. dcvsm --debug describe-sessions If you don’t specify explicitly a boolean option, it’s set to FALSE by default. Integer An unsigned, whole number. dcvsm describe-sessions --max-results 2 Using the command structure This topic covers how the Amazon DCV Session Manager CLI command is structured. The CLI uses a multipart structure on the command line that must be speciﬁed in this order: 1. ./dcvsm–The base call to the program. 2. [options]– Corresponds to common options that's used by all the commands. You can specify these in any order. 3. commands– Speciﬁes which operation to perform. 4. args– Corresponds to the arguments required by the command. For a list of arguments, see Amazon DCV Session Manager CLI reference. Syntax reference dcvsm [options] commands args Arguments can take various types of input values. These include numbers, strings, boolean. What is supported is dependent upon the command that you specify. Using the command structure 13 Amazon DCV Session Manager Using return codes CLI Guide A return code is usually, but not always, a hidden code sent after running a Amazon DCV Session Manager CLI command describing its status. To view these return codes, you can use the echo command. This displays the code sent from the last Session Manager CLI command. YOu can use these codes to determine if a command was successful or not and why a command may have an error. In addition to the return codes, you can view more details about a failure by running your commands with --debug. This produces a detailed report of the steps the Session Manager CLI uses to process the command and the result of each step. To determine the return code of a DCV SM CLI command, run one of the following commands immediately after running the CLI command. • Linux and macOS $ echo $? 0 • Windows PowerShell $ echo $lastexitcode 0 • Windows command prompt $ echo %errorlevel% 0 The following return codes appear at the end of execution of a CLI command: • 0 The command was successful. There were no errors thrown by either the CLI or by the service that the request was made to. • 1 The conﬁguration ﬁle parsed to the CLI was not found or might be corrupt. Using return codes 14 Amazon DCV Session Manager CLI Guide • 2 The command entered on the command line failed to be parsed. Parsing failures can be caused by, but are not limited to, missing any required subcommands or arguments or using any unknown commands or arguments. Note that this return code meaning is applicable to all CLI commands. • 130 The process received a SIGINT (Ctrl-C). • 252 Command syntax was invalid, an unknown parameter was provided, or a parameter value was incorrect and prevented the command from running. • 253 The system environment or conﬁguration was invalid. While the command provided may be syntactically valid, missing conﬁguration or credentials prevented the command from running. • 254 The command was successfully parsed and a request was made to the speciﬁed service but the service returned an error. This will generally indicate incorrect API usage or other service speciﬁc issues. • 255 General catch-all error. The command may have parsed correctly but an unspeciﬁed runtime error occurred when running the command. Because this is a general error code, an error may change from 255 to a more speciﬁc return code. A return code of 255 shouldn't be relied on to determine a speciﬁc error case. Using return codes 15 Amazon DCV Session Manager CLI Guide Amazon DCV Session Manager CLI reference The CLI allows you to perform a variety of session management tasks, including launching new sessions, listing active sessions, getting connection information for sessions, and terminating sessions. This section documents the available CLI commands and their usage. Use the following commands to interact with the Amazon DCV server. • open-servers • describe-servers • close-servers Use the following commands to interact with the Amazon DCV session. • create-session • describe-sessions • get-session-connection-data • get-session-screenshots • update-session-permissions • delete-session close-servers Closes one or more Amazon DCV servers. When
sm-cli-006	sm-cli.pdf	6	codes 15 Amazon DCV Session Manager CLI Guide Amazon DCV Session Manager CLI reference The CLI allows you to perform a variety of session management tasks, including launching new sessions, listing active sessions, getting connection information for sessions, and terminating sessions. This section documents the available CLI commands and their usage. Use the following commands to interact with the Amazon DCV server. • open-servers • describe-servers • close-servers Use the following commands to interact with the Amazon DCV session. • create-session • describe-sessions • get-session-connection-data • get-session-screenshots • update-session-permissions • delete-session close-servers Closes one or more Amazon DCV servers. When you close a Amazon DCV server, you make it unavailable for Amazon DCV session placement. You can't create Amazon DCV sessions on closed servers. Closing a server ensures that no sessions are running on it and that users can't create new sessions on it. Topics • Synopsis • Options • Example close-servers 16 Amazon DCV Session Manager Synopsis close-servers --server-ids <value> [--force] Options --server-ids The comma-separated list of IDs of the Amazon DCV servers to close. Type: String Required: Yes --force Operation that forces the server to close. By default, this is disabled. Type: Boolean Required: No Example dcvsm close-servers --server-ids "server123,server456" create-session Creates a new Amazon DCV session with the speciﬁed details. Topics • Synopsis • Options • Example Synopsis CLI Guide 17 CLI Guide Amazon DCV Session Manager Synopsis create-session --name <value> --owner <value> --type <value> [--init-file-path <value>] [--autorun-file <value>] [--autorun-file-arguments <value>] [--max-concurrents-clients <value>] [--dcv-gl-enabled] [--permissions-file <value>] [--requirements <value>] [--storage-root <value>] [--enqueue-request <value>] Options --name The name of the session. Type: String Required: Yes --owner The name of the session owner. Type: String Required: Yes --type The session type. This is either Console or Virtual. Type: Choice Required: Yes Synopsis 18 Amazon DCV Session Manager --init-file-path CLI Guide The path to the custom script on the Amazon DCV server to run for initializing the session when it's created. The ﬁle path is relative to the init directory speciﬁed for the agent.init- folder Agent conﬁguration parameter. Type: String Required: No --autorun-file The path to a ﬁle on the host server that's to be run inside the session. The ﬁle path is relative to the autorun directory speciﬁed for the agent.autorun-folder Agent conﬁguration parameter. Type: String Required: No --autorun-file-arguments The command-line arguments passed to AutorunFile when it's run inside the session. Type: String Required: No --max_concurrent-clients The maximum number of concurrent Amazon DCV clients. If provided, this must be between 1 and 100. Type: Integer Required: No --dcv-gl-enabled Conﬁgures the virtual session to use hardware-based OpenGL. It's disabled by default. Type: Boolean Required: No Options 19 CLI Guide Amazon DCV Session Manager --permissions-file The path to the permissions ﬁle. Type: String Required: No --requirements The requirements that the server must meet to place the session. Type: String Required: No --storage-root The path to the folder used for session storage. Type: String Required: No --enqueue-request Indicates whether to queue the request if it cannot be immediately fulﬁlled. Requests are not enqueued by default. Type: Boolean Required: No Example dcvsm create-session --name session123 --owner sessionOwner --type Console --requirements "server:Host.Os.Family = 'windows'" delete-session Deletes the speciﬁed Amazon DCV session, and removes it from the cache of the broker. Topics Example 20 Amazon DCV Session Manager CLI Guide • Synopsis • Options • Example Synopsis delete-session --session-id <value> --owner <value> [--force] Options --session-id The ID of the session to delete. Type: String Required: Yes --owner The owner of the session to delete. Type: String Required: Yes --force The operation to ensure a session is removed from the cache of the broker. By default, this is disabled. Type: Boolean Required: No Example dcvsm delete-session --session-id session123 --owner sessionOwner Synopsis 21 CLI Guide Amazon DCV Session Manager --force describe-servers Describe the speciﬁed Amazon DCV server. Topics • Synopsis • Options • Example Synopsis describe-servers [--server-ids <value>] [--next-token <value>] [--max-results <value>] Options --server-ids The comma-separated list of IDs of the Amazon DCV servers to describe. Type: String Required: No --next-token The token to use to retrieve the next page of results. Type: String Required: No --max-results The maximum number of results to be returned by the request in paginated output. If provided, this must be a number between 1 and 1000. describe-servers 22 CLI Guide Amazon DCV Session Manager Type: Integer Required: No Example dcvsm describe-servers --server-ids "server123,server456" describe-sessions Describes one or more Amazon DCV servers. Topics • Synopsis • Options • Example Synopsis describe-sessions [--session-ids <value>] [--next-token <value>] [--owner <value>] [--max-results <value>] Options --session-ids The comma-separated list of IDs of the Amazon DCV sessions to describe. Type: String Required: No --next-token The token to retrieve the next page of results. Example 23 CLI Guide Amazon DCV Session Manager Type: String Required: No --owner The owner of the session to describe. Type: String Required: No --max-results The
sm-cli-007	sm-cli.pdf	7	between 1 and 1000. describe-servers 22 CLI Guide Amazon DCV Session Manager Type: Integer Required: No Example dcvsm describe-servers --server-ids "server123,server456" describe-sessions Describes one or more Amazon DCV servers. Topics • Synopsis • Options • Example Synopsis describe-sessions [--session-ids <value>] [--next-token <value>] [--owner <value>] [--max-results <value>] Options --session-ids The comma-separated list of IDs of the Amazon DCV sessions to describe. Type: String Required: No --next-token The token to retrieve the next page of results. Example 23 CLI Guide Amazon DCV Session Manager Type: String Required: No --owner The owner of the session to describe. Type: String Required: No --max-results The number of results to show. If provided, must be between 1 and 1000. Type: Integer Required: No Example dcvsm describe-sessions --session-ids "session123,session456" get-session-connection-data Gets connection information for a speciﬁc user's connection to a speciﬁc Amazon DCV session. Topics • Synopsis • Options • Example Synopsis get-session-connection-data --session-id <value> --user <value> Example 24 CLI Guide Amazon DCV Session Manager Options --session-id The ID of the Amazon DCV sessions to get connection data from. Type: String Required: Yes --user The name of the user to view connection information for. Type: Boolean Required: Yes Example ./dcvsm get-session-connection-data --session-id session123 --user dcvuser get-session-screenshots Gets screenshots of one or more Amazon DCV sessions. Optional parameters allow specifying the maximum width and height of the screenshots. Topics • Synopsis • Options • Example Synopsis get-session-screenshots --session-ids <value> --max-width <value> --max-height <value> Options 25 Amazon DCV Session Manager Options --session-ids CLI Guide The comma-separated list of IDs of the Amazon DCV sessions to get the screenshots from. Type: String Required: Yes Example ./dcvsm get-session-screenshots --session-ids session123 --max-width 1234 --max-height 1234 open-servers Opens one or more Amazon DCV servers. Before you can create sessions on a Amazon DCV server, you must change the server's state to open. After the Amazon DCV server is open, you can create Amazon DCV sessions on the server. Topics • Synopsis • Options • Example Synopsis open-servers --server-ids <value> Options --server-ids The comma-separated list of IDs of the Amazon DCV servers to open. Options 26 CLI Guide Amazon DCV Session Manager Type: String Required: Yes Example ./dcvsm open-servers --server-ids "server123,server456" update-session-permissions Updates the user permissions for a speciﬁc Amazon DCV session. Topics • Synopsis • Options • Example Synopsis update-session-permissions --session-id <value> --owner <value> --permission-file <value> Options --session-id The ID of the session to change the permissions for. Type: String Required: Yes --owner The owner of the session to change the permissions for. Example 27 CLI Guide Amazon DCV Session Manager Type: String Required: Yes --permission-file The path to the permissions ﬁle. Type: String Required: Yes Example ./dcvsm update-session-permissions --session-id session123 --owner Owner --permission-file path_to_file Example 28 Amazon DCV Session Manager CLI Guide Release notes and document history for Amazon DCV Session Manager This page provides the release notes and document history for Amazon DCV Session Manager. Topics • Amazon DCV Session Manager release notes • Document history Amazon DCV Session Manager release notes This section provides an overview of the major updates, feature releases, and bug ﬁxes for Amazon DCV Session Manager. All the updates are organized by release date. We update the documentation frequently to address the feedback that you send us. Topics • 2024.0-504— March 31, 2025 • 2024.0-493— January 15, 2025 • 2024.0-457— October 1, 2024 • 2023.1-17652— August 1, 2024 • 2023.1-16388— June 26, 2024 • 2023.1— November 9, 2023 • 2023.0-15065— May 4, 2023 • 2023.0-14852— March 28, 2023 • 2022.2-13907— November 11, 2022 • 2022.1-13067— June 29, 2022 • 2022.0-11952— February 23, 2022 • 2021.3-11591— December 20, 2021 • 2021.2-11445— November 18, 2021 • 2021.2-11190— October 11, 2021 • 2021.2-11042— September 01, 2021 • 2021.1-10557— May 31, 2021 Release Notes 29 Amazon DCV Session Manager CLI Guide • 2021.0-10242— April 12, 2021 • 2020.2-9662— December 04, 2020 • 2020.2-9508— November 11, 2020 2024.0-504— March 31, 2025 Build numbers Changes and bug ﬁxes • Broker: 504 • Added support for AL2023. • Agent: 817 • Bug ﬁxes and performance improvements. • CLI: 154 2024.0-493— January 15, 2025 Build numbers Changes and bug ﬁxes • Broker: 493 • Agent: 801 • CLI: 152 • Added parameters to the GetSessionScreenshot request to specify the maximum height and width of the screenshot. • Added parameter to the Broker conﬁguration ﬁle that speciﬁes the number of seconds after which session on an unreachable Amazon DCV server are deleted from the system. • Fixed an issue where the seconds-before-deleting-unr eachable-dcv-server ﬁle was not being honored. parameter in the Broker conﬁguration • Bug ﬁxes and performance improvements. 2024.0-457— October 1, 2024 Build numbers Changes and bug ﬁxes • Broker: 457 • Rebranded NICE DCV to Amazon DCV. • Agent: 748 • Added support for Ubuntu 24.04. 2024.0-504— March 31, 2025 30 Amazon DCV Session Manager CLI Guide Build numbers Changes and bug ﬁxes
sm-cli-008	sm-cli.pdf	8	the screenshot. • Added parameter to the Broker conﬁguration ﬁle that speciﬁes the number of seconds after which session on an unreachable Amazon DCV server are deleted from the system. • Fixed an issue where the seconds-before-deleting-unr eachable-dcv-server ﬁle was not being honored. parameter in the Broker conﬁguration • Bug ﬁxes and performance improvements. 2024.0-457— October 1, 2024 Build numbers Changes and bug ﬁxes • Broker: 457 • Rebranded NICE DCV to Amazon DCV. • Agent: 748 • Added support for Ubuntu 24.04. 2024.0-504— March 31, 2025 30 Amazon DCV Session Manager CLI Guide Build numbers Changes and bug ﬁxes • CLI: 140 2023.1-17652— August 1, 2024 Build numbers Changes and bug ﬁxes • Broker: 426 • Bug ﬁxes and performance improvements. • Agent: 748 • CLI: 140 2023.1-16388— June 26, 2024 Build numbers Changes and bug ﬁxes • Broker: 417 • Fixed a bug that showed memory incorrectly as TB, not GB. • Agent: 748 • Bug ﬁxes and performance improvements. • CLI: 140 2023.1— November 9, 2023 Build numbers Changes and bug ﬁxes • Broker: 410 • Bug ﬁxes and performance improvements • Agent: 732 • CLI: 140 2023.1-17652— August 1, 2024 31 Amazon DCV Session Manager CLI Guide 2023.0-15065— May 4, 2023 Build numbers Changes and bug ﬁxes • Broker: 392 • Added support for Red Hat Enterprise Linux 9, Rocky Linux 9, and • Agent: 675 • CLI: 132 CentOS Stream 9 on ARM platforms. 2023.0-14852— March 28, 2023 Build numbers Changes and bug ﬁxes • Broker: 392 • Added support for Red Hat Enterprise Linux 9, Rocky Linux 9, and • Agent: 642 • CLI: 132 CentOS Stream 9. 2022.2-13907— November 11, 2022 Build numbers Changes and bug ﬁxes • Broker: 382 • Agent: 612 • CLI: 123 • Added a Substate ﬁeld in DescribeSessions response. • Fixed a problem that could cause the CLI to fail to connect to the broker depending on the URL in use. 2022.1-13067— June 29, 2022 Build numbers Changes and bug ﬁxes • Broker: 355 • Added support to run the broker on AWS Graviton instances. • Agent: 592 • Added agent and broker support for Ubuntu 22.04. • CLI: 114 2023.0-15065— May 4, 2023 32 Amazon DCV Session Manager CLI Guide 2022.0-11952— February 23, 2022 Build numbers Changes and bug ﬁxes • Broker: 341 • Added log rotation capability to the Agent. • Agent: 520 • Added conﬁguration parameter to set Java home in the Broker. • CLI: 112 • Improved data ﬂushing from cache to disk in the Broker. • Fixed URL validation in the CLI. 2021.3-11591— December 20, 2021 Build numbers New features • Broker: 307 • Added support for integrating with the Amazon DCV Connection • Agent: 453 • CLI: 92 Gateway. • Added Broker support for Ubuntu 18.04 and Ubuntu 20.04. 2021.2-11445— November 18, 2021 Build numbers Changes and bug ﬁxes • Broker: 288 • Fixed a problem with the validation of login names which include a • Agent: 413 • CLI: 54 Windows domain. 2021.2-11190— October 11, 2021 Build numbers Changes and bug ﬁxes • Broker: 254 • Fixed a problem in the command line interface which prevented from • Agent: 413 • CLI: 54 launching Windows sessions. 2022.0-11952— February 23, 2022 33 Amazon DCV Session Manager CLI Guide 2021.2-11042— September 01, 2021 Build numbers New features Changes and bug ﬁxes • Broker: 254 • Agent: 413 • Amazon DCV Session Manager now oﬀers command line interface (CLI) • When registering an external authorization server, you can now • CLI: 37 support. You can create and manage specify the algorithm that the Amazon DCV sessions in the CLI, authorization server uses to sign instead of calling APIs. JSON-formatted Web Tokens. With • Amazon DCV Session Manager introduced Broker data persistence. For higher availability, brokers can persist server state information on an external data store and restore the data at startup. this change, you can use Azure AD as an external authorization server. 2021.1-10557— May 31, 2021 Build numbers New features Changes and bug ﬁxes • Broker: 214 • Agent: 365 • Amazon DCV Session Manager added support for input parameters passed to the autorun ﬁle on Linux. • We ﬁxed a problem with the autorun ﬁle on Windows. • Server properties can now be passed as requirements to the CreateSes sions API. 2021.0-10242— April 12, 2021 Build numbers Changes and bug ﬁxes • Broker: 183 • Amazon DCV Session Manager introduced the following new APIs: 2021.2-11042— September 01, 2021 34 Amazon DCV Session Manager CLI Guide Build numbers Changes and bug ﬁxes • Agent: 318 • OpenServers • CloseServers • DescribeServers • GetSessionScreenshots • It also introduced the following new conﬁguration parameters: • Broker parameters: session-screenshot-max-widt h , session-screenshot-max-height , session-s , create-sessions-queue-max-s creenshot-format ize , and create-sessions-queue-max-time-seconds . • Agent parameters: agent.autorun_folder
sm-cli-009	sm-cli.pdf	9	the autorun ﬁle on Windows. • Server properties can now be passed as requirements to the CreateSes sions API. 2021.0-10242— April 12, 2021 Build numbers Changes and bug ﬁxes • Broker: 183 • Amazon DCV Session Manager introduced the following new APIs: 2021.2-11042— September 01, 2021 34 Amazon DCV Session Manager CLI Guide Build numbers Changes and bug ﬁxes • Agent: 318 • OpenServers • CloseServers • DescribeServers • GetSessionScreenshots • It also introduced the following new conﬁguration parameters: • Broker parameters: session-screenshot-max-widt h , session-screenshot-max-height , session-s , create-sessions-queue-max-s creenshot-format ize , and create-sessions-queue-max-time-seconds . • Agent parameters: agent.autorun_folder , max_virtu al_sessions , and max_concurrent_sessions_per _user . Agent parameters: agent.autorun_folder al_sessions , and max_concurrent_sessions_per _user . ,max_virtu Agent parameters: agent.autorun_folder al_sessions , and max_concurrent_sessions_per _user . ,max_virtu 2020.2-9662— December 04, 2020 Build numbers Changes and bug ﬁxes • Broker: 114 • We ﬁxed a problem with the auto-generated TLS certiﬁcates that • Agent: 211 prevented the Broker from starting. 2020.2-9662— December 04, 2020 35 Amazon DCV Session Manager CLI Guide 2020.2-9508— November 11, 2020 Build numbers Changes and bug ﬁxes • Broker: 78 • Agent: 183 • The initial release of Amazon DCV Session Manager. Document history The following table describes the documentation for this release of Amazon DCV Session Manager. Change Description Date Amazon DCV Version Amazon DCV Session Manager has been updated for Amazon DCV 2024.0-504. For more information, see March 31, 2025 2024.0-50 ???. 4 Amazon DCV Version Amazon DCV Session Manager has been updated for Amazon DCV 2024.0-493. For more information, see January 15, 2025 2024.0-49 2024.0-493— January 15, 2025. 3 Amazon DCV Version 2024.0-45 7 Amazon DCV Version 2023.1-17 652 Amazon DCV Session Manager has been updated for Amazon DCV 2024.0-457. For more information, see 2024.0-457— October 1, 2024. September 30, 2024 Amazon DCV Session Manager has been updated for Amazon DCV 2023.1-17652. For more information, see 2023.1-17652— August 1, 2024. August 1, 2024 36 Amazon DCV Session Manager CLI Guide Change Description Date Amazon DCV Version Amazon DCV Session Manager has been updated for Amazon DCV 2023.1-16388. For more information, 2023.1-16 see 2023.1-16388— June 26, 2024. June 26, 2024 388 Amazon DCV Version 2023.1 Amazon DCV Version 2023.0 Amazon DCV Version 2022.2 Amazon DCV Version 2022.1 Amazon DCV Version 2022.0 Amazon DCV Version 2021.3 Amazon DCV Session Manager has been updated for Amazon DCV 2023.1. For more information, see 2023.1— November 9, 2023. Amazon DCV Session Manager has been updated for Amazon DCV 2023.0. For more information, see 2023.0-14 852— March 28, 2023. Amazon DCV Session Manager has been updated for Amazon DCV 2022.2. For more information, see 2022.2-13 907— November 11, 2022. Amazon DCV Session Manager has been updated for Amazon DCV 2022.1. For more information, see 2022.1-13 067— June 29, 2022. Amazon DCV Session Manager has been updated for Amazon DCV 2022.0. For more information, see 2022.0-11 952— February 23, 2022. Amazon DCV Session Manager has been updated for Amazon DCV 2021.3. For more information, see 2021.3-11 591— December 20, 2021. November 9, 2023 March 28, 2023 November 11, 2022 June 29, 2022 February 23, 2022 December 20, 2021 Document history 37 Amazon DCV Session Manager CLI Guide Change Description Date Amazon DCV Session Manager has been updated for Amazon DCV 2021.2. For more information, see 2021.2-11 042— September 01, 2021. Amazon DCV Session Manager has been updated for Amazon DCV 2021.1. For more information, see 2021.1-10 557— May 31, 2021. Amazon DCV Session Manager has been updated for Amazon DCV 2021.0. For more information, see 2021.0-10 242— April 12, 2021. September 01, 2021 May 31, 2021 April 12, 2021 The ﬁrst publication of this content. November 11, 2020 Amazon DCV Version 2021.2 Amazon DCV Version 2021.1 Amazon DCV Version 2021.0 Initial release of Amazon DCV Session Manager Document history 38
sm-dev-001	sm-dev.pdf	1	Developer Guide Amazon DCV Session Manager Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon DCV Session Manager Developer Guide Amazon DCV Session Manager: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. Amazon DCV Session Manager Table of Contents Developer Guide What is Session Manager? ............................................................................................................... 1 How Session Manager works ..................................................................................................................... 1 Features .......................................................................................................................................................... 3 Getting started with Session Manager API .................................................................................... 5 Step 1: Generate your API client .............................................................................................................. 5 Step 2: Register your client API ................................................................................................................ 6 Step 3: Get an access token and make an API request ........................................................................ 7 Session Manager API reference .................................................................................................... 10 CloseServers ................................................................................................................................................ 10 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 CreateSessions ............................................................................................................................................ 13 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 DescribeServers ........................................................................................................................................... 21 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 DescribeSessions ......................................................................................................................................... 32 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 DeleteSessions ............................................................................................................................................ 38 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 GetSessionConnectionData ...................................................................................................................... 41 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Additional info ....................................................................................................................................... 44 Example ................................................................................................................................................... 12 GetSessionScreenshots .............................................................................................................................. 47 iii Amazon DCV Session Manager Developer Guide Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 OpenServers ................................................................................................................................................ 52 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 UpdateSessionPermissions ....................................................................................................................... 54 Request parameters ................................................................................................................................ 7 Response parameters ........................................................................................................................... 11 Example ................................................................................................................................................... 12 Release Notes and Document History .......................................................................................... 57 Release Notes .............................................................................................................................................. 57 2024.0-504— March 31, 2025 .......................................................................................................... 58 2024.0-493— January 15, 2025 ....................................................................................................... 58 2024.0-457— October 1, 2024 ......................................................................................................... 58 2023.1-17652— August 1, 2024 ....................................................................................................... 59 2023.1-16388— June 26, 2024 ........................................................................................................ 59 2023.1— November 9, 2023 .............................................................................................................. 59 2023.0-15065— May 4, 2023 ............................................................................................................ 60 2023.0-14852— March 28, 2023 ...................................................................................................... 60 2022.2-13907— November 11, 2022 .............................................................................................. 60 2022.1-13067— June 29, 2022 ........................................................................................................ 60 2022.0-11952— February 23, 2022 ................................................................................................. 61 2021.3-11591— December 20, 2021 ............................................................................................... 61 2021.2-11445— November 18, 2021 .............................................................................................. 61 2021.2-11190— October 11, 2021 .................................................................................................. 61 2021.2-11042— September 01, 2021 ............................................................................................. 62 2021.1-10557— May 31, 2021 ......................................................................................................... 62 2021.0-10242— April 12, 2021 ........................................................................................................ 62 2020.2-9662— December 04, 2020 ................................................................................................. 63 .................................................................................................................................................................. 64 Document history ....................................................................................................................................... 64 iv Amazon DCV Session Manager Developer Guide What is Amazon DCV Session Manager? Note Amazon DCV was previously known as NICE DCV. Amazon DCV Session Manager is set of installable software packages (an Agent and a Broker) and an application programming interface (API) that makes it easy for developers and independent software vendors (ISVs) to build front-end applications that programmatically create and manage the lifecycle of Amazon DCV sessions across a ﬂeet of Amazon DCV servers. This guide explains how to use the Session Manager APIs to manage the lifecycle of Amazon DCV sessions. For more information about how to install and conﬁgure the Session Manager Broker and Agents, see the Amazon DCV Session Manager Administrator Guide. Prerequisites Before you start working with the Session Manager APIs, ensure that you're familiar with Amazon DCV and Amazon DCV sessions. For more information, see the Amazon DCV Administrator Guide. Topics • How Session Manager works • Features How Session Manager works The following diagram shows the high-level components of Session Manager. How Session Manager works 1 Amazon DCV Session Manager Developer Guide Broker The Broker is a web server that hosts and exposes the Session Manager APIs. It receives and processes API requests to manage Amazon DCV sessions from the client, and then passes the instructions to the relevant Agents. The Broker must be installed on a host that is separate from your Amazon DCV servers, but it must be accessible to the client, and it must be able to access the Agents. Agent The Agent is installed on each Amazon DCV server in the ﬂeet. The Agents receive instructions from the Broker and run them on their respective Amazon DCV servers. The Agents also monitor the state of the Amazon DCV servers, and send periodic status updates back to the Broker. APIs Session Manager exposes a set of REST application programming interfaces (APIs) that can be used to manage Amazon DCV sessions on a ﬂeet of Amazon DCV servers. The APIs are hosted on and exposed by the Broker. Developers can build custom session management clients that call the APIs. Client The client is the front-end application or portal that
sm-dev-002	sm-dev.pdf	2	DCV server in the ﬂeet. The Agents receive instructions from the Broker and run them on their respective Amazon DCV servers. The Agents also monitor the state of the Amazon DCV servers, and send periodic status updates back to the Broker. APIs Session Manager exposes a set of REST application programming interfaces (APIs) that can be used to manage Amazon DCV sessions on a ﬂeet of Amazon DCV servers. The APIs are hosted on and exposed by the Broker. Developers can build custom session management clients that call the APIs. Client The client is the front-end application or portal that you develop to call the Session Manager APIs that are exposed by the Broker. End users use the client to manage the sessions hosted on the Amazon DCV servers in the ﬂeet. How Session Manager works 2 Amazon DCV Session Manager Access token Developer Guide In order to make an API request, you must provide an access token. Tokens can be requested from the Broker, or an external authorization server, by registered client APIs. To request and access token, the client API must provide valid credentials. Client API The client API is generated from the Session Manager API deﬁnition YAML ﬁle, using Swagger Codegen. The client API is used to make API requests. Amazon DCV session An Amazon DCV session is a span of time when the Amazon DCV server is able to accept connections from a client. Before your clients can connect to an Amazon DCV session, you must create an Amazon DCV session on the Amazon DCV server. Amazon DCV supports both console and virtual sessions, and each session has a speciﬁed owner and set of permissions. You use the Session Manager APIs to manage the lifecycle of Amazon DCV sessions. Amazon DCV sessions can be in one of the following states: • CREATING—the Broker is in the process of creating the session. • READY—the session is ready to accept client connections. • DELETING—the session is being deleted. • DELETED—the session has been deleted. • UNKNOWN—unable to determine the session's state. The Broker and the Agent might be unable to communicate. Features DCV Session Manager oﬀers the following features: • Provides Amazon DCV session information—get information about the sessions running on multiple Amazon DCV servers. • Manage the lifecycle for multiple Amazon DCV sessions—create or delete multiple sessions for multiple users across multiple Amazon DCV servers with one API request. • Supports tags—use custom tags to target a group of Amazon DCV servers when creating sessions. Features 3 Amazon DCV Session Manager Developer Guide • Manages permissions for multiple Amazon DCV sessions—modify user permissions for multiple sessions with one API request. • Provides connection information—retrieve client connection information for Amazon DCV sessions. • Supports for cloud and on premises—use Session Manager on AWS, on premises, or with alternative cloud-based servers. Features 4 Amazon DCV Session Manager Developer Guide Getting started with Session Manager API The Amazon DCV Session Manager API provides an automated interface for managing remote desktop sessions. Through this API, developers can create, list, start, stop, and otherwise control DCV sessions programmatically. This allows for the integration of Amazon DCV functionality into custom applications and workﬂows. By leveraging this API, organizations can streamline the management of remote visualization workloads, automating many common tasks. Before you can start making calls to the Amazon DCV API, you'll need to obtain an access token that authenticates your application and authorizes it to access the necessary resources. The Amazon DCV API uses OAuth 2.0 for authentication, so you'll need to register your application and retrieve the necessary credentials. Once you have your access token, you can start sending requests to the Amazon DCV API endpoints to begin processing data. Topics • Step 1: Generate your API client • Step 2: Register your client API • Step 3: Get an access token and make an API request Step 1: Generate your API client The Session Manager APIs are deﬁned in a single YAML ﬁle. The APIs are based on the OpenAPI3.0 speciﬁcation, which deﬁnes a standard, language-agnostic interface to RESTful APIs. For more information, see OpenAPI Speciﬁcation. Using the YAML ﬁle, you can generate API client in one of the supported languages. To do this, you must use Swagger Codegen 3.0 or later. For more information about the supported languages, see the swagger-codegen repo. To generate the API client 1. Download the Session Manager API YAML ﬁle from the Session Manager Broker. The YAML ﬁle is available at the following URL. https://broker_host_ip:port/dcv-session-manager-api.yaml 2. Install Swagger Codegen. Step 1: Generate your API client 5 Amazon DCV Session Manager • macOS $ brew install swagger-codegen • Other platforms Developer Guide $ git clone https://github.com/swagger-api/swagger-codegen --branch 3.0.0 $ cd swagger-codegen 3. Generate the API client. • macOS $ swagger-codegen generate -i /path_to/yaml_file -l language
sm-dev-003	sm-dev.pdf	3	languages. To do this, you must use Swagger Codegen 3.0 or later. For more information about the supported languages, see the swagger-codegen repo. To generate the API client 1. Download the Session Manager API YAML ﬁle from the Session Manager Broker. The YAML ﬁle is available at the following URL. https://broker_host_ip:port/dcv-session-manager-api.yaml 2. Install Swagger Codegen. Step 1: Generate your API client 5 Amazon DCV Session Manager • macOS $ brew install swagger-codegen • Other platforms Developer Guide $ git clone https://github.com/swagger-api/swagger-codegen --branch 3.0.0 $ cd swagger-codegen 3. Generate the API client. • macOS $ swagger-codegen generate -i /path_to/yaml_file -l language -o $output_folder • Other platforms $ mvn clean package $ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate - i /path_to/yaml_file -l language -o output_folder Step 2: Register your client API API requests use an access token to verify your credentials. These credentials are based on a client ID and client password that is generated when your client is registered with the Broker. To access this token, you need to register with the Broker. Use register-api-client to register client API. If you don't have a client ID and client password for your client, you must request them from your Broker administrator. Step 2: Register your client API 6 Amazon DCV Session Manager Developer Guide Step 3: Get an access token and make an API request This example will walk through the steps to get your access token set up, then show you how to make a basic API request. This will give you the foundational knowledge to start building more advanced applications powered by the Amazon DCV API. In this example, we'll show you how to do this by using the DescribeSessions API. Example First we import the models needed for the application. Then we declare variables for the client ID (__CLIENT_ID), client password (__CLIENT_SECRET), and the Broker URL, including the port number (__PROTOCOL_HOST_PORT). Next, we create a function called build_client_credentials that generates the client credentials. To generate the client credentials, you must ﬁrst concatenate the client ID and client password and separate the values with a colon (client_ID:client_password), and then Base64 encode the entire string. import swagger_client import base64 import requests import json from swagger_client.models.describe_sessions_request_data import DescribeSessionsRequestData from swagger_client.models.key_value_pair import KeyValuePair from swagger_client.models.delete_session_request_data import DeleteSessionRequestData from swagger_client.models.update_session_permissions_request_data import UpdateSessionPermissionsRequestData from swagger_client.models.create_session_request_data import CreateSessionRequestData __CLIENT_ID = '794b2dbb-bd82-4707-a2f7-f3d9899cb386' __CLIENT_SECRET = 'MzcxNzJhN2UtYjEzNS00MjNjLTg2N2YtMjFlZmRlZWNjMDU1' __PROTOCOL_HOST_PORT = 'https://<broker-hostname>:8443' def build_client_credentials(): client_credentials = '{client_id}:{client_secret}'.format(client_id=__CLIENT_ID, client_secret=__CLIENT_SECRET) return base64.b64encode(client_credentials.encode('utf-8')).decode('utf-8') Step 3: Get an access token and make an API request 7 Amazon DCV Session Manager Developer Guide Now that we have our client credentials, we can use it to request an access token from the Broker. To do this, we create a function called get_access_token. You must call a POST on https://Broker_IP:8443/oauth2/token?grant_type=client_credentials, and provide an authorization header, which includes the Basic-encoded client credentials, and a content type of application/x-www-form-urlencoded. def get_access_token(): client_credentials = build_client_credentials() headers = { 'Authorization': 'Basic {}'.format(client_credentials), 'Content-Type': 'application/x-www-form-urlencoded' } endpoint = __PROTOCOL_HOST_PORT + '/oauth2/token?grant_type=client_credentials' print('Calling', endpoint, 'using headers', headers) res = requests.post(endpoint, headers=headers, verify=True) if res.status_code != 200: print('Cannot get access token:', res.text) return None access_token = json.loads(res.text)['access_token'] print('Access token is', access_token) return access_token Now, we create the functions needed to instantiate a client API. To instantiate a client API, you must specify the client conﬁguration and the headers to be used for requests. The get_client_configuration function creates a conﬁguration object that includes the Broker's IP address and port and the path to Broker's self-signed certiﬁcate, which you should have received from the Broker administrator. The set_request_headers function creates a request header object that includes the client credentials and the access token. def get_client_configuration(): configuration = swagger_client.Configuration() configuration.host = __PROTOCOL_HOST_PORT configuration.verify_ssl = True # configuration.ssl_ca_cert = cert_file.pem return configuration def set_request_headers(api_client): access_token = get_access_token() api_client.set_default_header(header_name='Authorization', header_value='Bearer {}'.format(access_token)) Step 3: Get an access token and make an API request 8 Amazon DCV Session Manager Developer Guide def get_sessions_api(): api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration())) set_request_headers(api_instance.api_client) return api_instance Finally, we create a main method that calls the DescribeSessions API. For more information, see DescribeSessions. def describe_sessions(session_ids=None, next_token=None, tags=None, owner=None): filters = list() if tags: for tag in tags: filter_key_value_pair = KeyValuePair(key='tag:' + tag['Key'], value=tag['Value']) filters.append(filter_key_value_pair) if owner: filter_key_value_pair = KeyValuePair(key='owner', value=owner) filters.append(filter_key_value_pair) request = DescribeSessionsRequestData(session_ids=session_ids, filters=filters, next_token=next_token) print('Describe Sessions Request:', request) api_instance = get_sessions_api() api_response = api_instance.describe_sessions(body=request) print('Describe Sessions Response', api_response) def main(): describe_sessions( session_ids=['SessionId1895', 'SessionId1897'], owner='an owner 1890', tags=[{'Key': 'ram', 'Value': '4gb'}]) Step 3: Get an access token and make an API request 9 Amazon DCV Session Manager Developer Guide Session Manager API reference This reference provides details on the available API actions, required parameters, and response formats to enable you to eﬀectively leverage the Session Manager API in your own systems. Using the Session Manager API, you can start, stop, and get details on interactive sessions. This allows you to automate and integrate functionality into your applications and workﬂows. Topics •
sm-dev-004	sm-dev.pdf	4	get_sessions_api() api_response = api_instance.describe_sessions(body=request) print('Describe Sessions Response', api_response) def main(): describe_sessions( session_ids=['SessionId1895', 'SessionId1897'], owner='an owner 1890', tags=[{'Key': 'ram', 'Value': '4gb'}]) Step 3: Get an access token and make an API request 9 Amazon DCV Session Manager Developer Guide Session Manager API reference This reference provides details on the available API actions, required parameters, and response formats to enable you to eﬀectively leverage the Session Manager API in your own systems. Using the Session Manager API, you can start, stop, and get details on interactive sessions. This allows you to automate and integrate functionality into your applications and workﬂows. Topics • CloseServers • CreateSessions • DescribeServers • DescribeSessions • DeleteSessions • GetSessionConnectionData • GetSessionScreenshots • OpenServers • UpdateSessionPermissions CloseServers Closes one or more Amazon DCV servers. When you close a Amazon DCV server, you make it unavailable for Amazon DCV session placement. You cannot create Amazon DCV sessions on closed servers. Closing a server ensures that no sessions are running on it and that users cannot create new sessions on it. Topics • Request parameters • Response parameters • Example CloseServers 10 Developer Guide Amazon DCV Session Manager Request parameters ServerId The ID of the server to close. Type: String Required: Yes Force Forces the close operation. If you specify true, the server is closed even if it has running sessions. The sessions continue to run. Type: Boolean Required: No Response parameters RequestId The unique ID of the request. SuccessfulList Information about the Amazon DCV servers that were successfully closed. This data structure includes the following nested response parameter: ServerId The ID of the server that was successfully closed. UnsuccessfulList Information about the Amazon DCV servers that could not be closed. This data structure includes the following nested response parameters: CloseServerRequestData Information about the original request that failed. This data structure includes the following nested response parameter: Request parameters 11 Amazon DCV Session Manager ServerId Developer Guide The ID of the Amazon DCV server that could not be closed. Force The requested force parameter. FailureCode The code of the failure. FailureReason The reason for the failure. Example Python Request The following example closes two Amazon DCV servers (serverId1 and serverId2). Server serverId2 doesn't exist and results in a failure. from swagger_client.models import CloseServerRequestData def get_servers_api(): api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration())) set_request_headers(api_instance.api_client) return api_instance def close_servers(server_ids): request = [CloseServerRequestData(server_id=server_id) for server_id in server_ids] print('Close Servers Request:', request) api_instance = get_servers_api() api_response = api_instance.close_servers(body=request) print('Close Servers Response:', api_response) open_servers(server_ids) def main(): close_servers(["serverId1", "serverId2"]) Example 12 Amazon DCV Session Manager Response The following is the sample output. Developer Guide { "RequestId": "4d7839b2-a03c-4b34-a40d-06c8b21099e6", "SuccessfulList": [ { "ServerId": "serverId1" } ], "UnsuccessfulList": [ { "OpenServerRequestData": { "ServerId": "serverId2" }, "FailureCode": "DCV_SERVER_NOT_FOUND", "FailureReason": "Dcv server not found." } ] } CreateSessions Creates a new Amazon DCV session with the speciﬁed details. API actions • Request parameters • Response parameters • Example Request parameters Name The name for the session. Type: String Required: Yes CreateSessions 13 Amazon DCV Session Manager Owner Developer Guide The name of the session owner. This must be the name of an existing user on the target Amazon DCV server. Type: String Required: Yes Type The session type. For more information about the types of sessions, see Introduction to Amazon DCV Sessions in the Amazon DCV Administrator Guide. Valid values: CONSOLE \| VIRTUAL Type: String Required: Yes InitFile Supported with virtual sessions on Linux Amazon DCV servers. It is not supported with console sessions on Windows and Linux Amazon DCV servers. The path to custom script on the Amazon DCV server to run for initializing the session when it is created. The ﬁle path is relative to the init directory speciﬁed for the agent.init_folder Agent conﬁguration parameter. If the ﬁle is in the speciﬁed init directory, specify the ﬁle name only. If the ﬁle is not in the speciﬁed init directory, specify the relative path. For more information, see see Agent conﬁguration ﬁle in the Amazon DCV Session Manager Administrator Guide. Type: String Required: No MaxConcurrents The maximum number of concurrent Amazon DCV clients. Type: Integer Required: No DcvGlEnabled Indicates whether the virtual session is conﬁgured to use hardware-based OpenGL. Supported with virtual sessions only. This parameter is not supported with Windows Amazon DCV servers. Request parameters 14 Amazon DCV Session Manager Valid values: true \| false Type: Boolean Required: No PermissionsFile Developer Guide The Base64-encoded contents of the permissions ﬁle. Defaults to the server defaults if omitted. For more information, see Conﬁguring Amazon DCV Authorization in the Amazon DCV Administrator Guide. Type: String Required: No EnqueueRequest Indicates whether to queue the request if it can't be immediately fulﬁlled. Type: Boolean Default: false Required: No AutorunFile Supported with console sessions on Windows Amazon DCV servers and virtual sessions on Linux Amazon DCV servers. It is not supported with console sessions on Linux Amazon DCV servers. The

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.