Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/imagebuilder.ts?docs=full";

§Classes

Imagebuilder

§Interfaces

AccountAggregation

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.

AdditionalInstanceConfiguration

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.

Ami

Details of an Amazon EC2 AMI.

AmiDistributionConfiguration

Define and configure the output AMIs of the pipeline.

CancelImageCreationRequest
CancelImageCreationResponse
CancelLifecycleExecutionRequest
CancelLifecycleExecutionResponse
Component

A detailed view of a component.

ComponentConfiguration

Configuration details of the component.

ComponentParameter

Contains a key/value pair that sets the named component parameter.

ComponentParameterDetail

Defines a parameter that is used to provide configuration details for the component.

ComponentState

A group of fields that describe the current status of components.

ComponentSummary

A high-level summary of a component.

ComponentVersion

The defining characteristics of a specific version of an Amazon Web Services TOE component.

Container

A container encapsulates the runtime environment for an application.

ContainerDistributionConfiguration

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

ContainerRecipe

A container recipe.

ContainerRecipeSummary

A summary of a container recipe

CreateComponentRequest
CreateComponentResponse
CreateContainerRecipeRequest
CreateContainerRecipeResponse
CreateDistributionConfigurationRequest
CreateDistributionConfigurationResponse
CreateImagePipelineRequest
CreateImagePipelineResponse
CreateImageRecipeRequest
CreateImageRecipeResponse
CreateImageRequest
CreateImageResponse
CreateInfrastructureConfigurationRequest
CreateInfrastructureConfigurationResponse
CreateLifecyclePolicyRequest
CreateLifecyclePolicyResponse
CreateWorkflowRequest
CreateWorkflowResponse
CvssScore

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.

CvssScoreAdjustment

Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

CvssScoreDetails

Details about the source of the score, and the factors that determined the adjustments to create the final score.

DeleteComponentRequest
DeleteComponentResponse
DeleteContainerRecipeRequest
DeleteContainerRecipeResponse
DeleteDistributionConfigurationRequest
DeleteDistributionConfigurationResponse
DeleteImagePipelineRequest
DeleteImagePipelineResponse
DeleteImageRecipeRequest
DeleteImageRecipeResponse
DeleteImageRequest
DeleteImageResponse
DeleteInfrastructureConfigurationRequest
DeleteInfrastructureConfigurationResponse
DeleteLifecyclePolicyRequest
DeleteLifecyclePolicyResponse
DeleteWorkflowRequest
DeleteWorkflowResponse
Distribution

Defines the settings for a specific Region.

DistributionConfiguration

A distribution configuration.

DistributionConfigurationSummary

A high-level overview of a distribution configuration.

EbsInstanceBlockDeviceSpecification

Amazon EBS-specific block device mapping specifications.

EcrConfiguration

Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.

FastLaunchConfiguration

Define and configure faster launching for output Windows AMIs.

FastLaunchLaunchTemplateSpecification

Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.

FastLaunchSnapshotConfiguration

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

Filter

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

GetComponentPolicyRequest
GetComponentPolicyResponse
GetComponentRequest
GetComponentResponse
GetContainerRecipePolicyRequest
GetContainerRecipePolicyResponse
GetContainerRecipeRequest
GetContainerRecipeResponse
GetDistributionConfigurationRequest
GetDistributionConfigurationResponse
GetImagePipelineRequest
GetImagePipelineResponse
GetImagePolicyRequest
GetImagePolicyResponse
GetImageRecipePolicyRequest
GetImageRecipePolicyResponse
GetImageRecipeRequest
GetImageRecipeResponse
GetImageRequest
GetImageResponse
GetInfrastructureConfigurationRequest

GetInfrastructureConfiguration request object.

GetInfrastructureConfigurationResponse

GetInfrastructureConfiguration response object.

GetLifecycleExecutionRequest
GetLifecycleExecutionResponse
GetLifecyclePolicyRequest
GetLifecyclePolicyResponse
GetWorkflowExecutionRequest
GetWorkflowExecutionResponse
GetWorkflowRequest
GetWorkflowResponse
GetWorkflowStepExecutionRequest
GetWorkflowStepExecutionResponse
Image

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.

ImageAggregation

Contains vulnerability counts for a specific image.

ImagePackage

Represents a package installed on an Image Builder image.

ImagePipeline

Details of an image pipeline.

ImagePipelineAggregation

Contains vulnerability counts for a specific image pipeline.

ImageRecipe

An image recipe.

ImageRecipeSummary

A summary of an image recipe.

ImageScanFinding

Contains details about a vulnerability scan finding.

ImageScanFindingAggregation

This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.

ImageScanFindingsFilter

A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.

ImageScanningConfiguration

Contains settings for Image Builder image resource and container image scans.

ImageScanState

Shows the vulnerability scan status for a specific image, and the reason for that status.

ImageState

Image status and the reason for that status.

ImageSummary

An image summary.

ImageTestsConfiguration

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.

ImageVersion

The defining characteristics of a specific version of an Image Builder image.

ImportComponentRequest
ImportComponentResponse
ImportVmImageRequest
ImportVmImageResponse
InfrastructureConfiguration

Details of the infrastructure configuration.

InfrastructureConfigurationSummary

The infrastructure used when building Amazon EC2 AMIs.

InspectorScoreDetails

Information about the factors that influenced the score that Amazon Inspector assigned for a finding.

InstanceBlockDeviceMapping

Defines block device mappings for the instance used to configure your image.

InstanceConfiguration

Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.

InstanceMetadataOptions

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.

LaunchPermissionConfiguration

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.

LaunchTemplateConfiguration

Identifies an Amazon EC2 launch template to use for a specific account.

LifecycleExecution

Contains metadata from a runtime instance of a lifecycle policy.

LifecycleExecutionResource

Contains details for a resource that the runtime instance of the lifecycle policy identified for action.

LifecycleExecutionResourceAction

The lifecycle policy action that was identified for the impacted resource.

LifecycleExecutionResourcesImpactedSummary

Contains details for an image resource that was identified for a lifecycle action.

LifecycleExecutionResourceState

Contains the state of an impacted resource that the runtime instance of the lifecycle policy identified for action.

LifecycleExecutionSnapshotResource

Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action.

LifecycleExecutionState

The current state of the runtime instance of the lifecycle policy.

LifecyclePolicy

The configuration details for a lifecycle policy resource.

LifecyclePolicyDetail

The configuration details for a lifecycle policy resource.

LifecyclePolicyDetailAction

Contains selection criteria for the lifecycle policy.

LifecyclePolicyDetailActionIncludeResources

Specifies how the lifecycle policy should apply actions to selected resources.

LifecyclePolicyDetailExclusionRules

Specifies resources that lifecycle policy actions should not apply to.

LifecyclePolicyDetailExclusionRulesAmis

Defines criteria for AMIs that are excluded from lifecycle actions.

LifecyclePolicyDetailExclusionRulesAmisLastLaunched

Defines criteria to exclude AMIs from lifecycle actions based on the last time they were used to launch an instance.

LifecyclePolicyDetailFilter

Defines filters that the lifecycle policy uses to determine impacted resource.

LifecyclePolicyResourceSelection

Resource selection criteria for the lifecycle policy.

LifecyclePolicyResourceSelectionRecipe

Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.

LifecyclePolicySummary

Contains a summary of lifecycle policy resources.

ListComponentBuildVersionsRequest
ListComponentBuildVersionsResponse
ListComponentsRequest
ListComponentsResponse
ListContainerRecipesRequest
ListContainerRecipesResponse
ListDistributionConfigurationsRequest
ListDistributionConfigurationsResponse
ListImageBuildVersionsRequest
ListImageBuildVersionsResponse
ListImagePackagesRequest
ListImagePackagesResponse
ListImagePipelineImagesRequest
ListImagePipelineImagesResponse
ListImagePipelinesRequest
ListImagePipelinesResponse
ListImageRecipesRequest
ListImageRecipesResponse
ListImageScanFindingAggregationsRequest
ListImageScanFindingAggregationsResponse
ListImageScanFindingsRequest
ListImageScanFindingsResponse
ListImagesRequest
ListImagesResponse
ListInfrastructureConfigurationsRequest
ListInfrastructureConfigurationsResponse
ListLifecycleExecutionResourcesRequest
ListLifecycleExecutionResourcesResponse
ListLifecycleExecutionsRequest
ListLifecycleExecutionsResponse
ListLifecyclePoliciesRequest
ListLifecyclePoliciesResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListWaitingWorkflowStepsRequest
ListWaitingWorkflowStepsResponse
ListWorkflowBuildVersionsRequest
ListWorkflowBuildVersionsResponse
ListWorkflowExecutionsRequest
ListWorkflowExecutionsResponse
ListWorkflowsRequest
ListWorkflowsResponse
ListWorkflowStepExecutionsRequest
ListWorkflowStepExecutionsResponse
Logging

Logging configuration defines where Image Builder uploads your logs.

OutputResources

The resources produced by this image.

PackageVulnerabilityDetails

Information about package vulnerability findings.

PutComponentPolicyRequest
PutComponentPolicyResponse
PutContainerRecipePolicyRequest
PutContainerRecipePolicyResponse
PutImagePolicyRequest
PutImagePolicyResponse
PutImageRecipePolicyRequest
PutImageRecipePolicyResponse
Remediation

Information about how to remediate a finding.

RemediationRecommendation

Details about the recommended course of action to remediate the finding.

ResourceState

The current state of an impacted resource.

ResourceStateUpdateExclusionRules

Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.

ResourceStateUpdateIncludeResources

Specifies if the lifecycle policy should apply actions to selected resources.

S3ExportConfiguration

Properties that configure export from your build instance to a compatible file format for your VM.

S3Logs

Amazon S3 logging configuration.

Schedule

A schedule configures when and how often a pipeline will automatically create a new image.

SendWorkflowStepActionRequest
SendWorkflowStepActionResponse
SeverityCounts

Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.

StartImagePipelineExecutionRequest
StartImagePipelineExecutionResponse
StartResourceStateUpdateRequest
StartResourceStateUpdateResponse
SystemsManagerAgent

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

TagResourceRequest
TargetContainerRepository

The container repository where the output container image is stored.

UntagResourceRequest
UpdateDistributionConfigurationRequest
UpdateDistributionConfigurationResponse
UpdateImagePipelineRequest
UpdateImagePipelineResponse
UpdateInfrastructureConfigurationRequest
UpdateInfrastructureConfigurationResponse
UpdateLifecyclePolicyRequest
UpdateLifecyclePolicyResponse
VulnerabilityIdAggregation

Includes counts of image and pipeline resource findings by vulnerability.

VulnerablePackage

Information about a vulnerable package that Amazon Inspector identifies in a finding.

Workflow

Defines a process that Image Builder uses to build and test images during the image creation process.

WorkflowConfiguration

Contains control settings and configurable inputs for a workflow resource.

WorkflowExecutionMetadata

Metadata that includes details and status from this runtime instance of the workflow.

WorkflowParameter

Contains a key/value pair that sets the named workflow parameter.

WorkflowParameterDetail

Defines a parameter that's used to provide configuration details for the workflow.

WorkflowState

A group of fields that describe the current status of workflow.

WorkflowStepExecution

Contains runtime details for an instance of a workflow that ran for the associated image build version.

WorkflowStepMetadata

Runtime details and status for the workflow step.

WorkflowSummary

Contains metadata about the workflow resource.

WorkflowVersion

Contains details about this version of the workflow.

§Type Aliases

BuildType
ComponentFormat
ComponentStatus
ComponentType
ContainerRepositoryService
ContainerType
DiskImageFormat
EbsVolumeType
ImageScanStatus
ImageSource
ImageStatus
ImageType
LifecycleExecutionResourceActionName
LifecycleExecutionResourceStatus
LifecycleExecutionStatus
LifecyclePolicyDetailActionType
LifecyclePolicyDetailFilterType
LifecyclePolicyResourceType
LifecyclePolicyStatus
LifecyclePolicyTimeUnit
OnWorkflowFailure
Ownership
PipelineExecutionStartCondition
PipelineStatus
Platform
ResourceStatus
WorkflowExecutionStatus
WorkflowStatus
WorkflowStepActionType
WorkflowStepExecutionRollbackStatus
WorkflowStepExecutionStatus
WorkflowType