Class SageMakerCreateEndpointProps
Properties for creating an Amazon SageMaker endpoint.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SageMakerCreateEndpointProps : Object, ISageMakerCreateEndpointProps, ITaskStateBaseProps
Syntax (vb)
Public Class SageMakerCreateEndpointProps
Inherits Object
Implements ISageMakerCreateEndpointProps, ITaskStateBaseProps
Remarks
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html
ExampleMetadata: infused
Examples
new SageMakerCreateEndpoint(this, "SagemakerEndpoint", new SageMakerCreateEndpointProps {
EndpointName = JsonPath.StringAt("$.EndpointName"),
EndpointConfigName = JsonPath.StringAt("$.EndpointConfigName")
});
Synopsis
Constructors
SageMakerCreateEndpointProps() |
Properties
Comment | An optional description for this state. |
Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
EndpointConfigName | The name of an endpoint configuration. |
EndpointName | The name of the endpoint. |
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. |
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. |
StateName | Optional name for this state. |
Tags | Tags to be applied to the endpoint. |
TaskTimeout | Timeout for the task. |
Timeout | (deprecated) Timeout for the task. |
Constructors
SageMakerCreateEndpointProps()
public SageMakerCreateEndpointProps()
Properties
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
EndpointConfigName
The name of an endpoint configuration.
public string EndpointConfigName { get; set; }
Property Value
System.String
EndpointName
The name of the endpoint.
public string EndpointName { get; set; }
Property Value
System.String
Remarks
The name must be unique within an AWS Region in your AWS account.
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
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
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 endpoint.
public TaskInput Tags { get; set; }
Property Value
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