This is the newCloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see theAWS CloudFormation User Guide.
AWS::SageMaker::Image
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, seeBring your own SageMaker AI image.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SageMaker::Image", "Properties" :{ "ImageDescription" :String, "ImageDisplayName" :String, "ImageName" :String, "ImageRoleArn" :String, "Tags" :[Tag, ... ] }}YAML
Type: AWS::SageMaker::ImageProperties:ImageDescription:StringImageDisplayName:StringImageName:StringImageRoleArn:StringTags: -TagProperties
ImageDescriptionThe description of the image.
Required: No
Type: String
Pattern:
.+Minimum:
1Maximum:
512Update requires:No interruption
ImageDisplayNameThe display name of the image.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^\S(.*\S)?$Required: No
Type: String
Pattern:
^[A-Za-z0-9 -_]+$Minimum:
1Maximum:
128Update requires:No interruption
ImageNameThe 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}$Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$Minimum:
1Maximum:
63Update requires:Replacement
ImageRoleArnThe 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+=,.@\-_/]+$Required: Yes
Type: String
Pattern:
^arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*$Minimum:
1Maximum:
256Update requires:No interruption
TagsA list of key-value pairs to apply to this resource.
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Type: Array ofTag
Maximum:
50Update requires:No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsicRef function,Ref returns the ImageArn.
For more information about using theRef function, seeRef.
Fn::GetAtt
TheFn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using theFn::GetAtt intrinsic function, seeFn::GetAtt.
ImageArnThe Amazon Resource Name (ARN) of the image.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
