Class CfnImage
Creates a custom SageMaker image.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnImage : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnImage
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html
CloudformationResource: AWS::SageMaker::Image
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 cfnImage = new CfnImage(this, "MyCfnImage", new CfnImageProps {
ImageName = "imageName",
ImageRoleArn = "imageRoleArn",
// the properties below are optional
ImageDescription = "imageDescription",
ImageDisplayName = "imageDisplayName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnImage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnImage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnImage(Construct, String, ICfnImageProps) |
Properties
AttrImageArn | The Amazon Resource Name (ARN) of the image. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ImageDescription | The description of the image. |
ImageDisplayName | The display name of the image. |
ImageName | The name of the Image. |
ImageRoleArn | The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnImage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnImage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnImage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnImage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnImage(Construct, String, ICfnImageProps)
public CfnImage(Construct scope, string id, ICfnImageProps 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 ICfnImageProps
Resource properties.
Properties
AttrImageArn
The Amazon Resource Name (ARN) of the image.
public virtual string AttrImageArn { get; }
Property Value
System.String
Remarks
Type : String
Length Constraints : Maximum length of 256.
Pattern : ^arn:aws(-[\w]+):sagemaker:.+:[0-9]{12}:image/a-z0-9$
CloudformationAttribute: ImageArn
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
ImageDescription
The description of the image.
public virtual string ImageDescription { get; set; }
Property Value
System.String
ImageDisplayName
The display name of the image.
public virtual string ImageDisplayName { get; set; }
Property Value
System.String
ImageName
The name of the Image.
public virtual string ImageName { get; set; }
Property Value
System.String
Remarks
Must be unique by region in your account.
ImageRoleArn
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
public virtual string ImageRoleArn { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>