software.amazon.awscdk.services.sagemaker

Interface CfnImageProps

All Known Implementing Classes:

CfnImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:00.227Z")
public interface CfnImageProps

Properties for defining a `CfnImage`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnImageProps cfnImageProps = CfnImageProps.builder()
         .imageName("imageName")
         .imageRoleArn("imageRoleArn")
         // the properties below are optional
         .imageDescription("imageDescription")
         .imageDisplayName("imageDisplayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnImageProps.Builder A builder for CfnImageProps
static class	CfnImageProps.Jsii$Proxy An implementation for CfnImageProps

Method Summary

Modifier and Type	Method and Description
static CfnImageProps.Builder	builder()
default java.lang.String	getImageDescription() The description of the image.
default java.lang.String	getImageDisplayName() The display name of the image.
java.lang.String	getImageName() The name of the Image.
java.lang.String	getImageRoleArn() The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
default java.util.List<CfnTag>	getTags() A list of key-value pairs to apply to this resource.

Method Detail

getImageName

java.lang.String getImageName()

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

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

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

getImageRoleArn

java.lang.String getImageRoleArn()

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

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

getImageDescription

default java.lang.String getImageDescription()

The description of the image.

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

Pattern : .*

getImageDisplayName

default java.lang.String getImageDisplayName()

The display name of the image.

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

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

getTags

default java.util.List<CfnTag> getTags()

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

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

builder

static CfnImageProps.Builder builder()

Returns:

a CfnImageProps.Builder of CfnImageProps