S3SourceOptions

class aws_cdk.pipelines.S3SourceOptions(*, action_name=None, role=None, trigger=None)

Bases: object

Options for S3 sources.

Parameters
  • action_name (Optional[str]) – The action name used for this source in the CodePipeline. Default: - The bucket name

  • role (Optional[IRole]) – The role that will be assumed by the pipeline prior to executing the S3Source action. Default: - a new role will be generated

  • trigger (Optional[S3Trigger]) – 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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codepipeline_actions as codepipeline_actions
from aws_cdk import aws_iam as iam
from aws_cdk import pipelines

# role: iam.Role

s3_source_options = pipelines.S3SourceOptions(
    action_name="actionName",
    role=role,
    trigger=codepipeline_actions.S3Trigger.NONE
)

Attributes

action_name

The action name used for this source in the CodePipeline.

Default
  • The bucket name

Return type

Optional[str]

role

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

Default
  • a new role will be generated

Return type

Optional[IRole]

trigger

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

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

Return type

Optional[S3Trigger]