aws-cdk-lib.aws_scheduler.CfnSchedule.TargetProperty

interface TargetProperty

LanguageType name
.NETAmazon.CDK.AWS.Scheduler.CfnSchedule.TargetProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsscheduler#CfnSchedule_TargetProperty
Javasoftware.amazon.awscdk.services.scheduler.CfnSchedule.TargetProperty
Pythonaws_cdk.aws_scheduler.CfnSchedule.TargetProperty
TypeScript aws-cdk-lib » aws_scheduler » CfnSchedule » TargetProperty

The schedule's target.

EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_scheduler as scheduler } from 'aws-cdk-lib';

declare const tags: any;
const targetProperty: scheduler.CfnSchedule.TargetProperty = {
  arn: 'arn',
  roleArn: 'roleArn',

  // the properties below are optional
  deadLetterConfig: {
    arn: 'arn',
  },
  ecsParameters: {
    taskDefinitionArn: 'taskDefinitionArn',

    // the properties below are optional
    capacityProviderStrategy: [{
      capacityProvider: 'capacityProvider',

      // the properties below are optional
      base: 123,
      weight: 123,
    }],
    enableEcsManagedTags: false,
    enableExecuteCommand: false,
    group: 'group',
    launchType: 'launchType',
    networkConfiguration: {
      awsvpcConfiguration: {
        subnets: ['subnets'],

        // the properties below are optional
        assignPublicIp: 'assignPublicIp',
        securityGroups: ['securityGroups'],
      },
    },
    placementConstraints: [{
      expression: 'expression',
      type: 'type',
    }],
    placementStrategy: [{
      field: 'field',
      type: 'type',
    }],
    platformVersion: 'platformVersion',
    propagateTags: 'propagateTags',
    referenceId: 'referenceId',
    tags: tags,
    taskCount: 123,
  },
  eventBridgeParameters: {
    detailType: 'detailType',
    source: 'source',
  },
  input: 'input',
  kinesisParameters: {
    partitionKey: 'partitionKey',
  },
  retryPolicy: {
    maximumEventAgeInSeconds: 123,
    maximumRetryAttempts: 123,
  },
  sageMakerPipelineParameters: {
    pipelineParameterList: [{
      name: 'name',
      value: 'value',
    }],
  },
  sqsParameters: {
    messageGroupId: 'messageGroupId',
  },
};

Properties

NameTypeDescription
arnstringThe Amazon Resource Name (ARN) of the target.
roleArnstringThe Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
deadLetterConfig?IResolvable | DeadLetterConfigPropertyAn object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
ecsParameters?IResolvable | EcsParametersPropertyThe templated target type for the Amazon ECS RunTask API operation.
eventBridgeParameters?IResolvable | EventBridgeParametersPropertyThe templated target type for the EventBridge PutEvents API operation.
input?stringThe text, or well-formed JSON, passed to the target.
kinesisParameters?IResolvable | KinesisParametersPropertyThe templated target type for the Amazon Kinesis PutRecord API operation.
retryPolicy?IResolvable | RetryPolicyPropertyA RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
sageMakerPipelineParameters?IResolvable | SageMakerPipelineParametersPropertyThe templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqsParameters?IResolvable | SqsParametersPropertyThe templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .

arn

Type: string

The Amazon Resource Name (ARN) of the target.


roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.


deadLetterConfig?

Type: IResolvable | DeadLetterConfigProperty (optional)

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.

If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.


ecsParameters?

Type: IResolvable | EcsParametersProperty (optional)

The templated target type for the Amazon ECS RunTask API operation.


eventBridgeParameters?

Type: IResolvable | EventBridgeParametersProperty (optional)

The templated target type for the EventBridge PutEvents API operation.


input?

Type: string (optional)

The text, or well-formed JSON, passed to the target.

If you are configuring a templated Lambda , AWS Step Functions , or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.


kinesisParameters?

Type: IResolvable | KinesisParametersProperty (optional)

The templated target type for the Amazon Kinesis PutRecord API operation.


retryPolicy?

Type: IResolvable | RetryPolicyProperty (optional)

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.


sageMakerPipelineParameters?

Type: IResolvable | SageMakerPipelineParametersProperty (optional)

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.


sqsParameters?

Type: IResolvable | SqsParametersProperty (optional)

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .