Package software.amazon.awscdk.services.sagemaker

Class CfnPartnerApp

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnPartnerApp
All Implemented Interfaces:
IInspectable, ITaggableV2, IPartnerAppRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:48.231Z") @Stability(Stable) public class CfnPartnerApp extends CfnResource implements IInspectable, IPartnerAppRef, ITaggableV2
The AWS::SageMaker::PartnerApp resource creates an Amazon SageMaker Partner AI App.

For more information, see Partner AI Apps .

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.*;
 CfnPartnerApp cfnPartnerApp = CfnPartnerApp.Builder.create(this, "MyCfnPartnerApp")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPartnerApp

      protected CfnPartnerApp(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPartnerApp

      protected CfnPartnerApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPartnerApp

      @Stability(Stable) public CfnPartnerApp(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPartnerAppProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the created PartnerApp.

    • getAttrBaseUrl

      @Stability(Stable) @NotNull public String getAttrBaseUrl()
      The AppServerUrl based on app and account-info.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPartnerAppRef

      @Stability(Stable) @NotNull public PartnerAppReference getPartnerAppRef()
      A reference to a PartnerApp resource.
      Specified by:
      getPartnerAppRef in interface IPartnerAppRef

    • getAuthType

      @Stability(Stable) @NotNull public String getAuthType()
      Defines the authentication type used for the Partner AI App.

    • setAuthType

      @Stability(Stable) public void setAuthType(@NotNull String value)
      Defines the authentication type used for the Partner AI App.

    • getExecutionRoleArn

      @Stability(Stable) @NotNull public String getExecutionRoleArn()
      The Amazon Resource Name (ARN) of the IAM role of the user.

    • setExecutionRoleArn

      @Stability(Stable) public void setExecutionRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role of the user.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the Partner AI App.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the Partner AI App.

    • getTier

      @Stability(Stable) @NotNull public String getTier()
      Specifies the tier or level of the Partner AI App.

    • setTier

      @Stability(Stable) public void setTier(@NotNull String value)
      Specifies the tier or level of the Partner AI App.

    • getType

      @Stability(Stable) @NotNull public String getType()
      Specifies the type of Partner AI App being created.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      Specifies the type of Partner AI App being created.

    • getApplicationConfig

      @Stability(Stable) @Nullable public Object getApplicationConfig()
      Configuration settings for the Partner AI App.

      Returns union: either IResolvable or CfnPartnerApp.PartnerAppConfigProperty

    • setApplicationConfig

      @Stability(Stable) public void setApplicationConfig(@Nullable IResolvable value)
      Configuration settings for the Partner AI App.

    • setApplicationConfig

      @Stability(Stable) public void setApplicationConfig(@Nullable CfnPartnerApp.PartnerAppConfigProperty value)
      Configuration settings for the Partner AI App.

    • getClientToken

      @Stability(Deprecated) @Deprecated @Nullable public String getClientToken()
      Deprecated.
      this property has been deprecated
      (deprecated) The client token for the PartnerApp.

    • setClientToken

      @Stability(Deprecated) @Deprecated public void setClientToken(@Nullable String value)
      Deprecated.
      this property has been deprecated
      (deprecated) The client token for the PartnerApp.

    • getEnableIamSessionBasedIdentity

      @Stability(Stable) @Nullable public Object getEnableIamSessionBasedIdentity()
      Enables IAM Session based Identity for PartnerApp.

      Returns union: either Boolean or IResolvable

    • setEnableIamSessionBasedIdentity

      @Stability(Stable) public void setEnableIamSessionBasedIdentity(@Nullable Boolean value)
      Enables IAM Session based Identity for PartnerApp.

    • setEnableIamSessionBasedIdentity

      @Stability(Stable) public void setEnableIamSessionBasedIdentity(@Nullable IResolvable value)
      Enables IAM Session based Identity for PartnerApp.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.

    • getMaintenanceConfig

      @Stability(Stable) @Nullable public Object getMaintenanceConfig()
      A collection of settings that specify the maintenance schedule for the PartnerApp.

      Returns union: either IResolvable or CfnPartnerApp.PartnerAppMaintenanceConfigProperty

    • setMaintenanceConfig

      @Stability(Stable) public void setMaintenanceConfig(@Nullable IResolvable value)
      A collection of settings that specify the maintenance schedule for the PartnerApp.

    • setMaintenanceConfig

      @Stability(Stable) public void setMaintenanceConfig(@Nullable CfnPartnerApp.PartnerAppMaintenanceConfigProperty value)
      A collection of settings that specify the maintenance schedule for the PartnerApp.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to apply to the PartnerApp.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to apply to the PartnerApp.