software.amazon.awscdk.services.sagemaker

Class CfnApp

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.CfnApp

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.853Z")
 @Stability(value=Stable)
public class CfnApp
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::App`.

Creates a running app for the specified UserProfile. Supported apps are JupyterServer and KernelGateway . This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

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.*;
 CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp")
         .appName("appName")
         .appType("appType")
         .domainId("domainId")
         .userProfileName("userProfileName")
         // the properties below are optional
         .resourceSpec(ResourceSpecProperty.builder()
                 .instanceType("instanceType")
                 .sageMakerImageArn("sageMakerImageArn")
                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApp.Builder A fluent builder for CfnApp.
static interface	CfnApp.ResourceSpecProperty Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

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

Method Summary

Modifier and Type	Method and Description
String	getAppName() The name of the app.
String	getAppType() The type of app.
String	getAttrAppArn() The Amazon Resource Name (ARN) of the app, such as `arn:aws:sagemaker:us-west-2:account-id:app/my-app-name` .
protected Map<String,Object>	getCfnProperties()
String	getDomainId() The domain ID.
Object	getResourceSpec() Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getUserProfileName() The user profile name.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppName(String value) The name of the app.
void	setAppType(String value) The type of app.
void	setDomainId(String value) The domain ID.
void	setResourceSpec(CfnApp.ResourceSpecProperty value) Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
void	setResourceSpec(IResolvable value) Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
void	setUserProfileName(String value) The user profile name.

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

CfnApp

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

CfnApp

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

CfnApp

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

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

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.

getAttrAppArn

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

The Amazon Resource Name (ARN) of the app, such as `arn:aws:sagemaker:us-west-2:account-id:app/my-app-name` .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getAppName

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

The name of the app.

setAppName

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

The name of the app.

getAppType

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

The type of app.

Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas

setAppType

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

The type of app.

Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas

getDomainId

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

The domain ID.

setDomainId

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

The domain ID.

getUserProfileName

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

The user profile name.

setUserProfileName

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

The user profile name.

getResourceSpec

@Stability(value=Stable)
 @Nullable
public Object getResourceSpec()

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

setResourceSpec

@Stability(value=Stable)
public void setResourceSpec(@Nullable
                                                     CfnApp.ResourceSpecProperty value)

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

setResourceSpec

@Stability(value=Stable)
public void setResourceSpec(@Nullable
                                                     IResolvable value)

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.