Package com.pulumi.aws.sagemaker

Class ImageVersion

  • public class ImageVersion
extends com.pulumi.resources.CustomResource
    Provides a SageMaker AI Image Version resource. ## Example Usage ### Basic usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.sagemaker.ImageVersion;
 import com.pulumi.aws.sagemaker.ImageVersionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new ImageVersion("example", ImageVersionArgs.builder()
             .imageName(test.id())
             .baseImage("012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest")
             .build());
 
     }
 }
    ### With Aliases 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.sagemaker.ImageVersion;
 import com.pulumi.aws.sagemaker.ImageVersionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var test = new ImageVersion("test", ImageVersionArgs.builder()
             .imageName(testAwsSagemakerImage.id())
             .baseImage("012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest")
             .aliases(            
                 "latest",
                 "stable")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import SageMaker AI Image Versions using a comma-delimited string concatenating `imageName` and `version`. For example: ```sh $ pulumi import aws:sagemaker/imageVersion:ImageVersion example example-name,1 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> aliases()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> baseImage()  
      com.pulumi.core.Output<java.lang.String> containerImage()  
      static ImageVersion get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ImageVersionState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> horovod()  
      com.pulumi.core.Output<java.lang.String> imageArn()  
      com.pulumi.core.Output<java.lang.String> imageName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> jobType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> mlFramework()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> processor()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> programmingLang()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> releaseNotes()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vendorGuidance()  
      com.pulumi.core.Output<java.lang.Integer> version()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ImageVersion

        public ImageVersion​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ImageVersion

        public ImageVersion​(java.lang.String name,
                    ImageVersionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ImageVersion

        public ImageVersion​(java.lang.String name,
                    ImageVersionArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • aliases

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> aliases()
        Returns:
        A list of aliases for the image version.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN assigned by AWS to this Image Version.

      • baseImage

        public com.pulumi.core.Output<java.lang.String> baseImage()
        Returns:
        The registry path of the container image on which this image version is based.

      • containerImage

        public com.pulumi.core.Output<java.lang.String> containerImage()
        Returns:
        The registry path of the container image that contains this image version.

      • horovod

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> horovod()
        Returns:
        Indicates Horovod compatibility.

      • imageArn

        public com.pulumi.core.Output<java.lang.String> imageArn()

      • imageName

        public com.pulumi.core.Output<java.lang.String> imageName()
        Returns:
        The name of the image. Must be unique to your account.

      • jobType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> jobType()
        Returns:
        Indicates SageMaker AI job type compatibility. Valid values are: `TRAINING`, `INFERENCE`, and `NOTEBOOK_KERNEL`.

      • mlFramework

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> mlFramework()
        Returns:
        The machine learning framework vended in the image version.

      • processor

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> processor()
        Returns:
        Indicates CPU or GPU compatibility. Valid values are: `CPU` and `GPU`.

      • programmingLang

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> programmingLang()
        Returns:
        The supported programming language and its version.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • releaseNotes

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> releaseNotes()
        Returns:
        The maintainer description of the image version.

      • vendorGuidance

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vendorGuidance()
        Returns:
        The stability of the image version, specified by the maintainer. Valid values are: `NOT_PROVIDED`, `STABLE`, `TO_BE_ARCHIVED`, and `ARCHIVED`.

      • version

        public com.pulumi.core.Output<java.lang.Integer> version()
        Returns:
        The version of the image. If not specified, the latest version is described.

      • get

        public static ImageVersion get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               ImageVersionState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.