CfnImageVersion (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.CfnImageVersion

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.901Z")
 @Stability(value=Stable)
public class CfnImageVersion
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::SageMaker::ImageVersion`.
Creates a version of the SageMaker image specified by ImageName . The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .
You can use the DependsOn attribute to specify that the creation of a specific resource follows another. You can use it for the following use cases. For more information, see DependsOn attribute .
1. DependsOn can be used to establish a parent/child relationship between ImageVersion and Image where the ImageVersion DependsOn the Image .
2. DependsOn can be used to establish order among ImageVersion s within the same Image namespace. For example, if ImageVersionB DependsOn ImageVersionA and both share the same parent Image , then ImageVersionA is version N and ImageVersionB is N+1.
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.*;
 CfnImageVersion cfnImageVersion = CfnImageVersion.Builder.create(this, "MyCfnImageVersion")
         .baseImage("baseImage")
         .imageName("imageName")
         .build();
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnImageVersion.Builder
A fluent builder for CfnImageVersion.
- 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`	`CfnImageVersion.Builder` A fluent builder for `CfnImageVersion`.

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
	`CfnImageVersion(software.constructs.Construct scope, String id, CfnImageVersionProps props)` Create a new `AWS::SageMaker::ImageVersion`.
`protected`	`CfnImageVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnImageVersion(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrContainerImage()` The URI of the container image version referenced by ImageVersion.
`String`	`getAttrImageArn()` The Amazon Resource Name (ARN) of the parent Image.
`String`	`getAttrImageVersionArn()` The Amazon Resource Name (ARN) of the image version.
`Number`	`getAttrVersion()` The version of the image.
`String`	`getBaseImage()` The container image that the SageMaker image version is based on.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getImageName()` The name of the parent image.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setBaseImage(String value)` The container image that the SageMaker image version is based on.
`void`	`setImageName(String value)` The name of the parent image.

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

CfnImageVersion

protected CfnImageVersion(software.amazon.jsii.JsiiObjectRef objRef)

CfnImageVersion

protected CfnImageVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnImageVersion

@Stability(value=Stable)
public CfnImageVersion(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnImageVersionProps props)

Create a new `AWS::SageMaker::ImageVersion`.

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.
- getAttrContainerImage
```
@Stability(value=Stable)
 @NotNull
public String getAttrContainerImage()
```
  The URI of the container image version referenced by ImageVersion.
- getAttrImageArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrImageArn()
```
  The Amazon Resource Name (ARN) of the parent Image.
- getAttrImageVersionArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrImageVersionArn()
```
  The Amazon Resource Name (ARN) of the image version.
  Type : String
  Length Constraints : Maximum length of 256.
  Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])* /[0-9]+$
- getAttrVersion
```
@Stability(value=Stable)
 @NotNull
public Number getAttrVersion()
```
  The version of the image.
- getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
  Overrides:
  
  getCfnProperties in class CfnResource
- getBaseImage
```
@Stability(value=Stable)
 @NotNull
public String getBaseImage()
```
  The container image that the SageMaker image version is based on.
  Length Constraints : Minimum length of 1. Maximum length of 255.
  Pattern : .*
- setBaseImage
```
@Stability(value=Stable)
public void setBaseImage(@NotNull
                                                  String value)
```
  The container image that the SageMaker image version is based on.
  Length Constraints : Minimum length of 1. Maximum length of 255.
  Pattern : .*
- getImageName
```
@Stability(value=Stable)
 @NotNull
public String getImageName()
```
  The name of the parent image.
  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 parent image.
  Length Constraints : Minimum length of 1. Maximum length of 63.
  Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Class CfnImageVersion

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

CfnImageVersion

CfnImageVersion

CfnImageVersion

Method Detail

inspect

renderProperties

getAttrContainerImage

getAttrImageArn

getAttrImageVersionArn

getAttrVersion

getCfnProperties

getBaseImage

setBaseImage

getImageName

setImageName