Actions, resources, and condition keys for Amazon CloudWatch Synthetics - Service Authorization Reference

Actions, resources, and condition keys for Amazon CloudWatch Synthetics

Amazon CloudWatch Synthetics (service prefix: synthetics) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by Amazon CloudWatch Synthetics

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
CreateCanary Grants permission to create a canary Write
DeleteCanary Grants permission to delete a canary. Amazon Synthetics deletes all the resources except for the Lambda function and the CloudWatch Alarms if you created one Write

canary*

DescribeCanaries Grants permission to list information of all canaries Read
DescribeCanariesLastRun Grants permission to list information about the last test run associated with all canaries Read
DescribeRuntimeVersions Grants permission to list information about Synthetics canary runtime versions Read
GetCanary Grants permission to get a canary details Read

canary*

GetCanaryRuns Grants permission to list information about all the test runs associated with a canary Read

canary*

ListTagsForResource Grants permission to list all tags and values associated with a canary Read

canary

StartCanary Grants permission to start a canary, so that Amazon CloudWatch Synthetics starts monitoring a website Write

canary*

StopCanary Grants permission to stop a canary Write

canary*

TagResource Grants permission to add one or more tags to a canary Tagging

canary

UntagResource Grants permission to remove one or more tags from a canary Tagging

canary

UpdateCanary Grants permission to update a canary Write

canary*

Resource types defined by Amazon CloudWatch Synthetics

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see The resource types table.

Resource types ARN Condition keys
canary arn:${Partition}:synthetics:${Region}:${Account}:canary:${CanaryName}

aws:ResourceTag/${TagKey}

Condition keys for Amazon CloudWatch Synthetics

Amazon CloudWatch Synthetics defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see The condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:ResourceTag/${TagKey} Filters access based on the tags associated with the resource String