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:

java.io.Serializable, java.lang.Comparable<S3Trigger>

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:01.405Z")
public enum S3Trigger
extends java.lang.Enum<S3Trigger>

How should the S3 Action detect changes.

This is the type of the {@link 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();
 

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static S3Trigger	valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

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

public static final S3Trigger POLL

CodePipeline will poll S3 to detect changes.

This is the default method of detecting changes.

EVENTS

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 Detail

values

public static S3Trigger[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (S3Trigger c : S3Trigger.values())
    System.out.println(c);

Returns:

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

valueOf

public static S3Trigger valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null