software.amazon.awscdk.services.codepipeline.actions

Interface S3SourceActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3SourceActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.563Z")
 @Stability(value=Stable)
public interface S3SourceActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the S3 source Action.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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

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

Method Summary

Modifier and Type	Method and Description
static S3SourceActionProps.Builder	builder()
IBucket	getBucket() The Amazon S3 bucket that stores the source code.
String	getBucketKey() The key within the S3 bucket that stores the source code.
Artifact	getOutput()
default S3Trigger	getTrigger() How should CodePipeline detect source changes for this Action.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucket

@Stability(value=Stable)
 @NotNull
IBucket getBucket()

The Amazon S3 bucket that stores the source code.

If you import an encrypted bucket in your stack, please specify the encryption key at import time by using Bucket.fromBucketAttributes() method.

getBucketKey

@Stability(value=Stable)
 @NotNull
String getBucketKey()

The key within the S3 bucket that stores the source code.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "path/to/file.zip";
 

getOutput

@Stability(value=Stable)
 @NotNull
Artifact getOutput()

getTrigger

@Stability(value=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(value=Stable)
static S3SourceActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a S3SourceActionProps.Builder of S3SourceActionProps