software.amazon.awscdk.services.sagemaker

Class CfnImage

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.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.206Z")
 @Stability(value=Stable)
public class CfnImage
extends CfnResource
implements IInspectable

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

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

Field Summary

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

Modifier and Type	Method and Description
String	getAttrImageArn()
protected Map<String,Object>	getCfnProperties()
String	getImageDescription() `AWS::SageMaker::Image.ImageDescription`.
String	getImageDisplayName() `AWS::SageMaker::Image.ImageDisplayName`.
String	getImageName() `AWS::SageMaker::Image.ImageName`.
String	getImageRoleArn() `AWS::SageMaker::Image.ImageRoleArn`.
TagManager	getTags() `AWS::SageMaker::Image.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setImageDescription(String value) `AWS::SageMaker::Image.ImageDescription`.
void	setImageDisplayName(String value) `AWS::SageMaker::Image.ImageDisplayName`.
void	setImageName(String value) `AWS::SageMaker::Image.ImageName`.
void	setImageRoleArn(String value) `AWS::SageMaker::Image.ImageRoleArn`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::SageMaker::Image.Tags`.

getImageName

@Stability(value=Stable)
 @NotNull
public String getImageName()

`AWS::SageMaker::Image.ImageName`.

setImageName

@Stability(value=Stable)
public void setImageName(@NotNull
                                                  String value)

`AWS::SageMaker::Image.ImageName`.

getImageRoleArn

@Stability(value=Stable)
 @NotNull
public String getImageRoleArn()

`AWS::SageMaker::Image.ImageRoleArn`.

setImageRoleArn

@Stability(value=Stable)
public void setImageRoleArn(@NotNull
                                                     String value)

`AWS::SageMaker::Image.ImageRoleArn`.

getImageDescription

@Stability(value=Stable)
 @Nullable
public String getImageDescription()

`AWS::SageMaker::Image.ImageDescription`.

setImageDescription

@Stability(value=Stable)
public void setImageDescription(@Nullable
                                                         String value)

`AWS::SageMaker::Image.ImageDescription`.

getImageDisplayName

@Stability(value=Stable)
 @Nullable
public String getImageDisplayName()

`AWS::SageMaker::Image.ImageDisplayName`.

setImageDisplayName

@Stability(value=Stable)
public void setImageDisplayName(@Nullable
                                                         String value)

`AWS::SageMaker::Image.ImageDisplayName`.