OnCloudTrailBucketEventOptions
- class aws_cdk.aws_s3.OnCloudTrailBucketEventOptions(*, description=None, event_pattern=None, rule_name=None, target=None, paths=None)
Bases:
OnEventOptions
Options for the onCloudTrailPutObject method.
- Parameters
description (
Optional
[str
]) – A description of the rule’s purpose. Default: - No descriptionevent_pattern (
Union
[EventPattern
,Dict
[str
,Any
],None
]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.rule_name (
Optional
[str
]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.target (
Optional
[IRuleTarget
]) – The target to register for the event. Default: - No target is added to the rule. UseaddTarget()
to add a target.paths (
Optional
[Sequence
[str
]]) – Only watch changes to these object paths. Default: - Watch changes to all objects
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events import aws_cdk.aws_s3 as s3 # detail: Any # rule_target: events.IRuleTarget on_cloud_trail_bucket_event_options = s3.OnCloudTrailBucketEventOptions( description="description", event_pattern=events.EventPattern( account=["account"], detail={ "detail_key": detail }, detail_type=["detailType"], id=["id"], region=["region"], resources=["resources"], source=["source"], time=["time"], version=["version"] ), paths=["paths"], rule_name="ruleName", target=rule_target )
Attributes
- description
A description of the rule’s purpose.
- Default
No description
- event_pattern
Additional restrictions for the event to route to the specified target.
The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.
- Default
No additional filtering based on an event pattern.
- See
https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
- paths
Only watch changes to these object paths.
- Default
Watch changes to all objects
- rule_name
A name for the rule.
- Default
AWS CloudFormation generates a unique physical ID.
- target
The target to register for the event.
- Default
No target is added to the rule. Use
addTarget()
to add a target.