1.204.0

interface CfnImageProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnImageProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnImageProps
Pythonaws_cdk.aws_sagemaker.CfnImageProps
TypeScript @aws-cdk/aws-sagemaker » CfnImageProps

Properties for defining a CfnImage.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker from '@aws-cdk/aws-sagemaker';
const cfnImageProps: sagemaker.CfnImageProps = {
  imageName: 'imageName',
  imageRoleArn: 'imageRoleArn',

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

Properties

NameTypeDescription
imageNamestringThe name of the Image. Must be unique by region in your account.
imageRoleArnstringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
imageDescription?stringThe description of the image.
imageDisplayName?stringThe display name of the image.
tags?CfnTag[]A list of key-value pairs to apply to this resource.

imageName

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

imageRoleArn

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

imageDescription?

Type: string (optional)

The description of the image.

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

Pattern : .*

imageDisplayName?

Type: string (optional)

The display name of the image.

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

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

tags?

Type: CfnTag[] (optional)

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

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

← PreviousNext →