amazonka-imagebuilder-2.0: Amazon EC2 Image Builder SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ImageBuilder.Lens

Contents

Description

 
Synopsis

Operations

CancelImageCreation

cancelImageCreation_imageBuildVersionArn :: Lens' CancelImageCreation Text Source #

The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

cancelImageCreation_clientToken :: Lens' CancelImageCreation Text Source #

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

cancelImageCreationResponse_clientToken :: Lens' CancelImageCreationResponse (Maybe Text) Source #

The idempotency token that was used for this request.

cancelImageCreationResponse_imageBuildVersionArn :: Lens' CancelImageCreationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

cancelImageCreationResponse_requestId :: Lens' CancelImageCreationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

cancelImageCreationResponse_httpStatus :: Lens' CancelImageCreationResponse Int Source #

The response's http status code.

CreateComponent

createComponent_changeDescription :: Lens' CreateComponent (Maybe Text) Source #

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

createComponent_data :: Lens' CreateComponent (Maybe Text) Source #

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

createComponent_description :: Lens' CreateComponent (Maybe Text) Source #

The description of the component. Describes the contents of the component.

createComponent_kmsKeyId :: Lens' CreateComponent (Maybe Text) Source #

The ID of the KMS key that should be used to encrypt this component.

createComponent_supportedOsVersions :: Lens' CreateComponent (Maybe (NonEmpty Text)) Source #

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

createComponent_tags :: Lens' CreateComponent (Maybe (HashMap Text Text)) Source #

The tags of the component.

createComponent_uri :: Lens' CreateComponent (Maybe Text) Source #

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

createComponent_name :: Lens' CreateComponent Text Source #

The name of the component.

createComponent_semanticVersion :: Lens' CreateComponent Text Source #

The semantic version of the component. This version follows the semantic version syntax.

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.

createComponent_platform :: Lens' CreateComponent Platform Source #

The platform of the component.

createComponent_clientToken :: Lens' CreateComponent Text Source #

The idempotency token of the component.

createComponentResponse_clientToken :: Lens' CreateComponentResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createComponentResponse_componentBuildVersionArn :: Lens' CreateComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component that was created by this request.

createComponentResponse_requestId :: Lens' CreateComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int Source #

The response's http status code.

CreateContainerRecipe

createContainerRecipe_description :: Lens' CreateContainerRecipe (Maybe Text) Source #

The description of the container recipe.

createContainerRecipe_dockerfileTemplateData :: Lens' CreateContainerRecipe (Maybe Text) Source #

The Dockerfile template used to build your image as an inline data blob.

createContainerRecipe_dockerfileTemplateUri :: Lens' CreateContainerRecipe (Maybe Text) Source #

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

createContainerRecipe_imageOsVersionOverride :: Lens' CreateContainerRecipe (Maybe Text) Source #

Specifies the operating system version for the base image.

createContainerRecipe_instanceConfiguration :: Lens' CreateContainerRecipe (Maybe InstanceConfiguration) Source #

A group of options that can be used to configure an instance for building and testing container images.

createContainerRecipe_kmsKeyId :: Lens' CreateContainerRecipe (Maybe Text) Source #

Identifies which KMS key is used to encrypt the container image.

createContainerRecipe_platformOverride :: Lens' CreateContainerRecipe (Maybe Platform) Source #

Specifies the operating system platform when you use a custom base image.

createContainerRecipe_tags :: Lens' CreateContainerRecipe (Maybe (HashMap Text Text)) Source #

Tags that are attached to the container recipe.

createContainerRecipe_workingDirectory :: Lens' CreateContainerRecipe (Maybe Text) Source #

The working directory for use during build and test workflows.

createContainerRecipe_containerType :: Lens' CreateContainerRecipe ContainerType Source #

The type of container to create.

createContainerRecipe_name :: Lens' CreateContainerRecipe Text Source #

The name of the container recipe.

createContainerRecipe_semanticVersion :: Lens' CreateContainerRecipe Text Source #

The semantic version of the container recipe. This version follows the semantic version syntax.

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.

createContainerRecipe_components :: Lens' CreateContainerRecipe (NonEmpty ComponentConfiguration) Source #

Components for build and test that are included in the container recipe.

createContainerRecipe_parentImage :: Lens' CreateContainerRecipe Text Source #

The base image for the container recipe.

createContainerRecipe_targetRepository :: Lens' CreateContainerRecipe TargetContainerRepository Source #

The destination repository for the container image.

createContainerRecipe_clientToken :: Lens' CreateContainerRecipe Text Source #

The client token used to make this request idempotent.

createContainerRecipeResponse_clientToken :: Lens' CreateContainerRecipeResponse (Maybe Text) Source #

The client token used to make this request idempotent.

createContainerRecipeResponse_containerRecipeArn :: Lens' CreateContainerRecipeResponse (Maybe Text) Source #

Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

createContainerRecipeResponse_requestId :: Lens' CreateContainerRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createContainerRecipeResponse_httpStatus :: Lens' CreateContainerRecipeResponse Int Source #

The response's http status code.

CreateDistributionConfiguration

createDistributionConfiguration_description :: Lens' CreateDistributionConfiguration (Maybe Text) Source #

The description of the distribution configuration.

createDistributionConfiguration_tags :: Lens' CreateDistributionConfiguration (Maybe (HashMap Text Text)) Source #

The tags of the distribution configuration.

createDistributionConfiguration_name :: Lens' CreateDistributionConfiguration Text Source #

The name of the distribution configuration.

createDistributionConfiguration_distributions :: Lens' CreateDistributionConfiguration [Distribution] Source #

The distributions of the distribution configuration.

createDistributionConfiguration_clientToken :: Lens' CreateDistributionConfiguration Text Source #

The idempotency token of the distribution configuration.

createDistributionConfigurationResponse_clientToken :: Lens' CreateDistributionConfigurationResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createDistributionConfigurationResponse_distributionConfigurationArn :: Lens' CreateDistributionConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.

createDistributionConfigurationResponse_requestId :: Lens' CreateDistributionConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createDistributionConfigurationResponse_httpStatus :: Lens' CreateDistributionConfigurationResponse Int Source #

The response's http status code.

CreateImage

createImage_containerRecipeArn :: Lens' CreateImage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

createImage_distributionConfigurationArn :: Lens' CreateImage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

createImage_enhancedImageMetadataEnabled :: Lens' CreateImage (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.

createImage_imageRecipeArn :: Lens' CreateImage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

createImage_imageTestsConfiguration :: Lens' CreateImage (Maybe ImageTestsConfiguration) Source #

The image tests configuration of the image.

createImage_tags :: Lens' CreateImage (Maybe (HashMap Text Text)) Source #

The tags of the image.

createImage_infrastructureConfigurationArn :: Lens' CreateImage Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

createImage_clientToken :: Lens' CreateImage Text Source #

The idempotency token used to make this request idempotent.

createImageResponse_clientToken :: Lens' CreateImageResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createImageResponse_imageBuildVersionArn :: Lens' CreateImageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image that was created by this request.

createImageResponse_requestId :: Lens' CreateImageResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createImageResponse_httpStatus :: Lens' CreateImageResponse Int Source #

The response's http status code.

CreateImagePipeline

createImagePipeline_containerRecipeArn :: Lens' CreateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

createImagePipeline_description :: Lens' CreateImagePipeline (Maybe Text) Source #

The description of the image pipeline.

createImagePipeline_distributionConfigurationArn :: Lens' CreateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

createImagePipeline_enhancedImageMetadataEnabled :: Lens' CreateImagePipeline (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.

createImagePipeline_imageRecipeArn :: Lens' CreateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

createImagePipeline_imageTestsConfiguration :: Lens' CreateImagePipeline (Maybe ImageTestsConfiguration) Source #

The image test configuration of the image pipeline.

createImagePipeline_schedule :: Lens' CreateImagePipeline (Maybe Schedule) Source #

The schedule of the image pipeline.

createImagePipeline_status :: Lens' CreateImagePipeline (Maybe PipelineStatus) Source #

The status of the image pipeline.

createImagePipeline_tags :: Lens' CreateImagePipeline (Maybe (HashMap Text Text)) Source #

The tags of the image pipeline.

createImagePipeline_name :: Lens' CreateImagePipeline Text Source #

The name of the image pipeline.

createImagePipeline_infrastructureConfigurationArn :: Lens' CreateImagePipeline Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

createImagePipeline_clientToken :: Lens' CreateImagePipeline Text Source #

The idempotency token used to make this request idempotent.

createImagePipelineResponse_clientToken :: Lens' CreateImagePipelineResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createImagePipelineResponse_imagePipelineArn :: Lens' CreateImagePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

createImagePipelineResponse_requestId :: Lens' CreateImagePipelineResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createImagePipelineResponse_httpStatus :: Lens' CreateImagePipelineResponse Int Source #

The response's http status code.

CreateImageRecipe

createImageRecipe_additionalInstanceConfiguration :: Lens' CreateImageRecipe (Maybe AdditionalInstanceConfiguration) Source #

Specify additional settings and launch scripts for your build instances.

createImageRecipe_blockDeviceMappings :: Lens' CreateImageRecipe (Maybe [InstanceBlockDeviceMapping]) Source #

The block device mappings of the image recipe.

createImageRecipe_description :: Lens' CreateImageRecipe (Maybe Text) Source #

The description of the image recipe.

createImageRecipe_tags :: Lens' CreateImageRecipe (Maybe (HashMap Text Text)) Source #

The tags of the image recipe.

createImageRecipe_workingDirectory :: Lens' CreateImageRecipe (Maybe Text) Source #

The working directory used during build and test workflows.

createImageRecipe_name :: Lens' CreateImageRecipe Text Source #

The name of the image recipe.

createImageRecipe_semanticVersion :: Lens' CreateImageRecipe Text Source #

The semantic version of the image recipe. This version follows the semantic version syntax.

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.

createImageRecipe_components :: Lens' CreateImageRecipe (NonEmpty ComponentConfiguration) Source #

The components of the image recipe.

createImageRecipe_parentImage :: Lens' CreateImageRecipe Text Source #

The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

createImageRecipe_clientToken :: Lens' CreateImageRecipe Text Source #

The idempotency token used to make this request idempotent.

createImageRecipeResponse_clientToken :: Lens' CreateImageRecipeResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createImageRecipeResponse_imageRecipeArn :: Lens' CreateImageRecipeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that was created by this request.

createImageRecipeResponse_requestId :: Lens' CreateImageRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createImageRecipeResponse_httpStatus :: Lens' CreateImageRecipeResponse Int Source #

The response's http status code.

CreateInfrastructureConfiguration

createInfrastructureConfiguration_description :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

The description of the infrastructure configuration.

createInfrastructureConfiguration_instanceMetadataOptions :: Lens' CreateInfrastructureConfiguration (Maybe InstanceMetadataOptions) Source #

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

createInfrastructureConfiguration_instanceTypes :: Lens' CreateInfrastructureConfiguration (Maybe [Text]) Source #

The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

createInfrastructureConfiguration_keyPair :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

createInfrastructureConfiguration_logging :: Lens' CreateInfrastructureConfiguration (Maybe Logging) Source #

The logging configuration of the infrastructure configuration.

createInfrastructureConfiguration_resourceTags :: Lens' CreateInfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags attached to the resource created by Image Builder.

createInfrastructureConfiguration_securityGroupIds :: Lens' CreateInfrastructureConfiguration (Maybe [Text]) Source #

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

createInfrastructureConfiguration_snsTopicArn :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

createInfrastructureConfiguration_subnetId :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

createInfrastructureConfiguration_tags :: Lens' CreateInfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags of the infrastructure configuration.

createInfrastructureConfiguration_terminateInstanceOnFailure :: Lens' CreateInfrastructureConfiguration (Maybe Bool) Source #

The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

createInfrastructureConfiguration_name :: Lens' CreateInfrastructureConfiguration Text Source #

The name of the infrastructure configuration.

createInfrastructureConfiguration_instanceProfileName :: Lens' CreateInfrastructureConfiguration Text Source #

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

createInfrastructureConfiguration_clientToken :: Lens' CreateInfrastructureConfiguration Text Source #

The idempotency token used to make this request idempotent.

createInfrastructureConfigurationResponse_clientToken :: Lens' CreateInfrastructureConfigurationResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createInfrastructureConfigurationResponse_infrastructureConfigurationArn :: Lens' CreateInfrastructureConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

createInfrastructureConfigurationResponse_requestId :: Lens' CreateInfrastructureConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createInfrastructureConfigurationResponse_httpStatus :: Lens' CreateInfrastructureConfigurationResponse Int Source #

The response's http status code.

DeleteComponent

deleteComponent_componentBuildVersionArn :: Lens' DeleteComponent Text Source #

The Amazon Resource Name (ARN) of the component build version to delete.

deleteComponentResponse_componentBuildVersionArn :: Lens' DeleteComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component build version that was deleted.

deleteComponentResponse_requestId :: Lens' DeleteComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteComponentResponse_httpStatus :: Lens' DeleteComponentResponse Int Source #

The response's http status code.

DeleteContainerRecipe

deleteContainerRecipe_containerRecipeArn :: Lens' DeleteContainerRecipe Text Source #

The Amazon Resource Name (ARN) of the container recipe to delete.

deleteContainerRecipeResponse_containerRecipeArn :: Lens' DeleteContainerRecipeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that was deleted.

deleteContainerRecipeResponse_requestId :: Lens' DeleteContainerRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteContainerRecipeResponse_httpStatus :: Lens' DeleteContainerRecipeResponse Int Source #

The response's http status code.

DeleteDistributionConfiguration

deleteDistributionConfiguration_distributionConfigurationArn :: Lens' DeleteDistributionConfiguration Text Source #

The Amazon Resource Name (ARN) of the distribution configuration to delete.

deleteDistributionConfigurationResponse_distributionConfigurationArn :: Lens' DeleteDistributionConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that was deleted.

deleteDistributionConfigurationResponse_requestId :: Lens' DeleteDistributionConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteDistributionConfigurationResponse_httpStatus :: Lens' DeleteDistributionConfigurationResponse Int Source #

The response's http status code.

DeleteImage

deleteImage_imageBuildVersionArn :: Lens' DeleteImage Text Source #

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

deleteImageResponse_imageBuildVersionArn :: Lens' DeleteImageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Image Builder image resource that was deleted.

deleteImageResponse_requestId :: Lens' DeleteImageResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteImageResponse_httpStatus :: Lens' DeleteImageResponse Int Source #

The response's http status code.

DeleteImagePipeline

deleteImagePipeline_imagePipelineArn :: Lens' DeleteImagePipeline Text Source #

The Amazon Resource Name (ARN) of the image pipeline to delete.

deleteImagePipelineResponse_imagePipelineArn :: Lens' DeleteImagePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

deleteImagePipelineResponse_requestId :: Lens' DeleteImagePipelineResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteImagePipelineResponse_httpStatus :: Lens' DeleteImagePipelineResponse Int Source #

The response's http status code.

DeleteImageRecipe

deleteImageRecipe_imageRecipeArn :: Lens' DeleteImageRecipe Text Source #

The Amazon Resource Name (ARN) of the image recipe to delete.

deleteImageRecipeResponse_imageRecipeArn :: Lens' DeleteImageRecipeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that was deleted.

deleteImageRecipeResponse_requestId :: Lens' DeleteImageRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteImageRecipeResponse_httpStatus :: Lens' DeleteImageRecipeResponse Int Source #

The response's http status code.

DeleteInfrastructureConfiguration

deleteInfrastructureConfiguration_infrastructureConfigurationArn :: Lens' DeleteInfrastructureConfiguration Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

deleteInfrastructureConfigurationResponse_infrastructureConfigurationArn :: Lens' DeleteInfrastructureConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.

deleteInfrastructureConfigurationResponse_requestId :: Lens' DeleteInfrastructureConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

deleteInfrastructureConfigurationResponse_httpStatus :: Lens' DeleteInfrastructureConfigurationResponse Int Source #

The response's http status code.

GetComponent

getComponent_componentBuildVersionArn :: Lens' GetComponent Text Source #

The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/\d+$" suffix.

getComponentResponse_component :: Lens' GetComponentResponse (Maybe Component) Source #

The component object associated with the specified ARN.

getComponentResponse_requestId :: Lens' GetComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getComponentResponse_httpStatus :: Lens' GetComponentResponse Int Source #

The response's http status code.

GetComponentPolicy

getComponentPolicy_componentArn :: Lens' GetComponentPolicy Text Source #

The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

getComponentPolicyResponse_policy :: Lens' GetComponentPolicyResponse (Maybe Text) Source #

The component policy.

getComponentPolicyResponse_requestId :: Lens' GetComponentPolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getComponentPolicyResponse_httpStatus :: Lens' GetComponentPolicyResponse Int Source #

The response's http status code.

GetContainerRecipe

getContainerRecipe_containerRecipeArn :: Lens' GetContainerRecipe Text Source #

The Amazon Resource Name (ARN) of the container recipe to retrieve.

getContainerRecipeResponse_containerRecipe :: Lens' GetContainerRecipeResponse (Maybe ContainerRecipe) Source #

The container recipe object that is returned.

getContainerRecipeResponse_requestId :: Lens' GetContainerRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getContainerRecipeResponse_httpStatus :: Lens' GetContainerRecipeResponse Int Source #

The response's http status code.

GetContainerRecipePolicy

getContainerRecipePolicy_containerRecipeArn :: Lens' GetContainerRecipePolicy Text Source #

The Amazon Resource Name (ARN) of the container recipe for the policy being requested.

getContainerRecipePolicyResponse_policy :: Lens' GetContainerRecipePolicyResponse (Maybe Text) Source #

The container recipe policy object that is returned.

getContainerRecipePolicyResponse_requestId :: Lens' GetContainerRecipePolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getContainerRecipePolicyResponse_httpStatus :: Lens' GetContainerRecipePolicyResponse Int Source #

The response's http status code.

GetDistributionConfiguration

getDistributionConfiguration_distributionConfigurationArn :: Lens' GetDistributionConfiguration Text Source #

The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

getDistributionConfigurationResponse_distributionConfiguration :: Lens' GetDistributionConfigurationResponse (Maybe DistributionConfiguration) Source #

The distribution configuration object.

getDistributionConfigurationResponse_requestId :: Lens' GetDistributionConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getDistributionConfigurationResponse_httpStatus :: Lens' GetDistributionConfigurationResponse Int Source #

The response's http status code.

GetImage

getImage_imageBuildVersionArn :: Lens' GetImage Text Source #

The Amazon Resource Name (ARN) of the image that you want to retrieve.

getImageResponse_image :: Lens' GetImageResponse (Maybe Image) Source #

The image object.

getImageResponse_requestId :: Lens' GetImageResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getImageResponse_httpStatus :: Lens' GetImageResponse Int Source #

The response's http status code.

GetImagePipeline

getImagePipeline_imagePipelineArn :: Lens' GetImagePipeline Text Source #

The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

getImagePipelineResponse_imagePipeline :: Lens' GetImagePipelineResponse (Maybe ImagePipeline) Source #

The image pipeline object.

getImagePipelineResponse_requestId :: Lens' GetImagePipelineResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getImagePipelineResponse_httpStatus :: Lens' GetImagePipelineResponse Int Source #

The response's http status code.

GetImagePolicy

getImagePolicy_imageArn :: Lens' GetImagePolicy Text Source #

The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

getImagePolicyResponse_policy :: Lens' GetImagePolicyResponse (Maybe Text) Source #

The image policy object.

getImagePolicyResponse_requestId :: Lens' GetImagePolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getImagePolicyResponse_httpStatus :: Lens' GetImagePolicyResponse Int Source #

The response's http status code.

GetImageRecipe

getImageRecipe_imageRecipeArn :: Lens' GetImageRecipe Text Source #

The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

getImageRecipeResponse_imageRecipe :: Lens' GetImageRecipeResponse (Maybe ImageRecipe) Source #

The image recipe object.

getImageRecipeResponse_requestId :: Lens' GetImageRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getImageRecipeResponse_httpStatus :: Lens' GetImageRecipeResponse Int Source #

The response's http status code.

GetImageRecipePolicy

getImageRecipePolicy_imageRecipeArn :: Lens' GetImageRecipePolicy Text Source #

The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.

getImageRecipePolicyResponse_policy :: Lens' GetImageRecipePolicyResponse (Maybe Text) Source #

The image recipe policy object.

getImageRecipePolicyResponse_requestId :: Lens' GetImageRecipePolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getImageRecipePolicyResponse_httpStatus :: Lens' GetImageRecipePolicyResponse Int Source #

The response's http status code.

GetInfrastructureConfiguration

getInfrastructureConfiguration_infrastructureConfigurationArn :: Lens' GetInfrastructureConfiguration Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

getInfrastructureConfigurationResponse_infrastructureConfiguration :: Lens' GetInfrastructureConfigurationResponse (Maybe InfrastructureConfiguration) Source #

The infrastructure configuration object.

getInfrastructureConfigurationResponse_requestId :: Lens' GetInfrastructureConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

getInfrastructureConfigurationResponse_httpStatus :: Lens' GetInfrastructureConfigurationResponse Int Source #

The response's http status code.

ImportComponent

importComponent_changeDescription :: Lens' ImportComponent (Maybe Text) Source #

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

importComponent_data :: Lens' ImportComponent (Maybe Text) Source #

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

importComponent_description :: Lens' ImportComponent (Maybe Text) Source #

The description of the component. Describes the contents of the component.

importComponent_kmsKeyId :: Lens' ImportComponent (Maybe Text) Source #

The ID of the KMS key that should be used to encrypt this component.

importComponent_tags :: Lens' ImportComponent (Maybe (HashMap Text Text)) Source #

The tags of the component.

importComponent_uri :: Lens' ImportComponent (Maybe Text) Source #

The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

importComponent_name :: Lens' ImportComponent Text Source #

The name of the component.

importComponent_semanticVersion :: Lens' ImportComponent Text Source #

The semantic version of the component. This version follows the semantic version syntax.

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.

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.

importComponent_type :: Lens' ImportComponent ComponentType Source #

The type of the component denotes whether the component is used to build the image, or only to test it.

importComponent_format :: Lens' ImportComponent ComponentFormat Source #

The format of the resource that you want to import as a component.

importComponent_platform :: Lens' ImportComponent Platform Source #

The platform of the component.

importComponent_clientToken :: Lens' ImportComponent Text Source #

The idempotency token of the component.

importComponentResponse_clientToken :: Lens' ImportComponentResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

importComponentResponse_componentBuildVersionArn :: Lens' ImportComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the imported component.

importComponentResponse_requestId :: Lens' ImportComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

importComponentResponse_httpStatus :: Lens' ImportComponentResponse Int Source #

The response's http status code.

ImportVmImage

importVmImage_description :: Lens' ImportVmImage (Maybe Text) Source #

The description for the base image that is created by the import process.

importVmImage_osVersion :: Lens' ImportVmImage (Maybe Text) Source #

The operating system version for the imported VM.

importVmImage_tags :: Lens' ImportVmImage (Maybe (HashMap Text Text)) Source #

Tags that are attached to the import resources.

importVmImage_name :: Lens' ImportVmImage Text Source #

The name of the base image that is created by the import process.

importVmImage_semanticVersion :: Lens' ImportVmImage Text Source #

The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

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.

importVmImage_platform :: Lens' ImportVmImage Platform Source #

The operating system platform for the imported VM.

importVmImage_vmImportTaskId :: Lens' ImportVmImage Text Source #

The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

importVmImage_clientToken :: Lens' ImportVmImage Text Source #

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

importVmImageResponse_clientToken :: Lens' ImportVmImageResponse (Maybe Text) Source #

The idempotency token that was used for this request.

importVmImageResponse_imageArn :: Lens' ImportVmImageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.

importVmImageResponse_requestId :: Lens' ImportVmImageResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

importVmImageResponse_httpStatus :: Lens' ImportVmImageResponse Int Source #

The response's http status code.

ListComponentBuildVersions

listComponentBuildVersions_maxResults :: Lens' ListComponentBuildVersions (Maybe Natural) Source #

The maximum items to return in a request.

listComponentBuildVersions_nextToken :: Lens' ListComponentBuildVersions (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listComponentBuildVersions_componentVersionArn :: Lens' ListComponentBuildVersions Text Source #

The component version Amazon Resource Name (ARN) whose versions you want to list.

listComponentBuildVersionsResponse_componentSummaryList :: Lens' ListComponentBuildVersionsResponse (Maybe [ComponentSummary]) Source #

The list of component summaries for the specified semantic version.

listComponentBuildVersionsResponse_nextToken :: Lens' ListComponentBuildVersionsResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listComponentBuildVersionsResponse_requestId :: Lens' ListComponentBuildVersionsResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listComponentBuildVersionsResponse_httpStatus :: Lens' ListComponentBuildVersionsResponse Int Source #

The response's http status code.

ListComponents

listComponents_byName :: Lens' ListComponents (Maybe Bool) Source #

Returns the list of component build versions for the specified name.

listComponents_filters :: Lens' ListComponents (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • description
  • name
  • platform
  • supportedOsVersion
  • type
  • version

listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #

The maximum items to return in a request.

listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listComponents_owner :: Lens' ListComponents (Maybe Ownership) Source #

The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.

listComponentsResponse_componentVersionList :: Lens' ListComponentsResponse (Maybe [ComponentVersion]) Source #

The list of component semantic versions.

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.

listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listComponentsResponse_requestId :: Lens' ListComponentsResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int Source #

The response's http status code.

ListContainerRecipes

listContainerRecipes_filters :: Lens' ListContainerRecipes (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • containerType
  • name
  • parentImage
  • platform

listContainerRecipes_maxResults :: Lens' ListContainerRecipes (Maybe Natural) Source #

The maximum number of results to return in the list.

listContainerRecipes_nextToken :: Lens' ListContainerRecipes (Maybe Text) Source #

Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

listContainerRecipes_owner :: Lens' ListContainerRecipes (Maybe Ownership) Source #

Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

listContainerRecipesResponse_containerRecipeSummaryList :: Lens' ListContainerRecipesResponse (Maybe [ContainerRecipeSummary]) Source #

The list of container recipes returned for the request.

listContainerRecipesResponse_nextToken :: Lens' ListContainerRecipesResponse (Maybe Text) Source #

The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.

listContainerRecipesResponse_requestId :: Lens' ListContainerRecipesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listContainerRecipesResponse_httpStatus :: Lens' ListContainerRecipesResponse Int Source #

The response's http status code.

ListDistributionConfigurations

listDistributionConfigurations_filters :: Lens' ListDistributionConfigurations (Maybe (NonEmpty Filter)) Source #

You can filter on name to streamline results.

listDistributionConfigurations_maxResults :: Lens' ListDistributionConfigurations (Maybe Natural) Source #

The maximum items to return in a request.

listDistributionConfigurations_nextToken :: Lens' ListDistributionConfigurations (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listDistributionConfigurationsResponse_distributionConfigurationSummaryList :: Lens' ListDistributionConfigurationsResponse (Maybe [DistributionConfigurationSummary]) Source #

The list of distributions.

listDistributionConfigurationsResponse_nextToken :: Lens' ListDistributionConfigurationsResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listDistributionConfigurationsResponse_requestId :: Lens' ListDistributionConfigurationsResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listDistributionConfigurationsResponse_httpStatus :: Lens' ListDistributionConfigurationsResponse Int Source #

The response's http status code.

ListImageBuildVersions

listImageBuildVersions_filters :: Lens' ListImageBuildVersions (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • name
  • osVersion
  • platform
  • type
  • version

listImageBuildVersions_maxResults :: Lens' ListImageBuildVersions (Maybe Natural) Source #

The maximum items to return in a request.

listImageBuildVersions_nextToken :: Lens' ListImageBuildVersions (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImageBuildVersions_imageVersionArn :: Lens' ListImageBuildVersions Text Source #

The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.

listImageBuildVersionsResponse_imageSummaryList :: Lens' ListImageBuildVersionsResponse (Maybe [ImageSummary]) Source #

The list of image build versions.

listImageBuildVersionsResponse_nextToken :: Lens' ListImageBuildVersionsResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listImageBuildVersionsResponse_requestId :: Lens' ListImageBuildVersionsResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImageBuildVersionsResponse_httpStatus :: Lens' ListImageBuildVersionsResponse Int Source #

The response's http status code.

ListImagePackages

listImagePackages_maxResults :: Lens' ListImagePackages (Maybe Natural) Source #

The maxiumum number of results to return from the ListImagePackages request.

listImagePackages_nextToken :: Lens' ListImagePackages (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImagePackages_imageBuildVersionArn :: Lens' ListImagePackages Text Source #

Filter results for the ListImagePackages request by the Image Build Version ARN

listImagePackagesResponse_imagePackageList :: Lens' ListImagePackagesResponse (Maybe [ImagePackage]) Source #

The list of Image Packages returned in the response.

listImagePackagesResponse_nextToken :: Lens' ListImagePackagesResponse (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImagePackagesResponse_requestId :: Lens' ListImagePackagesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImagePackagesResponse_httpStatus :: Lens' ListImagePackagesResponse Int Source #

The response's http status code.

ListImagePipelineImages

listImagePipelineImages_filters :: Lens' ListImagePipelineImages (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • name
  • version

listImagePipelineImages_maxResults :: Lens' ListImagePipelineImages (Maybe Natural) Source #

The maximum items to return in a request.

listImagePipelineImages_nextToken :: Lens' ListImagePipelineImages (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImagePipelineImages_imagePipelineArn :: Lens' ListImagePipelineImages Text Source #

The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

listImagePipelineImagesResponse_imageSummaryList :: Lens' ListImagePipelineImagesResponse (Maybe [ImageSummary]) Source #

The list of images built by this pipeline.

listImagePipelineImagesResponse_nextToken :: Lens' ListImagePipelineImagesResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listImagePipelineImagesResponse_requestId :: Lens' ListImagePipelineImagesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImagePipelineImagesResponse_httpStatus :: Lens' ListImagePipelineImagesResponse Int Source #

The response's http status code.

ListImagePipelines

listImagePipelines_filters :: Lens' ListImagePipelines (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • description
  • distributionConfigurationArn
  • imageRecipeArn
  • infrastructureConfigurationArn
  • name
  • status

listImagePipelines_maxResults :: Lens' ListImagePipelines (Maybe Natural) Source #

The maximum items to return in a request.

listImagePipelines_nextToken :: Lens' ListImagePipelines (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImagePipelinesResponse_imagePipelineList :: Lens' ListImagePipelinesResponse (Maybe [ImagePipeline]) Source #

The list of image pipelines.

listImagePipelinesResponse_nextToken :: Lens' ListImagePipelinesResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listImagePipelinesResponse_requestId :: Lens' ListImagePipelinesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImagePipelinesResponse_httpStatus :: Lens' ListImagePipelinesResponse Int Source #

The response's http status code.

ListImageRecipes

listImageRecipes_filters :: Lens' ListImageRecipes (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • name
  • parentImage
  • platform

listImageRecipes_maxResults :: Lens' ListImageRecipes (Maybe Natural) Source #

The maximum items to return in a request.

listImageRecipes_nextToken :: Lens' ListImageRecipes (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImageRecipes_owner :: Lens' ListImageRecipes (Maybe Ownership) Source #

The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.

listImageRecipesResponse_imageRecipeSummaryList :: Lens' ListImageRecipesResponse (Maybe [ImageRecipeSummary]) Source #

The list of image pipelines.

listImageRecipesResponse_nextToken :: Lens' ListImageRecipesResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listImageRecipesResponse_requestId :: Lens' ListImageRecipesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImageRecipesResponse_httpStatus :: Lens' ListImageRecipesResponse Int Source #

The response's http status code.

ListImages

listImages_byName :: Lens' ListImages (Maybe Bool) Source #

Requests a list of images with a specific recipe name.

listImages_filters :: Lens' ListImages (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • name
  • osVersion
  • platform
  • type
  • version

listImages_includeDeprecated :: Lens' ListImages (Maybe Bool) Source #

Includes deprecated images in the response list.

listImages_maxResults :: Lens' ListImages (Maybe Natural) Source #

The maximum items to return in a request.

listImages_nextToken :: Lens' ListImages (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImages_owner :: Lens' ListImages (Maybe Ownership) Source #

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

listImagesResponse_imageVersionList :: Lens' ListImagesResponse (Maybe [ImageVersion]) Source #

The list of image semantic versions.

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.

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.

listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listImagesResponse_requestId :: Lens' ListImagesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImagesResponse_httpStatus :: Lens' ListImagesResponse Int Source #

The response's http status code.

ListInfrastructureConfigurations

listInfrastructureConfigurations_filters :: Lens' ListInfrastructureConfigurations (Maybe (NonEmpty Filter)) Source #

You can filter on name to streamline results.

listInfrastructureConfigurations_maxResults :: Lens' ListInfrastructureConfigurations (Maybe Natural) Source #

The maximum items to return in a request.

listInfrastructureConfigurations_nextToken :: Lens' ListInfrastructureConfigurations (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listInfrastructureConfigurationsResponse_infrastructureConfigurationSummaryList :: Lens' ListInfrastructureConfigurationsResponse (Maybe [InfrastructureConfigurationSummary]) Source #

The list of infrastructure configurations.

listInfrastructureConfigurationsResponse_nextToken :: Lens' ListInfrastructureConfigurationsResponse (Maybe Text) Source #

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listInfrastructureConfigurationsResponse_requestId :: Lens' ListInfrastructureConfigurationsResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listInfrastructureConfigurationsResponse_httpStatus :: Lens' ListInfrastructureConfigurationsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags for the specified resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

PutComponentPolicy

putComponentPolicy_componentArn :: Lens' PutComponentPolicy Text Source #

The Amazon Resource Name (ARN) of the component that this policy should be applied to.

putComponentPolicy_policy :: Lens' PutComponentPolicy Text Source #

The policy to apply.

putComponentPolicyResponse_componentArn :: Lens' PutComponentPolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component that this policy was applied to.

putComponentPolicyResponse_requestId :: Lens' PutComponentPolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

putComponentPolicyResponse_httpStatus :: Lens' PutComponentPolicyResponse Int Source #

The response's http status code.

PutContainerRecipePolicy

putContainerRecipePolicy_containerRecipeArn :: Lens' PutContainerRecipePolicy Text Source #

The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

putContainerRecipePolicy_policy :: Lens' PutContainerRecipePolicy Text Source #

The policy to apply to the container recipe.

putContainerRecipePolicyResponse_containerRecipeArn :: Lens' PutContainerRecipePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

putContainerRecipePolicyResponse_requestId :: Lens' PutContainerRecipePolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

putContainerRecipePolicyResponse_httpStatus :: Lens' PutContainerRecipePolicyResponse Int Source #

The response's http status code.

PutImagePolicy

putImagePolicy_imageArn :: Lens' PutImagePolicy Text Source #

The Amazon Resource Name (ARN) of the image that this policy should be applied to.

putImagePolicy_policy :: Lens' PutImagePolicy Text Source #

The policy to apply.

putImagePolicyResponse_imageArn :: Lens' PutImagePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image that this policy was applied to.

putImagePolicyResponse_requestId :: Lens' PutImagePolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

putImagePolicyResponse_httpStatus :: Lens' PutImagePolicyResponse Int Source #

The response's http status code.

PutImageRecipePolicy

putImageRecipePolicy_imageRecipeArn :: Lens' PutImageRecipePolicy Text Source #

The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.

putImageRecipePolicy_policy :: Lens' PutImageRecipePolicy Text Source #

The policy to apply.

putImageRecipePolicyResponse_imageRecipeArn :: Lens' PutImageRecipePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.

putImageRecipePolicyResponse_requestId :: Lens' PutImageRecipePolicyResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

putImageRecipePolicyResponse_httpStatus :: Lens' PutImageRecipePolicyResponse Int Source #

The response's http status code.

StartImagePipelineExecution

startImagePipelineExecution_imagePipelineArn :: Lens' StartImagePipelineExecution Text Source #

The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

startImagePipelineExecution_clientToken :: Lens' StartImagePipelineExecution Text Source #

The idempotency token used to make this request idempotent.

startImagePipelineExecutionResponse_clientToken :: Lens' StartImagePipelineExecutionResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

startImagePipelineExecutionResponse_imageBuildVersionArn :: Lens' StartImagePipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image that was created by this request.

startImagePipelineExecutionResponse_requestId :: Lens' StartImagePipelineExecutionResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

startImagePipelineExecutionResponse_httpStatus :: Lens' StartImagePipelineExecutionResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to tag.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to apply to the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to untag.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys to remove from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateDistributionConfiguration

updateDistributionConfiguration_description :: Lens' UpdateDistributionConfiguration (Maybe Text) Source #

The description of the distribution configuration.

updateDistributionConfiguration_distributionConfigurationArn :: Lens' UpdateDistributionConfiguration Text Source #

The Amazon Resource Name (ARN) of the distribution configuration that you want to update.

updateDistributionConfiguration_distributions :: Lens' UpdateDistributionConfiguration [Distribution] Source #

The distributions of the distribution configuration.

updateDistributionConfiguration_clientToken :: Lens' UpdateDistributionConfiguration Text Source #

The idempotency token of the distribution configuration.

updateDistributionConfigurationResponse_clientToken :: Lens' UpdateDistributionConfigurationResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

updateDistributionConfigurationResponse_distributionConfigurationArn :: Lens' UpdateDistributionConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.

updateDistributionConfigurationResponse_requestId :: Lens' UpdateDistributionConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

updateDistributionConfigurationResponse_httpStatus :: Lens' UpdateDistributionConfigurationResponse Int Source #

The response's http status code.

UpdateImagePipeline

updateImagePipeline_containerRecipeArn :: Lens' UpdateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container pipeline to update.

updateImagePipeline_description :: Lens' UpdateImagePipeline (Maybe Text) Source #

The description of the image pipeline.

updateImagePipeline_distributionConfigurationArn :: Lens' UpdateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

updateImagePipeline_enhancedImageMetadataEnabled :: Lens' UpdateImagePipeline (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.

updateImagePipeline_imageRecipeArn :: Lens' UpdateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

updateImagePipeline_imageTestsConfiguration :: Lens' UpdateImagePipeline (Maybe ImageTestsConfiguration) Source #

The image test configuration of the image pipeline.

updateImagePipeline_schedule :: Lens' UpdateImagePipeline (Maybe Schedule) Source #

The schedule of the image pipeline.

updateImagePipeline_status :: Lens' UpdateImagePipeline (Maybe PipelineStatus) Source #

The status of the image pipeline.

updateImagePipeline_imagePipelineArn :: Lens' UpdateImagePipeline Text Source #

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

updateImagePipeline_infrastructureConfigurationArn :: Lens' UpdateImagePipeline Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

updateImagePipeline_clientToken :: Lens' UpdateImagePipeline Text Source #

The idempotency token used to make this request idempotent.

updateImagePipelineResponse_clientToken :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

updateImagePipelineResponse_imagePipelineArn :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

updateImagePipelineResponse_requestId :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

updateImagePipelineResponse_httpStatus :: Lens' UpdateImagePipelineResponse Int Source #

The response's http status code.

UpdateInfrastructureConfiguration

updateInfrastructureConfiguration_description :: Lens' UpdateInfrastructureConfiguration (Maybe Text) Source #

The description of the infrastructure configuration.

updateInfrastructureConfiguration_instanceMetadataOptions :: Lens' UpdateInfrastructureConfiguration (Maybe InstanceMetadataOptions) Source #

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:

updateInfrastructureConfiguration_instanceTypes :: Lens' UpdateInfrastructureConfiguration (Maybe [Text]) Source #

The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

updateInfrastructureConfiguration_keyPair :: Lens' UpdateInfrastructureConfiguration (Maybe Text) Source #

The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

updateInfrastructureConfiguration_logging :: Lens' UpdateInfrastructureConfiguration (Maybe Logging) Source #

The logging configuration of the infrastructure configuration.

updateInfrastructureConfiguration_resourceTags :: Lens' UpdateInfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags attached to the resource created by Image Builder.

updateInfrastructureConfiguration_securityGroupIds :: Lens' UpdateInfrastructureConfiguration (Maybe [Text]) Source #

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

updateInfrastructureConfiguration_snsTopicArn :: Lens' UpdateInfrastructureConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

updateInfrastructureConfiguration_subnetId :: Lens' UpdateInfrastructureConfiguration (Maybe Text) Source #

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

updateInfrastructureConfiguration_terminateInstanceOnFailure :: Lens' UpdateInfrastructureConfiguration (Maybe Bool) Source #

The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

updateInfrastructureConfiguration_infrastructureConfigurationArn :: Lens' UpdateInfrastructureConfiguration Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

updateInfrastructureConfiguration_instanceProfileName :: Lens' UpdateInfrastructureConfiguration Text Source #

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

updateInfrastructureConfiguration_clientToken :: Lens' UpdateInfrastructureConfiguration Text Source #

The idempotency token used to make this request idempotent.

updateInfrastructureConfigurationResponse_clientToken :: Lens' UpdateInfrastructureConfigurationResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

updateInfrastructureConfigurationResponse_infrastructureConfigurationArn :: Lens' UpdateInfrastructureConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

updateInfrastructureConfigurationResponse_requestId :: Lens' UpdateInfrastructureConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

updateInfrastructureConfigurationResponse_httpStatus :: Lens' UpdateInfrastructureConfigurationResponse Int Source #

The response's http status code.

Types

AdditionalInstanceConfiguration

additionalInstanceConfiguration_systemsManagerAgent :: Lens' AdditionalInstanceConfiguration (Maybe SystemsManagerAgent) Source #

Contains settings for the Systems Manager agent on your build instance.

additionalInstanceConfiguration_userDataOverride :: Lens' AdditionalInstanceConfiguration (Maybe Text) Source #

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

Ami

ami_accountId :: Lens' Ami (Maybe Text) Source #

The account ID of the owner of the AMI.

ami_description :: Lens' Ami (Maybe Text) Source #

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

ami_image :: Lens' Ami (Maybe Text) Source #

The AMI ID of the Amazon EC2 AMI.

ami_name :: Lens' Ami (Maybe Text) Source #

The name of the Amazon EC2 AMI.

ami_region :: Lens' Ami (Maybe Text) Source #

The Amazon Web Services Region of the Amazon EC2 AMI.

ami_state :: Lens' Ami (Maybe ImageState) Source #

Undocumented member.

AmiDistributionConfiguration

amiDistributionConfiguration_amiTags :: Lens' AmiDistributionConfiguration (Maybe (HashMap Text Text)) Source #

The tags to apply to AMIs distributed to this Region.

amiDistributionConfiguration_description :: Lens' AmiDistributionConfiguration (Maybe Text) Source #

The description of the AMI distribution configuration. Minimum and maximum length are in characters.

amiDistributionConfiguration_kmsKeyId :: Lens' AmiDistributionConfiguration (Maybe Text) Source #

The KMS key identifier used to encrypt the distributed image.

amiDistributionConfiguration_launchPermission :: Lens' AmiDistributionConfiguration (Maybe LaunchPermissionConfiguration) Source #

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

amiDistributionConfiguration_name :: Lens' AmiDistributionConfiguration (Maybe Text) Source #

The name of the output AMI.

amiDistributionConfiguration_targetAccountIds :: Lens' AmiDistributionConfiguration (Maybe (NonEmpty Text)) Source #

The ID of an account to which you want to distribute an image.

Component

component_arn :: Lens' Component (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component.

component_changeDescription :: Lens' Component (Maybe Text) Source #

The change description of the component.

component_data :: Lens' Component (Maybe Text) Source #

Component data contains the YAML document content for the component.

component_dateCreated :: Lens' Component (Maybe Text) Source #

The date that the component was created.

component_description :: Lens' Component (Maybe Text) Source #

The description of the component.

component_encrypted :: Lens' Component (Maybe Bool) Source #

The encryption status of the component.

component_kmsKeyId :: Lens' Component (Maybe Text) Source #

The KMS key identifier used to encrypt the component.

component_name :: Lens' Component (Maybe Text) Source #

The name of the component.

component_owner :: Lens' Component (Maybe Text) Source #

The owner of the component.

component_parameters :: Lens' Component (Maybe [ComponentParameterDetail]) Source #

Contains parameter details for each of the parameters that are defined for the component.

component_platform :: Lens' Component (Maybe Platform) Source #

The platform of the component.

component_state :: Lens' Component (Maybe ComponentState) Source #

Describes the current status of the component. This is used for components that are no longer active.

component_supportedOsVersions :: Lens' Component (Maybe (NonEmpty Text)) Source #

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

component_tags :: Lens' Component (Maybe (HashMap Text Text)) Source #

The tags associated with the component.

component_type :: Lens' Component (Maybe ComponentType) Source #

The type of the component denotes whether the component is used to build the image or only to test it.

component_version :: Lens' Component (Maybe Text) Source #

The version of the component.

ComponentConfiguration

componentConfiguration_parameters :: Lens' ComponentConfiguration (Maybe (NonEmpty ComponentParameter)) Source #

A group of parameter settings that are used to configure the component for a specific recipe.

componentConfiguration_componentArn :: Lens' ComponentConfiguration Text Source #

The Amazon Resource Name (ARN) of the component.

ComponentParameter

componentParameter_name :: Lens' ComponentParameter Text Source #

The name of the component parameter to set.

componentParameter_value :: Lens' ComponentParameter [Text] Source #

Sets the value for the named component parameter.

ComponentParameterDetail

componentParameterDetail_defaultValue :: Lens' ComponentParameterDetail (Maybe [Text]) Source #

The default value of this parameter if no input is provided.

componentParameterDetail_description :: Lens' ComponentParameterDetail (Maybe Text) Source #

Describes this parameter.

componentParameterDetail_name :: Lens' ComponentParameterDetail Text Source #

The name of this input parameter.

componentParameterDetail_type :: Lens' ComponentParameterDetail Text Source #

The type of input this parameter provides. The currently supported value is "string".

ComponentState

componentState_reason :: Lens' ComponentState (Maybe Text) Source #

Describes how or why the component changed state.

componentState_status :: Lens' ComponentState (Maybe ComponentStatus) Source #

The current state of the component.

ComponentSummary

componentSummary_arn :: Lens' ComponentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component.

componentSummary_changeDescription :: Lens' ComponentSummary (Maybe Text) Source #

The change description of the component.

componentSummary_dateCreated :: Lens' ComponentSummary (Maybe Text) Source #

The date that the component was created.

componentSummary_description :: Lens' ComponentSummary (Maybe Text) Source #

The description of the component.

componentSummary_name :: Lens' ComponentSummary (Maybe Text) Source #

The name of the component.

componentSummary_owner :: Lens' ComponentSummary (Maybe Text) Source #

The owner of the component.

componentSummary_platform :: Lens' ComponentSummary (Maybe Platform) Source #

The platform of the component.

componentSummary_state :: Lens' ComponentSummary (Maybe ComponentState) Source #

Describes the current status of the component.

componentSummary_supportedOsVersions :: Lens' ComponentSummary (Maybe (NonEmpty Text)) Source #

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

componentSummary_tags :: Lens' ComponentSummary (Maybe (HashMap Text Text)) Source #

The tags associated with the component.

componentSummary_type :: Lens' ComponentSummary (Maybe ComponentType) Source #

The type of the component denotes whether the component is used to build the image or only to test it.

componentSummary_version :: Lens' ComponentSummary (Maybe Text) Source #

The version of the component.

ComponentVersion

componentVersion_arn :: Lens' ComponentVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

  1. 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.
  2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
  3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

componentVersion_dateCreated :: Lens' ComponentVersion (Maybe Text) Source #

The date that the component was created.

componentVersion_description :: Lens' ComponentVersion (Maybe Text) Source #

The description of the component.

componentVersion_name :: Lens' ComponentVersion (Maybe Text) Source #

The name of the component.

componentVersion_owner :: Lens' ComponentVersion (Maybe Text) Source #

The owner of the component.

componentVersion_platform :: Lens' ComponentVersion (Maybe Platform) Source #

The platform of the component.

componentVersion_supportedOsVersions :: Lens' ComponentVersion (Maybe (NonEmpty Text)) Source #

he operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

componentVersion_type :: Lens' ComponentVersion (Maybe ComponentType) Source #

The type of the component denotes whether the component is used to build the image or only to test it.

componentVersion_version :: Lens' ComponentVersion (Maybe Text) Source #

The semantic version of the component.

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.

Container

container_imageUris :: Lens' Container (Maybe [Text]) Source #

A list of URIs for containers created in the context Region.

container_region :: Lens' Container (Maybe Text) Source #

Containers and container images are Region-specific. This is the Region context for the container.

ContainerDistributionConfiguration

containerDistributionConfiguration_containerTags :: Lens' ContainerDistributionConfiguration (Maybe [Text]) Source #

Tags that are attached to the container distribution configuration.

containerDistributionConfiguration_description :: Lens' ContainerDistributionConfiguration (Maybe Text) Source #

The description of the container distribution configuration.

containerDistributionConfiguration_targetRepository :: Lens' ContainerDistributionConfiguration TargetContainerRepository Source #

The destination repository for the container distribution configuration.

ContainerRecipe

containerRecipe_arn :: Lens' ContainerRecipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

  1. 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.
  2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
  3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

containerRecipe_components :: Lens' ContainerRecipe (Maybe (NonEmpty ComponentConfiguration)) Source #

Components for build and test that are included in the container recipe.

containerRecipe_containerType :: Lens' ContainerRecipe (Maybe ContainerType) Source #

Specifies the type of container, such as Docker.

containerRecipe_dateCreated :: Lens' ContainerRecipe (Maybe Text) Source #

The date when this container recipe was created.

containerRecipe_description :: Lens' ContainerRecipe (Maybe Text) Source #

The description of the container recipe.

containerRecipe_dockerfileTemplateData :: Lens' ContainerRecipe (Maybe Text) Source #

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

containerRecipe_encrypted :: Lens' ContainerRecipe (Maybe Bool) Source #

A flag that indicates if the target container is encrypted.

containerRecipe_instanceConfiguration :: Lens' ContainerRecipe (Maybe InstanceConfiguration) Source #

A group of options that can be used to configure an instance for building and testing container images.

containerRecipe_kmsKeyId :: Lens' ContainerRecipe (Maybe Text) Source #

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

containerRecipe_name :: Lens' ContainerRecipe (Maybe Text) Source #

The name of the container recipe.

containerRecipe_owner :: Lens' ContainerRecipe (Maybe Text) Source #

The owner of the container recipe.

containerRecipe_parentImage :: Lens' ContainerRecipe (Maybe Text) Source #

The base image for the container recipe.

containerRecipe_platform :: Lens' ContainerRecipe (Maybe Platform) Source #

The system platform for the container, such as Windows or Linux.

containerRecipe_tags :: Lens' ContainerRecipe (Maybe (HashMap Text Text)) Source #

Tags that are attached to the container recipe.

containerRecipe_targetRepository :: Lens' ContainerRecipe (Maybe TargetContainerRepository) Source #

The destination repository for the container image.

containerRecipe_version :: Lens' ContainerRecipe (Maybe Text) Source #

The semantic version of the container recipe.

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.

containerRecipe_workingDirectory :: Lens' ContainerRecipe (Maybe Text) Source #

The working directory for use during build and test workflows.

ContainerRecipeSummary

containerRecipeSummary_arn :: Lens' ContainerRecipeSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe.

containerRecipeSummary_containerType :: Lens' ContainerRecipeSummary (Maybe ContainerType) Source #

Specifies the type of container, such as "Docker".

containerRecipeSummary_dateCreated :: Lens' ContainerRecipeSummary (Maybe Text) Source #

The date when this container recipe was created.

containerRecipeSummary_name :: Lens' ContainerRecipeSummary (Maybe Text) Source #

The name of the container recipe.

containerRecipeSummary_owner :: Lens' ContainerRecipeSummary (Maybe Text) Source #

The owner of the container recipe.

containerRecipeSummary_parentImage :: Lens' ContainerRecipeSummary (Maybe Text) Source #

The base image for the container recipe.

containerRecipeSummary_platform :: Lens' ContainerRecipeSummary (Maybe Platform) Source #

The system platform for the container, such as Windows or Linux.

containerRecipeSummary_tags :: Lens' ContainerRecipeSummary (Maybe (HashMap Text Text)) Source #

Tags that are attached to the container recipe.

Distribution

distribution_amiDistributionConfiguration :: Lens' Distribution (Maybe AmiDistributionConfiguration) Source #

The specific AMI settings; for example, launch permissions or AMI tags.

distribution_containerDistributionConfiguration :: Lens' Distribution (Maybe ContainerDistributionConfiguration) Source #

Container distribution settings for encryption, licensing, and sharing in a specific Region.

distribution_fastLaunchConfigurations :: Lens' Distribution (Maybe (NonEmpty FastLaunchConfiguration)) Source #

The Windows faster-launching configurations to use for AMI distribution.

distribution_launchTemplateConfigurations :: Lens' Distribution (Maybe (NonEmpty LaunchTemplateConfiguration)) Source #

A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

distribution_licenseConfigurationArns :: Lens' Distribution (Maybe (NonEmpty Text)) Source #

The License Manager Configuration to associate with the AMI in the specified Region.

distribution_s3ExportConfiguration :: Lens' Distribution (Maybe S3ExportConfiguration) Source #

Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

distribution_region :: Lens' Distribution Text Source #

The target Region.

DistributionConfiguration

distributionConfiguration_arn :: Lens' DistributionConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration.

distributionConfiguration_dateCreated :: Lens' DistributionConfiguration (Maybe Text) Source #

The date on which this distribution configuration was created.

distributionConfiguration_dateUpdated :: Lens' DistributionConfiguration (Maybe Text) Source #

The date on which this distribution configuration was last updated.

distributionConfiguration_description :: Lens' DistributionConfiguration (Maybe Text) Source #

The description of the distribution configuration.

distributionConfiguration_distributions :: Lens' DistributionConfiguration (Maybe [Distribution]) Source #

The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.

distributionConfiguration_name :: Lens' DistributionConfiguration (Maybe Text) Source #

The name of the distribution configuration.

distributionConfiguration_tags :: Lens' DistributionConfiguration (Maybe (HashMap Text Text)) Source #

The tags of the distribution configuration.

distributionConfiguration_timeoutMinutes :: Lens' DistributionConfiguration Natural Source #

The maximum duration in minutes for this distribution configuration.

DistributionConfigurationSummary

distributionConfigurationSummary_arn :: Lens' DistributionConfigurationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration.

distributionConfigurationSummary_dateCreated :: Lens' DistributionConfigurationSummary (Maybe Text) Source #

The date on which the distribution configuration was created.

distributionConfigurationSummary_dateUpdated :: Lens' DistributionConfigurationSummary (Maybe Text) Source #

The date on which the distribution configuration was updated.

distributionConfigurationSummary_description :: Lens' DistributionConfigurationSummary (Maybe Text) Source #

The description of the distribution configuration.

distributionConfigurationSummary_name :: Lens' DistributionConfigurationSummary (Maybe Text) Source #

The name of the distribution configuration.

distributionConfigurationSummary_regions :: Lens' DistributionConfigurationSummary (Maybe [Text]) Source #

A list of Regions where the container image is distributed to.

distributionConfigurationSummary_tags :: Lens' DistributionConfigurationSummary (Maybe (HashMap Text Text)) Source #

The tags associated with the distribution configuration.

EbsInstanceBlockDeviceSpecification

ebsInstanceBlockDeviceSpecification_deleteOnTermination :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Bool) Source #

Use to configure delete on termination of the associated device.

ebsInstanceBlockDeviceSpecification_encrypted :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Bool) Source #

Use to configure device encryption.

ebsInstanceBlockDeviceSpecification_iops :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural) Source #

Use to configure device IOPS.

ebsInstanceBlockDeviceSpecification_kmsKeyId :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Text) Source #

Use to configure the KMS key to use when encrypting the device.

ebsInstanceBlockDeviceSpecification_snapshotId :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Text) Source #

The snapshot that defines the device contents.

ebsInstanceBlockDeviceSpecification_throughput :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural) Source #

For GP3 volumes only – The throughput in MiB/s that the volume supports.

ebsInstanceBlockDeviceSpecification_volumeSize :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural) Source #

Use to override the device's volume size.

ebsInstanceBlockDeviceSpecification_volumeType :: Lens' EbsInstanceBlockDeviceSpecification (Maybe EbsVolumeType) Source #

Use to override the device's volume type.

FastLaunchConfiguration

fastLaunchConfiguration_accountId :: Lens' FastLaunchConfiguration (Maybe Text) Source #

The owner account ID for the fast-launch enabled Windows AMI.

fastLaunchConfiguration_launchTemplate :: Lens' FastLaunchConfiguration (Maybe FastLaunchLaunchTemplateSpecification) Source #

The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

fastLaunchConfiguration_maxParallelLaunches :: Lens' FastLaunchConfiguration (Maybe Natural) Source #

The maximum number of parallel instances that are launched for creating resources.

fastLaunchConfiguration_snapshotConfiguration :: Lens' FastLaunchConfiguration (Maybe FastLaunchSnapshotConfiguration) Source #

Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

fastLaunchConfiguration_enabled :: Lens' FastLaunchConfiguration Bool Source #

A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

FastLaunchLaunchTemplateSpecification

fastLaunchLaunchTemplateSpecification_launchTemplateId :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text) Source #

The ID of the launch template to use for faster launching for a Windows AMI.

fastLaunchLaunchTemplateSpecification_launchTemplateName :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text) Source #

The name of the launch template to use for faster launching for a Windows AMI.

fastLaunchLaunchTemplateSpecification_launchTemplateVersion :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text) Source #

The version of the launch template to use for faster launching for a Windows AMI.

FastLaunchSnapshotConfiguration

fastLaunchSnapshotConfiguration_targetResourceCount :: Lens' FastLaunchSnapshotConfiguration (Maybe Natural) Source #

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

Filter

filter_name :: Lens' Filter (Maybe Text) Source #

The name of the filter. Filter names are case-sensitive.

filter_values :: Lens' Filter (Maybe (NonEmpty Text)) Source #

The filter values. Filter values are case-sensitive.

Image

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:

  1. 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.
  2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
  3. 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_dateCreated :: Lens' Image (Maybe Text) Source #

The date on which this image was created.

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_name :: Lens' Image (Maybe Text) Source #

The name of the 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_platform :: Lens' Image (Maybe Platform) Source #

The platform of the 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_tags :: Lens' Image (Maybe (HashMap Text Text)) Source #

The tags 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.

ImagePackage

imagePackage_packageName :: Lens' ImagePackage (Maybe Text) Source #

The name of the package as reported to the operating system package manager.

imagePackage_packageVersion :: Lens' ImagePackage (Maybe Text) Source #

The version of the package as reported to the operating system package manager.

ImagePipeline

imagePipeline_arn :: Lens' ImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image pipeline.

imagePipeline_containerRecipeArn :: Lens' ImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

imagePipeline_dateCreated :: Lens' ImagePipeline (Maybe Text) Source #

The date on which this image pipeline was created.

imagePipeline_dateLastRun :: Lens' ImagePipeline (Maybe Text) Source #

The date on which this image pipeline was last run.

imagePipeline_dateNextRun :: Lens' ImagePipeline (Maybe Text) Source #

The date on which this image pipeline will next be run.

imagePipeline_dateUpdated :: Lens' ImagePipeline (Maybe Text) Source #

The date on which this image pipeline was last updated.

imagePipeline_description :: Lens' ImagePipeline (Maybe Text) Source #

The description of the image pipeline.

imagePipeline_distributionConfigurationArn :: Lens' ImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

imagePipeline_enhancedImageMetadataEnabled :: Lens' ImagePipeline (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.

imagePipeline_imageRecipeArn :: Lens' ImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

imagePipeline_imageTestsConfiguration :: Lens' ImagePipeline (Maybe ImageTestsConfiguration) Source #

The image tests configuration of the image pipeline.

imagePipeline_infrastructureConfigurationArn :: Lens' ImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

imagePipeline_name :: Lens' ImagePipeline (Maybe Text) Source #

The name of the image pipeline.

imagePipeline_platform :: Lens' ImagePipeline (Maybe Platform) Source #

The platform of the image pipeline.

imagePipeline_schedule :: Lens' ImagePipeline (Maybe Schedule) Source #

The schedule of the image pipeline.

imagePipeline_status :: Lens' ImagePipeline (Maybe PipelineStatus) Source #

The status of the image pipeline.

imagePipeline_tags :: Lens' ImagePipeline (Maybe (HashMap Text Text)) Source #

The tags of this image pipeline.

ImageRecipe

imageRecipe_additionalInstanceConfiguration :: Lens' ImageRecipe (Maybe AdditionalInstanceConfiguration) Source #

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

imageRecipe_arn :: Lens' ImageRecipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe.

imageRecipe_blockDeviceMappings :: Lens' ImageRecipe (Maybe [InstanceBlockDeviceMapping]) Source #

The block device mappings to apply when creating images from this recipe.

imageRecipe_components :: Lens' ImageRecipe (Maybe (NonEmpty ComponentConfiguration)) Source #

The components of the image recipe.

imageRecipe_dateCreated :: Lens' ImageRecipe (Maybe Text) Source #

The date on which this image recipe was created.

imageRecipe_description :: Lens' ImageRecipe (Maybe Text) Source #

The description of the image recipe.

imageRecipe_name :: Lens' ImageRecipe (Maybe Text) Source #

The name of the image recipe.

imageRecipe_owner :: Lens' ImageRecipe (Maybe Text) Source #

The owner of the image recipe.

imageRecipe_parentImage :: Lens' ImageRecipe (Maybe Text) Source #

The base image of the image recipe.

imageRecipe_platform :: Lens' ImageRecipe (Maybe Platform) Source #

The platform of the image recipe.

imageRecipe_tags :: Lens' ImageRecipe (Maybe (HashMap Text Text)) Source #

The tags of the image recipe.

imageRecipe_type :: Lens' ImageRecipe (Maybe ImageType) Source #

Specifies which type of image is created by the recipe - an AMI or a container image.

imageRecipe_version :: Lens' ImageRecipe (Maybe Text) Source #

The version of the image recipe.

imageRecipe_workingDirectory :: Lens' ImageRecipe (Maybe Text) Source #

The working directory to be used during build and test workflows.

ImageRecipeSummary

imageRecipeSummary_arn :: Lens' ImageRecipeSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe.

imageRecipeSummary_dateCreated :: Lens' ImageRecipeSummary (Maybe Text) Source #

The date on which this image recipe was created.

imageRecipeSummary_name :: Lens' ImageRecipeSummary (Maybe Text) Source #

The name of the image recipe.

imageRecipeSummary_owner :: Lens' ImageRecipeSummary (Maybe Text) Source #

The owner of the image recipe.

imageRecipeSummary_parentImage :: Lens' ImageRecipeSummary (Maybe Text) Source #

The base image of the image recipe.

imageRecipeSummary_platform :: Lens' ImageRecipeSummary (Maybe Platform) Source #

The platform of the image recipe.

imageRecipeSummary_tags :: Lens' ImageRecipeSummary (Maybe (HashMap Text Text)) Source #

The tags of the image recipe.

ImageState

imageState_reason :: Lens' ImageState (Maybe Text) Source #

The reason for the image's status.

imageState_status :: Lens' ImageState (Maybe ImageStatus) Source #

The status of the image.

ImageSummary

imageSummary_arn :: Lens' ImageSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image.

imageSummary_buildType :: Lens' ImageSummary (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.

imageSummary_dateCreated :: Lens' ImageSummary (Maybe Text) Source #

The date on which this image was created.

imageSummary_name :: Lens' ImageSummary (Maybe Text) Source #

The name of the image.

imageSummary_osVersion :: Lens' ImageSummary (Maybe Text) Source #

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

imageSummary_outputResources :: Lens' ImageSummary (Maybe OutputResources) Source #

The output resources produced when creating this image.

imageSummary_owner :: Lens' ImageSummary (Maybe Text) Source #

The owner of the image.

imageSummary_platform :: Lens' ImageSummary (Maybe Platform) Source #

The platform of the image.

imageSummary_state :: Lens' ImageSummary (Maybe ImageState) Source #

The state of the image.

imageSummary_tags :: Lens' ImageSummary (Maybe (HashMap Text Text)) Source #

The tags of the image.

imageSummary_type :: Lens' ImageSummary (Maybe ImageType) Source #

Specifies whether this is an AMI or container image.

imageSummary_version :: Lens' ImageSummary (Maybe Text) Source #

The version of the image.

ImageTestsConfiguration

imageTestsConfiguration_imageTestsEnabled :: Lens' ImageTestsConfiguration (Maybe Bool) Source #

Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

imageTestsConfiguration_timeoutMinutes :: Lens' ImageTestsConfiguration (Maybe Natural) Source #

The maximum time in minutes that tests are permitted to run.

ImageVersion

imageVersion_arn :: Lens' ImageVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

  1. 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.
  2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
  3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

imageVersion_buildType :: Lens' ImageVersion (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.

imageVersion_dateCreated :: Lens' ImageVersion (Maybe Text) Source #

The date on which this specific version of the Image Builder image was created.

imageVersion_name :: Lens' ImageVersion (Maybe Text) Source #

The name of this specific version of an Image Builder image.

imageVersion_osVersion :: Lens' ImageVersion (Maybe Text) Source #

The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

imageVersion_owner :: Lens' ImageVersion (Maybe Text) Source #

The owner of the image version.

imageVersion_platform :: Lens' ImageVersion (Maybe Platform) Source #

The platform of the image version, for example "Windows" or "Linux".

imageVersion_type :: Lens' ImageVersion (Maybe ImageType) Source #

Specifies whether this image is an AMI or a container image.

imageVersion_version :: Lens' ImageVersion (Maybe Text) Source #

Details for a specific version of an Image Builder image. This version follows the semantic version syntax.

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.

InfrastructureConfiguration

infrastructureConfiguration_arn :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration.

infrastructureConfiguration_dateCreated :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The date on which the infrastructure configuration was created.

infrastructureConfiguration_dateUpdated :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The date on which the infrastructure configuration was last updated.

infrastructureConfiguration_description :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The description of the infrastructure configuration.

infrastructureConfiguration_instanceMetadataOptions :: Lens' InfrastructureConfiguration (Maybe InstanceMetadataOptions) Source #

The instance metadata option settings for the infrastructure configuration.

infrastructureConfiguration_instanceProfileName :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The instance profile of the infrastructure configuration.

infrastructureConfiguration_instanceTypes :: Lens' InfrastructureConfiguration (Maybe [Text]) Source #

The instance types of the infrastructure configuration.

infrastructureConfiguration_keyPair :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The Amazon EC2 key pair of the infrastructure configuration.

infrastructureConfiguration_logging :: Lens' InfrastructureConfiguration (Maybe Logging) Source #

The logging configuration of the infrastructure configuration.

infrastructureConfiguration_name :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The name of the infrastructure configuration.

infrastructureConfiguration_resourceTags :: Lens' InfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags attached to the resource created by Image Builder.

infrastructureConfiguration_securityGroupIds :: Lens' InfrastructureConfiguration (Maybe [Text]) Source #

The security group IDs of the infrastructure configuration.

infrastructureConfiguration_snsTopicArn :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

infrastructureConfiguration_subnetId :: Lens' InfrastructureConfiguration (Maybe Text) Source #

The subnet ID of the infrastructure configuration.

infrastructureConfiguration_tags :: Lens' InfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags of the infrastructure configuration.

infrastructureConfiguration_terminateInstanceOnFailure :: Lens' InfrastructureConfiguration (Maybe Bool) Source #

The terminate instance on failure configuration of the infrastructure configuration.

InfrastructureConfigurationSummary

infrastructureConfigurationSummary_arn :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration.

infrastructureConfigurationSummary_dateCreated :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #

The date on which the infrastructure configuration was created.

infrastructureConfigurationSummary_dateUpdated :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #

The date on which the infrastructure configuration was last updated.

infrastructureConfigurationSummary_description :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #

The description of the infrastructure configuration.

infrastructureConfigurationSummary_instanceProfileName :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #

The instance profile of the infrastructure configuration.

infrastructureConfigurationSummary_instanceTypes :: Lens' InfrastructureConfigurationSummary (Maybe [Text]) Source #

The instance types of the infrastructure configuration.

infrastructureConfigurationSummary_name :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #

The name of the infrastructure configuration.

infrastructureConfigurationSummary_resourceTags :: Lens' InfrastructureConfigurationSummary (Maybe (HashMap Text Text)) Source #

The tags attached to the image created by Image Builder.

infrastructureConfigurationSummary_tags :: Lens' InfrastructureConfigurationSummary (Maybe (HashMap Text Text)) Source #

The tags of the infrastructure configuration.

InstanceBlockDeviceMapping

instanceBlockDeviceMapping_deviceName :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #

The device to which these mappings apply.

instanceBlockDeviceMapping_ebs :: Lens' InstanceBlockDeviceMapping (Maybe EbsInstanceBlockDeviceSpecification) Source #

Use to manage Amazon EBS-specific configuration for this mapping.

instanceBlockDeviceMapping_noDevice :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #

Use to remove a mapping from the base image.

instanceBlockDeviceMapping_virtualName :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #

Use to manage instance ephemeral devices.

InstanceConfiguration

instanceConfiguration_blockDeviceMappings :: Lens' InstanceConfiguration (Maybe [InstanceBlockDeviceMapping]) Source #

Defines the block devices to attach for building an instance from this Image Builder AMI.

instanceConfiguration_image :: Lens' InstanceConfiguration (Maybe Text) Source #

The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

InstanceMetadataOptions

instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural) Source #

Limit the number of hops that an instance metadata request can traverse to reach its destination.

instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe Text) Source #

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

  • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
  • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

LaunchPermissionConfiguration

launchPermissionConfiguration_organizationArns :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text)) Source #

The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

launchPermissionConfiguration_organizationalUnitArns :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text)) Source #

The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

launchPermissionConfiguration_userGroups :: Lens' LaunchPermissionConfiguration (Maybe [Text]) Source #

The name of the group.

launchPermissionConfiguration_userIds :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text)) Source #

The Amazon Web Services account ID.

LaunchTemplateConfiguration

launchTemplateConfiguration_accountId :: Lens' LaunchTemplateConfiguration (Maybe Text) Source #

The account ID that this configuration applies to.

launchTemplateConfiguration_setDefaultVersion :: Lens' LaunchTemplateConfiguration (Maybe Bool) Source #

Set the specified Amazon EC2 launch template as the default launch template for the specified account.

launchTemplateConfiguration_launchTemplateId :: Lens' LaunchTemplateConfiguration Text Source #

Identifies the Amazon EC2 launch template to use.

Logging

logging_s3Logs :: Lens' Logging (Maybe S3Logs) Source #

The Amazon S3 logging configuration.

OutputResources

outputResources_amis :: Lens' OutputResources (Maybe [Ami]) Source #

The Amazon EC2 AMIs created by this image.

outputResources_containers :: Lens' OutputResources (Maybe [Container]) Source #

Container images that the pipeline has generated and stored in the output repository.

S3ExportConfiguration

s3ExportConfiguration_s3Prefix :: Lens' S3ExportConfiguration (Maybe Text) Source #

The Amazon S3 path for the bucket where the output disk images for your VM are stored.

s3ExportConfiguration_roleName :: Lens' S3ExportConfiguration Text Source #

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

s3ExportConfiguration_diskImageFormat :: Lens' S3ExportConfiguration DiskImageFormat Source #

Export the updated image to one of the following supported disk image formats:

  • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.
  • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.
  • Raw – Raw format.

s3ExportConfiguration_s3Bucket :: Lens' S3ExportConfiguration Text Source #

The S3 bucket in which to store the output disk images for your VM.

S3Logs

s3Logs_s3BucketName :: Lens' S3Logs (Maybe Text) Source #

The S3 bucket in which to store the logs.

s3Logs_s3KeyPrefix :: Lens' S3Logs (Maybe Text) Source #

The Amazon S3 path to the bucket where the logs are stored.

Schedule

schedule_pipelineExecutionStartCondition :: Lens' Schedule (Maybe PipelineExecutionStartCondition) Source #

The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

schedule_scheduleExpression :: Lens' Schedule (Maybe Text) Source #

The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

schedule_timezone :: Lens' Schedule (Maybe Text) Source #

The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

SystemsManagerAgent

systemsManagerAgent_uninstallAfterBuild :: Lens' SystemsManagerAgent (Maybe Bool) Source #

Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

TargetContainerRepository

targetContainerRepository_service :: Lens' TargetContainerRepository ContainerRepositoryService Source #

Specifies the service in which this image was registered.

targetContainerRepository_repositoryName :: Lens' TargetContainerRepository Text Source #

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.