S3SourceAction

class aws_cdk.aws_codepipeline_actions.S3SourceAction(*, bucket, bucket_key, output, trigger=None, role=None, action_name, run_order=None)

Bases: aws_cdk.aws_codepipeline_actions.Action

Source that is provided by a specific Amazon S3 object.

Will trigger the pipeline as soon as the S3 object changes, but only if there is a CloudTrail Trail in the account that captures the S3 event.

__init__(*, bucket, bucket_key, output, trigger=None, role=None, action_name, run_order=None)
Parameters
  • props

  • bucket (IBucket) – The Amazon S3 bucket that stores the source code.

  • bucket_key (str) – The key within the S3 bucket that stores the source code.

  • output (Artifact) –

  • 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

  • role (Optional[IRole]) – The Role in which context’s this Action will be executing in. The Pipeline’s Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated

  • action_name (str) – The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

Return type

None

Methods

bind(scope, stage, *, bucket, role)
Parameters

stability :stability: experimental

Return type

ActionConfig

on_state_change(name, target=None, *, description=None, enabled=None, event_pattern=None, rule_name=None, schedule=None, targets=None)
Parameters
  • name (str) –

  • target (Optional[IRuleTarget]) –

  • options

  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description.

  • enabled (Optional[bool]) – Indicates whether the rule is enabled. Default: true

  • event_pattern (Optional[EventPattern]) – Describes which events CloudWatch Events routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon CloudWatch User Guide. Default: - None.

  • rule_name (Optional[str]) – A name for the rule. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

  • schedule (Optional[Schedule]) – The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide. Default: - None.

  • targets (Optional[List[IRuleTarget]]) – Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]). Default: - No targets.

stability :stability: experimental

Return type

Rule

Attributes

action_properties

stability :stability: experimental

Return type

ActionProperties