aws-cdk-lib.pipelines.S3SourceOptions

interface S3SourceOptions

LanguageType name
.NETAmazon.CDK.Pipelines.S3SourceOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/pipelines#S3SourceOptions
Javasoftware.amazon.awscdk.pipelines.S3SourceOptions
Pythonaws_cdk.pipelines.S3SourceOptions
TypeScript (source)aws-cdk-lib » pipelines » S3SourceOptions

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 { aws_codepipeline_actions as codepipeline_actions } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { pipelines } from 'aws-cdk-lib';

declare const role: iam.Role;
const s3SourceOptions: pipelines.S3SourceOptions = {
  actionName: 'actionName',
  role: role,
  trigger: codepipeline_actions.S3Trigger.NONE,
};

Properties

NameTypeDescription
actionName?stringThe action name used for this source in the CodePipeline.
role?IRoleThe role that will be assumed by the pipeline prior to executing the S3Source action.
trigger?S3TriggerHow should CodePipeline detect source changes for this Action.

actionName?

Type: string (optional, default: The bucket name)

The action name used for this source in the CodePipeline.


role?

Type: IRole (optional, default: a new role will be generated)

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


trigger?

Type: S3Trigger (optional, default: S3Trigger.POLL)

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.

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