Skip to content
v2.278.0

KernelGatewayAppSettingsProperty Struct ​

The KernelGateway app settings.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const kernelGatewayAppSettingsProperty: sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty = {
  customImages: [{
    appImageConfigName: 'appImageConfigName',
    imageName: 'imageName',

    // the properties below are optional
    imageVersionNumber: 123,
  }],
  defaultResourceSpec: {
    instanceType: 'instanceType',
    lifecycleConfigArn: 'lifecycleConfigArn',
    sageMakerImageArn: 'sageMakerImageArn',
    sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    trainingPlanArn: 'trainingPlanArn',
  },
  lifecycleConfigArns: ['lifecycleConfigArns'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

kernel_gateway_app_settings_property = sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty(
    custom_images=[sagemaker.CfnUserProfile.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",

        # the properties below are optional
        image_version_number=123
    )],
    default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn",
        training_plan_arn="trainingPlanArn"
    ),
    lifecycle_config_arns=["lifecycleConfigArns"]
)
java
// 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.*;

KernelGatewayAppSettingsProperty kernelGatewayAppSettingsProperty = KernelGatewayAppSettingsProperty.builder()
        .customImages(List.of(CustomImageProperty.builder()
                .appImageConfigName("appImageConfigName")
                .imageName("imageName")

                // the properties below are optional
                .imageVersionNumber(123)
                .build()))
        .defaultResourceSpec(ResourceSpecProperty.builder()
                .instanceType("instanceType")
                .lifecycleConfigArn("lifecycleConfigArn")
                .sageMakerImageArn("sageMakerImageArn")
                .sageMakerImageVersionArn("sageMakerImageVersionArn")
                .trainingPlanArn("trainingPlanArn")
                .build())
        .lifecycleConfigArns(List.of("lifecycleConfigArns"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var kernelGatewayAppSettingsProperty = new KernelGatewayAppSettingsProperty {
    CustomImages = new [] { new CustomImageProperty {
        AppImageConfigName = "appImageConfigName",
        ImageName = "imageName",

        // the properties below are optional
        ImageVersionNumber = 123
    } },
    DefaultResourceSpec = new ResourceSpecProperty {
        InstanceType = "instanceType",
        LifecycleConfigArn = "lifecycleConfigArn",
        SageMakerImageArn = "sageMakerImageArn",
        SageMakerImageVersionArn = "sageMakerImageVersionArn",
        TrainingPlanArn = "trainingPlanArn"
    },
    LifecycleConfigArns = new [] { "lifecycleConfigArns" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

kernelGatewayAppSettingsProperty := &KernelGatewayAppSettingsProperty{
	CustomImages: []interface{}{
		&CustomImageProperty{
			AppImageConfigName: jsii.String("appImageConfigName"),
			ImageName: jsii.String("imageName"),

			// the properties below are optional
			ImageVersionNumber: jsii.Number(123),
		},
	},
	DefaultResourceSpec: &ResourceSpecProperty{
		InstanceType: jsii.String("instanceType"),
		LifecycleConfigArn: jsii.String("lifecycleConfigArn"),
		SageMakerImageArn: jsii.String("sageMakerImageArn"),
		SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"),
		TrainingPlanArn: jsii.String("trainingPlanArn"),
	},
	LifecycleConfigArns: []*string{
		jsii.String("lifecycleConfigArns"),
	},
}

Properties ​

customImagesoptionalIResolvable | IResolvable | CfnUserProfile.CustomImageProperty[]custom_imagesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomImageProperty]]]customImagesoptionalIResolvableCustomImagesoptionalIResolvableCustomImagesoptionalinterface{} #
A list of custom SageMaker AI images that are configured to run as a KernelGateway app.

The maximum number of custom images are as follows.

  • On a domain level: 200
  • On a space level: 5
  • On a user profile level: 5
defaultResourceSpecoptionalIResolvable | CfnUserProfile.ResourceSpecPropertydefault_resource_specoptionaltyping.Union[IResolvable, ResourceSpecProperty]defaultResourceSpecoptionalIResolvableDefaultResourceSpecoptionalIResolvableDefaultResourceSpecoptionalinterface{} #
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
notes

The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or CloudFormation and the instance type parameter value is not passed.

lifecycleConfigArnsoptionalstring[]lifecycle_config_arnsoptionaltyping.List[str]lifecycleConfigArnsoptionalList<String>LifecycleConfigArnsoptionalstring[]LifecycleConfigArnsoptional*[]*string #
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.