Class SageMakerCreateTransformJobProps
Properties for creating an Amazon SageMaker transform job task.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SageMakerCreateTransformJobProps : Object, ISageMakerCreateTransformJobProps, ITaskStateBaseProps
Syntax (vb)
Public Class SageMakerCreateTransformJobProps
Inherits Object
Implements ISageMakerCreateTransformJobProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
new SageMakerCreateTransformJob(this, "Batch Inference", new SageMakerCreateTransformJobProps {
TransformJobName = "MyTransformJob",
ModelName = "MyModelName",
ModelClientOptions = new ModelClientOptions {
InvocationsMaxRetries = 3, // default is 0
InvocationsTimeout = Duration.Minutes(5)
},
TransformInput = new TransformInput {
TransformDataSource = new TransformDataSource {
S3DataSource = new TransformS3DataSource {
S3Uri = "s3://inputbucket/train",
S3DataType = S3DataType.S3_PREFIX
}
}
},
TransformOutput = new TransformOutput {
S3OutputPath = "s3://outputbucket/TransformJobOutputPath"
},
TransformResources = new TransformResources {
InstanceCount = 1,
InstanceType = InstanceType.Of(InstanceClass.M4, InstanceSize.XLARGE)
}
});
Synopsis
Constructors
SageMakerCreateTransformJobProps() |
Properties
BatchStrategy | Number of records to include in a mini-batch for an HTTP inference request. |
Comment | An optional description for this state. |
Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
Environment | Environment variables to set in the Docker container. |
Heartbeat | (deprecated) Timeout for the heartbeat. |
HeartbeatTimeout | Timeout for the heartbeat. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
MaxConcurrentTransforms | Maximum number of parallel requests that can be sent to each instance in a transform job. |
MaxPayload | Maximum allowed size of the payload, in MB. |
ModelClientOptions | Configures the timeout and maximum number of retries for processing a transform job invocation. |
ModelName | Name of the model that you want to use for the transform job. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
Role | Role for the Transform Job. |
StateName | Optional name for this state. |
Tags | Tags to be applied to the train job. |
TaskTimeout | Timeout for the task. |
Timeout | (deprecated) Timeout for the task. |
TransformInput | Dataset to be transformed and the Amazon S3 location where it is stored. |
TransformJobName | Transform Job Name. |
TransformOutput | S3 location where you want Amazon SageMaker to save the results from the transform job. |
TransformResources | ML compute instances for the transform job. |
Constructors
SageMakerCreateTransformJobProps()
public SageMakerCreateTransformJobProps()
Properties
BatchStrategy
Number of records to include in a mini-batch for an HTTP inference request.
public Nullable<BatchStrategy> BatchStrategy { get; set; }
Property Value
System.Nullable<BatchStrategy>
Remarks
Default: - No batch strategy
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
public ICredentials Credentials { get; set; }
Property Value
Remarks
This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
Environment
Environment variables to set in the Docker container.
public IDictionary<string, string> Environment { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No environment variables
Heartbeat
(deprecated) Timeout for the heartbeat.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
Stability: Deprecated
HeartbeatTimeout
Timeout for the heartbeat.
public Timeout HeartbeatTimeout { get; set; }
Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<IntegrationPattern>
Remarks
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
.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
MaxConcurrentTransforms
Maximum number of parallel requests that can be sent to each instance in a transform job.
public Nullable<double> MaxConcurrentTransforms { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1.
MaxPayload
Maximum allowed size of the payload, in MB.
public Size MaxPayload { get; set; }
Property Value
Remarks
Default: 6
ModelClientOptions
Configures the timeout and maximum number of retries for processing a transform job invocation.
public IModelClientOptions ModelClientOptions { get; set; }
Property Value
Remarks
Default: - 0 retries and 60 seconds of timeout
ModelName
Name of the model that you want to use for the transform job.
public string ModelName { get; set; }
Property Value
System.String
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
Role
Role for the Transform Job.
public IRole Role { get; set; }
Property Value
Remarks
Default: - A role is created with AmazonSageMakerFullAccess
managed policy
StateName
Optional name for this state.
public string StateName { get; set; }
Property Value
System.String
Remarks
Default: - The construct ID will be used as state name
Tags
Tags to be applied to the train job.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No tags
TaskTimeout
Timeout for the task.
public Timeout TaskTimeout { get; set; }
Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
Timeout
(deprecated) Timeout for the task.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None
Stability: Deprecated
TransformInput
Dataset to be transformed and the Amazon S3 location where it is stored.
public ITransformInput TransformInput { get; set; }
Property Value
TransformJobName
Transform Job Name.
public string TransformJobName { get; set; }
Property Value
System.String
TransformOutput
S3 location where you want Amazon SageMaker to save the results from the transform job.
public ITransformOutput TransformOutput { get; set; }
Property Value
TransformResources
ML compute instances for the transform job.
public ITransformResources TransformResources { get; set; }
Property Value
Remarks
Default: - 1 instance of type M4.XLarge