Package software.amazon.awssdk.services.sagemaker.model

Interface CreateAppRequest.Builder

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

  • Method Details

    • domainId

      CreateAppRequest.Builder domainId(String domainId)

      The domain ID.

      Parameters:
      domainId - The domain ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userProfileName

      CreateAppRequest.Builder userProfileName(String userProfileName)

      The user profile name. If this value is not set, then SpaceName must be set.

      Parameters:
      userProfileName - The user profile name. If this value is not set, then SpaceName must be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spaceName

      CreateAppRequest.Builder spaceName(String spaceName)

      The name of the space. If this value is not set, then UserProfileName must be set.

      Parameters:
      spaceName - The name of the space. If this value is not set, then UserProfileName must be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • appType

      CreateAppRequest.Builder appType(String appType)

      The type of app.

      Parameters:
      appType - The type of app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appType

      CreateAppRequest.Builder appType(AppType appType)

      The type of app.

      Parameters:
      appType - The type of app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appName

      CreateAppRequest.Builder appName(String appName)

      The name of the app.

      Parameters:
      appName - The name of the app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAppRequest.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

      CreateAppRequest.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

      CreateAppRequest.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:

    • resourceSpec

      CreateAppRequest.Builder resourceSpec(ResourceSpec resourceSpec)

      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

      Parameters:
      resourceSpec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

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

    • resourceSpec

      default CreateAppRequest.Builder resourceSpec(Consumer<ResourceSpec.Builder> resourceSpec)

      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

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

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

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

    • overrideConfiguration

      CreateAppRequest.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

      CreateAppRequest.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.