software.amazon.awscdk.services.sagemaker

Class CfnAppImageConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnAppImageConfig

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.854Z")
 @Stability(value=Stable)
public class CfnAppImageConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::AppImageConfig`.

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

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.*;
 CfnAppImageConfig cfnAppImageConfig = CfnAppImageConfig.Builder.create(this, "MyCfnAppImageConfig")
         .appImageConfigName("appImageConfigName")
         // the properties below are optional
         .kernelGatewayImageConfig(KernelGatewayImageConfigProperty.builder()
                 .kernelSpecs(List.of(KernelSpecProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .displayName("displayName")
                         .build()))
                 // the properties below are optional
                 .fileSystemConfig(FileSystemConfigProperty.builder()
                         .defaultGid(123)
                         .defaultUid(123)
                         .mountPath("mountPath")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAppImageConfig.Builder A fluent builder for CfnAppImageConfig.
static interface	CfnAppImageConfig.FileSystemConfigProperty The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
static interface	CfnAppImageConfig.KernelGatewayImageConfigProperty The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.
static interface	CfnAppImageConfig.KernelSpecProperty The specification of a Jupyter kernel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAppImageConfig(software.constructs.Construct scope, String id, CfnAppImageConfigProps props) Create a new `AWS::SageMaker::AppImageConfig`.
protected	CfnAppImageConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAppImageConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppImageConfigName() The name of the AppImageConfig.
String	getAttrAppImageConfigArn() The Amazon Resource Name (ARN) of the AppImageConfig, such as `arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name` .
protected Map<String,Object>	getCfnProperties()
Object	getKernelGatewayImageConfig() The configuration for the file system and kernels in the SageMaker image.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppImageConfigName(String value) The name of the AppImageConfig.
void	setKernelGatewayImageConfig(CfnAppImageConfig.KernelGatewayImageConfigProperty value) The configuration for the file system and kernels in the SageMaker image.
void	setKernelGatewayImageConfig(IResolvable value) The configuration for the file system and kernels in the SageMaker image.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAppImageConfig

protected CfnAppImageConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnAppImageConfig

protected CfnAppImageConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAppImageConfig

@Stability(value=Stable)
public CfnAppImageConfig(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnAppImageConfigProps props)

Create a new `AWS::SageMaker::AppImageConfig`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAppImageConfigArn

@Stability(value=Stable)
 @NotNull
public String getAttrAppImageConfigArn()

The Amazon Resource Name (ARN) of the AppImageConfig, such as `arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getAppImageConfigName

@Stability(value=Stable)
 @NotNull
public String getAppImageConfigName()

The name of the AppImageConfig.

Must be unique to your account.

setAppImageConfigName

@Stability(value=Stable)
public void setAppImageConfigName(@NotNull
                                                           String value)

The name of the AppImageConfig.

Must be unique to your account.

getKernelGatewayImageConfig

@Stability(value=Stable)
 @Nullable
public Object getKernelGatewayImageConfig()

The configuration for the file system and kernels in the SageMaker image.

setKernelGatewayImageConfig

@Stability(value=Stable)
public void setKernelGatewayImageConfig(@Nullable
                                                                 CfnAppImageConfig.KernelGatewayImageConfigProperty value)

The configuration for the file system and kernels in the SageMaker image.

setKernelGatewayImageConfig

@Stability(value=Stable)
public void setKernelGatewayImageConfig(@Nullable
                                                                 IResolvable value)

The configuration for the file system and kernels in the SageMaker image.