Class CodePipelineTargetOptions
Customization options when creating a CodePipeline
event target.
Inheritance
Namespace: Amazon.CDK.AWS.Events.Targets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CodePipelineTargetOptions : Object, ICodePipelineTargetOptions, ITargetBaseProps
Syntax (vb)
Public Class CodePipelineTargetOptions
Inherits Object
Implements ICodePipelineTargetOptions, ITargetBaseProps
Remarks
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;
using Amazon.CDK.AWS.Events.Targets;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.SQS;
Queue queue;
Role role;
var codePipelineTargetOptions = new CodePipelineTargetOptions {
DeadLetterQueue = queue,
EventRole = role,
MaxEventAge = Duration.Minutes(30),
RetryAttempts = 123
};
Synopsis
Constructors
CodePipelineTargetOptions() |
Properties
DeadLetterQueue | The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. |
EventRole | The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered. |
MaxEventAge | The maximum age of a request that Lambda sends to a function for processing. |
RetryAttempts | The maximum number of times to retry when the function returns an error. |
Constructors
CodePipelineTargetOptions()
public CodePipelineTargetOptions()
Properties
DeadLetterQueue
The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.
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
EventRole
The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.
public IRole EventRole { get; set; }
Property Value
Remarks
Default: - a new role will be created
MaxEventAge
The maximum age of a request that Lambda sends to a function for processing.
public Duration MaxEventAge { get; set; }
Property Value
Remarks
Minimum value of 60. Maximum value of 86400.
Default: Duration.hours(24)
RetryAttempts
The maximum number of times to retry when the function 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