java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy

All Implemented Interfaces:: AssignableStateOptions, JsonPathCommonOptions, StateBaseProps, SageMakerCreateTrainingJobJsonPathProps, TaskStateBaseOptions, TaskStateJsonPathBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: SageMakerCreateTrainingJobJsonPathProps

@Stability(Stable) @Internal public static final class SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SageMakerCreateTrainingJobJsonPathProps

An implementation for SageMakerCreateTrainingJobJsonPathProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateTrainingJobJsonPathProps
SageMakerCreateTrainingJobJsonPathProps.Builder, SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(SageMakerCreateTrainingJobJsonPathProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the SageMakerCreateTrainingJobJsonPathProps.Builder.

protected

Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final AlgorithmSpecification

getAlgorithmSpecification()

Identifies the training algorithm to use.

final Map<String,Object>

getAssign()

Workflow variables to store in this step.

final String

getComment()

A comment describing this state.

final Credentials

getCredentials()

Credentials for an IAM Role that the State Machine assumes for executing the task.

final Boolean

getEnableNetworkIsolation()

Isolates the training container.

final Map<String,String>

getEnvironment()

Environment variables to set in the Docker container.

final Duration

getHeartbeat()

(deprecated) Timeout for the heartbeat.

final Timeout

getHeartbeatTimeout()

Timeout for the heartbeat.

final Map<String,Object>

getHyperparameters()

Algorithm-specific parameters that influence the quality of the model.

final List<Channel>

getInputDataConfig()

Describes the various datasets (e.g.

final String

getInputPath()

JSONPath expression to select part of the state to be the input to this state.

final IntegrationPattern

getIntegrationPattern()

AWS Step Functions integrates with services directly in the Amazon States Language.

final OutputDataConfig

getOutputDataConfig()

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.

final String

getOutputPath()

JSONPath expression to select part of the state to be the output to this state.

final QueryLanguage

getQueryLanguage()

The name of the query language used by the state.

final ResourceConfig

getResourceConfig()

Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.

final String

getResultPath()

JSONPath expression to indicate where to inject the state's output.

final Map<String,Object>

getResultSelector()

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

final IRole

getRole()

Role for the Training Job.

final String

getStateName()

Optional name for this state.

final StoppingCondition

getStoppingCondition()

Sets a time limit for training.

final Map<String,String>

getTags()

Tags to be applied to the train job.

final Timeout

getTaskTimeout()

Timeout for the task.

final Duration

getTimeout()

(deprecated) Timeout for the task.

final String

getTrainingJobName()

Training Job Name.

final VpcConfig

getVpcConfig()

Specifies the VPC that you want your training job to connect to.

final int

hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Jsii$Proxy
  
  protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
  
  Constructor that initializes the object based on values retrieved from the JsiiObject.
  
  Parameters:
  
  objRef - Reference to the JSII managed object.
- Jsii$Proxy
  
  protected Jsii$Proxy(SageMakerCreateTrainingJobJsonPathProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the SageMakerCreateTrainingJobJsonPathProps.Builder.
Method Details
- getAlgorithmSpecification
  
  public final AlgorithmSpecification getAlgorithmSpecification()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Identifies the training algorithm to use.
  
  Specified by:
  
  getAlgorithmSpecification in interface SageMakerCreateTrainingJobJsonPathProps
- getOutputDataConfig
  
  public final OutputDataConfig getOutputDataConfig()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.
  
  Specified by:
  
  getOutputDataConfig in interface SageMakerCreateTrainingJobJsonPathProps
- getTrainingJobName
  
  public final String getTrainingJobName()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Training Job Name.
  
  Specified by:
  
  getTrainingJobName in interface SageMakerCreateTrainingJobJsonPathProps
- getEnableNetworkIsolation
  
  public final Boolean getEnableNetworkIsolation()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Isolates the training container.
  No inbound or outbound network calls can be made to or from the training container.
  Default: false
  
  Specified by:
  
  getEnableNetworkIsolation in interface SageMakerCreateTrainingJobJsonPathProps
- getEnvironment
  
  public final Map<String,String> getEnvironment()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Environment variables to set in the Docker container.
  Default: - No environment variables
  
  Specified by:
  
  getEnvironment in interface SageMakerCreateTrainingJobJsonPathProps
- getHyperparameters
  
  public final Map<String,Object> getHyperparameters()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Algorithm-specific parameters that influence the quality of the model.
  Set hyperparameters before you start the learning process. For a list of hyperparameters provided by Amazon SageMaker
  Default: - No hyperparameters
  Specified by:
  
  getHyperparameters in interface SageMakerCreateTrainingJobJsonPathProps
  
  See Also:
  
  https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html
- getInputDataConfig
  
  public final List<Channel> getInputDataConfig()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored.
  Default: - No inputDataConfig
  
  Specified by:
  
  getInputDataConfig in interface SageMakerCreateTrainingJobJsonPathProps
- getResourceConfig
  
  public final ResourceConfig getResourceConfig()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.
  Default: - 1 instance of EC2 `M4.XLarge` with `10GB` volume
  
  Specified by:
  
  getResourceConfig in interface SageMakerCreateTrainingJobJsonPathProps
- getRole
  
  public final IRole getRole()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Role for the Training Job.
  The role must be granted all necessary permissions for the SageMaker training job to be able to operate.
  See https://docs.aws.amazon.com/fr_fr/sagemaker/latest/dg/sagemaker-roles.html#sagemaker-roles-createtrainingjob-perms
  Default: - a role will be created.
  
  Specified by:
  
  getRole in interface SageMakerCreateTrainingJobJsonPathProps
- getStoppingCondition
  
  public final StoppingCondition getStoppingCondition()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Sets a time limit for training.
  Default: - max runtime of 1 hour
  
  Specified by:
  
  getStoppingCondition in interface SageMakerCreateTrainingJobJsonPathProps
- getTags
  
  public final Map<String,String> getTags()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Tags to be applied to the train job.
  Default: - No tags
  
  Specified by:
  
  getTags in interface SageMakerCreateTrainingJobJsonPathProps
- getVpcConfig
  
  public final VpcConfig getVpcConfig()
  
  Description copied from interface: SageMakerCreateTrainingJobJsonPathProps
  
  Specifies the VPC that you want your training job to connect to.
  Default: - No VPC
  
  Specified by:
  
  getVpcConfig in interface SageMakerCreateTrainingJobJsonPathProps
- getResultPath
  
  public final String getResultPath()
  
  Description copied from interface: TaskStateJsonPathBaseProps
  
  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: $
  
  Specified by:
  
  getResultPath in interface TaskStateJsonPathBaseProps
- getResultSelector
  
  public final Map<String,Object> getResultSelector()
  
  Description copied from interface: TaskStateJsonPathBaseProps
  
  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
  Specified by:
  
  getResultSelector in interface TaskStateJsonPathBaseProps
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
- getComment
  
  public final String getComment()
  
  Description copied from interface: StateBaseProps
  
  A comment describing this state.
  Default: No comment
  
  Specified by:
  
  getComment in interface StateBaseProps
- getQueryLanguage
  
  public final QueryLanguage getQueryLanguage()
  
  Description copied from interface: StateBaseProps
  
  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
  
  Specified by:
  
  getQueryLanguage in interface StateBaseProps
- getStateName
  
  public final String getStateName()
  
  Description copied from interface: StateBaseProps
  
  Optional name for this state.
  Default: - The construct ID will be used as state name
  
  Specified by:
  
  getStateName in interface StateBaseProps
- getCredentials
  
  public final Credentials getCredentials()
  
  Description copied from interface: TaskStateBaseOptions
  
  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)
  Specified by:
  
  getCredentials in interface TaskStateBaseOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
- getHeartbeat
  
  public final Duration getHeartbeat()
  
  Description copied from interface: TaskStateBaseOptions
  
  (deprecated) Timeout for the heartbeat.
  Default: - None
  
  Specified by:
  
  getHeartbeat in interface TaskStateBaseOptions
- getHeartbeatTimeout
  
  public final Timeout getHeartbeatTimeout()
  
  Description copied from interface: TaskStateBaseOptions
  
  Timeout for the heartbeat.
  [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
  Default: - None
  
  Specified by:
  
  getHeartbeatTimeout in interface TaskStateBaseOptions
- getIntegrationPattern
  
  public final IntegrationPattern getIntegrationPattern()
  
  Description copied from interface: TaskStateBaseOptions
  
  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`.
  Specified by:
  
  getIntegrationPattern in interface TaskStateBaseOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
- getTaskTimeout
  
  public final Timeout getTaskTimeout()
  
  Description copied from interface: TaskStateBaseOptions
  
  Timeout for the task.
  [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
  Default: - None
  
  Specified by:
  
  getTaskTimeout in interface TaskStateBaseOptions
- getTimeout
  
  public final Duration getTimeout()
  
  Description copied from interface: TaskStateBaseOptions
  
  (deprecated) Timeout for the task.
  Default: - None
  
  Specified by:
  
  getTimeout in interface TaskStateBaseOptions
- getAssign
  
  public final Map<String,Object> getAssign()
  
  Description copied from interface: AssignableStateOptions
  
  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
  Specified by:
  
  getAssign in interface AssignableStateOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html
- getInputPath
  
  public final String getInputPath()
  
  Description copied from interface: JsonPathCommonOptions
  
  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: $
  
  Specified by:
  
  getInputPath in interface JsonPathCommonOptions
- getOutputPath
  
  public final String getOutputPath()
  
  Description copied from interface: JsonPathCommonOptions
  
  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: $
  
  Specified by:
  
  getOutputPath in interface JsonPathCommonOptions
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateTrainingJobJsonPathProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getAlgorithmSpecification

getOutputDataConfig

getTrainingJobName

getEnableNetworkIsolation

getEnvironment

getHyperparameters

getInputDataConfig

getResourceConfig

getRole

getStoppingCondition

getTags

getVpcConfig

getResultPath

getResultSelector

getComment

getQueryLanguage

getStateName

getCredentials

getHeartbeat

getHeartbeatTimeout

getIntegrationPattern

getTaskTimeout

getTimeout

getAssign

getInputPath

getOutputPath

$jsii$toJson

equals

hashCode