Package software.amazon.awscdk.services.sagemaker

Class CfnApp

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnApp
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.075Z") @Stability(Stable) public class CfnApp extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::App.

Creates a running app for the specified UserProfile. 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();

  • 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 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 Details

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

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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

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

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

    • setAppType

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

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

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

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

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

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