Package 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, IEnvironmentAware, IAppRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.282Z") @Stability(Stable) public class CfnApp extends CfnResource implements IInspectable, IAppRef, ITaggable
Creates a running app for the specified UserProfile.

This operation is automatically invoked by Amazon SageMaker AI 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
         .recoveryMode(false)
         .resourceSpec(ResourceSpecProperty.builder()
                 .instanceType("instanceType")
                 .lifecycleConfigArn("lifecycleConfigArn")
                 .sageMakerImageArn("sageMakerImageArn")
                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApp

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

    • CfnApp

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

    • CfnApp

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForApp

      @Stability(Stable) @NotNull public static String arnForApp(@NotNull IAppRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnApp

      @Stability(Stable) @NotNull public static Boolean isCfnApp(@NotNull Object x)
      Checks whether the given object is a CfnApp.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAppRef

      @Stability(Stable) @NotNull public AppReference getAppRef()
      A reference to a App resource.
      Specified by:
      getAppRef in interface IAppRef

    • getAttrAppArn

      @Stability(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 .

    • getAttrBuiltInLifecycleConfigArn

      @Stability(Stable) @NotNull public String getAttrBuiltInLifecycleConfigArn()
      The lifecycle configuration that runs before the default lifecycle configuration.

      It can override changes made in the default lifecycle configuration.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAppName

      @Stability(Stable) @NotNull public String getAppName()
      The name of the app.

    • setAppName

      @Stability(Stable) public void setAppName(@NotNull String value)
      The name of the app.

    • getAppType

      @Stability(Stable) @NotNull public String getAppType()
      The type of app.

    • setAppType

      @Stability(Stable) public void setAppType(@NotNull String value)
      The type of app.

    • getDomainId

      @Stability(Stable) @NotNull public String getDomainId()
      The domain ID.

    • setDomainId

      @Stability(Stable) public void setDomainId(@NotNull String value)
      The domain ID.

    • getUserProfileName

      @Stability(Stable) @NotNull public String getUserProfileName()
      The user profile name.

    • setUserProfileName

      @Stability(Stable) public void setUserProfileName(@NotNull String value)
      The user profile name.

    • getRecoveryMode

      @Stability(Stable) @Nullable public Object getRecoveryMode()
      Indicates whether the application is launched in recovery mode.

      Returns union: either Boolean or IResolvable

    • setRecoveryMode

      @Stability(Stable) public void setRecoveryMode(@Nullable Boolean value)
      Indicates whether the application is launched in recovery mode.

    • setRecoveryMode

      @Stability(Stable) public void setRecoveryMode(@Nullable IResolvable value)
      Indicates whether the application is launched in recovery mode.

    • getResourceSpec

      @Stability(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.

      Returns union: either IResolvable or CfnApp.ResourceSpecProperty

    • setResourceSpec

      @Stability(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.

    • setResourceSpec

      @Stability(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.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.