Class CfnImageVersion

Creates a version of the SageMaker image specified by ImageName .

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnImageVersion
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 <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

    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(Construct, string, ICfnImageVersionProps)

    Creates a version of the SageMaker image specified by ImageName .

    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

    Creates a version of the SageMaker image specified by ImageName .
    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>)

    Creates a version of the SageMaker image specified by ImageName .

    Constructors

    CfnImageVersion(Construct, string, ICfnImageVersionProps)

    Creates a version of the SageMaker image specified by ImageName .

    public CfnImageVersion(Construct scope, string id, ICfnImageVersionProps props)
    Parameters
    scope Construct

    Scope in which this resource is defined.

    id string

    Construct identifier for this resource (unique in its scope).

    props ICfnImageVersionProps

    Resource properties.

    Remarks

    The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

    You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

      CloudformationResource: AWS::SageMaker::ImageVersion

      ExampleMetadata: fixture=_generated

      Properties

      Alias

      The alias of the image version.

      public virtual string? Alias { get; set; }
      Property Value

      string

      Remarks

      The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

      You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

        CloudformationResource: AWS::SageMaker::ImageVersion

        ExampleMetadata: fixture=_generated

        Aliases

        List of aliases for the image version.

        public virtual string[]? Aliases { get; set; }
        Property Value

        string[]

        Remarks

        The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

        You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

          CloudformationResource: AWS::SageMaker::ImageVersion

          ExampleMetadata: fixture=_generated

          AttrContainerImage

          The URI of the container image version referenced by ImageVersion.

          public virtual string AttrContainerImage { get; }
          Property Value

          string

          Remarks

          CloudformationAttribute: ContainerImage

          AttrImageArn

          The Amazon Resource Name (ARN) of the parent Image.

          public virtual string AttrImageArn { get; }
          Property Value

          string

          Remarks

          CloudformationAttribute: ImageArn

          AttrImageVersionArn

          The Amazon Resource Name (ARN) of the image version.

          public virtual string AttrImageVersionArn { get; }
          Property Value

          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

          double

          Remarks

          CloudformationAttribute: Version

          BaseImage

          The container image that the SageMaker image version is based on.

          public virtual string BaseImage { get; set; }
          Property Value

          string

          Remarks

          The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

          You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

            CloudformationResource: AWS::SageMaker::ImageVersion

            ExampleMetadata: fixture=_generated

            CFN_RESOURCE_TYPE_NAME

            The CloudFormation resource type name for this resource class.

            public static string CFN_RESOURCE_TYPE_NAME { get; }
            Property Value

            string

            Remarks

            The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

            You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

              CloudformationResource: AWS::SageMaker::ImageVersion

              ExampleMetadata: fixture=_generated

              CfnProperties

              Creates a version of the SageMaker image specified by ImageName .

              protected override IDictionary<string, object> CfnProperties { get; }
              Property Value

              IDictionary<string, object>

              Overrides
              Remarks

              The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

              You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                CloudformationResource: AWS::SageMaker::ImageVersion

                ExampleMetadata: fixture=_generated

                Horovod

                Indicates Horovod compatibility.

                public virtual object? Horovod { get; set; }
                Property Value

                object

                Remarks

                The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                  CloudformationResource: AWS::SageMaker::ImageVersion

                  ExampleMetadata: fixture=_generated

                  ImageName

                  The name of the parent image.

                  public virtual string ImageName { get; set; }
                  Property Value

                  string

                  Remarks

                  The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                  You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                    CloudformationResource: AWS::SageMaker::ImageVersion

                    ExampleMetadata: fixture=_generated

                    JobType

                    Indicates SageMaker job type compatibility.

                    public virtual string? JobType { get; set; }
                    Property Value

                    string

                    Remarks

                    The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                    You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                      CloudformationResource: AWS::SageMaker::ImageVersion

                      ExampleMetadata: fixture=_generated

                      MlFramework

                      The machine learning framework vended in the image version.

                      public virtual string? MlFramework { get; set; }
                      Property Value

                      string

                      Remarks

                      The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                      You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                        CloudformationResource: AWS::SageMaker::ImageVersion

                        ExampleMetadata: fixture=_generated

                        Processor

                        Indicates CPU or GPU compatibility.

                        public virtual string? Processor { get; set; }
                        Property Value

                        string

                        Remarks

                        The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                        You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                          CloudformationResource: AWS::SageMaker::ImageVersion

                          ExampleMetadata: fixture=_generated

                          ProgrammingLang

                          The supported programming language and its version.

                          public virtual string? ProgrammingLang { get; set; }
                          Property Value

                          string

                          Remarks

                          The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                          You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                            CloudformationResource: AWS::SageMaker::ImageVersion

                            ExampleMetadata: fixture=_generated

                            ReleaseNotes

                            The maintainer description of the image version.

                            public virtual string? ReleaseNotes { get; set; }
                            Property Value

                            string

                            Remarks

                            The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                            You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                              CloudformationResource: AWS::SageMaker::ImageVersion

                              ExampleMetadata: fixture=_generated

                              VendorGuidance

                              The availability of the image version specified by the maintainer.

                              public virtual string? VendorGuidance { get; set; }
                              Property Value

                              string

                              Remarks

                              The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                              You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                                CloudformationResource: AWS::SageMaker::ImageVersion

                                ExampleMetadata: fixture=_generated

                                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.

                                Remarks

                                The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                                You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                                  CloudformationResource: AWS::SageMaker::ImageVersion

                                  ExampleMetadata: fixture=_generated

                                  RenderProperties(IDictionary<string, object>)

                                  Creates a version of the SageMaker image specified by ImageName .

                                  protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
                                  Parameters
                                  props IDictionary<string, object>
                                  Returns

                                  IDictionary<string, object>

                                  Overrides
                                  Remarks

                                  The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

                                  You can use the <code>DependsOn</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html"><code>DependsOn</code> attribute</a> .

                                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

                                    CloudformationResource: AWS::SageMaker::ImageVersion

                                    ExampleMetadata: fixture=_generated

                                    Implements