CfnImageProps
- class aws_cdk.aws_sagemaker.CfnImageProps(*, image_name, image_role_arn, image_description=None, image_display_name=None, tags=None)
Bases:
object
Properties for defining a
CfnImage
.- Parameters:
image_name (
str
) – 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}$
image_role_arn (
str
) – 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+=,.@\-_/]+$
image_description (
Optional
[str
]) – The description of the image. Length Constraints : Minimum length of 1. Maximum length of 512. Pattern :.*
image_display_name (
Optional
[str
]) – The display name of the image. Length Constraints : Minimum length of 1. Maximum length of 128. Pattern :^\S(.*\S)?$
tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – A list of key-value pairs to apply to this resource. Array Members : Minimum number of 0 items. Maximum number of 50 items.
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sagemaker as sagemaker cfn_image_props = sagemaker.CfnImageProps( image_name="imageName", image_role_arn="imageRoleArn", # the properties below are optional image_description="imageDescription", image_display_name="imageDisplayName", tags=[CfnTag( key="key", value="value" )] )
Attributes
- image_description
The description of the image.
Length Constraints : Minimum length of 1. Maximum length of 512.
Pattern :
.*
- image_display_name
The display name of the image.
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- image_name
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}$
- image_role_arn
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
A list of key-value pairs to apply to this resource.
Array Members : Minimum number of 0 items. Maximum number of 50 items.