How Image Builder works with IAM policies and roles
Before you use IAM to manage access to Image Builder, learn what IAM features are available to use with Image Builder.
To get a high-level view of how Image Builder and other Amazon services work with most IAM features, see Amazon services that work with IAM in the IAM User Guide.
Identity-based policies for Image Builder
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. 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 Image Builder
To view examples of Image Builder identity-based policies, see Image Builder identity-based policies.
Resource-based policies within Image Builder
Supports resource-based policies: Yes
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 Amazon Web Services 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. For more information, see Cross account resource access in IAM in the IAM User Guide.
Policy actions for Image Builder
Supports policy actions: Yes
Administrators can use Amazon 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. Include actions in a policy to grant permissions to perform the associated operation.
To see a list of Image Builder actions, see Actions defined by EC2 Image Builder in the Service Authorization Reference.
Policy actions in Image Builder use the following prefix before the action:
imagebuilder
To specify multiple actions in a single statement, separate them with commas.
"Action": [ "imagebuilder:action1", "imagebuilder:action2" ]
To view examples of Image Builder identity-based policies, see Image Builder identity-based policies.
Policy resources for Image Builder
Supports policy resources: Yes
Administrators can use Amazon 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. As a best practice, specify a resource using its Amazon Resource Name (ARN). For actions that don't support resource-level permissions, use a wildcard (*) to indicate that the statement applies to all resources.
"Resource": "*"
To see a list of Image Builder resource types and their ARNs, see Resources defined by EC2 Image Builder in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by EC2 Image Builder.
To view examples of Image Builder identity-based policies, see Image Builder identity-based policies.
Policy condition keys for Image Builder
Supports service-specific policy condition keys: Yes
Administrators can use Amazon 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 specifies when statements execute based on defined criteria. 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. To see all Amazon global
condition keys, see Amazon global condition context keys in the
IAM User Guide.
To see a list of Image Builder condition keys, see Condition keys for EC2 Image Builder in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by EC2 Image Builder.
To view examples of Image Builder identity-based policies, see Image Builder identity-based policies.
ACLs in Image Builder
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 Image Builder
Supports ABAC (tags in policies): Partial
Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes called tags. You can attach tags to IAM entities and Amazon resources, then design ABAC policies to allow operations when the principal's tag matches the tag on the resource.
To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/,
key-nameaws:RequestTag/, or key-nameaws: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 Image Builder
Supports temporary credentials: Yes
Temporary credentials provide short-term access to Amazon resources and are automatically created when you use federation or switch roles. Amazon recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM and Amazon Web Services services that work with IAM in the IAM User Guide.
Cross-service principal permissions for Image Builder
Supports forward access sessions (FAS): Yes
Forward access sessions (FAS) use the permissions of the principal calling an Amazon Web Services service, combined with the requesting Amazon Web Services service to make requests to downstream services. For policy details when making FAS requests, see Forward access sessions.
Service roles for Image Builder
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 Amazon Web Services service in the IAM User Guide.
Warning
Changing the permissions for a service role might break Image Builder functionality. Edit service roles only when Image Builder provides guidance to do so.
Service-linked roles for Image Builder
Supports service-linked roles: Yes
A service-linked role is a type of service role that is linked to an Amazon Web Services service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your Amazon Web Services account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles.
For details about the Image Builder service-linked role, see Use IAM service-linked roles for Image Builder.
Image Builder identity-based policies
With IAM identity-based policies, you can specify allowed or denied actions and resources, and also the conditions under which actions are allowed or denied. Image Builder supports specific actions, resources, and condition keys. For information about all of the elements that you use in a JSON policy, see Actions, Resources, and Condition Keys for Amazon EC2 Image Builder in the IAM User Guide.
Actions
Policy actions in Image Builder use the following prefix before the action:
imagebuilder:. Policy statements must include either an
Action or NotAction element. Image Builder defines its own
set of actions that describe tasks that you can perform with this
service.
To specify multiple actions in a single statement, separate them with commas as follows:
"Action": [ "imagebuilder:action1", "imagebuilder:action2" ]
You can specify multiple actions using wildcards (*). For example, to specify
all actions that begin with the word List, include the following
action:
"Action": "imagebuilder:List*"
To see a list of Image Builder actions, see Actions, Resources, and Condition Keys for Amazon Web Services services in the IAM User Guide.
Managing access using policies
For detailed information about how to manage access in Amazon by creating policies and attaching them to IAM identities or Amazon resources, see Policies and Permissions in the IAM User Guide.
The IAM role that you associate with your instance profile must have permissions to run the build and test components included in your image. The following IAM role policies must be attached to the IAM role that is associated with the instance profile:
-
EC2InstanceProfileForImageBuilder
-
EC2InstanceProfileForImageBuilderECRContainerBuilds
-
AmazonSSMManagedInstanceCore
Resources
Administrators can use Amazon 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. As a best practice, specify a resource using its Amazon Resource Name (ARN). For actions that don't support resource-level permissions, use a wildcard (*) to indicate that the statement applies to all resources.
"Resource": "*"
The ARN is made up of multiple nodes that help identify the resource and ensure that the name is unique. The last nodes in the name include several variations in formatting for the resource type, name, and ID. When Image Builder creates a resource it uses the following format:
arn:aws:imagebuilder:region:owner:resource-type/resource-name/version/build-version
Note
The build version is not always included in the resource ARN. However, some API operations, such as GetComponent, need the build version to uniquely identify a resource to retrieve.
For the resources that Image Builder uses in its recipes, such as the base image or components, the owner node can be one of the following:
-
The account number of the resource owner
-
For Amazon managed resources:
aws -
For Amazon Web Services Marketplace resources:
aws-marketplace
The following example shows the ARN for a managed component to install the Amazon CloudWatch agent on Linux:
arn:aws:imagebuilder:us-east-1:aws:component/amazon-cloudwatch-agent-linux/1.0.1/1
This example shows the ARN for a fictitious managed component from the Amazon Web Services Marketplace:
arn:aws:imagebuilder:us-east-1:aws-marketplace:component/example-linux-software-component/1.0.1
For more information about getting a list of components, including the use of an ownership filter, see List Image Builder components.
Example ARNs
The following are some examples of resource ARNs that you might specify in an IAM policy:
-
Instance ARN
"Resource": "arn:aws:imagebuilder:us-east-1:111122223333:instance/i-1234567890abcdef0" -
Wildcard (*) example to specify all instances for a given account
"Resource": "arn:aws:imagebuilder:us-east-1:111122223333:instance/*" -
Wildcard (*) example to specify all versions of a managed image workflow
"Resource": "arn:aws:imagebuilder:us-east-1:aws:workflow/build/build-image/*" -
Managed image ARN
"Resource": "arn:aws:imagebuilder:us-east-1:aws:image/amazon-linux-2-arm64/2024.12.17/1" -
Wildcard (*) example to specify all versions of a managed image
"Resource": "arn:aws:imagebuilder:us-east-1:aws:image/amazon-linux-2-arm64/x.x.x"
Many EC2 Image Builder API actions involve multiple resources. To specify multiple resources in a single statement, separate the ARNs with commas.
"Resource": [ "resource1", "resource2" ]
Condition keys
Image Builder provides service-specific condition keys and supports using some global condition keys. To see all Amazon global condition keys, see Amazon Global Condition Context Keys in the IAM User Guide. The following service-specific condition keys are provided.
imagebuilder:CreatedResourceTagKeys
Works with string operators.
Use this key to filter access by the presence of tag keys in the request. This allows you to manage the resources that Image Builder creates.
Availability – This key is available to
only the CreateInfrastrucutreConfiguration and
UpdateInfrastructureConfiguration APIs.
imagebuilder:CreatedResourceTag/<key>
Works with string operators.
Use this key to filter access by the tag key-value pairs that are attached to the resource that Image Builder created. This allows you to manage Image Builder resources through defined tags.
Availability – This key is available to
only the CreateInfrastrucutreConfiguration and
UpdateInfrastructureConfiguration APIs.
imagebuilder:LifecyclePolicyResourceType
Works with string operators.
Use this key to filter access by the Lifecycle resource type specified in the request.
The value for this key can be either AMI_IMAGE or
CONTAINER_IMAGE.
Availability – This key is available
to only the CreateLifecyclePolicy and UpdateLifecyclePolicy
APIs.
imagebuilder:Ec2MetadataHttpTokens
Works with string operators.
Use this key to filter access by the EC2 Instance Metadata HTTP Token Requirement specified in the request.
This value for this key can be either optional or
required.
Availability – This key is available to
only the CreateInfrastrucutreConfiguration and
UpdateInfrastructureConfiguration APIs.
imagebuilder:StatusTopicArn
Works with string operators.
Use this key to filter access by the SNS Topic ARN in the request to which terminal state notifications will be published.
Availability – This key is available to
only the CreateInfrastrucutreConfiguration and
UpdateInfrastructureConfiguration APIs.
Examples
To view examples of Image Builder identity-based policies, see Image Builder identity-based policies.
Image Builder resource-based policies
Resource-based policies specify what actions a specified principal can perform on the Image Builder resource and under what conditions. Image Builder supports resource-based permissions policies for components, images, and image recipes. Resource-based policies let you grant usage permission to other accounts on a per-resource basis. You can also use a resource-based policy to allow an Amazon service to access your components, images, and image recipes.
Authorization based on Image Builder tags
You can attach tags to Image Builder resources or pass tags in a request to Image Builder. To
control access based on tags, you provide tag information in the condition
element of a policy using the
imagebuilder:ResourceTag/,
key-nameaws:RequestTag/, or
key-nameaws:TagKeys condition keys. For more information about tagging Image Builder
resources, see Tag a resource from the Amazon CLI.
Image Builder IAM roles
An IAM role is an entity within your Amazon Web Services account that has specific permissions.
Using temporary credentials with Image Builder
You can use temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling Amazon STS API operations such as AssumeRole or GetFederationToken.
Service-linked roles
Service-linked roles allow Amazon Web Services services to access resources in other services to complete an action on your behalf. Service-linked roles appear in your IAM account and are owned by the service. A user with administrative access can view but not edit the permissions for service-linked roles.
Image Builder supports service-linked roles. For information about creating or managing Image Builder service-linked roles, see Use IAM service-linked roles for Image Builder.
Service roles
This feature allows a service to assume a service role on your behalf. This role allows the service to access resources in other services to complete an action on your behalf. Service roles appear in your IAM account and are owned by the account. This means that an user with administrative access can change the permissions for this role. However, doing so might break the functionality of the service.