Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnAppMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.857Z")
@Stability(Stable)
public interface CfnAppMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnAppPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 CfnAppMixinProps cfnAppMixinProps = CfnAppMixinProps.builder()
         .appName("appName")
         .appType("appType")
         .domainId("domainId")
         .recoveryMode(false)
         .resourceSpec(ResourceSpecProperty.builder()
                 .instanceType("instanceType")
                 .lifecycleConfigArn("lifecycleConfigArn")
                 .sageMakerImageArn("sageMakerImageArn")
                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userProfileName("userProfileName")
         .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	CfnAppMixinProps.Builder	A builder for CfnAppMixinProps
static final class	CfnAppMixinProps.Jsii$Proxy	An implementation for CfnAppMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnAppMixinProps.Builder	builder()
default String	getAppName()	The name of the app.
default String	getAppType()	The type of app.
default 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.
default String	getUserProfileName()	The user profile name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppName

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

The domain ID.

See Also:

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

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

getUserProfileName

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

builder

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

Returns:

a CfnAppMixinProps.Builder of CfnAppMixinProps