String accountId
Identifies the account that owns the aggregated resource findings.
SeverityCounts severityCounts
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.
SystemsManagerAgent systemsManagerAgent
Contains settings for the Systems Manager agent on your build instance.
String userDataOverride
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
String region
The Amazon Web Services Region of the Amazon EC2 AMI.
String image
The AMI ID of the Amazon EC2 AMI.
String name
The name of the Amazon EC2 AMI.
String description
The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
ImageState state
String accountId
The account ID of the owner of the AMI.
String name
The name of the output AMI.
String description
The description of the AMI distribution configuration. Minimum and maximum length are in characters.
List<E> targetAccountIds
The ID of an account to which you want to distribute an image.
Map<K,V> amiTags
The tags to apply to AMIs distributed to this Region.
String kmsKeyId
The KMS key identifier used to encrypt the distributed image.
LaunchPermissionConfiguration launchPermission
Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image that you want to cancel creation for.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String lifecycleExecutionId
Identifies the specific runtime instance of the image lifecycle to cancel.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String lifecycleExecutionId
The unique identifier for the image lifecycle runtime instance that was canceled.
String arn
The Amazon Resource Name (ARN) of the component.
String name
The name of the component.
String version
The version of the component.
String description
The description of the component.
String changeDescription
Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.
String type
The component type specifies whether Image Builder uses the component to build the image or only to test it.
String platform
The operating system platform of the component.
List<E> supportedOsVersions
The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
ComponentState state
Describes the current status of the component. This is used for components that are no longer active.
List<E> parameters
Contains parameter details for each of the parameters that the component document defined for the component.
String owner
The owner of the component.
String data
Component data contains the YAML document content for the component.
String kmsKeyId
The KMS key identifier used to encrypt the component.
Boolean encrypted
The encryption status of the component.
String dateCreated
The date that Image Builder created the component.
Map<K,V> tags
The tags that apply to the component.
String publisher
Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
Boolean obfuscate
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
String name
The name of this input parameter.
String type
The type of input this parameter provides. The currently supported value is "string".
List<E> defaultValue
The default value of this parameter if no input is provided.
String description
Describes this parameter.
String arn
The Amazon Resource Name (ARN) of the component.
String name
The name of the component.
String version
The version of the component.
String platform
The operating system platform of the component.
List<E> supportedOsVersions
The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
ComponentState state
Describes the current status of the component.
String type
The component type specifies whether Image Builder uses the component to build the image or only to test it.
String owner
The owner of the component.
String description
The description of the component.
String changeDescription
The change description for the current version of the component.
String dateCreated
The original creation date of the component.
Map<K,V> tags
The tags that apply to the component.
String publisher
Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
Boolean obfuscate
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
String arn
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:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String name
The name of the component.
String version
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.
String description
The description of the component.
String platform
The platform of the component.
List<E> supportedOsVersions
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.
String type
The type of the component denotes whether the component is used to build the image or only to test it.
String owner
The owner of the component.
String dateCreated
The date that the component was created.
String description
The description of the container distribution configuration.
List<E> containerTags
Tags that are attached to the container distribution configuration.
TargetContainerRepository targetRepository
The destination repository for the container distribution configuration.
String arn
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:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String containerType
Specifies the type of container, such as Docker.
String name
The name of the container recipe.
String description
The description of the container recipe.
String platform
The system platform for the container, such as Windows or Linux.
String owner
The owner of the container recipe.
String version
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.
List<E> components
Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
InstanceConfiguration instanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
String dockerfileTemplateData
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.
String kmsKeyId
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
Boolean encrypted
A flag that indicates if the target container is encrypted.
String parentImage
The base image for the container recipe.
String dateCreated
The date when this container recipe was created.
Map<K,V> tags
Tags that are attached to the container recipe.
String workingDirectory
The working directory for use during build and test workflows.
TargetContainerRepository targetRepository
The destination repository for the container image.
String arn
The Amazon Resource Name (ARN) of the container recipe.
String containerType
Specifies the type of container, such as "Docker".
String name
The name of the container recipe.
String platform
The system platform for the container, such as Windows or Linux.
String owner
The owner of the container recipe.
String parentImage
The base image for the container recipe.
String dateCreated
The date when this container recipe was created.
Map<K,V> tags
Tags that are attached to the container recipe.
String name
The name of the component.
String semanticVersion
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.
String description
Describes the contents of the component.
String changeDescription
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 the component.
String platform
The operating system platform of the component.
List<E> supportedOsVersions
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.
String data
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.
String uri
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.
String kmsKeyId
The ID of the KMS key that is used to encrypt this component.
Map<K,V> tags
The tags that apply to the component.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String containerType
The type of container to create.
String name
The name of the container recipe.
String description
The description of the container recipe.
String semanticVersion
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.
List<E> components
Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
InstanceConfiguration instanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
String dockerfileTemplateData
The Dockerfile template used to build your image as an inline data blob.
String dockerfileTemplateUri
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
String platformOverride
Specifies the operating system platform when you use a custom base image.
String imageOsVersionOverride
Specifies the operating system version for the base image.
String parentImage
The base image for the container recipe.
Map<K,V> tags
Tags that are attached to the container recipe.
String workingDirectory
The working directory for use during build and test workflows.
TargetContainerRepository targetRepository
The destination repository for the container image.
String kmsKeyId
Identifies which KMS key is used to encrypt the container image.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The client token that uniquely identifies the request.
String containerRecipeArn
Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
List<E> distributions
The distributions of the distribution configuration.
Map<K,V> tags
The tags of the distribution configuration.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The client token that uniquely identifies the request.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
String name
The name of the image pipeline.
String description
The description of the image pipeline.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
ImageTestsConfiguration imageTestsConfiguration
The image test configuration of the image pipeline.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Schedule schedule
The schedule of the image pipeline.
String status
The status of the image pipeline.
Map<K,V> tags
The tags of the image pipeline.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
ImageScanningConfiguration imageScanningConfiguration
Contains settings for vulnerability scans.
List<E> workflows
Contains an array of workflow configuration objects.
String executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
String name
The name of the image recipe.
String description
The description of the image recipe.
String semanticVersion
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.
List<E> components
The components included in the image recipe.
String parentImage
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.
List<E> blockDeviceMappings
The block device mappings of the image recipe.
Map<K,V> tags
The tags of the image recipe.
String workingDirectory
The working directory used during build and test workflows.
AdditionalInstanceConfiguration additionalInstanceConfiguration
Specify additional settings and launch scripts for your build instances.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
ImageTestsConfiguration imageTestsConfiguration
The image tests configuration of the image.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Map<K,V> tags
The tags of the image.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
ImageScanningConfiguration imageScanningConfiguration
Contains settings for vulnerability scans.
List<E> workflows
Contains an array of workflow configuration objects.
String executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
String name
The name of the infrastructure configuration.
String description
The description of the infrastructure configuration.
List<E> instanceTypes
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.
String instanceProfileName
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
List<E> securityGroupIds
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
String subnetId
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
Logging logging
The logging configuration of the infrastructure configuration.
String keyPair
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
Boolean terminateInstanceOnFailure
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.
String snsTopicArn
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.
Map<K,V> resourceTags
The tags attached to the resource created by Image Builder.
InstanceMetadataOptions instanceMetadataOptions
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
Map<K,V> tags
The tags of the infrastructure configuration.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The client token that uniquely identifies the request.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
String name
The name of the lifecycle policy to create.
String description
Optional description for the lifecycle policy.
String status
Indicates whether the lifecycle policy resource is enabled.
String executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.
String resourceType
The type of Image Builder resource that the lifecycle policy applies to.
List<E> policyDetails
Configuration details for the lifecycle policy rules.
LifecyclePolicyResourceSelection resourceSelection
Selection criteria for the resources that the lifecycle policy applies to.
Map<K,V> tags
Tags to apply to the lifecycle policy resource.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String name
The name of the workflow to create.
String semanticVersion
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
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.
String description
Describes the workflow.
String changeDescription
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
String data
Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
String uri
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.
String kmsKeyId
The ID of the KMS key that is used to encrypt this workflow resource.
Map<K,V> tags
Tags that apply to the workflow resource.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String type
The phase in the image build process for which the workflow resource is responsible.
String scoreSource
The source for the CVSS score.
String cvssSource
The source of the finding.
String version
The CVSS version that generated the score.
Double score
The CVSS score.
String scoringVector
A vector that measures the severity of the vulnerability.
List<E> adjustments
An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.
String componentBuildVersionArn
The Amazon Resource Name (ARN) of the component build version to delete.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe to delete.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration to delete.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline to delete.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe to delete.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the Image Builder image resource to delete.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
String lifecyclePolicyArn
The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.
String lifecyclePolicyArn
The ARN of the lifecycle policy that was deleted.
String workflowBuildVersionArn
The Amazon Resource Name (ARN) of the workflow resource to delete.
String workflowBuildVersionArn
The ARN of the workflow resource that this request deleted.
String region
The target Region.
AmiDistributionConfiguration amiDistributionConfiguration
The specific AMI settings; for example, launch permissions or AMI tags.
ContainerDistributionConfiguration containerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region.
List<E> licenseConfigurationArns
The License Manager Configuration to associate with the AMI in the specified Region.
List<E> launchTemplateConfigurations
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
S3ExportConfiguration s3ExportConfiguration
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.
List<E> fastLaunchConfigurations
The Windows faster-launching configurations to use for AMI distribution.
String arn
The Amazon Resource Name (ARN) of the distribution configuration.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
List<E> distributions
The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
Integer timeoutMinutes
The maximum duration in minutes for this distribution configuration.
String dateCreated
The date on which this distribution configuration was created.
String dateUpdated
The date on which this distribution configuration was last updated.
Map<K,V> tags
The tags of the distribution configuration.
String arn
The Amazon Resource Name (ARN) of the distribution configuration.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
String dateCreated
The date on which the distribution configuration was created.
String dateUpdated
The date on which the distribution configuration was updated.
Map<K,V> tags
The tags associated with the distribution configuration.
List<E> regions
A list of Regions where the container image is distributed to.
Boolean encrypted
Use to configure device encryption.
Boolean deleteOnTermination
Use to configure delete on termination of the associated device.
Integer iops
Use to configure device IOPS.
String kmsKeyId
Use to configure the KMS key to use when encrypting the device.
String snapshotId
The snapshot that defines the device contents.
Integer volumeSize
Use to override the device's volume size.
String volumeType
Use to override the device's volume type.
Integer throughput
For GP3 volumes only – The throughput in MiB/s that the volume supports.
String repositoryName
The name of the container repository that Amazon Inspector scans to identify findings for your container images.
The name includes the path for the repository location. If you don’t provide this information, Image Builder
creates a repository in your account named image-builder-image-scanning-repository for vulnerability
scans of your output container images.
List<E> containerTags
Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.
Boolean enabled
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.
FastLaunchSnapshotConfiguration snapshotConfiguration
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
Integer maxParallelLaunches
The maximum number of parallel instances that are launched for creating resources.
FastLaunchLaunchTemplateSpecification launchTemplate
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
String accountId
The owner account ID for the fast-launch enabled Windows AMI.
String launchTemplateId
The ID of the launch template to use for faster launching for a Windows AMI.
String launchTemplateName
The name of the launch template to use for faster launching for a Windows AMI.
String launchTemplateVersion
The version of the launch template to use for faster launching for a Windows AMI.
Integer targetResourceCount
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
String componentArn
The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
String componentBuildVersionArn
The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix
/\d+$.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe to retrieve.
String requestId
The request ID that uniquely identifies this request.
ContainerRecipe containerRecipe
The container recipe object that is returned.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
DistributionConfiguration distributionConfiguration
The distribution configuration object.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
ImagePipeline imagePipeline
The image pipeline object.
String imageArn
The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
ImageRecipe imageRecipe
The image recipe object.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image that you want to get.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
InfrastructureConfiguration infrastructureConfiguration
The infrastructure configuration object.
String lifecycleExecutionId
Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.
LifecycleExecution lifecycleExecution
Runtime details for the specified runtime instance of the lifecycle policy.
String lifecyclePolicyArn
Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.
LifecyclePolicy lifecyclePolicy
The ARN of the image lifecycle policy resource that was returned.
String workflowExecutionId
Use the unique identifier for a runtime instance of the workflow to get runtime details.
String requestId
The request ID that uniquely identifies this request.
String workflowBuildVersionArn
The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.
String workflowExecutionId
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.
String type
The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
String status
The current runtime status for the specified runtime instance of the workflow.
String message
The output message from the specified runtime instance of the workflow, if applicable.
Integer totalStepCount
The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
Integer totalStepsSucceeded
A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
Integer totalStepsFailed
A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
Integer totalStepsSkipped
A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
String startTime
The timestamp when the specified runtime instance of the workflow started.
String endTime
The timestamp when the specified runtime instance of the workflow finished.
String parallelGroup
Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows.
String workflowBuildVersionArn
The Amazon Resource Name (ARN) of the workflow resource that you want to get.
Workflow workflow
The workflow resource specified in the request.
String stepExecutionId
Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.
String requestId
The request ID that uniquely identifies this request.
String stepExecutionId
The unique identifier for the runtime version of the workflow step that you specified in the request.
String workflowBuildVersionArn
The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
String workflowExecutionId
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.
String name
The name of the specified runtime instance of the workflow step.
String description
Describes the specified workflow step.
String action
The name of the action that the specified step performs.
String status
The current status for the specified runtime version of the workflow step.
String rollbackStatus
Reports on the rollback status of the specified runtime version of the workflow step, if applicable.
String message
The output message from the specified runtime instance of the workflow step, if applicable.
String inputs
Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
String outputs
The file names that the specified runtime version of the workflow step created as output.
String startTime
The timestamp when the specified runtime version of the workflow step started.
String endTime
The timestamp when the specified runtime instance of the workflow step finished.
String onFailure
The action to perform if the workflow step fails.
Integer timeoutSeconds
The maximum duration in seconds for this step to complete its action.
String arn
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String type
Specifies whether this image produces an AMI or a container image.
String name
The name of the image.
String version
The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
String platform
The image operating system platform, such as Linux or Windows.
Boolean enhancedImageMetadataEnabled
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
String osVersion
The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
ImageState state
The state of the image.
ImageRecipe imageRecipe
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
ContainerRecipe containerRecipe
For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
String sourcePipelineName
The name of the image pipeline that created this image.
String sourcePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that created this image.
InfrastructureConfiguration infrastructureConfiguration
The infrastructure that Image Builder used to create this image.
DistributionConfiguration distributionConfiguration
The distribution configuration that Image Builder used to create this image.
ImageTestsConfiguration imageTestsConfiguration
The image tests that ran when that Image Builder created this image.
String dateCreated
The date on which Image Builder created this image.
OutputResources outputResources
The output resources that Image Builder produces for this image.
Map<K,V> tags
The tags that apply to this image.
String buildType
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
String imageSource
The origin of the base image that Image Builder used to build this image.
ImageScanState scanState
Contains information about the current state of scans for this image.
ImageScanningConfiguration imageScanningConfiguration
Contains settings for vulnerability scans.
Date deprecationTime
The time when deprecation occurs for an image resource. This can be a past or future date.
String lifecycleExecutionId
Identifies the last runtime instance of the lifecycle policy to take action on the image.
String executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
List<E> workflows
Contains the build and test workflows that are associated with the image.
String imageBuildVersionArn
The Amazon Resource Name (ARN) that identifies the image for this aggregation.
SeverityCounts severityCounts
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.
String arn
The Amazon Resource Name (ARN) of the image pipeline.
String name
The name of the image pipeline.
String description
The description of the image pipeline.
String platform
The platform of the image pipeline.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
ImageTestsConfiguration imageTestsConfiguration
The image tests configuration of the image pipeline.
Schedule schedule
The schedule of the image pipeline.
String status
The status of the image pipeline.
String dateCreated
The date on which this image pipeline was created.
String dateUpdated
The date on which this image pipeline was last updated.
String dateLastRun
This is no longer supported, and does not return a value.
String dateNextRun
The next date when the pipeline is scheduled to run.
Map<K,V> tags
The tags of this image pipeline.
ImageScanningConfiguration imageScanningConfiguration
Contains settings for vulnerability scans.
String executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
List<E> workflows
Contains the workflows that run for the image pipeline.
String imagePipelineArn
The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.
SeverityCounts severityCounts
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.
String arn
The Amazon Resource Name (ARN) of the image recipe.
String type
Specifies which type of image is created by the recipe - an AMI or a container image.
String name
The name of the image recipe.
String description
The description of the image recipe.
String platform
The platform of the image recipe.
String owner
The owner of the image recipe.
String version
The version of the image recipe.
List<E> components
The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
String parentImage
The base image of the image recipe.
List<E> blockDeviceMappings
The block device mappings to apply when creating images from this recipe.
String dateCreated
The date on which this image recipe was created.
Map<K,V> tags
The tags of the image recipe.
String workingDirectory
The working directory to be used during build and test workflows.
AdditionalInstanceConfiguration additionalInstanceConfiguration
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.
String arn
The Amazon Resource Name (ARN) of the image recipe.
String name
The name of the image recipe.
String platform
The platform of the image recipe.
String owner
The owner of the image recipe.
String parentImage
The base image of the image recipe.
String dateCreated
The date on which this image recipe was created.
Map<K,V> tags
The tags of the image recipe.
String awsAccountId
The Amazon Web Services account ID that's associated with the finding.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image build version that's associated with the finding.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding.
String type
The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that
apply to output images, and excludes other types.
String description
The description of the finding.
String title
The title of the finding.
Remediation remediation
An object that contains the details about how to remediate the finding.
String severity
The severity of the finding.
Date firstObservedAt
The date and time when the finding was first observed.
Date updatedAt
The timestamp when the finding was last updated.
Double inspectorScore
The score that Amazon Inspector assigned for the finding.
InspectorScoreDetails inspectorScoreDetails
An object that contains details of the Amazon Inspector score.
PackageVulnerabilityDetails packageVulnerabilityDetails
An object that contains the details of a package vulnerability finding.
String fixAvailable
Details about whether a fix is available for any of the packages that are identified in the finding through a version update.
AccountAggregation accountAggregation
Returns an object that contains severity counts based on an account ID.
ImageAggregation imageAggregation
Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.
ImagePipelineAggregation imagePipelineAggregation
Returns an object that contains severity counts based on an image pipeline ARN.
VulnerabilityIdAggregation vulnerabilityIdAggregation
Returns an object that contains severity counts based on vulnerability ID.
Boolean imageScanningEnabled
A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
EcrConfiguration ecrConfiguration
Contains Amazon ECR settings for vulnerability scans.
String arn
The Amazon Resource Name (ARN) of the image.
String name
The name of the image.
String type
Specifies whether this image produces an AMI or a container image.
String version
The version of the image.
String platform
The image operating system platform, such as Linux or Windows.
String osVersion
The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
ImageState state
The state of the image.
String owner
The owner of the image.
String dateCreated
The date on which Image Builder created this image.
OutputResources outputResources
The output resources that Image Builder produced when it created this image.
Map<K,V> tags
The tags that apply to this image.
String buildType
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
String imageSource
The origin of the base image that Image Builder used to build this image.
Date deprecationTime
The time when deprecation occurs for an image resource. This can be a past or future date.
String lifecycleExecutionId
Identifies the last runtime instance of the lifecycle policy to take action on the image.
Boolean imageTestsEnabled
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
Integer timeoutMinutes
The maximum time in minutes that tests are permitted to run.
The timeoutMinutes attribute is not currently active. This value is ignored.
String arn
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:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String name
The name of this specific version of an Image Builder image.
String type
Specifies whether this image produces an AMI or a container image.
String version
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.
String platform
The operating system platform of the image version, for example "Windows" or "Linux".
String osVersion
The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
String owner
The owner of the image version.
String dateCreated
The date on which this specific version of the Image Builder image was created.
String buildType
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
String imageSource
The origin of the base image that Image Builder used to build this image.
String name
The name of the component.
String semanticVersion
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.
String description
The description of the component. Describes the contents of the component.
String changeDescription
The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.
String type
The type of the component denotes whether the component is used to build the image, or only to test it.
String format
The format of the resource that you want to import as a component.
String platform
The platform of the component.
String data
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.
String uri
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.
String kmsKeyId
The ID of the KMS key that should be used to encrypt this component.
Map<K,V> tags
The tags of the component.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String name
The name of the base image that is created by the import process.
String semanticVersion
The semantic version to attach to the base image that was created during the . 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.
String description
The description for the base image that is created by the import process.
String platform
The operating system platform for the imported VM.
String osVersion
The operating system version for the imported VM.
String vmImportTaskId
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.
Map<K,V> tags
Tags that are attached to the import resources.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String requestId
The request ID that uniquely identifies this request.
String imageArn
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.
String clientToken
The client token that uniquely identifies the request.
String arn
The Amazon Resource Name (ARN) of the infrastructure configuration.
String name
The name of the infrastructure configuration.
String description
The description of the infrastructure configuration.
List<E> instanceTypes
The instance types of the infrastructure configuration.
String instanceProfileName
The instance profile of the infrastructure configuration.
List<E> securityGroupIds
The security group IDs of the infrastructure configuration.
String subnetId
The subnet ID of the infrastructure configuration.
Logging logging
The logging configuration of the infrastructure configuration.
String keyPair
The Amazon EC2 key pair of the infrastructure configuration.
Boolean terminateInstanceOnFailure
The terminate instance on failure configuration of the infrastructure configuration.
String snsTopicArn
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.
String dateCreated
The date on which the infrastructure configuration was created.
String dateUpdated
The date on which the infrastructure configuration was last updated.
Map<K,V> resourceTags
The tags attached to the resource created by Image Builder.
InstanceMetadataOptions instanceMetadataOptions
The instance metadata option settings for the infrastructure configuration.
Map<K,V> tags
The tags of the infrastructure configuration.
String arn
The Amazon Resource Name (ARN) of the infrastructure configuration.
String name
The name of the infrastructure configuration.
String description
The description of the infrastructure configuration.
String dateCreated
The date on which the infrastructure configuration was created.
String dateUpdated
The date on which the infrastructure configuration was last updated.
Map<K,V> resourceTags
The tags attached to the image created by Image Builder.
Map<K,V> tags
The tags of the infrastructure configuration.
List<E> instanceTypes
The instance types of the infrastructure configuration.
String instanceProfileName
The instance profile of the infrastructure configuration.
CvssScoreDetails adjustedCvss
An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.
String deviceName
The device to which these mappings apply.
EbsInstanceBlockDeviceSpecification ebs
Use to manage Amazon EBS-specific configuration for this mapping.
String virtualName
Use to manage instance ephemeral devices.
String noDevice
Use to remove a mapping from the base image.
String image
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.
List<E> blockDeviceMappings
Defines the block devices to attach for building an instance from this Image Builder AMI.
String httpTokens
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.
Integer httpPutResponseHopLimit
Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.
List<E> userIds
The Amazon Web Services account ID.
List<E> userGroups
The name of the group.
List<E> organizationArns
The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.
List<E> organizationalUnitArns
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.
String launchTemplateId
Identifies the Amazon EC2 launch template to use.
String accountId
The account ID that this configuration applies to.
Boolean setDefaultVersion
Set the specified Amazon EC2 launch template as the default launch template for the specified account.
String lifecycleExecutionId
Identifies the lifecycle policy runtime instance.
String lifecyclePolicyArn
The Amazon Resource Name (ARN) of the lifecycle policy that ran.
LifecycleExecutionResourcesImpactedSummary resourcesImpactedSummary
Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy.
LifecycleExecutionState state
Runtime state that reports if the policy action ran successfully, failed, or was skipped.
Date startTime
The timestamp when the lifecycle runtime instance started.
Date endTime
The timestamp when the lifecycle runtime instance completed.
String accountId
The account that owns the impacted resource.
String resourceId
Identifies the impacted resource. The resource ID depends on the type of resource, as follows.
Image Builder image resources: Amazon Resource Name (ARN)
Distributed AMIs: AMI ID
Container images distributed to an ECR repository: image URI or SHA Digest
LifecycleExecutionResourceState state
The runtime state for the lifecycle execution.
LifecycleExecutionResourceAction action
The action to take for the identified resource.
String region
The Amazon Web Services Region where the lifecycle execution resource is stored.
List<E> snapshots
A list of associated resource snapshots for the impacted resource if it’s an AMI.
List<E> imageUris
For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories.
Boolean hasImpactedResources
Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted.
String snapshotId
Identifies the impacted snapshot resource.
LifecycleExecutionResourceState state
The runtime status of the lifecycle action taken for the snapshot.
String arn
The Amazon Resource Name (ARN) of the lifecycle policy resource.
String name
The name of the lifecycle policy.
String description
Optional description for the lifecycle policy.
String status
Indicates whether the lifecycle policy resource is enabled.
String executionRole
The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.
String resourceType
The type of resources the lifecycle policy targets.
List<E> policyDetails
The configuration details for a lifecycle policy resource.
LifecyclePolicyResourceSelection resourceSelection
Resource selection criteria used to run the lifecycle policy.
Date dateCreated
The timestamp when Image Builder created the lifecycle policy resource.
Date dateUpdated
The timestamp when Image Builder updated the lifecycle policy resource.
Date dateLastRun
The timestamp for the last time Image Builder ran the lifecycle policy.
Map<K,V> tags
To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.
LifecyclePolicyDetailAction action
Configuration details for the policy action.
LifecyclePolicyDetailFilter filter
Specifies the resources that the lifecycle policy applies to.
LifecyclePolicyDetailExclusionRules exclusionRules
Additional rules to specify resources that should be exempt from policy actions.
String type
Specifies the lifecycle action to take.
LifecyclePolicyDetailActionIncludeResources includeResources
Specifies the resources that the lifecycle policy applies to.
Boolean amis
Specifies whether the lifecycle action should apply to distributed AMIs.
Boolean snapshots
Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
Boolean containers
Specifies whether the lifecycle action should apply to distributed containers.
Map<K,V> tagMap
Contains a list of tags that Image Builder uses to skip lifecycle actions for resources that have them.
LifecyclePolicyDetailExclusionRulesAmis amis
Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
Boolean isPublic
Configures whether public AMIs are excluded from the lifecycle action.
List<E> regions
Configures Amazon Web Services Regions that are excluded from the lifecycle action.
List<E> sharedAccounts
Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.
LifecyclePolicyDetailExclusionRulesAmisLastLaunched lastLaunched
Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.
Map<K,V> tagMap
Lists tags that should be excluded from lifecycle actions for the AMIs that have them.
String type
Filter resources based on either age or count.
Integer value
The number of units for the time period or for the count. For example, a value of 6 might refer to
six months or six AMIs.
For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.
String unit
Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.
Integer retainAtLeast
For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE
action is applied. Impacted resources are only deleted if you have more than this number of resources. If you
have fewer resources than this number, the impacted resource is not deleted.
String arn
The Amazon Resource Name (ARN) of the lifecycle policy summary resource.
String name
The name of the lifecycle policy.
String description
Optional description for the lifecycle policy.
String status
The lifecycle policy resource status.
String executionRole
The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.
String resourceType
The type of resources the lifecycle policy targets.
Date dateCreated
The timestamp when Image Builder created the lifecycle policy resource.
Date dateUpdated
The timestamp when Image Builder updated the lifecycle policy resource.
Date dateLastRun
The timestamp for the last time Image Builder ran the lifecycle policy.
Map<K,V> tags
To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.
String componentVersionArn
The component version Amazon Resource Name (ARN) whose versions you want to list.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> componentSummaryList
The list of component summaries for the specified semantic version.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String owner
Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.
List<E> filters
Use the following filters to streamline results:
description
name
platform
supportedOsVersion
type
version
Boolean byName
Returns the list of components for the specified name.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> componentVersionList
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.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String owner
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.
List<E> filters
Use the following filters to streamline results:
containerType
name
parentImage
platform
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> containerRecipeSummaryList
The list of container recipes returned for the request.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String requestId
The request ID that uniquely identifies this request.
List<E> distributionConfigurationSummaryList
The list of distributions.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String imageVersionArn
The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
List<E> filters
Use the following filters to streamline results:
name
osVersion
platform
type
version
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imageSummaryList
The list of image build versions.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String imageBuildVersionArn
Filter results for the ListImagePackages request by the Image Build Version ARN
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imagePackageList
The list of Image Packages returned in the response.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
List<E> filters
Use the following filters to streamline results:
name
version
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imageSummaryList
The list of images built by this pipeline.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
List<E> filters
Use the following filters to streamline results:
description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imagePipelineList
The list of image pipelines.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String owner
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.
List<E> filters
Use the following filters to streamline results:
name
parentImage
platform
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imageRecipeSummaryList
The list of image pipelines.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String requestId
The request ID that uniquely identifies this request.
String aggregationType
The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns
results based on the request filter. If you didn't specify a filter in the request, the type defaults to
accountId.
Aggregation types
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.
List<E> responses
An array of image scan finding aggregations that match the filter criteria.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
List<E> filters
An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
severity
If you don't request a filter, then all findings in your account are listed.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> findings
The image scan findings for your account that meet your request filter criteria.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String owner
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.
List<E> filters
Use the following filters to streamline results:
name
osVersion
platform
type
version
Boolean byName
Requests a list of images with a specific recipe name.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
Boolean includeDeprecated
Includes deprecated images in the response list.
String requestId
The request ID that uniquely identifies this request.
List<E> imageVersionList
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.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String requestId
The request ID that uniquely identifies this request.
List<E> infrastructureConfigurationSummaryList
The list of infrastructure configurations.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String lifecycleExecutionId
Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.
String parentResourceId
You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.
To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String lifecycleExecutionId
Runtime details for the specified runtime instance of the lifecycle policy.
LifecycleExecutionState lifecycleExecutionState
The current state of the lifecycle runtime instance.
List<E> resources
A list of resources that were identified for lifecycle actions.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String resourceArn
The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.
List<E> lifecycleExecutions
A list of lifecycle runtime instances for the specified resource.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
List<E> lifecyclePolicySummaryList
A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String resourceArn
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
List<E> steps
An array of the workflow steps that are waiting for action in your Amazon Web Services account.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String workflowVersionArn
The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
List<E> workflowSummaryList
A list that contains metadata for the workflow builds that have run for the workflow resource specified in the request.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String imageBuildVersionArn
List all workflow runtime instances for the specified image build version resource ARN.
String requestId
The request ID that uniquely identifies this request.
List<E> workflowExecutions
Contains an array of runtime details that represents each time a workflow ran for the requested image build version.
String imageBuildVersionArn
The resource ARN of the image build version for which you requested a list of workflow runtime details.
String message
The output message from the list action, if applicable.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
String owner
Used to get a list of workflow build version filtered by the identity of the creator.
List<E> filters
Used to streamline search results.
Boolean byName
Specify all or part of the workflow name to streamline results.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
List<E> workflowVersionList
A list of workflow build versions that match the request criteria.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
String workflowExecutionId
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
String requestId
The request ID that uniquely identifies this request.
List<E> steps
Contains an array of runtime details that represents each step in this runtime instance of the workflow.
String workflowBuildVersionArn
The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.
String workflowExecutionId
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
String imageBuildVersionArn
The image build version resource ARN that's associated with the specified runtime instance of the workflow.
String message
The output message from the list action, if applicable.
String nextToken
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
S3Logs s3Logs
The Amazon S3 logging configuration.
String vulnerabilityId
A unique identifier for this vulnerability.
List<E> vulnerablePackages
The packages that this vulnerability impacts.
String source
The source of the vulnerability information.
List<E> cvss
CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.
List<E> relatedVulnerabilities
Vulnerabilities that are often related to the findings for the package.
String sourceUrl
A link to the source of the vulnerability information.
String vendorSeverity
The severity that the vendor assigned to this vulnerability type.
Date vendorCreatedAt
The date and time when this vulnerability was first added to the vendor's database.
Date vendorUpdatedAt
The date and time when the vendor last updated this vulnerability in their database.
List<E> referenceUrls
Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.
RemediationRecommendation recommendation
An object that contains information about the recommended course of action to remediate the finding.
String status
Shows the current lifecycle policy action that was applied to an impacted resource.
LifecyclePolicyDetailExclusionRulesAmis amis
Boolean amis
Specifies whether the lifecycle action should apply to distributed AMIs
Boolean snapshots
Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
Boolean containers
Specifies whether the lifecycle action should apply to distributed containers.
String roleName
The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
String diskImageFormat
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.
String s3Bucket
The S3 bucket in which to store the output disk images for your VM.
String s3Prefix
The Amazon S3 path for the bucket where the output disk images for your VM are stored.
String scheduleExpression
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.
String timezone
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.
String pipelineExecutionStartCondition
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.
String stepExecutionId
Uniquely identifies the workflow step that sent the step action.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image build version to send action for.
String action
The action for the image creation process to take while a workflow WaitForAction step waits for an
asynchronous action to complete.
String reason
The reason why this action is sent.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String stepExecutionId
The workflow step that sent the step action.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image build version that received the action request.
String clientToken
The client token that uniquely identifies the request.
Long all
The total number of findings across all severity levels for the specified filter.
Long critical
The number of critical severity findings for the specified filter.
Long high
The number of high severity findings for the specified filter.
Long medium
The number of medium severity findings for the specified filter.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String resourceArn
The ARN of the Image Builder resource that is updated. The state update might also impact associated resources.
ResourceState state
Indicates the lifecycle action to take for this request.
String executionRole
The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.
ResourceStateUpdateIncludeResources includeResources
A list of image resources to update state for.
ResourceStateUpdateExclusionRules exclusionRules
Skip action on the image resource and associated resources if specified exclusion rules are met.
Date updateAt
The timestamp that indicates when resources are updated by a lifecycle action.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Boolean uninstallAfterBuild
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.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
String description
The description of the distribution configuration.
List<E> distributions
The distributions of the distribution configuration.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The client token that uniquely identifies the request.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
String description
The description of the image pipeline.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container pipeline to update.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
ImageTestsConfiguration imageTestsConfiguration
The image test configuration of the image pipeline.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Schedule schedule
The schedule of the image pipeline.
String status
The status of the image pipeline.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
ImageScanningConfiguration imageScanningConfiguration
Contains settings for vulnerability scans.
List<E> workflows
Contains the workflows to run for the pipeline.
String executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
String description
The description of the infrastructure configuration.
List<E> instanceTypes
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.
String instanceProfileName
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
List<E> securityGroupIds
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
String subnetId
The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
Logging logging
The logging configuration of the infrastructure configuration.
String keyPair
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
Boolean terminateInstanceOnFailure
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.
String snsTopicArn
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.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Map<K,V> resourceTags
The tags attached to the resource created by Image Builder.
InstanceMetadataOptions instanceMetadataOptions
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:
Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The client token that uniquely identifies the request.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
String lifecyclePolicyArn
The Amazon Resource Name (ARN) of the lifecycle policy resource.
String description
Optional description for the lifecycle policy.
String status
Indicates whether the lifecycle policy resource is enabled.
String executionRole
The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.
String resourceType
The type of image resource that the lifecycle policy applies to.
List<E> policyDetails
The configuration details for a lifecycle policy resource.
LifecyclePolicyResourceSelection resourceSelection
Selection criteria for resources that the lifecycle policy applies to.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String lifecyclePolicyArn
The ARN of the image lifecycle policy resource that was updated.
String vulnerabilityId
The vulnerability Id for this set of counts.
SeverityCounts severityCounts
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.
String name
The name of the vulnerable package.
String version
The version of the vulnerable package.
String sourceLayerHash
The source layer hash of the vulnerable package.
Integer epoch
The epoch of the vulnerable package.
String release
The release of the vulnerable package.
String arch
The architecture of the vulnerable package.
String packageManager
The package manager of the vulnerable package.
String filePath
The file path of the vulnerable package.
String fixedInVersion
The version of the package that contains the vulnerability fix.
String remediation
The code to run in your environment to update packages with a fix available.
String arn
The Amazon Resource Name (ARN) of the workflow resource.
String name
The name of the workflow resource.
String version
The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
String description
The description of the workflow.
String changeDescription
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
String type
Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
WorkflowState state
Describes the current status of the workflow and the reason for that status.
String owner
The owner of the workflow resource.
String data
Contains the YAML document content for the workflow.
String kmsKeyId
The KMS key identifier used to encrypt the workflow resource.
String dateCreated
The timestamp when Image Builder created the workflow resource.
Map<K,V> tags
The tags that apply to the workflow resource
List<E> parameters
An array of input parameters that that the image workflow uses to control actions or configure settings.
String workflowArn
The Amazon Resource Name (ARN) of the workflow resource.
List<E> parameters
Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
String parallelGroup
Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.
String onFailure
The action to take if the workflow fails.
String workflowBuildVersionArn
The Amazon Resource Name (ARN) of the workflow resource build version that ran.
String workflowExecutionId
Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
String type
Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
String status
The current runtime status for this workflow.
String message
The runtime output message from the workflow, if applicable.
Integer totalStepCount
The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
Integer totalStepsSucceeded
A runtime count for the number of steps in the workflow that ran successfully.
Integer totalStepsFailed
A runtime count for the number of steps in the workflow that failed.
Integer totalStepsSkipped
A runtime count for the number of steps in the workflow that were skipped.
String startTime
The timestamp when the runtime instance of this workflow started.
String endTime
The timestamp when this runtime instance of the workflow finished.
String parallelGroup
The name of the test group that included the test workflow resource at runtime.
String name
The name of this input parameter.
String type
The type of input this parameter provides. The currently supported value is "string".
List<E> defaultValue
The default value of this parameter if no input is provided.
String description
Describes this parameter.
String stepExecutionId
Uniquely identifies the workflow step that ran for the associated image build version.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image build version that ran the workflow.
String workflowExecutionId
Uniquely identifies the runtime instance of the workflow that contains the workflow step that ran for the associated image build version.
String workflowBuildVersionArn
The ARN of the workflow resource that ran.
String name
The name of the workflow step.
String action
The name of the step action.
String startTime
The timestamp when the workflow step started.
String stepExecutionId
A unique identifier for the workflow step, assigned at runtime.
String name
The name of the workflow step.
String description
Description of the workflow step.
String action
The step action name.
String status
Runtime status for the workflow step.
String rollbackStatus
Reports on the rollback status of the step, if applicable.
String message
Detailed output message that the workflow step provides at runtime.
String inputs
Input parameters that Image Builder provides for the workflow step.
String outputs
The file names that the workflow step created as output for this runtime instance of the workflow.
String startTime
The timestamp when the workflow step started.
String endTime
The timestamp when the workflow step finished.
String arn
The Amazon Resource Name (ARN) of the workflow resource.
String name
The name of the workflow.
String version
The version of the workflow.
String description
Describes the workflow.
String changeDescription
The change description for the current version of the workflow resource.
String type
The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.
String owner
The owner of the workflow resource.
WorkflowState state
Describes the current state of the workflow resource.
String dateCreated
The original creation date of the workflow resource.
Map<K,V> tags
Contains a list of tags that are defined for the workflow.
String arn
The Amazon Resource Name (ARN) of the workflow resource.
String name
The name of the workflow.
String version
The semantic version of the workflow resource. The format includes three nodes: <major>.<minor>.<patch>.
String description
Describes the workflow.
String type
The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.
String owner
The owner of the workflow resource.
String dateCreated
The timestamp when Image Builder created the workflow version.
Copyright © 2023. All rights reserved.