Package software.amazon.awssdk.services.sagemaker.model

Interface CreateImageVersionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateImageVersionRequest.Builder,CreateImageVersionRequest>, SageMakerRequest.Builder, SdkBuilder<CreateImageVersionRequest.Builder,CreateImageVersionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateImageVersionRequest
public static interface CreateImageVersionRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateImageVersionRequest.Builder,CreateImageVersionRequest>

  • Method Details

    • baseImage

      CreateImageVersionRequest.Builder baseImage(String baseImage)

      The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

      <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

      Parameters:
      baseImage - The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

      <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

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

    • clientToken

      CreateImageVersionRequest.Builder clientToken(String clientToken)

      A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

      Parameters:
      clientToken - A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageName

      CreateImageVersionRequest.Builder imageName(String imageName)

      The ImageName of the Image to create a version of.

      Parameters:
      imageName - The ImageName of the Image to create a version of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aliases

      CreateImageVersionRequest.Builder aliases(Collection<String> aliases)

      A list of aliases created with the image version.

      Parameters:
      aliases - A list of aliases created with the image version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aliases

      CreateImageVersionRequest.Builder aliases(String... aliases)

      A list of aliases created with the image version.

      Parameters:
      aliases - A list of aliases created with the image version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vendorGuidance

      CreateImageVersionRequest.Builder vendorGuidance(String vendorGuidance)

      The stability of the image version, specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

      Parameters:
      vendorGuidance - The stability of the image version, specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

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

    • vendorGuidance

      CreateImageVersionRequest.Builder vendorGuidance(VendorGuidance vendorGuidance)

      The stability of the image version, specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

      Parameters:
      vendorGuidance - The stability of the image version, specified by the maintainer.

      • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      • STABLE: The image version is stable.

      • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

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

    • jobType

      CreateImageVersionRequest.Builder jobType(String jobType)

      Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

      Parameters:
      jobType - Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

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

    • jobType

      CreateImageVersionRequest.Builder jobType(JobType jobType)

      Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

      Parameters:
      jobType - Indicates SageMaker job type compatibility.

      • TRAINING: The image version is compatible with SageMaker training jobs.

      • INFERENCE: The image version is compatible with SageMaker inference jobs.

      • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

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

    • mlFramework

      CreateImageVersionRequest.Builder mlFramework(String mlFramework)

      The machine learning framework vended in the image version.

      Parameters:
      mlFramework - The machine learning framework vended in the image version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • programmingLang

      CreateImageVersionRequest.Builder programmingLang(String programmingLang)

      The supported programming language and its version.

      Parameters:
      programmingLang - The supported programming language and its version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processor

      CreateImageVersionRequest.Builder processor(String processor)

      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

      Parameters:
      processor - Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

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

    • processor

      CreateImageVersionRequest.Builder processor(Processor processor)

      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

      Parameters:
      processor - Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

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

    • horovod

      CreateImageVersionRequest.Builder horovod(Boolean horovod)

      Indicates Horovod compatibility.

      Parameters:
      horovod - Indicates Horovod compatibility.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • releaseNotes

      CreateImageVersionRequest.Builder releaseNotes(String releaseNotes)

      The maintainer description of the image version.

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

    • overrideConfiguration

      CreateImageVersionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateImageVersionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.