id
stringlengths
8
78
source
stringclasses
743 values
chunk_id
int64
1
5.05k
text
stringlengths
593
49.7k
acw-ug-871
acw-ug.pdf
871
CloudWatch works with IAM 3120 Amazon CloudWatch IAM feature Principal permissions Service roles Service-linked roles CloudWatch support User Guide Yes Yes No To get a high-level view of how CloudWatch and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for CloudWatch Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for CloudWatch To view examples of CloudWatch identity-based policies, see Identity-based policy examples for Amazon CloudWatch. Resource-based policies within CloudWatch Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified How Amazon CloudWatch works with IAM 3121 Amazon CloudWatch User Guide principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for CloudWatch Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of CloudWatch actions, see Actions defined by Amazon CloudWatch in the Service Authorization Reference. Policy actions in CloudWatch use the following prefix before the action: cloudwatch To specify multiple actions in a single statement, separate them with commas. "Action": [ "cloudwatch:action1", How Amazon CloudWatch works with IAM 3122 Amazon CloudWatch "cloudwatch:action2" ] User Guide To view examples of CloudWatch identity-based policies, see Identity-based policy examples for Amazon CloudWatch. Policy resources for CloudWatch Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of CloudWatch resource types and their ARNs, see Resources defined by Amazon CloudWatch in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon CloudWatch. To view examples of CloudWatch identity-based policies, see Identity-based policy examples for Amazon CloudWatch. Policy
acw-ug-872
acw-ug.pdf
872
Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of CloudWatch resource types and their ARNs, see Resources defined by Amazon CloudWatch in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon CloudWatch. To view examples of CloudWatch identity-based policies, see Identity-based policy examples for Amazon CloudWatch. Policy condition keys for CloudWatch Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. How Amazon CloudWatch works with IAM 3123 Amazon CloudWatch User Guide The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of CloudWatch condition keys, see Condition keys for Amazon CloudWatch in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by Amazon CloudWatch. To view examples of CloudWatch identity-based policies, see Identity-based policy examples for Amazon CloudWatch. ACLs in CloudWatch Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with CloudWatch Supports ABAC (tags in policies): Partial Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. How Amazon CloudWatch works with IAM 3124 Amazon CloudWatch User Guide ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with CloudWatch Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials
acw-ug-873
acw-ug.pdf
873
access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for CloudWatch 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 How Amazon CloudWatch works with IAM 3125 Amazon CloudWatch User Guide different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for CloudWatch Supports service roles: Yes A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break CloudWatch functionality. Edit service roles only when CloudWatch provides guidance to do so. Identity-based policy examples for Amazon CloudWatch By default, users and roles don't have permission to create or modify CloudWatch resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by CloudWatch, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for Amazon CloudWatch in the Service Authorization Reference. Topics • Policy best practices • Using the CloudWatch console Identity-based policy examples 3126 Amazon CloudWatch Policy best practices User Guide Identity-based policies determine whether someone can create, access, or delete CloudWatch resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access
acw-ug-874
acw-ug.pdf
874
access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Identity-based policy examples 3127 Amazon CloudWatch User Guide Using the CloudWatch console To access the Amazon CloudWatch console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the CloudWatch resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can still use the CloudWatch console, also attach the CloudWatch ConsoleAccess or ReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Permissions needed for CloudWatch console The full set of permissions required to work with the CloudWatch console are listed below. These permissions provide full write and read access to the CloudWatch console. • application-autoscaling:DescribeScalingPolicies • autoscaling:DescribeAutoScalingGroups • autoscaling:DescribePolicies • cloudtrail:DescribeTrails • cloudwatch:DeleteAlarms • cloudwatch:DescribeAlarmHistory • cloudwatch:DescribeAlarms • cloudwatch:GetMetricData • cloudwatch:GetMetricStatistics • cloudwatch:ListMetrics • cloudwatch:PutMetricAlarm • cloudwatch:PutMetricData • ec2:DescribeInstances • ec2:DescribeTags Identity-based policy examples 3128 User Guide Amazon CloudWatch • ec2:DescribeVolumes • es:DescribeElasticsearchDomain • es:ListDomainNames • events:DeleteRule • events:DescribeRule • events:DisableRule • events:EnableRule • events:ListRules • events:PutRule • iam:AttachRolePolicy • iam:CreateRole • iam:GetPolicy • iam:GetPolicyVersion • iam:GetRole • iam:ListAttachedRolePolicies • iam:ListRoles • kinesis:DescribeStream • kinesis:ListStreams • lambda:AddPermission • lambda:CreateFunction • lambda:GetFunctionConfiguration • lambda:ListAliases • lambda:ListFunctions • lambda:ListVersionsByFunction • lambda:RemovePermission • logs:CancelExportTask • logs:CreateExportTask • logs:CreateLogGroup • logs:CreateLogStream Identity-based policy examples 3129 User Guide Amazon CloudWatch • logs:DeleteLogGroup • logs:DeleteLogStream • logs:DeleteMetricFilter • logs:DeleteRetentionPolicy • logs:DeleteSubscriptionFilter • logs:DescribeExportTasks • logs:DescribeLogGroups • logs:DescribeLogStreams • logs:DescribeMetricFilters • logs:DescribeQueries • logs:DescribeSubscriptionFilters • logs:FilterLogEvents • logs:GetLogGroupFields • logs:GetLogRecord • logs:GetLogEvents • logs:GetQueryResults • logs:PutMetricFilter • logs:PutRetentionPolicy • logs:PutSubscriptionFilter • logs:StartQuery • logs:StopQuery • logs:TestMetricFilter • s3:CreateBucket • s3:ListBucket • sns:CreateTopic • sns:GetTopicAttributes • sns:ListSubscriptions • sns:ListTopics • sns:SetTopicAttributes Identity-based policy examples 3130 User Guide Amazon CloudWatch • sns:Subscribe • sns:Unsubscribe • sqs:GetQueueAttributes • sqs:GetQueueUrl • sqs:ListQueues • sqs:SetQueueAttributes • swf:CreateAction • swf:DescribeAction • swf:ListActionTemplates • swf:RegisterAction • swf:RegisterDomain • swf:UpdateAction Additionally, to view the X-Ray Trace Map, you need AWSXrayReadOnlyAccess Troubleshooting Amazon CloudWatch identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with CloudWatch and IAM. Topics • I am not authorized to perform an action in CloudWatch • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my CloudWatch resources I am not authorized to perform an action in CloudWatch If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but doesn't have the fictional cloudwatch:GetWidget permissions. Troubleshooting 3131 Amazon CloudWatch User Guide User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: cloudwatch: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 cloudwatch: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 CloudWatch. Some AWS services allow you to
acw-ug-875
acw-ug.pdf
875
CloudWatch User Guide User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: cloudwatch: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 cloudwatch: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 CloudWatch. 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 CloudWatch. 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 CloudWatch resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: Troubleshooting 3132 Amazon CloudWatch User Guide • To learn whether CloudWatch supports these features, see How Amazon CloudWatch works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. CloudWatch dashboard permissions update On May 1, 2018, AWS changed the permissions required to access CloudWatch dashboards. Dashboard access in the CloudWatch console now requires permissions that were introduced in 2017 to support dashboard API operations: • cloudwatch:GetDashboard • cloudwatch:ListDashboards • cloudwatch:PutDashboard • cloudwatch:DeleteDashboards To access CloudWatch dashboards, you need one of the following: • The AdministratorAccess policy. • The CloudWatchFullAccess policy. • A custom policy that includes one or more of these specific permissions: • cloudwatch:GetDashboard and cloudwatch:ListDashboards to be able to view dashboards • cloudwatch:PutDashboard to be able to create or modify dashboards • cloudwatch:DeleteDashboards to be able to delete dashboards For more information about using policies to change permissions for an IAM user, see Changing Permissions for an IAM user. CloudWatch dashboard permissions update 3133 Amazon CloudWatch User Guide For more information about CloudWatch permissions, see Amazon CloudWatch permissions reference. For more information about dashboard API operations, see PutDashboard in the Amazon CloudWatch API Reference. AWS managed (predefined) policies for CloudWatch AWS addresses many common use cases by providing standalone IAM policies that are created and administered by AWS. These AWS managed policies grant necessary permissions for common use cases so that you can avoid having to investigate what permissions are needed. For more information, see AWS managed policies in the IAM User Guide. The following AWS managed policies, which you can attach to users in your account, are specific to CloudWatch. Topics • CloudWatchFullAccessV2 • CloudWatchFullAccess • CloudWatchReadOnlyAccess • CloudWatchActionsEC2Access • CloudWatch-CrossAccountAccess • CloudWatchAutomaticDashboardsAccess • CloudWatchAgentServerPolicy • CloudWatchAgentAdminPolicy • AWS managed (predefined) policies for CloudWatch cross-account observability • AWS managed (predefined) policies for Amazon Q Developer operational investigations • AWS managed (predefined) policies for CloudWatch Application Signals • AWS managed (predefined) policies for CloudWatch Synthetics • AWS managed (predefined) policies for Amazon CloudWatch RUM • AWS managed (predefined) policies for CloudWatch Evidently • AWS managed policy for AWS Systems Manager Incident Manager AWS managed (predefined) policies for CloudWatch 3134 Amazon CloudWatch CloudWatchFullAccessV2 User Guide AWS recently added the CloudWatchFullAccessV2 managed IAM policy. This policy grants full access to CloudWatch actions and resources and also more properly scopes the permissions granted for other services such as Amazon SNS and Amazon EC2
acw-ug-876
acw-ug.pdf
876
(predefined) policies for Amazon Q Developer operational investigations • AWS managed (predefined) policies for CloudWatch Application Signals • AWS managed (predefined) policies for CloudWatch Synthetics • AWS managed (predefined) policies for Amazon CloudWatch RUM • AWS managed (predefined) policies for CloudWatch Evidently • AWS managed policy for AWS Systems Manager Incident Manager AWS managed (predefined) policies for CloudWatch 3134 Amazon CloudWatch CloudWatchFullAccessV2 User Guide AWS recently added the CloudWatchFullAccessV2 managed IAM policy. This policy grants full access to CloudWatch actions and resources and also more properly scopes the permissions granted for other services such as Amazon SNS and Amazon EC2 Auto Scaling. We recommend that you begin using this policy instead of using CloudWatchFullAccess. AWS plans to deprecate CloudWatchFullAccess in the near future. It includes application-signals: permissions so that users can access all the functionality from the CloudWatch console under Application Signals. It includes some autoscaling:Describe permissions so that users with this policy can see the Auto Scaling actions that are associated with CloudWatch alarms. It includes some sns permissions so that users with this policy can retrieve create Amazon SNS topics and associate them with CloudWatch alarms. It includes IAM permissions so that users with this policy can view information about service-linked roles associated with CloudWatch. It includes the oam:ListSinks and oam:ListAttachedLinks permissions so that users with this policy can use the console to view data shared from source accounts in CloudWatch cross-account observability. It includes Amazon OpenSearch Service permissions to support vended logs dashboards in CloudWatch Logs, which are created with Amazon OpenSearch Service analytics. It includes rum, synthetics, and xray permissions so that users can have full access to CloudWatch Synthetics, AWS X-Ray, and CloudWatch RUM, all of which are under the CloudWatch service. The contents of CloudWatchFullAccessV2 are as follows: { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchFullAccessPermissions", "Effect": "Allow", "Action": [ "application-autoscaling:DescribeScalingPolicies", "application-signals:*", "autoscaling:DescribeAutoScalingGroups", "autoscaling:DescribePolicies", "cloudwatch:*", "logs:*", "sns:CreateTopic", AWS managed (predefined) policies for CloudWatch 3135 Amazon CloudWatch User Guide "sns:ListSubscriptions", "sns:ListSubscriptionsByTopic", "sns:ListTopics", "sns:Subscribe", "iam:GetPolicy", "iam:GetPolicyVersion", "iam:GetRole", "oam:ListSinks", "rum:*", "synthetics:*", "xray:*", "opensearch:ApplicationAccessAll", "iam:ListRoles", "iam:ListUsers", "aoss:BatchGetCollection", "aoss:BatchGetLifecyclePolicy", "es:ListApplications" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsServiceLinkedRolePermissions", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals", "Condition": { "StringLike": { "iam:AWSServiceName": "application- signals.cloudwatch.amazonaws.com" } } }, { "Sid": "EventsServicePermissions", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/events.amazonaws.com/ AWSServiceRoleForCloudWatchEvents*", "Condition": { "StringLike": { "iam:AWSServiceName": "events.amazonaws.com" } } AWS managed (predefined) policies for CloudWatch 3136 User Guide Amazon CloudWatch }, { "Sid": "OAMReadPermissions", "Effect": "Allow", "Action": [ "oam:ListAttachedLinks" ], "Resource": "arn:aws:oam:*:*:sink/*" }, { "Sid": "CloudWatchLogsOpenSearchCreateServiceLinkedAccess", "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": "arn:aws:iam::*:role/aws-service-role/ opensearchservice.amazonaws.com/AWSServiceRoleForAmazonOpenSearchService", "Condition": { "StringEquals": { "iam:AWSServiceName": "opensearchservice.amazonaws.com" } } }, { "Sid": "CloudWatchLogsObservabilityCreateServiceLinkedAccess", "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": "arn:aws:iam::*:role/aws-service-role/*/ AWSServiceRoleForAmazonOpenSearchServerless", "Condition": { "StringEquals": { "iam:AWSServiceName": "observability.aoss.amazonaws.com" } } }, { "Sid": "CloudWatchLogsCollectionRequestAccess", "Effect": "Allow", "Action": [ "aoss:CreateCollection" ], "Resource": "*", AWS managed (predefined) policies for CloudWatch 3137 Amazon CloudWatch "Condition": { User Guide "StringEquals": { "aws:RequestTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsApplicationRequestAccess", "Effect": "Allow", "Action": [ "es:CreateApplication" ], "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/OpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "OpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsCollectionResourceAccess", "Effect": "Allow", "Action": [ "aoss:DeleteCollection" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] } } }, AWS managed (predefined) policies for CloudWatch 3138 Amazon CloudWatch { "Sid": "CloudWatchLogsApplicationResourceAccess", "Effect": "Allow", User Guide "Action": [ "es:UpdateApplication", "es:GetApplication" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/OpenSearchIntegration": [ "Dashboards" ] } } }, { "Sid": "CloudWatchLogsCollectionPolicyAccess", "Effect": "Allow", "Action": [ "aoss:CreateSecurityPolicy", "aoss:CreateAccessPolicy", "aoss:DeleteAccessPolicy", "aoss:DeleteSecurityPolicy", "aoss:GetAccessPolicy", "aoss:GetSecurityPolicy", "aoss:APIAccessAll" ], "Resource": "*", "Condition": { "StringLike": { "aoss:collection": "logs-collection-*" } } }, { "Sid": "CloudWatchLogsIndexPolicyAccess", "Effect": "Allow", "Action": [ "aoss:CreateAccessPolicy", "aoss:DeleteAccessPolicy", "aoss:GetAccessPolicy", "aoss:CreateLifecyclePolicy", "aoss:DeleteLifecyclePolicy" AWS managed (predefined) policies for CloudWatch 3139 User Guide Amazon CloudWatch ], "Resource": "*", "Condition": { "StringLike": { "aoss:index": "logs-collection-*" } } }, { "Sid": "CloudWatchLogsStartDirectQueryAccess", "Effect": "Allow", "Action": [ "opensearch:StartDirectQuery" ], "Resource": "arn:aws:opensearch:*:*:datasource/logs_datasource_*" }, { "Sid": "CloudWatchLogsDQSRequestQueryAccess", "Effect": "Allow", "Action": [ "es:AddDirectQueryDataSource" ], "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsDQSResourceQueryAccess", "Effect": "Allow", "Action": [ "es:GetDirectQueryDataSource", "es:DeleteDirectQueryDataSource" ], "Resource": "*", "Condition": { "StringEquals": { AWS managed (predefined) policies for CloudWatch 3140 Amazon CloudWatch User Guide "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] } } }, { "Sid": "CloudWatchLogsPassRoleAccess", "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { "StringLike": { "iam:PassedToService": "directquery.opensearchservice.amazonaws.com" } } }, { "Sid": "CloudWatchLogsAossTagsAccess", "Effect": "Allow", "Action": [ "aoss:TagResource", "es:AddTags" ], "Resource": "arn:aws:aoss:*:*:collection/*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsEsApplicationTagsAccess", "Effect": "Allow", "Action": [ "es:AddTags" AWS managed (predefined) policies for CloudWatch 3141 User Guide Amazon CloudWatch ], "Resource": "arn:aws:opensearch:*:*:application/*", "Condition": { "StringEquals": { "aws:ResourceTag/OpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "OpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsEsDataSourceTagsAccess", "Effect": "Allow", "Action": [ "es:AddTags" ], "Resource":
acw-ug-877
acw-ug.pdf
877
] } } }, { "Sid": "CloudWatchLogsPassRoleAccess", "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { "StringLike": { "iam:PassedToService": "directquery.opensearchservice.amazonaws.com" } } }, { "Sid": "CloudWatchLogsAossTagsAccess", "Effect": "Allow", "Action": [ "aoss:TagResource", "es:AddTags" ], "Resource": "arn:aws:aoss:*:*:collection/*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsEsApplicationTagsAccess", "Effect": "Allow", "Action": [ "es:AddTags" AWS managed (predefined) policies for CloudWatch 3141 User Guide Amazon CloudWatch ], "Resource": "arn:aws:opensearch:*:*:application/*", "Condition": { "StringEquals": { "aws:ResourceTag/OpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "OpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsEsDataSourceTagsAccess", "Effect": "Allow", "Action": [ "es:AddTags" ], "Resource": "arn:aws:opensearch:*:*:datasource/*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } } ] } CloudWatchFullAccess The CloudWatchFullAccess policy is on the path to deprecation. We recommend that you stop using it, and use CloudWatchFullAccessV2 instead. The contents of CloudWatchFullAccess are as follows: { "Version": "2012-10-17", AWS managed (predefined) policies for CloudWatch 3142 Amazon CloudWatch User Guide "Statement": [ { "Effect": "Allow", "Action": [ "autoscaling:Describe*", "cloudwatch:*", "logs:*", "sns:*", "iam:GetPolicy", "iam:GetPolicyVersion", "iam:GetRole", "oam:ListSinks", "opensearch:ApplicationAccessAll", "iam:ListRoles", "iam:ListUsers", "aoss:BatchGetCollection", "aoss:BatchGetLifecyclePolicy", "es:ListApplications" ], "Resource": "*" }, { "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/events.amazonaws.com/ AWSServiceRoleForCloudWatchEvents*", "Condition": { "StringLike": { "iam:AWSServiceName": "events.amazonaws.com" } } }, { "Effect": "Allow", "Action": [ "oam:ListAttachedLinks" ], "Resource": "arn:aws:oam:*:*:sink/*" }, { "Sid": "CloudWatchLogsOpenSearchCreateServiceLinkedAccess", "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" AWS managed (predefined) policies for CloudWatch 3143 Amazon CloudWatch ], User Guide "Resource": "arn:aws:iam::*:role/aws-service-role/ opensearchservice.amazonaws.com/AWSServiceRoleForAmazonOpenSearchService", "Condition": { "StringEquals": { "iam:AWSServiceName": "opensearchservice.amazonaws.com" } } }, { "Sid": "CloudWatchLogsObservabilityCreateServiceLinkedAccess", "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": "arn:aws:iam::*:role/aws-service-role/*/ AWSServiceRoleForAmazonOpenSearchServerless", "Condition": { "StringEquals": { "iam:AWSServiceName": "observability.aoss.amazonaws.com" } } }, { "Sid": "CloudWatchLogsCollectionRequestAccess", "Effect": "Allow", "Action": [ "aoss:CreateCollection" ], "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsApplicationRequestAccess", "Effect": "Allow", AWS managed (predefined) policies for CloudWatch 3144 Amazon CloudWatch User Guide "Action": [ "es:CreateApplication" ], "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/OpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "OpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsCollectionResourceAccess", "Effect": "Allow", "Action": [ "aoss:DeleteCollection" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] } } }, { "Sid": "CloudWatchLogsApplicationResourceAccess", "Effect": "Allow", "Action": [ "es:UpdateApplication", "es:GetApplication" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/OpenSearchIntegration": [ "Dashboards" ] } AWS managed (predefined) policies for CloudWatch 3145 User Guide Amazon CloudWatch } }, { "Sid": "CloudWatchLogsCollectionPolicyAccess", "Effect": "Allow", "Action": [ "aoss:CreateSecurityPolicy", "aoss:CreateAccessPolicy", "aoss:DeleteAccessPolicy", "aoss:DeleteSecurityPolicy", "aoss:GetAccessPolicy", "aoss:GetSecurityPolicy", "aoss:APIAccessAll" ], "Resource": "*", "Condition": { "StringLike": { "aoss:collection": "logs-collection-*" } } }, { "Sid": "CloudWatchLogsIndexPolicyAccess", "Effect": "Allow", "Action": [ "aoss:CreateAccessPolicy", "aoss:DeleteAccessPolicy", "aoss:GetAccessPolicy", "aoss:CreateLifecyclePolicy", "aoss:DeleteLifecyclePolicy" ], "Resource": "*", "Condition": { "StringLike": { "aoss:index": "logs-collection-*" } } }, { "Sid": "CloudWatchLogsStartDirectQueryAccess", "Effect": "Allow", "Action": [ "opensearch:StartDirectQuery" ], AWS managed (predefined) policies for CloudWatch 3146 Amazon CloudWatch User Guide "Resource": "arn:aws:opensearch:*:*:datasource/logs_datasource_*" }, { "Sid": "CloudWatchLogsDQSRequestQueryAccess", "Effect": "Allow", "Action": [ "es:AddDirectQueryDataSource" ], "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsDQSResourceQueryAccess", "Effect": "Allow", "Action": [ "es:GetDirectQueryDataSource", "es:DeleteDirectQueryDataSource" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] } } }, { "Sid": "CloudWatchLogsPassRoleAccess", "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { AWS managed (predefined) policies for CloudWatch 3147 Amazon CloudWatch User Guide "StringLike": { "iam:PassedToService": "directquery.opensearchservice.amazonaws.com" } } }, { "Sid": "CloudWatchLogsAossTagsAccess", "Effect": "Allow", "Action": [ "aoss:TagResource", "es:AddTags" ], "Resource": "arn:aws:aoss:*:*:collection/*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } }, { "Sid": "CloudWatchLogsEsApplicationTagsAccess", "Effect": "Allow", "Action": [ "es:AddTags" ], "Resource": "arn:aws:opensearch:*:*:application/*", "Condition": { "StringEquals": { "aws:ResourceTag/OpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "OpenSearchIntegration" } } }, { AWS managed (predefined) policies for CloudWatch 3148 Amazon CloudWatch User Guide "Sid": "CloudWatchLogsEsDataSourceTagsAccess", "Effect": "Allow", "Action": [ "es:AddTags" ], "Resource": "arn:aws:opensearch:*:*:datasource/*", "Condition": { "StringEquals": { "aws:ResourceTag/CloudWatchOpenSearchIntegration": [ "Dashboards" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "CloudWatchOpenSearchIntegration" } } } ] } CloudWatchReadOnlyAccess The CloudWatchReadOnlyAccess policy grants read-only access to CloudWatch. The policy includes some logs: permissions, so that users with this policy can use the console to view CloudWatch Logs information and CloudWatch Logs Insights queries. It includes autoscaling:Describe*, so that users with this policy can see the Auto Scaling actions that are associated with CloudWatch alarms. It includes the application-signals: permissions so that users can use Application Signals to monitor the health of their services. It includes application- autoscaling:DescribeScalingPolicies, so that users with this policy can access information about Application Auto Scaling policies. It includes sns:Get* and sns:List*, so that users with this policy can retrieve information about the Amazon SNS topics that receive notifications about CloudWatch alarms. It includes the oam:ListSinks and oam:ListAttachedLinks permissions, so that users with this policy can use the console to view data shared from source accounts in CloudWatch cross-account observability. It includes the iam:GetRole permissions so that users can check if CloudWatch Application Signals have been set up.
acw-ug-878
acw-ug.pdf
878
can use Application Signals to monitor the health of their services. It includes application- autoscaling:DescribeScalingPolicies, so that users with this policy can access information about Application Auto Scaling policies. It includes sns:Get* and sns:List*, so that users with this policy can retrieve information about the Amazon SNS topics that receive notifications about CloudWatch alarms. It includes the oam:ListSinks and oam:ListAttachedLinks permissions, so that users with this policy can use the console to view data shared from source accounts in CloudWatch cross-account observability. It includes the iam:GetRole permissions so that users can check if CloudWatch Application Signals have been set up. It includes rum, synthetics, and xray permissions so that users can have read-only access to CloudWatch Synthetics, AWS X-Ray, and CloudWatch RUM, all of which are under the CloudWatch service. AWS managed (predefined) policies for CloudWatch 3149 Amazon CloudWatch User Guide The following is the content of the CloudWatchReadOnlyAccess policy. { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchReadOnlyAccessPermissions", "Effect": "Allow", "Action": [ "application-autoscaling:DescribeScalingPolicies", "application-signals:BatchGet*", "application-signals:Get*", "application-signals:List*", "autoscaling:Describe*", "cloudwatch:BatchGet*", "cloudwatch:Describe*", "cloudwatch:GenerateQuery", "cloudwatch:Get*", "cloudwatch:List*", "logs:Get*", "logs:List*", "logs:StartQuery", "logs:StopQuery", "logs:Describe*", "logs:TestMetricFilter", "logs:FilterLogEvents", "logs:StartLiveTail", "logs:StopLiveTail", "oam:ListSinks", "sns:Get*", "sns:List*", "rum:BatchGet*", "rum:Get*", "rum:List*", "synthetics:Describe*", "synthetics:Get*", "synthetics:List*", "xray:BatchGet*", "xray:Get*", "xray:List*", "xray:StartTraceRetrieval", "xray:CancelTraceRetrieval" ], "Resource": "*" AWS managed (predefined) policies for CloudWatch 3150 Amazon CloudWatch }, { "Sid": "OAMReadPermissions", "Effect": "Allow", "Action": [ "oam:ListAttachedLinks" ], "Resource": "arn:aws:oam:*:*:sink/*" }, { User Guide "Sid": "CloudWatchReadOnlyGetRolePermissions", "Effect": "Allow", "Action": "iam:GetRole", "Resource": "arn:aws:iam::*:role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" } ] } CloudWatchActionsEC2Access The CloudWatchActionsEC2Access policy grants read-only access to CloudWatch alarms and metrics in addition to Amazon EC2 metadata. It also grants access to the Stop, Terminate, and Reboot API actions for EC2 instances. The following is the content of the CloudWatchActionsEC2Access policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudwatch:Describe*", "ec2:Describe*", "ec2:RebootInstances", "ec2:StopInstances", "ec2:TerminateInstances" ], "Resource": "*" } ] } AWS managed (predefined) policies for CloudWatch 3151 Amazon CloudWatch User Guide CloudWatch-CrossAccountAccess The CloudWatch-CrossAccountAccess managed policy is used by the CloudWatch- CrossAccountSharingRole IAM role. This role and policy enable users of cross-account dashboards to view automatic dashboards in each account that is sharing dashboards. The following is the content of CloudWatch-CrossAccountAccess: { "Version": "2012-10-17", "Statement": [ { "Action": [ "sts:AssumeRole" ], "Resource": [ "arn:aws:iam::*:role/CloudWatch-CrossAccountSharing*" ], "Effect": "Allow" } ] } CloudWatchAutomaticDashboardsAccess The CloudWatchAutomaticDashboardsAccess managed policy grants access to CloudWatch for non-CloudWatch APIs, so that resources such as Lambda functions can be displayed on CloudWatch automatic dashboards. The following is the content of CloudWatchAutomaticDashboardsAccess: { "Version": "2012-10-17", "Statement": [ { "Action": [ "autoscaling:DescribeAutoScalingGroups", "cloudfront:GetDistribution", "cloudfront:ListDistributions", "dynamodb:DescribeTable", "dynamodb:ListTables", "ec2:DescribeInstances", "ec2:DescribeVolumes", AWS managed (predefined) policies for CloudWatch 3152 Amazon CloudWatch User Guide "ecs:DescribeClusters", "ecs:DescribeContainerInstances", "ecs:ListClusters", "ecs:ListContainerInstances", "ecs:ListServices", "elasticache:DescribeCacheClusters", "elasticbeanstalk:DescribeEnvironments", "elasticfilesystem:DescribeFileSystems", "elasticloadbalancing:DescribeLoadBalancers", "kinesis:DescribeStream", "kinesis:ListStreams", "lambda:GetFunction", "lambda:ListFunctions", "rds:DescribeDBClusters", "rds:DescribeDBInstances", "resource-groups:ListGroupResources", "resource-groups:ListGroups", "route53:GetHealthCheck", "route53:ListHealthChecks", "s3:ListAllMyBuckets", "s3:ListBucket", "sns:ListTopics", "sqs:GetQueueAttributes", "sqs:GetQueueUrl", "sqs:ListQueues", "synthetics:DescribeCanariesLastRun", "tag:GetResources" ], "Effect": "Allow", "Resource": "*" }, { "Action": [ "apigateway:GET" ], "Effect": "Allow", "Resource": [ "arn:aws:apigateway:*::/restapis*" ] } ] AWS managed (predefined) policies for CloudWatch 3153 Amazon CloudWatch User Guide CloudWatchAgentServerPolicy The CloudWatchAgentServerPolicy policy can be used in IAM roles that are attached to Amazon EC2 instances to allow the CloudWatch agent to read information from the instance and write it to CloudWatch. Its contents are as follows. { "Version": "2012-10-17", "Statement": [ { "Sid": "CWACloudWatchServerPermissions", "Effect": "Allow", "Action": [ "cloudwatch:PutMetricData", "ec2:DescribeVolumes", "ec2:DescribeTags", "logs:PutLogEvents", "logs:PutRetentionPolicy", "logs:DescribeLogStreams", "logs:DescribeLogGroups", "logs:CreateLogStream", "logs:CreateLogGroup", "xray:PutTraceSegments", "xray:PutTelemetryRecords", "xray:GetSamplingRules", "xray:GetSamplingTargets", "xray:GetSamplingStatisticSummaries" ], "Resource": "*" }, { "Sid": "CWASSMServerPermissions", "Effect": "Allow", "Action": [ "ssm:GetParameter" ], "Resource": "arn:aws:ssm:*:*:parameter/AmazonCloudWatch-*" } ] } AWS managed (predefined) policies for CloudWatch 3154 Amazon CloudWatch User Guide CloudWatchAgentAdminPolicy The CloudWatchAgentAdminPolicy policy can be used in IAM roles that are attached to Amazon EC2 instances. This policy allows the CloudWatch agent to read information from the instance and write it to CloudWatch, and also to write information to Parameter Store. Its contents are as follows. { "Version": "2012-10-17", "Statement": [ { "Sid": "CWACloudWatchPermissions", "Effect": "Allow", "Action": [ "cloudwatch:PutMetricData", "ec2:DescribeTags", "logs:PutLogEvents", "logs:PutRetentionPolicy", "logs:DescribeLogStreams", "logs:DescribeLogGroups", "logs:CreateLogStream", "logs:CreateLogGroup", "xray:PutTraceSegments", "xray:PutTelemetryRecords", "xray:GetSamplingRules", "xray:GetSamplingTargets", "xray:GetSamplingStatisticSummaries" ], "Resource": "*" }, { "Sid": "CWASSMPermissions", "Effect": "Allow", "Action": [ "ssm:GetParameter", "ssm:PutParameter" ], "Resource": "arn:aws:ssm:*:*:parameter/AmazonCloudWatch-*" } ] } AWS managed (predefined) policies for CloudWatch 3155 Amazon CloudWatch Note User Guide You can review these permissions policies by signing in to the IAM console and searching for specific policies there. You can also create your own custom IAM policies to allow permissions for CloudWatch actions and resources. You can attach these custom policies to the IAM users or groups that require those permissions. AWS managed (predefined) policies for CloudWatch cross-account observability The policies in this section grant permissions related to CloudWatch cross-account observability. For more information, see CloudWatch cross-account observability. CloudWatchCrossAccountSharingConfiguration The CloudWatchCrossAccountSharingConfiguration policy grants access to create, manage, and view Observability Access Manager links for sharing CloudWatch resources between accounts. For more information, see CloudWatch cross-account observability. The contents are as follows: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow",
acw-ug-879
acw-ug.pdf
879
can also create your own custom IAM policies to allow permissions for CloudWatch actions and resources. You can attach these custom policies to the IAM users or groups that require those permissions. AWS managed (predefined) policies for CloudWatch cross-account observability The policies in this section grant permissions related to CloudWatch cross-account observability. For more information, see CloudWatch cross-account observability. CloudWatchCrossAccountSharingConfiguration The CloudWatchCrossAccountSharingConfiguration policy grants access to create, manage, and view Observability Access Manager links for sharing CloudWatch resources between accounts. For more information, see CloudWatch cross-account observability. The contents are as follows: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudwatch:Link", "oam:ListLinks" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "oam:DeleteLink", "oam:GetLink", "oam:TagResource" ], "Resource": "arn:aws:oam:*:*:link/*" }, AWS managed (predefined) policies for CloudWatch 3156 User Guide Amazon CloudWatch { "Effect": "Allow", "Action": [ "oam:CreateLink", "oam:UpdateLink" ], "Resource": [ "arn:aws:oam:*:*:link/*", "arn:aws:oam:*:*:sink/*" ] } ] } OAMFullAccess The OAMFullAccess policy grants access to create, manage, and view Observability Access Manager sinks and links, which are used for CloudWatch cross-account observability. The OAMFullAccess policy by itself does not permit you to share observability data across links. To create a link to share CloudWatch metrics, you also need either CloudWatchFullAccess or CloudWatchCrossAccountSharingConfiguration. To create a link to share CloudWatch Logs log groups, you also need either CloudWatchLogsFullAccess or CloudWatchLogsCrossAccountSharingConfiguration. To create a link to share X-Ray traces, you also need either AWSXRayFullAccess or AWSXRayCrossAccountSharingConfiguration. For more information, see CloudWatch cross-account observability. The contents are as follows: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "oam:*" ], "Resource": "*" } ] } AWS managed (predefined) policies for CloudWatch 3157 Amazon CloudWatch OAMReadOnlyAccess User Guide The OAMReadOnlyAccess policy grants read-only access to Observability Access Manager resources, which are used for CloudWatch cross-account observability. For more information, see CloudWatch cross-account observability. The contents are as follows: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "oam:Get*", "oam:List*" ], "Resource": "*" } ] } AWS managed (predefined) policies for Amazon Q Developer operational investigations The policies in this section grant permissions related to Amazon Q Developer operational investigations. For more information, see Amazon Q Developer operational investigations (Preview). AIOpsConsoleAdminPolicy The AIOpsConsoleAdminPolicy policy grants full access to all Amazon Q Developer operational investigations actions and their required permissions via the AWS console. This policy also grants limited access to other service's APIs required for Amazon Q Developer operational investigations functionality. • The aiops permissions grant access to all Amazon Q Developer operational investigations actions. • The organizations, sso, identitystore, and sts permissions allow actions needed for IAM Identity Center management which facilitate identity-aware sessions. • The ssm permissions are required for SSM Ops Item integration with third-party issue management. AWS managed (predefined) policies for CloudWatch 3158 Amazon CloudWatch User Guide • The iam permissions are needed so that administrators can pass IAM roles to the aiops and ssm.integrations services, and the role is later used by the assistant to analyze AWS resources Important These permissions allow users with this policy to pass any IAM role to the aiops and ssm.integrations services. • It allows APIs from services outside Amazon Q Developer operational investigations, which are required for investigation feature functionality. These include actions to configure Amazon Q Developer in chat applications, AWS KMS, CloudTrail trails, and SSM third-party issue management. The following are the contents of the AIOpsConsoleAdminPolicy policy. { "Version": "2012-10-17", "Statement": [ { "Sid": "AIOpsAdmin", "Effect": "Allow", "Action": [ "aiops:*" ], "Resource": "*" }, { "Sid": "OrganizationsAccess", "Effect": "Allow", "Action": [ "organizations:ListAWSServiceAccessForOrganization", "organizations:DescribeOrganization" ], "Resource": "*" }, { "Sid": "SSOApplicationManagement", "Effect": "Allow", "Action": [ "sso:PutApplicationAccessScope", AWS managed (predefined) policies for CloudWatch 3159 Amazon CloudWatch User Guide "sso:PutApplicationAssignmentConfiguration", "sso:PutApplicationGrant", "sso:PutApplicationAuthenticationMethod", "sso:DeleteApplication" ], "Resource": "*", "Condition": { "StringEquals": { "aws:CalledViaLast": "aiops.amazonaws.com", "aws:ResourceTag/ManagedByAmazonAIOperations": "true" } } }, { "Sid": "SSOApplicationTagManagement", "Effect": "Allow", "Action": [ "sso:CreateApplication", "sso:TagResource" ], "Resource": [ "arn:aws:sso:::instance/*", "arn:aws:sso::aws:applicationProvider/aiops" ], "Condition": { "StringEquals": { "aws:CalledViaLast": "aiops.amazonaws.com", "aws:RequestTag/ManagedByAmazonAIOperations": "true" }, "ForAllValues:StringEquals": { "aws:TagKeys": [ "ManagedByAmazonAIOperations" ] } } }, { "Sid": "SSOTagManagement", "Effect": "Allow", "Action": [ "sso:TagResource" ], "Resource": "arn:aws:sso::*:application/*", "Condition": { AWS managed (predefined) policies for CloudWatch 3160 Amazon CloudWatch "StringEquals": { "aws:CalledViaLast": "aiops.amazonaws.com", "aws:ResourceTag/ManagedByAmazonAIOperations": "true" }, "ForAllValues:StringEquals": { "aws:TagKeys": [ "ManagedByAmazonAIOperations" User Guide ] } } }, { "Sid": "SSOManagementAccess", "Effect": "Allow", "Action": [ "identitystore:DescribeUser", "sso:ListApplications", "sso:ListInstances", "sso:DescribeRegisteredRegions", "sso:GetSharedSsoConfiguration", "sso:DescribeInstance", "sso:GetSSOStatus", "sso-directory:DescribeUsers" ], "Resource": "*" }, { "Sid": "AllowSTSContextSetting", "Effect": "Allow", "Action": [ "sts:SetContext" ], "Resource": "arn:aws:sts::*:self" }, { "Sid": "IdentityPropagationAccess", "Effect": "Allow", "Action": [ "signin:ListTrustedIdentityPropagationApplicationsForConsole" ], "Resource": "*" }, { "Sid": "CloudtrailAccess", AWS managed (predefined) policies for CloudWatch 3161 Amazon CloudWatch User Guide "Effect": "Allow", "Action": [ "cloudtrail:ListTrails", "cloudtrail:DescribeTrails", "cloudtrail:ListEventDataStores" ], "Resource": "*" }, { "Sid": "KMSAccess", "Effect": "Allow", "Action": [ "kms:ListAliases" ], "Resource": "*" }, { "Sid": "SSMIntegrationSecretsManagerAccess", "Effect": "Allow", "Action": [ "secretsmanager:CreateSecret", "secretsmanager:PutResourcePolicy", "secretsmanager:UpdateSecret", "secretsmanager:DeleteSecret" ], "Resource": "arn:aws:secretsmanager:*:*:secret:aws/ssm/3p/*" }, { "Sid": "SSMIntegrationAccess", "Effect": "Allow", "Action": [ "ssm:GetServiceSetting", "ssm:UpdateServiceSetting"
acw-ug-880
acw-ug.pdf
880
"Allow", "Action": [ "identitystore:DescribeUser", "sso:ListApplications", "sso:ListInstances", "sso:DescribeRegisteredRegions", "sso:GetSharedSsoConfiguration", "sso:DescribeInstance", "sso:GetSSOStatus", "sso-directory:DescribeUsers" ], "Resource": "*" }, { "Sid": "AllowSTSContextSetting", "Effect": "Allow", "Action": [ "sts:SetContext" ], "Resource": "arn:aws:sts::*:self" }, { "Sid": "IdentityPropagationAccess", "Effect": "Allow", "Action": [ "signin:ListTrustedIdentityPropagationApplicationsForConsole" ], "Resource": "*" }, { "Sid": "CloudtrailAccess", AWS managed (predefined) policies for CloudWatch 3161 Amazon CloudWatch User Guide "Effect": "Allow", "Action": [ "cloudtrail:ListTrails", "cloudtrail:DescribeTrails", "cloudtrail:ListEventDataStores" ], "Resource": "*" }, { "Sid": "KMSAccess", "Effect": "Allow", "Action": [ "kms:ListAliases" ], "Resource": "*" }, { "Sid": "SSMIntegrationSecretsManagerAccess", "Effect": "Allow", "Action": [ "secretsmanager:CreateSecret", "secretsmanager:PutResourcePolicy", "secretsmanager:UpdateSecret", "secretsmanager:DeleteSecret" ], "Resource": "arn:aws:secretsmanager:*:*:secret:aws/ssm/3p/*" }, { "Sid": "SSMIntegrationAccess", "Effect": "Allow", "Action": [ "ssm:GetServiceSetting", "ssm:UpdateServiceSetting" ], "Resource": "arn:aws:ssm:*:*:servicesetting/integrations/*" }, { "Sid": "SSMIntegrationCreatePolicy", "Effect": "Allow", "Action": [ "iam:CreatePolicy" ], "Resource": "arn:aws:iam::*:policy/service-role/ AWSServiceRoleSSMIntegrationsPolicy*" AWS managed (predefined) policies for CloudWatch 3162 User Guide Amazon CloudWatch }, { "Sid": "ChatbotConfigurations", "Effect": "Allow", "Action": [ "chatbot:DescribeChimeWebhookConfigurations", "chatbot:DescribeSlackWorkspaces", "chatbot:DescribeSlackChannelConfigurations", "chatbot:ListMicrosoftTeamsChannelConfigurations", "chatbot:ListMicrosoftTeamsConfiguredTeams" ], "Resource": "*" }, { "Sid": "IAMPassRoleToAIOps", "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { "StringEquals": { "iam:PassedToService": "aiops.amazonaws.com" } } }, { "Sid": "IAMListRoles", "Effect": "Allow", "Action": [ "iam:ListRoles" ], "Resource": "*" }, { "Sid": "TagBoundaryPermission", "Effect": "Allow", "Action": [ "tag:GetTagKeys" ], "Resource": "*" }, { "Sid": "IAMPassRoleToSSMIntegration", AWS managed (predefined) policies for CloudWatch 3163 Amazon CloudWatch User Guide "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { "StringEquals": { "iam:PassedToService": "ssm.integrations.amazonaws.com" }, "ArnEquals": { "iam:AssociatedResourceArn": "arn:aws:aiops:*:*:investigation-group/*" } } }, { "Sid": "SSMOpsItemAccess", "Effect": "Allow", "Action": [ "ssm:CreateOpsItem", "ssm:AddTagsToResource" ], "Resource": "arn:*:ssm:*:*:opsitem/*", "Condition": { "StringEquals": { "aws:RequestTag/Integration": "CloudWatch", "aws:ResourceTag/Integration": "CloudWatch" }, "ForAllValues:StringEquals": { "aws:TagKeys": [ "Integration" ] } } } ] } AIOpsOperatorAccess The AIOpsOperatorAccess policy grants access to a limited set of Amazon Q Developer operational investigations APIs which include creating, updating, and deleting investigations, investigation events, and investigation resources. AWS managed (predefined) policies for CloudWatch 3164 Amazon CloudWatch User Guide This policy only provides access to investigations. You should be sure that IAM principals with this policy also have permissions to read CloudWatch observability data such as metrics, SLOs, and CloudWatch Logs query results. • The aiops permissions allow access to Amazon Q Developer operational investigations APIs to create, update, and delete investigations. • The sso, identitystore, and sts permssions allow actions needed for IAM Identity Center management which facilitate identity-aware sessions. • The ssm permissions are required for SSM Ops Item integration with third-party issue management. The following are the contents of the AIOpsOperatorAccess policy. { "Version": "2012-10-17", "Statement": [ { "Sid": "AIOpsOperatorAccess", "Effect": "Allow", "Action": [ "aiops:CreateInvestigation", "aiops:CreateInvestigationEvent", "aiops:CreateInvestigationResource", "aiops:DeleteInvestigation", "aiops:Get*", "aiops:List*", "aiops:UpdateInvestigation", "aiops:UpdateInvestigationEvent" ], "Resource": "*" }, { "Sid": "SSOManagementAccess", "Effect": "Allow", "Action": [ "identitystore:DescribeUser", "sso:DescribeInstance", "sso-directory:DescribeUsers" ], "Resource": "*" }, AWS managed (predefined) policies for CloudWatch 3165 User Guide Amazon CloudWatch { "Sid": "AllowSTSContextSetting", "Effect": "Allow", "Action": [ "sts:SetContext" ], "Resource": "arn:aws:sts::*:self" }, { "Sid": "SSMSettingServiceIntegration", "Effect": "Allow", "Action": [ "ssm:GetServiceSetting" ], "Resource": "arn:aws:ssm:*:*:servicesetting/integrations/*" }, { "Sid": "SSMIntegrationTagAccess", "Effect": "Allow", "Action": [ "ssm:AddTagsToResource", "ssm:CreateOpsItem" ], "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/Integration": [ "CloudWatch" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "Integration" } } }, { "Sid": "SSMOpsItemIntegration", "Effect": "Allow", "Action": [ "ssm:DeleteOpsItem", "ssm:UpdateOpsItem" ], "Resource": "*", "Condition": { AWS managed (predefined) policies for CloudWatch 3166 Amazon CloudWatch User Guide "StringEquals": { "aws:ResourceTag/Integration": [ "CloudWatch" ] } } }, { "Sid": "SSMTagOperation", "Effect": "Allow", "Action": [ "ssm:AddTagsToResource" ], "Resource": "arn:aws:ssm:*:*:opsitem/*", "Condition": { "StringEquals": { "aws:ResourceTag/Integration": [ "CloudWatch" ] }, "ForAllValues:StringEquals": { "aws:TagKeys": "Integration" } } }, { "Sid": "SSMOpsSummaryIntegration", "Effect": "Allow", "Action": [ "ssm:GetOpsSummary" ], "Resource": "*" } ] } AIOpsReadOnlyAccess The AIOpsReadOnlyAccess policy grants read-only permissions for Amazon Q investigations and other related services. The following are the contents of the AIOpsReadOnlyAccess policy. { AWS managed (predefined) policies for CloudWatch 3167 Amazon CloudWatch User Guide "Version": "2012-10-17", "Statement": [ { "Sid": "AIOpsReadOnlyAccess", "Effect": "Allow", "Action": [ "aiops:Get*", "aiops:List*" ], "Resource": "*" }, { "Sid": "SSOManagementAccess", "Effect": "Allow", "Action": [ "identitystore:DescribeUser", "sso:DescribeInstance", "sso-directory:DescribeUsers" ], "Resource": "*" } ] } IAM policy for Amazon Q Developer operational investigations (AIOpsAssistantPolicy) The AIOpsAssistantPolicy policy in this section is not to be assigned to users or administrators. Instead, you assign AIOpsAssistantPolicy to Amazon Q Developer to enable it to analyze your AWS resources during investigations of operational events. This policy is scoped based on the resources that Amazon Q Developer supports during investigations, and will be updated as more resources are supported. You can also choose to assign the general AWS ReadOnlyAccess to the assistant in addition to assigning it AIOpsAssistantPolicy. The reason to do this is that ReadOnlyAccess will be updated more frequently by AWS with permissions for new AWS services and actions that are released. The AIOpsAssistantPolicy will also be updated for new actions, but not as frequently. The following are the contents of the AIOpsAssistantPolicy policy. { "Version": "2012-10-17", "Statement": [ AWS managed (predefined) policies for CloudWatch 3168 User Guide Amazon CloudWatch { "Sid": "AIOPSServiceAccess", "Effect": "Allow", "Action": [ "access-analyzer:GetAnalyzer", "access-analyzer:List*", "acm-pca:Describe*", "acm-pca:GetCertificate",
acw-ug-881
acw-ug.pdf
881
updated as more resources are supported. You can also choose to assign the general AWS ReadOnlyAccess to the assistant in addition to assigning it AIOpsAssistantPolicy. The reason to do this is that ReadOnlyAccess will be updated more frequently by AWS with permissions for new AWS services and actions that are released. The AIOpsAssistantPolicy will also be updated for new actions, but not as frequently. The following are the contents of the AIOpsAssistantPolicy policy. { "Version": "2012-10-17", "Statement": [ AWS managed (predefined) policies for CloudWatch 3168 User Guide Amazon CloudWatch { "Sid": "AIOPSServiceAccess", "Effect": "Allow", "Action": [ "access-analyzer:GetAnalyzer", "access-analyzer:List*", "acm-pca:Describe*", "acm-pca:GetCertificate", "acm-pca:GetCertificateAuthorityCertificate", "acm-pca:GetCertificateAuthorityCsr", "acm-pca:List*", "acm:DescribeCertificate", "acm:GetAccountConfiguration", "airflow:List*", "amplify:GetApp", "amplify:GetBranch", "amplify:GetDomainAssociation", "amplify:List*", "aoss:BatchGetCollection", "aoss:BatchGetLifecyclePolicy", "aoss:BatchGetVpcEndpoint", "aoss:GetAccessPolicy", "aoss:GetSecurityConfig", "aoss:GetSecurityPolicy", "aoss:List*", "appconfig:GetApplication", "appconfig:GetConfigurationProfile", "appconfig:GetEnvironment", "appconfig:GetHostedConfigurationVersion", "appconfig:List*", "appflow:Describe*", "appflow:List*", "application-autoscaling:Describe*", "application-signals:BatchGetServiceLevelObjectiveBudgetReport", "application-signals:GetService", "application-signals:GetServiceLevelObjective", "application-signals:List*", "applicationinsights:Describe*", "applicationinsights:List*", "apprunner:Describe*", "apprunner:List*", "appstream:Describe*", "appstream:List*", "appsync:GetApiAssociation", AWS managed (predefined) policies for CloudWatch 3169 Amazon CloudWatch User Guide "appsync:GetDomainName", "appsync:GetFunction", "appsync:GetResolver", "appsync:GetSourceApiAssociation", "appsync:List*", "aps:Describe*", "aps:List*", "arc-zonal-shift:GetManagedResource", "arc-zonal-shift:List*", "athena:GetCapacityAssignmentConfiguration", "athena:GetCapacityReservation", "athena:GetDataCatalog", "athena:GetNamedQuery", "athena:GetPreparedStatement", "athena:GetWorkGroup", "athena:List*", "auditmanager:GetAssessment", "auditmanager:List*", "autoscaling:Describe*", "backup-gateway:GetHypervisor", "backup-gateway:List*", "backup:Describe*", "backup:GetBackupPlan", "backup:GetBackupSelection", "backup:GetBackupVaultAccessPolicy", "backup:GetBackupVaultNotifications", "backup:GetRestoreTestingPlan", "backup:GetRestoreTestingSelection", "backup:List*", "batch:DescribeComputeEnvironments", "batch:DescribeJobQueues", "batch:DescribeSchedulingPolicies", "batch:List*", "bedrock:GetAgent", "bedrock:GetAgentActionGroup", "bedrock:GetAgentAlias", "bedrock:GetAgentKnowledgeBase", "bedrock:GetDataSource", "bedrock:GetGuardrail", "bedrock:GetKnowledgeBase", "bedrock:List*", "budgets:Describe*", "budgets:List*", "ce:Describe*", AWS managed (predefined) policies for CloudWatch 3170 Amazon CloudWatch User Guide "ce:GetAnomalyMonitors", "ce:GetAnomalySubscriptions", "ce:List*", "chatbot:Describe*", "chatbot:GetMicrosoftTeamsChannelConfiguration", "chatbot:List*", "cleanrooms-ml:GetTrainingDataset", "cleanrooms-ml:List*", "cleanrooms:GetAnalysisTemplate", "cleanrooms:GetCollaboration", "cleanrooms:GetConfiguredTable", "cleanrooms:GetConfiguredTableAnalysisRule", "cleanrooms:GetConfiguredTableAssociation", "cleanrooms:GetMembership", "cleanrooms:List*", "cloudformation:Describe*", "cloudformation:GetResource", "cloudformation:GetStackPolicy", "cloudformation:GetTemplate", "cloudformation:List*", "cloudfront:Describe*", "cloudfront:GetCachePolicy", "cloudfront:GetCloudFrontOriginAccessIdentity", "cloudfront:GetContinuousDeploymentPolicy", "cloudfront:GetDistribution", "cloudfront:GetDistributionConfig", "cloudfront:GetFunction", "cloudfront:GetKeyGroup", "cloudfront:GetMonitoringSubscription", "cloudfront:GetOriginAccessControl", "cloudfront:GetOriginRequestPolicy", "cloudfront:GetPublicKey", "cloudfront:GetRealtimeLogConfig", "cloudfront:GetResponseHeadersPolicy", "cloudfront:List*", "cloudtrail:Describe*", "cloudtrail:GetChannel", "cloudtrail:GetEventDataStore", "cloudtrail:GetEventSelectors", "cloudtrail:GetInsightSelectors", "cloudtrail:GetQueryResults", "cloudtrail:GetResourcePolicy", "cloudtrail:GetTrail", "cloudtrail:GetTrailStatus", AWS managed (predefined) policies for CloudWatch 3171 Amazon CloudWatch User Guide "cloudtrail:List*", "cloudtrail:LookupEvents", "cloudtrail:StartQuery", "cloudwatch:Describe*", "cloudwatch:GenerateQuery", "cloudwatch:GetDashboard", "cloudwatch:GetInsightRuleReport", "cloudwatch:GetMetricData", "cloudwatch:GetMetricStream", "cloudwatch:GetService", "cloudwatch:GetServiceLevelObjective", "cloudwatch:List*", "codeartifact:Describe*", "codeartifact:GetDomainPermissionsPolicy", "codeartifact:GetRepositoryPermissionsPolicy", "codeartifact:List*", "codebuild:BatchGetFleets", "codebuild:List*", "codecommit:GetRepository", "codecommit:GetRepositoryTriggers", "codedeploy:BatchGetDeployments", "codedeploy:BatchGetDeploymentTargets", "codedeploy:GetApplication", "codedeploy:GetDeploymentConfig", "codedeploy:List*", "codeguru-profiler:Describe*", "codeguru-profiler:GetNotificationConfiguration", "codeguru-profiler:GetPolicy", "codeguru-profiler:List*", "codeguru-reviewer:Describe*", "codeguru-reviewer:List*", "codepipeline:GetPipeline", "codepipeline:GetPipelineState", "codepipeline:List*", "codestar-connections:GetConnection", "codestar-connections:GetRepositoryLink", "codestar-connections:GetSyncConfiguration", "codestar-connections:List*", "codestar-notifications:Describe*", "codestar-notifications:List*", "cognito-identity:DescribeIdentityPool", "cognito-identity:GetIdentityPoolRoles", "cognito-identity:ListIdentityPools", "cognito-identity:ListTagsForResource", AWS managed (predefined) policies for CloudWatch 3172 Amazon CloudWatch User Guide "cognito-idp:AdminListGroupsForUser", "cognito-idp:DescribeIdentityProvider", "cognito-idp:DescribeResourceServer", "cognito-idp:DescribeRiskConfiguration", "cognito-idp:DescribeUserImportJob", "cognito-idp:DescribeUserPool", "cognito-idp:DescribeUserPoolDomain", "cognito-idp:GetGroup", "cognito-idp:GetLogDeliveryConfiguration", "cognito-idp:GetUICustomization", "cognito-idp:GetUserPoolMfaConfig", "cognito-idp:GetWebACLForResource", "cognito-idp:ListGroups", "cognito-idp:ListIdentityProviders", "cognito-idp:ListResourceServers", "cognito-idp:ListUserPoolClients", "cognito-idp:ListUserPools", "cognito-idp:ListUsers", "cognito-idp:ListTagsForResource", "comprehend:Describe*", "comprehend:List*", "config:Describe*", "config:GetStoredQuery", "config:List*", "connect:Describe*", "connect:GetTaskTemplate", "connect:List*", "databrew:Describe*", "databrew:List*", "datapipeline:Describe*", "datapipeline:GetPipelineDefinition", "datapipeline:List*", "datasync:Describe*", "datasync:List*", "deadline:GetFarm", "deadline:GetFleet", "deadline:GetLicenseEndpoint", "deadline:GetMonitor", "deadline:GetQueue", "deadline:GetQueueEnvironment", "deadline:GetQueueFleetAssociation", "deadline:GetStorageProfile", "deadline:List*", "detective:GetMembers", AWS managed (predefined) policies for CloudWatch 3173 Amazon CloudWatch User Guide "detective:List*", "devicefarm:GetDevicePool", "devicefarm:GetInstanceProfile", "devicefarm:GetNetworkProfile", "devicefarm:GetProject", "devicefarm:GetTestGridProject", "devicefarm:GetVPCEConfiguration", "devicefarm:List*", "devops-guru:Describe*", "devops-guru:GetResourceCollection", "devops-guru:List*", "dms:Describe*", "dms:List*", "ds:Describe*", "dynamodb:Describe*", "dynamodb:GetResourcePolicy", "dynamodb:List*", "ec2:Describe*", "ec2:GetAssociatedEnclaveCertificateIamRoles", "ec2:GetIpamPoolAllocations", "ec2:GetIpamPoolCidrs", "ec2:GetManagedPrefixListEntries", "ec2:GetNetworkInsightsAccessScopeContent", "ec2:GetSnapshotBlockPublicAccessState", "ec2:GetTransitGatewayMulticastDomainAssociations", "ec2:GetTransitGatewayRouteTableAssociations", "ec2:GetTransitGatewayRouteTablePropagations", "ec2:GetVerifiedAccessEndpointPolicy", "ec2:GetVerifiedAccessGroupPolicy", "ec2:GetVerifiedAccessInstanceWebAcl", "ec2:SearchLocalGatewayRoutes", "ec2:SearchTransitGatewayRoutes", "ecr:Describe*", "ecr:GetLifecyclePolicy", "ecr:GetRegistryPolicy", "ecr:GetRepositoryPolicy", "ecr:List*", "ecs:Describe*", "ecs:List*", "eks:Describe*", "eks:List*", "elastic-inference:Describe*", "elasticache:Describe*", "elasticache:List*", AWS managed (predefined) policies for CloudWatch 3174 Amazon CloudWatch User Guide "elasticbeanstalk:Describe*", "elasticbeanstalk:List*", "elasticfilesystem:Describe*", "elasticloadbalancing:Describe*", "elasticmapreduce:Describe*", "elasticmapreduce:List*", "emr-containers:Describe*", "emr-containers:List*", "emr-serverless:GetApplication", "emr-serverless:List*", "es:Describe*", "es:List*", "events:Describe*", "events:List*", "evidently:GetExperiment", "evidently:GetFeature", "evidently:GetLaunch", "evidently:GetProject", "evidently:GetSegment", "evidently:List*", "firehose:Describe*", "firehose:List*", "fis:GetExperimentTemplate", "fis:GetTargetAccountConfiguration", "fis:List*", "fms:GetNotificationChannel", "fms:GetPolicy", "fms:List*", "forecast:Describe*", "forecast:List*", "frauddetector:BatchGetVariable", "frauddetector:Describe*", "frauddetector:GetDetectors", "frauddetector:GetDetectorVersion", "frauddetector:GetEntityTypes", "frauddetector:GetEventTypes", "frauddetector:GetExternalModels", "frauddetector:GetLabels", "frauddetector:GetListElements", "frauddetector:GetListsMetadata", "frauddetector:GetModelVersion", "frauddetector:GetOutcomes", "frauddetector:GetRules", "frauddetector:GetVariables", AWS managed (predefined) policies for CloudWatch 3175 Amazon CloudWatch User Guide "frauddetector:List*", "fsx:Describe*", "gamelift:Describe*", "gamelift:List*", "globalaccelerator:Describe*", "globalaccelerator:List*", "glue:GetDatabase", "glue:GetDatabases", "glue:GetJob", "glue:GetRegistry", "glue:GetSchema", "glue:GetSchemaVersion", "glue:GetTable", "glue:GetTags", "glue:GetTrigger", "glue:List*", "glue:querySchemaVersionMetadata", "grafana:Describe*", "grafana:List*", "greengrass:Describe*", "greengrass:GetDeployment", "greengrass:List*", "groundstation:GetConfig", "groundstation:GetDataflowEndpointGroup", "groundstation:GetMissionProfile", "groundstation:List*", "guardduty:GetDetector", "guardduty:GetFilter", "guardduty:GetIPSet", "guardduty:GetMalwareProtectionPlan", "guardduty:GetMasterAccount", "guardduty:GetMembers", "guardduty:GetThreatIntelSet", "guardduty:List*", "health:DescribeEvents", "health:DescribeEventDetails", "healthlake:Describe*", "healthlake:List*", "iam:GetGroup", "iam:GetGroupPolicy", "iam:GetInstanceProfile", "iam:GetLoginProfile", "iam:GetOpenIDConnectProvider", "iam:GetPolicy", AWS managed (predefined) policies for CloudWatch 3176 Amazon CloudWatch User Guide "iam:GetPolicyVersion", "iam:GetRole", "iam:GetRolePolicy", "iam:GetSAMLProvider", "iam:GetServerCertificate", "iam:GetServiceLinkedRoleDeletionStatus", "iam:GetUser", "iam:GetUserPolicy", "iam:ListOpenIDConnectProviders", "iam:ListServerCertificates", "iam:ListVirtualMFADevices", "identitystore:DescribeGroup", "identitystore:DescribeGroupMembership", "identitystore:ListGroupMemberships", "identitystore:ListGroups", "imagebuilder:GetComponent", "imagebuilder:GetContainerRecipe", "imagebuilder:GetDistributionConfiguration", "imagebuilder:GetImage", "imagebuilder:GetImagePipeline", "imagebuilder:GetImageRecipe", "imagebuilder:GetInfrastructureConfiguration", "imagebuilder:GetLifecyclePolicy", "imagebuilder:GetWorkflow", "imagebuilder:List*", "inspector2:List*", "inspector:Describe*", "inspector:List*", "internetmonitor:GetMonitor", "internetmonitor:List*", "iot:Describe*", "iot:GetPackage", "iot:GetPackageVersion", "iot:GetPolicy", "iot:GetThingShadow", "iot:GetTopicRule", "iot:GetTopicRuleDestination", "iot:GetV2LoggingOptions", "iot:List*", "iotanalytics:Describe*", "iotanalytics:List*", "iotevents:Describe*", "iotevents:List*", "iotfleethub:Describe*", AWS managed (predefined) policies for CloudWatch 3177 Amazon CloudWatch User Guide "iotfleethub:List*", "iotsitewise:Describe*", "iotsitewise:List*", "iotwireless:GetDestination", "iotwireless:GetDeviceProfile", "iotwireless:GetFuotaTask", "iotwireless:GetMulticastGroup", "iotwireless:GetNetworkAnalyzerConfiguration", "iotwireless:GetServiceProfile", "iotwireless:GetWirelessDevice", "iotwireless:GetWirelessGateway", "iotwireless:GetWirelessGatewayTaskDefinition", "iotwireless:List*", "ivs:GetChannel", "ivs:GetEncoderConfiguration", "ivs:GetPlaybackRestrictionPolicy", "ivs:GetRecordingConfiguration", "ivs:GetStage", "ivs:List*", "ivschat:GetLoggingConfiguration", "ivschat:GetRoom", "ivschat:List*", "kafka:Describe*", "kafka:GetClusterPolicy", "kafka:List*", "kafkaconnect:Describe*", "kafkaconnect:List*", "kendra:Describe*", "kendra:List*", "kinesis:Describe*", "kinesis:List*", "kinesisanalytics:Describe*", "kinesisanalytics:List*", "kinesisvideo:Describe*", "kms:DescribeKey", "kms:ListResourceTags", "kms:ListKeys", "lakeformation:Describe*", "lakeformation:GetLFTag", "lakeformation:GetResourceLFTags", "lakeformation:List*", "lambda:GetAlias", "lambda:GetCodeSigningConfig", "lambda:GetEventSourceMapping", AWS managed (predefined) policies for CloudWatch 3178 Amazon CloudWatch User Guide "lambda:GetFunction", "lambda:GetFunctionCodeSigningConfig", "lambda:GetFunctionConfiguration", "lambda:GetFunctionEventInvokeConfig", "lambda:GetFunctionRecursionConfig", "lambda:GetFunctionUrlConfig", "lambda:GetLayerVersion", "lambda:GetLayerVersionPolicy", "lambda:GetPolicy", "lambda:GetProvisionedConcurrencyConfig", "lambda:GetRuntimeManagementConfig", "lambda:List*", "launchwizard:GetDeployment", "launchwizard:List*", "lex:Describe*", "lex:List*", "license-manager:GetLicense", "license-manager:List*", "lightsail:GetAlarms", "lightsail:GetBuckets", "lightsail:GetCertificates", "lightsail:GetContainerServices", "lightsail:GetDisk", "lightsail:GetDisks", "lightsail:GetInstance", "lightsail:GetInstances", "lightsail:GetLoadBalancer", "lightsail:GetLoadBalancers", "lightsail:GetLoadBalancerTlsCertificates", "lightsail:GetStaticIp", "lightsail:GetStaticIps", "logs:Describe*", "logs:FilterLogEvents", "logs:GetDataProtectionPolicy", "logs:GetDelivery", "logs:GetDeliveryDestination", "logs:GetDeliveryDestinationPolicy", "logs:GetDeliverySource", "logs:GetLogAnomalyDetector", "logs:GetLogDelivery", "logs:GetQueryResults", "logs:List*", "logs:StartQuery", "logs:StopLiveTail", AWS managed (predefined) policies for CloudWatch 3179 Amazon CloudWatch User Guide "logs:StopQuery", "logs:TestMetricFilter", "lookoutmetrics:Describe*", "lookoutmetrics:List*", "lookoutvision:Describe*", "lookoutvision:List*", "m2:GetApplication", "m2:GetEnvironment", "m2:List*", "macie2:GetAllowList", "macie2:GetCustomDataIdentifier", "macie2:GetFindingsFilter", "macie2:GetMacieSession", "macie2:List*", "mediaconnect:Describe*", "mediaconnect:List*", "medialive:Describe*", "medialive:GetCloudWatchAlarmTemplate", "medialive:GetCloudWatchAlarmTemplateGroup", "medialive:GetEventBridgeRuleTemplate", "medialive:GetEventBridgeRuleTemplateGroup", "medialive:GetSignalMap", "medialive:List*", "mediapackage-vod:Describe*", "mediapackage-vod:List*", "mediapackage:Describe*", "mediapackage:List*", "mediapackagev2:GetChannel", "mediapackagev2:GetChannelGroup", "mediapackagev2:GetChannelPolicy", "mediapackagev2:GetOriginEndpoint", "mediapackagev2:GetOriginEndpointPolicy", "mediapackagev2:List*", "memorydb:Describe*", "memorydb:List*", "mobiletargeting:GetInAppTemplate", "mobiletargeting:List*", "mq:Describe*", "mq:List*", "network-firewall:Describe*", "network-firewall:List*", "networkmanager:Describe*", "networkmanager:GetConnectAttachment", "networkmanager:GetConnectPeer", AWS managed (predefined) policies for CloudWatch 3180 Amazon CloudWatch User Guide "networkmanager:GetCoreNetwork", "networkmanager:GetCoreNetworkPolicy", "networkmanager:GetCustomerGatewayAssociations", "networkmanager:GetDevices", "networkmanager:GetLinkAssociations", "networkmanager:GetLinks", "networkmanager:GetSites", "networkmanager:GetSiteToSiteVpnAttachment", "networkmanager:GetTransitGatewayPeering", "networkmanager:GetTransitGatewayRegistrations", "networkmanager:GetTransitGatewayRouteTableAttachment", "networkmanager:GetVpcAttachment", "networkmanager:List*", "nimble:GetLaunchProfile", "nimble:GetStreamingImage", "nimble:GetStudio", "nimble:GetStudioComponent", "nimble:List*", "oam:GetLink", "oam:GetSink", "oam:GetSinkPolicy", "oam:List*", "omics:GetAnnotationStore", "omics:GetReferenceStore", "omics:GetRunGroup", "omics:GetSequenceStore", "omics:GetVariantStore", "omics:GetWorkflow", "omics:List*", "opsworks-cm:Describe*", "opsworks-cm:List*", "organizations:Describe*", "organizations:List*", "osis:GetPipeline", "osis:List*", "payment-cryptography:GetAlias", "payment-cryptography:GetKey", "payment-cryptography:List*", "pca-connector-ad:GetConnector", "pca-connector-ad:GetDirectoryRegistration", "pca-connector-ad:GetServicePrincipalName", "pca-connector-ad:GetTemplate", "pca-connector-ad:GetTemplateGroupAccessControlEntry", "pca-connector-ad:List*", AWS managed (predefined) policies
acw-ug-882
acw-ug.pdf
882
"lookoutmetrics:List*", "lookoutvision:Describe*", "lookoutvision:List*", "m2:GetApplication", "m2:GetEnvironment", "m2:List*", "macie2:GetAllowList", "macie2:GetCustomDataIdentifier", "macie2:GetFindingsFilter", "macie2:GetMacieSession", "macie2:List*", "mediaconnect:Describe*", "mediaconnect:List*", "medialive:Describe*", "medialive:GetCloudWatchAlarmTemplate", "medialive:GetCloudWatchAlarmTemplateGroup", "medialive:GetEventBridgeRuleTemplate", "medialive:GetEventBridgeRuleTemplateGroup", "medialive:GetSignalMap", "medialive:List*", "mediapackage-vod:Describe*", "mediapackage-vod:List*", "mediapackage:Describe*", "mediapackage:List*", "mediapackagev2:GetChannel", "mediapackagev2:GetChannelGroup", "mediapackagev2:GetChannelPolicy", "mediapackagev2:GetOriginEndpoint", "mediapackagev2:GetOriginEndpointPolicy", "mediapackagev2:List*", "memorydb:Describe*", "memorydb:List*", "mobiletargeting:GetInAppTemplate", "mobiletargeting:List*", "mq:Describe*", "mq:List*", "network-firewall:Describe*", "network-firewall:List*", "networkmanager:Describe*", "networkmanager:GetConnectAttachment", "networkmanager:GetConnectPeer", AWS managed (predefined) policies for CloudWatch 3180 Amazon CloudWatch User Guide "networkmanager:GetCoreNetwork", "networkmanager:GetCoreNetworkPolicy", "networkmanager:GetCustomerGatewayAssociations", "networkmanager:GetDevices", "networkmanager:GetLinkAssociations", "networkmanager:GetLinks", "networkmanager:GetSites", "networkmanager:GetSiteToSiteVpnAttachment", "networkmanager:GetTransitGatewayPeering", "networkmanager:GetTransitGatewayRegistrations", "networkmanager:GetTransitGatewayRouteTableAttachment", "networkmanager:GetVpcAttachment", "networkmanager:List*", "nimble:GetLaunchProfile", "nimble:GetStreamingImage", "nimble:GetStudio", "nimble:GetStudioComponent", "nimble:List*", "oam:GetLink", "oam:GetSink", "oam:GetSinkPolicy", "oam:List*", "omics:GetAnnotationStore", "omics:GetReferenceStore", "omics:GetRunGroup", "omics:GetSequenceStore", "omics:GetVariantStore", "omics:GetWorkflow", "omics:List*", "opsworks-cm:Describe*", "opsworks-cm:List*", "organizations:Describe*", "organizations:List*", "osis:GetPipeline", "osis:List*", "payment-cryptography:GetAlias", "payment-cryptography:GetKey", "payment-cryptography:List*", "pca-connector-ad:GetConnector", "pca-connector-ad:GetDirectoryRegistration", "pca-connector-ad:GetServicePrincipalName", "pca-connector-ad:GetTemplate", "pca-connector-ad:GetTemplateGroupAccessControlEntry", "pca-connector-ad:List*", AWS managed (predefined) policies for CloudWatch 3181 Amazon CloudWatch User Guide "pca-connector-scep:GetChallengeMetadata", "pca-connector-scep:GetConnector", "pca-connector-scep:List*", "personalize:Describe*", "personalize:List*", "pipes:Describe*", "pipes:List*", "proton:GetEnvironmentTemplate", "proton:GetServiceTemplate", "proton:List*", "qbusiness:GetApplication", "qbusiness:GetDataSource", "qbusiness:GetIndex", "qbusiness:GetPlugin", "qbusiness:GetRetriever", "qbusiness:GetWebExperience", "qbusiness:List*", "qldb:Describe*", "qldb:List*", "ram:GetPermission", "ram:List*", "rds:Describe*", "rds:List*", "redshift-serverless:GetNamespace", "redshift-serverless:GetWorkgroup", "redshift-serverless:List*", "redshift:Describe*", "refactor-spaces:GetApplication", "refactor-spaces:GetEnvironment", "refactor-spaces:GetRoute", "refactor-spaces:List*", "rekognition:Describe*", "rekognition:List*", "resiliencehub:Describe*", "resiliencehub:List*", "resource-explorer-2:GetDefaultView", "resource-explorer-2:GetIndex", "resource-explorer-2:GetView", "resource-explorer-2:List*", "resource-groups:GetGroup", "resource-groups:GetGroupConfiguration", "resource-groups:GetGroupQuery", "resource-groups:GetTags", "resource-groups:List*", AWS managed (predefined) policies for CloudWatch 3182 Amazon CloudWatch User Guide "robomaker:Describe*", "robomaker:List*", "route53-recovery-control-config:Describe*", "route53-recovery-control-config:List*", "route53-recovery-readiness:GetCell", "route53-recovery-readiness:GetReadinessCheck", "route53-recovery-readiness:GetRecoveryGroup", "route53-recovery-readiness:GetResourceSet", "route53-recovery-readiness:List*", "route53:GetDNSSEC", "route53:GetHealthCheck", "route53:GetHostedZone", "route53:List*", "route53profiles:GetProfile", "route53profiles:GetProfileAssociation", "route53profiles:GetProfileResourceAssociation", "route53profiles:List*", "route53resolver:GetFirewallDomainList", "route53resolver:GetFirewallRuleGroup", "route53resolver:GetFirewallRuleGroupAssociation", "route53resolver:GetOutpostResolver", "route53resolver:GetResolverConfig", "route53resolver:GetResolverQueryLogConfig", "route53resolver:GetResolverQueryLogConfigAssociation", "route53resolver:GetResolverRule", "route53resolver:GetResolverRuleAssociation", "route53resolver:List*", "rum:GetAppMonitor", "rum:List*", "s3-outposts:GetAccessPoint", "s3-outposts:GetAccessPointPolicy", "s3-outposts:GetBucket", "s3-outposts:GetBucketPolicy", "s3-outposts:GetBucketTagging", "s3-outposts:GetLifecycleConfiguration", "s3-outposts:List*", "s3:GetAccelerateConfiguration", "s3:GetAccessGrant", "s3:GetAccessGrantsInstance", "s3:GetAccessGrantsLocation", "s3:GetAccessPoint", "s3:GetAccessPointConfigurationForObjectLambda", "s3:GetAccessPointForObjectLambda", "s3:GetAccessPointPolicy", AWS managed (predefined) policies for CloudWatch 3183 Amazon CloudWatch User Guide "s3:GetAccessPointPolicyForObjectLambda", "s3:GetAccessPointPolicyStatusForObjectLambda", "s3:GetAnalyticsConfiguration", "s3:GetBucketAcl", "s3:GetBucketCORS", "s3:GetBucketLocation", "s3:GetBucketLogging", "s3:GetBucketNotification", "s3:GetBucketObjectLockConfiguration", "s3:GetBucketOwnershipControls", "s3:GetBucketPolicy", "s3:GetBucketPublicAccessBlock", "s3:GetBucketTagging", "s3:GetBucketVersioning", "S3:GetBucketWebsite", "s3:GetEncryptionConfiguration", "s3:GetIntelligentTieringConfiguration", "s3:GetInventoryConfiguration", "s3:GetLifecycleConfiguration", "s3:GetMetricsConfiguration", "s3:GetMultiRegionAccessPoint", "s3:GetMultiRegionAccessPointPolicy", "s3:GetMultiRegionAccessPointPolicyStatus", "s3:GetReplicationConfiguration", "s3:GetStorageLensConfiguration", "s3:GetStorageLensConfigurationTagging", "s3:GetStorageLensGroup", "s3:List*", "sagemaker:Describe*", "sagemaker:List*", "scheduler:GetSchedule", "scheduler:GetScheduleGroup", "scheduler:List*", "schemas:Describe*", "schemas:GetResourcePolicy", "schemas:List*", "secretsmanager:Describe*", "secretsmanager:GetResourcePolicy", "secretsmanager:List*", "securityhub:BatchGetAutomationRules", "securityhub:BatchGetSecurityControls", "securityhub:Describe*", "securityhub:GetConfigurationPolicy", "securityhub:GetConfigurationPolicyAssociation", AWS managed (predefined) policies for CloudWatch 3184 Amazon CloudWatch User Guide "securityhub:GetEnabledStandards", "securityhub:GetFindingAggregator", "securityhub:GetInsights", "securityhub:List*", "securitylake:GetSubscriber", "securitylake:List*", "servicecatalog:Describe*", "servicecatalog:GetApplication", "servicecatalog:GetAttributeGroup", "servicecatalog:List*", "servicequotas:GetServiceQuota", "ses:Describe*", "ses:GetAccount", "ses:GetAddonInstance", "ses:GetAddonSubscription", "ses:GetArchive", "ses:GetConfigurationSet", "ses:GetConfigurationSetEventDestinations", "ses:GetContactList", "ses:GetDedicatedIpPool", "ses:GetDedicatedIps", "ses:GetEmailIdentity", "ses:GetEmailTemplate", "ses:GetIngressPoint", "ses:GetRelay", "ses:GetRuleSet", "ses:GetTemplate", "ses:GetTrafficPolicy", "ses:List*", "shield:Describe*", "shield:List*", "signer:GetSigningProfile", "signer:List*", "sns:GetDataProtectionPolicy", "sns:GetSubscriptionAttributes", "sns:GetTopicAttributes", "sns:List*", "sqs:GetQueueAttributes", "sqs:GetQueueUrl", "sqs:List*", "ssm-contacts:GetContact", "ssm-contacts:GetContactChannel", "ssm-contacts:List*", "ssm-incidents:GetReplicationSet", AWS managed (predefined) policies for CloudWatch 3185 Amazon CloudWatch User Guide "ssm-incidents:GetResponsePlan", "ssm-incidents:List*", "ssm-sap:GetApplication", "ssm-sap:List*", "ssm:Describe*", "ssm:GetDefaultPatchBaseline", "ssm:GetDocument", "ssm:GetParameters", "ssm:GetPatchBaseline", "ssm:GetResourcePolicies", "ssm:List*", "sso-directory:SearchGroups", "sso-directory:SearchUsers", "sso:GetInlinePolicyForPermissionSet", "sso:GetManagedApplicationInstance", "sso:GetPermissionsBoundaryForPermissionSet", "sso:GetSharedSsoConfiguration", "sso:ListAccountAssignments", "sso:ListApplicationAssignments", "sso:ListApplications", "sso:ListCustomerManagedPolicyReferencesInPermissionSet", "sso:ListInstances", "sso:ListManagedPoliciesInPermissionSet", "sso:ListTagsForResource", "states:Describe*", "states:List*", "synthetics:Describe*", "synthetics:GetCanary", "synthetics:GetGroup", "synthetics:List*", "tag:GetResources", "timestream:Describe*", "timestream:List*", "transfer:Describe*", "transfer:List*", "verifiedpermissions:GetIdentitySource", "verifiedpermissions:GetPolicy", "verifiedpermissions:GetPolicyStore", "verifiedpermissions:GetPolicyTemplate", "verifiedpermissions:GetSchema", "verifiedpermissions:List*", "vpc-lattice:GetAccessLogSubscription", "vpc-lattice:GetAuthPolicy", "vpc-lattice:GetListener", AWS managed (predefined) policies for CloudWatch 3186 Amazon CloudWatch User Guide "vpc-lattice:GetResourcePolicy", "vpc-lattice:GetRule", "vpc-lattice:GetService", "vpc-lattice:GetServiceNetwork", "vpc-lattice:GetServiceNetworkServiceAssociation", "vpc-lattice:GetServiceNetworkVpcAssociation", "vpc-lattice:GetTargetGroup", "vpc-lattice:List*", "wafv2:GetIPSet", "wafv2:GetLoggingConfiguration", "wafv2:GetRegexPatternSet", "wafv2:GetRuleGroup", "wafv2:GetWebACL", "wafv2:GetWebACLForResource", "wafv2:List*", "workspaces-web:GetBrowserSettings", "workspaces-web:GetIdentityProvider", "workspaces-web:GetNetworkSettings", "workspaces-web:GetPortal", "workspaces-web:GetPortalServiceProviderMetadata", "workspaces-web:GetTrustStore", "workspaces-web:GetUserAccessLoggingSettings", "workspaces-web:GetUserSettings", "workspaces-web:List*", "workspaces:Describe*", "xray:BatchGetTraces", "xray:GetGroup", "xray:GetGroups", "xray:GetSamplingRules", "xray:GetServiceGraph", "xray:GetTraceSummaries", "xray:List*" ], "Resource": "*" }, { "Sid": "AIOPSS3AccessForAmplify", "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion", "s3:GetObjectAcl" ], "Resource": [ AWS managed (predefined) policies for CloudWatch 3187 Amazon CloudWatch User Guide "arn:aws:s3:::amplify", "arn:aws:s3:::cdk--assets--*" ], "Condition": { "StringEquals": { "aws:ViaAWSService": [ "amplify.amazonaws.com" ], "aws:PrincipalAccount": [ "${aws:ResourceAccount}" ] } } }, { "Sid": "AIOPSAPIGatewayAccess", "Effect": "Allow", "Action": [ "apigateway:GET" ], "Resource": [ "arn:aws:apigateway:*::/restapis", "arn:aws:apigateway:*::/restapis/*", "arn:aws:apigateway:*::/restapis/*/deployments", "arn:aws:apigateway:*::/restapis/*/deployments/*", "arn:aws:apigateway:*::/restapis/*/resources/*/methods/*/integrations", "arn:aws:apigateway:*::/restapis/*/resources/*/methods/*/integrations/*", "arn:aws:apigateway:*::/restapis/*/stages", "arn:aws:apigateway:*::/restapis/*/stages/*", "arn:aws:apigateway:*::/apis", "arn:aws:apigateway:*::/apis/*", "arn:aws:apigateway:*::/apis/*/deployments", "arn:aws:apigateway:*::/apis/*/deployments/*", "arn:aws:apigateway:*::/apis/*/integrations", "arn:aws:apigateway:*::/apis/*/integrations/*", "arn:aws:apigateway:*::/apis/*/stages", "arn:aws:apigateway:*::/apis/*/stages/*" ] } ] } AWS managed (predefined) policies for CloudWatch 3188 Amazon CloudWatch User Guide AWS managed (predefined) policies for CloudWatch Application Signals The policies in this section grant permissions related to CloudWatch Application Signals. For more information, see Application Signals. CloudWatchApplicationSignalsReadOnlyAccess AWS has added the CloudWatchApplicationSignalsReadOnlyAccess managed IAM policy. This policy grants read only access to actions and resources available to users in the CloudWatch console under Application Signals. It includes application-signals: policies so that users can use CloudWatch Application signals to view, investigate and monitor the health of their services. It includes an iam:GetRole policy to allow users to retrieve information about an IAM role. It includes logs: policies to start and stop queries, retrieve the configuration for a metruc filter, and obtain query results. It includes cloudwatch: policies so that users can obtain information about a CloudWatch alarm or metrics. It includes synthetics: policies so that users can retrieve information about synthetics canary runs. It includes rum: policies to run batch operations, retrieve data, and update metrics definitions for RUM clients. It includes an xray: policy to retrieve trace summaries. The following are the contents of the CloudWatchApplicationSignalsReadOnlyAccess policy. { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsReadOnlyAccessPermissions", "Effect": "Allow", "Action": [ "application-signals:BatchGetServiceLevelObjectiveBudgetReport", "application-signals:GetService", "application-signals:GetServiceLevelObjective", "application-signals:ListServiceLevelObjectives", "application-signals:ListServiceDependencies", "application-signals:ListServiceDependents", "application-signals:ListServiceOperations", "application-signals:ListServices", "application-signals:ListTagsForResource" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsGetRolePermissions", AWS managed (predefined) policies for CloudWatch 3189 Amazon CloudWatch "Effect": "Allow", User Guide "Action": "iam:GetRole", "Resource": "arn:aws:iam::*:role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" }, { "Sid": "CloudWatchApplicationSignalsLogGroupPermissions", "Effect": "Allow", "Action": [ "logs:StartQuery" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/application-signals/data:*" }, { "Sid": "CloudWatchApplicationSignalsLogsPermissions", "Effect": "Allow", "Action": [ "logs:StopQuery", "logs:GetQueryResults" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsAlarmsReadPermissions", "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsMetricsReadPermissions", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:ListMetrics" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsSyntheticsReadPermissions", "Effect": "Allow", "Action": [ "synthetics:DescribeCanaries", AWS managed (predefined) policies for CloudWatch 3190 Amazon CloudWatch User Guide "synthetics:DescribeCanariesLastRun", "synthetics:GetCanaryRuns" ], "Resource": "*"
acw-ug-883
acw-ug.pdf
883
], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsGetRolePermissions", AWS managed (predefined) policies for CloudWatch 3189 Amazon CloudWatch "Effect": "Allow", User Guide "Action": "iam:GetRole", "Resource": "arn:aws:iam::*:role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" }, { "Sid": "CloudWatchApplicationSignalsLogGroupPermissions", "Effect": "Allow", "Action": [ "logs:StartQuery" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/application-signals/data:*" }, { "Sid": "CloudWatchApplicationSignalsLogsPermissions", "Effect": "Allow", "Action": [ "logs:StopQuery", "logs:GetQueryResults" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsAlarmsReadPermissions", "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsMetricsReadPermissions", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:ListMetrics" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsSyntheticsReadPermissions", "Effect": "Allow", "Action": [ "synthetics:DescribeCanaries", AWS managed (predefined) policies for CloudWatch 3190 Amazon CloudWatch User Guide "synthetics:DescribeCanariesLastRun", "synthetics:GetCanaryRuns" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsRumReadPermissions", "Effect": "Allow", "Action": [ "rum:BatchGetRumMetricDefinitions", "rum:GetAppMonitor", "rum:GetAppMonitorData", "rum:ListAppMonitors" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsXrayReadPermissions", "Effect": "Allow", "Action": [ "xray:GetTraceSummaries" ], "Resource": "*" } ] } CloudWatchApplicationSignalsFullAccess AWS has added the CloudWatchApplicationSignalsFullAccess managed IAM policy. This policy grants access to all actions and resources available to users in the CloudWatch console. It includes application-signals: policies so that users can use CloudWatch Application signals to view, investigate and monitor the health of their services. It uses cloudwatch: policies to retrieve data from metrics and alarms. It uses logs: policies to manage queries and filters. It uses synthetics: policies so that users can retrieve information about synthetics canary runs. It includes rum: policies to run batch operations, retrieve data and update metrics definitions for RUM clients. It includes an xray: policy to retrieve trace summaries. It includes arn:aws:cloudwatch:*:*:alarm: policies so that users can retrieve information about a service level objective (SLO) alarm. It includes iam: policies to manage IAM roles. It uses sns: policies to create, list, and subscribe to an Amazon SNS topic. The following are the contents of the CloudWatchApplicationSignalsFullAccess policy. AWS managed (predefined) policies for CloudWatch 3191 Amazon CloudWatch User Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsFullAccessPermissions", "Effect": "Allow", "Action": "application-signals:*", "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsAlarmsPermissions", "Effect": "Allow", "Action": "cloudwatch:DescribeAlarms", "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsMetricsPermissions", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:ListMetrics" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsLogGroupPermissions", "Effect": "Allow", "Action": [ "logs:StartQuery" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/application-signals/data:*" }, { "Sid": "CloudWatchApplicationSignalsLogsPermissions", "Effect": "Allow", "Action": [ "logs:StopQuery", "logs:GetQueryResults" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsSyntheticsPermissions", AWS managed (predefined) policies for CloudWatch 3192 Amazon CloudWatch User Guide "Effect": "Allow", "Action": [ "synthetics:DescribeCanaries", "synthetics:DescribeCanariesLastRun", "synthetics:GetCanaryRuns" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsRumPermissions", "Effect": "Allow", "Action": [ "rum:BatchCreateRumMetricDefinitions", "rum:BatchDeleteRumMetricDefinitions", "rum:BatchGetRumMetricDefinitions", "rum:GetAppMonitor", "rum:GetAppMonitorData", "rum:ListAppMonitors", "rum:PutRumMetricsDestination", "rum:UpdateRumMetricDefinition" ], "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsXrayPermissions", "Effect": "Allow", "Action": "xray:GetTraceSummaries", "Resource": "*" }, { "Sid": "CloudWatchApplicationSignalsPutMetricAlarmPermissions", "Effect": "Allow", "Action": "cloudwatch:PutMetricAlarm", "Resource": [ "arn:aws:cloudwatch:*:*:alarm:SLO-AttainmentGoalAlarm-*", "arn:aws:cloudwatch:*:*:alarm:SLO-WarningAlarm-*", "arn:aws:cloudwatch:*:*:alarm:SLI-HealthAlarm-*" ] }, { "Sid": "CloudWatchApplicationSignalsCreateServiceLinkedRolePermissions", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", AWS managed (predefined) policies for CloudWatch 3193 Amazon CloudWatch User Guide "Resource": "arn:aws:iam::*:role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals", "Condition": { "StringLike": { "iam:AWSServiceName": "application-signals.cloudwatch.amazonaws.com" } } }, { "Sid": "CloudWatchApplicationSignalsGetRolePermissions", "Effect": "Allow", "Action": "iam:GetRole", "Resource": "arn:aws:iam::*:role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" }, { "Sid": "CloudWatchApplicationSignalsSnsWritePermissions", "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:Subscribe" ], "Resource": "arn:aws:sns:*:*:cloudwatch-application-signals-*" }, { "Sid": "CloudWatchApplicationSignalsSnsReadPermissions", "Effect": "Allow", "Action": "sns:ListTopics", "Resource": "*" } ] } CloudWatchLambdaApplicationSignalsExecutionRolePolicy This policy is used when CloudWatch Application Signals is enabled for Lambda workloads. It enables write access to X-Ray and the log group used by CloudWatch Application Signals. The following are the contents of the CloudWatchLambdaApplicationSignalsExecutionRolePolicy policy. { "Version": "2012-10-17", AWS managed (predefined) policies for CloudWatch 3194 Amazon CloudWatch "Statement": [ { "Sid": "CloudWatchApplicationSignalsXrayWritePermissions", User Guide "Effect": "Allow", "Action": [ "xray:PutTraceSegments" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CloudWatchApplicationSignalsLogGroupWritePermissions", "Effect": "Allow", "Action": [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/application-signals/data:*", "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } } ] } AWS managed (predefined) policies for CloudWatch Synthetics The CloudWatchSyntheticsFullAccess and CloudWatchSyntheticsReadOnlyAccess AWS managed policies are available for you to assign to users who will manage or use CloudWatch Synthetics. The following additional policies are also relevant: • AmazonS3ReadOnlyAccess and CloudWatchReadOnlyAccess – These are necessary to read all Synthetics data in the CloudWatch console. AWS managed (predefined) policies for CloudWatch 3195 Amazon CloudWatch User Guide • AWSLambdaReadOnlyAccess – Required to view the source code used by canaries. • CloudWatchSyntheticsFullAccess – Allows you to create canaries. Additionally, to create and delete canaries that have a new IAM role created for them, you need the following inline policy statement: { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "synthetics:*" ], "Resource":"*" }, { "Effect":"Allow", "Action":[ "s3:CreateBucket", "s3:PutEncryptionConfiguration" ], "Resource":[ "arn:aws:s3:::cw-syn-results-*" ] }, { "Effect":"Allow", "Action":[ "iam:ListRoles", "s3:ListAllMyBuckets", "s3:GetBucketLocation", "xray:GetTraceSummaries", "xray:BatchGetTraces", "apigateway:GET" ], "Resource":"*" }, { "Effect":"Allow", "Action":[ "s3:GetObject", "s3:ListBucket" ], AWS managed (predefined) policies for CloudWatch 3196 Amazon CloudWatch User Guide "Resource":"arn:aws:s3:::cw-syn-*" }, { "Effect":"Allow", "Action":[ "s3:GetObjectVersion" ], "Resource":"arn:aws:s3:::aws-synthetics-library-*" }, { "Effect":"Allow", "Action":[ "iam:PassRole" ], "Resource":[ "arn:aws:iam::*:role/service-role/CloudWatchSyntheticsRole*" ], "Condition":{ "StringEquals":{ "iam:PassedToService":[ "lambda.amazonaws.com", "synthetics.amazonaws.com" ] } } }, { "Effect":"Allow", "Action":[ "iam:GetRole" ], "Resource":[ "arn:aws:iam::*:role/service-role/CloudWatchSyntheticsRole*" ] }, { "Effect":"Allow", "Action":[ "cloudwatch:GetMetricData", "cloudwatch:GetMetricStatistics" ], "Resource":"*" }, { AWS managed (predefined) policies for CloudWatch 3197 Amazon
acw-ug-884
acw-ug.pdf
884
"Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "synthetics:*" ], "Resource":"*" }, { "Effect":"Allow", "Action":[ "s3:CreateBucket", "s3:PutEncryptionConfiguration" ], "Resource":[ "arn:aws:s3:::cw-syn-results-*" ] }, { "Effect":"Allow", "Action":[ "iam:ListRoles", "s3:ListAllMyBuckets", "s3:GetBucketLocation", "xray:GetTraceSummaries", "xray:BatchGetTraces", "apigateway:GET" ], "Resource":"*" }, { "Effect":"Allow", "Action":[ "s3:GetObject", "s3:ListBucket" ], AWS managed (predefined) policies for CloudWatch 3196 Amazon CloudWatch User Guide "Resource":"arn:aws:s3:::cw-syn-*" }, { "Effect":"Allow", "Action":[ "s3:GetObjectVersion" ], "Resource":"arn:aws:s3:::aws-synthetics-library-*" }, { "Effect":"Allow", "Action":[ "iam:PassRole" ], "Resource":[ "arn:aws:iam::*:role/service-role/CloudWatchSyntheticsRole*" ], "Condition":{ "StringEquals":{ "iam:PassedToService":[ "lambda.amazonaws.com", "synthetics.amazonaws.com" ] } } }, { "Effect":"Allow", "Action":[ "iam:GetRole" ], "Resource":[ "arn:aws:iam::*:role/service-role/CloudWatchSyntheticsRole*" ] }, { "Effect":"Allow", "Action":[ "cloudwatch:GetMetricData", "cloudwatch:GetMetricStatistics" ], "Resource":"*" }, { AWS managed (predefined) policies for CloudWatch 3197 Amazon CloudWatch User Guide "Effect":"Allow", "Action":[ "cloudwatch:PutMetricAlarm", "cloudwatch:DeleteAlarms" ], "Resource":[ "arn:aws:cloudwatch:*:*:alarm:Synthetics-*" ] }, { "Effect":"Allow", "Action":[ "cloudwatch:DescribeAlarms" ], "Resource":[ "arn:aws:cloudwatch:*:*:alarm:*" ] }, { "Effect":"Allow", "Action":[ "lambda:CreateFunction", "lambda:AddPermission", "lambda:PublishVersion", "lambda:UpdateFunctionConfiguration", "lambda:GetFunctionConfiguration" ], "Resource":[ "arn:aws:lambda:*:*:function:cwsyn-*" ] }, { "Effect": "Allow", "Action": [ "lambda:GetLayerVersion", "lambda:PublishLayerVersion", "lambda:DeleteLayerVersion" ], "Resource": [ "arn:aws:lambda:*:*:layer:cwsyn-*", "arn:aws:lambda:*:*:layer:Synthetics:*", "arn:aws:lambda:*:*:layer:Synthetics_Selenium:*", "arn:aws:lambda:*:*:layer:AWS-CW-Synthetics*:*" ] AWS managed (predefined) policies for CloudWatch 3198 User Guide Amazon CloudWatch }, { "Effect":"Allow", "Action":[ "ec2:DescribeVpcs", "ec2:DescribeSubnets", "ec2:DescribeSecurityGroups" ], "Resource":[ "*" ] }, { "Effect":"Allow", "Action":[ "sns:ListTopics" ], "Resource":[ "*" ] }, { "Effect":"Allow", "Action":[ "sns:CreateTopic", "sns:Subscribe", "sns:ListSubscriptionsByTopic" ], "Resource":[ "arn:*:sns:*:*:Synthetics-*" ] } ] } Important Granting a user the iam:CreateRole, iam:DeleteRole, iam:CreatePolicy, iam:DeletePolicy, iam:AttachRolePolicy, and iam:DetachRolePolicy permissions gives that user full administrative access to create, attach, and delete roles and policies that have ARNs that match arn:aws:iam::*:role/service-role/ CloudWatchSyntheticsRole* and arn:aws:iam::*:policy/service-role/ AWS managed (predefined) policies for CloudWatch 3199 Amazon CloudWatch User Guide CloudWatchSyntheticsPolicy*. For example, a user with these permissions can create a policy that has full permissions for all resources, and attach that policy to any role that matches that ARN pattern. Be careful to whom you grant these permissions. For information about attaching policies and granting permissions to users, see Changing Permissions for an IAM User and To embed an inline policy for a user or role. CloudWatchSyntheticsFullAccess The following is the content of the CloudWatchSyntheticsFullAccess policy. { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action": [ "synthetics:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "s3:CreateBucket", "s3:PutEncryptionConfiguration" ], "Resource": [ "arn:aws:s3:::cw-syn-results-*" ] }, { "Effect": "Allow", "Action": [ "iam:ListRoles", "s3:ListAllMyBuckets", "xray:GetTraceSummaries", "xray:BatchGetTraces", "apigateway:GET" ], "Resource": "*" }, AWS managed (predefined) policies for CloudWatch 3200 User Guide Amazon CloudWatch { "Effect": "Allow", "Action": [ "s3:GetBucketLocation" ], "Resource": "arn:aws:s3:::*" }, { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:ListBucket" ], "Resource": "arn:aws:s3:::cw-syn-*" }, { "Effect": "Allow", "Action": [ "s3:GetObjectVersion" ], "Resource": "arn:aws:s3:::aws-synthetics-library-*" }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": [ "arn:aws:iam::*:role/service-role/CloudWatchSyntheticsRole*" ], "Condition": { "StringEquals": { "iam:PassedToService": [ "lambda.amazonaws.com", "synthetics.amazonaws.com" ] } } }, { "Effect": "Allow", "Action": [ "iam:GetRole", "iam:ListAttachedRolePolicies" AWS managed (predefined) policies for CloudWatch 3201 Amazon CloudWatch ], User Guide "Resource": [ "arn:aws:iam::*:role/service-role/CloudWatchSyntheticsRole*" ] }, { "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:GetMetricStatistics" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "cloudwatch:PutMetricAlarm", "cloudwatch:DeleteAlarms" ], "Resource": [ "arn:aws:cloudwatch:*:*:alarm:Synthetics-*" ] }, { "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": [ "arn:aws:cloudwatch:*:*:alarm:*" ] }, { "Effect": "Allow", "Action": [ "logs:GetLogRecord", "logs:DescribeLogStreams", "logs:StartQuery", "logs:GetLogEvents", "logs:FilterLogEvents", "logs:GetLogGroupFields" ], "Resource": [ "arn:aws:logs:*:*:log-group:/aws/lambda/cwsyn-*" AWS managed (predefined) policies for CloudWatch 3202 Amazon CloudWatch ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" User Guide } } }, { "Effect": "Allow", "Action": [ "lambda:CreateFunction", "lambda:AddPermission", "lambda:PublishVersion", "lambda:UpdateFunctionCode", "lambda:UpdateFunctionConfiguration", "lambda:GetFunctionConfiguration", "lambda:GetFunction", "lambda:DeleteFunction", "lambda:ListTags", "lambda:TagResource", "lambda:UntagResource" ], "Resource": [ "arn:aws:lambda:*:*:function:cwsyn-*" ] }, { "Effect": "Allow", "Action": [ "lambda:GetLayerVersion", "lambda:PublishLayerVersion", "lambda:DeleteLayerVersion" ], "Resource": [ "arn:aws:lambda:*:*:layer:cwsyn-*", "arn:aws:lambda:*:*:layer:Synthetics:*", "arn:aws:lambda:*:*:layer:Synthetics_Selenium:*", "arn:aws:lambda:*:*:layer:AWS-CW-Synthetics*:*" ] }, { "Effect": "Allow", "Action": [ "ec2:DescribeVpcs", AWS managed (predefined) policies for CloudWatch 3203 Amazon CloudWatch User Guide "ec2:DescribeSubnets", "ec2:DescribeSecurityGroups" ], "Resource": [ "*" ] }, { "Effect": "Allow", "Action": [ "sns:ListTopics" ], "Resource": [ "*" ] }, { "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:Subscribe", "sns:ListSubscriptionsByTopic" ], "Resource": [ "arn:*:sns:*:*:Synthetics-*" ] }, { "Effect": "Allow", "Action": [ "kms:ListAliases" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "kms:DescribeKey" ], "Resource": "arn:aws:kms:*:*:key/*" }, { "Effect": "Allow", "Action": [ AWS managed (predefined) policies for CloudWatch 3204 Amazon CloudWatch User Guide "kms:Decrypt" ], "Resource": "arn:aws:kms:*:*:key/*", "Condition": { "StringLike": { "kms:ViaService": [ "s3.*.amazonaws.com" ] } } } ] } CloudWatchSyntheticsReadOnlyAccess The following is the content of the CloudWatchSyntheticsReadOnlyAccess policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "synthetics:Describe*", "synthetics:Get*", "synthetics:List*", "lambda:GetFunctionConfiguration" ], "Resource": "*" } ] } AWS managed (predefined) policies for Amazon CloudWatch RUM The AmazonCloudWatchRUMFullAccess and AmazonCloudWatchRUMReadOnlyAccess AWS managed policies are available for you to assign to users who will manage or use CloudWatch RUM. AmazonCloudWatchRUMFullAccess The following are the contents of the AmazonCloudWatchRUMFullAccess policy. AWS managed (predefined) policies for CloudWatch 3205 Amazon CloudWatch User Guide { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "rum:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:GetRole", "iam:CreateServiceLinkedRole" ], "Resource": [ "arn:aws:iam::*:role/aws-service-role/rum.amazonaws.com/ AWSServiceRoleForRealUserMonitoring" ] }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": [ "arn:aws:iam::*:role/RUM-Monitor*" ], "Condition": { "StringEquals": { "iam:PassedToService": [ "cognito-identity.amazonaws.com" ] } } }, { "Effect": "Allow", "Action":
acw-ug-885
acw-ug.pdf
885
CloudWatch RUM The AmazonCloudWatchRUMFullAccess and AmazonCloudWatchRUMReadOnlyAccess AWS managed policies are available for you to assign to users who will manage or use CloudWatch RUM. AmazonCloudWatchRUMFullAccess The following are the contents of the AmazonCloudWatchRUMFullAccess policy. AWS managed (predefined) policies for CloudWatch 3205 Amazon CloudWatch User Guide { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "rum:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:GetRole", "iam:CreateServiceLinkedRole" ], "Resource": [ "arn:aws:iam::*:role/aws-service-role/rum.amazonaws.com/ AWSServiceRoleForRealUserMonitoring" ] }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": [ "arn:aws:iam::*:role/RUM-Monitor*" ], "Condition": { "StringEquals": { "iam:PassedToService": [ "cognito-identity.amazonaws.com" ] } } }, { "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:GetMetricStatistics", "cloudwatch:ListMetrics" AWS managed (predefined) policies for CloudWatch 3206 User Guide Amazon CloudWatch ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": "arn:aws:cloudwatch:*:*:alarm:*" }, { "Effect": "Allow", "Action": [ "cognito-identity:CreateIdentityPool", "cognito-identity:ListIdentityPools", "cognito-identity:DescribeIdentityPool", "cognito-identity:GetIdentityPoolRoles", "cognito-identity:SetIdentityPoolRoles" ], "Resource": "arn:aws:cognito-identity:*:*:identitypool/*" }, { "Effect": "Allow", "Action": [ "logs:CreateLogGroup", "logs:DeleteLogGroup", "logs:PutRetentionPolicy", "logs:CreateLogStream" ], "Resource": "arn:aws:logs:*:*:log-group:*RUMService*" }, { "Effect": "Allow", "Action": [ "logs:CreateLogDelivery", "logs:GetLogDelivery", "logs:UpdateLogDelivery", "logs:DeleteLogDelivery", "logs:ListLogDeliveries", "logs:DescribeResourcePolicies" ], "Resource": "*" }, { AWS managed (predefined) policies for CloudWatch 3207 Amazon CloudWatch User Guide "Effect": "Allow", "Action": [ "logs:DescribeLogGroups" ], "Resource": "arn:aws:logs:*:*:log-group::log-stream:*" }, { "Effect": "Allow", "Action": [ "synthetics:describeCanaries", "synthetics:describeCanariesLastRun" ], "Resource": "arn:aws:synthetics:*:*:canary:*" } ] } AmazonCloudWatchRUMReadOnlyAccess The AmazonCloudWatchRUMReadOnlyAccess allows read-only administrative access to CloudWatch RUM. The following are the contents of the AmazonCloudWatchRUMReadOnlyAccess policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "rum:GetAppMonitor", "rum:GetAppMonitorData", "rum:ListAppMonitors", "rum:ListRumMetricsDestinations", "rum:BatchGetRumMetricDefinitions", "rum:GetResourcePolicy" ], "Resource": "*" } ] } AWS managed (predefined) policies for CloudWatch 3208 Amazon CloudWatch User Guide AmazonCloudWatchRUMServiceRolePolicy You can't attach AmazonCloudWatchRUMServiceRolePolicy to your IAM entities. This policy is attached to a service-linked role that allows CloudWatch RUM to publish monitoring data to other relevant AWS services. For more information about this service linked role, see Using service-linked roles for CloudWatch RUM. The complete contents of AmazonCloudWatchRUMServiceRolePolicy are as follows. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "xray:PutTraceSegments" ], "Resource": [ "*" ] }, { "Effect": "Allow", "Action": "cloudwatch:PutMetricData", "Resource": "*", "Condition": { "StringLike": { "cloudwatch:namespace": [ "RUM/CustomMetrics/*", "AWS/RUM" ] } } } ] } AWS managed (predefined) policies for CloudWatch Evidently The CloudWatchEvidentlyFullAccess and CloudWatchEvidentlyReadOnlyAccess AWS managed policies are available for you to assign to users who will manage or use CloudWatch Evidently. AWS managed (predefined) policies for CloudWatch 3209 Amazon CloudWatch CloudWatchEvidentlyFullAccess User Guide The following are the contents of the CloudWatchEvidentlyFullAccess policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "evidently:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:ListRoles" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:GetRole" ], "Resource": [ "arn:aws:iam::*:role/service-role/CloudWatchRUMEvidentlyRole-*" ] }, { "Effect": "Allow", "Action": [ "s3:GetBucketLocation", "s3:ListAllMyBuckets" ], "Resource": "arn:aws:s3:::*" }, { "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:GetMetricStatistics", "cloudwatch:DescribeAlarmHistory", AWS managed (predefined) policies for CloudWatch 3210 Amazon CloudWatch User Guide "cloudwatch:DescribeAlarmsForMetric", "cloudwatch:ListTagsForResource" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms", "cloudwatch:TagResource", "cloudwatch:UnTagResource" ], "Resource": [ "arn:aws:cloudwatch:*:*:alarm:*" ] }, { "Effect": "Allow", "Action": [ "cloudtrail:LookupEvents" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "cloudwatch:PutMetricAlarm" ], "Resource": [ "arn:aws:cloudwatch:*:*:alarm:Evidently-Alarm-*" ] }, { "Effect": "Allow", "Action": [ "sns:ListTopics" ], "Resource": [ "*" ] }, { "Effect": "Allow", "Action": [ AWS managed (predefined) policies for CloudWatch 3211 Amazon CloudWatch User Guide "sns:CreateTopic", "sns:Subscribe", "sns:ListSubscriptionsByTopic" ], "Resource": [ "arn:*:sns:*:*:Evidently-*" ] }, { "Effect": "Allow", "Action": [ "logs:DescribeLogGroups" ], "Resource": [ "*" ] } ] } CloudWatchEvidentlyReadOnlyAccess The following are the contents of the CloudWatchEvidentlyReadOnlyAccess policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "evidently:GetExperiment", "evidently:GetFeature", "evidently:GetLaunch", "evidently:GetProject", "evidently:GetSegment", "evidently:ListExperiments", "evidently:ListFeatures", "evidently:ListLaunches", "evidently:ListProjects", "evidently:ListSegments", "evidently:ListSegmentReferencs" ], "Resource": "*" } AWS managed (predefined) policies for CloudWatch 3212 Amazon CloudWatch ] } User Guide AWS managed policy for AWS Systems Manager Incident Manager The AWSCloudWatchAlarms_ActionSSMIncidentsServiceRolePolicy policy is attached to a service-linked role that allows CloudWatch to start incidents in AWS Systems Manager Incident Manager on your behalf. For more information, see Service-linked role permissions for CloudWatch alarms Systems Manager Incident Manager actions. The policy has the following permission: • ssm-incidents:StartIncident Customer managed policy examples In this section, you can find example user policies that grant permissions for various CloudWatch actions. These policies work when you are using the CloudWatch API, AWS SDKs, or the AWS CLI. Examples • Example 1: Allow user full access to CloudWatch • Example 2: Allow read-only access to CloudWatch • Example 3: Stop or terminate an Amazon EC2 instance Example 1: Allow user full access to CloudWatch To grant a user full access to CloudWatch, you can use grant them the CloudWatchFullAccess managed policy instead of creating a customer-managed policy. The contents of the CloudWatchFullAccess are listed in CloudWatchFullAccess. Example 2: Allow read-only access to CloudWatch The following policy allows a user read-only access to CloudWatch and view Amazon EC2 Auto Scaling actions, CloudWatch metrics, CloudWatch Logs data, and alarm-related Amazon SNS data.
acw-ug-886
acw-ug.pdf
886
Example 1: Allow user full access to CloudWatch • Example 2: Allow read-only access to CloudWatch • Example 3: Stop or terminate an Amazon EC2 instance Example 1: Allow user full access to CloudWatch To grant a user full access to CloudWatch, you can use grant them the CloudWatchFullAccess managed policy instead of creating a customer-managed policy. The contents of the CloudWatchFullAccess are listed in CloudWatchFullAccess. Example 2: Allow read-only access to CloudWatch The following policy allows a user read-only access to CloudWatch and view Amazon EC2 Auto Scaling actions, CloudWatch metrics, CloudWatch Logs data, and alarm-related Amazon SNS data. { "Version": "2012-10-17", "Statement": [ { Customer managed policy examples 3213 Amazon CloudWatch User Guide "Action": [ "autoscaling:Describe*", "cloudwatch:Describe*", "cloudwatch:Get*", "cloudwatch:List*", "logs:Get*", "logs:Describe*", "logs:StartQuery", "logs:StopQuery", "logs:TestMetricFilter", "logs:FilterLogEvents", "logs:StartLiveTail", "logs:StopLiveTail", "sns:Get*", "sns:List*" ], "Effect": "Allow", "Resource": "*" } ] } Example 3: Stop or terminate an Amazon EC2 instance The following policy allows an CloudWatch alarm action to stop or terminate an EC2 instance. In the sample below, the GetMetricData, ListMetrics, and DescribeAlarms actions are optional. It is recommended that you include these actions to ensure that you have correctly stopped or terminated the instance. { "Version": "2012-10-17", "Statement": [ { "Action": [ "cloudwatch:PutMetricAlarm", "cloudwatch:GetMetricData", "cloudwatch:ListMetrics", "cloudwatch:DescribeAlarms" ], "Resource": [ "*" ], "Effect": "Allow" Customer managed policy examples 3214 User Guide Amazon CloudWatch }, { "Action": [ "ec2:DescribeInstanceStatus", "ec2:DescribeInstances", "ec2:StopInstances", "ec2:TerminateInstances" ], "Resource": [ "*" ], "Effect": "Allow" } ] } CloudWatch updates to AWS managed policies View details about updates to AWS managed policies for CloudWatch since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the CloudWatch Document history page. Change Description Date AmazonCloudWatchRU MReadOnlyAccess – Updated policy CloudWatch added a permission to the AmazonCloudWatchRU MReadOnlyAccess policy. April 28, 2025 The rum:GetResourcePol icy permission was added so that CloudWatch RUM can view the resource policy attached to the RUM applicati on monitor. CloudWatch created a new policy named AIOpsCons oleAdminPolicy. December 3, 2024 AIOpsConsoleAdminPolicy – New policy Policy updates 3215 Amazon CloudWatch User Guide Change Description Date This policy grants users full administrative access for managing Amazon Q Developer operational investigations, including the management of trusted identity propagation, and the management of IAM Identity Center and organizational access. CloudWatch created a new policy named AIOpsOper atorAccess. This policy grants users access to Amazon Q Developer operational investigations actions, and to additiona l AWS actions that are necessary for accessing investigation events. CloudWatch created a new policy named AIOpsRead OnlyAccess. This policy grants a user read- only permissions for Amazon AI Operations and other related services. December 3, 2024 December 3, 2024 AIOpOperatorAccess – New policy AIOpsReadOnlyAccess – New policy Policy updates 3216 Amazon CloudWatch User Guide Change Description Date AIOpsAssistantPolicy – New policy CloudWatchFullAccessV2 – Updates to existing policies December 3, 2024 December 1, 2024 CloudWatch created a new policy named AIOpsAssi stantPolicy. You don't assign this policy to a user. You assign this policy to the Amazon AI Operations assistant to enable Amazon Q operational investigations to analyze your AWS resources during the investigation of operational events. CloudWatch updated both CloudWatchFullAccessV2 and CloudWatchFullAccess. Permissions for Amazon OpenSearch Service were added to to enable CloudWatch Logs integration with OpenSearch Service for some features. Policy updates 3217 Amazon CloudWatch User Guide Change Description Date CloudWatchNetworkF lowMonitorServiceRolePolicy – New policy December 1, 2024 CloudWatch added a new policy CloudWatchNetworkF lowMonitorServiceR olePolicy. The CloudWatchNetworkF lowMonitorServiceR olePolicy grants permissions for Network Flow Monitor to publish metrics to CloudWatc h. It also allows the service to use AWS Organizations to get information for multi-acc ount scenarios. CloudWatchNetworkF lowMonitorTopology ServiceRolePolicy – New policy CloudWatch added a new policy CloudWatchNetworkF lowMonitorTopology ServiceRolePolicy. December 1, 2024 The CloudWatchNetworkF lowMonitorTopology ServiceRolePolicy grants permissions for Network Flow Monitor to generate topology snapshots of resources used in your account. Policy updates 3218 Amazon CloudWatch User Guide Change Description Date CloudWatchNetworkF lowMonitorAgentPublishPolic y – New policy December 1, 2024 CloudWatch added a new policy CloudWatchNetworkF lowMonitorAgentPub lishPolicy. The CloudWatchNetworkF lowMonitorAgentPub lishPolicy grants permissio ns for resources, such as Amazon EC2 and Amazon EKS instances, to send telemetry reports (metrics) to a Network Flow Monitor endpoint. Policy updates 3219 Amazon CloudWatch User Guide Change Description Date CloudWatchSyntheticsFullAcc ess – Update to an existing policy CloudWatch updated the policy named CloudWatc hSyntheticsFullAccess. November 20, 2024 The following CloudWatc h Logs actions have been added to allow CloudWatc h Synthetics to get and use canary log data in Lambda log groups. The lambda:Ge tFunction permission has also been added to allow Synthetics to get information about a specific function. • logs:GetLogRecord – Required to expand a log entry in CloudWatch Logs Insights. (Required to view logs in the Synthetics console.) • logs:DescribeLogSt reams – Required to list all log streams on a log
acw-ug-887
acw-ug.pdf
887
User Guide Change Description Date CloudWatchSyntheticsFullAcc ess – Update to an existing policy CloudWatch updated the policy named CloudWatc hSyntheticsFullAccess. November 20, 2024 The following CloudWatc h Logs actions have been added to allow CloudWatc h Synthetics to get and use canary log data in Lambda log groups. The lambda:Ge tFunction permission has also been added to allow Synthetics to get information about a specific function. • logs:GetLogRecord – Required to expand a log entry in CloudWatch Logs Insights. (Required to view logs in the Synthetics console.) • logs:DescribeLogSt reams – Required to list all log streams on a log group. • logs:StartQuery – Required to start a Logs Insights query (required in the Synthetics console to view logs). • logs:GetLogEvents – Required to list log events from the specified log stream. Used for querying Policy updates 3220 Amazon CloudWatch User Guide Change Description Date a specific log stream on a log group. • logs:FilterLogEven ts – Required to view logs in a canary’s log group. • logs:GetLogGroupFi elds – Required for running a Logs Insights query in the console. (The Synthetics console links to the Logs Insights query. Without this permission, Logs Insights queries on a log group fail.) Additionally, Lambda layer version actions now apply to all CloudWatch Synthetics layer ARNs. Policy updates 3221 Amazon CloudWatch User Guide Change Description Date November 14, 2024 CloudWatchInternet MonitorReadOnlyAccess – New CloudWatchInternet MonitorReadOnlyAccess. This policy grants read only access to resources and actions available in the CloudWatch console for Internet Monitor. The scope of this policy includes internetmonitor: so that users can use read-only Internet Monitor actions and resources. It includes some cloudwatch: policies to retrieve information on CloudWatch metrics. It includes some logs: policies to manage log queries. Policy updates 3222 Amazon CloudWatch User Guide Change Description Date CloudWatchInternet MonitorFullAccess – New policy CloudWatch created a new policy named CloudWatc hInternetMonitorFullAccess. October 23, 2024 This policy grants full access to resources and actions available in the CloudWatch console for Internet Monitor. The scope of this polic y includes internetm onitor: so that users can use Internet Monitor actions and resources. It includes some cloudwatch: policies to retrieve informati on on CloudWatch alarms and metrics. It includes some logs: policies to manage log queries. It includes some ec2:, cloudfront: , elasticloadbalanci ng: , and workspace s: policies to work with resources that you add to monitors so that Internet Monitor can create a traffic profile for your application. It contains some iam: policies to manage IAM roles. Policy updates 3223 Amazon CloudWatch User Guide Change Description Date October 16, 2024 CloudWatchLambdaAp plicationSignalsExecutionRo lePolicy – New CloudWatc hLambdaApplication SignalsExecutionRolePolicy. This policy is used when CloudWatch Application Signals is enabled for Lambda workloads. It enables write access to X-Ray and the log group used by CloudWatch Application Signals. CloudWatchSyntheticsFullAcc ess – Update to an existing p olicy CloudWatch updated the policy named CloudWatc hSyntheticsFullAccess. October 11, 2024 The lambda:ListTags , , lambda:TagResource and lambda:UntagResour ce permissions were added so that when you apply or change tags on a canary, you can choose to have Synthetic s also apply those same tags or changes to the Lambda function that the canary uses. Policy updates 3224 Amazon CloudWatch User Guide Change Description Date CloudWatchApplicationSignal sReadOnlyAccess – New policy June 7, 2024 CloudWatch created a new policy named CloudWatc hApplicationSignal sReadOnlyAccess. This policy grants read only access to resources and actions available in the CloudWatch console for Application Signals. The scope of this policy includes application-signal s: policies so that users can use read only actions and resources available in the CloudWatch console under Application Signals. It contains an iam: policy to manage IAM roles. It includes some logs: policies to manage log queries and filters. It includes cloudwatc h: policies to retrieve i nformation on CloudWatc h alarms and metrics. It includes some synthetic s: policies to retrive information about synthetics canaries. It includes rum: policies to manage RUM clients and jobs. It contains an xray: policy to obtain trace summaries. Policy updates 3225 Amazon CloudWatch User Guide Change Description Date CloudWatchApplicationSignal sFullAccess – New policy June 7, 2024 CloudWatch created a new policy named CloudWatc hApplicationSignalsFullAcce ss. This policy grants full access to resources and actions available in the CloudWatc h console for Application Signals. The scope of this policy includes applicati on-signals: so that users can use Application Signals actions and resources. It includes some cloudwatc h: policies to retrieve information on CloudWa tch alarms and metrics. It includes some logs: policies to manage log queries. It includes some synthetic s: policies to write and retrieve information about synthetics canaries. It includes rum: policies to manage RUM clients and jobs. It contains an xray: policy to obtain trace summaries. It includes s ome cloudwatch: policies to manage CloudWatch alarms. It contains some iam:
acw-ug-888
acw-ug.pdf
888
and actions available in the CloudWatc h console for Application Signals. The scope of this policy includes applicati on-signals: so that users can use Application Signals actions and resources. It includes some cloudwatc h: policies to retrieve information on CloudWa tch alarms and metrics. It includes some logs: policies to manage log queries. It includes some synthetic s: policies to write and retrieve information about synthetics canaries. It includes rum: policies to manage RUM clients and jobs. It contains an xray: policy to obtain trace summaries. It includes s ome cloudwatch: policies to manage CloudWatch alarms. It contains some iam: policies to manage IAM roles. It includes some sns: policies to manage Amazon Simple Policy updates 3226 Amazon CloudWatch User Guide Change Description Date CloudWatchFullAccessV2 – Update to an existing policy May 20, 2024 Notification Service notificat ions. CloudWatch updated the policy named CloudWatc hFullAccessV2. The scope of the CloudWatc hFullAccessPermiss ions policy was updated to add application- signals:* so that users can use CloudWatch Applicati on Signals to view, investiga te, and diagnose issues with the health of their services. Policy updates 3227 Amazon CloudWatch User Guide Change Description Date CloudWatchReadOnlyAccess – Update to an existing policy CloudWatch updated the policy named CloudWatc hReadOnlyAccess. May 20, 2024 The scope of the CloudWatc hReadOnlyAccessPer missions policy was updated to add applicati on-signals:BatchGe t* , application- signals:List* , and application-signal s:Get* so that users can use CloudWatch Applicat ion Signals to view, investiga te, and diagnose issues with the health of their services. The scope of CloudWatc hReadOnlyGetRolePe rmissions was updated to add the iam:GetRole action so that users can check if CloudWatch Application Signals is set up. Policy updates 3228 Amazon CloudWatch User Guide Change Description Date CloudWatchApplicationSignal sServiceRolePolicy – Update to an existing policy CloudWatchApplicationSignal sServiceRolePolicy – Update to an existing policy April 18, 2024 April 08, 2024 CloudWatch updated the policy named CloudWatc hApplicationSignalsServiceR olePolicy. The scoping of the logs:StartQuery and logs:GetQueryResul ts permissions was changed to add the arn:aws:l ogs:*:*:log-group: /aws/appsignals/*:* and arn:aws:logs:*:*:l og-group:/aws/appl ication-signals/ data:* ARNs to enable Application Signals on more architectures. CloudWatch changed the scope of a permission in CloudWatchApplicat ionSignalsServiceRolePolicy. The scope of the cloudwatc h:GetMetricData permission was changed to * so that Application Signals can retrieve metrics from sources in linked accounts. Policy updates 3229 Amazon CloudWatch User Guide Change Description Date CloudWatchAgentSer verPolicy – Update to an existing policy CloudWatch added permissio ns to CloudWatchAgentSer verPolicy. February 12, 2024 The xray:PutTraceSegme nts , xray:PutT , elemetryRecords xray:GetSamplingRu les , xray:GetS amplingTargets , xray:GetSamplingSt and atisticSummaries logs:PutRetentionP olicy permissions were added so that the CloudWatc h agent can publish X-Ray traces and modify log group retention periods. Policy updates 3230 Amazon CloudWatch User Guide Change Description Date CloudWatchAgentAdm inPolicy – Update to an existing policy CloudWatch added permissio ns to CloudWatchAgentAdm inPolicy. February 12, 2024 The xray:PutTraceSegme nts , xray:PutT , elemetryRecords xray:GetSamplingRu les , xray:GetS amplingTargets , xray:GetSamplingSt and atisticSummaries logs:PutRetentionP olicy permissions were added so that the CloudWatc h agent can publish X-Ray traces and modify log group retention periods. Policy updates 3231 Amazon CloudWatch User Guide Change Description Date CloudWatchFullAccessV2 – Update to an existing policy December 5, 2023 CloudWatch added permissio ns to CloudWatchFullAcce ssV2. Existing permissions for CloudWatch Synthetics, X- Ray, and CloudWatch RUM actions and new permissio ns for CloudWatch Applicati on Signals were added so that users with this policy can manage CloudWatch Applicati on Signals. The permission to create the CloudWatch Applicati on Signals service-linked role was added to allow CloudWatch Application Signals to discover telemetry data in logs, metrics, traces, and tags. Policy updates 3232 Amazon CloudWatch User Guide Change Description Date CloudWatchReadOnlyAccess – Update to an existing policy December 5, 2023 CloudWatch added permissio ns to CloudWatchReadOnly Access. Existing read-only permissio ns for CloudWatch Synthetics, X-Ray, and CloudWatch RUM actions and new read-only permissions for CloudWatc h Application Signals were added so that users with this policy can triage and dignos e their service health issues as reported by CloudWatch Application Signals. The cloudwatch:Generat eQuery permission was added so that users with this policy can generate a CloudWatch Metrics Insights query string from a natural language prompt. CloudWatchReadOnlyAccess – Update to an existing policy. CloudWatch added a permission to CloudWatc hReadOnlyAccess. December 01, 2023 The cloudwatch:Generat eQuery permission was added, so that users with this policy can generate a CloudWatch Metrics Insights query string from a natural la nguage prompt. Policy updates 3233 Amazon CloudWatch User Guide Change Description Date CloudWatchApplicationSignal sServiceRolePolicy – New policy CloudWatch added a new policy CloudWatchApplicat ionSignalsServiceRolePolicy. November 9, 2023 The CloudWatchApplicat ionSignalsServiceRolePolicy grants an upcoming feature permissions to collect CloudWatch Logs data, X- Ray trace data, CloudWatc h metrics data, and tagging data. AWSServiceRoleForC loudWatchMetrics_DbPerfInsi ghtsServiceRolePolicy – New CloudWatch added a new policy AWSServiceRoleForC loudWatchMetrics_D September
acw-ug-889
acw-ug.pdf
889
existing policy. CloudWatch added a permission to CloudWatc hReadOnlyAccess. December 01, 2023 The cloudwatch:Generat eQuery permission was added, so that users with this policy can generate a CloudWatch Metrics Insights query string from a natural la nguage prompt. Policy updates 3233 Amazon CloudWatch User Guide Change Description Date CloudWatchApplicationSignal sServiceRolePolicy – New policy CloudWatch added a new policy CloudWatchApplicat ionSignalsServiceRolePolicy. November 9, 2023 The CloudWatchApplicat ionSignalsServiceRolePolicy grants an upcoming feature permissions to collect CloudWatch Logs data, X- Ray trace data, CloudWatc h metrics data, and tagging data. AWSServiceRoleForC loudWatchMetrics_DbPerfInsi ghtsServiceRolePolicy – New CloudWatch added a new policy AWSServiceRoleForC loudWatchMetrics_D September 20, 2023 policy bPerfInsightsServiceRolePol icy. The AWSServiceRoleForC loudWatchMetrics_D bPerfInsightsServiceRolePol icy grants permission to CloudWatch to fetch Performance Insights metrics from databases on your behalf. Policy updates 3234 Amazon CloudWatch User Guide Change Description Date CloudWatchReadOnlyAccess – Update to an existing policy CloudWatch added a permission to CloudWatc hReadOnlyAccess. September 14, 2023 CloudWatchFullAccessV2 – New policy August 1, 2023 The application-autosc aling:DescribeScal ingPolicies permissio n was added so that users with this policy can access inf ormation about Application Auto Scaling policies. CloudWatch added a new policy CloudWatchFullAcce ssV2. The CloudWatchFullAcce ssV2 grants full access to CloudWatch actions and resources while better scoping the permissions granted to other services such as Amazon SNS and Amazon EC2 Auto Scaling. For more information, see CloudWatc hFullAccessV2. Policy updates 3235 Amazon CloudWatch User Guide Change Description Date AWSServiceRoleForI nternetMonitor – Update to an existing policy CloudWatchReadOnlyAccess – Update to an existing policy July 15, 2023 June 6, 2023 Amazon CloudWatch Internet Monitor added new permissio ns to monitor Network Load Balancer resources. The elasticloadbalanci ng:DescribeLoadBal ancers and ec2:Descr ibeNetworkInterfac es permissions are required so that Internet Monitor can monitor customers' Network Load Balancer traffic by analyzing flow logs for NLB resources. For more information, see Using Internet Monitor. CloudWatch added permissio ns to CloudWatchReadOnly Access. The logs:StartLiveTail and logs:Stop LiveTail permissions were added so that users with this policy can use the console to start and stop CloudWatc h Logs live tail sessions. For more information, see Use live tail to view logs in near real time. Policy updates 3236 Amazon CloudWatch User Guide Change Description Date CloudWatchCrossAcc ountSharingConfiguration – CloudWatch added a new policy to enable you to November 27, 2022 New policy OAMFullAccess – New policy manage CloudWatch cross- account observability links that share CloudWatch metrics. For more information, see CloudWatch cross-account observability. CloudWatch added a new policy to enable you to fully manage CloudWatch cross-ac count observability links and sinks. For more information, see CloudWatch cross-account observability. November 27, 2022 OAMReadOnlyAccess – New policy CloudWatch added a new policy to enable you to November 27, 2022 view information about CloudWatch cross-account observability links and sinks. For more information, see CloudWatch cross-account observability. Policy updates 3237 Amazon CloudWatch User Guide Change Description Date CloudWatchFullAccess – Update to an existing policy CloudWatch added permissio ns to CloudWatchFullAccess. November 27, 2022 CloudWatchReadOnlyAccess – Update to an existing policy The oam:ListSinks and oam:ListAttachedLi nks permissions were added so that users with this policy can use the console to view data shared from source accounts in CloudWatch cross-account observability. CloudWatch added permissio ns to CloudWatchReadOnly Access. The oam:ListSinks and oam:ListAttachedLi nks permissions were added so that users with this policy can use the console to view data shared from source accounts in CloudWatch cross-account observability. November 27, 2022 Policy updates 3238 Amazon CloudWatch User Guide Change Description Date AmazonCloudWatchRU MServiceRolePolicy – Update to an existing policy February 2, 2023 CloudWatch RUM updated a condition key in AmazonClo udWatchRUMServiceR olePolicy. The "Condition": { "StringEquals": { "cloudwatch:namesp ace": "AWS/ RUM" } } condition key was changed to the following so that CloudWatch RUM can send custom metrics to custom metric namespaces. "Condition": { "StringLike": { "cloudwatch:na mespace": [ "RUM/CustomMetrics/ *", "AWS/RUM" ] } } Policy updates 3239 Amazon CloudWatch User Guide Change Description Date AmazonCloudWatchRU MReadOnlyAccess – Updated policy AmazonCloudWatchRU MServiceRolePolicy – Update to an existing policy October 27, 2022 October 26, 2022 CloudWatch added permissio ns the AmazonClo udWatchRUMReadOnly Access policy. The rum:ListRumMetrics Destinations rum:BatchGetRumMet and ricsDefinitions permissions were added so that CloudWatch RUM can send extended metrics to CloudWatch and Evidently. CloudWatch RUM added permissions to AmazonClo udWatchRUMServiceR olePolicy. The cloudwatch:PutMetr icData permission was added so that CloudWatc h RUM can send extended metrics to CloudWatch. Policy updates 3240 Amazon CloudWatch User Guide Change Description Date CloudWatchEvidentl yReadOnlyAccess – Update to an existing policy CloudWatch Evidently added permissions to CloudWatc hEvidentlyReadOnlyAccess. August 12, 2022 The evidently:GetSegme nt , evidently :ListSegments evidently:ListSegm , and entReferences ns were added so that users permissio with this policy can see Evidently audience segments that have been created. CloudWatchSyntheticsFullAcc ess – Update to an existing policy CloudWatch Synthetics added permissions to CloudWatc hSyntheticsFullAccess. May 6, 2022 The lambda:DeleteFunct ion and lambda:De
acw-ug-890
acw-ug.pdf
890
AmazonClo udWatchRUMServiceR olePolicy. The cloudwatch:PutMetr icData permission was added so that CloudWatc h RUM can send extended metrics to CloudWatch. Policy updates 3240 Amazon CloudWatch User Guide Change Description Date CloudWatchEvidentl yReadOnlyAccess – Update to an existing policy CloudWatch Evidently added permissions to CloudWatc hEvidentlyReadOnlyAccess. August 12, 2022 The evidently:GetSegme nt , evidently :ListSegments evidently:ListSegm , and entReferences ns were added so that users permissio with this policy can see Evidently audience segments that have been created. CloudWatchSyntheticsFullAcc ess – Update to an existing policy CloudWatch Synthetics added permissions to CloudWatc hSyntheticsFullAccess. May 6, 2022 The lambda:DeleteFunct ion and lambda:De leteLayerVersion permissions were added so that CloudWatch Synthetics can delete related resources when a canary is deleted. The iam:ListAttachedRo was added lePolicies so that customers can view the policies that are attached to a canary's IAM role. Policy updates 3241 Amazon CloudWatch User Guide Change Description Date AmazonCloudWatchRU MFullAccess – New policy CloudWatch added a new policy to enable full November 29, 2021 management of CloudWatch RUM. CloudWatch RUM allows you to perform real user monitoring of your web application. For more information, see CloudWatch RUM. AmazonCloudWatchRU MReadOnlyAccess – New policy CloudWatch added a new policy to enable read-only access to CloudWatch RUM. November 29, 2021 CloudWatch RUM allows you to perform real user monitoring of your web application. For more information, see CloudWatch RUM. CloudWatchEvidentlyFullAcce ss – New policy CloudWatch added a new policy to enable full November 29, 2021 management of CloudWatch Evidently. CloudWatch Evidently allows you to perform A/B experiments of your web applications, and to roll them out gradually. For more information, see Perform launches and A/B experimen ts with CloudWatch Evidently. Policy updates 3242 Amazon CloudWatch User Guide Change Description Date CloudWatchEvidentl yReadOnlyAccess – New policy AWSServiceRoleForC loudWatchRUM – New managed policy November 29, 2021 November 29, 2021 CloudWatch added a new policy to enable read-only access to CloudWatch Evidently. CloudWatch Evidently allows you to perform A/B experiments of your web applications, and to roll them out gradually. For more information, see Perform launches and A/B experimen ts with CloudWatch Evidently. CloudWatch added a policy for a new service-linked role to allow CloudWatch RUM to pubish monitoring data to other relevant AWS services. Policy updates 3243 Amazon CloudWatch User Guide Change Description Date CloudWatchSyntheticsFullAcc ess – Update to an existing policy September 29, 2021 CloudWatch Synthetics added permissions to CloudWatc hSyntheticsFullAccess, and also changed the scope of one permission. The kms:ListAliases permission was added so that users can list available AWS KMS keys that can be used to encrypt canary artifacts. The kms:Descr ibeKey permission was added so that users can see the details of keys that will be used to encrypt for canary artifacts. And the kms:Decrypt permission was added to enable users to decrypt canary artifacts. This decryption ability is limited to use on resources within Amazon S3 buckets. The Resource scope of the s3:GetBucketLocati on permission was changed from * to arn:aws:s 3:::* . Policy updates 3244 Amazon CloudWatch User Guide Change Description Date CloudWatchSyntheticsFullAcc ess – Update to an existing policy CloudWatch Synthetics added a permission to CloudWatc hSyntheticsFullAccess. July 20, 2021 The lambda:UpdateFunct ionCode permission was added so that users with this policy can change the runtime version of canaries. AWSCloudWatchAlar ms_ActionSSMIncidentsServic eRolePolicy – New managed CloudWatch added a new managed IAM policy to allow CloudWatch to create May 10, 2021 policy CloudWatchAutomati cDashboardsAccess – Update to an existing policy CloudWatch started tracking changes incidents in AWS Systems Manager Incident Manager. CloudWatch added a permission to the CloudWatc hAutomaticDashboar dsAccess managed policy. The synthetics:Describ eCanariesLastRun permission was added to this policy to enable cross-acc ount dashboard users to see details about CloudWatch Synthetics canary runs. CloudWatch started tracking changes for its AWS managed policies. April 20, 2021 April 14, 2021 Policy updates 3245 Amazon CloudWatch User Guide Using condition keys to limit access to CloudWatch namespaces Use IAM condition keys to limit users to publishing metrics only in the CloudWatch namespaces that you specify. This section provides examples that describe how to allow and exclude users from publishing metrics in a namespace. Allowing publishing in one namespace only The following policy limits the user to publishing metrics only in the namespace named MyCustomNamespace. { "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Resource": "*", "Action": "cloudwatch:PutMetricData", "Condition": { "StringEquals": { "cloudwatch:namespace": "MyCustomNamespace" } } } } Excluding publishing from a namespace The following policy allows the user to publish metrics in any namespace except for CustomNamespace2. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Resource": "*", "Action": "cloudwatch:PutMetricData" }, { "Effect": "Deny", "Resource": "*", Using condition keys to limit access to CloudWatch namespaces 3246 Amazon CloudWatch User Guide "Action": "cloudwatch:PutMetricData", "Condition": { "StringEquals": { "cloudwatch:namespace": "CustomNamespace2" } } } ] } Using condition keys to limit Contributor Insights users' access to log
acw-ug-891
acw-ug.pdf
891
namespace named MyCustomNamespace. { "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Resource": "*", "Action": "cloudwatch:PutMetricData", "Condition": { "StringEquals": { "cloudwatch:namespace": "MyCustomNamespace" } } } } Excluding publishing from a namespace The following policy allows the user to publish metrics in any namespace except for CustomNamespace2. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Resource": "*", "Action": "cloudwatch:PutMetricData" }, { "Effect": "Deny", "Resource": "*", Using condition keys to limit access to CloudWatch namespaces 3246 Amazon CloudWatch User Guide "Action": "cloudwatch:PutMetricData", "Condition": { "StringEquals": { "cloudwatch:namespace": "CustomNamespace2" } } } ] } Using condition keys to limit Contributor Insights users' access to log groups To create a rule in Contributor Insights and see its results, a user must have the cloudwatch:PutInsightRule permission. By default, a user with this permission can create a Contributor Insights rule that evaluates any log group in CloudWatch Logs and then see the results. The results can contain contributor data for those log groups. You can create IAM policies with condition keys to grant users the permission to write Contributor Insights rules for some log groups while preventing them from writing rules for and seeing this data from other log groups. For more information about the Condition element in IAM policies, see IAM JSON policy elements: Condition. Allow access to write rules and view results for only certain log groups The following policy allows the user access to write rules and view results for the log group named AllowedLogGroup and all log groups that have names that start with AllowedWildCard. It does not grant access to write rules or view rule results for any other log groups. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowCertainLogGroups", "Effect": "Allow", "Action": "cloudwatch:PutInsightRule", "Resource": "arn:aws:cloudwatch:*:*:insight-rule/*", "Condition": { Using condition keys to limit Contributor Insights users' access to log groups 3247 Amazon CloudWatch User Guide "ForAllValues:StringEqualsIgnoreCase": { "cloudwatch:requestInsightRuleLogGroups": [ "AllowedLogGroup", "AllowedWildcard*" ] } } } ] } Deny writing rules for specific log groups but allow writing rules for all other log groups The following policy explicitly denies the user access to write rules and view rule results for the log group named ExplicitlyDeniedLogGroup, but allows writing rules and viewing rule results for all other log groups. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowInsightRulesOnLogGroupsByDefault", "Effect": "Allow", "Action": "cloudwatch:PutInsightRule", "Resource": "arn:aws:cloudwatch:*:*:insight-rule/*" }, { "Sid": "ExplicitDenySomeLogGroups", "Effect": "Deny", "Action": "cloudwatch:PutInsightRule", "Resource": "arn:aws:cloudwatch:*:*:insight-rule/*", "Condition": { "ForAllValues:StringEqualsIgnoreCase": { "cloudwatch:requestInsightRuleLogGroups": [ "/test/alpine/ExplicitlyDeniedLogGroup" ] } } } ] } Using condition keys to limit Contributor Insights users' access to log groups 3248 Amazon CloudWatch User Guide Using condition keys to limit alarm actions When CloudWatch alarms change state, they can perform different actions such as stopping and terminating EC2 instances and performing Systems Manager actions. These actions can be initiated when the alarm changes to any state, including ALARM, OK, or INSUFFICIENT_DATA. Use the cloudwatch:AlarmActions condition key to allow a user to create alarms that can only perform the actions you specify when the alarm state changes. For example, you can allow a user to create alarms that can only perform actions which are not EC2 actions. Allow a user to create alarms that can only send Amazon SNS notifications or perform Systems Manager actions The following policy limits the user to creating alarms that can only send Amazon SNS notifications and perform Systems Manager actions. The user can't create alarms that perform EC2 actions. { "Version": "2012-10-17", "Statement": [ { "Sid": "CreateAlarmsThatCanPerformOnlySNSandSSMActions", "Effect": "Allow", "Action": "cloudwatch:PutMetricAlarm", "Resource": "*", "Condition": { "ForAllValues:StringLike": { "cloudwatch:AlarmActions": [ "arn:aws:sns:*", "arn:aws:ssm:*" ] } } } ] } Using service-linked roles for CloudWatch Amazon CloudWatch uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to CloudWatch. Service-linked Using condition keys to limit alarm actions 3249 Amazon CloudWatch User Guide roles are predefined by CloudWatch and include all the permissions that the service requires to call other AWS services on your behalf. One service-linked role in CloudWatch makes setting up CloudWatch alarms that can terminate, stop, or reboot an Amazon EC2 instance without requiring you to manually add the necessary permissions. Another service-linked role enables a monitoring account to access CloudWatch data from other accounts that you specify, to build cross-account cross-Region dashboards. CloudWatch defines the permissions of these service-linked roles, and unless defined otherwise, only CloudWatch can assume the role. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete the roles only after first deleting their related resources. This restriction protects your CloudWatch resources because you can't inadvertently remove permissions to access the resources. 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 Role column.
acw-ug-892
acw-ug.pdf
892
cross-Region dashboards. CloudWatch defines the permissions of these service-linked roles, and unless defined otherwise, only CloudWatch can assume the role. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete the roles only after first deleting their related resources. This restriction protects your CloudWatch resources because you can't inadvertently remove permissions to access the resources. 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 Role column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for CloudWatch alarms EC2 actions CloudWatch uses the service-linked role named AWSServiceRoleForCloudWatchEvents – CloudWatch uses this service-linked role to perform Amazon EC2 alarm actions. The AWSServiceRoleForCloudWatchEvents service-linked role trusts the CloudWatch Events service to assume the role. CloudWatch Events invokes the terminate, stop, or reboot instance actions when called upon by the alarm. The AWSServiceRoleForCloudWatchEvents service-linked role permissions policy allows CloudWatch Events to complete the following actions on Amazon EC2 instances: • ec2:StopInstances • ec2:TerminateInstances • ec2:RecoverInstances • ec2:DescribeInstanceRecoveryAttribute • ec2:DescribeInstances • ec2:DescribeInstanceStatus Using service-linked roles 3250 Amazon CloudWatch User Guide The AWSServiceRoleForCloudWatchCrossAccount service-linked role permissions policy allows CloudWatch to complete the following actions: • sts:AssumeRole Service-linked role permissions for CloudWatch telemetry config CloudWatch observability admin creates and uses a service-linked role named AWSServiceRoleForObservabilityAdmin – CloudWatch uses this service-linked role to support resource and telemetry config discovery for AWS Organizations. The role is created in all member accounts of the Organization. The AWSServiceRoleForObservabilityAdmin service-linked role trusts Observability Admin to assume the role. Observability Admin manages AWS Config Service Linked Configuration Recorders and Service Linked Configuration Aggregator in your Organizations accounts. The AWSServiceRoleForObservabilityAdmin service-linked role has a policy, called AWSObservabilityAdminServiceRolePolicy, attached and this policy grants permission to CloudWatch Observability Admin to complete the following actions: • organizations:ListAccounts • organizations:ListAccountsForParent • organizations:ListChildren • organizations:ListParents • organizations:DescribeOrganization • organizations:DescribeOrganizationalUnit • organizations:EnableAWSServiceAccess • organizations:ListDelegatedAdministrators • config:PutServiceLinkedConfigurationRecorder • config:DeleteServiceLinkedConfigurationRecorder • config:PutConfigurationAggregator • config:DeleteConfigurationAggregator • config:SelectAggregateResourceConfig • iam:CreateServiceLinkedRole • iam:PassRole Using service-linked roles 3251 Amazon CloudWatch User Guide The complete contents of the AWSObservabilityAdminServiceRolePolicy policy are as follows: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "organizations:ListAccounts", "organizations:ListAccountsForParent", "organizations:ListChildren", "organizations:ListParents", "organizations:DescribeOrganization", "organizations:DescribeOrganizationalUnit" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "config:PutServiceLinkedConfigurationRecorder", "config:DeleteServiceLinkedConfigurationRecorder" ], "Resource": [ "arn:aws:config:*:*:configuration-recorder/ AWSConfigurationRecorderForObservabilityAdmin/*" ] }, { "Effect": "Allow", "Action": [ "config:PutConfigurationAggregator", "config:DeleteConfigurationAggregator", "config:SelectAggregateResourceConfig" ], "Resource": [ "arn:aws:config:*:*:config-aggregator/aws-service-config-aggregator/ observabilityadmin.amazonaws.com/*" ] }, { "Effect": "Allow", "Action": [ Using service-linked roles 3252 Amazon CloudWatch User Guide "iam:CreateServiceLinkedRole" ], "Resource": [ "arn:aws:iam::*:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig" ], "Condition": { "StringEquals": { "iam:AWSServiceName": [ "config.amazonaws.com" ] } } }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": [ "arn:aws:iam::*:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig" ], "Condition": { "StringEquals": { "iam:PassedToService": [ "config.amazonaws.com" ] } } }, { "Effect": "Allow", "Action": [ "organizations:EnableAWSServiceAccess" ], "Resource": "*", "Condition": { "StringEquals": { "organizations:ServicePrincipal": [ "config.amazonaws.com" ] } } }, { Using service-linked roles 3253 User Guide Amazon CloudWatch "Effect": "Allow", "Action": [ "organizations:ListDelegatedAdministrators" ], "Resource": "*", "Condition": { "StringEquals": { "organizations:ServicePrincipal": [ "observabilityadmin.amazonaws.com", "config.amazonaws.com" ] } } } ] } Service-linked role permissions for CloudWatch Application Signals CloudWatch Application Signals uses the service-linked role named AWSServiceRoleForCloudWatchApplicationSignals – CloudWatch uses this service-linked role to collect CloudWatch Logs data, X-Ray trace data, CloudWatch metrics data, and tagging data from applications that you have enabled for CloudWatch Application Signals. The AWSServiceRoleForCloudWatchApplicationSignals service-linked role trusts CloudWatch Application Signals to assume the role. Application Signals collects the logs, traces, metrics, and tags data from your account. The AWSServiceRoleForCloudWatchApplicationSignals has an IAM policy attached, and this policy is named CloudWatchApplicationSignalsServiceRolePolicy. This policy grants permission to CloudWatch Application Signals to collect monitoring and tagging data from other relevant AWS services. It includes permissions for Application Signals to complete the following actions: • xray – Retrieve X-Ray traces. • logs – Retrieve the current CloudWatch logs information. • cloudwatch – Retrieve the current CloudWatch metric information. • tags – Retrieve the current tags. • application-signals – Retrieve information on SLOs and their associated time exclusion windows. Using service-linked roles 3254 Amazon CloudWatch User Guide • autoscaling – Retrieve application tags from Amazon EC2 Autoscaling group. The complete contents of CloudWatchApplicationSignalsServiceRolePolicy are as follows: { "Version": "2012-10-17", "Statement": [ { "Sid": "XRayPermission", "Effect": "Allow", "Action": [ "xray:GetServiceGraph" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CWLogsPermission", "Effect": "Allow", "Action": [ "logs:StartQuery", "logs:GetQueryResults" ], "Resource": [ "arn:aws:logs:*:*:log-group:/aws/appsignals/*:*", "arn:aws:logs:*:*:log-group:/aws/application-signals/data:*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CWListMetricsPermission", "Effect": "Allow", "Action": [ Using service-linked roles 3255 User Guide Amazon CloudWatch "cloudwatch:ListMetrics" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CWGetMetricDataPermission", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData" ], "Resource": [ "*"
acw-ug-893
acw-ug.pdf
893
complete contents of CloudWatchApplicationSignalsServiceRolePolicy are as follows: { "Version": "2012-10-17", "Statement": [ { "Sid": "XRayPermission", "Effect": "Allow", "Action": [ "xray:GetServiceGraph" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CWLogsPermission", "Effect": "Allow", "Action": [ "logs:StartQuery", "logs:GetQueryResults" ], "Resource": [ "arn:aws:logs:*:*:log-group:/aws/appsignals/*:*", "arn:aws:logs:*:*:log-group:/aws/application-signals/data:*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CWListMetricsPermission", "Effect": "Allow", "Action": [ Using service-linked roles 3255 User Guide Amazon CloudWatch "cloudwatch:ListMetrics" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "CWGetMetricDataPermission", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData" ], "Resource": [ "*" ] }, { "Sid": "TagsPermission", "Effect": "Allow", "Action": [ "tag:GetResources" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "ApplicationSignalsPermission", "Effect": "Allow", "Action": [ "application-signals:ListServiceLevelObjectiveExclusionWindows", "application-signals:GetServiceLevelObjective" ], "Resource": [ Using service-linked roles 3256 User Guide Amazon CloudWatch "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "EC2AutoScalingPermission", "Effect": "Allow", "Action": [ "autoscaling:DescribeAutoScalingGroups" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } } ] } Service-linked role permissions for CloudWatch alarms Systems Manager OpsCenter actions CloudWatch uses the service-linked role named AWSServiceRoleForCloudWatchAlarms_ActionSSM – CloudWatch uses this service-linked role to perform Systems Manager OpsCenter actions when a CloudWatch alarm goes into ALARM state. The AWSServiceRoleForCloudWatchAlarms_ActionSSM service-linked role trusts the CloudWatch service to assume the role. CloudWatch alarms invoke the Systems Manager OpsCenter actions when called upon by the alarm. The AWSServiceRoleForCloudWatchAlarms_ActionSSM service-linked role permissions policy allows Systems Manager to complete the following actions: • ssm:CreateOpsItem Using service-linked roles 3257 Amazon CloudWatch User Guide Service-linked role permissions for CloudWatch alarms Systems Manager Incident Manager actions CloudWatch uses the service-linked role named AWSServiceRoleForCloudWatchAlarms_ActionSSMIncidents – CloudWatch uses this service- linked role to start Incident Manager incidents when a CloudWatch alarm goes into ALARM state. The AWSServiceRoleForCloudWatchAlarms_ActionSSMIncidents service-linked role trusts the CloudWatch service to assume the role. CloudWatch alarms invoke the Systems Manager Incident Manager action when called upon by the alarm. The AWSServiceRoleForCloudWatchAlarms_ActionSSMIncidents service-linked role permissions policy allows Systems Manager to complete the following actions: • ssm-incidents:StartIncident Service-linked role permissions for CloudWatch cross-account cross-Region CloudWatch uses the service-linked role named AWSServiceRoleForCloudWatchCrossAccount – CloudWatch uses this role to access CloudWatch data in other AWS accounts that you specify. The SLR only provides the assume role permission to allow the CloudWatch service to assume the role in the sharing account. It is the sharing role that provides access to data. The AWSServiceRoleForCloudWatchCrossAccount service-linked role permissions policy allows CloudWatch to complete the following actions: • sts:AssumeRole The AWSServiceRoleForCloudWatchCrossAccount service-linked role trusts the CloudWatch service to assume the role. Service-linked role permissions for CloudWatch database Performance Insights CloudWatch uses the service-linked role named AWSServiceRoleForCloudWatchMetrics_DbPerfInsights. – CloudWatch uses this role to retrieve Performance Insights metrics for creating alarms and snapshotting. Using service-linked roles 3258 Amazon CloudWatch User Guide The AWSServiceRoleForCloudWatchMetrics_DbPerfInsights service-linked role has the AWSServiceRoleForCloudWatchMetrics_DbPerfInsightsServiceRolePolicy IAM policy attached. The contents of that policy are as follows: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "pi:GetResourceMetrics" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } } ] } The AWSServiceRoleForCloudWatchMetrics_DbPerfInsights service-linked role trusts the CloudWatch service to assume the role. Creating a service-linked role for CloudWatch You do not need to manually create any of these service-linked roles. The first time you create an alarm in the AWS Management Console, the IAM CLI, or the IAM API, CloudWatch creates AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM for you. The first time that you enable service and topology discovery, Application Signals creates AWSServiceRoleForCloudWatchApplicationSignals for you. When you first enable an account to be a monitoring account for cross-account cross-Region functionality, CloudWatch creates AWSServiceRoleForCloudWatchCrossAccount for you. When you first create an alarm that uses the DB_PERF_INSIGHTS metric math function, CloudWatch creates AWSServiceRoleForCloudWatchMetrics_DbPerfInsights for you. For more information, see Creating a Service-Linked Role in the IAM User Guide. Using service-linked roles 3259 Amazon CloudWatch User Guide Editing a service-linked role for CloudWatch CloudWatch does not allow you to edit the AWSServiceRoleForCloudWatchEvents, AWSServiceRoleForCloudWatchAlarms_ActionSSM, AWSServiceRoleForCloudWatchCrossAccount, or AWSServiceRoleForCloudWatchMetrics_DbPerfInsights roles. After you create these roles, you cannot change their names because various entities might reference these roles. However, you can edit the description of these roles using IAM. Editing a service-linked role description (IAM console) You can use the IAM console to edit the description of a service-linked role. To edit the description of a service-linked role (console) 1. In the navigation pane of the IAM console, choose Roles. 2. Choose the name of the role to modify. 3. 4. To the far right of Role description, choose Edit. Type a new description in the box, and choose Save. Editing a service-linked role description (AWS CLI) You can use IAM commands from the AWS Command Line Interface to edit the description of a service-linked role. To change the description of a service-linked role
acw-ug-894
acw-ug.pdf
894
(IAM console) You can use the IAM console to edit the description of a service-linked role. To edit the description of a service-linked role (console) 1. In the navigation pane of the IAM console, choose Roles. 2. Choose the name of the role to modify. 3. 4. To the far right of Role description, choose Edit. Type a new description in the box, and choose Save. Editing a service-linked role description (AWS CLI) You can use IAM commands from the AWS Command Line Interface to edit the description of a service-linked role. To change the description of a service-linked role (AWS CLI) 1. (Optional) To view the current description for a role, use the following commands: $ aws iam get-role --role-name role-name Use the role name, not the ARN, to refer to roles with the AWS CLI commands. For example, if a role has the following ARN: arn:aws:iam::123456789012:role/myrole, you refer to the role as myrole. 2. To update a service-linked role's description, use the following command: $ aws iam update-role-description --role-name role-name --description description Using service-linked roles 3260 Amazon CloudWatch User Guide Editing a service-linked role description (IAM API) You can use the IAM API to edit the description of a service-linked role. To change the description of a service-linked role (API) 1. (Optional) To view the current description for a role, use the following command: GetRole 2. To update a role's description, use the following command: UpdateRoleDescription Deleting a service-linked role for CloudWatch If you no longer have alarms that automatically stop, terminate, or reboot EC2 instances, we recommend that you delete the AWSServiceRoleForCloudWatchEvents role. If you not longer have alarms that perform Systems Manager OpsCenter actions, we recommend that you delete the AWSServiceRoleForCloudWatchAlarms_ActionSSM role. If you delete all alarms that use the DB_PERF_INSIGHTS metric math function, we recommend that you delete the AWSServiceRoleForCloudWatchMetrics_DbPerfInsights service-linked role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up your service-linked role before you can delete it. Cleaning up a service-linked role Before you can use IAM to delete a service-linked role, you must first confirm that the role has no active sessions and remove any resources used by the role. To check whether the service-linked role has an active session in the IAM console 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Roles. Choose the name (not the check box) of the AWSServiceRoleForCloudWatchEvents role. 3. On the Summary page for the selected role, choose Access Advisor and review the recent activity for the service-linked role. Using service-linked roles 3261 Amazon CloudWatch Note User Guide If you are unsure whether CloudWatch is using the AWSServiceRoleForCloudWatchEvents role, try to delete the role. If the service is using the role, then the deletion fails and you can view the Regions where the role is being used. If the role is being used, then you must wait for the session to end before you can delete the role. You cannot revoke the session for a service-linked role. Deleting a service-linked role (IAM console) You can use the IAM console to delete a service-linked role. To delete a service-linked role (console) 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. 3. 4. In the navigation pane, choose Roles. Select the check box next to the name of the role you want to delete, not the name or row itself. For Role actions, choose Delete role. In the confirmation dialog box, review the service last accessed data, which shows when each of the selected roles last accessed an AWS service. This helps you to confirm whether the role is currently active. To proceed, choose Yes, Delete. 5. Watch the IAM console notifications to monitor the progress of the service-linked role deletion. Because the IAM service-linked role deletion is asynchronous, the deletion task can succeed or fail after you submit the role for deletion. If the task fails, choose View details or View Resources from the notifications to learn why the deletion failed. If the deletion fails because there are resources in the service that are being used by the role, then the reason for the failure includes a list of resources. Deleting a service-linked role (AWS CLI) You can use IAM commands from the AWS Command Line Interface to delete a service-linked role. To delete a service-linked role (AWS CLI) 1. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request. That request can be denied if these conditions are not Using service-linked roles 3262 Amazon CloudWatch User Guide met. You must capture the deletion-task-id from the response to check the status of the deletion task. Type the following command to submit a service-linked role deletion request: $ aws iam delete-service-linked-role
acw-ug-895
acw-ug.pdf
895
service-linked role (AWS CLI) You can use IAM commands from the AWS Command Line Interface to delete a service-linked role. To delete a service-linked role (AWS CLI) 1. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request. That request can be denied if these conditions are not Using service-linked roles 3262 Amazon CloudWatch User Guide met. You must capture the deletion-task-id from the response to check the status of the deletion task. Type the following command to submit a service-linked role deletion request: $ aws iam delete-service-linked-role --role-name service-linked-role-name 2. Type the following command to check the status of the deletion task: $ aws iam get-service-linked-role-deletion-status --deletion-task-id deletion-task- id The status of the deletion task can be NOT_STARTED, IN_PROGRESS, SUCCEEDED, or FAILED. If the deletion fails, the call returns the reason that it failed so that you can troubleshoot. Deleting a service-linked role (IAM API) You can use the IAM API to delete a service-linked role. To delete a service-linked role (API) 1. To submit a deletion request for a service-linked role, call DeleteServiceLinkedRole. In the request, specify the role name that you want to delete. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request. That request can be denied if these conditions are not met. You must capture the DeletionTaskId from the response to check the status of the deletion task. 2. To check the status of the deletion, call GetServiceLinkedRoleDeletionStatus. In the request, specify the DeletionTaskId. The status of the deletion task can be NOT_STARTED, IN_PROGRESS, SUCCEEDED, or FAILED. If the deletion fails, the call returns the reason that it failed so that you can troubleshoot. CloudWatch updates to AWS service-linked roles View details about updates to AWS managed policies for CloudWatch since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the CloudWatch Document history page. Using service-linked roles 3263 Amazon CloudWatch User Guide Change Description Date AWSServiceRoleFor CloudWatchApplicationSignal Updated the CloudWatc hApplicationSignalsServiceR s – Update to permissions of olePolicy to exclude time service-linked role policy windows from impacting March 13, 2025 the SLO attainment rate, error budget, and burn rate metrics. CloudWatch can retrieve exclusion windows on behalf of you. AWSServiceRoleForO bservabilityAdmin – New CloudWatch added this new service-linked role and service-linked role corresponding managed November 26, 2024 policy, AWSObservabilityAd minServiceRolePolicy, to support resource and telemetry config discovery for AWS Organizations. AWSServiceRoleFo rCloudWatchApplicationSigna CloudWatch add more log groups to the scope of the April 24, 2024 ls – Update to permissions of service-linked role policy AWSServiceRoleFo rCloudWatchApplicationSigna ls – New service-linked role logs:StartQuery and logs:GetQueryResults permissions granted by this role. CloudWatch added this new service-linked role to allow CloudWatch Application Signals to collect CloudWatc h Logs data, X-Ray trace data, CloudWatch metrics data, and tagging data from applicati November 9, 2023 Using service-linked roles 3264 Amazon CloudWatch User Guide Change Description Date ons that you have enabled for CloudWatch Application Signals. AWSServiceRoleForC loudWatchMetrics_DbPerfInsi CloudWatch added this new service-linked role ghts – New service-linked to allow CloudWatch to September 13, 2023 role fetch Performance Insights metrics for alarming and snapshotting. An IAM policy is attached to this role, and the policy grants permission to CloudWatch to fetch Performance Insights metrics on your behalf. AWSServiceRoleFo rCloudWatchAlarms_ CloudWatch added a new service-linked role to allow ActionSSMIncidents – New CloudWatch to create in service-linked role cidents in AWS Systems Manager Incident Manager. CloudWatch started tracking changes CloudWatch started tracking changes for its service-linked roles. April 26, 2021 April 26, 2021 Using service-linked roles for CloudWatch RUM CloudWatch RUM uses a AWS Identity and Access Management (IAM) service-linked role. A service- linked role is a unique type of IAM role that is linked directly to RUM. The service-linked role is predefined by RUM and includes all the permissions that the service requires to call other AWS services on your behalf. Using a service-linked role for CloudWatch RUM 3265 Amazon CloudWatch User Guide RUM defines the permissions of the service-linked role, and unless defined otherwise, only RUM can assume the role. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete the role only after first deleting its related resources. This restriction protects your RUM resources because you can't inadvertently remove permissions to access the resources. 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. Service-linked role permissions for RUM RUM uses the service-linked
acw-ug-896
acw-ug.pdf
896
the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete the role only after first deleting its related resources. This restriction protects your RUM resources because you can't inadvertently remove permissions to access the resources. 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. Service-linked role permissions for RUM RUM uses the service-linked role named AWSServiceRoleForCloudWatchRUM – this role allows RUM to send AWS X-Ray trace data into your account, for app monitors that you enable X-Ray tracing for. The AWSServiceRoleForCloudWatchRUM service-linked role trusts the X-Ray service to assume the role. X-Ray sends the trace data to your account. The AWSServiceRoleForCloudWatchRUM service-linked role has an IAM policy attached named AmazonCloudWatchRUMServiceRolePolicy. This policy grants permission to CloudWatch RUM to publish monitoring data to other relevant AWS services. It includes permissions that allow RUM to complete the following actions: • xray:PutTraceSegments • cloudwatch:PutMetricData The complete contents of AmazonCloudWatchRUMServiceRolePolicy are as follows. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "xray:PutTraceSegments" ], "Resource": [ "*" Using a service-linked role for CloudWatch RUM 3266 User Guide Amazon CloudWatch ] }, { "Effect": "Allow", "Action": "cloudwatch:PutMetricData", "Resource": "*", "Condition": { "StringLike": { "cloudwatch:namespace": [ "RUM/CustomMetrics/*", "AWS/RUM" ] } } } ] } Creating a service-linked role for RUM You do not need to manually create the service-linked role for CloudWatch RUM. The first time that you create an app monitor with X-Ray tracing enabled, or update an app monitor to use X-Ray tracing, RUM creates AWSServiceRoleForCloudWatchRUM for you. For more information, see Creating a Service-Linked Role in the IAM User Guide. Editing a service-linked role for RUM CloudWatch RUM does not allow you to edit the AWSServiceRoleForCloudWatchRUM role. After you create these roles, you cannot change their names because various entities might reference these roles. However, you can edit the description of these roles using IAM. Editing a service-linked role description (IAM console) You can use the IAM console to edit the description of a service-linked role. To edit the description of a service-linked role (console) 1. In the navigation pane of the IAM console, choose Roles. 2. Choose the name of the role to modify. 3. 4. To the far right of Role description, choose Edit. Type a new description in the box, and choose Save. Using a service-linked role for CloudWatch RUM 3267 Amazon CloudWatch User Guide Editing a service-linked role description (AWS CLI) You can use IAM commands from the AWS Command Line Interface to edit the description of a service-linked role. To change the description of a service-linked role (AWS CLI) 1. (Optional) To view the current description for a role, use the following commands: $ aws iam get-role --role-name role-name Use the role name, not the ARN, to refer to roles with the AWS CLI commands. For example, if a role has the following ARN: arn:aws:iam::123456789012:role/myrole, you refer to the role as myrole. 2. To update a service-linked role's description, use the following command: $ aws iam update-role-description --role-name role-name --description description Editing a service-linked role description (IAM API) You can use the IAM API to edit the description of a service-linked role. To change the description of a service-linked role (API) 1. (Optional) To view the current description for a role, use the following command: GetRole 2. To update a role's description, use the following command: UpdateRoleDescription Deleting a service-linked role for RUM If you no longer have app monitors with X-Ray enabled, we recommend that you delete the AWSServiceRoleForCloudWatchRUM role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up your service-linked role before you can delete it. Using a service-linked role for CloudWatch RUM 3268 Amazon CloudWatch Cleaning up a service-linked role User Guide Before you can use IAM to delete a service-linked role, you must first confirm that the role has no active sessions and remove any resources used by the role. To check whether the service-linked role has an active session in the IAM console 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Roles. Choose the name (not the check box) of the AWSServiceRoleForCloudWatchRUM role. 3. On the Summary page for the selected role, choose Access Advisor and review the recent activity for the service-linked role. Note If you are unsure whether RUM is using the AWSServiceRoleForCloudWatchRUM role, try to delete the role. If the service is using the role, then the deletion fails and you can view the Regions where the role is being used. If the role is being
acw-ug-897
acw-ug.pdf
897
role has an active session in the IAM console 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Roles. Choose the name (not the check box) of the AWSServiceRoleForCloudWatchRUM role. 3. On the Summary page for the selected role, choose Access Advisor and review the recent activity for the service-linked role. Note If you are unsure whether RUM is using the AWSServiceRoleForCloudWatchRUM role, try to delete the role. If the service is using the role, then the deletion fails and you can view the Regions where the role is being used. If the role is being used, then you must wait for the session to end before you can delete the role. You cannot revoke the session for a service-linked role. Deleting a service-linked role (IAM console) You can use the IAM console to delete a service-linked role. To delete a service-linked role (console) 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. 3. 4. In the navigation pane, choose Roles. Select the check box next to the name of the role you want to delete, not the name or row itself. For Role actions, choose Delete role. In the confirmation dialog box, review the service last accessed data, which shows when each of the selected roles last accessed an AWS service. This helps you to confirm whether the role is currently active. To proceed, choose Yes, Delete. 5. Watch the IAM console notifications to monitor the progress of the service-linked role deletion. Because the IAM service-linked role deletion is asynchronous, the deletion task can succeed or fail after you submit the role for deletion. If the task fails, choose View details or Using a service-linked role for CloudWatch RUM 3269 Amazon CloudWatch User Guide View Resources from the notifications to learn why the deletion failed. If the deletion fails because there are resources in the service that are being used by the role, then the reason for the failure includes a list of resources. Deleting a service-linked role (AWS CLI) You can use IAM commands from the AWS Command Line Interface to delete a service-linked role. To delete a service-linked role (AWS CLI) 1. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request. That request can be denied if these conditions are not met. You must capture the deletion-task-id from the response to check the status of the deletion task. Type the following command to submit a service-linked role deletion request: $ aws iam delete-service-linked-role --role-name service-linked-role-name 2. Type the following command to check the status of the deletion task: $ aws iam get-service-linked-role-deletion-status --deletion-task-id deletion-task- id The status of the deletion task can be NOT_STARTED, IN_PROGRESS, SUCCEEDED, or FAILED. If the deletion fails, the call returns the reason that it failed so that you can troubleshoot. Deleting a service-linked role (IAM API) You can use the IAM API to delete a service-linked role. To delete a service-linked role (API) 1. To submit a deletion request for a service-linked role, call DeleteServiceLinkedRole. In the request, specify the role name that you want to delete. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request. That request can be denied if these conditions are not met. You must capture the DeletionTaskId from the response to check the status of the deletion task. Using a service-linked role for CloudWatch RUM 3270 Amazon CloudWatch User Guide 2. To check the status of the deletion, call GetServiceLinkedRoleDeletionStatus. In the request, specify the DeletionTaskId. The status of the deletion task can be NOT_STARTED, IN_PROGRESS, SUCCEEDED, or FAILED. If the deletion fails, the call returns the reason that it failed so that you can troubleshoot. Supported Regions for CloudWatch RUM service-linked roles CloudWatch RUM supports using service-linked roles in all of the AWS Regions where the service is available. For more information, see CloudWatch RUM service endpoints. Using service-linked roles for CloudWatch Application Insights CloudWatch Application Insights uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to CloudWatch Application Insights. Service-linked roles are predefined by CloudWatch Application Insights and include all of the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up CloudWatch Application Insights easier because you don’t have to manually add the necessary permissions. CloudWatch Application Insights defines the permissions of its service-linked roles, and unless defined otherwise, only CloudWatch Application Insights can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. For information about other services that support service-linked roles, see AWS Services
acw-ug-898
acw-ug.pdf
898
predefined by CloudWatch Application Insights and include all of the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up CloudWatch Application Insights easier because you don’t have to manually add the necessary permissions. CloudWatch Application Insights defines the permissions of its service-linked roles, and unless defined otherwise, only CloudWatch Application Insights can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. 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 Role column. Choose a Yes link to view the service-linked role documentation for that service. Service-linked role permissions for CloudWatch Application Insights CloudWatch Application Insights uses the service-linked role named AWSServiceRoleForApplicationInsights. Application Insights uses this role to perform operations such as analyzing the resource groups of the customer, creating CloudFormation stacks to create alarms on metrics, and configuring the CloudWatch Agent on EC2 instances. This service-linked role has an IAM policy attached to it named CloudwatchApplicationInsightsServiceLinkedRolePolicy. For updates to this policy, see Application Insights updates to AWS managed policies. Using service-linked roles for Application Insights 3271 Amazon CloudWatch User Guide The role permissions policy allows CloudWatch Application Insights to complete the following actions on resources. { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatch", "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarmHistory", "cloudwatch:DescribeAlarms", "cloudwatch:GetMetricData", "cloudwatch:ListMetrics", "cloudwatch:PutMetricAlarm", "cloudwatch:DeleteAlarms", "cloudwatch:PutAnomalyDetector", "cloudwatch:DeleteAnomalyDetector", "cloudwatch:DescribeAnomalyDetectors" ], "Resource": [ "*" ] }, { "Sid": "CloudWatchLogs", "Effect": "Allow", "Action": [ "logs:FilterLogEvents", "logs:GetLogEvents", "logs:DescribeLogStreams", "logs:DescribeLogGroups" ], "Resource": [ "*" ] }, { "Sid": "EventBridge", "Effect": "Allow", "Action": [ "events:DescribeRule" ], Using service-linked roles for Application Insights 3272 User Guide Amazon CloudWatch "Resource": [ "*" ] }, { "Sid": "CloudFormation", "Effect": "Allow", "Action": [ "cloudFormation:CreateStack", "cloudFormation:UpdateStack", "cloudFormation:DeleteStack", "cloudFormation:DescribeStackResources", "cloudFormation:UpdateTerminationProtection" ], "Resource": [ "arn:aws:cloudformation:*:*:stack/ApplicationInsights-*" ] }, { "Sid": "CloudFormationStacks", "Effect": "Allow", "Action": [ "cloudFormation:DescribeStacks", "cloudFormation:ListStackResources", "cloudFormation:ListStacks" ], "Resource": [ "*" ] }, { "Sid": "Tag", "Effect": "Allow", "Action": [ "tag:GetResources" ], "Resource": [ "*" ] }, { "Sid": "ResourceGroups", "Effect": "Allow", "Action": [ Using service-linked roles for Application Insights 3273 Amazon CloudWatch User Guide "resource-groups:ListGroupResources", "resource-groups:GetGroupQuery", "resource-groups:GetGroup" ], "Resource": [ "*" ] }, { "Sid": "ApplicationInsightsResourceGroup", "Effect": "Allow", "Action": [ "resource-groups:CreateGroup", "resource-groups:DeleteGroup" ], "Resource": [ "arn:aws:resource-groups:*:*:group/ApplicationInsights-*" ] }, { "Sid": "ElasticLoadBalancing", "Effect": "Allow", "Action": [ "elasticloadbalancing:DescribeLoadBalancers", "elasticloadbalancing:DescribeTargetGroups", "elasticloadbalancing:DescribeTargetHealth" ], "Resource": [ "*" ] }, { "Sid": "AutoScaling", "Effect": "Allow", "Action": [ "autoscaling:DescribeAutoScalingGroups" ], "Resource": [ "*" ] }, { "Sid": "SSMParameter", "Effect": "Allow", Using service-linked roles for Application Insights 3274 Amazon CloudWatch User Guide "Action": [ "ssm:PutParameter", "ssm:DeleteParameter", "ssm:AddTagsToResource", "ssm:RemoveTagsFromResource", "ssm:GetParameters" ], "Resource": "arn:aws:ssm:*:*:parameter/AmazonCloudWatch-ApplicationInsights-*" }, { "Sid": "SSMAssociation", "Effect": "Allow", "Action": [ "ssm:CreateAssociation", "ssm:UpdateAssociation", "ssm:DeleteAssociation", "ssm:DescribeAssociation" ], "Resource": [ "arn:aws:ec2:*:*:instance/*", "arn:aws:ssm:*:*:association/*", "arn:aws:ssm:*:*:managed-instance/*", "arn:aws:ssm:*:*:document/AWSEC2- ApplicationInsightsCloudwatchAgentInstallAndConfigure", "arn:aws:ssm:*:*:document/AWS-ConfigureAWSPackage", "arn:aws:ssm:*:*:document/AmazonCloudWatch-ManageAgent" ] }, { "Sid": "SSMOpsItem", "Effect": "Allow", "Action": [ "ssm:GetOpsItem", "ssm:CreateOpsItem", "ssm:DescribeOpsItems", "ssm:UpdateOpsItem", "ssm:DescribeInstanceInformation" ], "Resource": [ "*" ] }, { "Sid": "SSMTags", Using service-linked roles for Application Insights 3275 Amazon CloudWatch User Guide "Effect": "Allow", "Action": [ "ssm:AddTagsToResource" ], "Resource": "arn:aws:ssm:*:*:opsitem/*" }, { "Sid": "SSMGetCommandInvocation", "Effect": "Allow", "Action": [ "ssm:ListCommandInvocations", "ssm:GetCommandInvocation" ], "Resource": [ "*" ] }, { "Sid": "SSMSendCommand", "Effect": "Allow", "Action": "ssm:SendCommand", "Resource": [ "arn:aws:ec2:*:*:instance/*", "arn:aws:ssm:*:*:document/AWSEC2-CheckPerformanceCounterSets", "arn:aws:ssm:*:*:document/AWS-ConfigureAWSPackage", "arn:aws:ssm:*:*:document/AWSEC2-DetectWorkload", "arn:aws:ssm:*:*:document/AmazonCloudWatch-ManageAgent" ] }, { "Sid": "EC2", "Effect": "Allow", "Action": [ "ec2:DescribeInstances", "ec2:DescribeVolumes", "ec2:DescribeVolumeStatus", "ec2:DescribeVpcs", "ec2:DescribeVpcAttribute", "ec2:DescribeNatGateways" ], "Resource": [ "*" ] }, Using service-linked roles for Application Insights 3276 User Guide Amazon CloudWatch { "Sid": "RDS", "Effect": "Allow", "Action": [ "rds:DescribeDBInstances", "rds:DescribeDBClusters" ], "Resource": [ "*" ] }, { "Sid": "Lambda", "Effect": "Allow", "Action": [ "lambda:ListFunctions", "lambda:GetFunctionConfiguration", "lambda:ListEventSourceMappings" ], "Resource": [ "*" ] }, { "Sid": "EventBridgeManagedRule", "Effect": "Allow", "Action": [ "events:PutRule", "events:PutTargets", "events:RemoveTargets", "events:DeleteRule" ], "Resource": [ "arn:aws:events:*:*:rule/AmazonCloudWatch-ApplicationInsights-*" ] }, { "Sid": "XRay", "Effect": "Allow", "Action": [ "xray:GetServiceGraph", "xray:GetTraceSummaries", "xray:GetTimeSeriesServiceStatistics", "xray:GetTraceGraph" Using service-linked roles for Application Insights 3277 User Guide Amazon CloudWatch ], "Resource": [ "*" ] }, { "Sid": "DynamoDB", "Effect": "Allow", "Action": [ "dynamodb:ListTables", "dynamodb:DescribeTable", "dynamodb:DescribeContributorInsights", "dynamodb:DescribeTimeToLive" ], "Resource": [ "*" ] }, { "Sid": "ApplicationAutoscaling", "Effect": "Allow", "Action": [ "application-autoscaling:DescribeScalableTargets" ], "Resource": [ "*" ] }, { "Sid": "S3", "Effect": "Allow", "Action": [ "s3:ListAllMyBuckets", "s3:GetMetricsConfiguration", "s3:GetReplicationConfiguration" ], "Resource": [ "*" ] }, { "Sid": "States", "Effect": "Allow", "Action": [ Using service-linked roles for Application Insights 3278 Amazon CloudWatch User Guide "states:ListStateMachines", "states:DescribeExecution", "states:DescribeStateMachine", "states:GetExecutionHistory" ], "Resource": [ "*" ] }, { "Sid": "APIGateway", "Effect": "Allow", "Action": [ "apigateway:GET" ], "Resource": [ "*" ] }, { "Sid": "ECS", "Effect": "Allow", "Action": [ "ecs:DescribeClusters", "ecs:DescribeContainerInstances", "ecs:DescribeServices", "ecs:DescribeTaskDefinition", "ecs:DescribeTasks", "ecs:DescribeTaskSets", "ecs:ListClusters", "ecs:ListContainerInstances", "ecs:ListServices", "ecs:ListTasks" ], "Resource": [ "*" ] }, { "Sid": "ECSCluster", "Effect": "Allow", "Action": [ "ecs:UpdateClusterSettings" ], Using service-linked roles for Application Insights 3279 Amazon CloudWatch User Guide "Resource": [ "arn:aws:ecs:*:*:cluster/*" ] }, { "Sid": "EKS", "Effect": "Allow", "Action": [ "eks:DescribeCluster", "eks:DescribeFargateProfile", "eks:DescribeNodegroup", "eks:ListClusters", "eks:ListFargateProfiles", "eks:ListNodegroups", "fsx:DescribeFileSystems", "fsx:DescribeVolumes" ],
acw-ug-899
acw-ug.pdf
899
[ Using service-linked roles for Application Insights 3278 Amazon CloudWatch User Guide "states:ListStateMachines", "states:DescribeExecution", "states:DescribeStateMachine", "states:GetExecutionHistory" ], "Resource": [ "*" ] }, { "Sid": "APIGateway", "Effect": "Allow", "Action": [ "apigateway:GET" ], "Resource": [ "*" ] }, { "Sid": "ECS", "Effect": "Allow", "Action": [ "ecs:DescribeClusters", "ecs:DescribeContainerInstances", "ecs:DescribeServices", "ecs:DescribeTaskDefinition", "ecs:DescribeTasks", "ecs:DescribeTaskSets", "ecs:ListClusters", "ecs:ListContainerInstances", "ecs:ListServices", "ecs:ListTasks" ], "Resource": [ "*" ] }, { "Sid": "ECSCluster", "Effect": "Allow", "Action": [ "ecs:UpdateClusterSettings" ], Using service-linked roles for Application Insights 3279 Amazon CloudWatch User Guide "Resource": [ "arn:aws:ecs:*:*:cluster/*" ] }, { "Sid": "EKS", "Effect": "Allow", "Action": [ "eks:DescribeCluster", "eks:DescribeFargateProfile", "eks:DescribeNodegroup", "eks:ListClusters", "eks:ListFargateProfiles", "eks:ListNodegroups", "fsx:DescribeFileSystems", "fsx:DescribeVolumes" ], "Resource": [ "*" ] }, { "Sid": "SNS", "Effect": "Allow", "Action": [ "sns:GetSubscriptionAttributes", "sns:GetTopicAttributes", "sns:GetSMSAttributes", "sns:ListSubscriptionsByTopic", "sns:ListTopics" ], "Resource": [ "*" ] }, { "Sid": "SQS", "Effect": "Allow", "Action": [ "sqs:ListQueues" ], "Resource": "*" }, { Using service-linked roles for Application Insights 3280 Amazon CloudWatch User Guide "Sid": "CloudWatchLogsDeleteSubscriptionFilter", "Effect": "Allow", "Action": [ "logs:DeleteSubscriptionFilter" ], "Resource": [ "arn:aws:logs:*:*:log-group:*" ] }, { "Sid": "CloudWatchLogsCreateSubscriptionFilter", "Effect": "Allow", "Action": [ "logs:PutSubscriptionFilter" ], "Resource": [ "arn:aws:logs:*:*:log-group:*", "arn:aws:logs:*:*:destination:AmazonCloudWatch-ApplicationInsights- LogIngestionDestination*" ] }, { "Sid": "EFS", "Effect": "Allow", "Action": [ "elasticfilesystem:DescribeFileSystems" ], "Resource": [ "*" ] }, { "Sid": "Route53", "Effect": "Allow", "Action": [ "route53:GetHostedZone", "route53:GetHealthCheck", "route53:ListHostedZones", "route53:ListHealthChecks", "route53:ListQueryLoggingConfigs" ], "Resource": [ "*" ] Using service-linked roles for Application Insights 3281 User Guide Amazon CloudWatch }, { "Sid": "Route53Resolver", "Effect": "Allow", "Action": [ "route53resolver:ListFirewallRuleGroupAssociations", "route53resolver:GetFirewallRuleGroup", "route53resolver:ListFirewallRuleGroups", "route53resolver:ListResolverEndpoints", "route53resolver:GetResolverQueryLogConfig", "route53resolver:ListResolverQueryLogConfigs", "route53resolver:ListResolverQueryLogConfigAssociations", "route53resolver:GetResolverEndpoint", "route53resolver:GetFirewallRuleGroupAssociation" ], "Resource": [ "*" ] } ] } You must configure 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. Creating a service-linked role for CloudWatch Application Insights You don't need to manually create a service-linked role. When you create a new Application Insights application in the AWS Management Console, CloudWatch Application Insights creates the service-linked role for you. If you delete this service-linked role, and then want to create it again, you can use the same process to recreate the role in your account. When you create a new Application Insights application, CloudWatch Application Insights creates the service-linked role for you again. Editing a service-linked role for CloudWatch Application Insights CloudWatch Application Insights does not allow you to edit the AWSServiceRoleForApplicationInsights service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. Using service-linked roles for Application Insights 3282 Amazon CloudWatch User Guide However, you can edit the description of the role using IAM. For more information, see Editing a Service-Linked Role in the IAM User Guide. Deleting a service-linked role for CloudWatch Application Insights If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you avoid having an unused entity that is not actively monitored or maintained. However, you must delete all applications in Application Insights before you can manually delete the role. Note If the CloudWatch Application Insights service is using the role when you try to delete the resources, the deletion might fail. If that happens, wait for a few minutes and try the operation again. To delete CloudWatch Application Insights resources used by the AWSServiceRoleForApplicationInsights • Delete all of your CloudWatch Application Insights applications. For more information, see "Deleting Your Application(s)" in the CloudWatch Application Insights User Guide. To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForApplicationInsights service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Supported Regions for CloudWatch Application Insights service-linked roles CloudWatch Application Insights supports using service-linked roles in all of the AWS Regions where the service is available. For more information, see CloudWatch Application Insights Regions and Endpoints. AWS managed policies for Amazon CloudWatch Application Insights AWS managed policies for Application Insights 3283 Amazon CloudWatch User Guide An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your specific use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by defining customer managed policies that are specific to your use cases. You cannot change the permissions defined in AWS managed policies. If AWS updates the permissions defined in an AWS managed policy, the update affects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is
acw-ug-900
acw-ug.pdf
900
and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your specific use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by defining customer managed policies that are specific to your use cases. You cannot change the permissions defined in AWS managed policies. If AWS updates the permissions defined in an AWS managed policy, the update affects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AWS managed policy: CloudWatchApplicationInsightsFullAccess You can attach the CloudWatchApplicationInsightsFullAccess policy to your IAM identities. This policy grants administrative permissions that allow full access to Application Insights functionality. Permissions details This policy includes the following permissions. • applicationinsights – Allows full access to Application Insights functionality. • iam – Allows Application Insights to create the service-linked role, AWSServiceRoleForApplicationInsights. This is required so that Application Insights can perform AWS managed policies for Application Insights 3284 Amazon CloudWatch User Guide operations such as analyze the resource groups of a customer, create CloudFormation stacks to create alarms on metrics, and configure the CloudWatch Agent on EC2 instances. For more information, see Using service-linked roles for CloudWatch Application Insights. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "applicationinsights:*", "Resource": "*" }, { "Effect": "Allow", "Action": [ "ec2:DescribeInstances", "ec2:DescribeVolumes", "rds:DescribeDBInstances", "rds:DescribeDBClusters", "sqs:ListQueues", "elasticloadbalancing:DescribeLoadBalancers", "elasticloadbalancing:DescribeTargetGroups", "elasticloadbalancing:DescribeTargetHealth", "autoscaling:DescribeAutoScalingGroups", "lambda:ListFunctions", "dynamodb:ListTables", "s3:ListAllMyBuckets", "sns:ListTopics", "states:ListStateMachines", "apigateway:GET", "ecs:ListClusters", "ecs:DescribeTaskDefinition", "ecs:ListServices", "ecs:ListTasks", "eks:ListClusters", "eks:ListNodegroups", "fsx:DescribeFileSystems", "logs:DescribeLogGroups", "elasticfilesystem:DescribeFileSystems" ], "Resource": "*" }, AWS managed policies for Application Insights 3285 User Guide Amazon CloudWatch { "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": [ "arn:aws:iam::*:role/aws-service-role/application-insights.amazonaws.com/ AWSServiceRoleForApplicationInsights" ], "Condition": { "StringEquals": { "iam:AWSServiceName": "application-insights.amazonaws.com" } } } ] } AWS managed policy: CloudWatchApplicationInsightsReadOnlyAccess You can attach the CloudWatchApplicationInsightsReadOnlyAccess policy to your IAM identities. This policy grants administrative permissions that allow read-only access to all Application Insights functionality. Permissions details This policy includes the following permissions. • applicationinsights – Allows read-only access to Application Insights functionality. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", AWS managed policies for Application Insights 3286 Amazon CloudWatch "Action": [ "applicationinsights:Describe*", "applicationinsights:List*" ], "Resource": "*" } ] } User Guide AWS managed policy: CloudwatchApplicationInsightsServiceLinkedRolePolicy You can't attach CloudwatchApplicationInsightsServiceLinkedRolePolicy to your IAM entities. This policy is attached to a service-linked role that allows Application Insights to monitor customer resources. For more information, see Using service-linked roles for CloudWatch Application Insights. Application Insights updates to AWS managed policies View details about updates to AWS managed policies for Application Insights since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Application Insights Document history page. Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Update to an existing policy Application Insights added a new permission. July 25, 2024 The policy change allows Amazon CloudWatch Application Insights to enable and disable termination protection on CloudForm ation stacks to manage SSM resources used to install and configure CloudWatch agents. AWS managed policies for Application Insights 3287 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to list Update to an existing policy CloudFormation stacks. April 24, 2023 These permissions are required for Amazon CloudWatch Application Insights to analyze and monitor AWS resources nested in the CloudFormation stack. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to get list of January 23, 2023 Update to an existing policy Amazon VPC and Route 53 resources. These permissions are required for Amazon CloudWatch Application Insights to automatically set up best practice network monitoring with Amazon CloudWatch. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Update to an existing policy Application Insights added new permissions to get SSM command invocation results. December 19, 2022 These permissions are required for Amazon CloudWatch Application Insights to automatically detect and monitor workloads running on Amazon EC2 instances. AWS managed policies for Application Insights 3288 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe Update to an existing policy Amazon VPC and Route 53 December 19, 2022 resources. These permissions are required for Amazon CloudWatch Application Insights to read customer Amazon VPC and Route 53 resource configurations, and to help customers automatic ally set up best practice network monitoring with Amazon CloudWatch. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe October 3, 2022 Update to an existing policy EFS resources. These permissions are required for Amazon CloudWatch Application Insights to read Amazon EFS customer resource configura tions, and to help customers automatically set up best practices for EFS monitoring with CloudWatch. AWS managed policies for Application Insights 3289 Amazon CloudWatch User Guide
acw-ug-901
acw-ug.pdf
901
December 19, 2022 resources. These permissions are required for Amazon CloudWatch Application Insights to read customer Amazon VPC and Route 53 resource configurations, and to help customers automatic ally set up best practice network monitoring with Amazon CloudWatch. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe October 3, 2022 Update to an existing policy EFS resources. These permissions are required for Amazon CloudWatch Application Insights to read Amazon EFS customer resource configura tions, and to help customers automatically set up best practices for EFS monitoring with CloudWatch. AWS managed policies for Application Insights 3289 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe October 3, 2022 Update to an existing policy the EFS file system. These permissions are required for Amazon CloudWatch Application Insights to create account-b ased applications by querying all of the supported resources in an account. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to retrieve Update to an existing policy information about FSx September 12, 2022 AWS managed policy: CloudWatchApplicationInsigh tsFullAccess – Update to an existing policy resources. These permissions are required for Amazon CloudWatch Application Insights to monitor workloads by retrieving sufficient information about the underlying FSx volumes. Application Insights added a new permission to describe log groups. This permissions is required for Amazon CloudWatch Application Insights to ensure that the correct permissions for monitoring log groups are in an account when creating a new application. January 24, 2022 AWS managed policies for Application Insights 3290 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to create Update to an existing policy and delete CloudWatch Log January 24, 2022 Subscription Filters. These permissions are required for Amazon CloudWatch Application Insights to create Subscript ion Filters to facilitate log monitoring of resources within configured applicati ons. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe Update to an existing policy target groups and target November 4, 2021 health for Elastic Load Balancers. These permissions are required for Amazon CloudWatch Application Insights to create account-b ased applications by querying all of the supported resources in an account. AWS managed policies for Application Insights 3291 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to run the September 30, 2021 Update to an existing policy AmazonCloudWatch- ManageAgent SSM document on Amazon EC2 instances. This permissions is required for Amazon CloudWatc h Application Insights to clean up CloudWatch agent configuration files created by Application Insights. AWS managed policies for Application Insights 3292 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to support Update to an existing policy account-based applicati September 15, 2021 on monitoring to onboard and monitor all supported resources in your account. These permissions are required for Amazon CloudWatch Applicati on Insights to query, tag resources, and create groups for these resources. Application Insights added new permissions to support monitoring of SNS topics. These permissions are required for Amazon CloudWatch Application Insights to gather metadata from SNS resources to configure monitoring for SNS topics. AWS managed policies for Application Insights 3293 Amazon CloudWatch User Guide Change Description Date AWS managed policy: CloudWatchApplicationInsigh Application Insights added new permissions to describe tsFullAccess – Update to an and list supported resources. existing policy September 15, 2021 These permissions are required for Amazon CloudWatch Application Insights to create account-b ased applications by querying all of the supported resources in an account. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe August 31, 2021 Update to an existing policy FSx resources. These permissions are required for Amazon CloudWatch Application Insights to read customer FSx resource configurations, and to help customers automatic ally set up best practice FSx monitoring with CloudWatch. AWS managed policies for Application Insights 3294 Amazon CloudWatch User Guide Change Description Date CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to describe Update to an existing policy and list ECS and EKS service May 18, 2021 resources. This permission is required for Amazon CloudWatch Application Insights to read customer container resources configuration, and to help customers automatically set up best practice container monitoring with CloudWatch. CloudwatchApplicationInsigh tsServiceLinkedRolePolicy – Application Insights added new permissions to allow Update to an existing policy OpsCenter to tag OpsItems April 13, 2021 using the ssm:AddTa action on gsToResource resources with the opsitem resource type. This permission is required by OpsCenter. Amazon CloudWatch Application Insights creates OpsItems so that the customer can resolve problems using AWS SSM OpsCenter. Application Insights started tracking changes for its AWS managed policies. April 13, 2021 Application Insights started tracking changes AWS managed policies for Application Insights 3295 Amazon CloudWatch User Guide Amazon CloudWatch permissions reference The following table lists each CloudWatch API operation and the corresponding actions for which
acw-ug-902
acw-ug.pdf
902
Insights added new permissions to allow Update to an existing policy OpsCenter to tag OpsItems April 13, 2021 using the ssm:AddTa action on gsToResource resources with the opsitem resource type. This permission is required by OpsCenter. Amazon CloudWatch Application Insights creates OpsItems so that the customer can resolve problems using AWS SSM OpsCenter. Application Insights started tracking changes for its AWS managed policies. April 13, 2021 Application Insights started tracking changes AWS managed policies for Application Insights 3295 Amazon CloudWatch User Guide Amazon CloudWatch permissions reference The following table lists each CloudWatch API operation and the corresponding actions for which you can grant permissions to perform the action. You specify the actions in the policy's Action field, and you specify a wildcard character (*) as the resource value in the policy's Resource field. You can use AWS-wide condition keys in your CloudWatch policies to express conditions. For a complete list of AWS-wide keys, see AWS Global and IAM Condition Context Keys in the IAM User Guide. Note To specify an action, use the cloudwatch: prefix followed by the API operation name. For example: cloudwatch:GetMetricData, cloudwatch:ListMetrics, or cloudwatch:* (for all CloudWatch actions). Topics • CloudWatch API operations and required permissions for actions • CloudWatch Application Signals API operations and required permissions for actions • CloudWatch Contributor Insights API operations and required permissions for actions • CloudWatch Events API operations and required permissions for actions • CloudWatch Logs API operations and required permissions for actions • Amazon EC2 API operations and required permissions for actions • Amazon EC2 Auto Scaling API operations and required permissions for actions CloudWatch API operations and required permissions for actions CloudWatch API operations Required permissions (API actions) DeleteAlarms cloudwatch:DeleteAlarms Required to delete an alarm. DeleteDashboards cloudwatch:DeleteDashboards Amazon CloudWatch permissions reference 3296 Amazon CloudWatch User Guide CloudWatch API operations Required permissions (API actions) Required to delete a dashboard. DeleteMetricStream cloudwatch:DeleteMetricStream Required to delete a metric stream. DescribeAlarmHistory cloudwatch:DescribeAlarmHistory Required to view alarm history. To retrieve information about composite alarms, your cloudwatch:DescribeAlarmHistory permission must have a * scope. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHis tory permission has a narrower scope. DescribeAlarms cloudwatch:DescribeAlarms Required to retrieve information about alarms. To retrieve information about composite alarms, your cloudwatch:Describ eAlarms permission must have a * scope. You can't return information about com posite alarms if your cloudwatch:Describ eAlarms permission has a narrower scope. DescribeAlarmsForMetric cloudwatch:DescribeAlarmsFo rMetric Required to view alarms for a metric. Amazon CloudWatch permissions reference 3297 Amazon CloudWatch User Guide CloudWatch API operations Required permissions (API actions) DisableAlarmActions cloudwatch:DisableAlarmActions Required to disable an alarm action. EnableAlarmActions cloudwatch:EnableAlarmActions Required to enable an alarm action. GetDashboard cloudwatch:GetDashboard Required to display data about existing dashboards. GetMetricData cloudwatch:GetMetricData Required to graph metric data in the CloudWatch console, to retrieve large batches of metric data, and perform metric math on that data. GetMetricStatistics cloudwatch:GetMetricStatistics Required to view graphs in other parts of the CloudWatch console and in dashboard widgets. GetMetricStream cloudwatch:GetMetricStream Required to view information about a metric stream. Amazon CloudWatch permissions reference 3298 Amazon CloudWatch User Guide CloudWatch API operations Required permissions (API actions) GetMetricWidgetImage cloudwatch:GetMetricWidgetImage Required to retrieve a snapshot graph of one or more CloudWatch metrics as a bitmap image. ListDashboards cloudwatch:ListDashboards Required to view the list of CloudWatch dashboards in your account. ListEntitiesForMetric cloudwatch:ListEntitiesForMetric (CloudWatch console-only permission) Required to find the entities associated with a metric. Required to explore related telemetry within the CloudWatch console. ListMetrics cloudwatch:ListMetrics Required to view or search metric names within the CloudWatch console and in the CLI. Required to select metrics on dashboard widgets. ListMetricStreams cloudwatch:ListMetricStreams Required to view or search the list of metric streams in the account. Amazon CloudWatch permissions reference 3299 Amazon CloudWatch User Guide CloudWatch API operations Required permissions (API actions) PutCompositeAlarm cloudwatch:PutCompositeAlarm Required to create a composite alarm. To create a composite alarm, your cloudwatch:PutCompositeAlarm permission must have a * scope. You can't return information about composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope. PutDashboard cloudwatch:PutDashboard Required to create a dashboard or update an existing dashboard. PutMetricAlarm cloudwatch:PutMetricAlarm Required to create or update an alarm. PutMetricData cloudwatch:PutMetricData Required to create metrics. PutMetricStream cloudwatch:PutMetricStream Required to create a metric stream. SetAlarmState cloudwatch:SetAlarmState Required to manually set an alarm's state. Amazon CloudWatch permissions reference 3300 Amazon CloudWatch User Guide CloudWatch API operations Required permissions (API actions) StartMetricStreams cloudwatch:StartMetricStreams Required to start the flow of metrics in a metric stream. StopMetricStreams cloudwatch:StopMetricStreams Required to temporarily stop the flow of metrics in a metric stream. TagResource cloudwatch:TagResource Required to add or update tags on CloudWatc h resources such as alarms and Contributor Insights rules. UntagResource cloudwatch:UntagResource Required to remove tags from CloudWatch resources . CloudWatch Application Signals API operations and required permissions for actions CloudWatch Application Signals API operations Required permissions (API actions) BatchGetServiceLevelObjectiveBudgetReport application-signals:BatchGe tServiceLevelObjectiveBudge tReport Amazon CloudWatch
acw-ug-903
acw-ug.pdf
903
an alarm's state. Amazon CloudWatch permissions reference 3300 Amazon CloudWatch User Guide CloudWatch API operations Required permissions (API actions) StartMetricStreams cloudwatch:StartMetricStreams Required to start the flow of metrics in a metric stream. StopMetricStreams cloudwatch:StopMetricStreams Required to temporarily stop the flow of metrics in a metric stream. TagResource cloudwatch:TagResource Required to add or update tags on CloudWatc h resources such as alarms and Contributor Insights rules. UntagResource cloudwatch:UntagResource Required to remove tags from CloudWatch resources . CloudWatch Application Signals API operations and required permissions for actions CloudWatch Application Signals API operations Required permissions (API actions) BatchGetServiceLevelObjectiveBudgetReport application-signals:BatchGe tServiceLevelObjectiveBudge tReport Amazon CloudWatch permissions reference 3301 Amazon CloudWatch User Guide CloudWatch Application Signals API operations Required permissions (API actions) Required to retrieve service level objective budget reports. CreateServiceLevelObjective application-signals:CreateS erviceLevelObjective Required to create a service level objective (SLO). DeleteServiceLevelObjective application-signals:DeleteS erviceLevelObjective Required to delete a service level objective (SLO). GetService application-signals:GetService Required to retrieve information about a service discovered by Application Signals. GetServiceLevelObjective application-signals:GetServ iceLevelObjective Required to retrieve information about a service level objective (SLO). ListObservedEntities application-signals:ListObs ervedEntities Grants permission to list entities that are associated with other entities. Amazon CloudWatch permissions reference 3302 Amazon CloudWatch User Guide CloudWatch Application Signals API operations Required permissions (API actions) ListServiceDependencies application-signals:ListSer viceDependencies Required to retrieve a list of service dependencies of a service that you specify. This service and the dependencies were discovered by Application Signals. ListServiceDependents application-signals:ListSer viceDependents Required to retrieve a list of dependents that invoked a service that you specify. This service and the dependents were discovered by Application Signals. ListServiceLevelObjectives application-signals:ListSer viceLevelObjectives Required to retrieve a list of service level objectives (SLOs) in the account. ListServiceOperations application-signals:ListSer viceOperations Required to retrieve a list of service operation s of a service that you specify. This service and the dependencies were discovered by Applicati on Signals. Amazon CloudWatch permissions reference 3303 Amazon CloudWatch User Guide CloudWatch Application Signals API operations Required permissions (API actions) ListServices application-signals:ListServices Required to retrieve a list of services discovere d by Application Signals. ListTagsForResource application-signals:ListTag sForResource Required to retrieve a list of the tags associate d with a resource. StartDiscovery application-signals:StartDi scovery Required to be able to enable Application Signals in the account and create the required service-linked role. TagResource application-signals:TagResource Required to be able to add tags to resources. UntagResource application-signals:UntagRe source Required to be able to remove tags from resources. Amazon CloudWatch permissions reference 3304 Amazon CloudWatch User Guide CloudWatch Application Signals API operations Required permissions (API actions) UpdateServiceLevelObjective application-signals:UpdateS erviceLevelObjective Required to update an existing service level objective CloudWatch Contributor Insights API operations and required permissions for actions Important When you grant a user the cloudwatch:PutInsightRule permission, by default that user can create a rule that evaluates any log group in CloudWatch Logs. You can add IAM policy conditions that limit these permissions for a user to include and exclude specific log groups. For more information, see Using condition keys to limit Contributor Insights users' access to log groups. CloudWatch Contributor Insights API operations Required permissions (API actions) DeleteInsightRules cloudwatch:DeleteInsightRules Required to delete Contributor Insights rules. DescribeInsightRules cloudwatch:DescribeInsightRules Required to view the Contributor Insights rules in your account. EnableInsightRules cloudwatch:EnableInsightRules Amazon CloudWatch permissions reference 3305 Amazon CloudWatch User Guide CloudWatch Contributor Insights API operations Required permissions (API actions) Required to enable Contributor Insights rules. GetInsightRuleReport cloudwatch:GetInsightRuleReport Required to retrieve time series data and other statistics collectd by Contributor Insights rules. PutInsightRule cloudwatch:PutInsightRule Required to create Contributor Insights rules. See the Important note at the beginning of this table. CloudWatch Events API operations and required permissions for actions CloudWatch Events API operations Required permissions (API actions) DeleteRule events:DeleteRule Required to delete a rule. DescribeRule events:DescribeRule DisableRule Required to list the details about a rule. events:DisableRule Required to disable a rule. EnableRule events:EnableRule Amazon CloudWatch permissions reference 3306 Amazon CloudWatch User Guide CloudWatch Events API operations Required permissions (API actions) Required to enable a rule. ListRuleNamesByTarget events:ListRuleNamesByTarget Required to list rules associated with a target. ListRules events:ListRules Required to list all rules in your account. ListTargetsByRule events:ListTargetsByRule Required to list all targets associated with a rule. PutEvents events:PutEvents Required to add custom events that can be matched to rules. PutRule events:PutRule Required to create or update a rule. PutTargets events:PutTargets Required to add targets to a rule. RemoveTargets events:RemoveTargets Required to remove a target from a rule. Amazon CloudWatch permissions reference 3307 Amazon CloudWatch User Guide CloudWatch Events API operations Required permissions (API actions) TestEventPattern events:TestEventPattern Required to test an event pattern against a given event. CloudWatch Logs API operations and required permissions for actions Note CloudWatch Logs permissions can be found in the CloudWatch Logs user guide. Amazon EC2 API operations and required permissions for actions Amazon EC2 API operations Required permissions (API actions) DescribeInstanceStatus ec2:DescribeInstanceStatus Required to view EC2 instance status details. DescribeInstances ec2:DescribeInstances Required
acw-ug-904
acw-ug.pdf
904
rule. PutTargets events:PutTargets Required to add targets to a rule. RemoveTargets events:RemoveTargets Required to remove a target from a rule. Amazon CloudWatch permissions reference 3307 Amazon CloudWatch User Guide CloudWatch Events API operations Required permissions (API actions) TestEventPattern events:TestEventPattern Required to test an event pattern against a given event. CloudWatch Logs API operations and required permissions for actions Note CloudWatch Logs permissions can be found in the CloudWatch Logs user guide. Amazon EC2 API operations and required permissions for actions Amazon EC2 API operations Required permissions (API actions) DescribeInstanceStatus ec2:DescribeInstanceStatus Required to view EC2 instance status details. DescribeInstances ec2:DescribeInstances Required to view EC2 instance details. RebootInstances ec2:RebootInstances Required to reboot an EC2 instance. StopInstances ec2:StopInstances Required to stop an EC2 instance. TerminateInstances ec2:TerminateInstances Amazon CloudWatch permissions reference 3308 Amazon CloudWatch User Guide Amazon EC2 API operations Required permissions (API actions) Required to terminate an EC2 instance. Amazon EC2 Auto Scaling API operations and required permissions for actions Amazon EC2 Auto Scaling API operations Required permissions (API actions) Scaling Trigger autoscaling:Scaling Required to scale an Auto Scaling group. autoscaling:Trigger Required to trigger an Auto Scaling action. Compliance validation for Amazon CloudWatch To learn whether an AWS service is within the scope of specific compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. Compliance validation 3309 Amazon CloudWatch User Guide • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in Amazon CloudWatch 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 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 in Amazon CloudWatch As a managed service, Amazon CloudWatch 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. Resilience 3310 Amazon CloudWatch User Guide You use AWS published API calls to access CloudWatch through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS)
acw-ug-905
acw-ug.pdf
905
3310 Amazon CloudWatch User Guide You use AWS published API calls to access CloudWatch through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Network isolation A virtual private cloud (VPC) is a virtual network in your own logically isolated area in the Amazon Web Services Cloud. A subnet is a range of IP addresses in a VPC. You can deploy a variety of AWS resources in the subnets of your VPCs. For example, you can deploy Amazon EC2 instances, EMR clusters, and DynamoDB tables in subnets. For more information, see the Amazon VPC User Guide. To enable CloudWatch to communicate with resources in a VPC without going through the public internet, use AWS PrivateLink. For more information, see Using CloudWatch, CloudWatch Synthetics, and CloudWatch Network Monitoring with interface VPC endpoints. A private subnet is a subnet with no default route to the public internet. Deploying an AWS resource in a private subnet does not prevent Amazon CloudWatch from collecting built-in metrics from the resource. If you need to publish custom metrics from an AWS resource in a private subnet, you can do so using a proxy server. The proxy server forwards those HTTPS requests to the public API endpoints for CloudWatch. AWS Security Hub Monitor your usage of CloudWatch as it relates to security best practices by using AWS Security Hub. Security Hub uses security controls to evaluate resource configurations and security standards to help you comply with various compliance frameworks. For more information about using Security Hub to evaluate CloudWatch resources, see Amazon CloudWatch controls in the AWS Security Hub User Guide. Network isolation 3311 Amazon CloudWatch User Guide Using CloudWatch, CloudWatch Synthetics, and CloudWatch Network Monitoring with interface VPC endpoints If you use Amazon Virtual Private Cloud (Amazon VPC) to host your AWS resources, you can establish a private connection between your VPC, CloudWatch, CloudWatch Synthetics, and CloudWatch Network Monitoring features. You can use these connections to enable these services to communicate with resources in your VPC without going through the public internet. Amazon VPC is an AWS service that you can use to launch AWS resources in a virtual network that you define. With a VPC, you have control over your network settings, such the IP address range, subnets, route tables, and network gateways. To connect your VPC to CloudWatch services, you define an interface VPC endpoint for your VPC. The endpoint provides reliable, scalable connectivity to CloudWatch and supported CloudWatch services without requiring an internet gateway, network address translation (NAT) instance, or VPN connection. For more information, see What is Amazon VPC in the Amazon VPC User Guide. Interface VPC endpoints are powered by AWS PrivateLink, an AWS technology that enables private communication between AWS services using an elastic network interface with private IP addresses. For more information, see the following blog post: New – AWS PrivateLink for AWS Services The following steps are for users of Amazon VPC. For more information, see Getting Started in the Amazon VPC User Guide. CloudWatch VPC endpoints CloudWatch currently supports VPC endpoints in the following AWS Regions: • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Asia Pacific (Hong Kong) • Asia Pacific (Mumbai) • Asia Pacific (Osaka) • Asia Pacific (Seoul) • Asia Pacific (Singapore) Interface VPC endpoints 3312 User Guide Amazon CloudWatch • Asia Pacific (Sydney) • Asia Pacific (Tokyo) • Canada (Central) • Europe (Frankfurt) • Europe (Ireland) • Europe (London) • Europe (Paris) • Middle East (UAE) • South America (São Paulo) • AWS GovCloud (US-East) • AWS GovCloud (US-West) Creating a VPC endpoint for CloudWatch To start using CloudWatch with your VPC, create an interface VPC endpoint for CloudWatch. The service name to choose is com.amazonaws.region.monitoring. For more information, see Creating an interface endpoint in the Amazon VPC User Guide. You do not need to change the settings for CloudWatch. CloudWatch calls other AWS services using either public endpoints or private interface VPC endpoints, whichever are in use. For example, if you create an interface VPC endpoint for CloudWatch, and you already have metrics flowing to CloudWatch from resources located on your VPC, these metrics begin flowing through the interface VPC endpoint by default. Controlling access to your CloudWatch VPC endpoint A VPC endpoint policy is an IAM resource
acw-ug-906
acw-ug.pdf
906
The service name to choose is com.amazonaws.region.monitoring. For more information, see Creating an interface endpoint in the Amazon VPC User Guide. You do not need to change the settings for CloudWatch. CloudWatch calls other AWS services using either public endpoints or private interface VPC endpoints, whichever are in use. For example, if you create an interface VPC endpoint for CloudWatch, and you already have metrics flowing to CloudWatch from resources located on your VPC, these metrics begin flowing through the interface VPC endpoint by default. Controlling access to your CloudWatch VPC endpoint A VPC endpoint policy is an IAM resource policy that you attach to an endpoint when you create or modify the endpoint. If you don't attach a policy when you create an endpoint, Amazon VPC attaches a default policy for you that allows full access to the service. An endpoint policy doesn't override or replace user policies or service-specific policies. It's a separate policy for controlling access from the endpoint to the specified service. Endpoint policies must be written in JSON format. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. CloudWatch 3313 Amazon CloudWatch User Guide The following is an example of an endpoint policy for CloudWatch. This policy allows users connecting to CloudWatch through the VPC to send metric data to CloudWatch and prevents them from performing other CloudWatch actions. { "Statement": [ { "Sid": "PutOnly", "Principal": "*", "Action": [ "cloudwatch:PutMetricData" ], "Effect": "Allow", "Resource": "*" } ] } To edit the VPC endpoint policy for CloudWatch 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Endpoints. If you have not already created the endpoint for CloudWatch, choose Create endpoint. Select com.amazonaws.region.monitoring, and then choose Create endpoint. Select the com.amazonaws.region.monitoring endpoint, and then choose the Policy tab. 5. Choose Edit policy, and then make your changes. CloudWatch Synthetics VPC endpoint CloudWatch Synthetics currently supports VPC endpoints in the following AWS Regions: • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Asia Pacific (Hong Kong) • Asia Pacific (Mumbai) CloudWatch Synthetics 3314 User Guide Amazon CloudWatch • Asia Pacific (Seoul) • Asia Pacific (Singapore) • Asia Pacific (Sydney) • Asia Pacific (Tokyo) • Canada (Central) • Europe (Frankfurt) • Europe (Ireland) • Europe (London) • Europe (Paris) • South America (São Paulo) Creating a VPC endpoint for CloudWatch Synthetics To start using CloudWatch Synthetics with your VPC, create an interface VPC endpoint for CloudWatch Synthetics. The service name to choose is com.amazonaws.region.synthetics. For more information, see Creating an interface endpoint in the Amazon VPC User Guide. You do not need to change the settings for CloudWatch Synthetics. CloudWatch Synthetics communicates with other AWS services using either public endpoints or private interface VPC endpoints, whichever are in use. For example, if you create an interface VPC endpoint for CloudWatch Synthetics, and you already have an interface endpoint for Amazon S3, CloudWatch Synthetics begins communicating with Amazon S3 through the interface VPC endpoint by default. Controlling access to your CloudWatch Synthetics VPC endpoint A VPC endpoint policy is an IAM resource policy that you attach to an endpoint when you create or modify the endpoint. If you don't attach a policy when you create an endpoint, we attach a default policy for you that allows full access to the service. An endpoint policy doesn't override or replace user policies or service-specific policies. It's a separate policy for controlling access from the endpoint to the specified service. Endpoint policies affect canaries that are managed privately by VPC. They are not needed for canaries that run on private subnets. Endpoint policies must be written in JSON format. CloudWatch Synthetics 3315 Amazon CloudWatch User Guide For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. The following is an example of an endpoint policy for CloudWatch Synthetics. This policy enables users connecting to CloudWatch Synthetics through the VPC to view information about canaries and their runs, but not to create, modify, or delete canaries. { "Statement": [ { "Action": [ "synthetics:DescribeCanaries", "synthetics:GetCanaryRuns" ], "Effect": "Allow", "Resource": "*", "Principal": "*" } ] } To edit the VPC endpoint policy for CloudWatch Synthetics 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Endpoints. If you have not already created the endpoint for CloudWatch Synthetics, choose Create endpoint. Select com.amazonaws.region.synthetics and then choose Create endpoint. Select the com.amazonaws.region.synthetics endpoint, and then choose the Policy tab. 5. Choose Edit policy, and then make your changes. CloudWatch Network Monitoring feature VPC endpoints CloudWatch Network Monitoring includes the following features: Network Flow Monitor, Internet Monitor, and Network Synthetic Monitor. These features each support VPC endpoints in the AWS Regions
acw-ug-907
acw-ug.pdf
907
] } To edit the VPC endpoint policy for CloudWatch Synthetics 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. In the navigation pane, choose Endpoints. If you have not already created the endpoint for CloudWatch Synthetics, choose Create endpoint. Select com.amazonaws.region.synthetics and then choose Create endpoint. Select the com.amazonaws.region.synthetics endpoint, and then choose the Policy tab. 5. Choose Edit policy, and then make your changes. CloudWatch Network Monitoring feature VPC endpoints CloudWatch Network Monitoring includes the following features: Network Flow Monitor, Internet Monitor, and Network Synthetic Monitor. These features each support VPC endpoints in the AWS Regions where the Network Monitoring feature is supported. To see a list of supported Regions for each Network Monitoring feature, see the following topics: • Network Flow Monitor: Supported AWS Regions for Network Flow Monitor CloudWatch Network Monitoring 3316 Amazon CloudWatch User Guide • Internet Monitor: Supported AWS Regions for Internet Monitor • Network Synthetic Monitor: Supported AWS Regions for Network Synthetic Monitor Creating a VPC endpoint for a CloudWatch Network Monitoring feature To start using CloudWatch Network Monitoring features with your VPC, create an interface VPC endpoint for the feature that you want to use. For Network Monitoring, the following service names are available: • com.amazonaws.region.networkflowmonitor • com.amazonaws.region.networkflowmonitorreports • com.amazonaws.region.internetmonitor • com.amazonaws.region.internetmonitor-fips • com.amazonaws.region.networkmonitor For more information, see Creating an interface endpoint in the Amazon VPC User Guide. You don't need to change the settings for Network Monitoring services. Network Monitoring services communicate with other AWS services using either public endpoints or private interface VPC endpoints, whichever are being used. For example, if you create an interface VPC endpoint for a Network Monitoring service, and you already have metrics flowing to the service from resources located on your VPC, the metrics begin flowing through the interface VPC endpoint by default. Controlling access to your CloudWatch Network Monitoring feature VPC endpoints A VPC endpoint policy is an IAM resource policy that you attach to an endpoint when you create or modify the endpoint. An endpoint policy doesn't override or replace user policies or service-specific policies. It's a separate policy for controlling access from the endpoint to the specified service. If you don't attach a policy when you create an endpoint, Amazon VPC attaches a default policy for you that allows full access and does not restrict access to a specific service. For additional security, you can attach a policy to the endpoint to specifically limit access to the feature. For example, for Internet Monitor, you could allow full access to just Internet Monitor by attaching the AWS managed policy that enables full access to the feature, CloudWatchInternetMonitorFullAccess. Or, you can further limit permissions to just specific actions for the endpoint. CloudWatch Network Monitoring 3317 Amazon CloudWatch User Guide For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. The following is an example of an endpoint policy that you could create for Network Flow Monitor to limit actions for the endpoint. This policy allows requests to Network Flow Monitor through the VPC to use only the Publish action, which enables requests to publish metrics to Network Flow Monitor backend ingestion. { "Statement": [ { "Effect": "Allow", "Principal": "*", "Action": "networkflowmonitor:Publish", "Resource": "*" } ] } If you want to use a specific VPC endpoint policy with an interface VPC endpoint for a Network Monitoring feature, use steps similar to the following example for adding a policy for Network Flow Monitor. To edit a VPC endpoint policy for Network Flow Monitor 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. 3. 4. 5. In the navigation pane, choose Endpoints. If you have not already created the endpoint for Internet Monitor, choose Create endpoint. Select com.amazonaws.region.networkflowmonitor, and then choose Create endpoint. Select the com.amazonaws.region.networkflowmonitor endpoint, and then choose the Policy tab. 6. Choose Edit policy, and then make your changes. Security considerations for Synthetics canaries The following sections explain security issues that you should consider when creating and running canaries in Synthetics. Security considerations for Synthetics canaries 3318 Amazon CloudWatch Use secure connections User Guide Because canary code and the results from canary test runs can contain sensitive information, do not have your canary connect to endpoints over unencrypted connections. Always use encrypted connections, such as those that begin with https://. Canary naming considerations The Amazon Resource Name (ARN) of a canary is included in the user-agent header as a part of outbound calls made from the Puppeteer-driven Chromium browser that is included as a part of the CloudWatch Synthetics wrapper library. This helps identify CloudWatch Synthetics canary traffic and relate it back to the canaries that are making calls. The canary ARN includes the canary name. Choose canary names that do not reveal proprietary information. Additionally, be sure to point your canaries only at websites
acw-ug-908
acw-ug.pdf
908
endpoints over unencrypted connections. Always use encrypted connections, such as those that begin with https://. Canary naming considerations The Amazon Resource Name (ARN) of a canary is included in the user-agent header as a part of outbound calls made from the Puppeteer-driven Chromium browser that is included as a part of the CloudWatch Synthetics wrapper library. This helps identify CloudWatch Synthetics canary traffic and relate it back to the canaries that are making calls. The canary ARN includes the canary name. Choose canary names that do not reveal proprietary information. Additionally, be sure to point your canaries only at websites and endpoints that you control. Secrets and sensitive information in canary code If you pass your canary code directly into the canary using a zip file, the contents of the script can be seen in AWS CloudTrail logs. If you have sensitive information or secrets (such as access keys or database credentials) in a canary script, we strongly recommend that you store the script as a versioned object in Amazon S3 and pass the Amazon S3 location into the canary, instead of passing the canary code by a zip file. If you do use a zip file to pass the canary script, we strongly recommend that you don't include secrets or sensitive information in your canary source code. For more information about how to use AWS Secrets Manager to help keep your secrets safe, see What is AWS Secrets Manager?. Permissions considerations We recommend that you restrict access to resources that are created or used by CloudWatch Synthetics. Use tight permissions on the Amazon S3 buckets where canaries store test run results and other artifacts, such as logs and screenshots. Similarly, keep tight permissions on the locations where your canary source code is stored, so that no user accidentally or maliciously deletes the Lambda layers or Lambda functions used for the canary. Use secure connections 3319 Amazon CloudWatch User Guide To help make sure you run the canary code you intend, you can use object versioning on the Amazon S3 bucket where your canary code is stored. Then when you specify this code to run as a canary, you can include the object versionId as part of the path, as in the following examples. https://bucket.s3.amazonaws.com/path/object.zip?versionId=version-id https://s3.amazonaws.com/bucket/path/object.zip?versionId=version-id https://bucket.s3-region.amazonaws.com/path/object.zip?versionId=version-id Stack traces and exception messages By default, CloudWatch Synthetics canaries capture any exception thrown by your canary script, no matter whether the script is custom or is from a blueprint. CloudWatch Synthetics logs both the exception message and the stack trace to three locations: • Back into the CloudWatch Synthetics service to speed up debugging when you describe test runs • Into CloudWatch Logs according to the configuration that your Lambda functions are created with • Into the Synthetics log file, which is a plaintext file that is uploaded to the Amazon S3 location specified by the value you set for the resultsLocation of the canary If you want to send and store less information, you can capture exceptions before they return to the CloudWatch Synthetics wrapper library. You can also have request URLs in your errors. CloudWatch Synthetics scans for any URLs in the error thrown by your script and redacts restricted URL parameters from them based on the restrictedUrlParameters configuration. If you are logging error messages in your script, you can use getSanitizedErrorMessage to redact URLs before logging. Scope your IAM roles narrowly We recommend that you do not configure your canary to visit potentially malicious URLs or endpoints. Pointing your Canary to untrusted or unknown websites or endpoints could expose your Lambda function code to malicious user’s scripts. Assuming a malicious website can break out of Chromium, it could have access to your Lambda code in a similar way to if you connected to it using an internet browser. Stack traces and exception messages 3320 Amazon CloudWatch User Guide Run your Lambda function with an IAM execution role that has scoped-down permissions. This way, if your Lambda function is compromised by a malicious script, it is limited in the actions it can take when running as your canary’s AWS account. When you use the CloudWatch console to create a canary, it is created with a scoped-down IAM execution role. Sensitive data redaction CloudWatch Synthetics captures URLs, status code, failure reason (if any), and headers and bodies of requests and responses. This enables a canary user to understand, monitor, and debug canaries. The configurations described in the following sections can be set at any point in canary execution. You can also choose to apply different configurations to different synthetics steps. Request URLs By default, CloudWatch Synthetics logs request URLs, status codes, and the status reason for each URL in canary logs. Request URLs can also appear in canary execution reports, HAR files, and so on. Your request URL might contain sensitive
acw-ug-909
acw-ug.pdf
909
data redaction CloudWatch Synthetics captures URLs, status code, failure reason (if any), and headers and bodies of requests and responses. This enables a canary user to understand, monitor, and debug canaries. The configurations described in the following sections can be set at any point in canary execution. You can also choose to apply different configurations to different synthetics steps. Request URLs By default, CloudWatch Synthetics logs request URLs, status codes, and the status reason for each URL in canary logs. Request URLs can also appear in canary execution reports, HAR files, and so on. Your request URL might contain sensitive query parameters, such as access tokens or passwords. You can redact sensitive information from being logged by CloudWatch Synthetics. To redact sensitive information, set the configuration property restrictedUrlParameters. For more information, see SyntheticsConfiguration class. This causes CloudWatch Synthetics to redact URL parameters, including path and query parameter values, based on restrictedUrlParameters before logging. If you are logging URLs in your script, you can use getSanitizedUrl(url, stepConfig = null) to redact URLs before logging. For more information, see SyntheticsLogHelper class. Headers By default, CloudWatch Synthetics doesn't log request/response headers. For UI canaries, this is the default behavior for canaries using runtime version syn-nodejs-puppeteer-3.2 and later. If your headers don't contain sensitive information, you can enable headers in HAR file and HTTP reports by setting the includeRequestHeaders and includeResponseHeaders properties to true. You can enable all headers but choose to restrict values of sensitive header keys. For example, you can choose to only redact Authorization headers from artifacts produced by canaries. Sensitive data redaction 3321 Amazon CloudWatch Request and response body User Guide By default, CloudWatch Synthetics doesn't log the request/response body in canary logs or reports. This information is particularly useful for API canaries. Synthetics captures all HTTP requests and can show headers, request and response bodies. For more information, see executeHttpStep(stepName, requestOptions, [callback], [stepConfig]). You can choose to enable request/response body by setting the includeRequestBody and includeResponseBody properties to true. Sensitive data redaction 3322 Amazon CloudWatch User Guide Logging Amazon CloudWatch API and console operations with AWS CloudTrail Amazon CloudWatch, CloudWatch Synthetics, CloudWatch RUM, Amazon Q Developer operational investigations, Network Flow Monitor, and Internet Monitor are integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures API calls made by or on behalf of your AWS account. The captured calls include calls from the CloudWatch console and code calls to CloudWatch API operations. Using the information collected by CloudTrail, you can determine the request that was made to CloudWatch, the IP address from which the request was made, when it was made, and additional details. 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 user or user credentials. • Whether the request was made on behalf of an IAM Identity Center user. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail Event history. The CloudTrail Event history provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see Working with CloudTrail Event history in the AWS CloudTrail User Guide. There are no CloudTrail charges for viewing the 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 files 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 3323 Amazon CloudWatch User Guide 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 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
acw-ug-910
acw-ug.pdf
910
User Guide 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 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. Note For information about CloudWatch Logs API calls that are logged in CloudTrail, see CloudWatch Logs information in CloudTrail. Topics • CloudWatch information in CloudTrail • CloudWatch data events in CloudTrail • Query generation information in CloudTrail • Amazon Q Developer operational investigations events in CloudTrail • Network Flow Monitor in CloudTrail • Network Flow Monitor data plane events in CloudTrail 3324 Amazon CloudWatch • Internet Monitor in CloudTrail • CloudWatch Synthetics information in CloudTrail • CloudWatch RUM information in CloudTrail • CloudWatch RUM data plane events in CloudTrail User Guide CloudWatch information in CloudTrail CloudWatch supports logging the following actions as events in CloudTrail log files: • DeleteAlarms • DeleteAnomalyDetector • DeleteDashboards • DescribeAlarmHistory • DescribeAlarms • DescribeAlarmsForMetric • DescribeAnomalyDetectors • DisableAlarmActions • EnableAlarmActions • GetDashboard • ListDashboards • PutAnomalyDetector • PutDashboard • PutMetricAlarm • SetAlarmState • TagResource • UntagResource Example: CloudWatch log file entries The following example shows a CloudTrail log entry that demonstrates the PutMetricAlarm action. CloudWatch information in CloudTrail 3325 User Guide Amazon CloudWatch { "Records": [{ "eventVersion": "1.01", "userIdentity": { "type": "Root", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:root", "accountId": "123456789012", "accessKeyId": "EXAMPLE_KEY_ID" }, "eventTime": "2014-03-23T21:50:34Z", "eventSource": "monitoring.amazonaws.com", "eventName": "PutMetricAlarm", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "aws-sdk-ruby2/2.0.0.rc4 ruby/1.9.3 x86_64-linux Seahorse/0.1.0", "requestParameters": { "threshold": 50.0, "period": 60, "metricName": "CloudTrail Test", "evaluationPeriods": 3, "comparisonOperator": "GreaterThanThreshold", "namespace": "AWS/CloudWatch", "alarmName": "CloudTrail Test Alarm", "statistic": "Sum" }, "responseElements": null, "requestID": "29184022-b2d5-11e3-a63d-9b463e6d0ff0", "eventID": "b096d5b7-dcf2-4399-998b-5a53eca76a27" }, ..additional entries ] } The following log file entry shows that a user called the CloudWatch Events PutRule action. { "eventVersion":"1.03", "userIdentity":{ "type":"Root", "principalId":"123456789012", "arn":"arn:aws:iam::123456789012:root", "accountId":"123456789012", Example: CloudWatch log file entries 3326 Amazon CloudWatch User Guide "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext":{ "attributes":{ "mfaAuthenticated":"false", "creationDate":"2015-11-17T23:56:15Z" } } }, "eventTime":"2015-11-18T00:11:28Z", "eventSource":"events.amazonaws.com", "eventName":"PutRule", "awsRegion":"us-east-1", "sourceIPAddress":"AWS Internal", "userAgent":"AWS CloudWatch Console", "requestParameters":{ "description":"", "name":"cttest2", "state":"ENABLED", "eventPattern":"{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}", "scheduleExpression":"" }, "responseElements":{ "ruleArn":"arn:aws:events:us-east-1:123456789012:rule/cttest2" }, "requestID":"e9caf887-8d88-11e5-a331-3332aa445952", "eventID":"49d14f36-6450-44a5-a501-b0fdcdfaeb98", "eventType":"AwsApiCall", "apiVersion":"2015-10-07", "recipientAccountId":"123456789012" } The following log file entry shows that a user called the CloudWatch Logs CreateExportTask action. { "eventVersion": "1.03", "userIdentity": { "type": "IAMUser", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:user/someuser", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", Example: CloudWatch log file entries 3327 Amazon CloudWatch User Guide "userName": "someuser" }, "eventTime": "2016-02-08T06:35:14Z", "eventSource": "logs.amazonaws.com", "eventName": "CreateExportTask", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "aws-sdk-ruby2/2.0.0.rc4 ruby/1.9.3 x86_64-linux Seahorse/0.1.0", "requestParameters": { "destination": "yourdestination", "logGroupName": "yourloggroup", "to": 123456789012, "from": 0, "taskName": "yourtask" }, "responseElements": { "taskId": "15e5e534-9548-44ab-a221-64d9d2b27b9b" }, "requestID": "1cd74c1c-ce2e-12e6-99a9-8dbb26bd06c9", "eventID": "fd072859-bd7c-4865-9e76-8e364e89307c", "eventType": "AwsApiCall", "apiVersion": "20140328", "recipientAccountId": "123456789012" } CloudWatch data events in CloudTrail CloudTrail can capture API activities related to the CloudWatch data plane operations GetMetricData and GetMetricWidgetImage. Data events, also known as data plane operations, give you insight into the resource operations performed on or within a resource. Data events are often high-volume activities. By default, CloudTrail doesn’t log data events. The CloudTrail Event history doesn't record data events. Additional charges apply for data events. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. You can log data events for the CloudWatch resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see Logging CloudWatch data events in CloudTrail 3328 Amazon CloudWatch User Guide data events with the AWS Management Console and Logging data events with the AWS Command Line Interface in the AWS CloudTrail User Guide. Data plane events can be filtered by resource type. Because there are additional costs for using data events in CloudTrail, filtering by resource allows you to have more control
acw-ug-911
acw-ug.pdf
911
CloudTrail pricing, see AWS CloudTrail Pricing. You can log data events for the CloudWatch resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see Logging CloudWatch data events in CloudTrail 3328 Amazon CloudWatch User Guide data events with the AWS Management Console and Logging data events with the AWS Command Line Interface in the AWS CloudTrail User Guide. Data plane events can be filtered by resource type. Because there are additional costs for using data events in CloudTrail, filtering by resource allows you to have more control over what you log and pay for. Using the information that CloudTrail collects, you can identify a specific request to the CloudWatch GetMetricData or GetMetricWidgetImage APIs, the IP address of the requester, the requester's identity, and the date and time of the request. Logging the GetMetricData and GetMetricWidgetImage APIs using CloudTrail helps you enable operational and risk auditing, governance, and compliance of your AWS account. Note When you view the GetMetricData events in CloudTrail, you might see more calls than the calls that you initiated. This is because CloudWatch logs events to CloudTrail for GetMetricData actions that are initiated by internal components. For example, you'll see GetMetricData calls initiated by CloudWatch dashboards to refresh widget data, and GetMetricData calls initiated by a monitoring account to retrieve data from a source account, in cross-account observability. These internally-initiated calls don't incur CloudWatch charges, but they do count toward the number of events logged in CloudTrail, and CloudTrail charges according to the number of events logged. The following is an example of a CloudTrail event for a GetMetricData operation. { "eventVersion": "1.09", "userIdentity": { "type": "IAMUser", "principalId": "AIDA2NYTR2EPCTNY7AF3L", "arn": "arn:aws:iam::111122223333:user/admin", "accountId": "111122223333", "accessKeyId": "EXAMPLE1234567890", "userName": "admin" }, "eventTime": "2024-05-08T16:20:34Z", "eventSource": "monitoring.amazonaws.com", "eventName": "GetMetricData", CloudWatch data events in CloudTrail 3329 Amazon CloudWatch User Guide "awsRegion": "us-east-1", "sourceIPAddress": "99.45.3.7", "userAgent": "aws-cli/2.13.23 Python/3.11.5 Darwin/23.4.0 exe/x86_64 prompt/off command/cloudwatch.get-metric-data", "requestParameters": { "metricDataQueries": [{ "id": "e1", "expression": "m1 / m2", "label": "ErrorRate" }, { "id": "m1", "metricStat": { "metric": { "namespace": "CWAgent", "metricName": "disk_used_percent", "dimensions": [{ "name": "LoadBalancerName", "value": "EXAMPLE4623a5cb6a7384c5229" }] }, "period": 300, "stat": "Sum", "unit": "Count" }, "returnData": false }, { "id": "m2", "metricStat": { "metric": { "namespace": "CWAgent", "metricName": "disk_used_percent", "dimensions": [{ "name": "LoadBalancerName", "value": "EXAMPLE4623a5cb6a7384c5229" }] }, "period": 300, "stat": "Sum" }, "returnData": true } ], CloudWatch data events in CloudTrail 3330 Amazon CloudWatch User Guide "startTime": "Apr 19, 2024, 4:00:00 AM", "endTime": "May 8, 2024, 4:30:00 AM" }, "responseElements": null, "requestID": "EXAMPLE-57ac-47d5-938c-f5917c6799d5", "eventID": "EXAMPLE-211c-404b-b13d-36d93c8b4fbf", "readOnly": true, "resources": [{ "type": "AWS::CloudWatch::Metric" }], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "111122223333", "eventCategory": "Data", "tlsDetails": { "tlsVersion": "TLSv1.3", "cipherSuite": "TLS_AES_128_GCM_SHA256", "clientProvidedHostHeader": "monitoring.us-east-1.amazonaws.com" } } Query generation information in CloudTrail CloudTrail logging for Query generator console events is also supported. Query generator is currently supported for CloudWatch Metric Insights and CloudWatch Logs Insights. In these CloudTrail events, the eventSource is monitoring.amazonaws.com. The following example shows a CloudTrail log entry that demonstrates the GenerateQuery action in CloudWatch Metrics Insights. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", Query generation information in CloudTrail 3331 Amazon CloudWatch User Guide "arn": "arn:aws:iam::111222333444:role/Administrator", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2020-04-08T21:43:24Z", "mfaAuthenticated": "false" } } }, "eventTime": "2020-04-08T23:06:30Z", "eventSource": "monitoring.amazonaws.com", "eventName": "GenerateQuery", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "exampleUserAgent", "requestParameters": { "query_ask": "***", "query_type": "MetricsInsights", "metrics_insights": { "aws_namespaces": [ "AWS/S3", "AWS/Lambda", "AWS/DynamoDB" ] }, "include_description": true }, "responseElements": null, "requestID": "2f56318c-cfbd-4b60-9d93-1234567890", "eventID": "52723fd9-4a54-478c-ac55-1234567890", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } Query generation information in CloudTrail 3332 Amazon CloudWatch User Guide Amazon Q Developer operational investigations events in CloudTrail Amazon Q Developer operational investigations supports logging the following actions as events in CloudTrail log files. • CreateInvestigation • GetInvestigation • UpdateInvestigation • DeleteInvestigation • ListInvestigations • CreateInvestigationGroup • GetInvestigationGroup • UpdateInvestigationGroup • DeleteInvestigationGroup • ListInvestigationsGroup • PutInvestigationGroupPolicy • DeleteInvestigationGroupPolicy • ListTagsForResource • GetInvestigationGroupPolicy • TagResource • UntagResource • CreateInvestigationEvent • GetInvestigationEvent • UpdateInvestigationEvent • ListInvestigationEvents • CreateInvestigationResource • GetInvestigationResource Amazon Q Developer operational investigations events in CloudTrail 3333 Amazon CloudWatch User Guide Example: Amazon Q Developer operational investigations log file entries The following example shows a Amazon Q Developer operational investigations log entry that demonstrates the CreateInvestigationGroup action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:role/role_name", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-10-30T18:42:05Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-10-30T18:48:26Z", "eventSource": "aiops.amazonaws.com", "eventName": "CreateInvestigationGroup", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "exampleUserAgent", "requestParameters": { "name": "exampleName", "roleArn": "arn:aws:iam::123456789012:role/role_name" }, "responseElements": { "arn": "arn:aws:aiops:us-east-1:123456789012:investigation-group/021345abcdef67890" }, "requestId": "e9caf887-8d88-11e5-a331-3332aa445952", "requestId": "49d14f36-6450-44a5-a501-b0fdcdfaeb98", "readOnly": false, Example: Amazon Q Developer operational investigations log file entries 3334 Amazon CloudWatch User Guide "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012",
acw-ug-912
acw-ug.pdf
912
Q Developer operational investigations log entry that demonstrates the CreateInvestigationGroup action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:role/role_name", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-10-30T18:42:05Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-10-30T18:48:26Z", "eventSource": "aiops.amazonaws.com", "eventName": "CreateInvestigationGroup", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "exampleUserAgent", "requestParameters": { "name": "exampleName", "roleArn": "arn:aws:iam::123456789012:role/role_name" }, "responseElements": { "arn": "arn:aws:aiops:us-east-1:123456789012:investigation-group/021345abcdef67890" }, "requestId": "e9caf887-8d88-11e5-a331-3332aa445952", "requestId": "49d14f36-6450-44a5-a501-b0fdcdfaeb98", "readOnly": false, Example: Amazon Q Developer operational investigations log file entries 3334 Amazon CloudWatch User Guide "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management" } The following example shows a Amazon Q Developer operational investigations log entry that demonstrates the CreateInvestigationEvent action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:sts::123456789012:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:role/role_name", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-10-30T16:17:49Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-10-30T16:35:34Z", "eventSource": "aiops.amazonaws.com", "eventName": "CreateInvestigationEvent", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "exampleUserAgent", "requestParameters": { "identifier": "arn:aws:aiops:us-east-1:123456789012:investigation- group/021345abcdef67890", "investigationId": "bcdef01234567890", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "type": "METRIC_OBSERVATION", Example: Amazon Q Developer operational investigations log file entries 3335 Amazon CloudWatch "body": "***" }, "responseElements": { "investigationGroupArn": "arn:aws:aiops:us-east-1:123456789012:investigation- User Guide group/021345abcdef67890", "investigationId": "bcdef01234567890", "investigationEventId": "14567890abcdef0g" }, "requestId": "e9caf887-8d88-11e5-a331-3332aa445952", "eventId": "49d14f36-6450-44a5-a501-b0fdcdfaeb98", "readOnly": false, "resources": [{ "accountId": "123456789012", "type": "AWS::AIOps::InvestigationGroup", "ARN": "arn:aws:aiops:us-east-1:123456789012:investigation-group/021345abcdef67890" }], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "123456789012", "eventCategory": "Data" } The following example shows a Amazon Q Developer operational investigations log entry that demonstrates the UpdateInvestigationEvent action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:sts::123456789012:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:role/role_name", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-10-30T16:17:49Z", Example: Amazon Q Developer operational investigations log file entries 3336 Amazon CloudWatch User Guide "mfaAuthenticated": "false" } } }, "eventTime": "2024-10-30T16:24:48Z", "eventSource": "aiops.amazonaws.com", "eventName": "UpdateInvestigationEvent", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "exampleUserAgent", "requestParameters": { "identifier": "arn:aws:aiops:us-east-1:123456789012:investigation- group/021345abcdef67890", "investigationId": "bcdef01234567890", "investigationEventId": "14567890abcdef0g", "comment": "***" }, "responseElements": null, "requestId": "e9caf887-8d88-11e5-a331-3332aa445952", "eventId": "49d14f36-6450-44a5-a501-b0fdcdfaeb98", "readOnly": false, "resources": [{ "accountId": "123456789012", "type": "AWS::AIOps::InvestigationGroup", "ARN": "arn:aws:aiops:us-east-1:123456789012:investigation-group/021345abcdef67890" }], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "123456789012", "eventCategory": "Data" } Network Flow Monitor in CloudTrail Network Flow Monitor supports logging the following actions as events in CloudTrail log files. • CreateMonitor • GetMonitor • DeleteMonitor • ListMonitors • UpdateMonitor Network Flow Monitor in CloudTrail 3337 Amazon CloudWatch • CreateScope • GetScope • ListScopes • DeleteScope • UpdateScope User Guide Example: Network Flow Monitor log file entry The following example shows a Network Flow Monitor CloudTrail log file entry that demonstrates the CreateMonitor action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:role/Admin", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-11-03T15:43:27Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-11-03T15:58:11Z", "eventSource": "networkflowmonitor.amazonaws.com", "eventName": "CreateMonitor", "awsRegion": "us-east-1", "sourceIPAddress": "192.0.2.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", "requestParameters": { Example: Network Flow Monitor log file entry 3338 Amazon CloudWatch User Guide "MonitorName": "TestMonitor", "ClientToken": "33551db7-1618-4aab-cdef-EXAMPLE33333", "LocalResources": [ { "Type": "AWS::EC2::Subnet", "Identifier": "subnet-cdef-EXAMPLEbbbbb" }, { "Type": "AWS::EC2::Subnet", "Identifier": "subnet-cdef-EXAMPLEccccc" }, { "Type": "AWS::EC2::Subnet", "Identifier": "subnet-cdef-EXAMPLEddddd" }, { "Type": "AWS::EC2::Subnet", "Identifier": "subnet-cdef-EXAMPLEeeeee" }, { "Type": "AWS::EC2::Subnet", "Identifier": "subnet-cdef-EXAMPLEfffff" }, { "Type": "AWS::EC2::Subnet", "Identifier": "subnet-cdef-EXAMPLEggggg" } ] }, "responseElements": { "Access-Control-Expose-Headers": "*", "MonitorArn": "arn:aws:networkflowmonitor:us-east-1:000000000000:monitor/ TestMonitor", "MonitorName": "TestMonitor", "MonitorStatus": "ACTIVE" }, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" Example: Network Flow Monitor log file entry 3339 Amazon CloudWatch User Guide } { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:role/Admin", "accountId":"123456789012", "userName": "SAMPLE_NAME" }, "webIdFederationData": {}, "attributes": { "creationDate": "2022-10-11T17:25:41Z", "mfaAuthenticated": "false" } } }, "eventTime": "2022-10-11T17:30:18Z", "eventSource": "networkflowmonitor.amazonaws.com", "eventName": "ListMonitors", "awsRegion": "us-east-2", "sourceIPAddress": "192.0.2.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", "requestParameters": null, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } Example: Network Flow Monitor log file entry 3340 Amazon CloudWatch User Guide Network Flow Monitor data plane events in CloudTrail CloudTrail can capture API activities related to the CloudWatch-NetworkFlowMonitor data plane operations. Data events, also known as data plane operations, give you insight into the resource operations performed on or within a resource. Data events are often high-volume activities. To enable logging of Network Flow Monitor data events in CloudTrail files, you'll need to enable the logging of data plane API activity in CloudTrail. See Logging data events for trails for more information. Data plane events can be filtered by resource type. Because there are additional costs for using data events in CloudTrail, filtering by resource allows you to have more control over what you log and pay for. Using the information that CloudTrail collects, you can identify a specific request to the CloudWatch-NetworkFlowMonitor data
acw-ug-913
acw-ug.pdf
913
resource operations performed on or within a resource. Data events are often high-volume activities. To enable logging of Network Flow Monitor data events in CloudTrail files, you'll need to enable the logging of data plane API activity in CloudTrail. See Logging data events for trails for more information. Data plane events can be filtered by resource type. Because there are additional costs for using data events in CloudTrail, filtering by resource allows you to have more control over what you log and pay for. Using the information that CloudTrail collects, you can identify a specific request to the CloudWatch-NetworkFlowMonitor data plane APIs, the IP address of the requester, the requester's identity, and the date and time of the request. Logging the data plane APIs using CloudTrail can help you with operational and risk auditing, governance, and compliance of your AWS account. The following are data plane APIs in Network Flow Monitor. • StartQueryWorkloadInsightsTopContributors • StopQueryWorkloadInsightsTop Contributors • GetQueryStatusWorkloadInsightsTopContributors • GetQueryResultsWorkloadInsightsTopContributors • StartQueryWorkloadInsightsTopContributorsData • StopQueryWorkloadInsightsTopContributorsData • GetQueryStatusWorkloadInsightsTopContributorsData • GetQueryResultsWorkloadInsightsTopContributorsData • StartQueryMonitorsTopContributors • StopQueryMonitorsTopContributors • GetQueryStatusMonitorsTopContributors • GetQueryResultsMonitorsTopContributors Network Flow Monitor data plane events in CloudTrail 3341 Amazon CloudWatch User Guide The following example shows a CloudTrail log entry that demonstrates the GetQueryResultsMonitorsTopContributors action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:role/Admin", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-11-03T15:43:27Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-11-15T14:08:04Z", "eventSource": "networkflowmonitor.amazonaws.com", "eventName": "GetQueryResultsMonitorTopContributors", "awsRegion": "us-east-1", "sourceIPAddress": "192.0.2.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", "errorCode": "AccessDenied", "requestParameters": { "QueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEQuery, "MaxResults": "20", "MonitorName": "TestMonitor" }, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "readOnly": true, "resources": [ { Network Flow Monitor data plane events in CloudTrail 3342 Amazon CloudWatch User Guide "accountId": "123456789012", "type": "AWS::NetworkFlowMonitor::Monitor", "ARN": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/TestMonitor" } ], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "000000000000", "eventCategory": "Data" } The following example shows a CloudTrail log entry that demonstrates the GetQueryResultsWorkloadInsightsTopContributors action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:assumed-role/role_name", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:role/Admin", "accountId": "123456789012", "userName": "SAMPLE_NAME" }, "attributes": { "creationDate": "2024-11-03T15:43:27Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-11-15T14:08:04Z", "eventSource": "networkflowmonitor.amazonaws.com", "eventName": "GetQueryResultsWorkloadInsightsTopContributorsData", "awsRegion": "us-east-1", "sourceIPAddress": "192.0.2.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", "errorCode": "AccessDenied", Network Flow Monitor data plane events in CloudTrail 3343 User Guide Amazon CloudWatch "requestParameters": { "QueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEQuery", "ScopeId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEScope" }, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "readOnly": true, "resources": [ { "accountId": "496383180932", "type": "AWS::NetworkFlowMonitor::Scope", "ARN": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/ a1b2c3d4-5678-90ab-cdef-EXAMPLEScope" } ], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "000000000000", "eventCategory": "Data" } Internet Monitor in CloudTrail Internet Monitor supports logging the following actions as events in CloudTrail log files. • CreateMonitor • DeleteMonitor • GetHealthEvent • GetMonitor • GetQueryResults • GetQueryStatus • ListHealthEvents • ListMonitors • ListTagsForResource • StartQuery • StopQuery • UpdateMonitor Internet Monitor in CloudTrail 3344 Amazon CloudWatch User Guide Example: Internet Monitor log file entries The following example shows a CloudTrail Internet Monitor log entry that demonstrates the ListMonitors action. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:role/Admin", "accountId":"123456789012", "userName": "SAMPLE_NAME" }, "webIdFederationData": {}, "attributes": { "creationDate": "2022-10-11T17:25:41Z", "mfaAuthenticated": "false" } } }, "eventTime": "2022-10-11T17:30:18Z", "eventSource": "internetmonitor.amazonaws.com", "eventName": "ListMonitors", "awsRegion": "us-east-2", "sourceIPAddress": "192.0.2.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", "requestParameters": null, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" Example: Internet Monitor log file entries 3345 Amazon CloudWatch } User Guide The following example shows a CloudTrail Internet Monitor log entry that demonstrates the CreateMonitor action. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::000000000000:role/Admin", "accountId":"123456789012", "userName": "SAMPLE_NAME" }, "webIdFederationData": {}, "attributes": { "creationDate": "2022-10-11T17:25:41Z", "mfaAuthenticated": "false" } } }, "eventTime": "2022-10-11T17:30:08Z", "eventSource": "internetmonitor.amazonaws.com", "eventName": "CreateMonitor", "awsRegion": "us-east-2", "sourceIPAddress": "192.0.2.0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)", "requestParameters": { "MonitorName": "TestMonitor", "Resources": ["arn:aws:ec2:us-east-2:444455556666:vpc/vpc-febc0b95"], "ClientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" }, "responseElements": { "Arn": "arn:aws:internetmonitor:us-east-2:444455556666:monitor/ct- onboarding-test", "Status": "PENDING" Example: Internet Monitor log file entries 3346 Amazon CloudWatch }, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } User Guide CloudWatch Synthetics information in CloudTrail CloudWatch Synthetics supports logging the following actions as events in CloudTrail log files: • CreateCanary • DeleteCanary • DescribeCanaries • DescribeCanariesLastRun • DescribeRuntimeVersions • GetCanary • GetCanaryRuns • ListTagsForResource • StartCanary • StopCanary • TagResource • UntagResource • UpdateCanary Example: CloudWatch Synthetics log file entries The following example shows a CloudTrail Synthetics log entry that demonstrates the DescribeCanaries action. { "eventVersion": "1.05", "userIdentity": { CloudWatch Synthetics information in CloudTrail 3347 Amazon CloudWatch User Guide "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::111222333444:role/Administrator",
acw-ug-914
acw-ug.pdf
914
} User Guide CloudWatch Synthetics information in CloudTrail CloudWatch Synthetics supports logging the following actions as events in CloudTrail log files: • CreateCanary • DeleteCanary • DescribeCanaries • DescribeCanariesLastRun • DescribeRuntimeVersions • GetCanary • GetCanaryRuns • ListTagsForResource • StartCanary • StopCanary • TagResource • UntagResource • UpdateCanary Example: CloudWatch Synthetics log file entries The following example shows a CloudTrail Synthetics log entry that demonstrates the DescribeCanaries action. { "eventVersion": "1.05", "userIdentity": { CloudWatch Synthetics information in CloudTrail 3347 Amazon CloudWatch User Guide "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::111222333444:role/Administrator", "accountId":"123456789012", "userName": "SAMPLE_NAME" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2020-04-08T21:43:24Z" } } }, "eventTime": "2020-04-08T23:06:47Z", "eventSource": "synthetics.amazonaws.com", "eventName": "DescribeCanaries", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "aws-internal/3 aws-sdk-java/1.11.590 Linux/4.9.184-0.1.ac.235.83.329.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.212-b03 java/1.8.0_212 vendor/Oracle_Corporation", "requestParameters": null, "responseElements": null, "requestID": "201ed5f3-15db-4f87-94a4-123456789", "eventID": "73ddbd81-3dd0-4ada-b246-123456789", "readOnly": true, "eventType": "AwsApiCall", "recipientAccountId": "111122223333" } The following example shows a CloudTrail Synthetics log entry that demonstrates the UpdateCanary action. { "eventVersion": "1.05", "userIdentity": { Example: CloudWatch Synthetics log file entries 3348 Amazon CloudWatch User Guide "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::111222333444:role/Administrator", "accountId":"123456789012", "userName": "SAMPLE_NAME" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2020-04-08T21:43:24Z" } } }, "eventTime": "2020-04-08T23:06:47Z", "eventSource": "synthetics.amazonaws.com", "eventName": "UpdateCanary", "awsRegion": "us-east-1", "sourceIPAddress": "192.0.2.0", "userAgent": "aws-internal/3 aws-sdk-java/1.11.590 Linux/4.9.184-0.1.ac.235.83.329.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.212-b03 java/1.8.0_212 vendor/Oracle_Corporation", "requestParameters": { "Schedule": { "Expression": "rate(1 minute)" }, "name": "sample_canary_name", "Code": { "Handler": "myOwnScript.handler", "ZipFile": "SAMPLE_ZIP_FILE" } }, "responseElements": null, "requestID": "fe4759b0-0849-4e0e-be71-1234567890", "eventID": "9dc60c83-c3c8-4fa5-bd02-1234567890", "readOnly": false, "eventType": "AwsApiCall", "recipientAccountId": "111122223333" Example: CloudWatch Synthetics log file entries 3349 Amazon CloudWatch } User Guide The following example shows a CloudTrail Synthetics log entry that demonstrates the GetCanaryRuns action. { "eventVersion": "1.05", "userIdentity": { "type": "AssumedRole", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::123456789012:assumed-role/role_name", "accountId":"123456789012", "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::111222333444:role/Administrator", "accountId":"123456789012", "userName": "SAMPLE_NAME" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2020-04-08T21:43:24Z" } } }, "eventTime": "2020-04-08T23:06:30Z", "eventSource": "synthetics.amazonaws.com", "eventName": "GetCanaryRuns", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "aws-internal/3 aws-sdk-java/1.11.590 Linux/4.9.184-0.1.ac.235.83.329.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.212-b03 java/1.8.0_212 vendor/Oracle_Corporation", "requestParameters": { "Filter": "TIME_RANGE", "name": "sample_canary_name", "FilterValues": [ "2020-04-08T23:00:00.000Z", "2020-04-08T23:10:00.000Z" ] Example: CloudWatch Synthetics log file entries 3350 Amazon CloudWatch }, "responseElements": null, "requestID": "2f56318c-cfbd-4b60-9d93-1234567890", "eventID": "52723fd9-4a54-478c-ac55-1234567890", "readOnly": true, "eventType": "AwsApiCall", "recipientAccountId": "111122223333" } User Guide CloudWatch RUM information in CloudTrail CloudWatch RUM supports logging the following actions as events in CloudTrail log files: • BatchCreateRumMetricDefinitions • BatchDeleteRumMetricDefinitions • BatchGetRumMetricDefinitions • CreateAppMonitor • DeleteAppMonitor • DeleteRumMetricsDestination • GetAppMonitor • GetAppMonitorData • ListAppMonitors • ListRumMetricsDestinations • ListTagsForResource • PutRumMetricsDestination • TagResource • UntagResource • UpdateAppMonitor • UpdateRumMetricDefinition Example: CloudWatch RUM log file entries This section contains example CloudTrail entries for some CloudWatch RUM APIs. CloudWatch RUM information in CloudTrail 3351 Amazon CloudWatch User Guide The following example shows a CloudTrail log entry that demonstrates the CreateAppMonitor action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:sts::777777777777:assumed-role/EXAMPLE", "accountId": "777777777777", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:iam::777777777777:role/EXAMPLE", "accountId": "777777777777", "userName": "USERNAME_EXAMPLE" }, "attributes": { "creationDate": "2024-07-23T16:48:47Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-07-23T18:02:57Z", "eventSource": "rum.amazonaws.com", "eventName": "CreateAppMonitor", "awsRegion": "us-east-1", "sourceIPAddress": "54.240.198.39", "userAgent": "aws-internal/3 aws-sdk-java/1.12.641 Linux/5.10.219-186.866.amzn2int.x86_64 OpenJDK_64-Bit_Server_VM/25.402-b08 java/1.8.0_402 vendor/Oracle_Corporation cfg/retry-mode/standard", "requestParameters": { "CustomEvents": { "Status": "ENABLED" }, "CwLogEnabled": true, "Domain": "*.github.io", "AppMonitorConfiguration": { "SessionSampleRate": 1, "IncludedPages": [], "ExcludedPages": [], Example: CloudWatch RUM log file entries 3352 Amazon CloudWatch User Guide "Telemetries": [ "performance", "errors", "http" ], "EnableXRay": false, "AllowCookies": true, "IdentityPoolId": "us-east-1:c81b9a1c-a5c9-4de5-8585-eb8df04e66f0" }, "Tags": { "TestAppMonitor": "" }, "Name": "TestAppMonitor" }, "responseElements": { "Id": "65a8cc63-4ae8-4f2c-b5fc-4a54ef43af51" }, "requestID": "cf7c30ad-25d3-4274-bab1-39c95a558007", "eventID": "2d43cc69-7f89-4f1a-95ae-0fc7e9b9fb3b", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "777777777777", "eventCategory": "Management" } The following example shows a CloudTrail log entry that demonstrates the PutRumMetricsDestination action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:sts::777777777777:assumed-role/EXAMPLE", "accountId": "777777777777", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:iam::777777777777:role/EXAMPLE", "accountId": "777777777777", Example: CloudWatch RUM log file entries 3353 Amazon CloudWatch User Guide "userName": "USERNAME_EXAMPLE" }, "attributes": { "creationDate": "2024-07-23T16:48:47Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-07-23T18:22:22Z", "eventSource": "rum.amazonaws.com", "eventName": "PutRumMetricsDestination", "awsRegion": "us-east-1", "sourceIPAddress": "52.94.133.142", "userAgent": "aws-cli/2.13.25 Python/3.11.5 Linux/5.10.219-186.866.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/rum.put-rum-metrics-destination", "requestParameters": { "Destination": "CloudWatch", "AppMonitorName": "TestAppMonitor" }, "responseElements": null, "requestID": "9b03fcce-b3a2-44fc-b771-900e1702998a", "eventID": "6250f9b7-0505-4f96-9668-feb64f82de5b", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "777777777777", "eventCategory": "Management" } The following example shows a CloudTrail log entry that demonstrates the BatchCreateRumMetricsDefinitions action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:sts::777777777777:assumed-role/EXAMPLE", "accountId": "777777777777", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", Example: CloudWatch RUM log file entries 3354 Amazon CloudWatch User Guide "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:iam::777777777777:role/EXAMPLE", "accountId": "777777777777", "userName": "USERNAME_EXAMPLE" }, "attributes": { "creationDate": "2024-07-23T16:48:47Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-07-23T18:23:11Z", "eventSource": "rum.amazonaws.com", "eventName": "BatchCreateRumMetricDefinitions", "awsRegion": "us-east-1", "sourceIPAddress": "52.94.133.142", "userAgent": "aws-cli/2.13.25 Python/3.11.5 Linux/5.10.219-186.866.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/rum.batch-create-rum-metric-definitions", "requestParameters": { "Destination": "CloudWatch", "MetricDefinitions": [ { "Name": "NavigationToleratedTransaction", "Namespace": "AWS/RUM", "DimensionKeys": { "metadata.browserName": "BrowserName" }, "EventPattern": "{\"metadata\":{\"browserName\":[\"Chrome\"]}, \"event_type\":[\"com.amazon.rum.performance_navigation_event\"],\"event_details\": {\"duration\": [{\"numeric\": [\"<=\",2000,\"<\",8000]}]}}" }, {
acw-ug-915
acw-ug.pdf
915
a CloudTrail log entry that demonstrates the BatchCreateRumMetricsDefinitions action. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:sts::777777777777:assumed-role/EXAMPLE", "accountId": "777777777777", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", Example: CloudWatch RUM log file entries 3354 Amazon CloudWatch User Guide "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:iam::777777777777:role/EXAMPLE", "accountId": "777777777777", "userName": "USERNAME_EXAMPLE" }, "attributes": { "creationDate": "2024-07-23T16:48:47Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-07-23T18:23:11Z", "eventSource": "rum.amazonaws.com", "eventName": "BatchCreateRumMetricDefinitions", "awsRegion": "us-east-1", "sourceIPAddress": "52.94.133.142", "userAgent": "aws-cli/2.13.25 Python/3.11.5 Linux/5.10.219-186.866.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/rum.batch-create-rum-metric-definitions", "requestParameters": { "Destination": "CloudWatch", "MetricDefinitions": [ { "Name": "NavigationToleratedTransaction", "Namespace": "AWS/RUM", "DimensionKeys": { "metadata.browserName": "BrowserName" }, "EventPattern": "{\"metadata\":{\"browserName\":[\"Chrome\"]}, \"event_type\":[\"com.amazon.rum.performance_navigation_event\"],\"event_details\": {\"duration\": [{\"numeric\": [\"<=\",2000,\"<\",8000]}]}}" }, { "Name": "HttpErrorCount", "DimensionKeys": { "metadata.browserName": "BrowserName", "metadata.countryCode": "CountryCode" }, "EventPattern": "{\"metadata\":{\"browserName\":[\"Chrome\"], \"countryCode\":[\"US\"]},\"event_type\":[\"com.amazon.rum.http_event\"]}" } ], "AppMonitorName": "TestAppMonitor" }, "responseElements": { Example: CloudWatch RUM log file entries 3355 Amazon CloudWatch User Guide "Errors": [], "MetricDefinitions": [] }, "requestID": "b14c5eda-f107-48e5-afae-1ac20d0962a8", "eventID": "001b55c6-1de1-48c0-a236-31096dffe249", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "777777777777", "eventCategory": "Management" } CloudWatch RUM data plane events in CloudTrail CloudTrail can capture API activities related to the CloudWatch RUM data plane operation PutRumEvents. Data events, also known as data plane operations, give you insight into the resource operations performed on or within a resource. Data events are often high-volume activities. To enable logging of the PutRumEvents data events in CloudTrail files, you'll need to enable the logging of data plane API activity in CloudTrail. See Logging data events for trails for more information. Data plane events can be filtered by resource type. Because there are additional costs for using data events in CloudTrail, filtering by resource allows you to have more control over what you log and pay for. Using the information that CloudTrail collects, you can identify a specific request to the CloudWatch RUM PutRumEvents API, the IP address of the requester, the requester's identity, and the date and time of the request. Logging the PutRumEvents API using CloudTrail helps you enable operational and risk auditing, governance, and compliance of your AWS account. The following example shows a CloudTrail log entry that demonstrates the PutRumEvents action. { "Records": [ { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "EXAMPLE_PRINCIPAL_ID", CloudWatch RUM data plane events in CloudTrail 3356 Amazon CloudWatch User Guide "arn": "arn:aws:sts::777777777777:assumed-role/EXAMPLE", "accountId": "777777777777", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "EXAMPLE_PRINCIPAL_ID", "arn": "arn:aws:iam::777777777777:role/EXAMPLE", "accountId": "777777777777", "userName": "USERNAME_EXAMPLE" }, "attributes": { "creationDate": "2024-05-16T20:32:39Z", "mfaAuthenticated": "false" } }, "invokedBy": "AWS Internal" }, "eventTime": "2024-05-16T20:32:42Z", "eventSource": "rum.amazonaws.com", "eventName": "PutRumEvents", "awsRegion": "us-east-1", "sourceIPAddress": "AWS Internal", "userAgent": "AWS Internal", "requestParameters": { "id": "73ddbd81-1234-5678-b246-123456789", "batchId": "123456-3dd0-4ada-b246-123456789", "appMonitorDetails": { "name": "APP-MONITOR-NAME", "id": "123456-3dd0-4ada-b246-123456789", "version": "1.0.0" }, "userDetails": { "userId": "73ddbd81-1111-9999-b246-123456789", "sessionId": "a1b2c3456-15db-4f87-6789-123456789" }, "rumEvents": [ { "id": "201f367a-15db-1234-94a4-123456789", "timestamp": "May 16, 2024, 8:32:20 PM", "type": "com.amazon.rum.dom_event", "metadata": "{}", "details": "{}" } CloudWatch RUM data plane events in CloudTrail 3357 User Guide Amazon CloudWatch ] }, "responseElements": null, "requestID": "201ed5f3-15db-4f87-94a4-123456789", "eventID": "73ddbd81-3dd0-4ada-b246-123456789", "readOnly": false, "resources": [ { "accountId": "777777777777", "type": "AWS::RUM::AppMonitor", "ARN": "arn:aws:rum:us-east-1:777777777777:appmonitor/ APPMONITOR_NAME_EXAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "777777777777", "eventCategory": "Data" } ] } CloudWatch RUM data plane events in CloudTrail 3358 Amazon CloudWatch User Guide Tagging your Amazon CloudWatch resources A tag is a custom attribute label that you or AWS assigns to an AWS resource. Tags help you do the following: • Identify and organize your AWS resources. Many AWS services support tagging. You can assign the same tag to resources from different services to indicate the resources are related. For example, you can assign the tag that you assigned to a CloudWatch rule to an EC2 instance. Tags have two parts: • A tag key (for example, CostCenter, Environment, or Project). Tag keys are case sensitive. • An optional field known as a tag value (for example, 111122223333 or Production). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive. The following sections provide more information about tags for CloudWatch. Supported resources in CloudWatch The following resources in CloudWatch support tagging: • Alarms – You can tag alarms using the tag-resource AWS CLI command and the TagResource API. You can also view and manage your alarm tags using the Alarms details page in the CloudWatch console. • Canaries – You can tag canaries using the CloudWatch console. For more information, see Creating a canary. • Contributor Insights rules – You can tag Contributor Insights rules when you create them by using the put-insight-rule AWS CLI command and the PutInsightRule API. You can add tags to existing rules by using the tag-resource AWS CLI command and the TagResource API. • Metric streams – You can tag metric streams when you create them by using the put-metric- stream AWS CLI command and the PutMetricStream API. You can add tags to existing metric streams by using the tag-resource AWS CLI command and the TagResource API. For information about adding and managing tags, see
acw-ug-916
acw-ug.pdf
916
see Creating a canary. • Contributor Insights rules – You can tag Contributor Insights rules when you create them by using the put-insight-rule AWS CLI command and the PutInsightRule API. You can add tags to existing rules by using the tag-resource AWS CLI command and the TagResource API. • Metric streams – You can tag metric streams when you create them by using the put-metric- stream AWS CLI command and the PutMetricStream API. You can add tags to existing metric streams by using the tag-resource AWS CLI command and the TagResource API. For information about adding and managing tags, see Managing tags. Supported resources in CloudWatch 3359 Amazon CloudWatch Managing tags User Guide Tags consist of the Key and Value properties on a resource. You can use the CloudWatch console, the AWS CLI, or the CloudWatch API to add, edit, or delete the values for these properties. For information about working with tags, see the following: • TagResource, UntagResource, and ListTagsForResource in the Amazon CloudWatch API Reference • tag-resource, untag-resource, and list-tags-for-resource in the Amazon CloudWatch CLI Reference • Working with Tag Editor in the Resource Groups User Guide Tag naming and usage conventions The following basic naming and usage conventions apply to using tags with CloudWatch resources: • Each resource can have a maximum of 50 tags. • For each resource, each tag key must be unique, and each tag key can have only one value. • The maximum tag key length is 128 Unicode characters in UTF-8. • The maximum tag value length is 256 Unicode characters in UTF-8. • Allowed characters are letters, numbers, spaces representable in UTF-8, and the following characters: . : + = @ _ / - (hyphen). • Tag keys and values are case sensitive. As a best practice, decide on a strategy for capitalizing tags and consistently implement that strategy across all resource types. For example, decide whether to use Costcenter, costcenter, or CostCenter and use the same convention for all tags. Avoid using similar tags with inconsistent case treatment. • The aws: prefix is prohibited for tags because it's reserved for AWS use. You can't edit or delete tag keys or values with this prefix. Tags with this prefix don't count against your tags per resource limit. Managing tags 3360 Amazon CloudWatch User Guide Grafana integration You can use Grafana version 6.5.0 and later to contextually advance through the CloudWatch console and query a dynamic list of metrics by using wildcards. This can help you monitor metrics for AWS resources, such as Amazon Elastic Compute Cloud instances or containers. When new instances are created as part of an Auto Scaling event, they appear in the graph automatically. You don't need to track the new instance IDs. Prebuilt dashboards help simplify the getting started experience for monitoring Amazon EC2, Amazon Elastic Block Store, and AWS Lambda resources. You can use Grafana version 7.0 and later to perform CloudWatch Logs Insights queries on log groups in CloudWatch Logs. You can visualize your query results in bar, line, and stacked graphs and in a table format. For more information about CloudWatch Logs Insights, see Analyzing Log Data with CloudWatch Logs Insights. For more information about how to get started, see Using AWS CloudWatch in Grafana in the Grafana Labs documentation. 3361 Amazon CloudWatch User Guide CloudWatch service quotas You can use the table in this section to learn about alarms, alarm email notifications, and API requests in Amazon CloudWatch. Note For some AWS services including CloudWatch, you can use the CloudWatch usage metrics to visualize your current service usage on CloudWatch graphs and dashboards. You can use a CloudWatch metric math function to display the service quotas for those resources on your graphs. You can also configure alarms that alert you when your usage approaches a service quota. For more information, see Visualizing your service quotas and setting alarms. Resource Alarm actions Alarm evaluation period Alarms Default quota 5/alarm. This quota cannot be changed. This is calculated by multiplying the alarm period by the number of evaluation periods used. The maximum value is seven days for alarms with a period of at least one hour (3600 seconds). The maximum is one day for alarms with a shorter period, and the maximum is one day for alarms using the custom Lambda data source. This quota cannot be changed. 10/month/customer for free. Additional alarms incur charges. No limit on the total number of alarms per account. Alarms based on metric math expressions can have up to 10 metrics. 200 Metrics Insights alarms per Region. You can request a quota increase. Anomaly detection models 500 per Region, per account. 3362 Amazon CloudWatch Resource API requests Default quota 1,000,000/month/customer for free. User Guide Application Signals API requests The following APIs have a quota of 10 transactions per second
acw-ug-917
acw-ug.pdf
917
with a shorter period, and the maximum is one day for alarms using the custom Lambda data source. This quota cannot be changed. 10/month/customer for free. Additional alarms incur charges. No limit on the total number of alarms per account. Alarms based on metric math expressions can have up to 10 metrics. 200 Metrics Insights alarms per Region. You can request a quota increase. Anomaly detection models 500 per Region, per account. 3362 Amazon CloudWatch Resource API requests Default quota 1,000,000/month/customer for free. User Guide Application Signals API requests The following APIs have a quota of 10 transactions per second (TPS) and per Region. You can request a quota increase. • BatchGetServiceLevelObjectiveBudgetReport • GetService • ListServiceDependencies • ListServiceDependents • ListServiceOperations • ListServices The following APIs have a quota of 5 transactions per second (TPS) and per Region. You can request a quota increase. • CreateServiceLevelObjective • DeleteServiceLevelObjective • GetServiceLevelObjective • ListServiceLevelObjectives • ListTagsForResource • StartDiscovery • TagResource • UntagResource • UpdateServiceLevelObjective Maximum number of SLOs supported per Region per account: 250 Maximum number of SLOs supported per Service: 100 You can request a quota increase. 3363 SLOs Amazon CloudWatch Resource Canaries User Guide Default quota 200 per Region per account. You can request a quota increase. Contributor Insights API requests The following APIs have a quota of 20 transactions per second (TPS) and per Region. • DescribeInsightRules The quota cannot be changed. • GetInsightRuleReport You can request a quota increase. The following APIs have a quota of 5 TPS per Region. This quota cannot be changed. • DeleteInsightRules • PutInsightRule The following APIs have a quota of 1 TPS per Region. This quota cannot be changed. • DisableInsightRules • EnableInsightRules Contributor Insights rules 100 rules per Region per account. You can request a quota increase. Custom metrics No quota. 3364 Amazon CloudWatch Resource Dashboards DescribeAlarms DeleteAlarms request DescribeAlarmHistory request DisableAlarmActions request EnableAlarmActions request SetAlarmState request DescribeAlarmsForMetric request DeleteDashboards request GetDashboard request ListDashboards request PutDashboard request User Guide Default quota Up to 500 widgets per dashboard. Up to 500 metrics per dashboard widget. Up to 2500 metrics per dashboard, across all widgets. These quotas include all metrics retrieved for use in metric math functions, even if those metrics are not displayed on the graph. These quotas cannot be changed. 9 transactions per second (TPS) per Region. The maximum number of operation requests you can make per second without being throttled. You can request a quota increase. 3 TPS per Region for each of these operations. The maximum number of operation requests you can make per second without being throttled. These quotas cannot be changed. 9 TPS per Region. The maximum number of operation requests you can make per second without being throttled. This quotas cannot be changed. 10 TPS per Region for each of these operations. The maximum number of operation requests you can make per second without being throttled. These quotas cannot be changed. 3365 Amazon CloudWatch Resource PutAnomalyDetector User Guide Default quota 10 TPS per Region. The maximum number of operation requests you can make per second without being DescribeAnomalyDetectors throttled. DeleteAnomalyDetector 5 TPS per Region. The maximum number of operation requests you can make per second without being throttled. Dimensions 30/metric. This quota cannot be changed. 3366 Amazon CloudWatch Resource GetMetricData User Guide Default quota 10 TPS per Region for operations that include Metrics Insights queries. For operations that do not include Metrics Insights queries, the quota is 50 TPS per Region. This is the maximum number of operation requests you can make per second without being throttled. You can request a quota increase. For GetMetricData operations that include a Metrics Insights query, the quota is 4,300,000 Datapoints Per Second (DPS) for the most recent 3 hours. This is calculated against the total number of data points scanned by the query (which can include no more than 10,000 metrics.) 180,000 Datapoints Per Second (DPS) if the StartTime used in the API request is less than or equal to three hours from current time. 396,000 DPS if the StartTime is more than three hours from current time. This is the maximum number of datapoints you can request per second using one or more API calls without being throttled. This quota cannot be changed. The DPS is calculated based on estimated data points, not actual data points. The data point estimate is calculated using the requested time range, period, and retention period. This means that if the actual data points in the requested metrics are sparse or empty, throttling still occurs if the estimated data points exceed the quota. The DPS quota is per-Region. 3367 Amazon CloudWatch Resource GetMetricData User Guide Default quota A single GetMetricData call can include the following: • As many as 500 MetricDataQuery structures. • As many as 100 SERVICE_QUOTA() functions. • As many as 100
acw-ug-918
acw-ug.pdf
918
quota cannot be changed. The DPS is calculated based on estimated data points, not actual data points. The data point estimate is calculated using the requested time range, period, and retention period. This means that if the actual data points in the requested metrics are sparse or empty, throttling still occurs if the estimated data points exceed the quota. The DPS quota is per-Region. 3367 Amazon CloudWatch Resource GetMetricData User Guide Default quota A single GetMetricData call can include the following: • As many as 500 MetricDataQuery structures. • As many as 100 SERVICE_QUOTA() functions. • As many as 100 SEARCH() functions. • As many as 5 LAMBDA() functions. These quotas can't be changed. GetMetricStatistics 400 TPS per Region. The maximum number of operation requests you can make per second without being throttled. You can request a quota increase. GetMetricWidgetImage Up to 500 metrics per image. This quota cannot be changed. ListMetrics Metric data values 20 TPS per Region. The maximum number of operation requests you can make per second without being throttled. You can request a quota increase. 25 TPS per Region. The maximum number of operation requests you can make per second without being throttled. You can request a quota increase. The value of a metric data point must be within the range of -2^360 to 2^360. Special values (for example, NaN, +Infinity, -Infinity) are not supported. This quota cannot be changed. 3368 Amazon CloudWatch Resource MetricDatum items User Guide Default quota 1000/PutMetricData request. A MetricDatum object can contain a single value or a StatisticSet object represent ing many values. This quota cannot be changed. Metrics 10/month/customer for free. Metrics Insights queries A single query can process no more than 10,000 metrics. This means that if the SELECT, FROM, and WHERE clauses would match more than 10,000 metrics, only the first 10,000 of these metrics that are found will be processed by the query. A single query can return no more than 500 time series. You can query only the most recent three hours of data Metrics Insights query generator requests As many as five concurrent natural-language generated requests. Observability Access Manager (OAM) API request rates. 1 TPS per Region for PutSinkPolicy. 10 TPS per Region for each other CloudWatch OAM API. These quotas reflect the maximum number of operation requests you can make per second without being throttled. These quotas can't be changed. OAM source account links Each source account can be linked to as many as 5 monitoring accounts This quota can't be changed. OAM sinks 1 sink per Region per account This quota can't be changed. 3369 Amazon CloudWatch Resource Default quota User Guide PutCompositeAlarm request 3 TPS per Region. The maximum number of operation requests you can make per second without being PutMetricAlarm request PutMetricData request throttled. You can request a quota increase. 3 TPS per Region. The maximum number of operation requests you can make per second without being throttled. You can request a quota increase. 1MB for HTTP POST requests. PutMetricData can handle 500 transactions per second (TPS), which is the maximum number of operation requests that you can make per second without being throttled. PutMetric Data can handle 1,000 metrics per request. You can request a quota increase. Amazon Q Developer operational investigations investigations You can have as many as 20 active investigations. Only two of these investigations at a time can have active analysis currently happening. Amazon SNS email notifications 1,000/month/customer for free. Synthetics Groups 20 per account. TagResource This quota can't be changed. 20 TPS per Region. The maximum number of operation requests you can make per second without being throttled. This quota can't be changed. 3370 Amazon CloudWatch Resource UntagResource User Guide Default quota 20 TPS per Region. The maximum number of operation requests you can make per second without being throttled. This quota can't be changed. 3371 Amazon CloudWatch User Guide Document history The following table describes important changes for each release of the Amazon CloudWatch User Guide, beginning in June 2018. To receive notifications about updates to this documentation, you can subscribe to an RSS feed. Change Description Date CloudWatch Network Monitoring releases multiple Network Flow Monitor, a feature of CloudWatch account support for Network Network Monitoring, now May 6, 2025 Flow Monitor AmazonCloudWatchRU MReadOnlyAccess updated CloudWatch Synthetics deprecates five runtime metrics on October 1, 2025 supports monitoring network performance metrics for network flows for resources in multiple accounts. For more information, see Initialize Network Flow Monitor for multi-account monitoring. The rum:GetResourcePol icy permission was added so that CloudWatch RUM can view the resource policy attached to the RUM applicati on monitor. April 28, 2025 CloudWatch Synthetics April 4, 2025 metrics syn-nodejs- puppeteer-7.0 , syn- nodejs-puppeteer-6.2 , syn-nodejs-puppete er-5.2 , syn-python- selenium-3.0 , and syn- python-selenium-2.1 will be deprecated on October 1, 2025. 3372 Amazon CloudWatch
acw-ug-919
acw-ug.pdf
919
Monitoring, now May 6, 2025 Flow Monitor AmazonCloudWatchRU MReadOnlyAccess updated CloudWatch Synthetics deprecates five runtime metrics on October 1, 2025 supports monitoring network performance metrics for network flows for resources in multiple accounts. For more information, see Initialize Network Flow Monitor for multi-account monitoring. The rum:GetResourcePol icy permission was added so that CloudWatch RUM can view the resource policy attached to the RUM applicati on monitor. April 28, 2025 CloudWatch Synthetics April 4, 2025 metrics syn-nodejs- puppeteer-7.0 , syn- nodejs-puppeteer-6.2 , syn-nodejs-puppete er-5.2 , syn-python- selenium-3.0 , and syn- python-selenium-2.1 will be deprecated on October 1, 2025. 3372 Amazon CloudWatch User Guide Updated CloudWatchApplicat ionSignalsServiceRolePolicy CloudWatch updated the policy to exclude time March 13, 2025 policy Time window exclusions windows from impacting the SLO attainment rate, error budget, and burn rate metrics. CloudWatch can retrieve exclusion windows on behalf of you. For more information, see CloudWatc hApplicationSignalsServiceR olePolicy. SLOs adds support for time window exclusions which is a block of time with a defined start and end date. This time period is excluded from the SLO's performance metrics and you can schedule one-time or recurring time exclusions windows. For more information, see Service level objectives (SLOs). March 13, 2025 New AIOpsReadOnlyAccess policy CloudWatch added the December 3, 2024 AIOpsReadOnlyAccess policy, which grants read-only permissions for Amazon AI Operations and other related services. 3373 Amazon CloudWatch User Guide New AIOpsOperatorAccess policy New AIOpsConsoleAdminP olicy policy December 3, 2024 CloudWatch added the AIOpsOperatorAccess policy, which grants users access to Amazon AI Operations actions, and to additiona l AWS actions that are necessary for accessing investigation events. CloudWatch added the December 3, 2024 AIOpsConsoleAdminPolicy policy, which grants users full administrative access for managing Amazon Q investigations, including the management of trusted identity propagation, and the management of IAM Identity Center and organizational access. New AIOpsAssistantPolicy policy CloudWatch added the December 3, 2024 AIOpsAssistantBasicAccess policy, which you can assign to the Amazon AI Operation s assistant to enable the assistant to have basic functionality. 3374 Amazon CloudWatch User Guide Amazon Q Developer operational investigations feature in Preview CloudWatch released a Preview of Amazon Q Developer operational December 3, 2024 investigations. This feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generativ e AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue, to help you troubleshoot operational issues faster. CloudWatch updated both December 1, 2024 CloudWatchFullAccessV2 and CloudWatchFullAcce ss. Permissions for Amazon OpenSearch Service were added to to enable CloudWatch Logs integration with OpenSearch Service for some features. CloudWatch added the telemetry config feature to discover and understand the state of telemetry configura tion for your AWS resources. CloudWatch added the new AWSServiceRoleForObservabil ityAdmin service-linked role and AWSObservabilityAd minServiceRolePolicy policy. November 26, 2024 November 26, 2024 CloudWatchFullAccessV2 and CloudWatchFullAccess policies updated Telemetry config feature generally available New AWSServiceRoleForO bservabilityAdmin service-l inked role 3375 Amazon CloudWatch User Guide CloudWatch supports exploring related telemetry CloudWatch supports exploring related telemetry November 22, 2024 Updated CloudWatchSyntheti csFullAccess IAM policy data across interconnected resources. CloudWatch updated the November 21, 2024 CloudWatchSyntheti csFullAccess policy to grant CloudWatch Synthetics access to get AWS Lambda functions , and perform actions on logs available in CloudWatch Logs. Additionally, Lambda layer version actions apply to all CloudWatch Synthetics layer ARNs. New CloudWatch Synthetics support for Node.js with the CloudWatch Synthetics adds support for Node.js canary Playwright runtime scripts that use the Playwrigh November 21, 2024 t runtime. CloudWatchReadOnlyAccess policy updated The scope of the policy was changed to include the November 21, 2024 xray:List *, xray:Star , and tTraceRetrieval xray:CancelTraceRe trieval permissions. This change allows CloudWatch to access new X-Ray read APIs. For more infomration, see CloudWatchReadOnlyAccess. 3376 Amazon CloudWatch User Guide CloudWatch Transaction Search is generally available CloudWatch releases Transacti on Search, a search and November 21, 2024 analytics experience. Transacti on Search provides visibilit y into application transacti on issues. Explore interacti ons between application components to establish a root cause. Understand your application transactions and their impact on customers . Search transactions using terms like customer name or order. For more information, see CloudWatch Transaction Search. Application Signals supports Lambda functions You can now enable Applicati on Signals for Lambda November 21, 2024 OpenTelemetry Application Signals collects runtime metrics functions. You can use OpenTelemetry to directly send traces to an OpenTelemetry Protocol (OTLP) endpoint, and get out-of-the box application performance monitoring experiences in CloudWatch Application Signals. Application Signals now collects OpenTelemetry- compatible runtime metrics from your Java and Python applications. November 20, 2024 November 19, 2024 3377 Amazon CloudWatch User Guide Application Signals collects runtime metrics Application Signals now collects OpenTelemetry- November 19, 2024 compatible runtime metrics from your Java and Python applications. Internet traffic monitoring for VPCs in AWS Local Zones Internet Monitor now
acw-ug-920
acw-ug.pdf
920
Applicati on Signals for Lambda November 21, 2024 OpenTelemetry Application Signals collects runtime metrics functions. You can use OpenTelemetry to directly send traces to an OpenTelemetry Protocol (OTLP) endpoint, and get out-of-the box application performance monitoring experiences in CloudWatch Application Signals. Application Signals now collects OpenTelemetry- compatible runtime metrics from your Java and Python applications. November 20, 2024 November 19, 2024 3377 Amazon CloudWatch User Guide Application Signals collects runtime metrics Application Signals now collects OpenTelemetry- November 19, 2024 compatible runtime metrics from your Java and Python applications. Internet traffic monitoring for VPCs in AWS Local Zones Internet Monitor now supports internet traffic November 18, 2024 monitoring for VPCs deployed in AWS Local Zones Application Signals support for Node.js applications is CloudWatch supports enabling Node.js applications November 15, 2024 generally available for Application Signals. New CloudWatchInternet MonitorReadOnlyAccess IAM CloudWatch added a CloudWatchInternet November 14, 2024 policy MonitorReadOnlyAcc ess policy, to grant read- only access to actions and resources available in the CloudWatch console for Internet Monitor. CloudWatch added observabi lity solutions CloudWatch observability solutions offer a catalog of November 13, 2024 readily available configura tions to help you quickly implement monitoring for various AWS services and common workloads, such as Java Virtual Machines (JVM), Apache Kafka, Apache Tomcat, and NGINX. 3378 Amazon CloudWatch User Guide CloudWatch added burn rate monitoring for Application CloudWatch added burn rate monitoring to Application November 13, 2024 Signals SLOs Signals SLOs. A burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO. New Internet Monitor latency reduction suggestions Amazon CloudWatch Internet Monitor now provides November 1, 2024 through Route 53 routing actionable suggestions to updates New CloudWatchInternet MonitorFullAccess IAM policy End of support notice help you optimize your Route 53 IP-based routing configurations. Easily identify the optimal AWS Regions for routing your end user traffic, and then configure your Route 53 IP-based routing based on the recommend ations. CloudWatch added a October 23, 2024 CloudWatchInternet MonitorFullAccess policy, to grant full access to actions and resources available in the CloudWatch console for Internet Monitor. End of support notice: On October 16, 2025, AWS will discontinue support for CloudWatch Evidently. After October 16, 2025, you will no longer be able to access the Evidently console or Evidently resources. October 17, 2024 3379 User Guide October 17, 2024 October 16, 2024 October 16, 2024 Amazon CloudWatch End of support notice New CloudWatchLambdaAp plicationSignalsExecutionRo lePolicy IAM policy New CloudWatchLambdaAp plicationSignalsExecutionRo lePolicy IAM policy End of support notice: On October 16, 2025, AWS will discontinue support for CloudWatch Evidently. After October 16, 2025, you will no longer be able to access the Evidently console or Evidently resources. CloudWatch added a new policy named CloudWatc hLambdaApplication SignalsExecutionRolePolicy. This policy is used when CloudWatch Application Signals is enabled for Lambda workloads. It enables write access to X-Ray and the log group used by CloudWatch Application Signals. CloudWatch added a new policy named CloudWatc hLambdaApplication SignalsExecutionRolePolicy. This policy is used when CloudWatch Application Signals is enabled for Lambda workloads. It enables write access to X-Ray and the log group used by CloudWatch Application Signals. 3380 Amazon CloudWatch User Guide CloudWatchSyntheticsFullAcc ess policy updated October 11, 2024 Permissions were added to the CloudWatchSyntheti csFullAccess IAM policy. The lambda:ListTags , , lambda:TagResource and lambda:UntagResour ce permissions were added so that when you apply or change tags on a canary, you can choose to have Synthetic s also apply those same tags or changes to the Lambda function that the canary uses. Application Signals supports request-based SLOs Application Signals adds support for request-based September 6, 2024 service level objects (SLOs). For more information, see Service level objectives (SLOs). Internet Monitor refreshed dashboard and latency Amazon CloudWatch Internet Monitor has launched an August 12, 2024 improvement suggestions updated console experienc Application Signals previewin g support for .NET applicati ons e, including new features for visualizing configura tion changes that can help you reduce latency for your application. CloudWatch Application Signals has added support for .NET applications, with ADOT Instrumentation for .NET on supported platforms. This feature is in preview release. August 5, 2024 3381 Amazon CloudWatch User Guide New CloudWatch Applicati on Insights service linked role Allows CloudWatch Applicati on Insights to enable and July 25, 2024 permission added disable termination protectio n on AWS CloudFormation stacks. CloudWatch Metrics Insights support for natural language CloudWatch Metrics Insights supports natural language June 10, 2024 query generation is generally query to generate and update available. queries. For more informati on, see Use natural language to generate and update CloudWatch Metric Insights queries. CloudWatch Application Signals is generally available CloudWatch Application Signals is now generally June 10, 2024 available. Use Application Signals to instrument your applications on AWS so that you can monitor current application health,
acw-ug-921
acw-ug.pdf
921
service linked role Allows CloudWatch Applicati on Insights to enable and July 25, 2024 permission added disable termination protectio n on AWS CloudFormation stacks. CloudWatch Metrics Insights support for natural language CloudWatch Metrics Insights supports natural language June 10, 2024 query generation is generally query to generate and update available. queries. For more informati on, see Use natural language to generate and update CloudWatch Metric Insights queries. CloudWatch Application Signals is generally available CloudWatch Application Signals is now generally June 10, 2024 available. Use Application Signals to instrument your applications on AWS so that you can monitor current application health, create service level objectives (SLOs), and track long-term applicati on performance against your business objectives. For more information, see Application Signals. CloudWatch added a CloudWatchApplicat ionSignalsReadOnlyAccess policy to add read only actions and resources available in the CloudWatc h console for Application Signals. June 7, 2024 3382 New CloudWatchApplicat ionSignalsReadOnlyAccess IAM policy Amazon CloudWatch User Guide New CloudWatchApplicat ionSignalsFullAccess policy CloudWatch added a June 7, 2024 CloudWatchApplicat ionSignalsFullAccess policy to add actions and resources available in the CloudWatc h console for Application Signals. CloudTrail now captures API activities related to CloudWatch data plane operations. CloudTrail now logs events in CloudTrail for GetMetricData and GetMetricWidgetImage API activities. June 6, 2024 CloudWatch Application Signals service map supports The Application Signals preview release has added canary, RUM clients and AWS default groupings in the service dependency groupings service map for canaries, May 21, 2024 . RUM clients, and AWS service dependencies of the same type. This change reduces the number of icons in the service map default view to make it easier to view and navigate. 3383 Amazon CloudWatch User Guide CloudWatchReadOnlyAccess policy updated CloudWatchFullAccessV2 policy updated Lambda Insights supports AWS GovCloud (US-East) and AWS GovCloud (US-West) May 17, 2024 May 17, 2024 April 29, 2024 CloudWatch changed the scope of a permission in CloudWatchReadOnlyAccess. The scope of the policy added the application-signal s:BatchGet* , applicati on-signals:Get* , and application-signal s:List* actions so that users can use CloudWatch Application Signals to view, investigate, and diagnose issues with the health of their services. CloudWatch also added an iam:GetRole action so that users can check if Application Signals is set up. CloudWatch changed the scope of a permission in CloudWatchFullAccessV2. The scope of the policy added the application-signal s:* so that users can use CloudWatch Application Signals to view, investigate, and diagnose issues with the health of their services. CloudWatch Lambda Insights has added support for the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions. 3384 Amazon CloudWatch User Guide CloudWatch cross-account observability supports You can now create filters to specify which metric April 26, 2024 resource filters CloudWatch Application Signals updates April 26, 2024 namespaces and log groups are shared from the source account to the monitoring account, when you create the link between the accounts. The Application Signals preview release has added three features. Applicati on Signals now supports Python applications. It offers a simpler enablement process for applications on Amazon EKS architectures. And it includes new configurations that you can use to manage the cardinality of metrics that are collected. CloudWatch Container Insights with enhanced You can now use CloudWatc h Container Insights with April 23, 2024 observability for Amazon EKS enhanced observability for can collect AWS Elastic Fabric Amazon EKS collect AWS Adapter (EFA) metrics Elastic Fabric Adapter (EFA) metrics from Amazon EKS clusters. 3385 Amazon CloudWatch User Guide Updated IAM policy CloudWatch updated the April 18, 2024 CloudWatchApplicat ionSignalsServiceRolePolicy policy. The scoping of the logs:StartQuery and logs:GetQueryResults permissions in this policy was changed to add arn:aws:l ogs:*:*:log-group: /aws/appsignals/ *:* and "arn:aws: logs:*:*:log-group :/aws/application- to signals/data:*" enable Application Signals on more architecures. This policy is attached to the AWSServic eRoleForCloudWatch ApplicationSignals service-l inked role. Internet Monitor provides a global internet weather Amazon CloudWatch Internet Monitor now displays a global April 16, 2024 map to authenticated AWS internet weather map that is customers CloudWatch Container Insights with enhanced observability for Amazon EKS can collect AWS Neuron metrics available in the console to all authenticated AWS customers . To view the map, in the Amazon CloudWatch console, navigate to Internet Monitor. You can now use CloudWatc h Container Insights with enhanced observability for Amazon EKS collect AWS Neuron metrics from Amazon EKS clusters. April 16, 2024 3386 Amazon CloudWatch User Guide CloudWatch Application Signals adds a Service overview tab and more metrics to aid in diagnostics April 16, 2024 A new Service overview tab displays an overview of your service, including number of operations, dependencies, synthetics, and client pages. The tab shows key metrics for your entire service, and top operations and dependencies. You can also now view X-Ray traces that are correlated with issues including faults, errors, and latency problems. CloudWatch Container Insights with enhanced You can now use CloudWatc h Container
acw-ug-922
acw-ug.pdf
922
Amazon EKS collect AWS Neuron metrics from Amazon EKS clusters. April 16, 2024 3386 Amazon CloudWatch User Guide CloudWatch Application Signals adds a Service overview tab and more metrics to aid in diagnostics April 16, 2024 A new Service overview tab displays an overview of your service, including number of operations, dependencies, synthetics, and client pages. The tab shows key metrics for your entire service, and top operations and dependencies. You can also now view X-Ray traces that are correlated with issues including faults, errors, and latency problems. CloudWatch Container Insights with enhanced You can now use CloudWatc h Container Insights with observability for Amazon EKS enhanced observability for adds support for Windows Amazon EKS collect metrics April 10, 2024 CloudWatchApplicat ionSignalsServiceRolePolicy IAM policy updated Amazon CloudWatch Internet Monitor now supports cross- account observability from Windows worker nodes on Amazon EKS clusters. CloudWatch changed the scope of a permission in CloudWatchApplicat ionSignalsServiceRolePolicy . The scope of the cloudwatc h:GetMetricData permission was changed to * so that Application Signals can retrieve metrics from sources in linked accounts. You can now use Internet Monitor cross-account observability to monitor your applications that span multiple AWS accounts within a single AWS Region. April 8, 2024 March 29, 2024 3387 Amazon CloudWatch User Guide CloudWatchAgentSer verPolicy and CloudWatc hAgentAdminPolicy policies updated CloudWatch added permissio February 12, 2024 ns to both the CloudWatc hAgentServerPolicy and CloudWatchAgentAdm inPolicy policies to allow the CloudWatch agent to publish X-Ray traces and modify log group retention periods. In both policies, the xray:PutT raceSegments , xray:PutTelemetryR ecords , xray:GetS amplingRules , xray:GetSamplingTa rgets , xray:GetS amplingStatisticSu mmaries and logs:PutR etentionPolicy permissions were added 3388 Amazon CloudWatch User Guide New service linked role and IAM policy for CloudWatch CloudWatch added a new service-linked role, called December 22, 2023 Network Monitor AWSServiceRoleForN etworkMonitor. CloudWatc h added this new service-l inked role to allow you to create monitors to fetch network metrics between source subnets and destinati on IP addresses. The new CloudWatchNetworkM onitorServiceRolePolicy IAM policy is attached to this role, and the policy grants permission to CloudWatch to fetch network metrics on your behalf. CloudWatch releases Amazon CloudWatch Network Monitor CloudWatch released a new feature, Amazon CloudWatc December 22, 2023 h Network Monitor. This is a new active network monitorin g service that identifies if a network issues exists within the AWS network or your own company network. 3389 Amazon CloudWatch User Guide CloudWatchReadOnlyAccess policy updated CloudWatch added existing read-only permissions for December 5, 2023 CloudWatchFullAccessV2 policy updated CloudWatch Synthetics, X- Ray, and CloudWatch RUM and new read-only permissio ns for CloudWatch Applicati on Signals toCloudWatc hReadOnlyAccess so that users with this policy can triage and diagnose service health issues as reported by CloudWatch Applicati on Signals. The cloudwatc h:GenerateQuery permission was added so that users with this policy can generate a CloudWatch Metrics Insights query string from a natural language prompt. CloudWatch added existing permissions to CloudWatc hFullAccessV2 for CloudWatc h Synthetics, X-Ray, and CloudWatch RUM, and added new permissions for CloudWatch Application Signals so that users with this policy can fully manage Application Signals to triage and diagnose issues with service health. December 5, 2023 3390 Amazon CloudWatch User Guide New service-linked role and new IAM policy CloudWatch added a new service-linked role, called November 30, 2023 AWSServiceRoleForC loudWatchApplicati onSignals. CloudWatch added this new service-linked role to allow CloudWatch Application Signals to collect CloudWatc h Logs data, X-Ray trace data, CloudWatch metrics data, and tagging data from applications that you have enabled for CloudWatch Application Signals. The new CloudWatchApplicat ionSignalsServiceRolePolicy IAM policy is attached to this role, and the policy grants permission to CloudWatch Application Signals to collect monitoring and tagging data from other relevant AWS services. 3391 Amazon CloudWatch User Guide CloudWatch launches Preview release of Application Signals CloudWatch Application Signals is in Preview. Use November 30, 2023 Application Signals to instrument your applicati ons on AWS so that you can monitor current applicati on health, create service level objectives (SLOs), and track long-term application performance against your business objectives. For more information, see Application Signals. CloudWatch adds support for querying other data sources You can use CloudWatch to query, visualize, and create November 26, 2023 alarms for metrics from other data sources For more information, see Querying metrics from other data sources. CloudWatch Metrics Insights supports natural language CloudWatch Metrics Insights supports natural language query generation query to generate and update November 26, 2023 queries. For more informati on, see Use natural language to generate and update CloudWatch Metric Insights queries. 3392 Amazon CloudWatch User Guide CloudWatch releases Container Insights with CloudWatch released a new version of Container enhanced observability for Insights. This version supports November 6, 2023 Amazon EKS enhanced observability for Amazon EKS clusters and can collect more detailed metrics from clusters running Amazon EKS. After installat
acw-ug-923
acw-ug.pdf
923
other data sources For more information, see Querying metrics from other data sources. CloudWatch Metrics Insights supports natural language CloudWatch Metrics Insights supports natural language query generation query to generate and update November 26, 2023 queries. For more informati on, see Use natural language to generate and update CloudWatch Metric Insights queries. 3392 Amazon CloudWatch User Guide CloudWatch releases Container Insights with CloudWatch released a new version of Container enhanced observability for Insights. This version supports November 6, 2023 Amazon EKS enhanced observability for Amazon EKS clusters and can collect more detailed metrics from clusters running Amazon EKS. After installat ion, it automatically collects detailed infrastructure telemetry and container logs for your Amazon EKS clusters. You can then use curated, immediately usable dashboards to drill down into application and infrastructure telemetry. CloudWatch metric streams adds quick partner setup CloudWatch metric streams now provides a quick partner October 17, 2023 CloudWatch releases alarm recommendations October 16, 2023 setup option, which you can use to quickly set up a metric stream to some third-party providers. CloudWatch Synthetics now provides alarm recommend ations for metrics from other AWS services. These recommendations can help you identify the metrics that you should set alarms for to follow best practices for monitoring these services. 3393 Amazon CloudWatch User Guide CloudWatch Synthetics releases runtime syn-nodejs- CloudWatch Synthetics September 26, 2023 released runtime syn-nodej puppeteer-6.0 s-puppeteer-6.0 . Adds Amazon CloudWatch Application Insights support You can now share CloudWatc h Application Insights for cross-account applications applications across account September 26, 2023 boundaries. New service-linked role and new IAM policy CloudWatch added a new service-linked role, called September 20, 2023 AWSServiceRoleForC loudWatchMetrics_D bPerfInsights. CloudWatch added this new service-linked role to allow CloudWatch to fetch Performance Insights metrics for alarming, anomaly detection, and snapshott ing. The new AWSServic eRoleForCloudWatch Metrics_DbPerfInsightsServi ceRolePolicy IAM policy is attached to this role, and the policy grants permissio n to CloudWatch to fetch Performance Insights metrics on your behalf. CloudWatch added a new metric math function, DB_PERF_INSIGHTS , that you can use to fetch Performance Insights metrics from AWS database services for alarming, anomaly detection, and snapshotting. September 20, 2023 3394 Adds new metric math function Amazon CloudWatch User Guide CloudWatchReadOnlyAccess policy updated CloudWatch added the September 14, 2023 application-autosc aling:DescribeScal ingPolicies permissio n to CloudWatchReadOnly Access so that users with this policy can access informati on about Application Auto Scaling policies. August 8, 2023 August 1, 2023 CloudWatch agent added support for AL2023 The CloudWatch agent supports AL2023. New managed IAM policy, CloudWatchFullAccessV2 CloudWatch added a new policy CloudWatchFullAcce ssV2. This policy grants full access to CloudWatch actions and resources while better scoping the permissions granted to other services such as Amazon SNS and Amazon EC2 Auto Scaling. Updated service linked role for Amazon CloudWatch Internet Monitor – update to an existing policy Adds new permissions, July 25, 2023 elasticloadbalanci ng:DescribeLoadBal ancers and ec2:Descr ibeNetworkInterfac es , to the service linked role for Internet Monitor, to support monitoring traffic for specific Network Load Balancer resources. 3395 Amazon CloudWatch User Guide Added support for Network Load Balancer resources in Adds support for creating a monitor in Internet Monitor Amazon CloudWatch Internet with specific Network Load July 25, 2023 Monitor Dashboard variables feature Internet Monitor now supports customizing the threshold for health events June 28, 2023 June 26, 2023 Balancer resources, to provide more granular levels of observability for your application. CloudWatch released dashboard variables, which you can use to create flexible dashboards that can quickly display different contents depending on how you set one input field within the dashboard. For example, you can create a dashboard that can quickly switch between different Lambda functions or Amazon EC2 instance IDs, or one that can switch to different AWS Regions. For more information, see Create flexible dashboards with dashboard variables. Internet Monitor added the ability to customize the threshold for when a global performance score or availabil ity score triggers a heath event. For more informati on, see Tracking real-time performance and availabil ity in Amazon CloudWatch Internet Monitor. 3396 Amazon CloudWatch User Guide Internet Monitor now supports all commercial Internet Monitor added seven new AWS Regions and now June 19, 2023 Regions supports all commercial Regions. New Lambda Insights extension versions CloudWatch added the 1.0.229.0 version of the June 12, 2023 CloudWatchReadOnlyAccess policy updated June 6, 2023 Lambda Insights extension for both x86-64 platforms and ARM64 platforms. For more information, see Available versions of the Lambda Insights extension. CloudWatch added permissions to CloudWatc hReadOnlyAccess. The logs:StartLiveTail and logs:StopLiveTail permissions were added so that users with this policy can use the console to start and stop CloudWatch Logs live tail sessions. For more informati on, see Use live tail to view logs in near real time. 3397 Amazon CloudWatch User Guide CloudWatch RUM adds support for custom metrics
acw-ug-924
acw-ug.pdf
924
Lambda Insights extension versions CloudWatch added the 1.0.229.0 version of the June 12, 2023 CloudWatchReadOnlyAccess policy updated June 6, 2023 Lambda Insights extension for both x86-64 platforms and ARM64 platforms. For more information, see Available versions of the Lambda Insights extension. CloudWatch added permissions to CloudWatc hReadOnlyAccess. The logs:StartLiveTail and logs:StopLiveTail permissions were added so that users with this policy can use the console to start and stop CloudWatch Logs live tail sessions. For more informati on, see Use live tail to view logs in near real time. 3397 Amazon CloudWatch User Guide CloudWatch RUM adds support for custom metrics You can use CloudWatch RUM app monitors to create February 9, 2023 custom metrics and send them to CloudWatch and CloudWatch Evidently. This feature includes an update to the AmazonCloudWatchRU MServiceRolePolicy managed IAM policy. In that policy, a condition key was changed so that CloudWatch RUM can send custom metrics to custom metric namespaces. New and updated managed polices for CloudWatch To support CloudWatch cross- account observability, the February 7, 2023 CloudWatchFullAccess and CloudWatchReadOnly Access policies have been updated, and the following new managed policies have been added: CloudWatc hCrossAccountShari , ngConfiguration OAMFullAccess , and OAMReadOnlyAccess . For more information, see CloudWatch updates to AWS managed policies. CloudWatch Application Insights service-linked role policy updates — update to an existing policy. CloudWatch Application Insights updated an existing AWS service-linked role policy. December 19, 2022 3398 Amazon CloudWatch User Guide Amazon CloudWatch Application Insights support You can display CloudWatch Application Insights detected November 17, 2021 for containerized applications problems for Amazon ECS and microservices from the and Amazon EKS on your Container Insights console. Container Insights dashboard. Amazon CloudWatch Application Insights monitorin You can monitor SAP HANA databases with Application November 15, 2021 g for SAP HANA databases. Insights. Amazon CloudWatch Application Insights support You can onboard and monitor all resources in an account. September 15, 2021 for monitoring all resources in an account. Amazon CloudWatch Application Insights support You can monitor metrics retrieved from Amazon FSx. August 31, 2021 for Amazon FSx. SDK Metrics is no longer supported. CloudWatch SDK Metrics is no longer supported. August 25, 2021 Amazon CloudWatch Application Insights support You can monitor container s using best practices with May 18, 2021 for setting up container Amazon CloudWatch Applicati monitoring. on Insights. Metric streams is generally available March 31, 2021 You can use metric streams to continually stream CloudWatc h metrics to a destination of your choice. For more information, see Metric streams in the Amazon CloudWatch User Guide. 3399 Amazon CloudWatch User Guide Amazon CloudWatch Application Insights monitorin You can monitor metrics and logs retrieved from Oracle g for Oracle databases on with Amazon CloudWatch Amazon RDS and Amazon Application Insights. EC2. January 16, 2021 Lambda Insights is generally available CloudWatch Lambda Insights is a monitoring and troublesh December 3, 2020 ooting solution for serverless applications running on AWS Lambda. For more informati on, see Using Lambda Insights in the Amazon CloudWatch User Guide. Amazon CloudWatch Application Insights monitorin You can monitor metrics retrieved from Prometheus g for Prometheus JMX JMX exporter with Amazon exporter metrics. CloudWatch Application Insights. November 20, 2020 CloudWatch Synthetics releases new runtime version CloudWatch Synthetics has released a new runtime September 11, 2020 version. For more informati on, see Canary Runtime Versions in the Amazon CloudWatch User Guide. Amazon CloudWatch Application Insights monitorin g for Postgre SQL on Amazon RDS and Amazon EC2. You can monitor applications built with PostgreSQL running on Amazon RDS or Amazon EC2. September 11, 2020 3400 User Guide September 10, 2020 Amazon CloudWatch CloudWatch supports dashboard sharing You can now share CloudWatc h dashboards with people outside of your organization and AWS account. For more information, see Sharing CloudWatch Dashboards in the Amazon CloudWatch User Guide. Set up monitors for .NET applications using SQL You can use the documenta tion tutorial to help you to set August 19, 2020 Server on the backend with up monitors for .NET applicati CloudWatch Application ons using SQL Server on the Insights backend with CloudWatch Application Insights. AWS CloudFormation support for Amazon CloudWatch You can add CloudWatch Application Insights monitorin July 30, 2020 Application Insights applicati g, including key metrics and ons. telemetry, to your applicati on, database, and web server, directly from AWS CloudForm ation templates. Amazon CloudWatch Application Insights monitorin You can monitor Aurora for MySQL database clusters g for Aurora for MySQL (RDS Aurora) with Amazon July 2, 2020 database clusters. CloudWatch Application Insights. 3401 Amazon CloudWatch User Guide CloudWatch Contributor Insights general availability CloudWatch Contributor Insights is now generally April 2, 2020 available. It enables you to analyze log data and create time series that display contributor data. You can see metrics about the top- N contributors, the total number of unique contribut ors, and their usage.
acw-ug-925
acw-ug.pdf
925
ons. telemetry, to your applicati on, database, and web server, directly from AWS CloudForm ation templates. Amazon CloudWatch Application Insights monitorin You can monitor Aurora for MySQL database clusters g for Aurora for MySQL (RDS Aurora) with Amazon July 2, 2020 database clusters. CloudWatch Application Insights. 3401 Amazon CloudWatch User Guide CloudWatch Contributor Insights general availability CloudWatch Contributor Insights is now generally April 2, 2020 available. It enables you to analyze log data and create time series that display contributor data. You can see metrics about the top- N contributors, the total number of unique contribut ors, and their usage. For more information, see Using Contributor Insights to Analyze High-Cardinality Data in the Amazon CloudWatch User Guide. CloudWatch Synthetics public preview CloudWatch Synthetics is now in public preview. It enables November 25, 2019 you to create canaries to monitor your endpoints and APIs. For more information, see Using Canaries in the Amazon CloudWatch User Guide. 3402 Amazon CloudWatch User Guide CloudWatch Contributor Insights public preview CloudWatch launches ServiceLens feature November 25, 2019 November 21, 2019 CloudWatch Contributor Insights is now in public preview. It enables you to analyze log data and create time series that display contributor data. You can see metrics about the top- N contributors, the total number of unique contribut ors, and their usage. For more information, see Using Contributor Insights to Analyze High-Cardinality Data in the Amazon CloudWatch User Guide. ServiceLens ehances the observability of your services and applications by enabling you to integrate traces, metrics, logs, and alarms into one place. ServiceLens integrates CloudWatch with AWS X-Ray to provide an end- to-end view of your applicati on. 3403 Amazon CloudWatch User Guide Use CloudWatch to proactive ly manage your AWS service You can use CloudWatch to proactively manage your AWS November 19, 2019 quotas service quotas. CloudWatch usage metrics provide visibilit y into your account's usage of resources and API operation s. For more information, see Service Quotas Integration and Usage Metrics in the Amazon CloudWatch User Guide. CloudWatch sends events when alarms change state CloudWatch now sends an event to Amazon EventBrid October 8, 2019 Container Insights August 30, 2019 ge when any CloudWatch alarm changes state. For more information, see Alarm Events and EventBridge in the Amazon CloudWatch User Guide. CloudWatch Container Insights is now generally available. It enables you to collect, aggregate, and summarize metrics and logs from your containerized applications and microserv ices. For more information, see Using Container Insights in the Amazon CloudWatch User Guide. 3404 Amazon CloudWatch User Guide Updates for Container Insights preview metrics on The Container Insights on Amazon EKS and Kubernete Amazon EKS and Kubernetes s public preview has been August 19, 2019 updated. InstanceId is now included as a dimension to the cluster EC2 instances . This allows alarms that have been created on these metrics to trigger the following EC2 actions: Stop, Terminate, Reboot, or Recover. Additionally, pod and service metrics are now reported by Kubernete s namespace to simplify the monitoring and alarming on metrics by namespace. Updates for AWS Systems Manager OpsCenter integrati Updates on how CloudWatch Application Insights integrate August 7, 2019 on CloudWatch usage metrics August 6, 2019 s with Systems Manager OpsCenter. CloudWatch usage metrics help you track the usage of your CloudWatch resources and stay within your service limits. For more informati on, see https://docs.aws. amazon.com/Amazon CloudWatch/latest/monitor ing/CloudWatch-Usage-Metri cs.html. 3405 User Guide July 9, 2019 Amazon CloudWatch CloudWatch Container Insights public preview CloudWatch Container Insights is now in public preview. It enables you to collect, aggregate, and summarize metrics and logs from your containerized applications and microserv ices. For more information, see Using Container Insights in the Amazon CloudWatch User Guide. CloudWatch Anomaly Detection public preview CloudWatch anomaly detection is now in public July 9, 2019 CloudWatch Application Insights for .NET and SQL Server preview. CloudWatch applies machine-learning algorithm s to a metric's past data to create a model of the metric's expected values. You can use this model for visualiza tion and for setting alarms. For more information, see Using CloudWatch Anomaly Detection in the Amazon CloudWatch User Guide. CloudWatch Application Insights for .NET and SQL Server facilitates observabi lity for .NET and SQL Server applications. It can help you set up the best monitors for your application resources to continuously analyze data for signs of problems with your applications. June 21, 2019 3406 Amazon CloudWatch User Guide CloudWatch agent section re- organized The CloudWatch agent documentation has been March 28, 2019 rewritten to improve clarity, especially for customers using the command line to install and configure the agent. For more information, see Collecting Metrics and Logs from Amazon EC2 Instances and On-Premises Servers with the CloudWatch Agent in the Amazon CloudWatch User Guide. SEARCH function added to metric math expressions You can now use a SEARCH
acw-ug-926
acw-ug.pdf
926
can help you set up the best monitors for your application resources to continuously analyze data for signs of problems with your applications. June 21, 2019 3406 Amazon CloudWatch User Guide CloudWatch agent section re- organized The CloudWatch agent documentation has been March 28, 2019 rewritten to improve clarity, especially for customers using the command line to install and configure the agent. For more information, see Collecting Metrics and Logs from Amazon EC2 Instances and On-Premises Servers with the CloudWatch Agent in the Amazon CloudWatch User Guide. SEARCH function added to metric math expressions You can now use a SEARCH function in metric math March 21, 2019 AWS SDK Metrics for Enterpris e Support expressions. This enables you to create dashboards that update automatically as new resources are created that match the search query. For more information, see Using Search Expressions in Graphs in the Amazon CloudWatch User Guide. SDK Metrics helps you assess the health of your AWS services and diagnose latency caused by reaching your account usage limits or by a service outage. For more information, see Monitor Applications Using AWS SDK Metrics in the Amazon CloudWatch User Guide. December 11, 2018 3407 Amazon CloudWatch User Guide Alarms on math expressions November 20, 2018 CloudWatch supports creating alarms based on metric math expressions. For more information, see Alarms on Math Expressions in the Amazon CloudWatch User Guide. New CloudWatch console home page Amazon has created a new home page in the CloudWatc November 19, 2018 h console, which automatic ally displays key metrics and alarms for all the AWS services you are using. For more information, see Getting Started with Amazon CloudWatch in the Amazon CloudWatch User Guide. AWS CloudFormation templates for the CloudWatch Amazon has uploaded AWS CloudFormation templates November 9, 2018 Agent that you can use to install and update the CloudWatc h agent. For more informati on, see Install the CloudWatc h Agent on New Instances Using AWS CloudFormation in the Amazon CloudWatch User Guide. 3408 User Guide September 28, 2018 Amazon CloudWatch Enhancements to the CloudWatch Agent The CloudWatch agent has been updated to work with both the StatsD and collectd protocols. It also has improved cross-account support. For more informati on, see Retrieve Custom Metrics with StatsD, Retrieve Custom Metrics with collectd, and Sending Metrics and Logs to a Different AWS Account in the Amazon CloudWatch User Guide. Support for Amazon VPC endpoints You can now establish a private connection between June 28, 2018 your VPC and CloudWatc h. For more information, see Using CloudWatch with Interface VPC Endpoints in the Amazon CloudWatch User Guide. The following table describes important changes to the Amazon CloudWatch User Guide before June 2018. Change Description Metric math You can now perform math expressions on CloudWatch metrics, producing new time series that you can add to graphs on your dashboard. For more information, see Using math expressions with CloudWatch metrics. Release date April 4, 2018 "M out of N" alarms You can now configure an alarm to trigger based on "M out of N" datapoints in any alarm evaluatio December 8, 2017 3409 Amazon CloudWatch User Guide Change Description Release date n interval. For more information, see Evaluating an alarm. CloudWatch agent A new unified CloudWatch agent was released. You can use the unified multi-platform agent to September 7, 2017 collect custom both system metrics and log files from Amazon EC2 instances and on-premises servers. The new agent supports both Windows and Linux and enables customization of metrics collected, including sub-resource metrics such as per-CPU core. For more information, see Collect metrics, logs, and traces with the CloudWatch agent. NAT gateway metrics Added metrics for Amazon VPC NAT gateway. September 7, 2017 High-resolution metrics You can now optionally set up custom metrics as high-resolution metrics, with a granularity of July 26, 2017 as low as one second. For more information, see High-resolution metrics. You can now create, modify, and delete dashboards using APIs and the AWS CLI. For more information, see Creating a customized CloudWatch dashboard. July 6, 2017 Added metrics for AWS Direct Connect. June 29, 2017 Added metrics for Amazon VPC VPN. May 15, 2017 Added metrics for AppStream 2.0. March 8, 2017 Dashboard APIs AWS Direct Connect metrics Amazon VPC VPN metrics AppStream 2.0 metrics 3410 Amazon CloudWatch User Guide Change Description CloudWatch console color You can now choose the color for each metric on your dashboard widgets. For more information, picker see Editing a graph on a CloudWatch dashboard . Release date February 27, 2017 Alarms on dashboards Alarms can now be added to dashboards. For more information, see Adding an alarm to a February 15, 2017 CloudWatch dashboard. Added metrics for Amazon Polly Added metrics for Amazon Polly. December 1, 2016 Added metrics for Amazon Added metrics for Amazon Managed Service for
acw-ug-927
acw-ug.pdf
927
AWS Direct Connect metrics Amazon VPC VPN metrics AppStream 2.0 metrics 3410 Amazon CloudWatch User Guide Change Description CloudWatch console color You can now choose the color for each metric on your dashboard widgets. For more information, picker see Editing a graph on a CloudWatch dashboard . Release date February 27, 2017 Alarms on dashboards Alarms can now be added to dashboards. For more information, see Adding an alarm to a February 15, 2017 CloudWatch dashboard. Added metrics for Amazon Polly Added metrics for Amazon Polly. December 1, 2016 Added metrics for Amazon Added metrics for Amazon Managed Service for Apache Flink. December 1, 2016 Managed Service for Apache Flink Added support for percentile You can specify any percentile, using up to two decimal places (for example, p95.45). For more November 17, 2016 statistics information, see Percentiles. Added metrics for Amazon Simple Email Service. November 2, 2016 Added metrics for Amazon Simple Email Service Updated metrics retention Amazon CloudWatch now retains metrics data for 15 months instead of 14 days. November 1, 2016 Updated metrics console interface The CloudWatch console is updated with improvements to existing functionality and new functionality. November 1, 2016 Added metrics for Amazon Elastic Transcoder. September 20, 2016 Added metrics for Amazon Elastic Transcoder 3411 Amazon CloudWatch User Guide Change Description Release date Added metrics for Amazon API Gateway Added metrics for AWS Key Management Service Added metrics for the new Application Load Balancers supported by Elastic Load Balancing Added new NetworkPa cketsIn and NetworkPa cketsOut metrics for Amazon EC2 Added new metrics for Amazon EC2 Spot fleet Added new CloudWatch Logs metrics Added metrics for Amazon API Gateway. September 9, 2016 Added metrics for AWS Key Management Service. September 9, 2016 Added metrics for Application Load Balancers. August 11, 2016 Added new NetworkPacketsIn and NetworkPa cketsOut metrics for Amazon EC2. March 23, 2016 Added new metrics for Amazon EC2 Spot fleet. March 21, 2016 Added new CloudWatch Logs metrics. March 10, 2016 3412 Amazon CloudWatch User Guide Change Description Added Amazon OpenSearch Added Amazon OpenSearch Service and AWS WAF metrics and dimensions. Release date October 14, 2015 Service and AWS WAF metrics and dimensions Added support for CloudWatch Dashboards are customizable home pages in the CloudWatch console that you can use to monitor October 8, 2015 dashboards your resources in a single view, even those that are spread out across different Regions. For more information, see Using Amazon CloudWatch dashboards. Added AWS Lambda metrics and dimensions. September 4, 2015 Added AWS Lambda metrics and dimensions Added Amazon Elastic Container Added Amazon Elastic Container Service metrics and dimensions. August 17, 2015 Service metrics and dimensions Added Amazon Simple Storage Service metrics and dimensions New feature: Reboot alarm action Added Amazon WorkSpaces metrics and dimensions Added Amazon Simple Storage Service metrics and dimensions. July 26, 2015 Added the reboot alarm action and new IAM role for use with alarm actions. For more information, see Create alarms to stop, terminate, reboot, or recover an EC2 instance. July 23, 2015 Added Amazon WorkSpaces metrics and dimensions. April 30, 2015 3413 Amazon CloudWatch User Guide Change Description Added Amazon Machine Added Amazon Machine Learning metrics and dimensions. Learning metrics and dimensions New feature: Amazon EC2 Updated alarm actions to include new EC2 instance recovery action. For more information, instance see Create alarms to stop, terminate, reboot, or recovery alarm recover an EC2 instance. actions Release date April 9, 2015 March 12, 2015 Added Amazon CloudFront Added Amazon CloudFront and Amazon CloudSearch metrics and dimensions. March 6, 2015 and Amazon CloudSearch metrics and dimensions Added Amazon Simple Added Amazon Simple Workflow Service metrics and dimensions. May 9, 2014 Workflow Service metrics and dimensions Updated guide to add support for AWS CloudTrail Added a new topic to explain how you can use AWS CloudTrail to log activity in Amazon CloudWatch. For more information, see Logging Amazon CloudWatch API and console operations with AWS CloudTrail. April 30, 2014 3414 Amazon CloudWatch User Guide Change Description Updated guide to use the new The AWS CLI is a cross-service CLI with a simplifie d installation, unified configuration, and consisten AWS Command t command line syntax. The AWS CLI is supported Line Interface on Linux/Unix, Windows, and Mac. The CLI (AWS CLI) examples in this guide have been updated to use the new AWS CLI. Release date February 21, 2014 For information about how to install and configure the new AWS CLI, see Getting Set Up with the AWS CLI Interface in the AWS Command Line Interface User Guide. Added Amazon Redshift and AWS OpsWorks metrics and dimensions. July 16, 2013 Added Amazon Route 53 metrics and dimensions. June 26, 2013 Added Amazon Redshift and AWS OpsWorks metrics and dimensions Added Amazon Route 53 metrics and dimensions New feature: Amazon Added a new section to document
acw-ug-928
acw-ug.pdf
928
and Mac. The CLI (AWS CLI) examples in this guide have been updated to use the new AWS CLI. Release date February 21, 2014 For information about how to install and configure the new AWS CLI, see Getting Set Up with the AWS CLI Interface in the AWS Command Line Interface User Guide. Added Amazon Redshift and AWS OpsWorks metrics and dimensions. July 16, 2013 Added Amazon Route 53 metrics and dimensions. June 26, 2013 Added Amazon Redshift and AWS OpsWorks metrics and dimensions Added Amazon Route 53 metrics and dimensions New feature: Amazon Added a new section to document Amazon CloudWatch alarm actions, which you can use to January 8, 2013 CloudWatch stop or terminate an Amazon Elastic Compute Alarm Actions Cloud instance. For more information, see Create alarms to stop, terminate, reboot, or recover an EC2 instance. Updated EBS metrics Updated the EBS metrics to include two new metrics for Provisioned IOPS volumes. November 20, 2012 3415 Amazon CloudWatch User Guide Change Description New billing alerts You can now monitor your AWS charges using Amazon CloudWatch metrics and create alarms to Release date May 10, 2012 notify you when you have exceeded the specified threshold. For more information, see Create a billing alarm to monitor your estimated AWS charges. New metrics You can now access six new Elastic Load Balancing metrics that provide counts of various HTTP October 19, 2011 response codes. New feature You can now access metrics from Amazon EMR. June 30, 2011 New feature You can now access metrics from Amazon Simple Notification Service and Amazon Simple Queue July 14, 2011 Service. New Feature Added information about using the PutMetric Data API to publish custom metrics. For more information, see Publish custom metrics. May 10, 2011 Updated metrics retention Amazon CloudWatch now retains the history of an alarm for two weeks rather than six weeks. April 7, 2011 New feature With this change, the retention period for alarms matches the retention period for metrics data. Added ability to send Amazon Simple Notificat ion Service or Auto Scaling notifications when a metric has crossed a threshold. For more information, see Alarms. December 2, 2010 New feature A number of CloudWatch actions now include the MaxRecords and NextToken parameters, which enable you to control pages of results to display. December 2, 2010 3416 Amazon CloudWatch User Guide Change Description New feature This service now integrates with AWS Identity and Access Management (IAM). Release date December 2, 2010 3417
administration-guide-001
administration-guide.pdf
1
Administration Guide Amazon WorkSpaces Secure Browser Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Secure Browser Administration Guide Amazon WorkSpaces Secure Browser: Administration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Secure Browser Table of Contents Administration Guide What is Amazon WorkSpaces Secure Browser? ............................................................................. 1 Release history .............................................................................................................................................. 1 Terms to know .............................................................................................................................................. 2 Related services ............................................................................................................................................ 4 Architecture .................................................................................................................................................... 4 Access .............................................................................................................................................................. 5 Setting up ........................................................................................................................................ 6 Signing up and creating a user ................................................................................................................. 6 Sign up for an AWS account ................................................................................................................ 6 Create a user with administrative access ........................................................................................... 6 Granting programmatic access .................................................................................................................. 8 Networking ..................................................................................................................................................... 9 VPC setup .................................................................................................................................................. 9 User connections ................................................................................................................................... 25 Getting started .............................................................................................................................. 28 Web portal creation ................................................................................................................................... 28 Network settings ................................................................................................................................... 29 Portal settings ....................................................................................................................................... 29 User settings .......................................................................................................................................... 31 Identity provider configuration .......................................................................................................... 32 Launch ..................................................................................................................................................... 42 Web portal testing ..................................................................................................................................... 43 Web portal distribution ............................................................................................................................ 44 Managing your web portal ........................................................................................................... 45 Viewing web portal details ...................................................................................................................... 45 Editing a web portal .................................................................................................................................. 46 Deleting a web portal ............................................................................................................................... 46 Managing service quotas .......................................................................................................................... 46 Requesting a service quota increase ................................................................................................. 48 Requesting a portal increase .............................................................................................................. 48 Requesting a maximum concurrent sessions increase .................................................................. 49 Limit example ........................................................................................................................................ 49 Other service quotas ............................................................................................................................ 50 Re-authenticating a SAML IdP token ..................................................................................................... 50 iii Amazon WorkSpaces Secure Browser Administration Guide Setting up user access logging ............................................................................................................... 51 Log examples ......................................................................................................................................... 53 Managing browser policy ......................................................................................................................... 54 Tutorial: Setting a custom browser policy ....................................................................................... 55 Editing the baseline browser policy .................................................................................................. 61 Configuring the Input Method Editor .................................................................................................... 62 Configuring in-session localization ......................................................................................................... 63 Supported language codes ................................................................................................................. 64 User browser settings .......................................................................................................................... 66 Managing IP access controls .................................................................................................................... 67 Creating an IP access control group ................................................................................................. 68 Associating an IP access setting ........................................................................................................ 68 Editing an IP access control group .................................................................................................... 69 Deleting an IP access control group ................................................................................................. 69 Managing the single sign-on extension ................................................................................................ 70 Identifying domains for the single sign-on extension .................................................................. 71 Adding the single sign-on extension to a new web portal .......................................................... 71 Adding the single sign-on extension to an existing web portal .................................................. 72 Editing or removing the single sign-on extension ......................................................................... 72 Setting up URL filtering ........................................................................................................................... 72 Setting up URL filtering using the console ..................................................................................... 73 Setting up URL filtering using the JSON editor or file upload .................................................... 74 Deep links .................................................................................................................................................... 74 Setting up deep links ........................................................................................................................... 75 Using URL filtering for deep links ..................................................................................................... 75 Session management dashboard ............................................................................................................ 75 Dashboard access .................................................................................................................................. 75 Dashboard filters ................................................................................................................................... 76 Terminate sessions ................................................................................................................................ 76 Session history ...................................................................................................................................... 76 Protecting data in transit ......................................................................................................................... 77 Data protection settings ........................................................................................................................... 78 Inline data redaction ............................................................................................................................ 78 Default redaction configuration ........................................................................................................ 80 Base inline redaction ............................................................................................................................ 81 Custom inline redaction ...................................................................................................................... 83 iv Amazon WorkSpaces Secure Browser Administration Guide Create data protection settings ......................................................................................................... 84 Associate data protection settings .................................................................................................... 84 Edit data protection settings ............................................................................................................. 86 Delete data protection settings ......................................................................................................... 86 Toolbar controls .......................................................................................................................................... 86 Security .......................................................................................................................................... 88 Data protection ........................................................................................................................................... 89 Data encryption ..................................................................................................................................... 90 Inter-network traffic privacy .............................................................................................................. 99 User access logging .............................................................................................................................. 99 Identity and Access Management ........................................................................................................... 99 Audience ............................................................................................................................................... 100 Authenticating with identities ......................................................................................................... 100 Managing access using policies ....................................................................................................... 104 How Amazon WorkSpaces Secure Browser works with IAM ...................................................... 106 Identity-based policy examples ....................................................................................................... 113 AWS managed policies ...................................................................................................................... 116 Troubleshooting .................................................................................................................................. 126 Using service-linked roles ................................................................................................................. 127 Incident response ..................................................................................................................................... 131 Compliance validation ............................................................................................................................ 132 Resilience ................................................................................................................................................... 133 Infrastructure security ............................................................................................................................. 133 Configuration and vulnerability analysis ............................................................................................ 134 Interface VPC endpoint (AWS PrivateLink) ......................................................................................... 134 Considerations for Amazon WorkSpaces Secure Browser .......................................................... 135 Creating an interface VPC endpoint for Amazon WorkSpaces Secure Browser ..................... 135 Creating an endpoint policy for your interface VPC endpoint .................................................. 136 Troubleshooting .................................................................................................................................. 136 Security best practices ............................................................................................................................ 137 Monitoring ................................................................................................................................... 139 Monitoring with CloudWatch ................................................................................................................ 139 CloudTrail logs .......................................................................................................................................... 141 Information in CloudTrail .................................................................................................................. 141 Log file entries .................................................................................................................................... 142 User access logging ................................................................................................................................. 144 v Amazon WorkSpaces Secure Browser Administration Guide User guidance .............................................................................................................................. 145 Browser and device compatibility ........................................................................................................ 145 Web portal access .................................................................................................................................... 146 Session guidance ...................................................................................................................................... 146 Starting a session ............................................................................................................................... 146 Using the toolbar ............................................................................................................................... 147 Using the browser .............................................................................................................................. 150 Ending a session ................................................................................................................................. 150 Troubleshooting user issues .................................................................................................................. 151 Single sign-on extension ........................................................................................................................ 152 Single sign-on extension compatibility ..........................................................................................
administration-guide-002
administration-guide.pdf
2
VPC endpoint .................................................. 136 Troubleshooting .................................................................................................................................. 136 Security best practices ............................................................................................................................ 137 Monitoring ................................................................................................................................... 139 Monitoring with CloudWatch ................................................................................................................ 139 CloudTrail logs .......................................................................................................................................... 141 Information in CloudTrail .................................................................................................................. 141 Log file entries .................................................................................................................................... 142 User access logging ................................................................................................................................. 144 v Amazon WorkSpaces Secure Browser Administration Guide User guidance .............................................................................................................................. 145 Browser and device compatibility ........................................................................................................ 145 Web portal access .................................................................................................................................... 146 Session guidance ...................................................................................................................................... 146 Starting a session ............................................................................................................................... 146 Using the toolbar ............................................................................................................................... 147 Using the browser .............................................................................................................................. 150 Ending a session ................................................................................................................................. 150 Troubleshooting user issues .................................................................................................................. 151 Single sign-on extension ........................................................................................................................ 152 Single sign-on extension compatibility .......................................................................................... 153 Installing the single sign-on extension .......................................................................................... 153 Troubleshooting the single sign-on extension ............................................................................. 153 Document history ........................................................................................................................ 155 vi Amazon WorkSpaces Secure Browser Administration Guide What is Amazon WorkSpaces Secure Browser? Note Amazon WorkSpaces Secure Browser was previously known as Amazon WorkSpaces Web. Amazon WorkSpaces Secure Browser is a fully managed, cloud-native, hosted browser service used to securely access private websites and software-as-a-service (SaaS) web applications, interact with online resources, and browse the internet from a disposable container. WorkSpaces Secure Browser works with a user's existing web browsers, without burdening IT with managing appliances, infrastructure, specialized client software, or virtual private network (VPN) connections. Web content is streamed to the user's web browser, while the actual browser and web content is isolated in AWS. By using the same underlying technologies that power AWS End User Computing services like Amazon WorkSpaces and Amazon AppStream 2.0, WorkSpaces Secure Browser can be more cost effective than traditional virtual desktops, and reduce complexity compared to providing company-owned devices with management software. WorkSpaces Secure Browser reduces the risk of data exfiltration by streaming web content. No HTML, document object model (DOM), or sensitive company data is transmitted to the local machine. By isolating the device, corporate network, and internet from each other, the browser attack surface is virtually eliminated. You can enforce enterprise browser policy (including URL allow/blocking) on all sessions, and includes session-level controls for clipboard, file transfer, and printer. You can also restrict access to trusted networks or devices by using IP Access Controls. WorkSpaces Secure Browser is easy to set up and operate. Each session launches with a fresh and fully patched version of the Chrome Browser, with company policies and settings applied. Release history for Amazon WorkSpaces Secure Browser On May 20, 2024, Amazon WorkSpaces Web was renamed to Amazon WorkSpaces Secure Browser. For existing customers, there was no change to how they manage users or resources with the service. The following list describes the applicable updates that also took place as a result of this rename. The workspaces-web API namespace remains unchanged for backward compatibility. As a result, the following resources are still the same: Release history 1 Amazon WorkSpaces Secure Browser • CLI commands. Administration Guide • Amazon CloudWatch metrics. For more information, see the section called “Monitoring with CloudWatch”. • Service endpoints. For more information, see Amazon WorkSpaces Secure Browser endpoints and quotas. • AWS CloudFormation resources. For more information, see Amazon WorkSpaces Secure Browser resource type reference. • Service-linked role containing workspaces-web. For more information, see the section called “Using service-linked roles”. • Console URLs containing workspaces-web. • Documentation URLs containing workspaces-web. For more information, see Amazon WorkSpaces Secure Browser Documentation. • Existing ReadOnly managed role. For more information, see the section called “AWS managed policies”. • KMS grant name. • UAL(User-Activity Logging) Kinesis stream prefix. In addition, existing portal URLs remain the same. URLs for portals created before May 20, 2024 used the format <UUID>.workspaces-web.com. WorkSpaces Secure Browser portals continue to use this format and the workspaces-web.com domain. Terms to know when using Amazon WorkSpaces Secure Browser To help you get started with WorkSpaces Secure Browser, you should get familiar with the following concepts. Identity provider (IdP) An identity provider verifies your users’ credentials. It then issues authentication assertions to provide access to a service provider. You can configure your existing IdP to work with WorkSpaces Secure Browser. The process for configuring your identity provider (IdP) varies, depending on your IdP. Terms to know 2 Amazon WorkSpaces Secure Browser Administration Guide You must upload the service provider metadata file to your IdP. Otherwise, your users won't be able to log in. You must also grant access for your users to use WorkSpaces Secure Browser in your IdP. Identity provider (IdP) metadata document WorkSpaces Secure Browser requires specific metadata from your identity provider (IdP) to establish trust. You can add this metadata to WorkSpaces Secure Browser by uploading a metadata exchange file downloaded from your IdP. Service provider (SP) A service provider accepts authentication assertions and provides a service to the user. WorkSpaces Secure Browser acts as a service provider to users who have been authenticated by their IdP. Service provider (SP) metadata document You will
administration-guide-003
administration-guide.pdf
3
won't be able to log in. You must also grant access for your users to use WorkSpaces Secure Browser in your IdP. Identity provider (IdP) metadata document WorkSpaces Secure Browser requires specific metadata from your identity provider (IdP) to establish trust. You can add this metadata to WorkSpaces Secure Browser by uploading a metadata exchange file downloaded from your IdP. Service provider (SP) A service provider accepts authentication assertions and provides a service to the user. WorkSpaces Secure Browser acts as a service provider to users who have been authenticated by their IdP. Service provider (SP) metadata document You will need to add the service provider metadata details to your identity provider's (IdP's) configuration interface. The details of this configuration process varies between providers. SAML 2.0 A standard for exchanging authentication and authorization data between an IdP and a service provider. Virtual Private Cloud (VPC) You can use an existing or new VPC, corresponding subnets, and security groups to link your content with WorkSpaces Secure Browser. Subnets must with a stable connection to the internet, and the VPC and subnets must also have a stable connection to any internal and Software as a Service (SaaS) websites for users to access these resources. The VPCs, subnets, and security groups listed are taken from the same region as your WorkSpaces Secure Browser console. Trust store If a user accessing a web site through WorkSpaces Secure Browser receives a privacy error, such as NET::ERR_CERT_INVALID, that site might be using a certificate signed by a private certificate authority (PCA). You may need to add or change the PCAs in your trust store. In addition, if a user's device requires you to install a specific certificate in order to load a web site, you will need Terms to know 3 Amazon WorkSpaces Secure Browser Administration Guide to add that certificate to your trust store to allow your user to access that site in WorkSpaces Secure Browser. Publicly accessible web sites usually don't require any changes to a trust store. Web portal A web portal provides your users with access to internal and SaaS websites from their browsers. You can create one web portal in any supported region per account. To request a limit increase for more than one portal, contact support. Web portal endpoint The web portal endpoint is the access point your users will launch your web portal from after signing in with the identity provider configured for the portal. The endpoint is publicly available on the internet and can be embedded into your network. AWS services related to Amazon WorkSpaces Secure Browser There are several AWS services that are related to WorkSpaces Secure Browser. WorkSpaces Secure Browser is a capability from Amazon WorkSpaces in the AWS End User Computing portfolio. Compared with WorkSpaces and AppStream 2.0, WorkSpaces Secure Browser is built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser is automatically managed, with capacity, scaling, and images provisioned and updated on demand by AWS. For example, you can choose to offer a persistent Workspace Desktop to your software developers who need access to desktop resources, and WorkSpaces Secure Browser to the contact center users that only need access to a handful of internal and SaaS websites (including those hosted outside your network) on desktop computers. Architecture of Amazon WorkSpaces Secure Browser The following diagram shows the architecture of WorkSpaces Secure Browser. Related services 4 Amazon WorkSpaces Secure Browser Administration Guide Accessing Amazon WorkSpaces Secure Browser You can access WorkSpaces Secure Browser in several ways. Administrators access WorkSpaces Secure Browser through the WorkSpaces Secure Browser Console, SDK, CLI, or API. Your users access it through the WorkSpaces Secure Browser endpoint. Access 5 Amazon WorkSpaces Secure Browser Administration Guide Setting up Amazon WorkSpaces Secure Browser Before you can configure WorkSpaces Secure Browser to reach your internal websites and SaaS applications, you must complete the following prerequisites. Topics • Signing up and creating a user • Granting programmatic access • Networking for Amazon WorkSpaces Secure Browser Signing up and creating a user Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage
administration-guide-004
administration-guide.pdf
4
the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Signing up and creating a user 6 Amazon WorkSpaces Secure Browser Administration Guide Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Configure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. Create a user with administrative access 7 Amazon WorkSpaces Secure Browser Administration Guide 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Granting programmatic access Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic access, choose one of the following options. Which user needs programmatic access? To By Workforce identity (Users managed in IAM Identity Center) Use temporary credentials to sign programmatic requests Following the instructions for the interface that you want to to the AWS CLI, AWS SDKs, or use. AWS APIs. • For the AWS CLI, see Configuring the AWS CLI to use AWS IAM Identity Center in the AWS Command Line Interface User Guide. • For AWS SDKs, tools, and AWS APIs, see IAM Identity Center authentication in the AWS SDKs and Tools Reference Guide. IAM Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. Following the instructions in Using temporary credentia ls with AWS resources in the IAM User Guide. Granting programmatic access 8 Amazon WorkSpaces Secure Browser Administration Guide Which user needs programmatic access? To By IAM (Not recommended) Use long-term credentials to Following the instructions for the interface that you want to sign programmatic requests use. to the AWS CLI, AWS SDKs, or AWS APIs. • For the AWS CLI, see Authenticating using IAM user credentials in the AWS Command Line Interface User Guide. • For AWS SDKs and tools, see Authenticate using long-term credentials in the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. Networking for Amazon WorkSpaces Secure Browser The following topics explain how to set up WorkSpaces Secure Browser streaming instances so that users can connect to them. It also explains how to enable your WorkSpaces Secure Browser streaming instances to access VPC resources, as well as the internet. Topics • Setting up a VPC for Amazon WorkSpaces Secure Browser • Enabling user connections for Amazon WorkSpaces Secure Browser Setting up a
administration-guide-005
administration-guide.pdf
5
tools, see Authenticate using long-term credentials in the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. Networking for Amazon WorkSpaces Secure Browser The following topics explain how to set up WorkSpaces Secure Browser streaming instances so that users can connect to them. It also explains how to enable your WorkSpaces Secure Browser streaming instances to access VPC resources, as well as the internet. Topics • Setting up a VPC for Amazon WorkSpaces Secure Browser • Enabling user connections for Amazon WorkSpaces Secure Browser Setting up a VPC for Amazon WorkSpaces Secure Browser To set up and configure a VPC for WorkSpaces Secure Browser complete the following steps. Networking 9 Amazon WorkSpaces Secure Browser Administration Guide Topics • VPC requirements for Amazon WorkSpaces Secure Browser • Creating a new VPC for Amazon WorkSpaces Secure Browser • Enabling internet browsing for Amazon WorkSpaces Secure Browser • VPC best practices for WorkSpaces Secure Browser • Supported Availability Zones for Amazon WorkSpaces Secure Browser VPC requirements for Amazon WorkSpaces Secure Browser During WorkSpaces Secure Browser portal creation, you'll select a VPC in your account. You'll also choose at least two subnets in two different Availability Zones. These VPCs and subnets must meet following requirements: • The VPC must have default tenancy. VPCs with dedicated tenancy are not supported. • For availability consideration, we require at least two subnets created in two different Availability Zones. Your subnets must have sufficient IP addresses to support the expected WorkSpaces Secure Browser traffic. Configure each of your subnets with a subnet mask that allows for enough client IP addresses to account for the maximum number of concurrent sessions. For more information, see Creating a new VPC for Amazon WorkSpaces Secure Browser. • All subnets must have a stable connection to any internal content, either located in the AWS Cloud or on premises, that users will access with WorkSpaces Secure Browser. We recommend you choose three subnets in different Availability Zones for availability and scaling consideration. For more information, see Creating a new VPC for Amazon WorkSpaces Secure Browser. WorkSpaces Secure Browser doesn't assign any public IP address to streaming instances to enable internet access. This would make your streaming instances accessible from the internet. Therefore, any streaming instance connected to your public subnet won’t have internet access. If you want your WorkSpaces Secure Browser portal to have access to both public internet content and private VPC content, complete the steps in Enabling unrestricted internet browsing for Amazon WorkSpaces Secure Browser (recommended). VPC setup 10 Amazon WorkSpaces Secure Browser Administration Guide Creating a new VPC for Amazon WorkSpaces Secure Browser This section describes how to use the VPC wizard to create a VPC with one public subnet and one private subnet. As part of this process, the wizard creates an internet gateway and a NAT gateway. It also creates a custom route table associated with the public subnet. It then updates the main route table associated with the private subnet. The NAT gateway is automatically created in your VPC's public subnet. After you use the wizard to create a VPC configuration, you'll add a second private subnet. For more information about this configuration, see VPC with public and private subnets (NAT). Topics • Allocating an Elastic IP address • Creating a new VPC • Adding a second private subnet • Verifying and naming your subnet route tables Allocating an Elastic IP address Before you create your VPC, you must allocate an Elastic IP address in your WorkSpaces Secure Browser Region. Once allocated, you can associate the Elastic IP address with your NAT gateway. With an Elastic IP address, you can mask a failure of your streaming instance by rapidly remapping the address to another streaming instance in your VPC. For more information, see Elastic IP addresses. Note Charges might apply to Elastic IP addresses that you use. For more information, see the Elastic IP addresses pricing page. If you don't already have an Elastic IP address, complete the following steps. If you want to use an existing Elastic IP address, you must first verify that it isn't currently associated with another instance or network interface. To allocate an Elastic IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. VPC setup 11 Amazon WorkSpaces Secure Browser Administration Guide 2. In the navigation pane, under Network & Security, choose Elastic IPs. 3. Choose Allocate New Address, and then choose Allocate. 4. Note the Elastic IP address shown on the console. 5. In the upper-right corner of the Elastic IPs pane, click the × icon to close the pane. Creating a new VPC Complete the following steps to create a new VPC with one public subnet and one private subnet. To create a new VPC 1. Open
administration-guide-006
administration-guide.pdf
6
To allocate an Elastic IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. VPC setup 11 Amazon WorkSpaces Secure Browser Administration Guide 2. In the navigation pane, under Network & Security, choose Elastic IPs. 3. Choose Allocate New Address, and then choose Allocate. 4. Note the Elastic IP address shown on the console. 5. In the upper-right corner of the Elastic IPs pane, click the × icon to close the pane. Creating a new VPC Complete the following steps to create a new VPC with one public subnet and one private subnet. To create a new VPC 1. Open the Amazon VPC Console at https://console.aws.amazon.com/vpc/. 2. In the navigation pane, choose VPC Dashboard. 3. Choose Launch VPC Wizard. 4. In Step 1: Select a VPC Configuration, choose VPC with Public and Private Subnets, and then choose Select. 5. In Step 2: VPC with Public and Private Subnets, configure the VPC as follows: • For IPv4 CIDR block, specify an IPv4 CIDR block for the VPC. • For IPv6 CIDR block, keep the default value, No IPv6 CIDR Block. • For VPC name, enter a unique name for the VPC. • Configure the public subnet as follows: • For Public subnet's IPv4 CIDR, specify the CIDR block for the subnet. • For Availability Zone, keep the default value, No Preference. • For Public subnet name, enter a name for the subnet. For example, WorkSpaces Secure Browser Public Subnet. • Configure the first private subnet as follows: • For Private subnet's IPv4 CIDR, specify the CIDR block for the subnet. Make a note of the value that you specify. • For Availability Zone, select a specific zone and make a note of the zone that you select. • For Private subnet name, enter a name for the subnet. For example, WorkSpaces Secure Browser Private Subnet1. • For the remaining fields, keep the default values where applicable. VPC setup 12 Amazon WorkSpaces Secure Browser Administration Guide • For Elastic IP Allocation ID, enter the value that corresponds to the Elastic IP address that you created. This address is then assigned to the NAT gateway. If you don't have an Elastic IP address, create one by using the Amazon VPC Console at https://console.aws.amazon.com/ vpc/. • For Service endpoints, if an Amazon S3 endpoint is required for your environment, specify one. To specify an Amazon S3 endpoint, do the following: 1. Choose Add Endpoint. 2. For Service, select the com.amazonaws.Region.s3 entry, where Region is the AWS Region you're creating your VPC in. 3. For Subnet, choose Private subnet. 4. For Policy, keep the default value, Full Access. • For Enable DNS hostnames, keep the default value, Yes. • For Hardware tenancy, keep the default value, Default. • Choose Create VPC. • It takes several minutes to set up your VPC. After the VPC is created, choose OK. Adding a second private subnet In the previous step, you created a VPC with one public subnet and one private subnet. Complete the following steps to add a second private subnet to your VPC. We recommend that you add a second private subnet in a different Availability Zone than your first private subnet. To add a second private subnet 1. 2. In the navigation pane, choose Subnets. Select the first private subnet that you created in the previous step. On the Description tab, below the list of subnets, make a note of the Availability Zone for this subnet. 3. On the upper left of the subnets pane, choose Create Subnet. 4. For Name tag, enter a name for the private subnet. For example, WorkSpaces Secure Browser Private Subnet2. 5. For VPC, select the VPC that you created in the previous step. VPC setup 13 Amazon WorkSpaces Secure Browser Administration Guide 6. 7. For Availability Zone, select an Availability Zone other than the one you're using for your first private subnet. Selecting a different Availability Zone increases fault tolerance and helps prevent insufficient capacity errors. For IPv4 CIDR block, specify a unique CIDR block range for the new subnet. For example, if your first private subnet has an IPv4 CIDR block range of 10.0.1.0/24, you could specify a CIDR block range of 10.0.2.0/24 for the second private subnet. 8. Choose Create. 9. After your subnet is created, choose Close. Verifying and naming your subnet route tables After you've created and configured your VPC, complete the following steps to specify a name for your route tables. You'll need to verify that the following details are correct for your route table: • The route table associated with the subnet that your NAT gateway resides in must include a route that points internet traffic to an internet gateway. This ensures that your NAT gateway can access the internet. • The route tables associated with your private subnets must be configured to
administration-guide-007
administration-guide.pdf
7
8. Choose Create. 9. After your subnet is created, choose Close. Verifying and naming your subnet route tables After you've created and configured your VPC, complete the following steps to specify a name for your route tables. You'll need to verify that the following details are correct for your route table: • The route table associated with the subnet that your NAT gateway resides in must include a route that points internet traffic to an internet gateway. This ensures that your NAT gateway can access the internet. • The route tables associated with your private subnets must be configured to point internet traffic to the NAT gateway. This enables the streaming instances in your private subnets to communicate with the internet. To verify and name your subnet route tables 1. In the navigation pane, choose Subnets, and then select the public subnet that you created. For example, WorkSpaces Secure Browser 2.0 Public Subnet. 2. On the Route Table tab, choose the ID of the route table. For example, rtb-12345678. 3. Select the route table. Under Name, choose the edit (pencil) icon, and enter a name for the table. For example, enter the name workspacesweb-public-routetable. Then select the check mark to save the name. 4. With the public route table still selected, on the Routes tab, verify that there are two routes: one for local traffic, and one that sends all other traffic through the VPC's internet gateway. The following table describes these two routes: VPC setup 14 Amazon WorkSpaces Secure Browser Administration Guide Destination Public subnet IPv4 CIDR block (for example, 10.0.0/20) Target Local Traffic destined to all other IPv4 addresses (for example, 0.0.0.0/0) Outbound (igw-ID) Description All traffic from the resources destined for IPv4 addresses within the public subnet IPv4 CIDR block. This traffic is routed locally within the VPC. Traffic destined for all other IPv4 addresses is routed to the internet gateway (identified by igw-ID) that was created by the VPC wizard. 5. In the navigation pane, choose Subnets. Then, select the first private subnet that you created (for example, WorkSpaces Secure Browser Private Subnet1). 6. On the Route Table tab, choose the route table's ID. 7. Select the route table. Under Name, choose the edit (pencil) icon, and enter a name for the table. For example, enter the name workspacesweb-private-routetable. Then choose the check mark to save the name. 8. On the Routes tab, verify that the route table includes the following routes: Destination Public subnet IPv4 CIDR block (for example, 10.0.0/20) Target Local Traffic destined to all other IPv4 addresses (for example, 0.0.0.0/0) Outbound (nat-ID) Description All traffic from the resources destined for IPv4 addresses within the public subnet IPv4 CIDR block is routed locally within the VPC. Traffic destined for all other IPv4 addresses is routed to VPC setup 15 Amazon WorkSpaces Secure Browser Administration Guide Destination Target Description Storage (vpce-ID) Traffic destined for S3 buckets (applicable if you specified an S3 endpoint) [pl-ID (com.amazonaws.reg ion.s3)] the NAT gateway (identified by nat-ID). Traffic destined for S3 buckets is routed to the S3 endpoint (identified by vpce-ID). 9. In the navigation pane, choose Subnets. Then select the second private subnet that you created (for example, WorkSpaces Secure Browser Private Subnet2). 10. On the Route Table tab, verify that the selected route table is the private route table (for example, workspacesweb-private-routetable). If the route table is different, choose Edit and select your private route table instead. Enabling internet browsing for Amazon WorkSpaces Secure Browser You can choose to enable unrestricted internet browsing (the recommended option) or restricted internet browsing. Topics • Enabling unrestricted internet browsing for Amazon WorkSpaces Secure Browser (recommended) • Enabling restricted internet browsing for Amazon WorkSpaces Secure Browser • Internet connectivity ports for Amazon WorkSpaces Secure Browser Enabling unrestricted internet browsing for Amazon WorkSpaces Secure Browser (recommended) Follow these steps to configure a VPC with a NAT gateway for unrestricted internet browsing. This grants WorkSpaces Secure Browser access to sites on the public internet, and private sites hosted in or with a connection to your VPC. To configure a VPC with a NAT gateway for unrestricted internet browsing If you want your WorkSpaces Secure Browser portal to have access to both public internet content and private VPC content, follow these steps: VPC setup 16 Amazon WorkSpaces Secure Browser Administration Guide Note If you already configured a VPC, complete the following steps to add a NAT gateway to your VPC. If you need to create a new VPC, see Creating a new VPC for Amazon WorkSpaces Secure Browser. 1. To create your NAT gateway, complete the steps in Create a NAT gateway. Make sure that this NAT gateway has public connectivity, and is in a public subnet in your VPC. 2. You must specify at least two private subnets from different Availability Zones. Assigning your
administration-guide-008
administration-guide.pdf
8
and private VPC content, follow these steps: VPC setup 16 Amazon WorkSpaces Secure Browser Administration Guide Note If you already configured a VPC, complete the following steps to add a NAT gateway to your VPC. If you need to create a new VPC, see Creating a new VPC for Amazon WorkSpaces Secure Browser. 1. To create your NAT gateway, complete the steps in Create a NAT gateway. Make sure that this NAT gateway has public connectivity, and is in a public subnet in your VPC. 2. You must specify at least two private subnets from different Availability Zones. Assigning your subnets to different Availability Zones helps to ensure better availability and fault tolerance. For information about how to create a second private subnet, see the section called “Second private subnet”. Note To make sure every streaming instance has internet access, do not attach a public subnet to your WorkSpaces Secure Browser portal. 3. Update the route table associated with your private subnets to point internet-bound traffic to the NAT gateway. This enables the streaming instances in your private subnets to communicate with the internet. For information on how to associate a route table with a private subnet, complete the steps in Configure route tables. Enabling restricted internet browsing for Amazon WorkSpaces Secure Browser The recommended network setup of a WorkSpaces Secure Browser portal is to use private subnets with NAT gateway, so that the portal can browse both public internet and private content. For more information, see the section called “Unrestricted internet browsing”. However, you might be required to control outbound communication from a WorkSpaces Secure Browser portal to the internet by using a web proxy. For example, if you use a web proxy as the gateway to the internet, you can implement preventive security controls, such as domain allow-listing and content filtering. This can also reduce bandwidth usage and improve network performance by caching frequently accessed resources, such as web pages or software updates locally. For some use cases, you might have private content that is only accessible by using a web proxy. VPC setup 17 Amazon WorkSpaces Secure Browser Administration Guide You might already be familiar with configuring proxy settings on managed devices, or on the image of your virtual environments. But this poses challenges if you aren’t in control of the device (for example, when users are on devices not owned or managed by the enterprise), or if you need to manage the image for your virtual environment. With WorkSpaces Secure Browser, you can set proxy settings using Chrome’s policies built into the web browser. You can do this by setting up an HTTP outbound proxy for WorkSpaces Secure Browser. This solution is based on a recommended outbound VPC proxy setup. The proxy solution is based on the open source HTTP proxy Squid. Then, it uses WorkSpaces Secure Browser browser settings to configure WorkSpaces Secure Browser portal to connect to the proxy endpoint. For more information, see How to set up an outbound VPC proxy with domain whitelisting and content filtering. This solution provides you with the following benefits: • An outbound proxy that includes a group of auto-scaling Amazon EC2 instances, hosted by a network load balancer. Proxy instances live in a public subnet, and each of them is attached with an Elastic IP, so they can have access to the internet. • A WorkSpaces Secure Browser portal deployed to private subnets. You don’t need to configure NAT gateway to enable internet access. Instead, you configure your browser policy, so all internet traffic goes through the outbound proxy. If you want to use your own proxy, the WorkSpaces Secure Browser portal setup will be similar. Topics • Restricted internet browsing architecture for Amazon WorkSpaces Secure Browser • Restricted internet browsing prerequisites for Amazon WorkSpaces Secure Browser • HTTP outbound proxy for Amazon WorkSpaces Secure Browser • Troubleshooting restricted internet browsing for Amazon WorkSpaces Secure Browser Restricted internet browsing architecture for Amazon WorkSpaces Secure Browser The following is an example of a typical proxy setup in your VPC. The proxy Amazon EC2 instance is in public subnets and associated with Elastic IP, so they have access to internet. A network load balancer hosts an auto scaling group of proxy instances. This ensures that proxy instances can scale up automatically, and the network load balancer is the single proxy endpoint, which can be consumed by WorkSpaces Secure Browser sessions. VPC setup 18 Amazon WorkSpaces Secure Browser Administration Guide Restricted internet browsing prerequisites for Amazon WorkSpaces Secure Browser Before you get started, make sure that you meet the following prerequisites: • You need an already deployed VPC, with public and private subnets spreading over several Availability Zones (AZs). For more information about how to set up your VPC environment, see Default VPCs. VPC setup 19 Amazon WorkSpaces Secure Browser
administration-guide-009
administration-guide.pdf
9
of proxy instances. This ensures that proxy instances can scale up automatically, and the network load balancer is the single proxy endpoint, which can be consumed by WorkSpaces Secure Browser sessions. VPC setup 18 Amazon WorkSpaces Secure Browser Administration Guide Restricted internet browsing prerequisites for Amazon WorkSpaces Secure Browser Before you get started, make sure that you meet the following prerequisites: • You need an already deployed VPC, with public and private subnets spreading over several Availability Zones (AZs). For more information about how to set up your VPC environment, see Default VPCs. VPC setup 19 Amazon WorkSpaces Secure Browser Administration Guide • You need one single proxy endpoint that is accessible from private subnets, where WorkSpaces Secure Browser sessions live (for example, the network load balancer DNS name). If you want to use your existing proxy, make sure it also has a single endpoint that is accessible from your private subnets. HTTP outbound proxy for Amazon WorkSpaces Secure Browser To set up an HTTP outbound proxy for WorkSpaces Secure Browser, follow these steps. 1. To deploy an example outbound proxy to your VPC, follow the steps in How to set up an outbound VPC proxy with domain whitelisting and content filtering. a. Follow the steps in "Installation (one-time setup)" to deploy the CloudFormation template to your account. Make sure to choose the right VPC and subnets as the CloudFormation template parameters. b. After deployment, find the CloudFormation output parameter OutboundProxyDomain and OutboundProxyPort. This is your proxy’s DNS name and port. c. If you already have your own proxy, skip this step and use your proxy’s DNS name and port. 2. In the WorkSpaces Secure Browser, console, select your portal and then choose Edit. a. In the Network connection details, choose the VPC and private subnets that have access to the proxy. b. In the Policy settings, add the following ProxySettings policy by using a JSON editor. The ProxyServer field should be your proxy’s DNS name and port. For more details about ProxySettings policy, see ProxySettings. { "chromePolicies": { ... "ProxySettings": { "value": { "ProxyMode": "fixed_servers", "ProxyServer": "OutboundProxyLoadBalancer-0a01409a46943c47.elb.us- west-2.amazonaws.com:3128", "ProxyBypassList": "https://www.example1.com,https:// www.example2.com,https://internalsite/" } }, } VPC setup 20 Amazon WorkSpaces Secure Browser Administration Guide } 3. In your WorkSpaces Secure Browser session, you will see the proxy is applied to Chrome setting Chrome is using proxy settings from your administrator. 4. Go to chrome://policy and the Chrome policy tab to confirm that the policy is applied. 5. Verify that your WorkSpaces Secure Browser session can successfully browse internet content without NAT gateway. In the CloudWatch Logs, verify that Squid proxy access logs are recorded. Troubleshooting restricted internet browsing for Amazon WorkSpaces Secure Browser After Chrome policy is applied, if your WorkSpaces Secure Browser session still can't access the internet, follow these steps to try to resolve your issue: • Verify that the proxy endpoint is accessible from the private subnets where your WorkSpaces Secure Browser portal lives. To do you this, create an EC2 instance in the private subnet, and test the connection from the private EC2 instance to your proxy endpoint. • Verify that the proxy has internet access. • Verify that the Chrome policy is correct. • Confirm the following formatting for the ProxyServer field of the policy: <Proxy DNS name>:<Proxy port>. There should be no http:// or https:// in the prefix. • In the WorkSpaces Secure Browser session, use Chrome to navigate to chrome://policy, and make sure that the ProxySettings policy is successfully applied. Internet connectivity ports for Amazon WorkSpaces Secure Browser Each WorkSpaces Secure Browser streaming instance has a customer network interface that provides connectivity to the resources within your VPC, as well as to the internet if private subnets with NAT gateway are set up. For internet connectivity, the following ports must be open to all destinations. If you are using a modified or custom security group, you'll need to add the required rules manually. For more information, see Security group rules. Note This applies to egress traffic. VPC setup 21 Amazon WorkSpaces Secure Browser Administration Guide • TCP 80 (HTTP) • TCP 443 (HTTPS) • UDP 8433 VPC best practices for WorkSpaces Secure Browser The following recommendations can help you configure your VPC more effectively and securely. Overall VPC Configuration • Make sure that your VPC configuration can support your scaling needs. • Make sure that your WorkSpaces Secure Browser service quotas (also referred to as limits) are sufficient to support your anticipated demand. To request a quota increase, you can use the Service Quotas console at https://console.aws.amazon.com/servicequotas/. For information about default WorkSpaces Secure Browser quotas, see the section called “Managing service quotas”. • If you plan to provide your streaming sessions with access to the internet, we recommend that you configure a VPC with a NAT gateway in a public subnet. Elastic Network
administration-guide-010
administration-guide.pdf
10
effectively and securely. Overall VPC Configuration • Make sure that your VPC configuration can support your scaling needs. • Make sure that your WorkSpaces Secure Browser service quotas (also referred to as limits) are sufficient to support your anticipated demand. To request a quota increase, you can use the Service Quotas console at https://console.aws.amazon.com/servicequotas/. For information about default WorkSpaces Secure Browser quotas, see the section called “Managing service quotas”. • If you plan to provide your streaming sessions with access to the internet, we recommend that you configure a VPC with a NAT gateway in a public subnet. Elastic Network Interfaces • Each WorkSpaces Secure Browser session requires its own elastic network interface during the streaming duration. WorkSpaces Secure Browser creates as many elastic network interfaces (ENIs) as the maximum desired capacity of your fleet. By default, the limit for ENIs per Region is 5000. For more information, see Network interfaces. When planning capacity for very large deployments, for example, thousands of concurrent streaming sessions, consider the number of ENIs that might be required for your peak usage. We recommend that you keep your ENI limit at or above the max concurrent usage limit you configure for your web portal. Subnets • As you develop your plan to scale up users, keep in mind that each WorkSpaces Secure Browser session requires a unique client IP address from your configured subnets. Therefore, the size of the client IP address space configured on your subnets determines the number of users who can stream concurrently. VPC setup 22 Amazon WorkSpaces Secure Browser Administration Guide • We recommend each subnet is configured with a subnet mask that allows for enough client IP addresses to account for the maximum number of expected concurrent users. In addition, consider adding additional IP addresses to account for anticipated growth. For more information, see VPC and Subnet Sizing for IPv4. • We recommend that you configure a subnet in each unique Availability Zone that WorkSpaces Secure Browser supports in your desired region for availability and scaling consideration. For more information, see the section called “Creating a new VPC”. • Make sure that the network resources required for your web applications are accessible through your subnets. Security Groups • Use security groups to provide additional access control to your VPC. Security groups that belong to your VPC let you control the network traffic between WorkSpaces Secure Browser streaming instances and network resources required by web applications. Make sure that the security groups provide access to the network resources that your web applications require. Supported Availability Zones for Amazon WorkSpaces Secure Browser When you are creating a virtual private cloud (VPC) for use with WorkSpaces Secure Browser, your VPC's subnets must reside in different Availability Zones in the Region where you're launching WorkSpaces Secure Browser. Availability Zones are distinct locations that are engineered to be isolated from failures in other Availability Zones. By launching instances in separate Availability Zones, you can protect your applications from the failure of a single location. Each subnet must reside entirely within one Availability Zone and cannot span zones. We recommend configuring a subnet for each supported AZ in your desired region for maximum resiliency An Availability Zone is represented by a Region code followed by a letter identifier; for example, us-east-1a. To ensure that resources are distributed across the Availability Zones for a Region, we independently map Availability Zones to names for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not be the same location as us- east-1a for another AWS account. VPC setup 23 Amazon WorkSpaces Secure Browser Administration Guide To coordinate Availability Zones across accounts, you must use the AZ ID, which is a unique and consistent identifier for an Availability Zone. For example, use1-az2 is an AZ ID for the us- east-1 Region and it has the same location in every AWS account. Viewing AZ IDs enables you to determine the location of resources in one account relative to the resources in another account. For example, if you share a subnet in the Availability Zone with the AZ ID use1-az2 with another account, this subnet is available to that account in the Availability Zone whose AZ ID is also use1-az2. The AZ ID for each VPC and subnet is displayed in the Amazon VPC console. WorkSpaces Secure Browser is available in a subset of the Availability Zones for each supported Region. The following table lists the AZ IDs that you can use for each Region. To see the mapping of AZ IDs to Availability Zones in your account, see AZ IDs for Your Resources in the AWS RAM User Guide. Region name Region code Supported AZ IDs US East (N. Virginia) us-east-1 use1-az1, use1-az2, use1- az4, use1-az5, use1-az6 US West (Oregon) us-west-2 usw2-az1, usw2-az2, usw2- az3
administration-guide-011
administration-guide.pdf
11
ID is also use1-az2. The AZ ID for each VPC and subnet is displayed in the Amazon VPC console. WorkSpaces Secure Browser is available in a subset of the Availability Zones for each supported Region. The following table lists the AZ IDs that you can use for each Region. To see the mapping of AZ IDs to Availability Zones in your account, see AZ IDs for Your Resources in the AWS RAM User Guide. Region name Region code Supported AZ IDs US East (N. Virginia) us-east-1 use1-az1, use1-az2, use1- az4, use1-az5, use1-az6 US West (Oregon) us-west-2 usw2-az1, usw2-az2, usw2- az3 Asia Pacific (Mumbai) ap-south-1 aps1-az1, aps1-az3 Asia Pacific (Singapore) ap-southeast-1 apse1-az1 , apse1-az2 , apse1-az3 Asia Pacific (Sydney) ap-southeast-2 apse2-az1 , apse2-az2 , apse2-az3 Asia Pacific (Tokyo) ap-northeast-1 apne1-az1 , apne1-az2 , apne1-az4 Canada (Central) ca-central-1 cac1-az1, cac1-az2, cac1- az4 Europe (Frankfurt) eu-central-1 euc1-az2, euc1-az2, euc1- az3 VPC setup 24 Amazon WorkSpaces Secure Browser Administration Guide Region name Region code Supported AZ IDs Europe (Ireland) eu-west-1 euw1-az1, euw1-az2, euw1- az3 Europe (London) eu-west-2 euw2-az1, euw2-az2 For more information about Availability Zones and AZ IDs, see Regions, Availability Zones, and Local Zones in the Amazon EC2 User Guide. Enabling user connections for Amazon WorkSpaces Secure Browser WorkSpaces Secure Browser is configured to route streaming connections over the public internet. Internet connectivity is required to authenticate users and deliver the web assets that WorkSpaces Secure Browser requires to function. To allow this traffic, you must allow the domains listed in Allowed domains for Amazon WorkSpaces Secure Browser. The following topics provide information about how to enable user connections to WorkSpaces Secure Browser. Topics • IP address and port requirements for Amazon WorkSpaces Secure Browser • Allowed domains for Amazon WorkSpaces Secure Browser IP address and port requirements for Amazon WorkSpaces Secure Browser To access WorkSpaces Secure Browser instances, user devices require outbound access on the following ports: • Port 443 (TCP) • Port 443 is used for HTTPS communication between user devices and streaming instances when using the internet endpoints. Typically, when end users browse the web during streaming sessions, the web browser randomly selects a source port in the high range for streaming traffic. You must ensure that return traffic to this port is allowed. • This port must be open to the required domains listed at Allowed domains for Amazon WorkSpaces Secure Browser. User connections 25 Amazon WorkSpaces Secure Browser Administration Guide • AWS publishes its current IP address ranges, including the ranges that the Session Gateway and CloudFront domains may resolve to, in JSON format. For information about how to download the .json file and view the current ranges, see AWS IP address ranges. Or, if you are using AWS Tools for Windows PowerShell, you can access the same information by using the Get-AWSPublicIpAddressRange PowerShell command. For more information, see Querying the Public IP Address Ranges for AWS. • (Optional) Port 53 (UDP) • Port 53 is used for communication between user devices and your DNS servers. • This port is optional if you are not using DNS servers for domain name resolution. • The port must be open to the IP addresses for your DNS servers so that public domain names can be resolved. Allowed domains for Amazon WorkSpaces Secure Browser For users to be able to access web portals from their local browser, you must add the following domains to the allow list on the network the user is trying to access the service from. In the following table, replace {region} with the code of the operating web portal's Region. For example, s3.{region}.amazonaws.com should be s3.eu-west-1.amazonaws.com for a web portal the Europe (Ireland) region. For a list of Region codes, see Amazon WorkSpaces Secure Browser endpoints and quotas. Category Domain or IP address WorkSpaces Secure Browser streaming assets s3.{region}.amazonaws.com s3.amazonaws.com appstream2.{region}.aws.amazon.com *.amazonappstream.com *.shortbread.aws.dev WorkSpaces Secure Browser static assets *.workspaces-web.com di5ry4hb4263e.cloudfront.net User connections 26 Amazon WorkSpaces Secure Browser Administration Guide Category Domain or IP address WorkSpaces Secure Browser authentication *.auth.{region}.amazoncognito.com cognito-identity.{region}.amazonaws.com cognito-idp.{region}.amazonaws.com *.cloudfront.net WorkSpaces Secure Browser metrics and reporting *.execute-api.{region}.amazonaws.com unagi-na.amazon.com Depending on your configured identity provider, you might also need to allow list additional domains. Review your IdP’s documentation to identify which domains you need to allow list in order for WorkSpaces Secure Browser to use that provider. If you are using IAM Identity Center, see IAM Identity Center prerequisites for more information. User connections 27 Amazon WorkSpaces Secure Browser Administration Guide Getting started with Amazon WorkSpaces Secure Browser Follow these steps to create a WorkSpaces Secure Browser web portal and provide users with access to internal and SaaS websites from their existing browsers. You can create one web portal in any supported region per account. Note To request a limit increase for more than one portal, please contact support with your AWS account ID, number of
administration-guide-012
administration-guide.pdf
12
list in order for WorkSpaces Secure Browser to use that provider. If you are using IAM Identity Center, see IAM Identity Center prerequisites for more information. User connections 27 Amazon WorkSpaces Secure Browser Administration Guide Getting started with Amazon WorkSpaces Secure Browser Follow these steps to create a WorkSpaces Secure Browser web portal and provide users with access to internal and SaaS websites from their existing browsers. You can create one web portal in any supported region per account. Note To request a limit increase for more than one portal, please contact support with your AWS account ID, number of portals to request, and AWS Region. This process typically takes five minutes with the web portal creation wizard, and up to an additional 15 minutes for the portal to become Active. There are no costs associated with setting up a web portal. WorkSpaces Secure Browser offers pay- as-you-go pricing, including a low, monthly price for users who actively use the service. There are no up-front costs, licenses, or long-term commitments. Important Before you begin, you must complete the necessary prerequisites for a web portal. For more information about web portal prerequisites, see Setting up Amazon WorkSpaces Secure Browser. Topics • Creating a web portal for Amazon WorkSpaces Secure Browser • Testing your web portal in Amazon WorkSpaces Secure Browser • Distributing your web portal in Amazon WorkSpaces Secure Browser Creating a web portal for Amazon WorkSpaces Secure Browser Follow these steps to create a web portal. Web portal creation 28 Amazon WorkSpaces Secure Browser Administration Guide Topics • Configuring network settings for Amazon WorkSpaces Secure Browser • Configuring portal settings for Amazon WorkSpaces Secure Browser • Configuring user settings for Amazon WorkSpaces Secure Browser • Configuring your identity provider for Amazon WorkSpaces Secure Browser • Launching a web portal with Amazon WorkSpaces Secure Browser Configuring network settings for Amazon WorkSpaces Secure Browser To configuring network settings for WorkSpaces Secure Browser follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home. 2. Choose WorkSpaces Secure Browser, then Web portals, and then choose Create web portal. 3. On the Step 1: Specify networking connection page, complete the following steps to connect your VPC to your web portal and configure your VPC and subnets. 1. For Networking details, choose a VPC with a connection to the content you want your users to access with WorkSpaces Secure Browser. 2. Choose up to three private subnets that meet the following requirements. For more information, see Networking for Amazon WorkSpaces Secure Browser. • You must choose a minimum of two private subnets to create a portal. • To ensure high availability for your web portal, we recommend you provide the maximum number of private subnets in unique availability zones for your VPC. 3. Choose a security group. Configuring portal settings for Amazon WorkSpaces Secure Browser On the Step 2: Configure web portal settings page, complete the following steps to customize your users' browsing experience when they start a session. 1. Under Web portal details, for Display name, enter an identifiable name for your web portal. 2. Under Instance Type, select the instance type for your web portal from the drop-down menu. Then, enter your Max concurrent user limit for the web portal. For more information, see the section called “Managing service quotas”. Network settings 29 Amazon WorkSpaces Secure Browser Administration Guide Note Selecting a new instance type will change the cost for each monthly active user. For more information, see Amazon WorkSpaces Secure Browser Pricing. 3. Under User access logging, for Kinesis stream ID, select the Amazon Kinesis data stream you want to send your data to. For more information, see the section called “Setting up user access logging”. 4. Under Policy settings, complete the following: • For Policy options, select Visual editor or JSON file upload. You can use either method to provide the policy configuration details for your web portal. For more information, see the section called “Managing browser policy”. • WorkSpaces Secure Browser includes support for Chrome enterprise policies. You can add and manage policies with either a visual editor or a manual upload for policy files. You can switch between either option at any time. • When you upload a policy file, you can see the available policies in the file in the console. However, you can't edit all policies in the visual editor. The console lists policies in your JSON file that you can't edit with the visual editor under Additional JSON policies. To make changes to these policies, you must edit them manually. • (Optional) For Startup URL - optional, enter a domain to use as the homepage when users launch their browser. Your VPC must have a stable connection to this URL. • Select or clear Private browsing and History deletion to turn these features on
administration-guide-013
administration-guide.pdf
13
a policy file, you can see the available policies in the file in the console. However, you can't edit all policies in the visual editor. The console lists policies in your JSON file that you can't edit with the visual editor under Additional JSON policies. To make changes to these policies, you must edit them manually. • (Optional) For Startup URL - optional, enter a domain to use as the homepage when users launch their browser. Your VPC must have a stable connection to this URL. • Select or clear Private browsing and History deletion to turn these features on or off during a user's session Note URLs visited while browsing privately, or before a user deletes their browser history, can't be recorded in user access logging. For more information, see the section called “Setting up user access logging”. • Under URL filtering, you can configure which URLs users can visit during a session. For more information, see the section called “Setting up URL filtering”. • (Optional) For Browser bookmarks - optional, enter the Display name, Domain, and Folder for any bookmarks you want your users to see in their browser. Then, choose Add bookmark. Portal settings 30 Amazon WorkSpaces Secure Browser Administration Guide Note Domain is a required field for browser bookmarks. In Chrome, users can find managed bookmarks in the Managed bookmarks folder on the bookmarks toolbar. • (Optional) Add Tags to your portal. You can use tags to search for or filter your AWS resources. Tags consist of a key and optional value and are associated with your portal resource. 5. Under IP Access Control (optional), choose whether to restrict access to trusted networks. For more information, see the section called “Managing IP access controls”. 6. Choose Next to continue. Configuring user settings for Amazon WorkSpaces Secure Browser On the Step 3: Select user settings page, complete the following steps to choose which features your users can access from the top navigation bar during their session, and then choose Next: 1. Under Permissions, choose whether to enable the extension for single sign-on. For more information, see the section called “Managing the single sign-on extension”. 2. 3. For Allow users to print to a local device from their web portal, choose Allowed or Not allowed. For Allow users to deeplink to their web portal, choose Allowed or Not Allowed. For more information about deep links, see the section called “Deep links”. 4. Under Toolbar controls, choose the settings that you want under Features. 5. Under Settings, manage the toolbar presentation view at start of the session including toolbar state (docked or detached), theme (dark or light mode), icon visibility, and maximum display resolution for the session. Leave these settings unconfigured to grant end users full control over these options. For more information, see the section called “Toolbar controls”. 6. For Session timeouts, specify the following: • For Disconnect timeout in minutes, choose the amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to User settings 31 Amazon WorkSpaces Secure Browser Administration Guide their previous session. Otherwise, they are connected to a new session with a new streaming instance. If a user ends the session, the disconnect timeout does not apply. Instead, the user is prompted to save any open documents, and then is immediately disconnected from the streaming instance. The instance the user was using is then terminated. • For Idle disconnect timeout in minutes, choose the amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the Disconnect timeout in minutes time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in Disconnect timeout in minutes has elapsed, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Setting this value to 0 disables it. When this value is disabled, users are not disconnected due to inactivity. Note Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in Idle disconnect timeout in minutes elapses, they are disconnected. Configuring your identity provider for Amazon WorkSpaces Secure Browser Use the following steps to configure your identity provider (IdP). Topics • Choosing the identity provider type for Amazon WorkSpaces Secure Browser • Changing the identity provider type for Amazon WorkSpaces Secure Browser Choosing the identity provider type for Amazon WorkSpaces Secure Browser WorkSpaces Secure Browser offers
administration-guide-014
administration-guide.pdf
14
or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in Idle disconnect timeout in minutes elapses, they are disconnected. Configuring your identity provider for Amazon WorkSpaces Secure Browser Use the following steps to configure your identity provider (IdP). Topics • Choosing the identity provider type for Amazon WorkSpaces Secure Browser • Changing the identity provider type for Amazon WorkSpaces Secure Browser Choosing the identity provider type for Amazon WorkSpaces Secure Browser WorkSpaces Secure Browser offers two authentication types: Standard and AWS IAM Identity Center. You choose the authentication type to use with your portal on the Configure identity provider page. Identity provider configuration 32 Amazon WorkSpaces Secure Browser Administration Guide • For Standard (default option), federate your 3rd party SAML 2.0 identity provider (such as Okta or Ping) directly with your portal. For more information, see the section called “Standard authentication type”. The standard type supports both SP-initiated and IdP-initiated authentication flows. • For IAM Identity Center (advanced option), federate the IAM Identity Center with your portal. To use this authentication type, your IAM Identity Center and WorkSpaces Secure Browser portal must both reside in the same AWS Region. For more information, see the section called “IAM Identity Center authentication type”. Topics • Configuring the standard authentication type for Amazon WorkSpaces Secure Browser • Configuring the IAM Identity Center authentication type for Amazon WorkSpaces Secure Browser Configuring the standard authentication type for Amazon WorkSpaces Secure Browser The standard authentication type is the default authentication type. It can support service provider-initiated (SP-initiated) and identity provider-initiated (IdP-initiated) sign-in flows with your SAML 2.0 compliant IdP. To configure the standard authentication type, follow the steps below to federate your third-party SAML 2.0 IdP (such as Okta or Ping) directly with your portal. Topics • Configuring your identity provider on Amazon WorkSpaces Secure Browser • Configuring your IdP on your own IdP • Finishing IdP configuration on Amazon WorkSpaces Secure Browser • Guidance for using specific IdPs with Amazon WorkSpaces Secure Browser Configuring your identity provider on Amazon WorkSpaces Secure Browser Complete the following steps to configure your identity provider: 1. On the Configure identity provider page of the creation wizard, choose Standard. 2. Choose Continue with Standard IdP. 3. Download the SP metadata file, and keep the tab open for individual metadata values. Identity provider configuration 33 Amazon WorkSpaces Secure Browser Administration Guide • If the SP metadata file is available, choose Download metadata file to download the service provider (SP) metadata document, and upload the service provider metadata file to your IdP in the next step. Without this, users won't be able to sign in. • If your provider doesn't upload SP metadata files, manually enter the metadata values. 4. Under Choose SAML sign-in type, choose between SP-initiated and IdP-initiated SAML assertions, or SP-initiated SAML assertions only. • SP-initiated and IdP-initiated SAML assertions allow your portal to support both types of sign-in flows. Portals that support IdP-initiated flows allow you to present SAML assertions to the service identity federation endpoint without requiring users to launch a session by visiting the portal URL. • Choose this to allow the portal to accept unsolicited IdP-initiated SAML assertions. • This option requires a default Relay State to be configured in your SAML 2.0 Identity Provider. The Relay state parameter for your portal is in the console under IdP initiated SAML sign in, or you can copy it from the SP metadata file under <md:IdPInitRelayState>. • Note • The following is the format of the relay state: redirect_uri=https%3A%2F %2Fportal-id.workspaces-web.com %2Fsso&response_type=code&client_id=1example23456789&identity_provider=Example- Identity-Provider. • If you copy and paste the value from the SP metadata file, make sure that you change &amp; to &. &amp; is an XML escape character. • Choose SP-initiated SAML assertions only for the portal to only support SP-initiated sign in flows. This option will reject unsolicited SAML assertions from IdP-initiated sign-in flows. Note Some third-party IdPs allow you to create a custom SAML application that can deliver IdP-initiated authentication experiences leveraging SP-initiated flows. For example, see Add an Okta bookmark application. 5. Choose whether you want to enable Sign SAML requests to this provider. SP-initiated authentication allows your IdP to validate that the authentication request is coming from the portal, which prevents accepting other third-party requests. Identity provider configuration 34 Amazon WorkSpaces Secure Browser Administration Guide a. Download the signing certificate and upload it to your IdP. The same signing certificate can be used for single logout. b. Enable signed request in your IdP. The name might be different, depending on the IdP. Note RSA-SHA256 is the only request and default request signing algorithm supported. 6. Choose whether you want to enable Require encrypted SAML assertions. This allows
administration-guide-015
administration-guide.pdf
15
Sign SAML requests to this provider. SP-initiated authentication allows your IdP to validate that the authentication request is coming from the portal, which prevents accepting other third-party requests. Identity provider configuration 34 Amazon WorkSpaces Secure Browser Administration Guide a. Download the signing certificate and upload it to your IdP. The same signing certificate can be used for single logout. b. Enable signed request in your IdP. The name might be different, depending on the IdP. Note RSA-SHA256 is the only request and default request signing algorithm supported. 6. Choose whether you want to enable Require encrypted SAML assertions. This allows you to encrypt the SAML assertion that comes from your IdP. It can prevent data from being intercepted in SAML assertions between the IdP and WorkSpaces Secure Browser. Note The encryption certificate is not available at this step. It will be created after your portal launches. After you launch the portal, download the encryption certificate and upload it to your IdP. Then, enable assertion encryption in your IdP (the name might be different, depending on the IdP. 7. Choose whether you want to enable Single Logout. Single logout allows your end users to sign out of both their IdP and WorkSpaces Secure Browser session with a single action. a. Download the signing certificate from WorkSpaces Secure Browser and upload it onto your IdP. This is the same signing certificate used for Request Signing in the previous step. b. Using Single Logout requires you to configure a Single Logout URL in your SAML 2.0 identity provider. You can find the Single Logout URL for your portal in the console under Service provider (SP) details - Show individual metadata values, or from the SP metadata file under <md:SingleLogoutService> . c. Enable Single Logout in your IdP. The name might be different, depending on the IdP. Configuring your IdP on your own IdP To configure your IdP on your own IdP, follow these steps. 1. Open a new tab in your browser. 2. Add your portal metadata to your SAML IdP. Identity provider configuration 35 Amazon WorkSpaces Secure Browser Administration Guide Either upload the SP metadata document that you downloaded in the previous step to your IdP, or copy and paste the metadata values into the correct fields in your IdP. Some providers do not allow file upload. The details of this process can vary between providers. Find your provider's documentation in the section called “Guidance for specific IdPs” for help on how to add the portal details to your IdP configuration. 3. Confirm the NameID for your SAML assertion. Make sure your SAML IdP populates NameID in the SAML assertion with the user email field. NameID and user email are used for uniquely identifying your SAML federated user with the portal. Use the persistent SAML Name ID format. 4. Optional: Configure the Relay State for IdP-initiated authentication. If you chose Accept SP-initiated and IdP-initiated SAML assertions in the previous step, follow steps in step 2 of the section called “IdP configuration on WorkSpaces Secure Browser” to set the default Relay State for your IdP application. 5. Optional: Configure Request signing. If you chose Sign SAML requests to this provider in the previous step, follow steps in step 3 of the section called “IdP configuration on WorkSpaces Secure Browser” to upload the signing certificate onto your IdP and enable request signing. Some IdPs such as Okta might require your NameID to belong to the “persistent” type to use Request signing. Make sure to confirm your NameID for your SAML assertion by following the steps above. 6. Optional: Configure Assertion encryption. If you chose Require encrypted SAML assertions from this provider, wait until portal creation is complete, then follow step 4 in "Upload metadata" below to upload the encryption certificate onto your IdP and enable assertion encryption. 7. Optional: Configure Single Logout. If you chose Single Logout, follow the steps in step 5 of the section called “IdP configuration on WorkSpaces Secure Browser” to upload the signing certificate onto your IdP, fill in Single Logout URL, and enable Single Logout. 8. Grant access to your users in your IdP to use WorkSpaces Secure Browser. 9. Download a metadata exchange file from your IdP. You will upload this metadata to WorkSpaces Secure Browser in the next step. Identity provider configuration 36 Amazon WorkSpaces Secure Browser Administration Guide Finishing IdP configuration on Amazon WorkSpaces Secure Browser To finish IdP configuration on WorkSpaces Secure Browser follow these steps. 1. Return to the WorkSpaces Secure Browserconsole. On the Configure identity provider page of the creation wizard, under IdP metadata, either upload a metadata file, or enter a metadata URL from your IdP. The portal uses this metadata from your IdP to establish trust. 2. To upload a metadata file, under IdP metadata document, choose Choose file. Upload the
administration-guide-016
administration-guide.pdf
16
will upload this metadata to WorkSpaces Secure Browser in the next step. Identity provider configuration 36 Amazon WorkSpaces Secure Browser Administration Guide Finishing IdP configuration on Amazon WorkSpaces Secure Browser To finish IdP configuration on WorkSpaces Secure Browser follow these steps. 1. Return to the WorkSpaces Secure Browserconsole. On the Configure identity provider page of the creation wizard, under IdP metadata, either upload a metadata file, or enter a metadata URL from your IdP. The portal uses this metadata from your IdP to establish trust. 2. To upload a metadata file, under IdP metadata document, choose Choose file. Upload the XML- formatted metadata file from your IdP that you downloaded in the previous step. 3. To use a metadata URL, go to your IdP that you set up in the previous step and obtain its Metadata URL. Go back to the WorkSpaces Secure Browser console, and under IdP metadata URL, enter the metadata url that you obtained from your IdP. 4. When you are done, choose Next. 5. For portals where you have enabled the Require encrypted SAML assertions from this provider option, you need to download the encryption certificate from the portal IdP details section and upload it onto your IdP. Then, you can enable the option there. Note WorkSpaces Secure Browser requires the subject or NameID to be mapped and set in the SAML assertion within your IdP's settings. Your IdP can create these mappings automatically. If these mappings aren't configured correctly, your users can't sign in to the web portal and start a session. WorkSpaces Secure Browser requires the following claims to be present in the SAML response. You can find <Your SP Entity ID> and <Your SP ACS URL> from your portal’s service provider details or metadata document, either through the console or the CLI. • An AudienceRestriction claim with an Audience value that sets your SP Entity ID as the target of the response. Example: <saml:AudienceRestriction> <saml:Audience><Your SP Entity ID></saml:Audience> </saml:AudienceRestriction> • A Response claim with an InResponseTo value of the original SAML request ID. Example: Identity provider configuration 37 Amazon WorkSpaces Secure Browser Administration Guide <samlp:Response ... InResponseTo="<originalSAMLrequestId>"> • A SubjectConfirmationData claim with a Recipient value of your SP ACS URL, and an InResponseTo value that matches the original SAML request ID. Example: <saml:SubjectConfirmation> <saml:SubjectConfirmationData ... Recipient="<Your SP ACS URL>" InResponseTo="<originalSAMLrequestId>" /> </saml:SubjectConfirmation> WorkSpaces Secure Browser validates your request parameters and SAML assertions. For IdP-initiated SAML assertions, the details of your request must be formatted as a RelayState parameter in the body of an HTTP POST request. The request body must also contain your SAML assertion as a SAMLResponse parameter. Both of these should be present if you have followed the previous step. The following is an example POST body for an IdP-initiated SAML provider. SAMLResponse=<Base64-encoded SAML assertion>&RelayState=<RelayState> Guidance for using specific IdPs with Amazon WorkSpaces Secure Browser To make sure you correctly configure the SAML federation for your portal, see the links below for documentation from commonly used IdPs. IdP Okta SAML applicati User managemen IdP-initi ated auth Request signing Assertion encryption Single logout on setup t Create SAML app integrati ons User managemen t Applicati on Integrati on Wizard SAML field Applicati on Integrati on Wizard SAML field Applicati on Integrati on Wizard SAML field Applicati on Integrati on Wizard SAML field reference reference reference reference Identity provider configuration 38 Amazon WorkSpaces Secure Browser Administration Guide IdP Entra Ping SAML applicati User managemen IdP-initi ated auth Request signing Assertion encryption Single logout on setup t Create your own Quickstar t: Create Enable single SAML Request Configure Microsoft application and assign sign-on Signature Single Sign-Out SAML Protocol SAML 2.0 single logout for an Verificat enterprise ion application Entra SAML token encryption Enabling IdP-initi ated SSO Configuri ng authentic ation Does PingOne for Enterpris request e support signing in encryptio PingOne n? for Enterprise a user account Users Add a SAML application One Login SAML Custom Add Users to SAML Custom SAML Custom SAML Custom SAML Custom Connector OneLogin Connector Connector Connector Connector (Advanced) Manually (Advanced) (Advanced) (Advanced) (Advanced) (4266907) (4266907) (4266907) (4266907) (4266907) IAM Identity Center Set up your own SAML 2.0 application Set up your own SAML 2.0 application Set up your own SAML 2.0 application N/A N/A N/A Configuring the IAM Identity Center authentication type for Amazon WorkSpaces Secure Browser For the IAM Identity Center type (advanced), you federate IAM Identity Center with your portal. Only select this option if the following applies to you: Identity provider configuration 39 Amazon WorkSpaces Secure Browser Administration Guide • Your IAM Identity Center is configured in the same AWS account and AWS Region as your web portal. • If you are using AWS Organizations, you are using a management account. Before creating a web portal with the IAM Identity Center authentication type, you must
administration-guide-017
administration-guide.pdf
17
own SAML 2.0 application N/A N/A N/A Configuring the IAM Identity Center authentication type for Amazon WorkSpaces Secure Browser For the IAM Identity Center type (advanced), you federate IAM Identity Center with your portal. Only select this option if the following applies to you: Identity provider configuration 39 Amazon WorkSpaces Secure Browser Administration Guide • Your IAM Identity Center is configured in the same AWS account and AWS Region as your web portal. • If you are using AWS Organizations, you are using a management account. Before creating a web portal with the IAM Identity Center authentication type, you must set up IAM Identity Center as a standalone provider. For more information, see Get started with common tasks in IAM Identity Center. Or, you can connect your SAML 2.0 IdP to IAM Identity Center. For more information, see Connect to an external identity provider. Otherwise, you won't have any users or groups to assign to your web portal. If you are already using IAM Identity Center, you can choose IAM Identity Center as a provider type and follow the steps below to add, view, or remove users or groups from your web portal. Note In order to use this authentication type, your IAM Identity Center needs to be in the same AWS account and AWS Region as your WorkSpaces Secure Browser portal. If your IAM Identity Center is in a separate AWS account or AWS Region, follow the instructions for the Standard authentication type. For more information, see the section called “Standard authentication type”. If you're using AWS Organizations, you can only create WorkSpaces Secure Browser portals integrated with IAM Identity Center using a management account. Topics • Creating a web portal with IAM Identity Center • Managing your web portal with IAM Identity Center • Adding additional users and groups to a web portal • Viewing or removing users and groups for your web portal Creating a web portal with IAM Identity Center To create a web portal with IAM Identity Center, follow these steps. Identity provider configuration 40 Amazon WorkSpaces Secure Browser Administration Guide To create a web portal with IAM Identity Center 1. During portal creation at Step 4: Configure identity provider, choose AWS IAM Identity Center. 2. Choose Continue with IAM Identity Center. 3. On the Assign users and groups page, choose the Users and/or Groups tab. 4. Check the box next to the user(s) or group(s) that you want to add to the portal. 5. After you create your portal, the users that you associated can sign into WorkSpaces Secure Browser with their IAM Identity Center user name and password. Managing your web portal with IAM Identity Center To manage your web portal with IAM Identity Center, follow these steps. To manage your web portal with IAM Identity Center 1. After you create your portal, it is listed in the IAM Identity Center console as a configured application. 2. To access this application’s configuration, choose Applications in the sidebar, and look for a configured application with a name that matches the display name for your web portal. Note If you haven’t entered a display name, your portal’s GUID is shown instead. The GUID is the ID that is prefixed to your web portal’s endpoint URL. Adding additional users and groups to a web portal To add additional users and groups to an existing web portal, follow these steps. To add additional users and groups to an existing web portal 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, Web portals, choose your web portal, and then choose Edit. Identity provider configuration 41 Amazon WorkSpaces Secure Browser Administration Guide 3. Choose Identity provider settings and Assign additional users and groups. From here, you can add users and groups to your web portal. Note You can't add users or groups from the IAM Identity Center console. You must do this from the edit page of your WorkSpaces Secure Browser portal. Viewing or removing users and groups for your web portal To view or remove users and groups for your web portal, use the actions available in the Assigned users table. For more information, see Manage access to applications Note You can't view or remove users and groups from the edit page of the WorkSpaces Secure Browserportal. You must do this from the edit page of your IAM Identity Center console. Changing the identity provider type for Amazon WorkSpaces Secure Browser You can change the authentication type of your portal at any time. To do this, follow these steps. • To change from IAM Identity Center to Standard, follow the steps at the section called “Standard authentication type”. • To change from Standard to IAM Identity Center, follow the steps at the section called “IAM Identity Center authentication type”. Changes to the
administration-guide-018
administration-guide.pdf
18
view or remove users and groups from the edit page of the WorkSpaces Secure Browserportal. You must do this from the edit page of your IAM Identity Center console. Changing the identity provider type for Amazon WorkSpaces Secure Browser You can change the authentication type of your portal at any time. To do this, follow these steps. • To change from IAM Identity Center to Standard, follow the steps at the section called “Standard authentication type”. • To change from Standard to IAM Identity Center, follow the steps at the section called “IAM Identity Center authentication type”. Changes to the identity provider type may take up to 15 minutes to deploy, and will not automatically terminate in-progress sessions. You can view identity provider type changes to your portal through AWS CloudTrail by inspecting UpdatePortal events. The type is visible in the request and response payloads of the event. Launching a web portal with Amazon WorkSpaces Secure Browser When you are finished configuring your web portal, you can follow these steps to launch it. Launch 42 Amazon WorkSpaces Secure Browser Administration Guide 1. On the Step 5: Review and launch page, review the settings you selected for your web portal. You can choose Edit to changes settings within a given section. You can also change these settings later on from the Web portals tab of the console. 2. When you're done, choose Launch web portal. 3. To view the status of your web portal, choose Web portals, choose your portal, and then choose View details. A web portal has one of the following statuses: • Incomplete - The web portal's configuration is missing required identity provider settings. • Pending - The web portal is applying changes to its settings. • Active - The web portal is ready and available for use. 4. Wait up to 15 minutes for your portal to become Active. Testing your web portal in Amazon WorkSpaces Secure Browser After you create a web portal, you can sign into the WorkSpaces Secure Browser endpoint to browse your connected websites as an end user would. If you already completed these steps in the section called “Identity provider configuration”, you can skip this section and go to Distributing your web portal in Amazon WorkSpaces Secure Browser. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, Web portals, choose your web portal, and then choose View details 3. Under Web portal endpoint, go to the specified URL for your portal. The web portal endpoint is the access point your users will launch your web portal from after signing in with the identity provider configured for the portal. It's publicly available on the internet and can be embedded into your network. 4. On the WorkSpaces Secure Browser sign-in page, choose Sign in, SAML, and enter your SAML credentials. 5. When you see the Your session is being prepared page, your WorkSpaces Secure Browser session is launching. Do not close or exit this page. 6. The web browser launches, displaying your startup URL and any other additional behavior configured through your browser policy settings. Web portal testing 43 Amazon WorkSpaces Secure Browser Administration Guide 7. You can now browse to connected websites by choosing links or enter URLs into the address bar. Distributing your web portal in Amazon WorkSpaces Secure Browser When you are ready for your users to begin using WorkSpaces Secure Browser, you choose from the following options to distribute the portal: • Add your portal to your SAML application gateway to enable users to launch a session from their IdP directly. You can do this through the IdP-initiated sign-in flow with your SAML 2.0 compliant IdP. For more information, see SP-initiated and IdP-initiated SAML assertions in the section called “Standard authentication type”. Alternatively, you can create a custom SAML application that can deliver IdP-initiated authentication experiences by using SP-initiated flows. For more information, see Create a Bookmark App integration. • Add the portal URL to a website that you own, and use a browser redirect to direct users to the web portal. • Email the portal URL to your users, or push down to a device you manage as a browser home page or bookmark. Web portal distribution 44 Amazon WorkSpaces Secure Browser Administration Guide Managing your web portal in Amazon WorkSpaces Secure Browser After you set up your web portal, you can perform the following actions to manage it. Topics • Viewing web portal details in Amazon WorkSpaces Secure Browser • Editing a web portal in Amazon WorkSpaces Secure Browser • Deleting a web portal in Amazon WorkSpaces Secure Browser • Managing service quotas for your portal in Amazon WorkSpaces Secure Browser • Controlling the interval for re-authenticating a SAML IdP token in Amazon WorkSpaces Secure Browser • Setting up user access logging
administration-guide-019
administration-guide.pdf
19
bookmark. Web portal distribution 44 Amazon WorkSpaces Secure Browser Administration Guide Managing your web portal in Amazon WorkSpaces Secure Browser After you set up your web portal, you can perform the following actions to manage it. Topics • Viewing web portal details in Amazon WorkSpaces Secure Browser • Editing a web portal in Amazon WorkSpaces Secure Browser • Deleting a web portal in Amazon WorkSpaces Secure Browser • Managing service quotas for your portal in Amazon WorkSpaces Secure Browser • Controlling the interval for re-authenticating a SAML IdP token in Amazon WorkSpaces Secure Browser • Setting up user access logging in Amazon WorkSpaces Secure Browser • Managing browser policy in Amazon WorkSpaces Secure Browser • Configuring the Input Method Editor for Amazon WorkSpaces Secure Browser • Configuring in-session localization for Amazon WorkSpaces Secure Browser • Managing IP access controls in Amazon WorkSpaces Secure Browser • Managing the single sign-on extension in Amazon WorkSpaces Secure Browser • Setting up URL filtering in Amazon WorkSpaces Secure Browser • Deep links in Amazon WorkSpaces Secure Browser • Using the session management dashboard in Amazon WorkSpaces Secure Browser • Protecting data in transit with FIPS endpoints and Amazon WorkSpaces Secure Browser • Managing data protection settings in Amazon WorkSpaces Secure Browser • Managing toolbar controls in Amazon WorkSpaces Secure Browser Viewing web portal details in Amazon WorkSpaces Secure Browser To view web portal details, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. Viewing web portal details 45 Amazon WorkSpaces Secure Browser Administration Guide 2. Choose WorkSpaces Secure Browser, Web portals, choose your web portal, and then choose View details. Editing a web portal in Amazon WorkSpaces Secure Browser To edit a web portal, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, Web portals, choose your web portal, and then choose Edit. Note Changes to networking settings or timeout settings immediately end any active portal sessions. Users are disconnected and must reconnect to begin a new session. Changes to Clipboard permissions, File transfer permissions, or Print to local device apply beginning with the first new session. Currently active sessions aren't disconnected. Users connected to active sessions aren't affected by the changes until they disconnect and connect to a new session. Deleting a web portal in Amazon WorkSpaces Secure Browser To delete a web portal, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, Web portals, choose your web portal, and then choose Delete. Managing service quotas for your portal in Amazon WorkSpaces Secure Browser When you create your AWS account, we automatically set default service quotas (also referred to as limits) for resource usage with AWS services. Administrators must be aware of two quotas that Editing a web portal 46 Amazon WorkSpaces Secure Browser Administration Guide might need to be increased to support their use case. These two quotas are the number of web portals you can create in each region, and the number of maximum concurrent sessions you can support with each available instance type in each region. You can request an increase for these from the Service Quotas page in the AWS Console. The following table lists the default service quotas limits. Default quotas within an AWS Region by account Value Web portals Maximum concurrent sessions - standard. regular 3 25 Maximum concurrent sessions - standard.large 10 Maximum concurrent sessions - standard. xlarge 5 To view the service quotas allocated to your account for each region at any time, see the Service Quotas page. Important Service quotas affect one AWS Region at a time. You must request service quota increases in each AWS Region where you need more resources. For more information, Amazon WorkSpaces Secure Browser endpoints and quotas. Topics • Requesting a service quota increase in Amazon WorkSpaces Secure Browser • Requesting a portal increase in Amazon WorkSpaces Secure Browser • Requesting a maximum concurrent sessions increase in Amazon WorkSpaces Secure Browser • Limit example for Amazon WorkSpaces Secure Browser • Other service quotas in Amazon WorkSpaces Secure Browser Managing service quotas 47 Amazon WorkSpaces Secure Browser Administration Guide Requesting a service quota increase in Amazon WorkSpaces Secure Browser To request a service quota increase follow these steps. 1. Open the AWS Support dashboard. 2. Choose Service Limit Increase. Important WorkSpaces Secure Browser service quotas affect one Region at a time. You must request service quota increases in each AWS Region where you need more resources. For more information, see AWS service endpoints. 3. Under Use case description, enter the following information: • If you are requesting an increase for the number of web portals, specify this resource type, and include your AWS Account ID, the region where you would like the increase, and the new limit value.
administration-guide-020
administration-guide.pdf
20
Browser To request a service quota increase follow these steps. 1. Open the AWS Support dashboard. 2. Choose Service Limit Increase. Important WorkSpaces Secure Browser service quotas affect one Region at a time. You must request service quota increases in each AWS Region where you need more resources. For more information, see AWS service endpoints. 3. Under Use case description, enter the following information: • If you are requesting an increase for the number of web portals, specify this resource type, and include your AWS Account ID, the region where you would like the increase, and the new limit value. • If you are requesting an increase for maximum concurrent sessions, specify this resource type, and include your AWS Account ID, the region where you would like the increase, the web portal ARN, and the new limit value. 4. (Optional) To request multiple service quota increases at the same time, complete one quota increase request in the Requests section, and then choose Add another request. Requesting a portal increase in Amazon WorkSpaces Secure Browser A portal is the service’s foundational resource. Each portal is an association between your SAML 2.0 identity provider and your networking connection to the internet and any private web content. Each portal can have a separate portal browser policy and user settings, so administrators will commonly create multiple portals in the same region to address different use cases. For example, you can provide Group A with access to a specific website with restrictive policies (e.g., Clipboard and File transfer disabled), and Group B with access to the general internet without URL filtering. You can create a portal in any supported AWS Region. To view current service availability, see AWS Services by Region. To request a service quota increase Requesting a service quota increase 48 Amazon WorkSpaces Secure Browser Administration Guide 1. Open the Service Quotas page in your desired region. 2. Choose Number of Web Portals. 3. Choose Request an increase at account level. 4. Under Increase quota value, enter in the total amount that you want the quota to be. Requesting a maximum concurrent sessions increase in Amazon WorkSpaces Secure Browser The maximum concurrent sessions quota is the highest amount of users that can be connected at the same time to a portal. If the service quota limit for maximum concurrent sessions is not set appropriately, users may find that a session is not available when they sign in. In addition to increasing this service quota, customers must also ensure that their VPC and subnets have sufficient IP space to support the maximum concurrent sessions. To request a maximum concurrent session increase 1. Open the Service Quotas page in your desired region. 2. Choose Number of Maximum Concurrent Sessions per Portal for the instance type you want to increase. 3. Choose Request an increase at account level. 4. Under Increase quota value, enter in the total amount that you want the quota to be. Note For large or urgent increases, go to your Service Quotas history page, select the link in the status column of your request, link to your support case, and add a reply with details about your use case and/or the urgency. This information helps the service team prioritize requests and ensure sufficient capacity is allocated for your account. Limit example for Amazon WorkSpaces Secure Browser As an example, assume an administrator is configuring two web portals in US East (N. Virginia) for 125 total users. Before creating the web portal, the administrator identifies the first web portal (Portal A) will support 100 users. When testing the workflow for these users, the administrator determines they will need the XL instance type to support streaming of audio and video during Requesting a maximum concurrent sessions increase 49 Amazon WorkSpaces Secure Browser Administration Guide the session. The second web portal (Portal B) needs to be available for up to 25 users to support access to a single static webpage hosted in the customers VPC. When testing this use case, the administrator determines that the standard instance type can support this use case. For portal A, the administrator must submit a service quota increase request to raise the limit for XL instances from the regions default (i.e., 5) to 100. Once fulfilled, the administrator can allocate the capacity by editing the web portal. For portal B, the administrator can move forward without requesting a quota increase (i.e., since the region has a default quota of 25 for standard instance type). Other service quotas in Amazon WorkSpaces Secure Browser You can view and request increases for other quotas listed on the Service Quotas page. In practice, most customers will find it unnecessary to request increases for these limits. These quotas are broadly grouped into two types: Number and Rate. For Number quotas, when you submit a
administration-guide-021
administration-guide.pdf
21
default (i.e., 5) to 100. Once fulfilled, the administrator can allocate the capacity by editing the web portal. For portal B, the administrator can move forward without requesting a quota increase (i.e., since the region has a default quota of 25 for standard instance type). Other service quotas in Amazon WorkSpaces Secure Browser You can view and request increases for other quotas listed on the Service Quotas page. In practice, most customers will find it unnecessary to request increases for these limits. These quotas are broadly grouped into two types: Number and Rate. For Number quotas, when you submit a service quota increase for Number of web portals, you will automatically receive an increase in the number of sub-resources required to create a unique portal. This will be reflected on the Service Quotas page. For example, if you request an increase in portals from 3 to 5, you will automatically receive a service quota increase from 3 to 5 for both browser and user settings. You have the option to re-use or create new sub-resources as desired. On rare occasion, customers may find a use case for increasing the number or rate of other resource quotas. For example, administrators may want to increase the number of browser settings for testing additional portal configurations. These service quota requests will be reviewed and fulfilled on a case-by-case basis. For Rate quotas, the rate limits exposed in Service Quotas should not need to be adjusted, regardless of the account portal limit. Controlling the interval for re-authenticating a SAML IdP token in Amazon WorkSpaces Secure Browser When a user visits a WorkSpaces Secure Browser portal, they can sign in to launch a streaming session. Every sessions begins on the start page, unless they sign in less than 5 minutes ago. The portal checks for identity provider (IdP) tokens to determine whether to prompt the user for credentials when it launches a session. A user without a valid IdP token must enter a user name, password, and (optionally multifactor authentication (MFA) to launch a streaming session. If a user Other service quotas 50 Amazon WorkSpaces Secure Browser Administration Guide already generated a SAML IdP token by signing into their IdP or an app protected by the same IdP, they won't be asked for sign-in credentials. If a user has a valid SAML IdP token, they can access WorkSpaces Secure Browser. You can control the interval required for re-authenticating a SAML IdP token. To control the interval for re-authenticating a SAML IdP token 1. Set the IdP timeout duration with your SAML IdP provider. We recommend configuring your IdP timeout duration with the shortest amount of time necessary for a user to complete their tasks. • For more information about Okta, see Enforce a limited session lifetime for all policies. • For more information about Azure AD, see Configuring authentication session controls. • For more information about Ping, see Sessions. • For more information about AWS IAM Identity Center, see Set session duration. 2. Set your WorkSpaces Secure Browser portal's inactivity and idle timeout values. These values controls the amount of time between a user’s last interaction and when a WorkSpaces Secure Browser session ends due to inactivity. When a session ends, a user will lose their session state (including open tabs, unsaved web content, and history), and return to a fresh state at the start of the next session. For more information, see step 5 in the section called “Web portal creation”. Note If a user's session times out but the user still has a valid SAML IdP token, they don't have to enter their user name and password to start a new WorkSpaces Secure Browser session. To control how tokens are re-authenticated, follow the guides in the previous step. Setting up user access logging in Amazon WorkSpaces Secure Browser You can set up user access logging to record the following user events: • Session start - Marks the beginning of a WorkSpaces Secure Browser session. Setting up user access logging 51 Amazon WorkSpaces Secure Browser Administration Guide • Session end - Marks the end of a WorkSpaces Secure Browser session. • URL navigation - Logs the URL that a user loads. Note URL navigation logs are recorded from the browser history. URLs not recorded in browser history (either visited in incognito mode, or deleted from browser history) are not recorded in logs. It is up to customers to determine whether to turn off incognito mode or history deletion with their browser policy. In addition, the following information is included for each event: • Event time • Username • Web portal ARN Customers are responsible for understanding the potential legal issues that arise with their use of WorkSpaces Secure Browser, and ensuring that their use of WorkSpaces Secure Browser complies with all applicable laws and
administration-guide-022
administration-guide.pdf
22
logs are recorded from the browser history. URLs not recorded in browser history (either visited in incognito mode, or deleted from browser history) are not recorded in logs. It is up to customers to determine whether to turn off incognito mode or history deletion with their browser policy. In addition, the following information is included for each event: • Event time • Username • Web portal ARN Customers are responsible for understanding the potential legal issues that arise with their use of WorkSpaces Secure Browser, and ensuring that their use of WorkSpaces Secure Browser complies with all applicable laws and regulations. These include laws that regulate an employer's ability to monitor an employee's use of WorkSpaces Secure Browser, including activities performed within the application. Activating user access logs on your WorkSpaces Secure Browser portal might result in charges from Amazon Kinesis Data Streams. For more details on pricing, see Amazon Kinesis Data Streams pricing. To activate user access logging in the WorkSpaces Secure Browser console, under User access logging, select the Kinesis Stream ID that you want to use to receive data. The data recorded will be delivered directly to that stream. For more information about how to create an Amazon Kinesis Data Stream, see What Is Amazon Kinesis Data Streams? Note In order to receive logs from WorkSpaces Secure Browser, you must have an Amazon Kinesis Data Stream that starts with "amazon-workspaces-web-*". Your Amazon Kinesis data Setting up user access logging 52 Amazon WorkSpaces Secure Browser Administration Guide stream must either have server-side encryption turned off, or must use AWS managed keys for server-side encryption. For more information about setting server-side encryption in Amazon Kinesis, see How Do I Get Started with Server-Side Encryption?. Topics • User access log examples for Amazon WorkSpaces Secure Browser User access log examples for Amazon WorkSpaces Secure Browser Below is an example of each available event, including Validation, StartSession, VisitPage, and EndSession. The following fields are always included for each event: • timestamp is included as epoch time in milliseconds. • eventType is included as a string. • details is included as another json object. • portalArn and userName are included for every event except for Validation. { "timestamp": "1665430373875", "eventType": "Validation", "details": { "permission": "Kinesis:PutRecord", "userArn": "userArn", "operation": "AssociateUserAccessLoggingSettings", "userAccessLoggingSettingsArn": "userAccessLoggingSettingsArn" } } { "timestamp": "1665179071723", "eventType": "StartSession", "details": {}, "portalArn": "portalArn", "userName": "userName" Log examples 53 Amazon WorkSpaces Secure Browser Administration Guide } { "timestamp": "1665179084578", "eventType": "VisitPage", "details": { "title": "Amazon", "url": "https://www.amazon.com/" }, "portalArn": "portalArn", "userName": "userName" } { "timestamp": "1665179155953", "eventType": "EndSession", "details": {}, "portalArn": "portalArn", "userName": "userName" } Managing browser policy in Amazon WorkSpaces Secure Browser With WorkSpaces Secure Browser, you can set a custom browser policy using Chrome policies available for the latest stable version. There are more than 300 policies you can apply to a web portal. For more information, see the section called “Tutorial: Setting a custom browser policy” and Chrome Enterprise policy list. By using the console view to create a web portal, you can apply the following policies: • StartURL • Bookmarks and bookmark folders • Turning private browsing on and off • History deletion • URL filtering with AllowURL and BlockURL For more information about using console view policies, see Getting started. Managing browser policy 54 Amazon WorkSpaces Secure Browser Administration Guide WorkSpaces Secure Browser applies a baseline browser policy configuration to all portals along with any policies that you specify. You can edit some of these policies with your custom JSON file. For more information, see the section called “Editing the baseline browser policy”. Topics • Tutorial: Setting a custom browser policy in Amazon WorkSpaces Secure Browser • Editing the baseline browser policy in Amazon WorkSpaces Secure Browser Tutorial: Setting a custom browser policy in Amazon WorkSpaces Secure Browser You can set any supported Chrome policy for Linux by uploading a JSON file. To learn more about Chrome policies, see Chrome Enterprise policy list and select the Linux platform. Then, search and review the policies for the most recent stable version. In the following tutorial, you create a web portal with the following policy controls: • Set up bookmarks • Set up default startup pages • Prevent the user from installing other extensions • Prevent the user from deleting history • Prevent the user from accessing incognito mode • Pre-install the Okta plug-in extension for all sessions. Topics • Step 1: Create a web portal • Step 2: Gather policies • Step 3: Create a custom JSON policy file • Step 4: Add your policies to the template • Step 5: Upload your policy JSON file to your web portal Tutorial: Setting a custom browser policy 55 Amazon WorkSpaces Secure Browser Administration Guide Step 1: Create a web portal In order to upload your Chrome policy JSON file, you must
administration-guide-023
administration-guide.pdf
23
installing other extensions • Prevent the user from deleting history • Prevent the user from accessing incognito mode • Pre-install the Okta plug-in extension for all sessions. Topics • Step 1: Create a web portal • Step 2: Gather policies • Step 3: Create a custom JSON policy file • Step 4: Add your policies to the template • Step 5: Upload your policy JSON file to your web portal Tutorial: Setting a custom browser policy 55 Amazon WorkSpaces Secure Browser Administration Guide Step 1: Create a web portal In order to upload your Chrome policy JSON file, you must create a WorkSpaces Secure Browser portal. For more information, see the section called “Web portal creation”. Step 2: Gather policies Search for and locate policies you want from Chrome Policy. You then use the policies to create a JSON file in the next step. 1. Go to Chrome Enterprise policy list. 2. Choose the platform Linux, and then choose the most recent Chrome version. 3. Search for the policies you want to set. For this example, search for extensions to find policies for managing them. Each policy includes a description, Linux preference name, and sample value. 4. From the search results, there are 3 policies that meet the business requirements if used together: • ExtensionSettings – Installs an extension at browser start. • ExtensionInstallBlocklist – Prevents specific extensions from being installed. • ExtensionInstallAllowlist – Allows certain extensions to be installed. 5. Additional policies satisfy the remaining requirements; • ManagedBookmarks – Adds bookmarks to webpages. • RestoreOnStartupURLs – Configures which webpages are opened whenever a new browser window is launched. • AllowDeletingBrowserHistory – Configures whether users can delete their browsing history. • IncognitoModeAvailability – Configures whether users can access incognito mode. Step 3: Create a custom JSON policy file Create a JSON file using a text editor, template, and the policies you found in the previous step. 1. Open a text editor. 2. Copy and paste the following template into your text editor: { Tutorial: Setting a custom browser policy 56 Amazon WorkSpaces Secure Browser Administration Guide "chromePolicies": { "ManagedBookmarks": { "value": [ { "name": "Bookmark 1", "url": "bookmark-url-1" }, { "name": "Bookmark 2", "url": "bookmark-url-2" }, ] }, "RestoreOnStartup": { "value": 4 }, "RestoreOnStartupURLs": { "value": [ "startup-url" ] }, "ExtensionInstallBlocklist": { "value": [ "insert-extensions-value-to-block", ] }, "ExtensionInstallAllowlist": { "value": [ "insert-extensions-value-to-allow", ] }, "ExtensionSettings": { "value": { "insert-extension-value-to-force-install": { "installation_mode": "force_installed", Tutorial: Setting a custom browser policy 57 Amazon WorkSpaces Secure Browser Administration Guide "update_url": "https://clients2.google.com/service/update2/crx", "toolbar_pin": "force_pinned" }, } }, "AllowDeletingBrowserHistory": { "value": should-allow-history-deletion }, "IncognitoModeAvailability": { "value": incognito-mode-availability } } } Step 4: Add your policies to the template Add your custom policies to the template for each business requirement. 1. Set up bookmark URLs. a. Under the value key, add pairs of name and url keys for each bookmark you want to add. b. Set bookmark-url-1 to https://www.amazon.com. c. Set bookmark-url-2 to https://docs.aws.amazon.com/workspaces-web/latest/ adminguide/. "ManagedBookmarks": { "value": [ { "name": "Amazon", "url": "https//www.amazon.com" }, { "name": "Bookmark 2", "url": "https://docs.aws.amazon.com/workspaces-web/latest/ adminguide/" Tutorial: Setting a custom browser policy 58 Amazon WorkSpaces Secure Browser Administration Guide }, ] }, 2. Set up the startup URLs. This policy allows administrators to set the webpages displayed when a user launches a new browser window. a. Set the RestoreOnStartup to 4. This sets the RestoreOnStartup action to open a list of URLs . You can also use other actions on your startup URLs. For more information, see Chrome Enterprise policy list. b. Set RestoreOnStartupURLs to https://www.aboutamazon.com/news. "RestoreOnStartup": { "value": 4 }, "RestoreOnStartupURLs": { "value": [ "https://www.aboutamazon.com/news" ] }, 3. To prevent the user from deleting their browser history, set AllowDeletingBrowserHistory to false. "AllowDeletingBrowserHistory": { "value": false }, 4. To turn off access to Incognito mode access for your users, set IncognitoModeAvailability to 1. "IncognitoModeAvailability": Tutorial: Setting a custom browser policy 59 Amazon WorkSpaces Secure Browser Administration Guide { "value": 1 } 5. Set and enforce the Okta plug-in with the following policies: • ExtensionSettings – Installs an extension at browser start. The extension value is available from the Okta plug-in help page. • ExtensionInstallBlocklist – Prevents specific extensions from being installed. Use a * value to prevent all extensions by default. Administrators can control which extensions to allow on the ExtensionInstallAllowlist. • ExtensionInstallAllowlist allows you to install certain extensions. Since ExtensionInstallBlocklist is set to *, add the Okta plug-in value here to allow it. The following shows an example policy to turn on the Okta plug-in: "ExtensionInstallBlocklist": { "value": [ "*", ] }, "ExtensionInstallAllowlist": { "value": [ "glnpjglilkicbckjpbgcfkogebgllemb", ] }, "ExtensionSettings": { "value": { "glnpjglilkicbckjpbgcfkogebgllemb": { "installation_mode": "force_installed", "update_url": "https://clients2.google.com/service/update2/crx", "toolbar_pin": "force_pinned" } } Tutorial: Setting a custom browser policy 60 Amazon WorkSpaces Secure Browser Administration Guide Step 5: Upload your policy JSON file to your web portal 1. Open the
administration-guide-024
administration-guide.pdf
24
Administrators can control which extensions to allow on the ExtensionInstallAllowlist. • ExtensionInstallAllowlist allows you to install certain extensions. Since ExtensionInstallBlocklist is set to *, add the Okta plug-in value here to allow it. The following shows an example policy to turn on the Okta plug-in: "ExtensionInstallBlocklist": { "value": [ "*", ] }, "ExtensionInstallAllowlist": { "value": [ "glnpjglilkicbckjpbgcfkogebgllemb", ] }, "ExtensionSettings": { "value": { "glnpjglilkicbckjpbgcfkogebgllemb": { "installation_mode": "force_installed", "update_url": "https://clients2.google.com/service/update2/crx", "toolbar_pin": "force_pinned" } } Tutorial: Setting a custom browser policy 60 Amazon WorkSpaces Secure Browser Administration Guide Step 5: Upload your policy JSON file to your web portal 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/workspaces- web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, then choose Web portals. 3. Choose your web portal, and then choose Edit. 4. Choose Policy settings, then choose JSON file upload. 5. Choose Choose File. Navigate to, select, and upload your JSON file. 6. Choose Save. Editing the baseline browser policy in Amazon WorkSpaces Secure Browser In order to deliver the service, WorkSpaces Secure Browser applies a baseline browser policy to all portals. This baseline policy is applied in addition to those you specify from the console view or JSON upload. The following is the list of policies applied by the service in JSON format: { "chromePolicies": { "DefaultDownloadDirectory": { "value": "/home/as2-streaming-user/MyFiles/TemporaryFiles" }, "DownloadDirectory": { "value": "/home/as2-streaming-user/MyFiles/TemporaryFiles" }, "DownloadRestrictions": { "value": 1 }, "URLBlocklist": { "value": [ "file://", "http://169.254.169.254", "http://[fd00:ec2::254]", ] }, "URLAllowlist": { "value": [ Editing the baseline browser policy 61 Amazon WorkSpaces Secure Browser Administration Guide "file:///home/as2-streaming-user/MyFiles/TemporaryFiles", "file:///opt/appstream/tmp/TemporaryFiles", ] } } } Customers can't make changes to the following policies: • DefaultDownloadDirectory – This policy can't be edited. The service overwrites any changes to this policy. • DownloadDirectory – This policy can't be edited. The service overwrites any changes to this policy. Customers can update the following policies for their web portal: • DownloadRestrictions – The default is set to 1 to prevent downloads identified as malicious by Chrome Safe Browsing. For more information, see Prevent users from downloading harmful files. You can set the value from 0 to 4. • The URLAllowlist and URLBlocklist policies can be extended by using the console view URL Filtering feature or JSON upload. However, the baseline URLs can't be overwritten. These policies aren't visible from a JSON file downloaded from your web portal. However, if you visit “chrome://policy” during a session, the remote browser displays the applied policies. Configuring the Input Method Editor for Amazon WorkSpaces Secure Browser An Input Method Editor (IME) is a utility that provides options to the end user to input text in languages that use a keyboard layout other than a QWERTY keyboard. IMEs help users enter text in languages with larger, more complex language sets, such as Japanese, Chinese, and Korean. WorkSpaces Secure Browser sessions include IME support by default. Users can select alternative languages from the IME toolbar in the session or by using keyboard shortcuts. The following languages are currently supported by WorkSpaces Secure Browser's IME: • English • Simplified Chinese (Pinyin) Configuring the Input Method Editor 62 Amazon WorkSpaces Secure Browser Administration Guide • Traditional Chinese (Bopomofo) • Japanese • Korean To select a language from the IME toolbar, do the following: 1. 2. 3. Select the language selector drop-down located on the right side of the black, top panel bar. By default, the selector will show en, for English. In the dropdown menu, choose the desired language. In the submenu that appears after choosing a language, choose additional language details. To select a language using keyboard shortcuts, use the following: • All IMEs • To cycle the IME forward (or move to the right keyboard layout), press Shift+Control+Left Alt. • Japanese • To choose Hiragana, press F6. • To choose Katakana, press F7. • To choose Latin, press F10. • To choose Wide Latin, press F9. • To choose Direct Input, press ALT +, ALT+@, Zenkaku Hankaku. • Korean • To choose Hangul, press Shift+Space. • To choose Hanja, press F9. To remove the IME toolbar and menu, or to turn off the on-screen keyboard from your WorkSpaces Secure Browser sessions, contact Support. Configuring in-session localization for Amazon WorkSpaces Secure Browser When a user starts a session, WorkSpaces Secure Browser detects the user’s local browser language and time zone settings and applies them to the session. This affects the display language during Configuring in-session localization 63 Amazon WorkSpaces Secure Browser Administration Guide the session, and helps ensure that the displayed time matches the current time in the user's location. The session language is determined in the following priority order: 1. The ForcedLanguages policy in the web portal’s browser settings. For more information, see ForcedLanguages. 2. The end user’s local browser language setting. 3. The default value, English (en-US). The time zone is determined by the local time zone
administration-guide-025
administration-guide.pdf
25
Secure Browser detects the user’s local browser language and time zone settings and applies them to the session. This affects the display language during Configuring in-session localization 63 Amazon WorkSpaces Secure Browser Administration Guide the session, and helps ensure that the displayed time matches the current time in the user's location. The session language is determined in the following priority order: 1. The ForcedLanguages policy in the web portal’s browser settings. For more information, see ForcedLanguages. 2. The end user’s local browser language setting. 3. The default value, English (en-US). The time zone is determined by the local time zone settings specified in the end user's browser. If the time zone setting isn't valid, UTC is used. The following components in WorkSpaces Secure Browser support localization: • WorkSpaces Secure Browser sign-in page • WorkSpaces Secure Browser portal status messages (including loading messages and errors) • Chrome browser • System Context menu and Save as window Topics • Supported language codes for Amazon WorkSpaces Secure Browser • Selecting languages in user browser settings Supported language codes for Amazon WorkSpaces Secure Browser The following list shows the language codes currently supported by WorkSpaces Secure Browser. If the user’s local browser is set to use a language code that isn't supported, the session defaults to English (en-US). • German • de – German • de-AT – German (Austria) • de-DE – German (Germany) • de-CH – German (Switzerland) Supported language codes 64 Amazon WorkSpaces Secure Browser Administration Guide • de-LI – German (Liechtenstein) • English • en – English • en-AU – English (Australia) • en-CA – English (Canada) • en-IN – English (India) • en-NZ – English (New Zealand) • en-ZA – English (Southern Africa) • en-GB – English (United Kingdom) • en-US – English (United States) • Spanish • es – Spanish • es-AR – Spanish (Argentina) • es-CL – Spanish (Chile) • es-CO – Spanish (Colombia) • es-CR – Spanish (Costa Rica) • es-HN – Spanish (Honduras) • es-419 – Spanish (Latin America) • es-MX – Spanish (Mexico) • es-PE – Spanish (Peru) • es-ES – Spanish (Spain) • es-US – Spanish (United States) • es-UY – Spanish (Uruguay) • es-VE – Spanish (Venezuela) • French • fr – French • fr-CA – French (Canada) • fr-FR – French (France) • fr-CH – French (Switzerland) Supported language codes • Indonesian 65 Administration Guide Amazon WorkSpaces Secure Browser • id – Indonesian • id-ID – Indonesian (Indonesia) • Italian • it – Italian • it-IT – Italian (Italy) • it-CH – Italian (Switzerland) • Japanese • ja – Japanese • ja-JP – Japanese (Japan) • Korean • ko – Korean • ko-KR – Korean (Korea) • Portuguese • pt – Portuguese • pt-BR – Portuguese (Brazil) • pt-PT – Portuguese (Portugal) • Chinese • zh – Chinese • zh-CN – Chinese (China) • zh-HK – Chinese (Hong Kong) • zh-TW – Chinese (Taiwan) Selecting languages in user browser settings To set a user's local browser settings, follow the appropriate steps. • In Chrome, choose Settings, choose Languages, and then order the languages based on preference. • In Firefox, choose Settings, General, Language, and select the language from the drop-down menu. • In Edge, choose Settings, choose Languages, and then order the languages based on preference. 66 User browser settings Amazon WorkSpaces Secure Browser Administration Guide Managing IP access controls in Amazon WorkSpaces Secure Browser WorkSpaces Secure Browser allows you to control which IP addresses your web portal can be accessed from. By using IP access settings, you can define and manage groups of trusted IP addresses, and only allow users to access their portal when they're connected to a trusted network. By default, WorkSpaces Secure Browser allows users to access their web portal from anywhere. An IP access control group acts as a virtual firewall that filters which IP address a user can use to connect to the web portal. When associated with your web portal, IP access settings will detect the user IP before authentication to determine whether they are eligible to connect. Once connected, WorkSpaces Secure Browser continuously monitors a user's IP address to ensure they remain connected from a trusted network. If a user's IP changes, WorkSpaces Secure Browser will detect and terminate the session. To specify the CIDR address ranges, add rules to your IP access control group, and then associate the group with your web portal. You can associate each IP access setting with one or more web portals. To specify the public IP addresses and ranges of IP addresses for your trusted networks, add rules to your IP access control groups. If your users access their web portal through a NAT gateway or VPN, you must create rules that allow traffic from the public IP addresses for the NAT gateway or VPN. Note Customers are
administration-guide-026
administration-guide.pdf
26
Browser will detect and terminate the session. To specify the CIDR address ranges, add rules to your IP access control group, and then associate the group with your web portal. You can associate each IP access setting with one or more web portals. To specify the public IP addresses and ranges of IP addresses for your trusted networks, add rules to your IP access control groups. If your users access their web portal through a NAT gateway or VPN, you must create rules that allow traffic from the public IP addresses for the NAT gateway or VPN. Note Customers are responsible for understanding the potential legal issues that arise with their use of WorkSpaces Secure Browser, and must ensure that their use of WorkSpaces Secure Browser complies with all applicable laws and regulations. This includes laws that regulate an employer's ability to monitor an employee's use of WorkSpaces Secure Browser, including activities performed within the application. Topics • Creating an IP access control group in Amazon WorkSpaces Secure Browser • Associating an IP access setting with a web portal in Amazon WorkSpaces Secure Browser • Editing an IP access control group in Amazon WorkSpaces Secure Browser • Deleting an IP access control group in Amazon WorkSpaces Secure Browser Managing IP access controls 67 Amazon WorkSpaces Secure Browser Administration Guide Creating an IP access control group in Amazon WorkSpaces Secure Browser To create an IP access control group, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. In the navigation pane, choose IP access controls. 3. Choose Create IP access control group. 4. 5. In the Create IP access control group dialog box, enter a name (required) and description (optional) for the group. Enter the IP address or CIDR IP range that will be associated to Source, and a Description (optional). 6. Under Tags, choose whether to tag a key value pair for each IP access control group. 7. When you are done adding rules and tags, choose Save. Associating an IP access setting with a web portal in Amazon WorkSpaces Secure Browser To associate an IP access control group with an existing web portal, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. In the navigation pane, choose Web portals. Select the web portal, and choose Edit. 2. 3. 4. Under IP access control group, and select the IP access control groups for the web portal. 5. Choose Save. To associate an IP access control group when creating a new web portal, follow these steps. 1. Complete steps 1 through 4 in the section called “Portal settings” to access IP Access Control (optional). 2. Choose Create IP access controls. Creating an IP access control group 68 Amazon WorkSpaces Secure Browser Administration Guide 3. 4. In the Create IP Group dialog box, enter a name (required) and description (optional) for the group. Enter the IP address or CIDR IP range that will be associated to Source, and a Description (optional). 5. Under Tags, choose whether to tag a key value pair for each IP access control group. 6. When you are done adding rules and tags, choose Create IP access control. 7. Your IP access control group will be associated to this web portal when launched. Editing an IP access control group in Amazon WorkSpaces Secure Browser You can delete a rule from an IP access setting at any time. If you remove a rule that was used to allow a connection to a web portal, any users with a current session will be disconnected from the web portal. To edit an IP access control group, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. In the navigation pane, choose IP access controls. Select the group and choose Edit. Edit the existing rules Source and Description (optional), or add additional rules. 2. 3. 4. 5. Under Tags, choose whether to tag a key value pair for each IP access control group. 6. When you are done adding rules and tags, choose Save. 7. If you updated an existing IP access setting, wait up to 15 minutes for the new or edited rule to take effect. Deleting an IP access control group in Amazon WorkSpaces Secure Browser You can delete a rule from an IP access control group at any time. If you remove a rule that was used to allow a connection to a web portal, any users with a current session will be disconnected from the web portal. Editing an IP access control group 69 Amazon WorkSpaces Secure Browser Administration Guide To delete an IP access control group, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. In the navigation pane, choose IP access control group. Select the group and choose Delete. 2.
administration-guide-027
administration-guide.pdf
27
access control group in Amazon WorkSpaces Secure Browser You can delete a rule from an IP access control group at any time. If you remove a rule that was used to allow a connection to a web portal, any users with a current session will be disconnected from the web portal. Editing an IP access control group 69 Amazon WorkSpaces Secure Browser Administration Guide To delete an IP access control group, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. In the navigation pane, choose IP access control group. Select the group and choose Delete. 2. 3. Managing the single sign-on extension in Amazon WorkSpaces Secure Browser You can enable an extension for your end users to have a better portal sign-on experience. For example, if you use Okta as your portal’s SAML 2.0 identity provider (IdP), and you also use it as the IdP for the websites you want users to visit during a session, you can pass the Okta sign-in cookie to the session with the extension. Afterwards, when users visit a website that requires the Okta domain cookie, they can access the website without having to sign in during the session. The extension is supported in Chrome and Firefox browsers. The extension enables cookie synchronization for the allowed domains from the users sign-in to the session. The extension does not require the user to sign in, and it works behind the scenes to enable cookie synchronization without requiring the user to take any actions after installation. No data is stored by the extension. By default, extensions are not enabled in Chrome in Incognito windows or Firefox Private Browsing windows. Users can enable them manually. For more information about Chrome, see Extensions in Incognito mode. For more information about Firefox, see Extensions in Private Browsing. Users are prompted to install the extension when they sign into a portal. For details about the user experience with the extension, see the section called “Single sign-on extension”. Topics • Identifying domains for the single sign-on extension in Amazon WorkSpaces Secure Browser • Adding the single sign-on extension to a new web portal in Amazon WorkSpaces Secure Browser • Adding the single sign-on extension to an existing web portal in Amazon WorkSpaces Secure Browser • Editing or removing the single sign-on extension in Amazon WorkSpaces Secure Browser Managing the single sign-on extension 70 Amazon WorkSpaces Secure Browser Administration Guide Identifying domains for the single sign-on extension in Amazon WorkSpaces Secure Browser First, determine which domains you need for your SAML IdP and websites. You can add up to 10 domains. You are responsible for testing and identifying the appropriate domain for the cookies to be synchronized. Changes might be required at the IdP or website authentication level to ensure single sign-on works as expected. To see which domains to use with most common IdP, refer to the following table: IdP and domains IdP Okta Entra ID AWS Identity Center One Login Duo Domain okta.com microsoftonline.com awsapps.com onelogin.com duosecurity.com Adding the single sign-on extension to a new web portal in Amazon WorkSpaces Secure Browser To allow the extension when creating a new web portal, follow these steps. 1. Follow the steps in the section called “Web portal creation” until you get to the section called “User settings”. 2. For step 1 of the section called “User settings”, under User permissions, choose Allowed to enable the extension for your web portal. 3. Enter the domain for cookie synchronization, and choose Add new domain. 4. Complete the steps in the section called “User settings” and the remaining sections in the section called “Web portal creation” to create your web portal. Identifying domains for the single sign-on extension 71 Amazon WorkSpaces Secure Browser Administration Guide Adding the single sign-on extension to an existing web portal in Amazon WorkSpaces Secure Browser To add the extension to an existing web portal, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home. 2. Select the web portal to edit. 3. Choose User settings, Users permissions, and Allowed to enable the extension for your web portal. 4. 5. Enter the domain for cookie synchronization, choose Add new domain. Save your portal changes. The portals will prompt users to install the extension within 15 minutes. Editing or removing the single sign-on extension in Amazon WorkSpaces Secure Browser To edit domains or remove the extension, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home. 2. Select the web portal to edit. 3. Choose User settings, Users permissions, and Not allowed to remove the extension for your web portal. 4. Remove or edit individual domains. 5. Once removed, sessions will no longer synchronize cookies, even if the user has the WorkSpaces Secure Browser extension installed in their browser. Setting up URL filtering
administration-guide-028
administration-guide.pdf
28
portals will prompt users to install the extension within 15 minutes. Editing or removing the single sign-on extension in Amazon WorkSpaces Secure Browser To edit domains or remove the extension, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home. 2. Select the web portal to edit. 3. Choose User settings, Users permissions, and Not allowed to remove the extension for your web portal. 4. Remove or edit individual domains. 5. Once removed, sessions will no longer synchronize cookies, even if the user has the WorkSpaces Secure Browser extension installed in their browser. Setting up URL filtering in Amazon WorkSpaces Secure Browser You can use Chrome Policy to filter which URLs users can access from their remote browser. Chrome Policy provides two mechanisms to filter URLs: URLAllowlist and URLBlocklist. You can use the WorkSpaces Secure Browser console interface to configure URL filtering as a portal setting, or Adding the single sign-on extension to an existing web portal 72 Amazon WorkSpaces Secure Browser Administration Guide you can add it as part of your custom JSON statement (either in the inline editor, or as a JSON file upload). Topics • Setting up URL filtering using the console in Amazon WorkSpaces Secure Browser • Setting up URL filtering using the JSON editor or file upload for Amazon WorkSpaces Secure Browser Setting up URL filtering using the console in Amazon WorkSpaces Secure Browser To set up URL filtering using the console, follow these steps. 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, Web portals, choose your web portal, and then choose View details. 3. For URL filtering, choose from the following options: • Allow access to all URLs: By default, a web portal allows access to all URLs. You can add specific websites to the BlockURL list to prevent users from visiting those sites during a session. For example, adding www.anycorp.com to the BlockURL list will prevent user from navigating to www.anycorp.com during their session. • Block access to all URLs: By default, the web portal blocks access to all URLS. You can add specific websites to the URL allowlist to curate a list of websites users can visit, and block traffic to any other websites. Consider adding each URL as a bookmark to enable 1-click access for users during their session. • Advanced configuration: Choose this option to create allowURL and blockURL lists in parallel. The URL allowlist has priority over URL blocklist. This option enables URL filtering by path. For example, you can add www.anycorp.com to the blocklist, and then add www.anycorp.com/hr to the allow list. This allows users to visit www.anycorp.com/hr, but they won't be able to access other URL paths, such as www.anycorp.com/finance. Setting up URL filtering using the console 73 Amazon WorkSpaces Secure Browser Administration Guide For more guidance about using block and allow URLs, see Allow or block access to websites. Add URLs to these lists following Chrome's blocklist filter format for the best results. For more information, see URL blocklist filter format. Setting up URL filtering using the JSON editor or file upload for Amazon WorkSpaces Secure Browser To set up URL filtering using the JSON editor or file upload, follow these steps. 1. From the Policy settings module, choose JSON Editor and bypass the console UI module for either Editor or File Upload view. • Editor allows customers to create custom policy statements inline in the console. Editor highlights errors in the JSON statement during policy creation. • File upload allows customers to add a JSON file created outside the console (such as exported from an existing Chrome browser). 2. See Chrome Policy details for URLAllowlist and URLBlocklist to properly format an allow/ denyURL list for your web portal. For more information, see URLAllowlist and URLBlocklist. Deep links in Amazon WorkSpaces Secure Browser When a user signs into WorkSpaces Secure Browser, they start the session on a home page set by the administrator. You can also allow portals to receive deep links that connect users to a specific website during a session. When a deep link is selected, the portal displays the URL specified in the deep link. The link is displayed alongside the home page(s) configured for session start, or by itself if a session is already in progress. This feature allows administrators to create more dynamic user experiences with WorkSpaces Secure Browser. Deep links open pages in a WorkSpaces Secure Browser session. If a session is already running, it will open the deep link in a new tab. If a session is not already running, it will open the deep link URL in a new tab, and the portal default home page in a separate tab. If a deep link contains more than one URL, it will display the deep link URL listed first
administration-guide-029
administration-guide.pdf
29
configured for session start, or by itself if a session is already in progress. This feature allows administrators to create more dynamic user experiences with WorkSpaces Secure Browser. Deep links open pages in a WorkSpaces Secure Browser session. If a session is already running, it will open the deep link in a new tab. If a session is not already running, it will open the deep link URL in a new tab, and the portal default home page in a separate tab. If a deep link contains more than one URL, it will display the deep link URL listed first in focus, with each subsequent URL (including the default home page) opened in separate tabs. Topics • Setting up deep links in Amazon WorkSpaces Secure Browser • Using URL filtering for deep links in Amazon WorkSpaces Secure Browser Setting up URL filtering using the JSON editor or file upload 74 Amazon WorkSpaces Secure Browser Administration Guide Setting up deep links in Amazon WorkSpaces Secure Browser To allow permission for deep links, choose Allowed when creating user settings. The site you want to deep link to must be URL-encoded. For example, to link a user to “https://www.example.com/? query=true”, update the link to https%3A%2F%2Fwww.example.com%2F%3Fquery%3Dtrue. A deeplink can contain up to 10 URLs, delineated by comma. For example: https://<uuid>.workspaces-web.com/?deepLinks=https%3A%2F%2Fwww.example.com%2F %3Fquery%3Dtrue,https%3A%2F%2Fwww.example.com%2F%3Fquery%3Dtrue2,https%3A %2F%2Fwww.example.com%2F%3Fquery%3Dtrue3,https%3A%2F%2Fwww.example.com%2F %3Fquery%3Dtrue4. For more information about allowing deep links, see the section called “User settings”. Using URL filtering for deep links in Amazon WorkSpaces Secure Browser Any user you share this portal link with can manipulate the deep link value to visit a website, if that domain is reachable from the portal and not on the URL blocklist. To create a restrictive allowlist or blocklist to prevent users from visiting unintended domains with your portal, use URL filtering. The allowlist and blocklist for a portal can be edited with URL filtering in your portal’s browser settings. To do this, append the URL to an allow-listed portal URL in the following format, where UUID is the portal id: https://<uuid>.workspaces-web.com/?deepLinks=https%3A%2F %2Fwww.example.com%2F%3Fquery%3Dtrue For more information, see the section called “Setting up URL filtering” and Allow or block access to websites. Using the session management dashboard in Amazon WorkSpaces Secure Browser Use the session management dashboard on your WorkSpaces Secure Browser console to monitor and manage active and complete sessions. Dashboard access To access the dashboard, follow these steps. Setting up deep links 75 Amazon WorkSpaces Secure Browser To access the dashboard Administration Guide 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose WorkSpaces Secure Browser, Web portals, and choose your web portal. 3. Choose the Session tab or choose View sessions to open the dashboard in a split panel below. Dashboard filters In the sessions panel, you can filter sessions by the following properties or values: • Status • Active – Indicates a session is currently running. To terminate the session, see below. • Terminated – Indicates a session is no longer active. • Session ID • Username • Session start time Terminate sessions To terminate a session, follow these steps. To terminate a session 1. On the sessions dashboard, select the session you want to stop. 2. Choose Terminate. 3. Disconnected users lose all state from the session. All open tabs, browser history, and files downloaded to the secure browser are recycled. Session history The dashboard contains sessions from the last 35 days. You can use the CLI to list sessions, with or without a filter. The session history is delivered as JSON, which administrators can process, manage, and store in a separate repository. The following are sample CLI commands for managing sessions in the US-West-2 (Oregon) region. Dashboard filters 76 Amazon WorkSpaces Secure Browser Administration Guide To list all sessions for a web portal, run the following command: aws workspaces-web list-sessions --portal-arn arn:aws:workspaces-web:us- west-2:<accountId>:portal/<portalId> To list all sessions for a specific user of a web portal, run the following command: aws workspaces-web list-sessions --portal-arn arn:aws:workspaces-web:us- west-2:<accountId>:portal/<portalId> --username <username> Protecting data in transit with FIPS endpoints and Amazon WorkSpaces Secure Browser By default, when you communicate with the WorkSpaces Secure Browser service as an administrator using the console, the AWS Command Line Interface (AWS CLI), or an AWS SDK, or during a user’s session, all data in transit is encrypted using TLS 1.2. If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. When you use a FIPS endpoint, all data in transit is encrypted using cryptographic standards that comply with Federal Information Processing Standard (FIPS) 140-3. For information about FIPS endpoints, including a list of WorkSpaces Secure Browser endpoints, see https://aws.amazon.com/compliance/fips. After a portal is created with FIPS endpoints, all user sessions and administrative changes are automatically made using FIPS 140-3 endpoints. You can use the AWS_USE_FIPS_ENDPOINT=true environment
administration-guide-030
administration-guide.pdf
30
user’s session, all data in transit is encrypted using TLS 1.2. If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. When you use a FIPS endpoint, all data in transit is encrypted using cryptographic standards that comply with Federal Information Processing Standard (FIPS) 140-3. For information about FIPS endpoints, including a list of WorkSpaces Secure Browser endpoints, see https://aws.amazon.com/compliance/fips. After a portal is created with FIPS endpoints, all user sessions and administrative changes are automatically made using FIPS 140-3 endpoints. You can use the AWS_USE_FIPS_ENDPOINT=true environment variable to locate FIPS endpoints and send requests with the SDK. The following is an example. $ export AWS_USE_FIPS_ENDPOINT=true $ aws workspaces-web list-portal You can also use the —endpoint-url option to send requests directly to FIPS endpoints. The following is an example calling list portals in the US-West-2 (Oregon) Region: $ aws workspaces-web list-portal --endpoint-url https://workspaces-web-fips.us- west-2.amazonaws.com Protecting data in transit 77 Amazon WorkSpaces Secure Browser Administration Guide Managing data protection settings in Amazon WorkSpaces Secure Browser Data Protection Settings are used to help protect data from being shared during a session. Settings can be created and applied to multiple portals. Topics • Inline data redaction in Amazon WorkSpaces Secure Browser • Default redaction configuration in Amazon WorkSpaces Secure Browser • Base inline redaction in Amazon WorkSpaces Secure Browser • Custom inline redaction in Amazon WorkSpaces Secure Browser • Create data protection settings in Amazon WorkSpaces Secure Browser • Associate data protection settings in Amazon WorkSpaces Secure Browser • Edit data protection settings in Amazon WorkSpaces Secure Browser • Delete data protection settings in Amazon WorkSpaces Secure Browser Inline data redaction in Amazon WorkSpaces Secure Browser By adding inline data redaction to a portal, you can automatically predict and redact certain data from a string of text displayed in web pages. You can create redaction policies by choosing from built-in patterns (such as social security numbers or credit card numbers), or create their own custom data types using regular expression and keywords. Policies include configurable levels of enforcement and controls for the URLs where redaction should be enforced. The following components determine when data is redacted: • Data Protection Settings - Data Protection Settings is the name of the resource that includes your data types and enforcement criteria. To use this resource, first create your settings, then associate them to a portal. When users launch a session, your settings are enforced during the session. • In-session browser extension - When you associate redaction settings with your portal, the session browser will launch with a system-enforced browser extension that enforces your settings. Data Protection Settings enforce redaction through pattern matching (Regular Expressions) and keyword searching following your confidence level and URL enforcement Data protection settings 78 Amazon WorkSpaces Secure Browser Administration Guide configuration. Content is predicted from text strings and redacted before displayed on the screen. The extension also sets related browser policies that govern users' ability to bypass redaction (such as disabled private browsing, access to developer tools, and network inspection). The following Chrome browser policy changes are enforced by the in-session browser extension. For more information, see Chrome Enterprise policy list. • Enforce browser policy to prevent users from viewing the session without redaction: • IncognitoModeAvailability = 1 • DeveloperToolsAvailability = 2 • BrowserAddPersonEnabled = false • BrowserGuestModeEnabled = false • The extension also prevents users from downloading HTML files from URLs that are enforcing data protection settings by canceling the download event. In general, you should use redaction with private, structured websites (such as your customer management tools, ticketing systems, or wikis), and not for unstructured public browsing (such as Facebook or Google). You can choose from built-in data types (see below for the full list), or define custom data types using your own regular expression values and keywords. Administrators are responsible for testing and validating that each data type, confidence level, and URL enforcement are working as expected. AWS cannot guarantee compatibility with custom websites or applications provided by third parties. WorkSpaces Secure Browser does not currently support redaction of supported or custom data types in non-text formats, including text in the following formats: • Images, such as JPEG, PNG, or GIF • Web pages that enable users to use dynamic word processing or editing, such as Google Docs or Sheets • Audio or video streams accessed in the browser, such as a YouTube videos • PDFs viewed by the Chrome browser Do not use redaction for content in an unsupported format. Administrators are responsible for validating site and content compatibility prior to granting users access to content they intend to be redacted. Inline data redaction 79 Amazon WorkSpaces Secure Browser Administration Guide Default redaction configuration in Amazon WorkSpaces Secure Browser The default redaction configuration will automatically
administration-guide-031
administration-guide.pdf
31
as JPEG, PNG, or GIF • Web pages that enable users to use dynamic word processing or editing, such as Google Docs or Sheets • Audio or video streams accessed in the browser, such as a YouTube videos • PDFs viewed by the Chrome browser Do not use redaction for content in an unsupported format. Administrators are responsible for validating site and content compatibility prior to granting users access to content they intend to be redacted. Inline data redaction 79 Amazon WorkSpaces Secure Browser Administration Guide Default redaction configuration in Amazon WorkSpaces Secure Browser The default redaction configuration will automatically apply a confidence level and URL enforcement for all built-in data types in the data protection settings. You have the option to override the default configuration when adding a built-in data type. Confidence levels allow you to fine-tune the redaction logic for built-in data types using a combination of format, keywords, and unformatted text. Choose the level of strictness for how redaction is applied, including High, Medium, or Low. The default value will apply to all data types, unless an override is applied at the data type level. In general, start with a default configuration of Medium, and refine by validating that the redaction is enforced as expected on your sites. Confidence level Description Example High Medium Low Requires a formatted text pattern match in order for SSN of 123-45-6798 would be redacted, while content to be redacted. 123456789 would not. Redaction considers both formatted and unformatt SSN of 123-45-6798 would be redacted. 123456789 ed text, and adds keyword would be redacted if detected associate to the logic. nearby a keyword (such as "social security number"). Redaction enforced for both formatted pattern + SSN in either format - 123-45-6798 and 123456789 unformatted pattern without keyword. - are redacted without requiring keyword. You must set the default redaction configuration for all data types. You can choose from the following options: • All URLs • Specific URLs • Advanced configuration Default redaction configuration 80 Amazon WorkSpaces Secure Browser Administration Guide The default value will apply to all data types, unless an override is applied at the data type level. URL enforcement uses similar logic to Chrome policy for managing allow and blocklists. For guidance using block and allow URLs, see Allow or block access to websites. For the best results, add URLs to these lists following Chrome's blocklist filter format. For more information, see URL blocklist filter format. Base inline redaction in Amazon WorkSpaces Secure Browser Inline data redaction has support for built-in patterns (such as social security numbers and credit card numbers), which you can find listed under Base inline redaction. Choose the data type(s) from the drop-down menu, and specify the replacement value for each data type. All data types follow the default configuration enforcement pattern above, but you can choose to override the confidence level, and fine-tune the domain enforcement pattern for each data type. To enter an alternative value from the default configuration, choose Confidence level override. For example, with the default configuration set to Medium, you might notice during testing that one of your data types is not being redacted reliably. You can set the override to Low to increase the chance of redaction, without adjusting the logic used for your other data types. To fine-tune the way redaction is applied across URLs without changing the default configuration, apply URL enforcement overrides. For example, you can set use URL overrides to enforce email address redaction in your customer relationship management system, without breaking user access to email addresses in the company directory website or web based email. The following is a list of data types and their corresponding built-in pattern IDs: builtInPatternId awsAccessKey: awsSecretKey: cardNumbers: crypto: cusipNum: date: Base inline redaction Data type AWS Access Key AWS Secret Key Credit Card Numbers Cryptocurrency Addresses CUSIP Number Date 81 Amazon WorkSpaces Secure Browser Administration Guide builtInPatternId Data type deaNum: dob: driversLicense: emailAddress: ein: expDate: US DEA Numbers Date of Birth US Driver’s Licenses Email Address US Employer Identification Number Credit Card Expiration Date healthInsuranceNum: Medicare Health Insurance Claim Number hipaaCode: indivTaxId: ipAddr: isin: jwt: locationCoord: macAddr: HIPAA ICD-10 Code US Individual Tax Id IP Address International Securities Identification Numbers JSON Web Token Location Coordinates MAC Address medicareBeneficiaryId: Medicare Beneficiary Number npi: ndc: passportNum: phoneNum: routingNumber: National Provider Identification Number National Drug Codes (NDC) US Passport Number Phone Number ABA Routing Number Base inline redaction 82 Amazon WorkSpaces Secure Browser Administration Guide builtInPatternId Data type ssn: swiftCode: time: vin: US Social Security Number SWIFT Code Time US Vehicle Identification Number Custom inline redaction in Amazon WorkSpaces Secure Browser Customers can define their own patterns using regular expression, such as custom internal application IDs. To create your custom inline redaction pattern, follow these steps: 1. Go to your data protection
administration-guide-032
administration-guide.pdf
32
Numbers JSON Web Token Location Coordinates MAC Address medicareBeneficiaryId: Medicare Beneficiary Number npi: ndc: passportNum: phoneNum: routingNumber: National Provider Identification Number National Drug Codes (NDC) US Passport Number Phone Number ABA Routing Number Base inline redaction 82 Amazon WorkSpaces Secure Browser Administration Guide builtInPatternId Data type ssn: swiftCode: time: vin: US Social Security Number SWIFT Code Time US Vehicle Identification Number Custom inline redaction in Amazon WorkSpaces Secure Browser Customers can define their own patterns using regular expression, such as custom internal application IDs. To create your custom inline redaction pattern, follow these steps: 1. Go to your data protection setting. 2. Choose Custom inline redaction and add. 3. Enter a name for the custom data type. 4. Enter your regular expression value. • Regular expression values must match the JavaScript regular expression literal syntax. For more information, see Regular expressions. An example regular expression is /ex[am]+ple/ i. • Make sure to test your custom patterns on the websites that you plan on supporting. If custom patterns are written with errors, they can introduce unintended performance issues. 5. Specify the replacement value. 6. Choose More options for more optional customizations, including the following: • Add keywords to fine tune the redaction logic. Keywords can increase the accuracy of enforcement. Add keywords in the Javascript regular expression literal syntax. For more information, see Regular expressions. For example, if you are creating a custom redaction pattern for client IDs used in an internal system, you can add /client name/i to the keyword field to inform the scanning and detection logic. • Apply URL enforcement overrides to fine-tune the way redaction is applied across URLs, without changing the default configuration. Custom inline redaction 83 Amazon WorkSpaces Secure Browser Administration Guide For example, you can set use URL overrides to enforce email address redaction in your customer relationship management system, without breaking user access to email addresses in the company directory website or web-based email. • Enter a description (optional) for the data type. Create data protection settings in Amazon WorkSpaces Secure Browser You can create data protection settings in WorkSpaces Secure Browser. To create data protection settings 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. In the left-hand navigation pane, choose Data Protection Settings. 3. Choose Create Data Protection Settings. 4. 5. Enter a display name (required) and description (optional) for the setting. Select the default settings for inline redaction. You can set the following: • The level of strictness of all data types • The domains on which redaction should be enforced 6. Choose your base inline redaction data types from the supported types, or create a custom data type. You can set overrides for each data type, including the level of strictness and domain exceptions. 7. Add any Tags (optional) for reporting. 8. When you are done, choose Save. Associate data protection settings in Amazon WorkSpaces Secure Browser You can associate data protection settings in WorkSpaces Secure Browser. To associate a data protection setting with an existing portal 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. Create data protection settings 84 Amazon WorkSpaces Secure Browser Administration Guide 2. 3. In the left hand navigation pane, choose Web portals. Select the web portal, and choose Edit. 4. Under Data protection settings, select the setting for your portal. 5. Choose Save. To associate a data protection setting when creating a new portal, follow these steps. To associate a data protection setting when creating a new portal 1. Follow the instructions in the section called “Web portal creation” to create a portal, until you get to data protection setting. 2. Choose your data protection setting from the drop-down menu. 3. Complete the steps in the section called “Web portal creation” to finish creating your portal. To create a data protection setting when creating a new portal, follow these steps. To create a data protection setting when creating a new portal 1. Follow the instructions in the section called “Web portal creation” to create a portal, until you get to data protection setting. 2. Choose data protection settings from the drop-down menu. 3. 4. Enter a display name (required) and description (optional) for the setting. Select the default settings for inline redaction. You can set the following: • The level of strictness of all data types • The domains on which redaction should be enforced 5. Choose your base inline redaction data types from the supported types, or create a custom data type. You can set overrides for each data type, including the level of strictness and domain exceptions. 6. Add any Tags (optional) for reporting. 7. When you are done, choose Save. 8. Select the refresh button under data protection settings, then choose your data protection setting from the drop-down menu. 9. Continue to follow the create portal instructions
administration-guide-033
administration-guide.pdf
33
inline redaction. You can set the following: • The level of strictness of all data types • The domains on which redaction should be enforced 5. Choose your base inline redaction data types from the supported types, or create a custom data type. You can set overrides for each data type, including the level of strictness and domain exceptions. 6. Add any Tags (optional) for reporting. 7. When you are done, choose Save. 8. Select the refresh button under data protection settings, then choose your data protection setting from the drop-down menu. 9. Continue to follow the create portal instructions to finish creating your portal. Associate data protection settings 85 Amazon WorkSpaces Secure Browser Administration Guide Edit data protection settings in Amazon WorkSpaces Secure Browser You can edit data protection settings in WorkSpaces Secure Browser. To edit data protection settings 1. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 2. Choose data protections settings and the data protection setting you want to edit from the list view. 3. You can update the name, description, default settings, data types (supported or custom), and apply confidence level or domain overrides. 4. Choose Save. Delete data protection settings in Amazon WorkSpaces Secure Browser You can delete data protection settings in WorkSpaces Secure Browser. To delete data protection settings 1. If you have a portal associated with a data protection setting, you must first remove the association before deleting the data protection setting. 2. Open the WorkSpaces Secure Browser console at https://console.aws.amazon.com/ workspaces-web/home?region=us-east-1#/. 3. Choose data protections settings and the data protection setting you want to delete from the list view. 4. Choose Delete. Managing toolbar controls in Amazon WorkSpaces Secure Browser With Toolbar controls, you can configure the toolbar presentation for end user sessions, including the following options: • Features Edit data protection settings 86 Amazon WorkSpaces Secure Browser Administration Guide • Clipboard: When enabled, allows copy/paste with granular controls (copy only, paste only, or both). When disabled, hides icon and prevents usage from the toolbar. • File transfer: When enabled, allows file operations with granular controls (upload only, download only, or both). When disabled, hides icon and prevents transfers. • Microphone: When enabled, allows microphone usage. When disabled, hides icon. • Webcam: When enabled, allows camera usage. When disabled, hides icon. • Dual monitor: When enabled, allows dual monitor usage. When disabled, hides icon. • Full screen: When enabled, allows full screen mode. When disabled, hides icon. • Windows: When enabled, allows moving between windows. When disabled, hides icon. • Settings • Toolbar theme: Controls light or dark mode display. Configuration removes end user theme control. • Toolbar state: Sets docked or detached state of the toolbar. Configuration removes end user control over the toolbar state. • Max resolution: Defines the highest allowed display resolution. Users can only select resolutions up to this defined limit. Toolbar controls 87 Amazon WorkSpaces Secure Browser Administration Guide Security in Amazon WorkSpaces Secure Browser Cloud security at AWS is the highest priority. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third-party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to Amazon WorkSpaces Secure Browser, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors, including the sensitivity of your data, your company’s requirements, and any applicable laws and regulations that apply to your data. This documentation helps you understand how to apply the shared responsibility model when using Amazon WorkSpaces Secure Browser. It shows you how to configure Amazon WorkSpaces Secure Browser to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Amazon WorkSpaces Secure Browser resources. Contents • Data protection in Amazon WorkSpaces Secure Browser • Identity and Access Management for Amazon WorkSpaces Secure Browser • Incident response in Amazon WorkSpaces Secure Browser • Compliance validation for Amazon WorkSpaces Secure Browser • Resilience in Amazon WorkSpaces Secure Browser • Infrastructure security in Amazon WorkSpaces Secure Browser • Configuration and vulnerability analysis in Amazon WorkSpaces Secure Browser • Access APIs using an interface VPC endpoint (AWS PrivateLink) • Security best practices for Amazon WorkSpaces Secure Browser 88 Amazon
administration-guide-034
administration-guide.pdf
34
how to use other AWS services that help you to monitor and secure your Amazon WorkSpaces Secure Browser resources. Contents • Data protection in Amazon WorkSpaces Secure Browser • Identity and Access Management for Amazon WorkSpaces Secure Browser • Incident response in Amazon WorkSpaces Secure Browser • Compliance validation for Amazon WorkSpaces Secure Browser • Resilience in Amazon WorkSpaces Secure Browser • Infrastructure security in Amazon WorkSpaces Secure Browser • Configuration and vulnerability analysis in Amazon WorkSpaces Secure Browser • Access APIs using an interface VPC endpoint (AWS PrivateLink) • Security best practices for Amazon WorkSpaces Secure Browser 88 Amazon WorkSpaces Secure Browser Administration Guide Data protection in Amazon WorkSpaces Secure Browser The AWS shared responsibility model applies to data protection in Amazon WorkSpaces Secure Browser. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with WorkSpaces Secure Browser or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Topics Data protection 89 Amazon WorkSpaces Secure Browser Administration Guide • Data encryption in Amazon WorkSpaces Secure Browser • Inter-network traffic privacy in Amazon WorkSpaces Secure Browser • User access logging in Amazon WorkSpaces Secure Browser Data encryption in Amazon WorkSpaces Secure Browser Amazon WorkSpaces Secure Browser collects portal customization data, such as browser settings, user settings, network settings, identity provider information, trust store data, and trust store certificate data. WorkSpaces Secure Browser also collects browser policy data, user preferences (for browser settings), and session logs. Collected data is stored in Amazon DynamoDB and Amazon S3. WorkSpaces Secure Browser uses AWS Key Management Service for encryption. To secure your content, follow these guidelines: • Implement least privilege access and create specific roles to be used for WorkSpaces Secure Browser actions. Use IAM templates to create a Full Access role or Read Only role. For more information, see AWS managed policies for WorkSpaces Secure Browser. • Protect data end to end by providing a customer managed key, so WorkSpaces Secure Browser can encrypt your data at rest with the keys you supply. • Be careful with sharing portal domains and user credentials: • Admins are required to log into the Amazon WorkSpaces console, and users are required to log into the WorkSpaces Secure Browser portal. • Anyone on the internet can access the web portal, but they can't start a session unless they have valid user credentials to the portal. • Users can explicitly end their sessions by choosing End Session. This discards the instance hosting the browser session, and results in browser isolation. WorkSpaces Secure Browser secures content and metadata by default by encrypting all sensitive data with AWS KMS. It collects browser policy and user preferences to enforce policy and settings during WorkSpaces Secure Browser sessions. If
administration-guide-035
administration-guide.pdf
35
the Amazon WorkSpaces console, and users are required to log into the WorkSpaces Secure Browser portal. • Anyone on the internet can access the web portal, but they can't start a session unless they have valid user credentials to the portal. • Users can explicitly end their sessions by choosing End Session. This discards the instance hosting the browser session, and results in browser isolation. WorkSpaces Secure Browser secures content and metadata by default by encrypting all sensitive data with AWS KMS. It collects browser policy and user preferences to enforce policy and settings during WorkSpaces Secure Browser sessions. If there is an error applying existing settings, a user can't access new sessions and can't access the company's internal sites and SaaS applications. Encryption at rest for Amazon WorkSpaces Secure Browser Encryption at rest is configured by default and all customer data (for example, browser policy statements, usernames, logging, or IP addresses) used in WorkSpaces Secure Browser is encrypted Data encryption 90 Amazon WorkSpaces Secure Browser Administration Guide using AWS KMS. By default, WorkSpaces Secure Browser enables encryption with an AWS-owned key. You can also use a Customer Managed Key (CMK) by specifying your CMK on resource creation. This is currently only supported via the CLI. If you choose to pass a CMK, the key provided must be a symmetric encryption AWS KMS key and you, as the administrator, must have the following permissions: kms:DescribeKey kms:GenerateDataKey kms:GenerateDataKeyWithoutPlaintext kms:Decrypt kms:ReEncryptTo kms:ReEncryptFrom If you use a CMK, you will need to allowlist the WorkSpaces Secure Browser external service principal to access to the key. For more information, see Example of Scoped CMK Key Policy with aws:SourceAccount Whenever possible, WorkSpaces Secure Browser will use Forward Access Sessions (FAS) credentials to access your key. For more information about FAS, see Forward access sessions. There are cases where WorkSpaces Secure Browser may need to access your key asynchronously. By allowlisting the WorkSpaces Secure Browser external service principal in your key policy, WorkSpaces Secure Browser will be able to perform the allowlisted set of cryptographic operations with your key. After a resource is created, the key can no longer be removed or changed. If you used a CMK, you, as the administrator accessing the resource, must have the following permissions: kms:GenerateDataKey kms:GenerateDataKeyWithoutPlaintext kms:Decrypt kms:ReEncryptTo kms:ReEncryptFrom If you see an Access Denied error when using the console, it is likely that the user accessing the console doesn't have the required permissions to use the CMK on the key that is being used. Data encryption 91 Amazon WorkSpaces Secure Browser Administration Guide Key policy and scoping examples for WorkSpaces Secure Browser CMKs require the following key policy: { "Version": "2012-10-17", "Statement": [ ..., { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", } ] } The following permissions are required by WorkSpaces Secure Browser: • kms:DescribeKey — Validates that the provided AWS KMS key is configured correctly. • kms:GenerateDataKeyWithoutPlaintext and kms:GenerateDataKey — Request for the AWS KMS key to create data keys used to encrypt objects. • kms:Decrypt — Requests the AWS KMS key to decrypt the encrypted data keys. These data keys are used to encrypt your data. • kms:ReEncryptTo and kms:ReEncryptFrom — Request for the AWS KMS key to permit re- encryption from or to a KMS key. Data encryption 92 Amazon WorkSpaces Secure Browser Administration Guide Scoping WorkSpaces Secure Browser permissions on your AWS KMS key When the principal in a key policy statement is an AWS service principal, we strongly recommend that you use the aws:SourceArn or aws:SourceAccount global condition keys, in addition to the Encryption Context. The Encryption Context used for a resource will always contain an entry in the format aws:workspaces-web:RESOURCE_TYPE:id and the corresponding resource ID. The source ARN and source account values are included in the authorization context only when a request comes to AWS KMS from another AWS service. This combination of conditions implements least privileged permissions and avoids a potential confused deputy scenario. For more information, see Permissions for AWS services in key policies. "Condition": { "StringEquals": { "aws:SourceAccount": "AccountId", "kms:EncryptionContext:aws:workspaces-web:resourceType:id": "resourceId" }, "ArnEquals": { "aws:SourceArn": [ "arn:aws:workspaces-web:Region:AccountId:resourceType/resourceId" ] }, } Note Before resource creation, the key policy should only use the aws:SourceAccount Condition, as the full resource arn will not exist yet. Following resource creation, the key policy can be updated to include the aws:SourceArn and kms:EncryptionContext Conditions. Example of Scoped CMK key policy with aws:SourceAccount { "Version": "2012-10-17", "Statement": [ ..., Data encryption 93 Amazon WorkSpaces Secure Browser Administration Guide { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "<AccountId>" } } } ] } Example of scoped
administration-guide-036
administration-guide.pdf
36
Before resource creation, the key policy should only use the aws:SourceAccount Condition, as the full resource arn will not exist yet. Following resource creation, the key policy can be updated to include the aws:SourceArn and kms:EncryptionContext Conditions. Example of Scoped CMK key policy with aws:SourceAccount { "Version": "2012-10-17", "Statement": [ ..., Data encryption 93 Amazon WorkSpaces Secure Browser Administration Guide { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "<AccountId>" } } } ] } Example of scoped CMK key policy with aws:SourceArn and resource wildcard { "Version": "2012-10-17", "Statement": [ ..., { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" Data encryption 94 Amazon WorkSpaces Secure Browser ], "Resource": "*", "Condition": { "ArnLike": { Administration Guide "aws:SourceArn": "arn:aws:workspaces-web:<Region>:<AccountId>:*/*" } } } ] } Example of scoped CMK key policy with aws:SourceArn { "Version": "2012-10-17", "Statement": [ ..., { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "ArnLike": { "aws:SourceArn": [ "arn:aws:workspaces-web:<Region>:<AccountId>:portal/*", "arn:aws:workspaces-web:<Region>:<AccountId>:browserSettings/*", "arn:aws:workspaces-web:<Region>:<AccountId>:userSettings/*", "arn:aws:workspaces-web:<Region>:<AccountId>:ipAccessSettings/*" ] } } ] Data encryption 95 Amazon WorkSpaces Secure Browser Administration Guide } Note After you create the resource, you can update the wildcard in SourceArn for it. If you use WorkSpaces Secure Browser to create a new resource that requires CMK access, ensure you update its key policy accordingly. Example of scoped CMK key policy with aws:SourceArn and resource-specific EncryptionContext { "Version": "2012-10-17", "Statement": [ ..., { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt portal", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "<AccountId>", "kms:EncryptionContext:aws:workspaces-web:portal:id": "<portalId>>" } } }, { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt userSettings", "Effect": "Allow", "Principal": { Data encryption 96 Amazon WorkSpaces Secure Browser Administration Guide "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "<AccountId>", "kms:EncryptionContext:aws:workspaces-web:userSetttings:id": "<userSetttingsId>" } } }, { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt browserSettings", "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "<AccountId>", "kms:EncryptionContext:aws:workspaces-web:browserSettings:id": "<browserSettingsId>" } } }, { "Sid": "Allow WorkSpaces Secure Browser to encrypt/decrypt ipAccessSettings", Data encryption 97 Administration Guide Amazon WorkSpaces Secure Browser "Effect": "Allow", "Principal": { "Service": "workspaces-web.amazonaws.com" }, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext", "kms:Decrypt", "kms:ReEncryptTo", "kms:ReEncryptFrom" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "<AccountId>", "kms:EncryptionContext:aws:workspaces-web:ipAccessSettings:id": "<ipAccessSettingsId>" } } }, ] } Note Ensure you create separate statements when including a resource specific EncryptionContext on the same key policy. For more information, see the Using multiple encryption context pairs section under kms:EncryptionContext:context-key. Encryption in transit for Amazon WorkSpaces Secure Browser WorkSpaces Secure Browser encrypts data in transit over HTTPS and TLS 1.2. You can send a request to WorkSpaces by using the console or direct API calls. The request data that is transferred is encrypted by sending everything through a HTTPS or TLS connection. Request data can be transferred from the AWS Console, AWS Command Line Interface, or AWS SDK to WorkSpaces Secure Browser. Encryption in transit is configured by default, and secure connections (HTTPS, TLS) are configured by default. Data encryption 98 Amazon WorkSpaces Secure Browser Administration Guide Key management for Amazon WorkSpaces Secure Browser You can supply your own Customer Managed AWS KMS Key to encrypt your customer information. If you don't supply one, WorkSpaces Secure Browser will use an AWS Owned Key. You can set your key using the AWS SDK. Inter-network traffic privacy in Amazon WorkSpaces Secure Browser To secure connections between WorkSpaces Secure Browser and on-premise applications, you use WorkSpaces Secure Browser to launch browser sessions inside of your own VPC. The connection to on-premise applications is configured in your own VPC, and is not controlled by WorkSpaces Secure Browser. To secure connections between accounts, WorkSpaces Secure Browser uses a service-linked role to securely connect to customer accounts and run operations on behalf of the customer. For more information, see Using service-linked roles for Amazon WorkSpaces Secure Browser. User access logging in Amazon WorkSpaces Secure Browser Administrators are able to record WorkSpaces Secure Browser session events, including start, stop, and URL visits. These logs are encrypted and securely delivered to customers through an Amazon Kinesis Data Stream. Browsing information from user access logging is not stored by AWS, or available from sessions without logging configured. URL visits in incognito mode, or deleted URLs from browser history, are not recorded in user access logging. Identity and Access Management for Amazon WorkSpaces Secure Browser AWS Identity and Access Management
administration-guide-037
administration-guide.pdf
37
more information, see Using service-linked roles for Amazon WorkSpaces Secure Browser. User access logging in Amazon WorkSpaces Secure Browser Administrators are able to record WorkSpaces Secure Browser session events, including start, stop, and URL visits. These logs are encrypted and securely delivered to customers through an Amazon Kinesis Data Stream. Browsing information from user access logging is not stored by AWS, or available from sessions without logging configured. URL visits in incognito mode, or deleted URLs from browser history, are not recorded in user access logging. Identity and Access Management for Amazon WorkSpaces Secure Browser 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 WorkSpaces Secure Browser resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities Inter-network traffic privacy 99 Amazon WorkSpaces Secure Browser Administration Guide • Managing access using policies • How Amazon WorkSpaces Secure Browser works with IAM • Identity-based policy examples for Amazon WorkSpaces Secure Browser • AWS managed policies for WorkSpaces Secure Browser • Troubleshooting Amazon WorkSpaces Secure Browser identity and access • Using service-linked roles for Amazon WorkSpaces Secure Browser Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in WorkSpaces Secure Browser. Service user – If you use the WorkSpaces Secure Browser service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more WorkSpaces Secure Browser features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in WorkSpaces Secure Browser, see Troubleshooting Amazon WorkSpaces Secure Browser identity and access. Service administrator – If you're in charge of WorkSpaces Secure Browser resources at your company, you probably have full access to WorkSpaces Secure Browser. It's your job to determine which WorkSpaces Secure Browser features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with WorkSpaces Secure Browser, see How Amazon WorkSpaces Secure Browser works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to WorkSpaces Secure Browser. To view example WorkSpaces Secure Browser identity-based policies that you can use in IAM, see Identity-based policy examples for Amazon WorkSpaces Secure Browser. 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. Audience 100 Amazon WorkSpaces Secure Browser Administration Guide You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create
administration-guide-038
administration-guide.pdf
38
additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using Authenticating with identities 101 Amazon WorkSpaces Secure Browser Administration Guide credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity Authenticating with identities 102 Amazon WorkSpaces Secure Browser Administration Guide is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in
administration-guide-039
administration-guide.pdf
39
identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API Authenticating with identities 103 Amazon WorkSpaces Secure Browser Administration Guide requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON
administration-guide-040
administration-guide.pdf
40
users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed Managing access using policies 104 Amazon WorkSpaces Secure Browser Administration Guide policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. Managing access using policies 105 Amazon WorkSpaces Secure Browser Administration Guide • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the
administration-guide-041
administration-guide.pdf
41
policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon WorkSpaces Secure Browser works with IAM Before you use IAM to manage access to WorkSpaces Secure Browser, learn what IAM features are available to use with WorkSpaces Secure Browser. IAM features you can use with Amazon WorkSpaces Secure Browser IAM feature WorkSpaces Secure Browser support Identity-based policies Yes How Amazon WorkSpaces Secure Browser works with IAM 106 Amazon WorkSpaces Secure Browser Administration Guide IAM feature WorkSpaces Secure Browser support Resource-based policies Policy actions Policy resources Policy condition keys ACLs No Yes Yes Yes No ABAC (tags in policies) Partial Temporary credentials Principal permissions Service roles Service-linked roles Yes Yes No Yes To get a high-level view of how WorkSpaces Secure Browser and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Topics • Identity-based policies for WorkSpaces Secure Browser • Resource-based policies within WorkSpaces Secure Browser • Policy actions for WorkSpaces Secure Browser • Policy resources for WorkSpaces Secure Browser • Policy condition keys for WorkSpaces Secure Browser • Access control lists (ACLs) in WorkSpaces Secure Browser • Attribute-based access control (ABAC) with WorkSpaces Secure Browser • Using Temporary credentials with WorkSpaces Secure Browser • Cross-service principal permissions for WorkSpaces Secure Browser • Service roles for WorkSpaces Secure Browser • Service-linked roles for WorkSpaces Secure Browser How Amazon WorkSpaces Secure Browser works with IAM 107 Amazon WorkSpaces Secure Browser Administration Guide Identity-based policies for WorkSpaces Secure Browser Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for WorkSpaces Secure Browser To view examples of WorkSpaces Secure Browser identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Secure Browser. Resource-based policies within WorkSpaces Secure Browser Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access How Amazon WorkSpaces Secure Browser works with IAM 108 Amazon WorkSpaces Secure Browser Administration Guide to a principal in
administration-guide-042
administration-guide.pdf
42
account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access How Amazon WorkSpaces Secure Browser works with IAM 108 Amazon WorkSpaces Secure Browser Administration Guide to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for WorkSpaces Secure Browser Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of WorkSpaces Secure Browser actions, see Actions defined by Amazon WorkSpaces Secure Browser in the Service Authorization Reference. Policy actions in WorkSpaces Secure Browser use the following prefix before the action: workspaces-web To specify multiple actions in a single statement, separate them with commas. "Action": [ "workspaces-web:action1", "workspaces-web:action2" ] To view examples of WorkSpaces Secure Browser identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Secure Browser. Policy resources for WorkSpaces Secure Browser Supports policy resources: Yes How Amazon WorkSpaces Secure Browser works with IAM 109 Amazon WorkSpaces Secure Browser Administration Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of WorkSpaces Secure Browser resource types and their ARNs, see Resources defined by Amazon WorkSpaces Secure Browser in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon WorkSpaces Secure Browser. To view examples of WorkSpaces Secure Browser identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Secure Browser. Policy condition keys for WorkSpaces Secure Browser Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How Amazon WorkSpaces Secure Browser works with IAM 110 Amazon WorkSpaces Secure Browser Administration Guide You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of WorkSpaces Secure Browser condition keys, see Condition keys for Amazon WorkSpaces Secure Browser in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by Amazon WorkSpaces Secure Browser. To view examples of WorkSpaces Secure Browser identity-based policies,