Interface CfnImageProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.229Z") @Stability(Stable) public interface CfnImageProps extends software.amazon.jsii.JsiiSerializable
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();
 
  • Method Details

    • getImageName

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @Nullable default String getImageDescription()
      The description of the image.

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

      Pattern : .*

    • getImageDisplayName

      @Stability(Stable) @Nullable default String getImageDisplayName()
      The display name of the image.

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

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

    • getTags

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static CfnImageProps.Builder builder()
      Returns:
      a CfnImageProps.Builder of CfnImageProps