Class ResourceSpec

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ResourceSpec
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ResourceSpec.Builder,ResourceSpec>
@Generated("software.amazon.awssdk:codegen") public final class ResourceSpec extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResourceSpec.Builder,ResourceSpec>

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.

See Also:

  • Method Details

    • sageMakerImageArn

      public final String sageMakerImageArn()

      The ARN of the SageMaker AI image that the image version belongs to.

      Returns:
      The ARN of the SageMaker AI image that the image version belongs to.

    • sageMakerImageVersionArn

      public final String sageMakerImageVersionArn()

      The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      Returns:
      The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

    • sageMakerImageVersionAlias

      public final String sageMakerImageVersionAlias()

      The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      Returns:
      The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

    • instanceType

      public final AppInstanceType instanceType()

      The instance type that the image version runs on.

      JupyterServer apps only support the system value.

      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return AppInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type that the image version runs on.

      JupyterServer apps only support the system value.

      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type that the image version runs on.

      JupyterServer apps only support the system value.

      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return AppInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type that the image version runs on.

      JupyterServer apps only support the system value.

      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

      See Also:

    • lifecycleConfigArn

      public final String lifecycleConfigArn()

      The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

      Returns:
      The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • toBuilder

      public ResourceSpec.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ResourceSpec.Builder,ResourceSpec>
      Returns:
      a builder for type T

    • builder

      public static ResourceSpec.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ResourceSpec.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.