Skip to main content

Aws/imagebuilder

@swamp/aws/imagebuilderv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS
01README

AWS IMAGEBUILDER infrastructure models

02Behaviors9
@swamp/aws/imagebuilder/componentv2026.10.23.1component.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
fn create()
Create a ImageBuilder Component
fn get(identifier: string)
Get a ImageBuilder Component
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Component
fn update()
Update a ImageBuilder Component
fn delete(identifier: string)
Delete a ImageBuilder Component
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Component
fn sync()
Sync ImageBuilder Component state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder Component resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
fn create()
Create a ImageBuilder ContainerRecipe
fn get(identifier: string)
Get a ImageBuilder ContainerRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ContainerRecipe
fn update()
Update a ImageBuilder ContainerRecipe
fn delete(identifier: string)
Delete a ImageBuilder ContainerRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ContainerRecipe
fn sync()
Sync ImageBuilder ContainerRecipe state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder ContainerRecipe resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
fn create()
Create a ImageBuilder DistributionConfiguration
fn get(identifier: string)
Get a ImageBuilder DistributionConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder DistributionConfiguration
fn update()
Update a ImageBuilder DistributionConfiguration
fn delete(identifier: string)
Delete a ImageBuilder DistributionConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder DistributionConfiguration
fn sync()
Sync ImageBuilder DistributionConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder DistributionConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ImageScanningConfiguration?objectContains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.
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.
fn create()
Create a ImageBuilder Image
fn get(identifier: string)
Get a ImageBuilder Image
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Image
fn update()
Update a ImageBuilder Image
fn delete(identifier: string)
Delete a ImageBuilder Image
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Image
fn sync()
Sync ImageBuilder Image state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder Image resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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 that Amazon Inspector runs against the test instance during image creation.
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.
ImageTags?recordThe tags to be applied to images created by this pipeline.
fn create()
Create a ImageBuilder ImagePipeline
fn get(identifier: string)
Get a ImageBuilder ImagePipeline
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImagePipeline
fn update()
Update a ImageBuilder ImagePipeline
fn delete(identifier: string)
Delete a ImageBuilder ImagePipeline
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImagePipeline
fn sync()
Sync ImageBuilder ImagePipeline state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder ImagePipeline resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
AmiWatermarks?arrayThe AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers that automatically propagate to derivative AMIs when the source AMI is copied or distributed.
Tags?recordThe tags of the image recipe.
fn create()
Create a ImageBuilder ImageRecipe
fn get(identifier: string)
Get a ImageBuilder ImageRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImageRecipe
fn update()
Update a ImageBuilder ImageRecipe
fn delete(identifier: string)
Delete a ImageBuilder ImageRecipe
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder ImageRecipe
fn sync()
Sync ImageBuilder ImageRecipe state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder ImageRecipe resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
ParentInstance?objectThe Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.
TerminateInstanceOnCompletion?booleanSpecifies whether Image Builder terminates build and test instances that are still running when image creation ends without a failure. A TerminateInstance step in a workflow runs even when this is false.
fn create()
Create a ImageBuilder InfrastructureConfiguration
fn get(identifier: string)
Get a ImageBuilder InfrastructureConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder InfrastructureConfiguration
fn update()
Update a ImageBuilder InfrastructureConfiguration
fn delete(identifier: string)
Delete a ImageBuilder InfrastructureConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder InfrastructureConfiguration
fn sync()
Sync ImageBuilder InfrastructureConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder InfrastructureConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
fn create()
Create a ImageBuilder LifecyclePolicy
fn get(identifier: string)
Get a ImageBuilder LifecyclePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder LifecyclePolicy
fn update()
Update a ImageBuilder LifecyclePolicy
fn delete(identifier: string)
Delete a ImageBuilder LifecyclePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder LifecyclePolicy
fn sync()
Sync ImageBuilder LifecyclePolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder LifecyclePolicy resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
fn create()
Create a ImageBuilder Workflow
fn get(identifier: string)
Get a ImageBuilder Workflow
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Workflow
fn update()
Update a ImageBuilder Workflow
fn delete(identifier: string)
Delete a ImageBuilder Workflow
ArgumentTypeDescription
identifierstringThe primary identifier of the ImageBuilder Workflow
fn sync()
Sync ImageBuilder Workflow state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ImageBuilder Workflow resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ImageBuilder Workflow resource state
03Previous Versions19
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
  • Updated: component, container_recipe, distribution_configuration, image, image_pipeline, image_recipe, infrastructure_configuration, lifecycle_policy, workflow
2026.10.17.1AGPL-3.0-or-later(was none)
  • Updated: infrastructure_configuration
2026.10.13.1
  • Updated: component, container_recipe, distribution_configuration, image, image_pipeline, image_recipe, infrastructure_configuration, lifecycle_policy, workflow
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
04Stats
A
100 / 100
Downloads
35
Archive size
1.8 MB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
05Platforms
06Labels