public static interface Image.Builder extends SdkPojo, CopyableBuilder<Image.Builder,Image>
| Modifier and Type | Method and Description |
|---|---|
Image.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the image.
|
Image.Builder |
buildType(BuildType buildType)
Indicates the type of build that created this image.
|
Image.Builder |
buildType(String buildType)
Indicates the type of build that created this image.
|
default Image.Builder |
containerRecipe(Consumer<ContainerRecipe.Builder> containerRecipe)
For container images, this is the container recipe that Image Builder used to create the image.
|
Image.Builder |
containerRecipe(ContainerRecipe containerRecipe)
For container images, this is the container recipe that Image Builder used to create the image.
|
Image.Builder |
dateCreated(String dateCreated)
The date on which Image Builder created this image.
|
default Image.Builder |
distributionConfiguration(Consumer<DistributionConfiguration.Builder> distributionConfiguration)
The distribution configuration that Image Builder used to create this image.
|
Image.Builder |
distributionConfiguration(DistributionConfiguration distributionConfiguration)
The distribution configuration that Image Builder used to create this image.
|
Image.Builder |
enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
Indicates whether Image Builder collects additional information about the image, such as the operating system
(OS) version and package list.
|
default Image.Builder |
imageRecipe(Consumer<ImageRecipe.Builder> imageRecipe)
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.
|
Image.Builder |
imageRecipe(ImageRecipe imageRecipe)
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.
|
default Image.Builder |
imageScanningConfiguration(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration)
Contains settings for vulnerability scans.
|
Image.Builder |
imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)
Contains settings for vulnerability scans.
|
Image.Builder |
imageSource(ImageSource imageSource)
The origin of the base image that Image Builder used to build this image.
|
Image.Builder |
imageSource(String imageSource)
The origin of the base image that Image Builder used to build this image.
|
default Image.Builder |
imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)
The image tests that ran when that Image Builder created this image.
|
Image.Builder |
imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
The image tests that ran when that Image Builder created this image.
|
default Image.Builder |
infrastructureConfiguration(Consumer<InfrastructureConfiguration.Builder> infrastructureConfiguration)
The infrastructure that Image Builder used to create this image.
|
Image.Builder |
infrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
The infrastructure that Image Builder used to create this image.
|
Image.Builder |
name(String name)
The name of the image.
|
Image.Builder |
osVersion(String osVersion)
The operating system version for instances that launch from this image.
|
default Image.Builder |
outputResources(Consumer<OutputResources.Builder> outputResources)
The output resources that Image Builder produces for this image.
|
Image.Builder |
outputResources(OutputResources outputResources)
The output resources that Image Builder produces for this image.
|
Image.Builder |
platform(Platform platform)
The image operating system platform, such as Linux or Windows.
|
Image.Builder |
platform(String platform)
The image operating system platform, such as Linux or Windows.
|
default Image.Builder |
scanState(Consumer<ImageScanState.Builder> scanState)
Contains information about the current state of scans for this image.
|
Image.Builder |
scanState(ImageScanState scanState)
Contains information about the current state of scans for this image.
|
Image.Builder |
sourcePipelineArn(String sourcePipelineArn)
The Amazon Resource Name (ARN) of the image pipeline that created this image.
|
Image.Builder |
sourcePipelineName(String sourcePipelineName)
The name of the image pipeline that created this image.
|
default Image.Builder |
state(Consumer<ImageState.Builder> state)
The state of the image.
|
Image.Builder |
state(ImageState state)
The state of the image.
|
Image.Builder |
tags(Map<String,String> tags)
The tags that apply to this image.
|
Image.Builder |
type(ImageType type)
Specifies whether this image produces an AMI or a container image.
|
Image.Builder |
type(String type)
Specifies whether this image produces an AMI or a container image.
|
Image.Builder |
version(String version)
The semantic version of the image.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildImage.Builder arn(String arn)
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
arn - The Amazon Resource Name (ARN) of the image. Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
Image.Builder type(String type)
Specifies whether this image produces an AMI or a container image.
Image.Builder type(ImageType type)
Specifies whether this image produces an AMI or a container image.
Image.Builder name(String name)
The name of the image.
name - The name of the image.Image.Builder version(String version)
The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
version - The semantic version of the image. The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
Image.Builder platform(String platform)
The image operating system platform, such as Linux or Windows.
Image.Builder platform(Platform platform)
The image operating system platform, such as Linux or Windows.
Image.Builder enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
enhancedImageMetadataEnabled - Indicates whether Image Builder collects additional information about the image, such as the operating
system (OS) version and package list.Image.Builder osVersion(String osVersion)
The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
osVersion - The operating system version for instances that launch from this image. For example, Amazon Linux 2,
Ubuntu 18, or Microsoft Windows Server 2019.Image.Builder state(ImageState state)
The state of the image.
state - The state of the image.default Image.Builder state(Consumer<ImageState.Builder> state)
The state of the image.
This is a convenience method that creates an instance of theImageState.Builder avoiding the need to
create one manually via ImageState.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to state(ImageState).
state - a consumer that will call methods on ImageState.Builderstate(ImageState)Image.Builder imageRecipe(ImageRecipe imageRecipe)
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
imageRecipe - For images that distribute an AMI, this is the image recipe that Image Builder used to create the
image. For container images, this is empty.default Image.Builder imageRecipe(Consumer<ImageRecipe.Builder> imageRecipe)
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
This is a convenience method that creates an instance of theImageRecipe.Builder avoiding the need to
create one manually via ImageRecipe.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to imageRecipe(ImageRecipe).
imageRecipe - a consumer that will call methods on ImageRecipe.BuilderimageRecipe(ImageRecipe)Image.Builder containerRecipe(ContainerRecipe containerRecipe)
For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
containerRecipe - For container images, this is the container recipe that Image Builder used to create the image. For
images that distribute an AMI, this is empty.default Image.Builder containerRecipe(Consumer<ContainerRecipe.Builder> containerRecipe)
For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
This is a convenience method that creates an instance of theContainerRecipe.Builder avoiding the
need to create one manually via ContainerRecipe.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to containerRecipe(ContainerRecipe).
containerRecipe - a consumer that will call methods on ContainerRecipe.BuildercontainerRecipe(ContainerRecipe)Image.Builder sourcePipelineName(String sourcePipelineName)
The name of the image pipeline that created this image.
sourcePipelineName - The name of the image pipeline that created this image.Image.Builder sourcePipelineArn(String sourcePipelineArn)
The Amazon Resource Name (ARN) of the image pipeline that created this image.
sourcePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that created this image.Image.Builder infrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
The infrastructure that Image Builder used to create this image.
infrastructureConfiguration - The infrastructure that Image Builder used to create this image.default Image.Builder infrastructureConfiguration(Consumer<InfrastructureConfiguration.Builder> infrastructureConfiguration)
The infrastructure that Image Builder used to create this image.
This is a convenience method that creates an instance of theInfrastructureConfiguration.Builder
avoiding the need to create one manually via InfrastructureConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to infrastructureConfiguration(InfrastructureConfiguration).
infrastructureConfiguration - a consumer that will call methods on InfrastructureConfiguration.BuilderinfrastructureConfiguration(InfrastructureConfiguration)Image.Builder distributionConfiguration(DistributionConfiguration distributionConfiguration)
The distribution configuration that Image Builder used to create this image.
distributionConfiguration - The distribution configuration that Image Builder used to create this image.default Image.Builder distributionConfiguration(Consumer<DistributionConfiguration.Builder> distributionConfiguration)
The distribution configuration that Image Builder used to create this image.
This is a convenience method that creates an instance of theDistributionConfiguration.Builder
avoiding the need to create one manually via DistributionConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to distributionConfiguration(DistributionConfiguration).
distributionConfiguration - a consumer that will call methods on DistributionConfiguration.BuilderdistributionConfiguration(DistributionConfiguration)Image.Builder imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
The image tests that ran when that Image Builder created this image.
imageTestsConfiguration - The image tests that ran when that Image Builder created this image.default Image.Builder imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)
The image tests that ran when that Image Builder created this image.
This is a convenience method that creates an instance of theImageTestsConfiguration.Builder avoiding
the need to create one manually via ImageTestsConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to imageTestsConfiguration(ImageTestsConfiguration).
imageTestsConfiguration - a consumer that will call methods on ImageTestsConfiguration.BuilderimageTestsConfiguration(ImageTestsConfiguration)Image.Builder dateCreated(String dateCreated)
The date on which Image Builder created this image.
dateCreated - The date on which Image Builder created this image.Image.Builder outputResources(OutputResources outputResources)
The output resources that Image Builder produces for this image.
outputResources - The output resources that Image Builder produces for this image.default Image.Builder outputResources(Consumer<OutputResources.Builder> outputResources)
The output resources that Image Builder produces for this image.
This is a convenience method that creates an instance of theOutputResources.Builder avoiding the
need to create one manually via OutputResources.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to outputResources(OutputResources).
outputResources - a consumer that will call methods on OutputResources.BuilderoutputResources(OutputResources)Image.Builder tags(Map<String,String> tags)
The tags that apply to this image.
tags - The tags that apply to this image.Image.Builder buildType(String buildType)
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
buildType - Indicates the type of build that created this image. The build can be initiated in the following
ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
BuildType,
BuildTypeImage.Builder buildType(BuildType buildType)
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
buildType - Indicates the type of build that created this image. The build can be initiated in the following
ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
BuildType,
BuildTypeImage.Builder imageSource(String imageSource)
The origin of the base image that Image Builder used to build this image.
imageSource - The origin of the base image that Image Builder used to build this image.ImageSource,
ImageSourceImage.Builder imageSource(ImageSource imageSource)
The origin of the base image that Image Builder used to build this image.
imageSource - The origin of the base image that Image Builder used to build this image.ImageSource,
ImageSourceImage.Builder scanState(ImageScanState scanState)
Contains information about the current state of scans for this image.
scanState - Contains information about the current state of scans for this image.default Image.Builder scanState(Consumer<ImageScanState.Builder> scanState)
Contains information about the current state of scans for this image.
This is a convenience method that creates an instance of theImageScanState.Builder avoiding the need
to create one manually via ImageScanState.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to scanState(ImageScanState).
scanState - a consumer that will call methods on ImageScanState.BuilderscanState(ImageScanState)Image.Builder imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)
Contains settings for vulnerability scans.
imageScanningConfiguration - Contains settings for vulnerability scans.default Image.Builder imageScanningConfiguration(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration)
Contains settings for vulnerability scans.
This is a convenience method that creates an instance of theImageScanningConfiguration.Builder
avoiding the need to create one manually via ImageScanningConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to imageScanningConfiguration(ImageScanningConfiguration).
imageScanningConfiguration - a consumer that will call methods on ImageScanningConfiguration.BuilderimageScanningConfiguration(ImageScanningConfiguration)Copyright © 2023. All rights reserved.