AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SageMaker::Image

CfnImage

Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see [Bring your own SageMaker AI image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .

Import

import { CfnImage } from 'aws-cdk-lib/aws-sagemaker';

Or use the module namespace:

import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnImage

Properties

Configuration passed to the constructor as CfnImageProps.

imageNameRequired
string

The name of the Image. Must be unique by region in your account. *Length Constraints* : Minimum length of 1. Maximum length of 63. *Pattern* : `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`

imageRoleArnRequired
string

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. *Length Constraints* : Minimum length of 20. Maximum length of 2048. *Pattern* : `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`

imageDescriptionOptional
string

The description of the image.

imageDisplayNameOptional
string

The display name of the image. *Length Constraints* : Minimum length of 1. Maximum length of 128. *Pattern* : `^\S(.*\S)?$`

tagsOptional
CfnTag[]

A list of key-value pairs to apply to this resource. *Array Members* : Minimum number of 0 items. Maximum number of 50 items.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::SageMaker::ImageView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-sagemaker
CFN TypeAWS::SageMaker::Image
Properties5

Related Constructs

Explore This Service

External Links