Package software.amazon.awscdk.services.sagemaker

Interface CfnPartnerAppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPartnerAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-20T13:49:25.180Z")
@Stability(Stable)
public interface CfnPartnerAppProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPartnerApp.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnPartnerAppProps cfnPartnerAppProps = CfnPartnerAppProps.builder()
         .authType("authType")
         .executionRoleArn("executionRoleArn")
         .name("name")
         .tier("tier")
         .type("type")
         // the properties below are optional
         .applicationConfig(PartnerAppConfigProperty.builder()
                 .adminUsers(List.of("adminUsers"))
                 .arguments(Map.of(
                         "argumentsKey", "arguments"))
                 .build())
         .clientToken("clientToken")
         .enableIamSessionBasedIdentity(false)
         .kmsKeyId("kmsKeyId")
         .maintenanceConfig(PartnerAppMaintenanceConfigProperty.builder()
                 .maintenanceWindowStart("maintenanceWindowStart")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnPartnerAppProps.Builder	A builder for CfnPartnerAppProps
static final class	CfnPartnerAppProps.Jsii$Proxy	An implementation for CfnPartnerAppProps

Method Summary

Modifier and Type	Method	Description
static CfnPartnerAppProps.Builder	builder()
default Object	getApplicationConfig()	Configuration settings for the Partner AI App.
String	getAuthType()	Defines the authentication type used for the Partner AI App.
default String	getClientToken()	Deprecated. this property has been deprecated
default Object	getEnableIamSessionBasedIdentity()	Enables IAM Session based Identity for PartnerApp.
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.
String	getName()	The name of the Partner AI App.
default List<CfnTag>	getTags()	A list of tags to apply to the PartnerApp.
String	getTier()	Specifies the tier or level of the Partner AI App.
String	getType()	Specifies the type of Partner AI App being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

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

getExecutionRoleArn

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

getName

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

getTier

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

getApplicationConfig

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

Configuration settings for the Partner AI App.

See Also:

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

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

getEnableIamSessionBasedIdentity

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

Enables IAM Session based Identity for PartnerApp.

See Also:

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

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.

See Also:

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

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

builder

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

Returns:

a CfnPartnerAppProps.Builder of CfnPartnerAppProps