AWSEventMetadataProps

class aws_cdk.AWSEventMetadataProps(*, region=None, resources=None, version=None)

Bases: object

Properties for AWS EventBridge event metadata.

Parameters:
  • region (Optional[Sequence[str]]) – Identifies the AWS region where the event originated. Default: - No filtering on region

  • resources (Optional[Sequence[str]]) – This JSON array contains ARNs that identify resources that are involved in the event. Inclusion of these ARNs is at the discretion of the service. For example, Amazon EC2 instance state-changes include Amazon EC2 instance ARNs, Auto Scaling events include ARNs for both instances and Auto Scaling groups, but API calls with AWS CloudTrail do not include resource ARNs. Default: - No filtering on resource

  • version (Optional[Sequence[str]]) – By default, this is set to 0 (zero) in all events. Default: - No filtering on version

ExampleMetadata:

infused

Example:

from aws_cdk.mixins_preview.aws_s3.events import BucketEvents

# bucket: s3.Bucket

bucket_events = BucketEvents.from_bucket(bucket)

pattern = bucket_events.object_created_pattern(
    event_metadata=AWSEventMetadataProps(
        region=["us-east-1", "us-west-2"],
        version=["0"]
    )
)

Attributes

region

Identifies the AWS region where the event originated.

Default:
  • No filtering on region

resources

This JSON array contains ARNs that identify resources that are involved in the event.

Inclusion of these ARNs is at the discretion of the service.

For example, Amazon EC2 instance state-changes include Amazon EC2 instance ARNs, Auto Scaling events include ARNs for both instances and Auto Scaling groups, but API calls with AWS CloudTrail do not include resource ARNs.

Default:
  • No filtering on resource

version

By default, this is set to 0 (zero) in all events.

Default:
  • No filtering on version