Package software.amazon.awscdk.services.codepipeline.actions

Enum S3Trigger

java.lang.Object

java.lang.Enum<S3Trigger>

software.amazon.awscdk.services.codepipeline.actions.S3Trigger

All Implemented Interfaces:

Serializable, Comparable<S3Trigger>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.237Z")
@Stability(Stable)
public enum S3Trigger
extends Enum<S3Trigger>

How should the S3 Action detect changes.

This is the type of the S3SourceAction.trigger property.

Example:

 import software.amazon.awscdk.services.cloudtrail.*;
 Bucket sourceBucket;
 Artifact sourceOutput = new Artifact();
 String key = "some/key.zip";
 Trail trail = new Trail(this, "CloudTrail");
 trail.addS3EventSelector(List.of(S3EventSelector.builder()
         .bucket(sourceBucket)
         .objectPrefix(key)
         .build()), AddEventSelectorOptions.builder()
         .readWriteType(ReadWriteType.WRITE_ONLY)
         .build());
 S3SourceAction sourceAction = S3SourceAction.Builder.create()
         .actionName("S3Source")
         .bucketKey(key)
         .bucket(sourceBucket)
         .output(sourceOutput)
         .trigger(S3Trigger.EVENTS)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVENTS	CodePipeline will use CloudWatch Events to be notified of changes.
NONE	The Action will never detect changes - the Pipeline it's part of will only begin a run when explicitly started.
POLL	CodePipeline will poll S3 to detect changes.

Method Summary

Modifier and Type	Method	Description
static S3Trigger	valueOf(String name)	Returns the enum constant of this type with the specified name.
static S3Trigger[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

@Stability(Stable)
public static final S3Trigger NONE

The Action will never detect changes - the Pipeline it's part of will only begin a run when explicitly started.

POLL

@Stability(Stable)
public static final S3Trigger POLL

CodePipeline will poll S3 to detect changes.

This is the default method of detecting changes.

EVENTS

@Stability(Stable)
public static final S3Trigger EVENTS

CodePipeline will use CloudWatch Events to be notified of changes.

Note that the Bucket that the Action uses needs to be part of a CloudTrail Trail for the events to be delivered.

Method Details

values

public static S3Trigger[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static S3Trigger valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null