Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnImageMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImageMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.975Z")
@Stability(Stable)
public interface CfnImageMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnImagePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 CfnImageMixinProps cfnImageMixinProps = CfnImageMixinProps.builder()
         .imageDescription("imageDescription")
         .imageDisplayName("imageDisplayName")
         .imageName("imageName")
         .imageRoleArn("imageRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnImageMixinProps.Builder	A builder for CfnImageMixinProps
static final class	CfnImageMixinProps.Jsii$Proxy	An implementation for CfnImageMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnImageMixinProps.Builder	builder()
default String	getImageDescription()	The description of the image.
default String	getImageDisplayName()	The display name of the image.
default String	getImageName()	The name of the Image.
default String	getImageRoleArn()	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
default List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageDescription

@Stability(Stable)
@Nullable
default String getImageDescription()

The description of the image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedescription

getImageDisplayName

@Stability(Stable)
@Nullable
default String getImageDisplayName()

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedisplayname

getImageName

@Stability(Stable)
@Nullable
default String getImageName()

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}$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagename

getImageRoleArn

@Stability(Stable)
@Nullable
default String getImageRoleArn()

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+=,.@\-_/]+$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagerolearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs to apply to this resource.

Array Members : Minimum number of 0 items. Maximum number of 50 items.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-tags

builder

@Stability(Stable)
static CfnImageMixinProps.Builder builder()

Returns:

a CfnImageMixinProps.Builder of CfnImageMixinProps