Class CfnImageVersion
Creates a version of the SageMaker image specified by ImageName
.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnImageVersion : CfnResource, IInspectable
Syntax (vb)
Public Class CfnImageVersion
Inherits CfnResource
Implements IInspectable
Remarks
The version represents the Amazon Container Registry (ECR) container image specified by BaseImage
.
You can use the DependsOn
attribute to specify that the creation of a specific resource follows another. You can use it for the following use cases. For more information, see DependsOn
attribute .
CloudformationResource: AWS::SageMaker::ImageVersion
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var cfnImageVersion = new CfnImageVersion(this, "MyCfnImageVersion", new CfnImageVersionProps {
BaseImage = "baseImage",
ImageName = "imageName",
// the properties below are optional
Alias = "alias",
Aliases = new [] { "aliases" },
Horovod = false,
JobType = "jobType",
MlFramework = "mlFramework",
Processor = "processor",
ProgrammingLang = "programmingLang",
ReleaseNotes = "releaseNotes",
VendorGuidance = "vendorGuidance"
});
Synopsis
Constructors
CfnImageVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnImageVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnImageVersion(Construct, String, ICfnImageVersionProps) |
Properties
Alias | The alias of the image version. |
Aliases | List of aliases for the image version. |
AttrContainerImage | The URI of the container image version referenced by ImageVersion. |
AttrImageArn | The Amazon Resource Name (ARN) of the parent Image. |
AttrImageVersionArn | The Amazon Resource Name (ARN) of the image version. |
AttrVersion | The version of the image. |
BaseImage | The container image that the SageMaker image version is based on. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Horovod | Indicates Horovod compatibility. |
ImageName | The name of the parent image. |
JobType | Indicates SageMaker job type compatibility. |
MlFramework | The machine learning framework vended in the image version. |
Processor | Indicates CPU or GPU compatibility. |
ProgrammingLang | The supported programming language and its version. |
ReleaseNotes | The maintainer description of the image version. |
VendorGuidance | The availability of the image version specified by the maintainer. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnImageVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnImageVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnImageVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnImageVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnImageVersion(Construct, String, ICfnImageVersionProps)
public CfnImageVersion(Construct scope, string id, ICfnImageVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnImageVersionProps
Resource properties.
Properties
Alias
The alias of the image version.
public virtual string Alias { get; set; }
Property Value
System.String
Aliases
List of aliases for the image version.
public virtual string[] Aliases { get; set; }
Property Value
System.String[]
AttrContainerImage
The URI of the container image version referenced by ImageVersion.
public virtual string AttrContainerImage { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ContainerImage
AttrImageArn
The Amazon Resource Name (ARN) of the parent Image.
public virtual string AttrImageArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ImageArn
AttrImageVersionArn
The Amazon Resource Name (ARN) of the image version.
public virtual string AttrImageVersionArn { get; }
Property Value
System.String
Remarks
Type : String
Length Constraints : Maximum length of 256.
Pattern : ^arn:aws(-[\w]+):sagemaker:.+:[0-9]{12}:image-version/a-z0-9 /[0-9]+$
CloudformationAttribute: ImageVersionArn
AttrVersion
The version of the image.
public virtual double AttrVersion { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: Version
BaseImage
The container image that the SageMaker image version is based on.
public virtual string BaseImage { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Horovod
Indicates Horovod compatibility.
public virtual object Horovod { get; set; }
Property Value
System.Object
ImageName
The name of the parent image.
public virtual string ImageName { get; set; }
Property Value
System.String
JobType
Indicates SageMaker job type compatibility.
public virtual string JobType { get; set; }
Property Value
System.String
MlFramework
The machine learning framework vended in the image version.
public virtual string MlFramework { get; set; }
Property Value
System.String
Processor
Indicates CPU or GPU compatibility.
public virtual string Processor { get; set; }
Property Value
System.String
ProgrammingLang
The supported programming language and its version.
public virtual string ProgrammingLang { get; set; }
Property Value
System.String
ReleaseNotes
The maintainer description of the image version.
public virtual string ReleaseNotes { get; set; }
Property Value
System.String
VendorGuidance
The availability of the image version specified by the maintainer.
public virtual string VendorGuidance { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>