Module aws_sdk_imagebuilder::types
source · Expand description
Data structures used by operation inputs/outputs.
Modules
- Builders
- Error types that EC2 Image Builder can respond with.
Structs
Contains counts of vulnerability findings from image scans that run when you create new Image Builder images, or build new versions of existing images. The vulnerability counts are grouped by severity level. The counts are aggregated across resources to create the final tally for the account that owns them.
In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances.
Details of an Amazon EC2 AMI.
Define and configure the output AMIs of the pipeline.
A detailed view of a component.
Configuration details of the component.
Contains a key/value pair that sets the named component parameter.
Defines a parameter that is used to provide configuration details for the component.
A group of fields that describe the current status of components that are no longer active.
A high-level summary of a component.
The defining characteristics of a specific version of an Amazon Web Services TOE component.
A container encapsulates the runtime environment for an application.
Container distribution settings for encryption, licensing, and sharing in a specific Region.
A container recipe.
A summary of a container recipe
Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.
Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.
Details about the source of the score, and the factors that determined the adjustments to create the final score.
Defines the settings for a specific Region.
A distribution configuration.
A high-level overview of a distribution configuration.
Amazon EBS-specific block device mapping specifications.
Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
Define and configure faster launching for output Windows AMIs.
Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.
Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (
containerRecipe
), which creates a container image, or an image recipe (imageRecipe
), which creates an AMI.Contains vulnerability counts for a specific image.
Represents a package installed on an Image Builder image.
Details of an image pipeline.
Contains vulnerability counts for a specific image pipeline.
An image recipe.
A summary of an image recipe.
Contains details about a vulnerability scan finding.
This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.
A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.
Shows the vulnerability scan status for a specific image, and the reason for that status.
Contains settings for Image Builder image resource and container image scans.
Image status and the reason for that status.
An image summary.
Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.
The defining characteristics of a specific version of an Image Builder image.
Details of the infrastructure configuration.
The infrastructure used when building Amazon EC2 AMIs.
Information about the factors that influenced the score that Amazon Inspector assigned for a finding.
Defines block device mappings for the instance used to configure your image.
Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to
all
. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.Identifies an Amazon EC2 launch template to use for a specific account.
Logging configuration defines where Image Builder uploads your logs.
The resources produced by this image.
Information about package vulnerability findings.
Information about how to remediate a finding.
Details about the recommended course of action to remediate the finding.
Properties that configure export from your build instance to a compatible file format for your VM.
Amazon S3 logging configuration.
A schedule configures how often and when a pipeline will automatically create a new image.
Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.
Contains settings for the Systems Manager agent on your build instance.
The container repository where the output container image is stored.
Includes counts of image and pipeline resource findings by vulnerability.
Information about a vulnerable package that Amazon Inspector identifies in a finding.
Metadata that includes details and status from this runtime instance of the workflow.
Runtime details and status for the workflow step.
Enums
- When writing a match expression against
BuildType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ComponentFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ComponentStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ComponentType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ContainerRepositoryService
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ContainerType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
DiskImageFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
EbsVolumeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ImageScanStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ImageSource
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ImageStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ImageType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Ownership
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
PipelineExecutionStartCondition
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
PipelineStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Platform
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
WorkflowExecutionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
WorkflowStepExecutionRollbackStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
WorkflowStepExecutionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
WorkflowType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.