Skip to main content

@swamp/aws/imagebuilder

v2026.04.23.3

AWS IMAGEBUILDER infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsimagebuildercloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/imagebuilder

@swamp/aws/imagebuilder/componentv2026.04.23.2component.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the component.
VersionstringThe version of the component.
Description?stringThe description of the component.
ChangeDescription?stringThe change description of the component.
PlatformenumThe platform of the component.
Data?stringThe data of the component.
KmsKeyId?stringThe KMS key identifier used to encrypt the component.
Tags?recordThe tags associated with the component.
Uri?stringThe uri of the component.
SupportedOsVersions?arrayThe operating system (OS) version supported by the component.
createCreate a ImageBuilder Component
getGet a ImageBuilder Component
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Component
updateUpdate a ImageBuilder Component
deleteDelete a ImageBuilder Component
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Component
syncSync ImageBuilder Component state from AWS

Resources

state(infinite)— ImageBuilder Component resource state
@swamp/aws/imagebuilder/container-recipev2026.04.23.2container_recipe.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Name?stringThe name of the container recipe.
Description?stringThe description of the container recipe.
Version?stringThe semantic version of the container recipe (..).
Components?arrayComponents for build and test that are included in the container recipe.
InstanceConfiguration?objectA group of options that can be used to configure an instance for building and testing container images.
DockerfileTemplateData?stringDockerfiles 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.
DockerfileTemplateUri?stringThe S3 URI for the Dockerfile that will be used to build your container image.
PlatformOverride?enumSpecifies the operating system platform when you use a custom source image.
ContainerType?enumSpecifies the type of container, such as Docker.
ImageOsVersionOverride?stringSpecifies the operating system version for the source image.
TargetRepository?objectThe destination repository for the container image.
KmsKeyId?stringIdentifies which KMS key is used to encrypt the container image.
ParentImage?stringThe source image for the container recipe.
WorkingDirectory?stringThe working directory to be used during build and test workflows.
Tags?recordTags that are attached to the container recipe.
createCreate a ImageBuilder ContainerRecipe
getGet a ImageBuilder ContainerRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ContainerRecipe
updateUpdate a ImageBuilder ContainerRecipe
deleteDelete a ImageBuilder ContainerRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ContainerRecipe
syncSync ImageBuilder ContainerRecipe state from AWS

Resources

state(infinite)— ImageBuilder ContainerRecipe resource state
@swamp/aws/imagebuilder/distribution-configurationv2026.04.23.2distribution_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the distribution configuration.
Description?stringThe description of the distribution configuration.
DistributionsarrayThe distributions of the distribution configuration.
Tags?recordThe tags associated with the component.
createCreate a ImageBuilder DistributionConfiguration
getGet a ImageBuilder DistributionConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder DistributionConfiguration
updateUpdate a ImageBuilder DistributionConfiguration
deleteDelete a ImageBuilder DistributionConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder DistributionConfiguration
syncSync ImageBuilder DistributionConfiguration state from AWS

Resources

state(infinite)— ImageBuilder DistributionConfiguration resource state
@swamp/aws/imagebuilder/imagev2026.04.23.2image.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ImageScanningConfiguration?objectContains settings for vulnerability scans.
ContainerRecipeArn?stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
Workflows?arrayWorkflows to define the image build process
ImagePipelineExecutionSettings?objectThe image pipeline execution settings of the image.
DeletionSettings?objectThe deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
InfrastructureConfigurationArn?stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
ImageRecipeArn?stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
DistributionConfigurationArn?stringThe Amazon Resource Name (ARN) of the distribution configuration.
LoggingConfiguration?objectThe logging configuration settings for the image.
ImageTestsConfiguration?objectThe image tests configuration used when creating this image.
EnhancedImageMetadataEnabled?booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
ExecutionRole?stringThe execution role name/ARN for the image build, if provided
Tags?recordThe tags associated with the image.
createCreate a ImageBuilder Image
getGet a ImageBuilder Image
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Image
updateUpdate a ImageBuilder Image
deleteDelete a ImageBuilder Image
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Image
syncSync ImageBuilder Image state from AWS

Resources

state(infinite)— ImageBuilder Image resource state
@swamp/aws/imagebuilder/image-pipelinev2026.04.23.2image_pipeline.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Name?stringThe name of the image pipeline.
Description?stringThe description of the image pipeline.
ImageTestsConfiguration?objectThe image tests configuration of the image pipeline.
Status?enumThe status of the image pipeline.
Schedule?objectThe schedule of the image pipeline.
ImageRecipeArn?stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
ContainerRecipeArn?stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
DistributionConfigurationArn?stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
InfrastructureConfigurationArn?stringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
Workflows?arrayWorkflows to define the image build process
EnhancedImageMetadataEnabled?booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
ImageScanningConfiguration?objectContains settings for vulnerability scans.
ExecutionRole?stringThe execution role name/ARN for the image build, if provided
LoggingConfiguration?objectThe logging configuration settings for the image pipeline.
Tags?recordThe tags of this image pipeline.
createCreate a ImageBuilder ImagePipeline
getGet a ImageBuilder ImagePipeline
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImagePipeline
updateUpdate a ImageBuilder ImagePipeline
deleteDelete a ImageBuilder ImagePipeline
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImagePipeline
syncSync ImageBuilder ImagePipeline state from AWS

Resources

state(infinite)— ImageBuilder ImagePipeline resource state
@swamp/aws/imagebuilder/image-recipev2026.04.23.2image_recipe.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the image recipe.
Description?stringThe description of the image recipe.
VersionstringThe version of the image recipe.
Components?arrayThe components of the image recipe.
BlockDeviceMappings?arrayThe block device mappings to apply when creating images from this recipe.
ParentImagestringThe parent image of the image recipe.
WorkingDirectory?stringThe working directory to be used during build and test workflows.
AdditionalInstanceConfiguration?objectSpecify additional settings and launch scripts for your build instances.
AmiTags?recordThe tags to apply to the AMI created by this image recipe.
Tags?recordThe tags of the image recipe.
createCreate a ImageBuilder ImageRecipe
getGet a ImageBuilder ImageRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImageRecipe
updateUpdate a ImageBuilder ImageRecipe
deleteDelete a ImageBuilder ImageRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImageRecipe
syncSync ImageBuilder ImageRecipe state from AWS

Resources

state(infinite)— ImageBuilder ImageRecipe resource state
@swamp/aws/imagebuilder/infrastructure-configurationv2026.04.23.2infrastructure_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the infrastructure configuration.
Description?stringThe description of the infrastructure configuration.
InstanceTypes?arrayThe instance types of the infrastructure configuration.
SecurityGroupIds?arrayThe security group IDs of the infrastructure configuration.
Logging?objectThe logging configuration of the infrastructure configuration.
SubnetId?stringThe subnet ID of the infrastructure configuration.
KeyPair?stringThe EC2 key pair of the infrastructure configuration..
TerminateInstanceOnFailure?booleanThe terminate instance on failure configuration of the infrastructure configuration.
InstanceProfileNamestringThe instance profile of the infrastructure configuration.
InstanceMetadataOptions?objectThe instance metadata option settings for the infrastructure configuration.
SnsTopicArn?stringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
ResourceTags?recordThe tags attached to the resource created by Image Builder.
Tags?recordThe tags associated with the component.
Placement?objectThe placement option settings for the infrastructure configuration.
createCreate a ImageBuilder InfrastructureConfiguration
getGet a ImageBuilder InfrastructureConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder InfrastructureConfiguration
updateUpdate a ImageBuilder InfrastructureConfiguration
deleteDelete a ImageBuilder InfrastructureConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder InfrastructureConfiguration
syncSync ImageBuilder InfrastructureConfiguration state from AWS

Resources

state(infinite)— ImageBuilder InfrastructureConfiguration resource state
@swamp/aws/imagebuilder/lifecycle-policyv2026.04.23.2lifecycle_policy.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the lifecycle policy.
Description?stringThe description of the lifecycle policy.
Status?enumThe status of the lifecycle policy.
ExecutionRolestringThe execution role of the lifecycle policy.
ResourceTypeenumThe resource type of the lifecycle policy.
PolicyDetailsarrayThe policy details of the lifecycle policy.
ResourceSelectionobjectThe resource selection of the lifecycle policy.
Tags?recordThe tags associated with the lifecycle policy.
createCreate a ImageBuilder LifecyclePolicy
getGet a ImageBuilder LifecyclePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder LifecyclePolicy
updateUpdate a ImageBuilder LifecyclePolicy
deleteDelete a ImageBuilder LifecyclePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder LifecyclePolicy
syncSync ImageBuilder LifecyclePolicy state from AWS

Resources

state(infinite)— ImageBuilder LifecyclePolicy resource state
@swamp/aws/imagebuilder/workflowv2026.04.23.2workflow.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the workflow.
VersionstringThe version of the workflow.
Description?stringThe description of the workflow.
ChangeDescription?stringThe change description of the workflow.
TypeenumThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
Data?stringThe data of the workflow.
Uri?stringThe uri of the workflow.
KmsKeyId?stringThe KMS key identifier used to encrypt the workflow.
Tags?recordThe tags associated with the workflow.
createCreate a ImageBuilder Workflow
getGet a ImageBuilder Workflow
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Workflow
updateUpdate a ImageBuilder Workflow
deleteDelete a ImageBuilder Workflow
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Workflow
syncSync ImageBuilder Workflow state from AWS

Resources

state(infinite)— ImageBuilder Workflow resource state