aws_ddk_core.stages.S3EventStage

class aws_ddk_core.stages.S3EventStage(*args: Any, **kwargs)

Class that represents an S3 Event DDK Stage.

__init__(scope: constructs.Construct, id: str, environment_id: str, event_names: List[str], bucket_name: Union[str, List[str]], key_prefix: Optional[Union[str, List[str]]] = None, **kwargs: Any) None

DDK S3 Event stage.

It implements an S3 event pattern based on event names, a bucket name and optional key prefix. Amazon EventBridge notifications must be enabled on the bucket in order to use this construct.

Parameters
  • scope (Construct) – Scope within which this construct is defined

  • id (str) – Identifier of the stage

  • environment_id (str) – Identifier of the environment

  • event_names (List[str]) – The list of events to capture, for example: [“Object Created”]. https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html

  • bucket_name (Union[str, List[str]]) – The name(s) of the S3 bucket(s). Amazon EventBridge notifications must be enabled on the bucket in order to use this construct.

  • key_prefix (Optional[Union[str, List[str]]]) – The S3 prefix or list of prefixes. Capture root level prefix (“/”) by default

Methods

__init__(scope, id, environment_id, ...[, ...])

DDK S3 Event stage.

get_event_pattern()

Get output event pattern of the stage.

get_targets()

Get input targets of the stage.

is_construct(x)

Checks if x is a construct.

to_string()

Returns a string representation of this construct.

Attributes

event_pattern

EventPattern The S3 event pattern

node

The tree node.

property event_pattern: aws_cdk.aws_events.EventPattern

EventPattern The S3 event pattern

Type

Return

get_event_pattern() Optional[aws_cdk.aws_events.EventPattern]

Get output event pattern of the stage.

Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets.

Returns

event_pattern – Event pattern

Return type

Optional[EventPattern]