# CfnImageProps

Properties for defining a `CfnImage`.

Extends: CfnImageProps
Used as props by: CfnImage

- Source: Generated code

## Example

```ts
// 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`: string — The description of the image.

- `imageDisplayName`: string — The display name of the image.

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

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

- `imageName`: string (required) — 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`: string (required) — 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`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — A list of key-value pairs to apply to this resource.

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