Skip to content
v2.273.0

SageMakerStartPipelineExecutionProps Struct ​

Properties for a SageMaker Target.

Example ​

ts
import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';

declare const pipeline: sagemaker.IPipeline;

new Schedule(this, 'Schedule', {
  schedule: ScheduleExpression.rate(Duration.minutes(60)),
  target: new targets.SageMakerStartPipelineExecution(pipeline, {
    pipelineParameterList: [{
      name: 'parameter-name',
      value: 'parameter-value',
    }],
  }),
});

Properties ​

deadLetterQueueIQueuedead_letter_queueIQueuedeadLetterQueueIQueueDeadLetterQueueIQueueDeadLetterQueueIQueue= no dead-letter queue#
The SQS queue to be used as deadLetterQueue.
notes

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.

maxEventAgeDurationmax_event_ageDurationmaxEventAgeDurationMaxEventAgeDurationMaxEventAgeDuration= Duration.hours(24)#
The maximum age of a request that Scheduler sends to a target for processing.

Minimum value of 60. Maximum value of 86400.

pipelineParameterListSageMakerPipelineParameter[]pipeline_parameter_listtyping.List[SageMakerPipelineParameter]pipelineParameterListList<SageMakerPipelineParameter>PipelineParameterListSageMakerPipelineParameter[]PipelineParameterList*[]SageMakerPipelineParameter= no pipeline parameter list#
List of parameter names and values to use when executing the SageMaker Model Building Pipeline.

The length must be between 0 and 200.

retryAttemptsnumberretry_attemptsint | floatretryAttemptsNumberRetryAttemptsdoubleRetryAttempts*float64= 185#
The maximum number of times to retry when the target returns an error.

Minimum value of 0. Maximum value of 185.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= created by target#
An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
notes

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.

Used as props by ​