ScheduleTargetConfig Struct
Config of a Schedule Target used during initialization of Schedule.
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
The Amazon Resource Name (ARN) of the target.
deadLetterConfigoptionalCfnSchedule.DeadLetterConfigPropertydead_letter_configoptionalDeadLetterConfigPropertydeadLetterConfigoptionalDeadLetterConfigPropertyDeadLetterConfigoptionalDeadLetterConfigPropertyDeadLetterConfigoptionalDeadLetterConfigProperty#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.
ecsParametersoptionalCfnSchedule.EcsParametersPropertyecs_parametersoptionalEcsParametersPropertyecsParametersoptionalEcsParametersPropertyEcsParametersoptionalEcsParametersPropertyEcsParametersoptionalEcsParametersProperty#The templated target type for the Amazon ECS RunTask API Operation.
Default: No parameters
eventBridgeParametersoptionalCfnSchedule.EventBridgeParametersPropertyevent_bridge_parametersoptionalEventBridgeParametersPropertyeventBridgeParametersoptionalEventBridgeParametersPropertyEventBridgeParametersoptionalEventBridgeParametersPropertyEventBridgeParametersoptionalEventBridgeParametersProperty#The templated target type for the EventBridge PutEvents API operation.
Default: No parameters
inputoptionalScheduleTargetInputinputoptionalScheduleTargetInputinputoptionalScheduleTargetInputInputoptionalScheduleTargetInputInputoptionalScheduleTargetInput#What input to pass to the target.
Default: No input
kinesisParametersoptionalCfnSchedule.KinesisParametersPropertykinesis_parametersoptionalKinesisParametersPropertykinesisParametersoptionalKinesisParametersPropertyKinesisParametersoptionalKinesisParametersPropertyKinesisParametersoptionalKinesisParametersProperty#The templated target type for the Amazon Kinesis PutRecord API operation.
Default: No parameters
retryPolicyoptionalCfnSchedule.RetryPolicyPropertyretry_policyoptionalRetryPolicyPropertyretryPolicyoptionalRetryPolicyPropertyRetryPolicyoptionalRetryPolicyPropertyRetryPolicyoptionalRetryPolicyProperty#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)
sageMakerPipelineParametersoptionalCfnSchedule.SageMakerPipelineParametersPropertysage_maker_pipeline_parametersoptionalSageMakerPipelineParametersPropertysageMakerPipelineParametersoptionalSageMakerPipelineParametersPropertySageMakerPipelineParametersoptionalSageMakerPipelineParametersPropertySageMakerPipelineParametersoptionalSageMakerPipelineParametersProperty#The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
Default: No parameters
sqsParametersoptionalCfnSchedule.SqsParametersPropertysqs_parametersoptionalSqsParametersPropertysqsParametersoptionalSqsParametersPropertySqsParametersoptionalSqsParametersPropertySqsParametersoptionalSqsParametersProperty#The templated target type for the Amazon SQS SendMessage API Operation.
Default: No parameters