Package software.amazon.awscdk.services.sagemaker

Interface CfnAppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:17.288Z")
@Stability(Stable)
public interface CfnAppProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApp.

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.*;
 CfnAppProps cfnAppProps = CfnAppProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAppProps.Builder	A builder for CfnAppProps
static final class	CfnAppProps.Jsii$Proxy	An implementation for CfnAppProps

Method Summary

Modifier and Type	Method	Description
static CfnAppProps.Builder	builder()
String	getAppName()	The name of the app.
String	getAppType()	The type of app.
String	getDomainId()	The domain ID.
default Object	getRecoveryMode()	Indicates whether the application is launched in recovery mode.
default Object	getResourceSpec()	Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getUserProfileName()	The user profile name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppName

@Stability(Stable)
@NotNull
String getAppName()

The name of the app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-appname

getAppType

@Stability(Stable)
@NotNull
String getAppType()

The type of app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-apptype

getDomainId

@Stability(Stable)
@NotNull
String getDomainId()

The domain ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-domainid

getUserProfileName

@Stability(Stable)
@NotNull
String getUserProfileName()

The user profile name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-userprofilename

getRecoveryMode

@Stability(Stable)
@Nullable
default Object getRecoveryMode()

Indicates whether the application is launched in recovery mode.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-recoverymode

getResourceSpec

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-resourcespec

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-tags

builder

@Stability(Stable)
static CfnAppProps.Builder builder()

Returns:

a CfnAppProps.Builder of CfnAppProps