Package software.amazon.awscdk.services.sagemaker

Interface CfnSpace.ResourceSpecProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSpace.ResourceSpecProperty.Jsii$Proxy

Enclosing class:

CfnSpace

@Stability(Stable)
public static interface CfnSpace.ResourceSpecProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ResourceSpecProperty resourceSpecProperty = ResourceSpecProperty.builder()
         .instanceType("instanceType")
         .lifecycleConfigArn("lifecycleConfigArn")
         .sageMakerImageArn("sageMakerImageArn")
         .sageMakerImageVersionArn("sageMakerImageVersionArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSpace.ResourceSpecProperty.Builder	A builder for CfnSpace.ResourceSpecProperty
static final class	CfnSpace.ResourceSpecProperty.Jsii$Proxy	An implementation for CfnSpace.ResourceSpecProperty

Method Summary

Modifier and Type	Method	Description
static CfnSpace.ResourceSpecProperty.Builder	builder()
default String	getInstanceType()	The instance type that the image version runs on.
default String	getLifecycleConfigArn()	The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
default String	getSageMakerImageArn()	The ARN of the SageMaker AI image that the image version belongs to.
default String	getSageMakerImageVersionArn()	The ARN of the image version created on the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-instancetype

getLifecycleConfigArn

@Stability(Stable)
@Nullable
default String getLifecycleConfigArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-lifecycleconfigarn

getSageMakerImageArn

@Stability(Stable)
@Nullable
default String getSageMakerImageArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-sagemakerimagearn

getSageMakerImageVersionArn

@Stability(Stable)
@Nullable
default String getSageMakerImageVersionArn()

The ARN of the image version created on the instance.

To clear the value set for SageMakerImageVersionArn , pass None as the value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-sagemakerimageversionarn

builder

@Stability(Stable)
static CfnSpace.ResourceSpecProperty.Builder builder()

Returns:

a CfnSpace.ResourceSpecProperty.Builder of CfnSpace.ResourceSpecProperty