Class CfnImage
A CloudFormation AWS::SageMaker::Image
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnImage : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnImage
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image .
CloudformationResource: AWS::SageMaker::Image
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.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 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(Construct, String, ICfnImageProps) | Create a new |
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 |
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. 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. |
Tags | 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(Construct, String, ICfnImageProps)
Create a new AWS::SageMaker::Image
.
public CfnImage(Construct scope, string id, ICfnImageProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnImageProps
- resource properties.
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
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
Remarks
Length Constraints : Minimum length of 1. Maximum length of 512.
Pattern : .*
ImageDisplayName
The display name of the image.
public virtual string ImageDisplayName { get; set; }
Property Value
System.String
Remarks
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern : ^\S(.*\S)?$
ImageName
The name of the Image. Must be unique by region in your account.
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}$
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
Remarks
Length Constraints : Minimum length of 20. Maximum length of 2048.
Pattern : ^arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+$
Tags
A list of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Array Members : Minimum number of 0 items. Maximum number of 50 items.
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>