Skip to content
v2.273.0

AWS::ImageBuilder Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as imagebuilder from 'aws-cdk-lib/aws-imagebuilder';
python
import aws_cdk.aws_imagebuilder as imagebuilder
java
import software.amazon.awscdk.services.imagebuilder.*;
csharp
using Amazon.CDK.AWS.ImageBuilder;
go
import imagebuilder "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::ImageBuilder.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnComponentConstruct (L1)Creates a new component that can be used to build, validate, test, and assess your image.
CfnContainerRecipeConstruct (L1)Creates a new container recipe.
CfnDistributionConfigurationConstruct (L1)A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .
CfnImageConstruct (L1)Creates a new image.
CfnImagePipelineConstruct (L1)An image pipeline is the automation configuration for building secure OS images on AWS .
CfnImageRecipeConstruct (L1)Creates a new image recipe.
CfnInfrastructureConfigurationConstruct (L1)Creates a new infrastructure configuration.
CfnLifecyclePolicyConstruct (L1)Create a lifecycle policy resource.
CfnWorkflowConstruct (L1)Create a new workflow or a new version of an existing workflow.
CfnComponent.LatestVersionPropertyStructThe resource ARNs with different wildcard variations of semantic versioning.
CfnComponentPropsStructProperties for defining a CfnComponent.
CfnContainerRecipe.ComponentConfigurationPropertyStructConfiguration details of the component.
CfnContainerRecipe.ComponentParameterPropertyStructContains a key/value pair that sets the named component parameter.
CfnContainerRecipe.EbsInstanceBlockDeviceSpecificationPropertyStructAmazon EBS-specific block device mapping specifications.
CfnContainerRecipe.InstanceBlockDeviceMappingPropertyStructDefines block device mappings for the instance used to configure your image.
CfnContainerRecipe.InstanceConfigurationPropertyStructDefines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
CfnContainerRecipe.LatestVersionPropertyStructThe resource ARNs with different wildcard variations of semantic versioning.
CfnContainerRecipe.TargetContainerRepositoryPropertyStructThe container repository where the output container image is stored.
CfnContainerRecipePropsStructProperties for defining a CfnContainerRecipe.
CfnDistributionConfiguration.AmiDistributionConfigurationPropertyStructDefine and configure the output AMIs of the pipeline.
CfnDistributionConfiguration.ContainerDistributionConfigurationPropertyStructContainer distribution settings for encryption, licensing, and sharing in a specific Region.
CfnDistributionConfiguration.DistributionPropertyStructThe distribution configuration distribution defines the settings for a specific Region in the Distribution Configuration.
CfnDistributionConfiguration.FastLaunchConfigurationPropertyStructDefine and configure faster launching for output Windows AMIs.
CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationPropertyStructIdentifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.
CfnDistributionConfiguration.FastLaunchSnapshotConfigurationPropertyStructConfiguration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
CfnDistributionConfiguration.LaunchPermissionConfigurationPropertyStructDescribes the configuration for a launch permission.
CfnDistributionConfiguration.LaunchTemplateConfigurationPropertyStructIdentifies an Amazon EC2 launch template to use for a specific account.
CfnDistributionConfiguration.SsmParameterConfigurationPropertyStructConfiguration for a single Parameter in the AWS Systems Manager (SSM) Parameter Store in a given Region.
CfnDistributionConfiguration.TargetContainerRepositoryPropertyStructThe container repository where the output container image is stored.
CfnDistributionConfigurationPropsStructProperties for defining a CfnDistributionConfiguration.
CfnImage.DeletionSettingsPropertyStructContains deletion settings of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.
CfnImage.EcrConfigurationPropertyStructSettings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
CfnImage.ImageLoggingConfigurationPropertyStructThe logging configuration that's defined for the image.
CfnImage.ImagePipelineExecutionSettingsPropertyStructContains settings for starting an image pipeline execution.
CfnImage.ImageScanningConfigurationPropertyStructContains settings for Image Builder image resource and container image scans.
CfnImage.ImageTestsConfigurationPropertyStructWhen you create an image or container recipe with Image Builder , you can add the build or test components that are used to create the final image.
CfnImage.LatestVersionPropertyStructThe resource ARNs with different wildcard variations of semantic versioning.
CfnImage.WorkflowConfigurationPropertyStructContains control settings and configurable inputs for a workflow resource.
CfnImage.WorkflowParameterPropertyStructContains a key/value pair that sets the named workflow parameter.
CfnImagePipeline.AutoDisablePolicyPropertyStructDefines the rules by which an image pipeline is automatically disabled when it fails.
CfnImagePipeline.EcrConfigurationPropertyStructSettings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
CfnImagePipeline.ImageScanningConfigurationPropertyStructContains settings for Image Builder image resource and container image scans.
CfnImagePipeline.ImageTestsConfigurationPropertyStructWhen you create an image or container recipe with Image Builder , you can add the build or test components that your image pipeline uses to create the final image.
CfnImagePipeline.PipelineLoggingConfigurationPropertyStructThe logging configuration that's defined for pipeline execution.
CfnImagePipeline.SchedulePropertyStructA schedule configures when and how often a pipeline will automatically create a new image.
CfnImagePipeline.WorkflowConfigurationPropertyStructContains control settings and configurable inputs for a workflow resource.
CfnImagePipeline.WorkflowParameterPropertyStructContains a key/value pair that sets the named workflow parameter.
CfnImagePipelinePropsStructProperties for defining a CfnImagePipeline.
CfnImagePropsStructProperties for defining a CfnImage.
CfnImageRecipe.AdditionalInstanceConfigurationPropertyStructIn addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances.
CfnImageRecipe.ComponentConfigurationPropertyStructConfiguration details of the component.
CfnImageRecipe.ComponentParameterPropertyStructContains a key/value pair that sets the named component parameter.
CfnImageRecipe.EbsInstanceBlockDeviceSpecificationPropertyStructThe image recipe EBS instance block device specification includes the Amazon EBS-specific block device mapping specifications for the image.
CfnImageRecipe.InstanceBlockDeviceMappingPropertyStructDefines block device mappings for the instance used to configure your image.
CfnImageRecipe.LatestVersionPropertyStructThe resource ARNs with different wildcard variations of semantic versioning.
CfnImageRecipe.SystemsManagerAgentPropertyStructContains settings for the Systems Manager agent on your build instance.
CfnImageRecipePropsStructProperties for defining a CfnImageRecipe.
CfnInfrastructureConfiguration.InstanceMetadataOptionsPropertyStructThe instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances.
CfnInfrastructureConfiguration.LoggingPropertyStructLogging configuration defines where Image Builder uploads your logs.
CfnInfrastructureConfiguration.PlacementPropertyStructBy default, EC2 instances run on shared tenancy hardware.
CfnInfrastructureConfiguration.S3LogsPropertyStructAmazon S3 logging configuration.
CfnInfrastructureConfigurationPropsStructProperties for defining a CfnInfrastructureConfiguration.
CfnLifecyclePolicy.ActionPropertyStructContains selection criteria for the lifecycle policy.
CfnLifecyclePolicy.AmiExclusionRulesPropertyStructDefines criteria for AMIs that are excluded from lifecycle actions.
CfnLifecyclePolicy.ExclusionRulesPropertyStructSpecifies resources that lifecycle policy actions should not apply to.
CfnLifecyclePolicy.FilterPropertyStructDefines filters that the lifecycle policy uses to determine impacted resource.
CfnLifecyclePolicy.IncludeResourcesPropertyStructSpecifies how the lifecycle policy should apply actions to selected resources.
CfnLifecyclePolicy.LastLaunchedPropertyStructDefines criteria to exclude AMIs from lifecycle actions based on the last time they were used to launch an instance.
CfnLifecyclePolicy.PolicyDetailPropertyStructThe configuration details for a lifecycle policy resource.
CfnLifecyclePolicy.RecipeSelectionPropertyStructSpecifies an Image Builder recipe that the lifecycle policy uses for resource selection.
CfnLifecyclePolicy.ResourceSelectionPropertyStructResource selection criteria for the lifecycle policy.
CfnLifecyclePolicyPropsStructProperties for defining a CfnLifecyclePolicy.
CfnWorkflow.LatestVersionPropertyStructThe resource ARNs with different wildcard variations of semantic versioning.
CfnWorkflowPropsStructProperties for defining a CfnWorkflow.