aws-cdk-lib.pipelines.S3SourceOptions

S3SourceOptions Struct

Options for S3 sources.

Source

pipelines/lib/codepipeline/codepipeline-source.ts

Type last changed

v2.27.0 · 3 Jun 2022

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

actionName?optionalstringaction_name?optionalstractionName?optionalStringActionName?optionalstringActionName?optional*string#

The action name used for this source in the CodePipeline.

Default: The bucket name

role?optionalIRolerole?optionalIRolerole?optionalIRoleRole?optionalIRoleRole?optionalIRole#

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

Default: a new role will be generated

trigger?optionalS3Triggertrigger?optionalS3Triggertrigger?optionalS3TriggerTrigger?optionalS3TriggerTrigger?optionalS3Trigger= 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.