Identity-based policy examples for Amazon Route 53 Application Recovery Controller
By default, users and roles don't have permission to create or modify Route 53 ARC resources. They also can't perform tasks by using the Amazon Web Services Management Console, Amazon Command Line Interface (Amazon CLI), or Amazon 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 Creating IAM policies in the IAM User Guide.
For details about actions and resource types defined by Route 53 ARC, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for Amazon Route 53 Application Recovery Controller in the Service Authorization Reference.
Policy best practices
Identity-based policies determine whether someone can create, access, or delete Route 53 ARC resources in your account. These actions can incur costs for your Amazon Web Services account. When you create or edit identity-based policies, follow these guidelines and recommendations:
-
Get started with Amazon managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the Amazon managed policies that grant permissions for many common use cases. They are available in your Amazon Web Services account. We recommend that you reduce permissions further by defining Amazon customer managed policies that are specific to your use cases. For more information, see Amazon managed policies or Amazon 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 Amazon Web Service, such as Amazon CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide.
-
Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see IAM Access Analyzer policy validation in the IAM User Guide.
-
Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your Amazon Web Services 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 Configuring MFA-protected API access in the IAM User Guide.
For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide.
Example: Route 53 ARC console access
To access the Amazon Route 53 Application Recovery Controller console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Route 53 ARC resources in your Amazon Web Services 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 Amazon CLI or the Amazon 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 Route 53 ARC console when you allow access to
only specific API operations, also attach a ReadOnly Amazon managed policy for Route 53 ARC to
the entities. For more information, see the Route 53 ARC Route 53 ARC
managed policies page or Adding permissions to a user in the IAM User Guide.
To perform some tasks, users must have permission to create one or both of the service-linked roles that are associated with Route 53 ARC. To learn more about the Route 53 ARC service-linked roles, see Using service-linked roles for Route 53 ARC.
To give users full access to use Route 53 ARC features through the console, attach a policy like the following to the user, to give the user full permissions to configure Route 53 ARC resources and operations:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "route53-recovery-cluster:GetRoutingControlState", "route53-recovery-cluster:UpdateRoutingControlState", "route53-recovery-cluster:UpdateRoutingControlStates", "route53-recovery-control-config:CreateCluster", "route53-recovery-control-config:CreateControlPanel", "route53-recovery-control-config:CreateRoutingControl", "route53-recovery-control-config:CreateSafetyRule", "route53-recovery-control-config:DeleteCluster", "route53-recovery-control-config:DeleteControlPanel", "route53-recovery-control-config:DeleteRoutingControl", "route53-recovery-control-config:DeleteSafetyRule", "route53-recovery-control-config:DescribeCluster", "route53-recovery-control-config:DescribeControlPanel", "route53-recovery-control-config:DescribeSafetyRule", "route53-recovery-control-config:DescribeRoutingControl", "route53-recovery-control-config:DescribeRoutingControlByName", "route53-recovery-control-config:ListAssociatedRoute53HealthChecks", "route53-recovery-control-config:ListClusters", "route53-recovery-control-config:ListControlPanels", "route53-recovery-control-config:ListRoutingControls", "route53-recovery-control-config:ListSafetyRules", "route53-recovery-control-config:UpdateControlPanel", "route53-recovery-control-config:UpdateRoutingControl", "route53-recovery-control-config:UpdateSafetyRule", "route53-recovery-readiness:CreateCell", "route53-recovery-readiness:CreateCrossAccountAuthorization", "route53-recovery-readiness:CreateReadinessCheck", "route53-recovery-readiness:CreateRecoveryGroup", "route53-recovery-readiness:CreateResourceSet", "route53-recovery-readiness:DeleteCell", "route53-recovery-readiness:DeleteCrossAccountAuthorization", "route53-recovery-readiness:DeleteReadinessCheck", "route53-recovery-readiness:DeleteRecoveryGroup", "route53-recovery-readiness:DeleteResourceSet", "route53-recovery-readiness:GetArchitectureRecommendations", "route53-recovery-readiness:GetCell", "route53-recovery-readiness:GetCellReadinessSummary", "route53-recovery-readiness:GetReadinessCheck", "route53-recovery-readiness:GetReadinessCheckResourceStatus", "route53-recovery-readiness:GetReadinessCheckStatus", "route53-recovery-readiness:GetRecoveryGroup", "route53-recovery-readiness:GetRecoveryGroupReadinessSummary", "route53-recovery-readiness:GetResourceSet", "route53-recovery-readiness:ListCells", "route53-recovery-readiness:ListCrossAccountAuthorizations", "route53-recovery-readiness:ListReadinessChecks", "route53-recovery-readiness:ListRecoveryGroups", "route53-recovery-readiness:ListResourceSets", "route53-recovery-readiness:ListRules", "route53-recovery-readiness:UpdateCell", "route53-recovery-readiness:UpdateReadinessCheck", "route53-recovery-readiness:UpdateRecoveryGroup", "route53-recovery-readiness:UpdateResourceSet", "arc-zonal-shift:ListManagedResources", "arc-zonal-shift:GetManagedResource", "arc-zonal-shift:ListZonalShifts", "arc-zonal-shift:StartZonalShift", "arc-zonal-shift:UpdateZonalShift", "arc-zonal-shift:CancelZonalShift", "arc-zonal-shift:CreatePracticeRunConfiguration", "arc-zonal-shift:DeletePracticeRunConfiguration", "arc-zonal-shift:ListAutoshifts", "arc-zonal-shift:UpdatePracticeRunConfiguration", "arc-zonal-shift:UpdateZonalAutoshiftConfiguration" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "route53:GetHealthCheck", "route53:CreateHealthCheck", "route53:DeleteHealthCheck", "route53:ChangeTagsForResource" ], "Resource": "*" } { "Effect": "Allow", "Action": [ "ec2:DescribeAvailabilityZones ], "Resource": "*" } { "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms ], "Resource": "*" } ] }
Examples: Route 53 ARC API actions
There are four separate APIs that you can use with Amazon Route 53 Application Recovery Controller:
The zonal shift and zonal autoshift API, to work with the Route 53 ARC zonal shift data plane – to temporarily move traffic away from an Availability Zone to recover an application, or to configure zonal autoshift so that Amazon shifts away application resource traffic from an Availability Zone, on your behalf, to help reduce your time to recovery during events.
The recovery readiness API, to work with the Route 53 ARC readiness check control plane – for example, to create recovery groups, resource sets, and readiness checks.
The recovery control API, to work with the Route 53 ARC routing control control plane – for example, to create clusters, control panels, and routing controls.
The recovery control data plane API, to work with the Route 53 ARC routing control data plane – to query and update routing control states to perform Regional failover and recovery.
To ensure that a user can use Route 53 ARC API actions, attach a policy that corresponds to the API operations that the user needs to work with, as described below.
To perform some tasks, users must have permission to create one or both of the service-linked roles that are associated with Route 53 ARC. To learn more about the Route 53 ARC service-linked roles, see Using service-linked roles for Route 53 ARC.
To work with API operations for zonal autoshift, attach a policy like the following to the user:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "arc-zonal-shift:CreatePracticeRunConfiguration", "arc-zonal-shift:DeletePracticeRunConfiguration", "arc-zonal-shift:ListAutoshifts", "arc-zonal-shift:UpdatePracticeRunConfiguration", "arc-zonal-shift:UpdateZonalAutoshiftConfiguration" ], "Resource": "*" } { "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms ], "Resource": "*" } ] }
To work with API operations for zonal shift, attach a policy like the following to the user:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "arc-zonal-shift:ListManagedResources", "arc-zonal-shift:GetManagedResource", "arc-zonal-shift:ListZonalShifts", "arc-zonal-shift:StartZonalShift", "arc-zonal-shift:UpdateZonalShift", "arc-zonal-shift:CancelZonalShift" ], "Resource": "*" } ] }
To work with API operations for recovery readiness, attach a policy like the following to the user:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "route53-recovery-readiness:CreateCell", "route53-recovery-readiness:CreateCrossAccountAuthorization", "route53-recovery-readiness:CreateReadinessCheck", "route53-recovery-readiness:CreateRecoveryGroup", "route53-recovery-readiness:CreateResourceSet", "route53-recovery-readiness:DeleteCell", "route53-recovery-readiness:DeleteCrossAccountAuthorization", "route53-recovery-readiness:DeleteReadinessCheck", "route53-recovery-readiness:DeleteRecoveryGroup", "route53-recovery-readiness:DeleteResourceSet", "route53-recovery-readiness:GetArchitectureRecommendations", "route53-recovery-readiness:GetCell", "route53-recovery-readiness:GetCellReadinessSummary", "route53-recovery-readiness:GetReadinessCheck", "route53-recovery-readiness:GetReadinessCheckResourceStatus", "route53-recovery-readiness:GetReadinessCheckStatus", "route53-recovery-readiness:GetRecoveryGroup", "route53-recovery-readiness:GetRecoveryGroupReadinessSummary", "route53-recovery-readiness:GetResourceSet", "route53-recovery-readiness:ListCells", "route53-recovery-readiness:ListCrossAccountAuthorizations", "route53-recovery-readiness:ListReadinessChecks", "route53-recovery-readiness:ListRecoveryGroups", "route53-recovery-readiness:ListResourceSets", "route53-recovery-readiness:ListRules", "route53-recovery-readiness:ListTagsForResources", "route53-recovery-readiness:UpdateCell", "route53-recovery-readiness:UpdateReadinessCheck", "route53-recovery-readiness:UpdateRecoveryGroup", "route53-recovery-readiness:UpdateResourceSet", "route53-recovery-readiness:TagResource", "route53-recovery-readiness:UntagResource" ], "Resource": "*" } ] }
To work with API operations for recovery control, attach a policy like the following to the user:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "route53-recovery-control-config:CreateCluster", "route53-recovery-control-config:CreateControlPanel", "route53-recovery-control-config:CreateRoutingControl", "route53-recovery-control-config:CreateSafetyRule", "route53-recovery-control-config:DeleteCluster", "route53-recovery-control-config:DeleteControlPanel", "route53-recovery-control-config:DeleteRoutingControl", "route53-recovery-control-config:DeleteSafetyRule", "route53-recovery-control-config:DescribeCluster", "route53-recovery-control-config:DescribeControlPanel", "route53-recovery-control-config:DescribeSafetyRule", "route53-recovery-control-config:DescribeRoutingControl", "route53-recovery-control-config:DescribeRoutingControlByName", "route53-recovery-control-config:ListAssociatedRoute53HealthChecks", "route53-recovery-control-config:ListClusters", "route53-recovery-control-config:ListControlPanels", "route53-recovery-control-config:ListRoutingControls", "route53-recovery-control-config:ListSafetyRules", "route53-recovery-control-config:ListTagsForResource", "route53-recovery-control-config:UpdateControlPanel", "route53-recovery-control-config:UpdateRoutingControl", "route53-recovery-control-config:UpdateSafetyRule", "route53-recovery-control-config:TagResource", "route53-recovery-control-config:UntagResource" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "route53:GetHealthCheck", "route53:CreateHealthCheck", "route53:DeleteHealthCheck", "route53:ChangeTagsForResource" ], "Resource": "*" } ] }
To perform tasks in Route 53 ARC with the recovery cluster data plane API, for example, updating routing control states to fail over during a disaster event, you can attach a Route 53 ARC IAM policy such as the following to your IAM user.
The AllowSafetyRuleOverride boolean gives permission to override safety rules that you've
configured as safeguards for routing controls. This permission might be required in "break glass" scenarios to
bypass the safeguards in disasters or other urgent failover scenarios. For example, an operator might need to
fail over quickly for disaster recovery, and one or more safety rules might unexpectedly prevent a routing control
state update required to reroute traffic. This permission allows the operator to specify safety rules to override
when making API calls to update routing control states. For more information, see Overriding safety rules
to reroute traffic.
If you want to allow an operator to use the recovery cluster data plane API but prevent
overriding safety rules, you can attach a policy such as the following, but set the AllowSafetyRuleOverrides
boolean to false.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "route53-recovery-cluster:GetRoutingControlState", "route53-recovery-cluster:ListRoutingControls" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "route53-recovery-cluster:UpdateRoutingControlStates", "route53-recovery-cluster:UpdateRoutingControlState" ], "Resource": "*", "Condition": { "Bool": { "route53-recovery-cluster:AllowSafetyRulesOverrides": "true" } } } ] }