CfnImageVersionProps
- class aws_cdk.aws_sagemaker.CfnImageVersionProps(*, base_image, image_name, alias=None, aliases=None, horovod=None, job_type=None, ml_framework=None, processor=None, programming_lang=None, release_notes=None, vendor_guidance=None, version=None)
Bases:
object
Properties for defining a
CfnImageVersion
.- Parameters:
base_image (
str
) – The container image that the SageMaker image version is based on.image_name (
str
) – The name of the parent image. Length Constraints : Minimum length of 1. Maximum length of 63. Pattern :^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
alias (
Optional
[str
]) – The alias of the image version.aliases (
Optional
[Sequence
[str
]]) – List of aliases for the image version.horovod (
Union
[bool
,IResolvable
,None
]) – Indicates Horovod compatibility.job_type (
Optional
[str
]) – Indicates SageMaker job type compatibility.ml_framework (
Optional
[str
]) – The machine learning framework vended in the image version.processor (
Optional
[str
]) – Indicates CPU or GPU compatibility.programming_lang (
Optional
[str
]) – The supported programming language and its version.release_notes (
Optional
[str
]) – The maintainer description of the image version.vendor_guidance (
Optional
[str
]) – The availability of the image version specified by the maintainer.version (
Union
[int
,float
,None
]) – The version number.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_sagemaker as sagemaker cfn_image_version_props = sagemaker.CfnImageVersionProps( base_image="baseImage", image_name="imageName", # the properties below are optional alias="alias", aliases=["aliases"], horovod=False, job_type="jobType", ml_framework="mlFramework", processor="processor", programming_lang="programmingLang", release_notes="releaseNotes", vendor_guidance="vendorGuidance", version=123 )
Attributes
- alias
The alias of the image version.
- aliases
List of aliases for the image version.
- base_image
The container image that the SageMaker image version is based on.
- horovod
Indicates Horovod compatibility.
- image_name
The name of the parent image.
Length Constraints : Minimum length of 1. Maximum length of 63.
Pattern :
^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
- job_type
Indicates SageMaker job type compatibility.
- ml_framework
The machine learning framework vended in the image version.
- processor
Indicates CPU or GPU compatibility.
- programming_lang
The supported programming language and its version.
- release_notes
The maintainer description of the image version.
- vendor_guidance
The availability of the image version specified by the maintainer.