CfnImage (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.sagemaker.CfnImage

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.900Z")
 @Stability(value=Stable)
public class CfnImage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::Image`.

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 .

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.*;
 CfnImage cfnImage = CfnImage.Builder.create(this, "MyCfnImage")
         .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 Class and Description

static class CfnImage.Builder
A fluent builder for CfnImage.
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.constructs.IConstruct
  software.constructs.IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnImage.Builder` A fluent builder for `CfnImage`.

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnImage(software.constructs.Construct scope, String id, CfnImageProps props)` Create a new `AWS::SageMaker::Image`.
`protected`	`CfnImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnImage(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrImageArn()` The Amazon Resource Name (ARN) of the image.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getImageDescription()` The description of the image.
`String`	`getImageDisplayName()` The display name of the image.
`String`	`getImageName()` The name of the Image.
`String`	`getImageRoleArn()` The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
`TagManager`	`getTags()` A list of key-value pairs to apply to this resource.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setImageDescription(String value)` The description of the image.
`void`	`setImageDisplayName(String value)` The display name of the image.
`void`	`setImageName(String value)` The name of the Image.
`void`	`setImageRoleArn(String value)` The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnImage
```
protected CfnImage(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnImage
```
protected CfnImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnImage
```
@Stability(value=Stable)
public CfnImage(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnImageProps props)
```
    Create a new `AWS::SageMaker::Image`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrImageArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrImageArn()
```
    The Amazon Resource Name (ARN) of the image.
    Type : String
    Length Constraints : Maximum length of 256.
    Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    A list of key-value pairs to apply to this resource.
    Array Members : Minimum number of 0 items. Maximum number of 50 items.
  - getImageName
```
@Stability(value=Stable)
 @NotNull
public 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}$
  - setImageName
```
@Stability(value=Stable)
public void setImageName(@NotNull
                                                  String value)
```
    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(value=Stable)
 @NotNull
public 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+=,.@\-_/]+$
  - setImageRoleArn
```
@Stability(value=Stable)
public void setImageRoleArn(@NotNull
                                                     String value)
```
    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(value=Stable)
 @Nullable
public String getImageDescription()
```
    The description of the image.
    Length Constraints : Minimum length of 1. Maximum length of 512.
    Pattern : .*
  - setImageDescription
```
@Stability(value=Stable)
public void setImageDescription(@Nullable
                                                         String value)
```
    The description of the image.
    Length Constraints : Minimum length of 1. Maximum length of 512.
    Pattern : .*
  - getImageDisplayName
```
@Stability(value=Stable)
 @Nullable
public String getImageDisplayName()
```
    The display name of the image.
    Length Constraints : Minimum length of 1. Maximum length of 128.
    Pattern : ^\S(.*\S)?$
  - setImageDisplayName
```
@Stability(value=Stable)
public void setImageDisplayName(@Nullable
                                                         String value)
```
    The display name of the image.
    Length Constraints : Minimum length of 1. Maximum length of 128.
    Pattern : ^\S(.*\S)?$

Class CfnImage

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnImage

CfnImage

CfnImage

Method Detail

inspect

renderProperties

getAttrImageArn

getCfnProperties

getTags

getImageName

setImageName

getImageRoleArn

setImageRoleArn

getImageDescription

setImageDescription

getImageDisplayName

setImageDisplayName