Package software.amazon.awscdk

Interface AWSEventMetadataProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AWSEventMetadataProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:03.592Z")
@Stability(Stable)
public interface AWSEventMetadataProps
extends software.amazon.jsii.JsiiSerializable

Properties for AWS EventBridge event metadata.

Example:

 import software.amazon.awscdk.mixins.preview.services.s3.events.BucketEvents;
 Bucket bucket;
 BucketEvents bucketEvents = BucketEvents.fromBucket(bucket);
 EventPattern pattern = bucketEvents.objectCreatedPattern(ObjectCreatedProps.builder()
         .eventMetadata(AWSEventMetadataProps.builder()
                 .region(List.of("us-east-1", "us-west-2"))
                 .version(List.of("0"))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AWSEventMetadataProps.Builder	A builder for AWSEventMetadataProps
static final class	AWSEventMetadataProps.Jsii$Proxy	An implementation for AWSEventMetadataProps

Method Summary

Modifier and Type	Method	Description
static AWSEventMetadataProps.Builder	builder()
default List<String>	getRegion()	Identifies the AWS region where the event originated.
default List<String>	getResources()	This JSON array contains ARNs that identify resources that are involved in the event.
default List<String>	getVersion()	By default, this is set to 0 (zero) in all events.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRegion

@Stability(Stable)
@Nullable
default List<String> getRegion()

Identifies the AWS region where the event originated.

Default: - No filtering on region

getResources

@Stability(Stable)
@Nullable
default List<String> getResources()

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

getVersion

@Stability(Stable)
@Nullable
default List<String> getVersion()

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

Default: - No filtering on version

builder

@Stability(Stable)
static AWSEventMetadataProps.Builder builder()

Returns:

a AWSEventMetadataProps.Builder of AWSEventMetadataProps