Package software.amazon.awscdk.services.imagebuilder.alpha

Class Component.Builder

java.lang.Object
software.amazon.awscdk.services.imagebuilder.alpha.Component.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Component>
Enclosing class:
Component
@Stability(Experimental) public static final class Component.Builder extends Object implements software.amazon.jsii.Builder<Component>
(experimental) A fluent builder for Component.

  • Method Details

    • create

      @Stability(Experimental) public static Component.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Component.Builder.

    • data

      @Stability(Experimental) public Component.Builder data(ComponentData data)
      (experimental) The component document content that defines the build, validation, or test steps to be executed during the image building process.

      Parameters:
      data - The component document content that defines the build, validation, or test steps to be executed during the image building process. This parameter is required.
      Returns:
      this

    • platform

      @Stability(Experimental) public Component.Builder platform(Platform platform)
      (experimental) The operating system platform of the component.

      Parameters:
      platform - The operating system platform of the component. This parameter is required.
      Returns:
      this

    • changeDescription

      @Stability(Experimental) public Component.Builder changeDescription(String changeDescription)
      (experimental) The change description of the component.

      Describes what change has been made in this version of the component, or what makes this version different from other versions.

      Default: None

      Parameters:
      changeDescription - The change description of the component. This parameter is required.
      Returns:
      this

    • componentName

      @Stability(Experimental) public Component.Builder componentName(String componentName)
      (experimental) The name of the component.

      Default: - a name is generated

      Parameters:
      componentName - The name of the component. This parameter is required.
      Returns:
      this

    • componentVersion

      @Stability(Experimental) public Component.Builder componentVersion(String componentVersion)
      (experimental) The version of the component.

      Default: 1.0.0

      Parameters:
      componentVersion - The version of the component. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public Component.Builder description(String description)
      (experimental) The description of the component.

      Default: None

      Parameters:
      description - The description of the component. This parameter is required.
      Returns:
      this

    • kmsKey

      @Stability(Experimental) public Component.Builder kmsKey(IKey kmsKey)
      (experimental) The KMS key used to encrypt this component.

      Default: - an Image Builder owned key will be used to encrypt the component.

      Parameters:
      kmsKey - The KMS key used to encrypt this component. This parameter is required.
      Returns:
      this

    • supportedOsVersions

      @Stability(Experimental) public Component.Builder supportedOsVersions(List<? extends OSVersion> supportedOsVersions)
      (experimental) The operating system versions supported by the component.

      Default: None

      Parameters:
      supportedOsVersions - The operating system versions supported by the component. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Experimental) public Component.Builder tags(Map<String,String> tags)
      (experimental) The tags to apply to the component.

      Default: None

      Parameters:
      tags - The tags to apply to the component. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public Component build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Component>
      Returns:
      a newly built instance of Component.