AWS CDK Reference

Appearance

v2.275.0

CfnAppProps Struct ​

Properties for defining a CfnApp.

Source
Generated code
Type last changed
v2.195.0 · 7 May 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnAppProps: sagemaker.CfnAppProps = {
  appName: 'appName',
  appType: 'appType',
  domainId: 'domainId',
  userProfileName: 'userProfileName',

  // the properties below are optional
  recoveryMode: false,
  resourceSpec: {
    instanceType: 'instanceType',
    lifecycleConfigArn: 'lifecycleConfigArn',
    sageMakerImageArn: 'sageMakerImageArn',
    sageMakerImageVersionArn: 'sageMakerImageVersionArn',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

appNamestringapp_namestrappNameStringAppNamestringAppName*stringrequired#
The name of the app.
appTypestringapp_typestrappTypeStringAppTypestringAppType*stringrequired#
The type of app.
domainIdstringdomain_idstrdomainIdStringDomainIdstringDomainId*stringrequired#
The domain ID.
recoveryModeoptionalboolean | IResolvablerecovery_modeoptionaltyping.Union[bool, IResolvable]recoveryModeoptionalBooleanRecoveryModeoptionalboolRecoveryModeoptionalinterface{}#
Indicates whether the application is launched in recovery mode.
resourceSpecoptionalIResolvable | CfnApp.ResourceSpecPropertyresource_specoptionaltyping.Union[IResolvable, ResourceSpecProperty]resourceSpecoptionalIResolvableResourceSpecoptionalIResolvableResourceSpecoptionalinterface{}#
Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.

For more information, see Tag .

userProfileNamestringuser_profile_namestruserProfileNameStringUserProfileNamestringUserProfileName*stringrequired#
The user profile name.