Class CfnImageProps

Properties for defining a CfnImage.

Inheritance

object

CfnImageProps

Implements

ICfnImageProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnImageProps : ICfnImageProps

Syntax (vb)

Public Class CfnImageProps Implements ICfnImageProps

Remarks

See: 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 cfnImageProps = 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

CfnImageProps()

Properties for defining a CfnImage.

Properties

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.

Constructors

CfnImageProps()

Properties for defining a CfnImage.

public CfnImageProps()

Remarks

See: 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 cfnImageProps = new CfnImageProps {
                 ImageName = "imageName",
                 ImageRoleArn = "imageRoleArn",

                 // the properties below are optional
                 ImageDescription = "imageDescription",
                 ImageDisplayName = "imageDisplayName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ImageDescription

The description of the image.

public string? ImageDescription { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedescription

ImageDisplayName

The display name of the image.

public string? ImageDisplayName { get; set; }

Property Value

string

Remarks

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

Pattern : ^\S(.*\S)?$

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedisplayname

ImageName

The name of the Image. Must be unique by region in your account.

public string ImageName { get; set; }

Property Value

string

Remarks

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

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

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

ImageRoleArn

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

public string ImageRoleArn { get; set; }

Property Value

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+=,.@-_/]+$

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagerolearn

Tags

A list of key-value pairs to apply to this resource.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Array Members : Minimum number of 0 items. Maximum number of 50 items.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-tags

Implements

ICfnImageProps