Package software.amazon.awscdk.services.stepfunctions.tasks

Class SageMakerCreateModel.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateModel.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SageMakerCreateModel>
Enclosing class:
SageMakerCreateModel
@Stability(Stable) public static final class SageMakerCreateModel.Builder extends Object implements software.amazon.jsii.Builder<SageMakerCreateModel>
A fluent builder for SageMakerCreateModel.

  • Method Details

    • create

      @Stability(Stable) public static SageMakerCreateModel.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of SageMakerCreateModel.Builder.

    • comment

      @Stability(Stable) public SageMakerCreateModel.Builder comment(String comment)
      A comment describing this state.

      Default: No comment

      Parameters:
      comment - A comment describing this state. This parameter is required.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public SageMakerCreateModel.Builder queryLanguage(QueryLanguage queryLanguage)
      The name of the query language used by the state.

      If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

      Default: - JSONPath

      Parameters:
      queryLanguage - The name of the query language used by the state. This parameter is required.
      Returns:
      this

    • stateName

      @Stability(Stable) public SageMakerCreateModel.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public SageMakerCreateModel.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public SageMakerCreateModel.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public SageMakerCreateModel.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • integrationPattern

      @Stability(Stable) public SageMakerCreateModel.Builder integrationPattern(IntegrationPattern integrationPattern)
      AWS Step Functions integrates with services directly in the Amazon States Language.

      You can control these AWS services using service integration patterns.

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

      Parameters:
      integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
      Returns:
      this
      See Also:

    • taskTimeout

      @Stability(Stable) public SageMakerCreateModel.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public SageMakerCreateModel.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • assign

      @Stability(Stable) public SageMakerCreateModel.Builder assign(Map<String,? extends Object> assign)
      Workflow variables to store in this step.

      Using workflow variables, you can store data in a step and retrieve that data in future steps.

      Default: - Not assign variables

      Parameters:
      assign - Workflow variables to store in this step. This parameter is required.
      Returns:
      this
      See Also:

    • inputPath

      @Stability(Stable) public SageMakerCreateModel.Builder inputPath(String inputPath)
      JSONPath expression to select part of the state to be the input to this state.

      May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

      Default: $

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • outputPath

      @Stability(Stable) public SageMakerCreateModel.Builder outputPath(String outputPath)
      JSONPath expression to select part of the state to be the output to this state.

      May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

      Default: $

      Parameters:
      outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.
      Returns:
      this

    • outputs

      @Stability(Stable) public SageMakerCreateModel.Builder outputs(Object outputs)
      Used to specify and transform output from the state.

      When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

      Default: - $states.result or $states.errorOutput

      Parameters:
      outputs - Used to specify and transform output from the state. This parameter is required.
      Returns:
      this
      See Also:

    • resultPath

      @Stability(Stable) public SageMakerCreateModel.Builder resultPath(String resultPath)
      JSONPath expression to indicate where to inject the state's output.

      May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

      Default: $

      Parameters:
      resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public SageMakerCreateModel.Builder resultSelector(Map<String,? extends Object> resultSelector)
      The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

      You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

      Default: - None

      Parameters:
      resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
      Returns:
      this
      See Also:

    • modelName

      @Stability(Stable) public SageMakerCreateModel.Builder modelName(String modelName)
      The name of the new model.

      Parameters:
      modelName - The name of the new model. This parameter is required.
      Returns:
      this

    • primaryContainer

      @Stability(Stable) public SageMakerCreateModel.Builder primaryContainer(IContainerDefinition primaryContainer)
      The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

      Parameters:
      primaryContainer - The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. This parameter is required.
      Returns:
      this

    • containers

      @Stability(Stable) public SageMakerCreateModel.Builder containers(List<? extends IContainerDefinition> containers)
      Specifies the containers in the inference pipeline.

      Default: - None

      Parameters:
      containers - Specifies the containers in the inference pipeline. This parameter is required.
      Returns:
      this

    • enableNetworkIsolation

      @Stability(Stable) public SageMakerCreateModel.Builder enableNetworkIsolation(Boolean enableNetworkIsolation)
      Isolates the model container.

      No inbound or outbound network calls can be made to or from the model container.

      Default: false

      Parameters:
      enableNetworkIsolation - Isolates the model container. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public SageMakerCreateModel.Builder role(IRole role)
      An execution role that you can pass in a CreateModel API request.

      Default: - a role will be created.

      Parameters:
      role - An execution role that you can pass in a CreateModel API request. This parameter is required.
      Returns:
      this

    • subnetSelection

      @Stability(Stable) public SageMakerCreateModel.Builder subnetSelection(SubnetSelection subnetSelection)
      The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).

      Default: - Private Subnets are selected

      Parameters:
      subnetSelection - The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided). This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public SageMakerCreateModel.Builder tags(TaskInput tags)
      Tags to be applied to the model.

      Default: - No tags

      Parameters:
      tags - Tags to be applied to the model. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Stable) public SageMakerCreateModel.Builder vpc(IVpc vpc)
      The VPC that is accessible by the hosted model.

      Default: - None

      Parameters:
      vpc - The VPC that is accessible by the hosted model. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public SageMakerCreateModel build()
      Specified by:
      build in interface software.amazon.jsii.Builder<SageMakerCreateModel>
      Returns:
      a newly built instance of SageMakerCreateModel.