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

Interface CfnPartnerAppMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPartnerAppMixinProps.Jsii$Proxy

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

Properties for CfnPartnerAppPropsMixin.

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.*;
 CfnPartnerAppMixinProps cfnPartnerAppMixinProps = CfnPartnerAppMixinProps.builder()
         .applicationConfig(PartnerAppConfigProperty.builder()
                 .adminUsers(List.of("adminUsers"))
                 .arguments(Map.of(
                         "argumentsKey", "arguments"))
                 .build())
         .appVersion("appVersion")
         .authType("authType")
         .clientToken("clientToken")
         .enableAutoMinorVersionUpgrade(false)
         .enableIamSessionBasedIdentity(false)
         .executionRoleArn("executionRoleArn")
         .kmsKeyId("kmsKeyId")
         .maintenanceConfig(PartnerAppMaintenanceConfigProperty.builder()
                 .maintenanceWindowStart("maintenanceWindowStart")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tier("tier")
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPartnerAppMixinProps.Builder	builder()
default Object	getApplicationConfig()	Configuration settings for the Partner AI App.
default String	getAppVersion()	The version of the PartnerApp.
default String	getAuthType()	Defines the authentication type used for the Partner AI App.
default String	getClientToken()	Deprecated. this property has been deprecated
default Object	getEnableAutoMinorVersionUpgrade()	Enables automatic minor version upgrades for the PartnerApp.
default Object	getEnableIamSessionBasedIdentity()	Enables IAM Session based Identity for PartnerApp.
default String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the IAM role of the user.
default String	getKmsKeyId()	The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.
default Object	getMaintenanceConfig()	A collection of settings that specify the maintenance schedule for the PartnerApp.
default String	getName()	The name of the Partner AI App.
default List<CfnTag>	getTags()	A list of tags to apply to the PartnerApp.
default String	getTier()	Specifies the tier or level of the Partner AI App.
default String	getType()	Specifies the type of Partner AI App being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationConfig

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

Configuration settings for the Partner AI App.

Returns union: either IResolvable or CfnPartnerAppPropsMixin.PartnerAppConfigProperty

See Also:

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

getAppVersion

@Stability(Stable)
@Nullable
default String getAppVersion()

The version of the PartnerApp.

See Also:

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

getAuthType

@Stability(Stable)
@Nullable
default String getAuthType()

Defines the authentication type used for the Partner AI App.

See Also:

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

getClientToken

@Stability(Deprecated)
@Deprecated
@Nullable
default String getClientToken()

Deprecated.

this property has been deprecated

(deprecated) The client token for the PartnerApp.

See Also:

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

getEnableAutoMinorVersionUpgrade

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

Enables automatic minor version upgrades for the PartnerApp.

Returns union: either Boolean or IResolvable

See Also:

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

getEnableIamSessionBasedIdentity

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

Enables IAM Session based Identity for PartnerApp.

Returns union: either Boolean or IResolvable

See Also:

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

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

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

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

See Also:

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

getMaintenanceConfig

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

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

Returns union: either IResolvable or CfnPartnerAppPropsMixin.PartnerAppMaintenanceConfigProperty

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the Partner AI App.

This name must be unique within your account and region.

See Also:

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

getTags

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

A list of tags to apply to the PartnerApp.

See Also:

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

getTier

@Stability(Stable)
@Nullable
default String getTier()

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 .

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

Specifies the type of Partner AI App being created.

See Also:

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

builder

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

Returns:

a CfnPartnerAppMixinProps.Builder of CfnPartnerAppMixinProps