Class CfnImageVersion

A CloudFormation AWS::SageMaker::ImageVersion.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnImageVersion
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnImageVersion : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnImageVersion
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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

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

    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"
});

    Synopsis

    Constructors

    CfnImageVersion(Construct, String, ICfnImageVersionProps)

    Create a new AWS::SageMaker::ImageVersion.
    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

    Properties

    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
    ImageName

    The name of the parent image.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.
    RenderProperties(IDictionary<String, Object>)

    Constructors

    CfnImageVersion(Construct, String, ICfnImageVersionProps)

    Create a new AWS::SageMaker::ImageVersion.

    public CfnImageVersion(Construct scope, string id, ICfnImageVersionProps props)
    Parameters
    scope Construct
    • scope in which this resource is defined.
    id System.String
    • scoped id of the resource.
    props ICfnImageVersionProps
    • resource properties.

    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

    Properties

    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

    Remarks

    Length Constraints : Minimum length of 1. Maximum length of 255.

    Pattern : .*

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-baseimage

    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

    ImageName

    The name of the parent image.

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

    System.String

    Remarks

    Length Constraints : Minimum length of 1. Maximum length of 63.

    Pattern : ^a-zA-Z0-9{0,62}$

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-imagename

    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>

    Overrides

    Implements

    Constructs.IConstruct