Package software.amazon.awscdk.services.events.targets

Interface CodePipelineTargetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

CodePipelineTargetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:59.764Z")
@Stability(Stable)
public interface CodePipelineTargetOptions
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customization options when creating a CodePipeline event target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.events.targets.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 Role role;
 CodePipelineTargetOptions codePipelineTargetOptions = CodePipelineTargetOptions.builder()
         .deadLetterQueue(queue)
         .eventRole(role)
         .maxEventAge(Duration.minutes(30))
         .retryAttempts(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CodePipelineTargetOptions.Builder	A builder for CodePipelineTargetOptions
static final class	CodePipelineTargetOptions.Jsii$Proxy	An implementation for CodePipelineTargetOptions

Method Summary

Modifier and Type	Method	Description
static CodePipelineTargetOptions.Builder	builder()
default IRole	getEventRole()	The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Method Details

getEventRole

@Stability(Stable)
@Nullable
default IRole getEventRole()

The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.

Default: - a new role will be created

builder

@Stability(Stable)
static CodePipelineTargetOptions.Builder builder()

Returns:

a CodePipelineTargetOptions.Builder of CodePipelineTargetOptions