Class SageMakerCreateEndpointConfigJsonPathProps

Properties for creating an Amazon SageMaker endpoint configuration using JSONPath.

Inheritance

object

SageMakerCreateEndpointConfigJsonPathProps

Implements

ISageMakerCreateEndpointConfigJsonPathProps

ITaskStateJsonPathBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonPathCommonOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.StepFunctions.Tasks

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SageMakerCreateEndpointConfigJsonPathProps : ISageMakerCreateEndpointConfigJsonPathProps, ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions

Syntax (vb)

Public Class SageMakerCreateEndpointConfigJsonPathProps Implements ISageMakerCreateEndpointConfigJsonPathProps, ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.KMS;
             using Amazon.CDK.AWS.StepFunctions;
             using Amazon.CDK.AWS.StepFunctions.Tasks;

             AcceleratorType acceleratorType;
             var assign;
             InstanceType instanceType;
             Key key;
             var resultSelector;
             TaskInput taskInput;
             TaskRole taskRole;
             Timeout timeout;

             var sageMakerCreateEndpointConfigJsonPathProps = new SageMakerCreateEndpointConfigJsonPathProps {
                 EndpointConfigName = "endpointConfigName",
                 ProductionVariants = new [] { new ProductionVariant {
                     InstanceType = instanceType,
                     ModelName = "modelName",
                     VariantName = "variantName",

                     // the properties below are optional
                     AcceleratorType = acceleratorType,
                     InitialInstanceCount = 123,
                     InitialVariantWeight = 123
                 } },

                 // the properties below are optional
                 Assign = new Dictionary<string, object> {
                     { "assignKey", assign }
                 },
                 Comment = "comment",
                 Credentials = new Credentials {
                     Role = taskRole
                 },
                 Heartbeat = Duration.Minutes(30),
                 HeartbeatTimeout = timeout,
                 InputPath = "inputPath",
                 IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                 KmsKey = key,
                 OutputPath = "outputPath",
                 QueryLanguage = QueryLanguage.JSON_PATH,
                 ResultPath = "resultPath",
                 ResultSelector = new Dictionary<string, object> {
                     { "resultSelectorKey", resultSelector }
                 },
                 StateName = "stateName",
                 Tags = taskInput,
                 TaskTimeout = timeout,
                 Timeout = Duration.Minutes(30)
             };

Synopsis

Constructors

SageMakerCreateEndpointConfigJsonPathProps()

Properties for creating an Amazon SageMaker endpoint configuration using JSONPath.

Properties

Assign	Workflow variables to store in this step.
Comment	A comment describing this state.
Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
EndpointConfigName	The name of the endpoint configuration.
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.
KmsKey	AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
OutputPath	JSONPath expression to select part of the state to be the output to this state.
ProductionVariants	An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
QueryLanguage	The name of the query language used by the 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 configuration.
TaskTimeout	Timeout for the task.
Timeout	(deprecated) Timeout for the task.

Constructors

SageMakerCreateEndpointConfigJsonPathProps()

Properties for creating an Amazon SageMaker endpoint configuration using JSONPath.

public SageMakerCreateEndpointConfigJsonPathProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.KMS;
             using Amazon.CDK.AWS.StepFunctions;
             using Amazon.CDK.AWS.StepFunctions.Tasks;

             AcceleratorType acceleratorType;
             var assign;
             InstanceType instanceType;
             Key key;
             var resultSelector;
             TaskInput taskInput;
             TaskRole taskRole;
             Timeout timeout;

             var sageMakerCreateEndpointConfigJsonPathProps = new SageMakerCreateEndpointConfigJsonPathProps {
                 EndpointConfigName = "endpointConfigName",
                 ProductionVariants = new [] { new ProductionVariant {
                     InstanceType = instanceType,
                     ModelName = "modelName",
                     VariantName = "variantName",

                     // the properties below are optional
                     AcceleratorType = acceleratorType,
                     InitialInstanceCount = 123,
                     InitialVariantWeight = 123
                 } },

                 // the properties below are optional
                 Assign = new Dictionary<string, object> {
                     { "assignKey", assign }
                 },
                 Comment = "comment",
                 Credentials = new Credentials {
                     Role = taskRole
                 },
                 Heartbeat = Duration.Minutes(30),
                 HeartbeatTimeout = timeout,
                 InputPath = "inputPath",
                 IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                 KmsKey = key,
                 OutputPath = "outputPath",
                 QueryLanguage = QueryLanguage.JSON_PATH,
                 ResultPath = "resultPath",
                 ResultSelector = new Dictionary<string, object> {
                     { "resultSelectorKey", resultSelector }
                 },
                 StateName = "stateName",
                 Tags = taskInput,
                 TaskTimeout = timeout,
                 Timeout = Duration.Minutes(30)
             };

Properties

Assign

Workflow variables to store in this step.

public IDictionary<string, object>? Assign { get; set; }

Property Value

IDictionary<string, object>

Remarks

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

Default: - Not assign variables

See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

Comment

A comment describing this state.

public string? Comment { get; set; }

Property Value

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

ICredentials

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 the endpoint configuration.

public string EndpointConfigName { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

Heartbeat

(deprecated) Timeout for the heartbeat.

[Obsolete("use `heartbeatTimeout`")]
public Duration? Heartbeat { get; set; }

Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

HeartbeatTimeout

Timeout for the heartbeat.

public Timeout? HeartbeatTimeout { get; set; }

Property Value

Timeout

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

string

Remarks

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

Default: $

IntegrationPattern

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

public IntegrationPattern? IntegrationPattern { get; set; }

Property Value

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

KmsKey

AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

public IKey? KmsKey { get; set; }

Property Value

IKey

Remarks

Default: - None

OutputPath

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

public string? OutputPath { get; set; }

Property Value

string

Remarks

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

Default: $

ProductionVariants

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

public IProductionVariant[] ProductionVariants { get; set; }

Property Value

IProductionVariant[]

Remarks

Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

QueryLanguage

The name of the query language used by the state.

public QueryLanguage? QueryLanguage { get; set; }

Property Value

QueryLanguage?

Remarks

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

ResultPath

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

public string? ResultPath { get; set; }

Property Value

string

Remarks

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

Default: $

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

IDictionary<string, 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

StateName

Optional name for this state.

public string? StateName { get; set; }

Property Value

string

Remarks

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

Tags

Tags to be applied to the endpoint configuration.

public TaskInput? Tags { get; set; }

Property Value

TaskInput

Remarks

Default: - No tags

TaskTimeout

Timeout for the task.

public Timeout? TaskTimeout { get; set; }

Property Value

Timeout

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.

[Obsolete("use `taskTimeout`")]
public Duration? Timeout { get; set; }

Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

Implements

ISageMakerCreateEndpointConfigJsonPathProps

ITaskStateJsonPathBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonPathCommonOptions