Interface CfnImageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnImageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:23.222Z")
@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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnImageProps
static final class
An implementation forCfnImageProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnImageProps.Builder
builder()
default String
The description of the image.default String
The display name of the image.The name of the Image.The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.getTags()
A list of key-value pairs to apply to this resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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}$
- See Also:
-
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+=,.@\-_/]+$
- See Also:
-
getImageDescription
The description of the image.- See Also:
-
getImageDisplayName
The display name of the image.Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- See Also:
-
getTags
A list of key-value pairs to apply to this resource.Array Members : Minimum number of 0 items. Maximum number of 50 items.
- See Also:
-
builder
- Returns:
- a
CfnImageProps.Builder
ofCfnImageProps
-