interface CfnImageProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Sagemaker.CfnImageProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnImageProps |
![]() | software.amazon.awscdk.services.sagemaker.CfnImageProps |
![]() | aws_cdk.aws_sagemaker.CfnImageProps |
![]() | aws-cdk-lib » aws_sagemaker » CfnImageProps |
Properties for defining a CfnImage
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html
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
Name | Type | Description |
---|---|---|
image | string | The name of the Image. Must be unique by region in your account. |
image | string | The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. |
image | string | The description of the image. |
image | string | The display name of the image. |
tags? | Cfn [] | 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.
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:
Cfn
[]
(optional)
A list of key-value pairs to apply to this resource.
Array Members : Minimum number of 0 items. Maximum number of 50 items.