Class SageMakerStartPipelineExecutionProps

Properties for a SageMaker Target.

Inheritance

object

SageMakerStartPipelineExecutionProps

Implements

ISageMakerStartPipelineExecutionProps

IScheduleTargetBaseProps

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.Scheduler.Targets

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SageMakerStartPipelineExecutionProps : ISageMakerStartPipelineExecutionProps, IScheduleTargetBaseProps

Syntax (vb)

Public Class SageMakerStartPipelineExecutionProps Implements ISageMakerStartPipelineExecutionProps, IScheduleTargetBaseProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Sagemaker;

            IPipeline pipeline;


            new Schedule(this, "Schedule", new ScheduleProps {
                Schedule = ScheduleExpression.Rate(Duration.Minutes(60)),
                Target = new SageMakerStartPipelineExecution(pipeline, new SageMakerStartPipelineExecutionProps {
                    PipelineParameterList = new [] { new SageMakerPipelineParameter {
                        Name = "parameter-name",
                        Value = "parameter-value"
                    } }
                })
            });

Synopsis

Constructors

SageMakerStartPipelineExecutionProps()

Properties for a SageMaker Target.

Properties

DeadLetterQueue	The SQS queue to be used as deadLetterQueue.
Input	Input passed to the target.
MaxEventAge	The maximum age of a request that Scheduler sends to a target for processing.
PipelineParameterList	List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
RetryAttempts	The maximum number of times to retry when the target returns an error.
Role	An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

Constructors

SageMakerStartPipelineExecutionProps()

Properties for a SageMaker Target.

public SageMakerStartPipelineExecutionProps()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Sagemaker;

            IPipeline pipeline;


            new Schedule(this, "Schedule", new ScheduleProps {
                Schedule = ScheduleExpression.Rate(Duration.Minutes(60)),
                Target = new SageMakerStartPipelineExecution(pipeline, new SageMakerStartPipelineExecutionProps {
                    PipelineParameterList = new [] { new SageMakerPipelineParameter {
                        Name = "parameter-name",
                        Value = "parameter-value"
                    } }
                })
            });

Properties

DeadLetterQueue

The SQS queue to be used as deadLetterQueue.

public IQueue? DeadLetterQueue { get; set; }

Property Value

IQueue

Remarks

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Input

Input passed to the target.

public ScheduleTargetInput? Input { get; set; }

Property Value

ScheduleTargetInput

Remarks

Default: - no input.

MaxEventAge

The maximum age of a request that Scheduler sends to a target for processing.

public Duration? MaxEventAge { get; set; }

Property Value

Duration

Remarks

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

PipelineParameterList

List of parameter names and values to use when executing the SageMaker Model Building Pipeline.

public ISageMakerPipelineParameter[]? PipelineParameterList { get; set; }

Property Value

ISageMakerPipelineParameter[]

Remarks

The length must be between 0 and 200.

Default: - no pipeline parameter list

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist

RetryAttempts

The maximum number of times to retry when the target returns an error.

public double? RetryAttempts { get; set; }

Property Value

double?

Remarks

Minimum value of 0. Maximum value of 185.

Default: 185

Role

An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

public IRole? Role { get; set; }

Property Value

IRole

Remarks

If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.

Default: - created by target

Implements

ISageMakerStartPipelineExecutionProps

IScheduleTargetBaseProps