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.104.0 (build e79254c)",
           date="2025-01-04T09:06:30.553Z")
@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)
         .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()	A collection of configuration settings for the PartnerApp.
String	getAuthType()	The Auth type of PartnerApp.
default String	getClientToken()	Deprecated. this property has been deprecated
default Object	getEnableIamSessionBasedIdentity()	Enables IAM Session based Identity for PartnerApp.
String	getExecutionRoleArn()	The execution role for the user.
default Object	getMaintenanceConfig()	A collection of settings that specify the maintenance schedule for the PartnerApp.
String	getName()	The name of the SageMaker Partner AI App.
default List<CfnTag>	getTags()	A list of tags to apply to the PartnerApp.
String	getTier()	The tier of the PartnerApp.
String	getType()	The type of SageMaker Partner AI App to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@NotNull
String getAuthType()

The Auth type of PartnerApp.

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 execution role for 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 SageMaker Partner AI App.

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()

The tier of the PartnerApp.

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()

The type of SageMaker Partner AI App to create.

Must be one of the following: lakera-guard , comet , deepchecks-llm-evaluation , or fiddler .

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()

A collection of configuration settings for the PartnerApp.

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

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