Skip to content
v2.278.0

CustomImageProperty Struct ​

A custom SageMaker AI image.

For more information, see Bring your own SageMaker AI image .

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 customImageProperty: sagemaker.CfnUserProfile.CustomImageProperty = {
  appImageConfigName: 'appImageConfigName',
  imageName: 'imageName',

  // the properties below are optional
  imageVersionNumber: 123,
};
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

custom_image_property = sagemaker.CfnUserProfile.CustomImageProperty(
    app_image_config_name="appImageConfigName",
    image_name="imageName",

    # the properties below are optional
    image_version_number=123
)
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.*;

CustomImageProperty customImageProperty = CustomImageProperty.builder()
        .appImageConfigName("appImageConfigName")
        .imageName("imageName")

        // the properties below are optional
        .imageVersionNumber(123)
        .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 customImageProperty = new CustomImageProperty {
    AppImageConfigName = "appImageConfigName",
    ImageName = "imageName",

    // the properties below are optional
    ImageVersionNumber = 123
};
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"

customImageProperty := &CustomImageProperty{
	AppImageConfigName: jsii.String("appImageConfigName"),
	ImageName: jsii.String("imageName"),

	// the properties below are optional
	ImageVersionNumber: jsii.Number(123),
}

Properties ​

appImageConfigNamestringapp_image_config_namestrappImageConfigNameStringAppImageConfigNamestringAppImageConfigName*string required #
The name of the AppImageConfig.
imageNamestringimage_namestrimageNameStringImageNamestringImageName*string required #
The name of the CustomImage.

Must be unique to your account.

imageVersionNumberoptionalnumberimage_version_numberoptionalint | floatimageVersionNumberoptionalNumberImageVersionNumberoptionaldoubleImageVersionNumberoptional*float64 #
The version number of the CustomImage.