interface ScheduleTargetConfig 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Scheduler.Alpha.ScheduleTargetConfig
Go	github.com/aws/aws-cdk-go/awscdkscheduleralpha/v2#ScheduleTargetConfig
Java	software.amazon.awscdk.services.scheduler.alpha.ScheduleTargetConfig
Python	aws_cdk.aws_scheduler_alpha.ScheduleTargetConfig
TypeScript (source)	@aws-cdk/aws-scheduler-alpha » ScheduleTargetConfig

Obtainable from EventBridgePutEvents.bindBaseTargetConfig(), KinesisStreamPutRecord.bindBaseTargetConfig(), SageMakerStartPipelineExecution.bindBaseTargetConfig(), ScheduleTargetBase.bind(), ScheduleTargetBase.bindBaseTargetConfig(), SqsSendMessage.bindBaseTargetConfig()

Config of a Schedule Target used during initialization of Schedule.

Example

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

declare const role: iam.Role;
declare const scheduleTargetInput: scheduler_alpha.ScheduleTargetInput;
declare const tags: any;
const scheduleTargetConfig: scheduler_alpha.ScheduleTargetConfig = {
  arn: 'arn',
  role: role,

  // 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: scheduleTargetInput,
  kinesisParameters: {
    partitionKey: 'partitionKey',
  },
  retryPolicy: {
    maximumEventAgeInSeconds: 123,
    maximumRetryAttempts: 123,
  },
  sageMakerPipelineParameters: {
    pipelineParameterList: [{
      name: 'name',
      value: 'value',
    }],
  },
  sqsParameters: {
    messageGroupId: 'messageGroupId',
  },
};

Properties

Name	Type	Description
arn🔹	string	The Amazon Resource Name (ARN) of the target.
role🔹	IRole	Role to use to invoke this event target.
deadLetterConfig?🔹	DeadLetterConfigProperty	An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
ecsParameters?🔹	EcsParametersProperty	The templated target type for the Amazon ECS RunTask API Operation.
eventBridgeParameters?🔹	EventBridgeParametersProperty	The templated target type for the EventBridge PutEvents API operation.
input?🔹	ScheduleTargetInput	What input to pass to the target.
kinesisParameters?🔹	KinesisParametersProperty	The templated target type for the Amazon Kinesis PutRecord API operation.
retryPolicy?🔹	RetryPolicyProperty	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?🔹	SageMakerPipelineParametersProperty	The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqsParameters?🔹	SqsParametersProperty	The templated target type for the Amazon SQS SendMessage API Operation.

---

arn🔹

Type: string

The Amazon Resource Name (ARN) of the target.

---

role🔹

Type: IRole

Role to use to invoke this event target.

---

deadLetterConfig?🔹

Type: 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: EcsParametersProperty (optional)

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

---

eventBridgeParameters?🔹

Type: EventBridgeParametersProperty (optional)

The templated target type for the EventBridge PutEvents API operation.

---

input?🔹

Type: ScheduleTargetInput (optional)

What input to pass to the target.

---

kinesisParameters?🔹

Type: KinesisParametersProperty (optional)

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

---

retryPolicy?🔹

Type: 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: SageMakerPipelineParametersProperty (optional)

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

---

sqsParameters?🔹

Type: SqsParametersProperty (optional)

The templated target type for the Amazon SQS SendMessage API Operation.