Class CfnSchedule.TargetProperty
The schedule's target.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Scheduler
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TargetProperty : Object, CfnSchedule.ITargetProperty
Syntax (vb)
Public Class TargetProperty
Inherits Object
Implements CfnSchedule.ITargetProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Scheduler;
var tags;
var targetProperty = new TargetProperty {
Arn = "arn",
RoleArn = "roleArn",
// the properties below are optional
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
EcsParameters = new EcsParametersProperty {
TaskDefinitionArn = "taskDefinitionArn",
// the properties below are optional
CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
EnableEcsManagedTags = false,
EnableExecuteCommand = false,
Group = "group",
LaunchType = "launchType",
NetworkConfiguration = new NetworkConfigurationProperty {
AwsvpcConfiguration = new AwsVpcConfigurationProperty {
Subnets = new [] { "subnets" },
// the properties below are optional
AssignPublicIp = "assignPublicIp",
SecurityGroups = new [] { "securityGroups" }
}
},
PlacementConstraints = new [] { new PlacementConstraintProperty {
Expression = "expression",
Type = "type"
} },
PlacementStrategy = new [] { new PlacementStrategyProperty {
Field = "field",
Type = "type"
} },
PlatformVersion = "platformVersion",
PropagateTags = "propagateTags",
ReferenceId = "referenceId",
Tags = tags,
TaskCount = 123
},
EventBridgeParameters = new EventBridgeParametersProperty {
DetailType = "detailType",
Source = "source"
},
Input = "input",
KinesisParameters = new KinesisParametersProperty {
PartitionKey = "partitionKey"
},
RetryPolicy = new RetryPolicyProperty {
MaximumEventAgeInSeconds = 123,
MaximumRetryAttempts = 123
},
SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
Name = "name",
Value = "value"
} }
},
SqsParameters = new SqsParametersProperty {
MessageGroupId = "messageGroupId"
}
};
Synopsis
Constructors
TargetProperty() |
Properties
Arn | The Amazon Resource Name (ARN) of the target. |
DeadLetterConfig | An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. |
EcsParameters | The templated target type for the Amazon ECS |
EventBridgeParameters | The templated target type for the EventBridge |
Input | The text, or well-formed JSON, passed to the target. |
KinesisParameters | The templated target type for the Amazon Kinesis |
RetryPolicy | A |
RoleArn | The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. |
SageMakerPipelineParameters | The templated target type for the Amazon SageMaker |
SqsParameters | The templated target type for the Amazon SQS |
Constructors
TargetProperty()
public TargetProperty()
Properties
Arn
The Amazon Resource Name (ARN) of the target.
public string Arn { get; set; }
Property Value
System.String
Remarks
DeadLetterConfig
An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
public object DeadLetterConfig { get; set; }
Property Value
System.Object
Remarks
If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
EcsParameters
The templated target type for the Amazon ECS RunTask
API operation.
public object EcsParameters { get; set; }
Property Value
System.Object
Remarks
EventBridgeParameters
The templated target type for the EventBridge PutEvents
API operation.
public object EventBridgeParameters { get; set; }
Property Value
System.Object
Remarks
Input
The text, or well-formed JSON, passed to the target.
public string Input { get; set; }
Property Value
System.String
Remarks
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
The templated target type for the Amazon Kinesis PutRecord
API operation.
public object KinesisParameters { get; set; }
Property Value
System.Object
Remarks
RetryPolicy
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.
public object RetryPolicy { get; set; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
SageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution
API operation.
public object SageMakerPipelineParameters { get; set; }
Property Value
System.Object
Remarks
SqsParameters
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 .
public object SqsParameters { get; set; }
Property Value
System.Object