AWS CDK Reference

Appearance

v2.275.0

CfnPartnerAppProps Struct ​

Properties for defining a CfnPartnerApp.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 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 cfnPartnerAppProps: sagemaker.CfnPartnerAppProps = {
  authType: 'authType',
  executionRoleArn: 'executionRoleArn',
  name: 'name',
  tier: 'tier',
  type: 'type',

  // the properties below are optional
  applicationConfig: {
    adminUsers: ['adminUsers'],
    arguments: {
      argumentsKey: 'arguments',
    },
  },
  appVersion: 'appVersion',
  clientToken: 'clientToken',
  enableAutoMinorVersionUpgrade: false,
  enableIamSessionBasedIdentity: false,
  kmsKeyId: 'kmsKeyId',
  maintenanceConfig: {
    maintenanceWindowStart: 'maintenanceWindowStart',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

applicationConfigoptionalIResolvable | CfnPartnerApp.PartnerAppConfigPropertyapplication_configoptionaltyping.Union[IResolvable, PartnerAppConfigProperty]applicationConfigoptionalIResolvableApplicationConfigoptionalIResolvableApplicationConfigoptionalinterface{}#
Configuration settings for the Partner AI App.
appVersionoptionalstringapp_versionoptionalstrappVersionoptionalStringAppVersionoptionalstringAppVersionoptional*string#
The version of the PartnerApp.
authTypestringauth_typestrauthTypeStringAuthTypestringAuthType*stringrequired#
Defines the authentication type used for the Partner AI App.
clientTokenoptionalstringclient_tokenoptionalstrclientTokenoptionalStringClientTokenoptionalstringClientTokenoptional*stringdeprecated#
this property has been deprecated
enableAutoMinorVersionUpgradeoptionalboolean | IResolvableenable_auto_minor_version_upgradeoptionaltyping.Union[bool, IResolvable]enableAutoMinorVersionUpgradeoptionalBooleanEnableAutoMinorVersionUpgradeoptionalboolEnableAutoMinorVersionUpgradeoptionalinterface{}#
Enables automatic minor version upgrades for the PartnerApp.
enableIamSessionBasedIdentityoptionalboolean | IResolvableenable_iam_session_based_identityoptionaltyping.Union[bool, IResolvable]enableIamSessionBasedIdentityoptionalBooleanEnableIamSessionBasedIdentityoptionalboolEnableIamSessionBasedIdentityoptionalinterface{}#
Enables IAM Session based Identity for PartnerApp.
executionRoleArnstringexecution_role_arnstrexecutionRoleArnStringExecutionRoleArnstringExecutionRoleArn*stringrequired#
The Amazon Resource Name (ARN) of the IAM role of the user.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.
maintenanceConfigoptionalIResolvable | CfnPartnerApp.PartnerAppMaintenanceConfigPropertymaintenance_configoptionaltyping.Union[IResolvable, PartnerAppMaintenanceConfigProperty]maintenanceConfigoptionalIResolvableMaintenanceConfigoptionalIResolvableMaintenanceConfigoptionalinterface{}#
A collection of settings that specify the maintenance schedule for the PartnerApp.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the Partner AI App.

This name must be unique within your account and region.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to apply to the PartnerApp.
tierstringtierstrtierStringTierstringTier*stringrequired#
Specifies the tier or level of the Partner AI App.

The tier size impacts the speed and capabilities of the application. For more information, see Set up Partner AI Apps .

typestringtypestrtypeStringTypestringType*stringrequired#
Specifies the type of Partner AI App being created.