Actions, resources, and condition keys for Amazon EC2 Image Builder
Amazon EC2 Image Builder (service prefix: imagebuilder
) provides the following service-specific resources, actions, and condition context
keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon EC2 Image Builder
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 |
---|---|---|---|---|---|
CancelImageCreation | Cancel an image creation | Write | |||
CreateComponent | Create a new component | Write | |||
CreateContainerRecipe | Create a new Container Recipe | Write |
imagebuilder:GetComponent |
||
CreateDistributionConfiguration | Create a new distribution configuration | Write | |||
CreateImage | Create a new image | Write |
imagebuilder:GetImageRecipe imagebuilder:GetInfrastructureConfiguration |
||
CreateImagePipeline | Create a new image pipeline | Write |
imagebuilder:GetImageRecipe |
||
CreateImageRecipe | Create a new Image Recipe | Write |
imagebuilder:GetComponent |
||
CreateInfrastructureConfiguration | Create a new infrastructure configuration | Write |
iam:PassRole |
||
DeleteComponent | Delete a component | Write | |||
DeleteContainerRecipe | Grants permission to delete a container recipe | Write | |||
DeleteDistributionConfiguration | Delete a distribution configuration | Write | |||
DeleteImage | Delete an image | Write | |||
DeleteImagePipeline | Delete an image pipeline | Write | |||
DeleteImageRecipe | Grants permission to delete an image recipe | Write | |||
DeleteInfrastructureConfiguration | Delete an infrastructure configuration | Write | |||
GetComponent | View details about a component | Read | |||
GetComponentPolicy | View the resource policy associated with a component | Read | |||
GetContainerRecipe | View details about a container recipe | Read | |||
GetContainerRecipePolicy | View the resource policy associated with a container recipe | Read | |||
GetDistributionConfiguration | View details about a distribution configuration | Read | |||
GetImage | View details about an image | Read | |||
GetImagePipeline | View details about an image pipeline | Read | |||
GetImagePolicy | View the resource policy associated with an image | Read | |||
GetImageRecipe | View details about an image recipe | Read | |||
GetImageRecipePolicy | View the resource policy associated with an image recipe | Read | |||
GetInfrastructureConfiguration | View details about an infrastructure configuration | Read | |||
ListComponentBuildVersions | List the component build versions in your account | List | |||
ListComponents | List the component versions owned by or shared with your account | List | |||
ListContainerRecipes | List the container recipes owned by or shared with your account | List | |||
ListDistributionConfigurations | List the distribution configurations in your account | List | |||
ListImageBuildVersions | List the image build versions in your account | List | |||
ListImagePipelineImages | Returns a list of images created by the specified pipeline | List | |||
ListImagePipelines | List the image pipelines in your account | List | |||
ListImageRecipes | List the image recipes owned by or shared with your account | List | |||
ListImages | List the image versions owned by or shared with your account | List | |||
ListInfrastructureConfigurations | List the infrastructure configurations in your account | List | |||
ListTagsForResource | List tag for an Image Builder resource | Read | |||
PutComponentPolicy | Set the resource policy associated with a component | Permissions management | |||
PutContainerRecipePolicy | Set the resource policy associated with a container recipe | Permissions management | |||
PutImagePolicy | Set the resource policy associated with an image | Permissions management | |||
PutImageRecipePolicy | Set the resource policy associated with an image recipe | Permissions management | |||
StartImagePipelineExecution | Create a new image from a pipeline | Write |
imagebuilder:GetImagePipeline |
||
TagResource | Tag an Image Builder resource | Tagging | |||
UntagResource | Untag an Image Builder resource | Tagging | |||
UpdateDistributionConfiguration | Update an existing distribution configuration | Write | |||
UpdateImagePipeline | Update an existing image pipeline | Write | |||
UpdateInfrastructureConfiguration | Update an existing infrastructure configuration | Write |
iam:PassRole |
||
Resource types defined by Amazon EC2 Image Builder
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 |
---|---|---|
component |
arn:${Partition}:imagebuilder:${Region}:${Account}:component/${ComponentName}/${ComponentVersion}/${ComponentBuildVersion}
|
|
componentVersion |
arn:${Partition}:imagebuilder:${Region}:${Account}:component/${ComponentName}/${ComponentVersion}
|
|
distributionConfiguration |
arn:${Partition}:imagebuilder:${Region}:${Account}:distribution-configuration/${DistributionConfigurationName}
|
|
image |
arn:${Partition}:imagebuilder:${Region}:${Account}:image/${ImageName}/${ImageVersion}/${ImageBuildVersion}
|
|
imageVersion |
arn:${Partition}:imagebuilder:${Region}:${Account}:image/${ImageName}/${ImageVersion}
|
|
imageRecipe |
arn:${Partition}:imagebuilder:${Region}:${Account}:image-recipe/${ImageRecipeName}/${ImageRecipeVersion}
|
|
containerRecipe |
arn:${Partition}:imagebuilder:${Region}:${Account}:container-recipe/${ContainerRecipeName}/${ContainerRecipeVersion}
|
|
imagePipeline |
arn:${Partition}:imagebuilder:${Region}:${Account}:image-pipeline/${ImagePipelineName}
|
|
infrastructureConfiguration |
arn:${Partition}:imagebuilder:${Region}:${Account}:infrastructure-configuration/${ResourceId}
|
|
kmsKey |
arn:${Partition}:kms:${Region}:${Account}:key/${KeyId}
|
Condition keys for Amazon EC2 Image Builder
Amazon EC2 Image Builder 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:RequestTag/${TagKey} | Filters actions by the presence of tag key-value pairs in the request | String |
aws:ResourceTag/${TagKey} | Filters actions by tag key-value pairs attached to the resource | String |
aws:TagKeys | Filters actions by the presence of tag keys in the request | String |
imagebuilder:CreatedResourceTag/<key> | Filters access by the tag key-value pairs attached to the resource created by Image Builder | String |
imagebuilder:CreatedResourceTagKeys | Filters access by the presence of tag keys in the request | String |