@aws-cdk/aws-imagebuilder-alpha.ImageProps

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ImageProps Struct

Properties for creating an Image resource.

ImageProps

used as props by

• Image

Stability

Experimental

Source

lib/image.ts

Example

const containerRecipe = new imagebuilder.ContainerRecipe(this, 'MyContainerRecipe', {
  baseImage: imagebuilder.BaseContainerImage.fromDockerHub('amazonlinux', 'latest'),
  targetRepository: imagebuilder.Repository.fromEcr(
    ecr.Repository.fromRepositoryName(this, 'Repository', 'my-container-repo')
  )
});

const containerImage = new imagebuilder.Image(this, 'MyContainerImage', {
  recipe: containerRecipe
});

Properties

deletionExecutionRole?optionalIRoledeletion_execution_role?optionalIRoledeletionExecutionRole?optionalIRoleDeletionExecutionRole?optionalIRoleDeletionExecutionRole?optionalIRole#

The execution role to use for deleting the image as well as the underlying resources, such as the AMIs, snapshots, and containers.

Default: no execution role. Only the Image Builder image will be deleted.

This role should contain resource lifecycle permissions required to delete the underlying AMIs/containers.

distributionConfiguration?optionalIDistributionConfigurationdistribution_configuration?optionalIDistributionConfigurationdistributionConfiguration?optionalIDistributionConfigurationDistributionConfiguration?optionalIDistributionConfigurationDistributionConfiguration?optionalIDistributionConfiguration= None#

The distribution configuration used for distributing the image.

enhancedImageMetadataEnabled?optionalbooleanenhanced_image_metadata_enabled?optionalboolenhancedImageMetadataEnabled?optionalBooleanEnhancedImageMetadataEnabled?optionalboolEnhancedImageMetadataEnabled?optional*bool= true#

If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.

executionRole?optionalIRoleexecution_role?optionalIRoleexecutionRole?optionalIRoleExecutionRole?optionalIRoleExecutionRole?optionalIRole#

The execution role used to perform workflow actions to build the image.

Default: Image Builder will use the SLR if possible. Otherwise, an execution role will be generated

notes

By default, the Image Builder Service Linked Role (SLR) will be created automatically and used as the execution role. However, when providing a custom set of image workflows for the image, an execution role will be generated with the minimal permissions needed to execute the workflows.

imageScanningEcrRepository?optionalIRepositoryimage_scanning_ecr_repository?optionalIRepositoryimageScanningEcrRepository?optionalIRepositoryImageScanningEcrRepository?optionalIRepositoryImageScanningEcrRepository?optionalIRepository#

The container repository that Amazon Inspector scans to identify findings for your container images.

Default: if scanning is enabled, a repository will be created by Image Builder if one is not provided

If a repository is not provided, Image Builder creates a repository named image-builder-image-scanning-repository for vulnerability scanning.

imageScanningEcrTags?optionalstring[]image_scanning_ecr_tags?optionaltyping.List[str]imageScanningEcrTags?optionalList<String>ImageScanningEcrTags?optionalstring[]ImageScanningEcrTags?optional*[]*string= None#

The tags for Image Builder to apply to the output container image that Amazon Inspector scans.

imageScanningEnabled?optionalbooleanimage_scanning_enabled?optionalboolimageScanningEnabled?optionalBooleanImageScanningEnabled?optionalboolImageScanningEnabled?optional*bool= false#

Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

imageTestsEnabled?optionalbooleanimage_tests_enabled?optionalboolimageTestsEnabled?optionalBooleanImageTestsEnabled?optionalboolImageTestsEnabled?optional*bool= true#

Whether to run tests after building an image.

infrastructureConfiguration?optionalIInfrastructureConfigurationinfrastructure_configuration?optionalIInfrastructureConfigurationinfrastructureConfiguration?optionalIInfrastructureConfigurationInfrastructureConfiguration?optionalIInfrastructureConfigurationInfrastructureConfiguration?optionalIInfrastructureConfiguration#

The infrastructure configuration used for building the image.

Default: an infrastructure configuration will be created with the default settings

notes

A default infrastructure configuration will be used if one is not provided.

The default configuration will create an instance profile and role with minimal permissions needed to build the image, attached to the EC2 instance.

IMDSv2 will be required by default on the instances used to build and test the image.

logGroup?optionalILogGrouplog_group?optionalILogGrouplogGroup?optionalILogGroupLogGroup?optionalILogGroupLogGroup?optionalILogGroup#

The log group to use for the image.

Default: a log group will be created

By default, a log group will be created with the format /aws/imagebuilder/<image-name>

recipeIRecipeBaserecipeIRecipeBaserecipeIRecipeBaseRecipeIRecipeBaseRecipeIRecipeBaserequired#

The recipe that defines the base image, components, and customizations used to build the image.

This can either be an image recipe, or a container recipe.

tags?optional{ [key: string]: string }tags?optionaltyping.Mapping[str, str]tags?optionalMap<String, String>Tags?optionalIDictionary<string, string>Tags?optional*map[string]*string= None#

The tags to apply to the image.

workflows?optionalWorkflowConfiguration[]workflows?optionaltyping.List[WorkflowConfiguration]workflows?optionalList<WorkflowConfiguration>Workflows?optionalWorkflowConfiguration[]Workflows?optional*[]WorkflowConfiguration#

The list of workflow configurations used to build the image.

Default: Image Builder will use a default set of workflows for the build to build, test, and distribute the image