Amazon CodeDeploy identity-based policy examples - Amazon CodeDeploy
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Amazon CodeDeploy identity-based policy examples

By default, IAM users and roles don't have permission to create or modify CodeDeploy resources. They also can't perform tasks using the Amazon Web Services Management Console, Amazon CLI, or Amazon API. An IAM administrator must create IAM policies that grant users and roles permission to perform API operations on the specified resources they need. The administrator must then attach those policies to the IAM users or groups who require those permissions.

To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating policies on the JSON tab in the IAM User Guide.

In CodeDeploy, identity-based policies are used to manage permissions to the various resources related to the deployment process. You can control access to the following resource types:

  • Applications and application revisions.

  • Deployments.

  • Deployment configurations.

  • Instances and on-premises instances.

The capabilities controlled by resource policies vary depending on the resource type, as outlined in the following table:

Resource types

Capabilities

All

View and list details about resources

Applications

Deployment configurations

Deployment groups

Create resources

Delete resources

Deployments

Create deployments

Stop deployments

Application revisions

Register application revisions

Applications

Deployment groups

Update resources

On-premises instances

Add tags to instances

Remove tags from instances

Register instances

Deregister instances

The following example shows a permissions policy that allows a user to delete the deployment group named WordPress_DepGroup associated with the application named WordPress_App in the us-west-2 Region.

{ "Version": "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Action" : [ "codedeploy:DeleteDeploymentGroup" ], "Resource" : [ "arn:aws-cn:codedeploy:us-west-2:444455556666:deploymentgroup:WordPress_App/WordPress_DepGroup" ] } ] }

Customer-managed policy examples

In this section, you can find example user policies that grant permissions for various CodeDeploy actions. These policies work when you are using the CodeDeploy API, Amazon SDKs, or the Amazon CLI. You must grant additional permissions for actions you perform in the console. To learn more about granting console permissions, see Using the CodeDeploy console .

Note

All examples use the US West (Oregon) Region (us-west-2) and contain fictitious account IDs.

Examples

Example 1: Allow a user to perform CodeDeploy operations in a single Region

The following example grants permissions to perform CodeDeploy operations in the us-west-2 Region only:

{ "Version": "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Action" : [ "codedeploy:*" ], "Resource" : [ "arn:aws-cn:codedeploy:us-west-2:444455556666:*" ] } ] }

Example 2: Allow a user to register revisions for a single application

The following example grants permissions to register application revisions for all applications that begin with Test in the us-west-2 Region:

{ "Version": "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Action" : [ "codedeploy:RegisterApplicationRevision" ], "Resource" : [ "arn:aws-cn:codedeploy:us-west-2:444455556666:application:Test*" ] } ] }

Example 3: Allow a user to create deployments for a single deployment group

The following example allows the specified user to create deployments for the deployment group named WordPress_DepGroup associated with the application named WordPress_App, the custom deployment configuration named ThreeQuartersHealthy, and any application revisions associated with the application named WordPress_App. All of these resources are in the us-west-2 Region.

{ "Version": "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Action" : [ "codedeploy:CreateDeployment" ], "Resource" : [ "arn:aws-cn:codedeploy:us-west-2:444455556666:deploymentgroup:WordPress_App/WordPress_DepGroup" ] }, { "Effect" : "Allow", "Action" : [ "codedeploy:GetDeploymentConfig" ], "Resource" : [ "arn:aws-cn:codedeploy:us-west-2:444455556666:deploymentconfig:ThreeQuartersHealthy" ] }, { "Effect" : "Allow", "Action" : [ "codedeploy:GetApplicationRevision" ], "Resource" : [ "arn:aws-cn:codedeploy:us-west-2:444455556666:application:WordPress_App" ] } ] }

Policy best practices

Identity-based policies are very powerful. They determine whether someone can create, access, or delete CodeDeploy 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 using Amazon managed policies – To start using CodeDeploy quickly, use Amazon managed policies to give your employees the permissions they need. These policies are already available in your account and are maintained and updated by Amazon. For more information, see Get started using permissions with Amazon managed policies in the IAM User Guide.

  • Grant least privilege – When you create custom policies, grant only the permissions required to perform a task. Start with a minimum set of permissions and grant additional permissions as necessary. Doing so is more secure than starting with permissions that are too lenient and then trying to tighten them later. For more information, see Grant least privilege in the IAM User Guide.

  • Enable MFA for sensitive operations – For extra security, require IAM users to use multi-factor authentication (MFA) to access sensitive resources or API operations. For more information, see Using multi-factor authentication (MFA) in Amazon in the IAM User Guide.

  • Use policy conditions for extra security – To the extent that it's practical, define the conditions under which your identity-based policies allow access to a resource. For example, you can write conditions to specify a range of allowable IP addresses that a request must come from. You can also write conditions to allow requests only within a specified date or time range, or to require the use of SSL or MFA. For more information, see IAM JSON policy elements: Condition in the IAM User Guide.

Using the CodeDeploy console

If you use the CodeDeploy console, you must have a minimum set of permissions that allows you to describe other Amazon resources for your Amazon account. To use CodeDeploy in the CodeDeploy console, you must have permissions from the following services:

  • Amazon EC2 Auto Scaling

  • Amazon CodeDeploy

  • Amazon Elastic Compute Cloud

  • Elastic Load Balancing

  • Amazon Identity and Access Management

  • Amazon Simple Storage Service

  • Amazon Simple Notification Service

  • Amazon CloudWatch

If you create an IAM policy that is more restrictive than the minimum required permissions, the console won't function as intended for users with that IAM policy. To ensure that those users can still use the CodeDeploy console, also attach the AWSCodeDeployReadOnlyAccess managed policy to the user, as described in Amazon managed (predefined) policies for CodeDeploy.

You don't need to allow minimum console permissions for users who are making calls only to the Amazon CLI or the CodeDeploy API.

Allow users to view their own permissions

This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the Amazon CLI or Amazon API.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws-cn:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] }