aws-cdk-lib.aws_sagemaker.CfnImageProps

CfnImageProps Struct

Properties for defining a CfnImage.

CfnImageProps

used as props by

• CfnImage

Source

Generated code

Example

// 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 cfnImageProps: sagemaker.CfnImageProps = {
  imageName: 'imageName',
  imageRoleArn: 'imageRoleArn',

  // the properties below are optional
  imageDescription: 'imageDescription',
  imageDisplayName: 'imageDisplayName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

imageDescription?optionalstringimage_description?optionalstrimageDescription?optionalStringImageDescription?optionalstringImageDescription?optional*string#

The description of the image.

imageDisplayName?optionalstringimage_display_name?optionalstrimageDisplayName?optionalStringImageDisplayName?optionalstringImageDisplayName?optional*string#

The display name of the image.

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

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

imageNamestringimage_namestrimageNameStringImageNamestringImageName*stringrequired#

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

imageRoleArnstringimage_role_arnstrimageRoleArnStringImageRoleArnstringImageRoleArn*stringrequired#

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

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

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

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