Interface CreatePartnerAppRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePartnerAppRequest.Builder,CreatePartnerAppRequest>, SageMakerRequest.Builder, SdkBuilder<CreatePartnerAppRequest.Builder,CreatePartnerAppRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePartnerAppRequest
@Mutable @NotThreadSafe public static interface CreatePartnerAppRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreatePartnerAppRequest.Builder,CreatePartnerAppRequest>

  • Method Details

    • name

      CreatePartnerAppRequest.Builder name(String name)

      The name to give the SageMaker Partner AI App.

      Parameters:
      name - The name to give the SageMaker Partner AI App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreatePartnerAppRequest.Builder type(String type)

      The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

      Parameters:
      type - The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreatePartnerAppRequest.Builder type(PartnerAppType type)

      The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

      Parameters:
      type - The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRoleArn

      CreatePartnerAppRequest.Builder executionRoleArn(String executionRoleArn)

      The ARN of the IAM role that the partner application uses.

      Parameters:
      executionRoleArn - The ARN of the IAM role that the partner application uses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreatePartnerAppRequest.Builder kmsKeyId(String kmsKeyId)

      SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.

      Parameters:
      kmsKeyId - SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maintenanceConfig

      CreatePartnerAppRequest.Builder maintenanceConfig(PartnerAppMaintenanceConfig maintenanceConfig)

      Maintenance configuration settings for the SageMaker Partner AI App.

      Parameters:
      maintenanceConfig - Maintenance configuration settings for the SageMaker Partner AI App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maintenanceConfig

      default CreatePartnerAppRequest.Builder maintenanceConfig(Consumer<PartnerAppMaintenanceConfig.Builder> maintenanceConfig)

      Maintenance configuration settings for the SageMaker Partner AI App.

      This is a convenience method that creates an instance of the PartnerAppMaintenanceConfig.Builder avoiding the need to create one manually via PartnerAppMaintenanceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maintenanceConfig(PartnerAppMaintenanceConfig).

      Parameters:
      maintenanceConfig - a consumer that will call methods on PartnerAppMaintenanceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tier

      CreatePartnerAppRequest.Builder tier(String tier)

      Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

      Parameters:
      tier - Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationConfig

      CreatePartnerAppRequest.Builder applicationConfig(PartnerAppConfig applicationConfig)

      Configuration settings for the SageMaker Partner AI App.

      Parameters:
      applicationConfig - Configuration settings for the SageMaker Partner AI App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationConfig

      default CreatePartnerAppRequest.Builder applicationConfig(Consumer<PartnerAppConfig.Builder> applicationConfig)

      Configuration settings for the SageMaker Partner AI App.

      This is a convenience method that creates an instance of the PartnerAppConfig.Builder avoiding the need to create one manually via PartnerAppConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to applicationConfig(PartnerAppConfig).

      Parameters:
      applicationConfig - a consumer that will call methods on PartnerAppConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idcConfig

      CreatePartnerAppRequest.Builder idcConfig(IdcConfigInput idcConfig)

      Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App. Specify this parameter when AuthType is IDC. Apps that use IAM authorization don't use this parameter.

      Parameters:
      idcConfig - Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App. Specify this parameter when AuthType is IDC. Apps that use IAM authorization don't use this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idcConfig

      default CreatePartnerAppRequest.Builder idcConfig(Consumer<IdcConfigInput.Builder> idcConfig)

      Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App. Specify this parameter when AuthType is IDC. Apps that use IAM authorization don't use this parameter.

      This is a convenience method that creates an instance of the IdcConfigInput.Builder avoiding the need to create one manually via IdcConfigInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to idcConfig(IdcConfigInput).

      Parameters:
      idcConfig - a consumer that will call methods on IdcConfigInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authType

      CreatePartnerAppRequest.Builder authType(String authType)

      The authorization type that users use to access the SageMaker Partner AI App. Valid values:

      • IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.

      • IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use in IdcConfig.

      Parameters:
      authType - The authorization type that users use to access the SageMaker Partner AI App. Valid values:

      • IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.

      • IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use in IdcConfig.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authType

      CreatePartnerAppRequest.Builder authType(PartnerAppAuthType authType)

      The authorization type that users use to access the SageMaker Partner AI App. Valid values:

      • IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.

      • IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use in IdcConfig.

      Parameters:
      authType - The authorization type that users use to access the SageMaker Partner AI App. Valid values:

      • IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.

      • IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use in IdcConfig.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableIamSessionBasedIdentity

      CreatePartnerAppRequest.Builder enableIamSessionBasedIdentity(Boolean enableIamSessionBasedIdentity)

      When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

      Parameters:
      enableIamSessionBasedIdentity - When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableAutoMinorVersionUpgrade

      CreatePartnerAppRequest.Builder enableAutoMinorVersionUpgrade(Boolean 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreatePartnerAppRequest.Builder clientToken(String clientToken)

      A unique token that guarantees that the call to this API is idempotent.

      Parameters:
      clientToken - A unique token that guarantees that the call to this API is idempotent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePartnerAppRequest.Builder tags(Collection<Tag> tags)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Parameters:
      tags - Each tag consists of a key and an optional value. Tag keys must be unique per resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePartnerAppRequest.Builder tags(Tag... tags)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Parameters:
      tags - Each tag consists of a key and an optional value. Tag keys must be unique per resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePartnerAppRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreatePartnerAppRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePartnerAppRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.