interface S3SourceOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.Pipelines.S3SourceOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/pipelines#S3SourceOptions |
![]() | software.amazon.awscdk.pipelines.S3SourceOptions |
![]() | aws_cdk.pipelines.S3SourceOptions |
![]() | 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
Name | Type | Description |
---|---|---|
action | string | The action name used for this source in the CodePipeline. |
role? | IRole | The role that will be assumed by the pipeline prior to executing the S3Source action. |
trigger? | S3 | How 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:
S3
(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.