Expand description
EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date “golden” server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
If you’re using the service, you’re probably looking for ImageBuilderClient and ImageBuilder.
Structs§
- Ami
Details of an EC2 AMI.
- AmiDistribution
Configuration Define and configure the output AMIs of the pipeline.
- Cancel
Image Creation Request - Cancel
Image Creation Response - Component
A detailed view of a component.
- Component
Configuration Configuration details of the component.
- Component
Summary A high-level summary of a component.
- Component
Version A high-level overview of a component semantic version.
- Create
Component Request - Create
Component Response - Create
Distribution Configuration Request - Create
Distribution Configuration Response - Create
Image Pipeline Request - Create
Image Pipeline Response - Create
Image Recipe Request - Create
Image Recipe Response - Create
Image Request - Create
Image Response - Create
Infrastructure Configuration Request - Create
Infrastructure Configuration Response - Delete
Component Request - Delete
Component Response - Delete
Distribution Configuration Request - Delete
Distribution Configuration Response - Delete
Image Pipeline Request - Delete
Image Pipeline Response - Delete
Image Recipe Request - Delete
Image Recipe Response - Delete
Image Request - Delete
Image Response - Delete
Infrastructure Configuration Request - Delete
Infrastructure Configuration Response - Distribution
Defines the settings for a specific Region.
- Distribution
Configuration A distribution configuration.
- Distribution
Configuration Summary A high-level overview of a distribution configuration.
- EbsInstance
Block Device Specification Amazon EBS-specific block device mapping specifications.
- Filter
A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
- GetComponent
Policy Request - GetComponent
Policy Response - GetComponent
Request - GetComponent
Response - GetDistribution
Configuration Request - GetDistribution
Configuration Response - GetImage
Pipeline Request - GetImage
Pipeline Response - GetImage
Policy Request - GetImage
Policy Response - GetImage
Recipe Policy Request - GetImage
Recipe Policy Response - GetImage
Recipe Request - GetImage
Recipe Response - GetImage
Request - GetImage
Response - GetInfrastructure
Configuration Request GetInfrastructureConfiguration request object.
- GetInfrastructure
Configuration Response GetInfrastructureConfiguration response object.
- Image
An image build version.
- Image
Builder Client - A client for the imagebuilder API.
- Image
Pipeline Details of an image pipeline.
- Image
Recipe An image recipe.
- Image
Recipe Summary A summary of an image recipe.
- Image
State Image state shows the image status and the reason for that status.
- Image
Summary An image summary.
- Image
Tests Configuration Image tests configuration.
- Image
Version An image semantic version.
- Import
Component Request - Import
Component Response - Infrastructure
Configuration Details of the infrastructure configuration.
- Infrastructure
Configuration Summary The infrastructure used when building EC2 AMIs.
- Instance
Block Device Mapping Defines block device mappings for the instance used to configure your image.
- Launch
Permission Configuration Describes the configuration for a launch permission. The launch permission modification request is sent to the EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to
all. See the examples for making an AMI public at EC2 ModifyImageAttribute.- List
Component Build Versions Request - List
Component Build Versions Response - List
Components Request - List
Components Response - List
Distribution Configurations Request - List
Distribution Configurations Response - List
Image Build Versions Request - List
Image Build Versions Response - List
Image Pipeline Images Request - List
Image Pipeline Images Response - List
Image Pipelines Request - List
Image Pipelines Response - List
Image Recipes Request - List
Image Recipes Response - List
Images Request - List
Images Response - List
Infrastructure Configurations Request - List
Infrastructure Configurations Response - List
Tags ForResource Request - List
Tags ForResource Response - Logging
Logging configuration defines where Image Builder uploads your logs.
- Output
Resources The resources produced by this image.
- PutComponent
Policy Request - PutComponent
Policy Response - PutImage
Policy Request - PutImage
Policy Response - PutImage
Recipe Policy Request - PutImage
Recipe Policy Response - S3Logs
Amazon S3 logging configuration.
- Schedule
A schedule configures how often and when a pipeline will automatically create a new image.
- Start
Image Pipeline Execution Request - Start
Image Pipeline Execution Response - TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Update
Distribution Configuration Request - Update
Distribution Configuration Response - Update
Image Pipeline Request - Update
Image Pipeline Response - Update
Infrastructure Configuration Request - Update
Infrastructure Configuration Response
Enums§
- Cancel
Image Creation Error - Errors returned by CancelImageCreation
- Create
Component Error - Errors returned by CreateComponent
- Create
Distribution Configuration Error - Errors returned by CreateDistributionConfiguration
- Create
Image Error - Errors returned by CreateImage
- Create
Image Pipeline Error - Errors returned by CreateImagePipeline
- Create
Image Recipe Error - Errors returned by CreateImageRecipe
- Create
Infrastructure Configuration Error - Errors returned by CreateInfrastructureConfiguration
- Delete
Component Error - Errors returned by DeleteComponent
- Delete
Distribution Configuration Error - Errors returned by DeleteDistributionConfiguration
- Delete
Image Error - Errors returned by DeleteImage
- Delete
Image Pipeline Error - Errors returned by DeleteImagePipeline
- Delete
Image Recipe Error - Errors returned by DeleteImageRecipe
- Delete
Infrastructure Configuration Error - Errors returned by DeleteInfrastructureConfiguration
- GetComponent
Error - Errors returned by GetComponent
- GetComponent
Policy Error - Errors returned by GetComponentPolicy
- GetDistribution
Configuration Error - Errors returned by GetDistributionConfiguration
- GetImage
Error - Errors returned by GetImage
- GetImage
Pipeline Error - Errors returned by GetImagePipeline
- GetImage
Policy Error - Errors returned by GetImagePolicy
- GetImage
Recipe Error - Errors returned by GetImageRecipe
- GetImage
Recipe Policy Error - Errors returned by GetImageRecipePolicy
- GetInfrastructure
Configuration Error - Errors returned by GetInfrastructureConfiguration
- Import
Component Error - Errors returned by ImportComponent
- List
Component Build Versions Error - Errors returned by ListComponentBuildVersions
- List
Components Error - Errors returned by ListComponents
- List
Distribution Configurations Error - Errors returned by ListDistributionConfigurations
- List
Image Build Versions Error - Errors returned by ListImageBuildVersions
- List
Image Pipeline Images Error - Errors returned by ListImagePipelineImages
- List
Image Pipelines Error - Errors returned by ListImagePipelines
- List
Image Recipes Error - Errors returned by ListImageRecipes
- List
Images Error - Errors returned by ListImages
- List
Infrastructure Configurations Error - Errors returned by ListInfrastructureConfigurations
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutComponent
Policy Error - Errors returned by PutComponentPolicy
- PutImage
Policy Error - Errors returned by PutImagePolicy
- PutImage
Recipe Policy Error - Errors returned by PutImageRecipePolicy
- Start
Image Pipeline Execution Error - Errors returned by StartImagePipelineExecution
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Distribution Configuration Error - Errors returned by UpdateDistributionConfiguration
- Update
Image Pipeline Error - Errors returned by UpdateImagePipeline
- Update
Infrastructure Configuration Error - Errors returned by UpdateInfrastructureConfiguration
Traits§
- Image
Builder - Trait representing the capabilities of the imagebuilder API. imagebuilder clients implement this trait.