@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-09T19:16:34.686Z") public class CfnAppImageConfig extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAppImageConfig(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAppImageConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAppImageConfig(Construct scope, java.lang.String id, CfnAppImageConfigProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAppImageConfigArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getAppImageConfigName()
Must be unique to your account.
public void setAppImageConfigName(java.lang.String value)
Must be unique to your account.
public java.lang.Object getKernelGatewayImageConfig()
public void setKernelGatewayImageConfig(IResolvable value)
public void setKernelGatewayImageConfig(CfnAppImageConfig.KernelGatewayImageConfigProperty value)