Interface Image.Builder

    • Method Detail

      • arn

        Image.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:

        1. 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.

        2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

        3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

        Parameters:
        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:

        1. 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.

        2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

        3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • type

        Image.Builder type​(String type)

        Specifies whether this image produces an AMI or a container image.

        Parameters:
        type - Specifies whether this image produces an AMI or a container image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageType, ImageType
      • type

        Image.Builder type​(ImageType type)

        Specifies whether this image produces an AMI or a container image.

        Parameters:
        type - Specifies whether this image produces an AMI or a container image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageType, ImageType
      • name

        Image.Builder name​(String name)

        The name of the image.

        Parameters:
        name - The name of the image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • version

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • platform

        Image.Builder platform​(String platform)

        The image operating system platform, such as Linux or Windows.

        Parameters:
        platform - The image operating system platform, such as Linux or Windows.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Platform, Platform
      • platform

        Image.Builder platform​(Platform platform)

        The image operating system platform, such as Linux or Windows.

        Parameters:
        platform - The image operating system platform, such as Linux or Windows.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Platform, Platform
      • enhancedImageMetadataEnabled

        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.

        Parameters:
        enhancedImageMetadataEnabled - Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • osVersion

        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.

        Parameters:
        osVersion - The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • state

        Image.Builder state​(ImageState state)

        The state of the image.

        Parameters:
        state - The state of the image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • imageRecipe

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • containerRecipe

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sourcePipelineName

        Image.Builder sourcePipelineName​(String sourcePipelineName)

        The name of the image pipeline that created this image.

        Parameters:
        sourcePipelineName - The name of the image pipeline that created this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sourcePipelineArn

        Image.Builder sourcePipelineArn​(String sourcePipelineArn)

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

        Parameters:
        sourcePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that created this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • infrastructureConfiguration

        Image.Builder infrastructureConfiguration​(InfrastructureConfiguration infrastructureConfiguration)

        The infrastructure that Image Builder used to create this image.

        Parameters:
        infrastructureConfiguration - The infrastructure that Image Builder used to create this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • distributionConfiguration

        Image.Builder distributionConfiguration​(DistributionConfiguration distributionConfiguration)

        The distribution configuration that Image Builder used to create this image.

        Parameters:
        distributionConfiguration - The distribution configuration that Image Builder used to create this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • imageTestsConfiguration

        Image.Builder imageTestsConfiguration​(ImageTestsConfiguration imageTestsConfiguration)

        The image tests that ran when that Image Builder created this image.

        Parameters:
        imageTestsConfiguration - The image tests that ran when that Image Builder created this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dateCreated

        Image.Builder dateCreated​(String dateCreated)

        The date on which Image Builder created this image.

        Parameters:
        dateCreated - The date on which Image Builder created this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • outputResources

        Image.Builder outputResources​(OutputResources outputResources)

        The output resources that Image Builder produces for this image.

        Parameters:
        outputResources - The output resources that Image Builder produces for this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tags

        Image.Builder tags​(Map<String,​String> tags)

        The tags that apply to this image.

        Parameters:
        tags - The tags that apply to this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • buildType

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BuildType, BuildType
      • buildType

        Image.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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BuildType, BuildType
      • imageSource

        Image.Builder imageSource​(String imageSource)

        The origin of the base image that Image Builder used to build this image.

        Parameters:
        imageSource - The origin of the base image that Image Builder used to build this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageSource, ImageSource
      • imageSource

        Image.Builder imageSource​(ImageSource imageSource)

        The origin of the base image that Image Builder used to build this image.

        Parameters:
        imageSource - The origin of the base image that Image Builder used to build this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageSource, ImageSource
      • scanState

        Image.Builder scanState​(ImageScanState scanState)

        Contains information about the current state of scans for this image.

        Parameters:
        scanState - Contains information about the current state of scans for this image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • imageScanningConfiguration

        Image.Builder imageScanningConfiguration​(ImageScanningConfiguration imageScanningConfiguration)

        Contains settings for vulnerability scans.

        Parameters:
        imageScanningConfiguration - Contains settings for vulnerability scans.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • deprecationTime

        Image.Builder deprecationTime​(Instant deprecationTime)

        The time when deprecation occurs for an image resource. This can be a past or future date.

        Parameters:
        deprecationTime - The time when deprecation occurs for an image resource. This can be a past or future date.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lifecycleExecutionId

        Image.Builder lifecycleExecutionId​(String lifecycleExecutionId)

        Identifies the last runtime instance of the lifecycle policy to take action on the image.

        Parameters:
        lifecycleExecutionId - Identifies the last runtime instance of the lifecycle policy to take action on the image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • executionRole

        Image.Builder executionRole​(String executionRole)

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

        Parameters:
        executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • workflows

        Image.Builder workflows​(Collection<WorkflowConfiguration> workflows)

        Contains the build and test workflows that are associated with the image.

        Parameters:
        workflows - Contains the build and test workflows that are associated with the image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • workflows

        Image.Builder workflows​(WorkflowConfiguration... workflows)

        Contains the build and test workflows that are associated with the image.

        Parameters:
        workflows - Contains the build and test workflows that are associated with the image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.