Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Image = Image' {
- arn :: Maybe Text
- buildType :: Maybe BuildType
- containerRecipe :: Maybe ContainerRecipe
- dateCreated :: Maybe Text
- distributionConfiguration :: Maybe DistributionConfiguration
- enhancedImageMetadataEnabled :: Maybe Bool
- imageRecipe :: Maybe ImageRecipe
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- infrastructureConfiguration :: Maybe InfrastructureConfiguration
- name :: Maybe Text
- osVersion :: Maybe Text
- outputResources :: Maybe OutputResources
- platform :: Maybe Platform
- sourcePipelineArn :: Maybe Text
- sourcePipelineName :: Maybe Text
- state :: Maybe ImageState
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ImageType
- version :: Maybe Text
- newImage :: Image
- image_arn :: Lens' Image (Maybe Text)
- image_buildType :: Lens' Image (Maybe BuildType)
- image_containerRecipe :: Lens' Image (Maybe ContainerRecipe)
- image_dateCreated :: Lens' Image (Maybe Text)
- image_distributionConfiguration :: Lens' Image (Maybe DistributionConfiguration)
- image_enhancedImageMetadataEnabled :: Lens' Image (Maybe Bool)
- image_imageRecipe :: Lens' Image (Maybe ImageRecipe)
- image_imageTestsConfiguration :: Lens' Image (Maybe ImageTestsConfiguration)
- image_infrastructureConfiguration :: Lens' Image (Maybe InfrastructureConfiguration)
- image_name :: Lens' Image (Maybe Text)
- image_osVersion :: Lens' Image (Maybe Text)
- image_outputResources :: Lens' Image (Maybe OutputResources)
- image_platform :: Lens' Image (Maybe Platform)
- image_sourcePipelineArn :: Lens' Image (Maybe Text)
- image_sourcePipelineName :: Lens' Image (Maybe Text)
- image_state :: Lens' Image (Maybe ImageState)
- image_tags :: Lens' Image (Maybe (HashMap Text Text))
- image_type :: Lens' Image (Maybe ImageType)
- image_version :: Lens' Image (Maybe Text)
Documentation
An Image Builder image. You must specify exactly one recipe for the
image – either a container recipe (containerRecipe
), which creates a
container image, or an image recipe (imageRecipe
), which creates an
AMI.
See: newImage
smart constructor.
Image' | |
|
Instances
Create a value of Image
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Image
, image_arn
- The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
$sel:buildType:Image'
, image_buildType
- Indicates the type of build that created this image. The build can be
initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
$sel:containerRecipe:Image'
, image_containerRecipe
- The recipe that is used to create an Image Builder container image.
Image
, image_dateCreated
- The date on which this image was created.
$sel:distributionConfiguration:Image'
, image_distributionConfiguration
- The distribution configuration used when creating this image.
$sel:enhancedImageMetadataEnabled:Image'
, image_enhancedImageMetadataEnabled
- Collects additional information about the image being created, including
the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder.
Enabled by default.
$sel:imageRecipe:Image'
, image_imageRecipe
- The image recipe used when creating the image.
$sel:imageTestsConfiguration:Image'
, image_imageTestsConfiguration
- The image tests configuration used when creating this image.
$sel:infrastructureConfiguration:Image'
, image_infrastructureConfiguration
- The infrastructure used when creating this image.
Image
, image_name
- The name of the image.
$sel:osVersion:Image'
, image_osVersion
- The operating system version of the instance. For example, Amazon Linux
2, Ubuntu 18, or Microsoft Windows Server 2019.
$sel:outputResources:Image'
, image_outputResources
- The output resources produced when creating this image.
Image
, image_platform
- The platform of the image.
$sel:sourcePipelineArn:Image'
, image_sourcePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that created this
image.
$sel:sourcePipelineName:Image'
, image_sourcePipelineName
- The name of the image pipeline that created this image.
$sel:state:Image'
, image_state
- The state of the image.
Image
, image_tags
- The tags of the image.
Image
, image_type
- Specifies whether this is an AMI or container image.
Image
, image_version
- The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
image_arn :: Lens' Image (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
image_buildType :: Lens' Image (Maybe BuildType) Source #
Indicates the type of build that created this image. The build can be initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
image_containerRecipe :: Lens' Image (Maybe ContainerRecipe) Source #
The recipe that is used to create an Image Builder container image.
image_distributionConfiguration :: Lens' Image (Maybe DistributionConfiguration) Source #
The distribution configuration used when creating this image.
image_enhancedImageMetadataEnabled :: Lens' Image (Maybe Bool) Source #
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
image_imageRecipe :: Lens' Image (Maybe ImageRecipe) Source #
The image recipe used when creating the image.
image_imageTestsConfiguration :: Lens' Image (Maybe ImageTestsConfiguration) Source #
The image tests configuration used when creating this image.
image_infrastructureConfiguration :: Lens' Image (Maybe InfrastructureConfiguration) Source #
The infrastructure used when creating this image.
image_osVersion :: Lens' Image (Maybe Text) Source #
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
image_outputResources :: Lens' Image (Maybe OutputResources) Source #
The output resources produced when creating this image.
image_sourcePipelineArn :: Lens' Image (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image pipeline that created this image.
image_sourcePipelineName :: Lens' Image (Maybe Text) Source #
The name of the image pipeline that created this image.
image_state :: Lens' Image (Maybe ImageState) Source #
The state of the image.
image_type :: Lens' Image (Maybe ImageType) Source #
Specifies whether this is an AMI or container image.
image_version :: Lens' Image (Maybe Text) Source #
The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.