Class KinesisStreamPutRecordProps
(experimental) Properties for a Kinesis Data Streams Target.
Inheritance
Namespace: Amazon.CDK.AWS.Scheduler.Targets.Alpha
Assembly: Amazon.CDK.AWS.Scheduler.Targets.Alpha.dll
Syntax (csharp)
public class KinesisStreamPutRecordProps : Object, IKinesisStreamPutRecordProps, IScheduleTargetBaseProps
Syntax (vb)
Public Class KinesisStreamPutRecordProps
Inherits Object
Implements IKinesisStreamPutRecordProps, IScheduleTargetBaseProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.Kinesis;
var stream = new Stream(this, "MyStream");
new Schedule(this, "Schedule", new ScheduleProps {
Schedule = ScheduleExpression.Rate(Duration.Minutes(60)),
Target = new KinesisStreamPutRecord(stream, new KinesisStreamPutRecordProps {
PartitionKey = "key"
})
});
Synopsis
Constructors
KinesisStreamPutRecordProps() |
Properties
DeadLetterQueue | (experimental) The SQS queue to be used as deadLetterQueue. |
Input | (experimental) Input passed to the target. |
MaxEventAge | (experimental) The maximum age of a request that Scheduler sends to a target for processing. |
PartitionKey | (experimental) The shard to which EventBridge Scheduler sends the event. |
RetryAttempts | (experimental) The maximum number of times to retry when the target returns an error. |
Role | (experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf. |
Constructors
KinesisStreamPutRecordProps()
public KinesisStreamPutRecordProps()
Properties
DeadLetterQueue
(experimental) The SQS queue to be used as deadLetterQueue.
public IQueue DeadLetterQueue { get; set; }
Property Value
Remarks
The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.
Default: - no dead-letter queue
Stability: Experimental
Input
(experimental) Input passed to the target.
public ScheduleTargetInput Input { get; set; }
Property Value
Remarks
Default: - no input.
Stability: Experimental
MaxEventAge
(experimental) The maximum age of a request that Scheduler sends to a target for processing.
public Duration MaxEventAge { get; set; }
Property Value
Remarks
Minimum value of 60. Maximum value of 86400.
Default: Duration.hours(24)
Stability: Experimental
PartitionKey
(experimental) The shard to which EventBridge Scheduler sends the event.
public string PartitionKey { get; set; }
Property Value
System.String
Remarks
The length must be between 1 and 256.
Stability: Experimental
RetryAttempts
(experimental) The maximum number of times to retry when the target returns an error.
public Nullable<double> RetryAttempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Minimum value of 0. Maximum value of 185.
Default: 185
Stability: Experimental
Role
(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
public IRole Role { get; set; }
Property Value
Remarks
If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.
Universal target automatically create an IAM role if you do not specify your own IAM role. However, in comparison with templated targets, for universal targets you must grant the required IAM permissions yourself.
Default: - created by target
Stability: Experimental