AWS::SageMaker::PartnerApp - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::PartnerApp

The AWS::SageMaker::PartnerApp resource creates an Amazon SageMaker Partner AI App. For more information, see Partner AI Apps.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::PartnerApp",
  "Properties" : {
      "ApplicationConfig" : PartnerAppConfig,
      "AppVersion" : String,
      "AuthType" : String,
      "EnableAutoMinorVersionUpgrade" : Boolean,
      "EnableIamSessionBasedIdentity" : Boolean,
      "ExecutionRoleArn" : String,
      "KmsKeyId" : String,
      "MaintenanceConfig" : PartnerAppMaintenanceConfig,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "Tier" : String,
      "Type" : String
    }
}

YAML

Type: AWS::SageMaker::PartnerApp
Properties:
  ApplicationConfig: 
    PartnerAppConfig
  AppVersion: String
  AuthType: String
  EnableAutoMinorVersionUpgrade: Boolean
  EnableIamSessionBasedIdentity: Boolean
  ExecutionRoleArn: String
  KmsKeyId: String
  MaintenanceConfig: 
    PartnerAppMaintenanceConfig
  Name: String
  Tags: 
    - Tag
  Tier: String
  Type: String

Properties

ApplicationConfig

Configuration settings for the Partner AI App.

Required: No

Type: PartnerAppConfig

Update requires: No interruption

AppVersion

The version of the Partner AI App. This property allows you to specify a particular version of the application to deploy.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

AuthType

Defines the authentication type used for the Partner AI App.

Required: Yes

Type: String

Allowed values: IAM

Update requires: Replacement

EnableAutoMinorVersionUpgrade

When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default is FALSE.

Required: No

Type: Boolean

Update requires: No interruption

EnableIamSessionBasedIdentity

Enables IAM Session based Identity for PartnerApp.

Required: No

Type: Boolean

Update requires: No interruption

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role of the user.

Required: Yes

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

KmsKeyId

The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.

Required: No

Type: String

Pattern: .*

Maximum: 2048

Update requires: Replacement

MaintenanceConfig

A collection of settings that specify the maintenance schedule for the PartnerApp.

Required: No

Type: PartnerAppMaintenanceConfig

Update requires: No interruption

Name

The name of the Partner AI App. This name must be unique within your account and region.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9]+

Minimum: 1

Maximum: 256

Update requires: Replacement

Tags

A list of tags to apply to the PartnerApp.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Tier

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

Type

Specifies the type of Partner AI App being created.

Required: Yes

Type: String

Allowed values: lakera-guard | comet | deepchecks-llm-evaluation | fiddler

Update requires: Replacement

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the Partner AI App.

BaseUrl

The AppServerUrl based on app and account-info.

CurrentVersionEolDate

The end-of-life date for the current version of the Partner AI App.