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

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 image and SageMaker image version, and the instance type that the version runs on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceSpec.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceSpec.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
AppInstanceType	instanceType()	The instance type that the image version runs on.
String	instanceTypeAsString()	The instance type that the image version runs on.
String	lifecycleConfigArn()	The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
String	sageMakerImageArn()	The ARN of the SageMaker image that the image version belongs to.
String	sageMakerImageVersionAlias()	The SageMakerImageVersionAlias of the image to launch with.
String	sageMakerImageVersionArn()	The ARN of the image version created on the instance.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceSpec.Builder>	serializableBuilderClass()
ResourceSpec.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sageMakerImageArn

public final String sageMakerImageArn()

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

Returns:

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

sageMakerImageVersionArn

public final String sageMakerImageVersionArn()

The ARN of the image version created on the instance.

Returns:

The ARN of the image version created on the instance.

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:

AppInstanceType

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:

AppInstanceType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceSpec.Builder,ResourceSpec>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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