Show / Hide Table of Contents

Class SageMakerUpdateEndpointProps

Properties for updating Amazon SageMaker endpoint.

Inheritance
System.Object
SageMakerUpdateEndpointProps
Implements
ISageMakerUpdateEndpointProps
ITaskStateBaseProps
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class SageMakerUpdateEndpointProps : Object, ISageMakerUpdateEndpointProps, ITaskStateBaseProps
Syntax (vb)
Public Class SageMakerUpdateEndpointProps
    Inherits Object
    Implements ISageMakerUpdateEndpointProps, ITaskStateBaseProps
Remarks

See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html

ExampleMetadata: infused

Examples
new SageMakerUpdateEndpoint(this, "SagemakerEndpoint", new SageMakerUpdateEndpointProps {
    EndpointName = JsonPath.StringAt("$.Endpoint.Name"),
    EndpointConfigName = JsonPath.StringAt("$.Endpoint.EndpointConfig")
});

Synopsis

Constructors

SageMakerUpdateEndpointProps()

Properties

Comment

An optional description for this state.

EndpointConfigName

The name of the new endpoint configuration.

EndpointName

The name of the endpoint whose configuration you want to update.

Heartbeat

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.

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.

Timeout

Timeout for the state machine.

Constructors

SageMakerUpdateEndpointProps()

public SageMakerUpdateEndpointProps()

Properties

Comment

An optional description for this state.

public string Comment { get; set; }
Property Value

System.String

Remarks

Default: - No comment

EndpointConfigName

The name of the new endpoint configuration.

public string EndpointConfigName { get; set; }
Property Value

System.String

EndpointName

The name of the endpoint whose configuration you want to update.

public string EndpointName { get; set; }
Property Value

System.String

Heartbeat

Timeout for the heartbeat.

public Duration Heartbeat { get; set; }
Property Value

Duration

Remarks

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

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-to-resource.html#connect-wait-token

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

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

Timeout

Timeout for the state machine.

public Duration Timeout { get; set; }
Property Value

Duration

Remarks

Default: - None

Implements

ISageMakerUpdateEndpointProps
ITaskStateBaseProps
Back to top Generated by DocFX