software.amazon.awscdk.services.sagemaker

Class CfnAppImageConfig

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sagemaker.CfnAppImageConfig

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:34.686Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAppImageConfig(Construct scope, java.lang.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
java.lang.String	getAppImageConfigName() The name of the AppImageConfig.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAppImageConfigName(java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnAppImageConfig(Construct scope,
                         java.lang.String id,
                         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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAppImageConfigArn

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getAppImageConfigName

public java.lang.String getAppImageConfigName()

The name of the AppImageConfig.

Must be unique to your account.

setAppImageConfigName

public void setAppImageConfigName(java.lang.String value)

The name of the AppImageConfig.

Must be unique to your account.

getKernelGatewayImageConfig

public java.lang.Object getKernelGatewayImageConfig()

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

setKernelGatewayImageConfig

public void setKernelGatewayImageConfig(IResolvable value)

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

setKernelGatewayImageConfig

public void setKernelGatewayImageConfig(CfnAppImageConfig.KernelGatewayImageConfigProperty value)

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