Package software.amazon.awscdk.pipelines

Interface S3SourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3SourceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-13T09:19:48.517Z")
@Stability(Stable)
public interface S3SourceOptions
extends software.amazon.jsii.JsiiSerializable

Options for S3 sources.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.actions.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.pipelines.*;
 Role role;
 S3SourceOptions s3SourceOptions = S3SourceOptions.builder()
         .actionName("actionName")
         .role(role)
         .trigger(S3Trigger.NONE)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3SourceOptions.Builder	builder()
default String	getActionName()	The action name used for this source in the CodePipeline.
default IRole	getRole()	The role that will be assumed by the pipeline prior to executing the S3Source action.
default S3Trigger	getTrigger()	How should CodePipeline detect source changes for this Action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionName

@Stability(Stable)
@Nullable
default String getActionName()

The action name used for this source in the CodePipeline.

Default: - The bucket name

getRole

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

The role that will be assumed by the pipeline prior to executing the S3Source action.

Default: - a new role will be generated

getTrigger

@Stability(Stable)
@Nullable
default S3Trigger getTrigger()

How should CodePipeline detect source changes for this Action.

Note that if this is S3Trigger.EVENTS, you need to make sure to include the source Bucket in a CloudTrail Trail, as otherwise the CloudWatch Events will not be emitted.

Default: S3Trigger.POLL

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/log-s3-data-events.html

builder

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

Returns:

a S3SourceOptions.Builder of S3SourceOptions