# ScheduleTargetConfig

Config of a Schedule Target used during initialization of Schedule.

- Source: [`aws-scheduler/lib/target.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-scheduler/lib/target.ts#L21)
- Type last changed: v2.186.0 · 27 Mar 2025

## Example

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

declare const role: iam.Role;
declare const scheduleTargetInput: scheduler.ScheduleTargetInput;
declare const tags: any;
const scheduleTargetConfig: scheduler.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

- `arn`: string (required) — The Amazon Resource Name (ARN) of the target.

- `deadLetterConfig`: [CfnSchedule.DeadLetterConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.DeadLetterConfigProperty.html) — An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.

  **Default:** No dead-letter queue

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

- `ecsParameters`: [CfnSchedule.EcsParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.EcsParametersProperty.html) — The templated target type for the Amazon ECS RunTask API Operation.

  **Default:** No parameters

- `eventBridgeParameters`: [CfnSchedule.EventBridgeParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.EventBridgeParametersProperty.html) — The templated target type for the EventBridge PutEvents API operation.

  **Default:** No parameters

- `input`: [ScheduleTargetInput](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.ScheduleTargetInput.html) — What input to pass to the target.

  **Default:** No input

- `kinesisParameters`: [CfnSchedule.KinesisParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.KinesisParametersProperty.html) — The templated target type for the Amazon Kinesis PutRecord API operation.

  **Default:** No parameters

- `retryPolicy`: [CfnSchedule.RetryPolicyProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.RetryPolicyProperty.html) — 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.

  **Default:** Maximum retry attempts of 185 and maximum age of 86400 seconds (1 day)

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — Role to use to invoke this event target.

- `sageMakerPipelineParameters`: [CfnSchedule.SageMakerPipelineParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.SageMakerPipelineParametersProperty.html) — The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

  **Default:** No parameters

- `sqsParameters`: [CfnSchedule.SqsParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.SqsParametersProperty.html) — The templated target type for the Amazon SQS SendMessage API Operation.

  **Default:** No parameters