imagebuilder/aws.sdk.kotlin.services.imagebuilder.model/ImagePipeline/Builder

Builder

Properties

The Amazon Resource Name (ARN) of the image pipeline.

Image Builder tracks the number of consecutive failures for scheduled pipeline executions and takes one of the following actions each time it runs on a schedule:

containerRecipeArn

var containerRecipeArn: String?

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

dateCreated

var dateCreated: String?

The date on which this image pipeline was created.

dateLastRun

var dateLastRun: String?

The date on which this image pipeline was last run.

dateNextRun

var dateNextRun: String?

The next date when the pipeline is scheduled to run.

dateUpdated

var dateUpdated: String?

The date on which this image pipeline was last updated.

description

var description: String?

The description of the image pipeline.

distributionConfigurationArn

var distributionConfigurationArn: String?

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

enhancedImageMetadataEnabled

var enhancedImageMetadataEnabled: Boolean?

Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.

executionRole

var executionRole: String?

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

imageRecipeArn

var imageRecipeArn: String?

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

imageScanningConfiguration

var imageScanningConfiguration: ImageScanningConfiguration?

Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.

imageTags

var imageTags: Map<String, String>?

The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. Builds that you start manually use the tags from the StartImagePipelineExecution request instead.

imageTestsConfiguration

var imageTestsConfiguration: ImageTestsConfiguration?

The image tests configuration of the image pipeline.

infrastructureConfigurationArn

var infrastructureConfigurationArn: String?

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

lastRunStatus

var lastRunStatus: ImageStatus?

The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.

loggingConfiguration

var loggingConfiguration: PipelineLoggingConfiguration?

The CloudWatch Logs configuration for the pipeline: the log group for image build logs and the log group for pipeline execution logs.

name

var name: String?

The name of the image pipeline.

platform

var platform: Platform?

The platform of the image pipeline, inherited from the recipe that the pipeline uses.

schedule

var schedule: Schedule?

The schedule of the image pipeline.

status

var status: PipelineStatus?

The status of the image pipeline. A disabled pipeline doesn't run on its schedule, but you can still start builds manually. Image Builder can also disable a pipeline automatically when consecutive scheduled builds fail.

Functions

imageScanningConfiguration

fun imageScanningConfiguration(block: ImageScanningConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.imagebuilder.model.ImageScanningConfiguration inside the given block

imageTestsConfiguration

fun imageTestsConfiguration(block: ImageTestsConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.imagebuilder.model.ImageTestsConfiguration inside the given block

loggingConfiguration

fun loggingConfiguration(block: PipelineLoggingConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.imagebuilder.model.PipelineLoggingConfiguration inside the given block

schedule

fun schedule(block: Schedule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.imagebuilder.model.Schedule inside the given block