BucketEvents

class aws_cdk.mixins_preview.aws_s3.events.BucketEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for Bucket.

Stability:: experimental
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"]
    )
)

Methods

aws_api_call_via_cloud_trail_pattern(*, additional_event_data=None, aws_region=None, error_code=None, error_message=None, event_category=None, event_id=None, event_metadata=None, event_name=None, event_source=None, event_time=None, event_type=None, event_version=None, management_event=None, read_only=None, recipient_account_id=None, request_id=None, request_parameters=None, resources=None, response_elements=None, source_ip_address=None, tls_details=None, user_agent=None, user_identity=None, vpc_endpoint_id=None)

(experimental) EventBridge event pattern for Bucket AWS API Call via CloudTrail.

Parameters:

additional_event_data (Union[AdditionalEventData, Dict[str, Any], None]) – (experimental) additionalEventData property. Specify an array of string values to match this event if the actual value of additionalEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
aws_region (Optional[Sequence[str]]) – (experimental) awsRegion property. Specify an array of string values to match this event if the actual value of awsRegion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
error_code (Optional[Sequence[str]]) – (experimental) errorCode property. Specify an array of string values to match this event if the actual value of errorCode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
error_message (Optional[Sequence[str]]) – (experimental) errorMessage property. Specify an array of string values to match this event if the actual value of errorMessage is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_category (Optional[Sequence[str]]) – (experimental) eventCategory property. Specify an array of string values to match this event if the actual value of eventCategory is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_id (Optional[Sequence[str]]) – (experimental) eventID property. Specify an array of string values to match this event if the actual value of eventID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (experimental) eventName property. Specify an array of string values to match this event if the actual value of eventName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_source (Optional[Sequence[str]]) – (experimental) eventSource property. Specify an array of string values to match this event if the actual value of eventSource is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_time (Optional[Sequence[str]]) – (experimental) eventTime property. Specify an array of string values to match this event if the actual value of eventTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_type (Optional[Sequence[str]]) – (experimental) eventType property. Specify an array of string values to match this event if the actual value of eventType is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_version (Optional[Sequence[str]]) – (experimental) eventVersion property. Specify an array of string values to match this event if the actual value of eventVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
management_event (Optional[Sequence[str]]) – (experimental) managementEvent property. Specify an array of string values to match this event if the actual value of managementEvent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
read_only (Optional[Sequence[str]]) – (experimental) readOnly property. Specify an array of string values to match this event if the actual value of readOnly is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
recipient_account_id (Optional[Sequence[str]]) – (experimental) recipientAccountId property. Specify an array of string values to match this event if the actual value of recipientAccountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) requestID property. Specify an array of string values to match this event if the actual value of requestID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_parameters (Union[RequestParameters, Dict[str, Any], None]) – (experimental) requestParameters property. Specify an array of string values to match this event if the actual value of requestParameters is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
resources (Optional[Sequence[Union[AwsapiCallViaCloudTrailItem, Dict[str, Any]]]]) – (experimental) resources property. Specify an array of string values to match this event if the actual value of resources is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
response_elements (Optional[Sequence[str]]) – (experimental) responseElements property. Specify an array of string values to match this event if the actual value of responseElements is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) sourceIPAddress property. Specify an array of string values to match this event if the actual value of sourceIPAddress is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
tls_details (Union[TlsDetails, Dict[str, Any], None]) – (experimental) tlsDetails property. Specify an array of string values to match this event if the actual value of tlsDetails is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
user_agent (Optional[Sequence[str]]) – (experimental) userAgent property. Specify an array of string values to match this event if the actual value of userAgent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
user_identity (Union[UserIdentity, Dict[str, Any], None]) – (experimental) userIdentity property. Specify an array of string values to match this event if the actual value of userIdentity is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
vpc_endpoint_id (Optional[Sequence[str]]) – (experimental) vpcEndpointId property. Specify an array of string values to match this event if the actual value of vpcEndpointId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_access_tier_changed_pattern(*, bucket=None, destination_access_tier=None, event_metadata=None, object=None, requester=None, request_id=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Access Tier Changed.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
destination_access_tier (Optional[Sequence[str]]) – (experimental) destination-access-tier property. Specify an array of string values to match this event if the actual value of destination-access-tier is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_acl_updated_pattern(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, version=None)

(experimental) EventBridge event pattern for Bucket Object ACL Updated.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_created_pattern(*, bucket=None, event_metadata=None, object=None, reason=None, requester=None, request_id=None, source_ip_address=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Created.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_deleted_pattern(*, bucket=None, deletion_type=None, event_metadata=None, object=None, reason=None, requester=None, request_id=None, source_ip_address=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Deleted.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
deletion_type (Optional[Sequence[str]]) – (experimental) deletion-type property. Specify an array of string values to match this event if the actual value of deletion-type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_restore_completed_pattern(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, restore_expiry_time=None, source_storage_class=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Restore Completed.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
restore_expiry_time (Optional[Sequence[str]]) – (experimental) restore-expiry-time property. Specify an array of string values to match this event if the actual value of restore-expiry-time is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_storage_class (Optional[Sequence[str]]) – (experimental) source-storage-class property. Specify an array of string values to match this event if the actual value of source-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_restore_expired_pattern(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Restore Expired.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_restore_initiated_pattern(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, source_storage_class=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Restore Initiated.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_storage_class (Optional[Sequence[str]]) – (experimental) source-storage-class property. Specify an array of string values to match this event if the actual value of source-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_storage_class_changed_pattern(*, bucket=None, destination_storage_class=None, event_metadata=None, object=None, requester=None, request_id=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Storage Class Changed.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
destination_storage_class (Optional[Sequence[str]]) – (experimental) destination-storage-class property. Specify an array of string values to match this event if the actual value of destination-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_tags_added_pattern(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Tags Added.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

object_tags_deleted_pattern(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, version=None)

(experimental) EventBridge event pattern for Bucket Object Tags Deleted.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

Static Methods

classmethod from_bucket(bucket_ref)

(experimental) Create BucketEvents from a Bucket reference.

Parameters:: bucket_ref (IBucketRef)
Stability:: experimental
Return type:: BucketEvents

AWSAPICallViaCloudTrail

class BucketEvents.AWSAPICallViaCloudTrail

Bases: object

(experimental) aws.s3@AWSAPICallViaCloudTrail event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

a_wSAPICall_via_cloud_trail = s3_events.BucketEvents.AWSAPICallViaCloudTrail()

Stability:: experimental

AWSAPICallViaCloudTrailProps

class BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps(*, additional_event_data=None, aws_region=None, error_code=None, error_message=None, event_category=None, event_id=None, event_metadata=None, event_name=None, event_source=None, event_time=None, event_type=None, event_version=None, management_event=None, read_only=None, recipient_account_id=None, request_id=None, request_parameters=None, resources=None, response_elements=None, source_ip_address=None, tls_details=None, user_agent=None, user_identity=None, vpc_endpoint_id=None)

Bases: object

(experimental) Props type for Bucket aws.s3@AWSAPICallViaCloudTrail event.

Parameters:

additional_event_data (Union[AdditionalEventData, Dict[str, Any], None]) – (experimental) additionalEventData property. Specify an array of string values to match this event if the actual value of additionalEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
aws_region (Optional[Sequence[str]]) – (experimental) awsRegion property. Specify an array of string values to match this event if the actual value of awsRegion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
error_code (Optional[Sequence[str]]) – (experimental) errorCode property. Specify an array of string values to match this event if the actual value of errorCode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
error_message (Optional[Sequence[str]]) – (experimental) errorMessage property. Specify an array of string values to match this event if the actual value of errorMessage is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_category (Optional[Sequence[str]]) – (experimental) eventCategory property. Specify an array of string values to match this event if the actual value of eventCategory is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_id (Optional[Sequence[str]]) – (experimental) eventID property. Specify an array of string values to match this event if the actual value of eventID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (experimental) eventName property. Specify an array of string values to match this event if the actual value of eventName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_source (Optional[Sequence[str]]) – (experimental) eventSource property. Specify an array of string values to match this event if the actual value of eventSource is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_time (Optional[Sequence[str]]) – (experimental) eventTime property. Specify an array of string values to match this event if the actual value of eventTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_type (Optional[Sequence[str]]) – (experimental) eventType property. Specify an array of string values to match this event if the actual value of eventType is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_version (Optional[Sequence[str]]) – (experimental) eventVersion property. Specify an array of string values to match this event if the actual value of eventVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
management_event (Optional[Sequence[str]]) – (experimental) managementEvent property. Specify an array of string values to match this event if the actual value of managementEvent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
read_only (Optional[Sequence[str]]) – (experimental) readOnly property. Specify an array of string values to match this event if the actual value of readOnly is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
recipient_account_id (Optional[Sequence[str]]) – (experimental) recipientAccountId property. Specify an array of string values to match this event if the actual value of recipientAccountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) requestID property. Specify an array of string values to match this event if the actual value of requestID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_parameters (Union[RequestParameters, Dict[str, Any], None]) – (experimental) requestParameters property. Specify an array of string values to match this event if the actual value of requestParameters is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
resources (Optional[Sequence[Union[AwsapiCallViaCloudTrailItem, Dict[str, Any]]]]) – (experimental) resources property. Specify an array of string values to match this event if the actual value of resources is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
response_elements (Optional[Sequence[str]]) – (experimental) responseElements property. Specify an array of string values to match this event if the actual value of responseElements is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) sourceIPAddress property. Specify an array of string values to match this event if the actual value of sourceIPAddress is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
tls_details (Union[TlsDetails, Dict[str, Any], None]) – (experimental) tlsDetails property. Specify an array of string values to match this event if the actual value of tlsDetails is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
user_agent (Optional[Sequence[str]]) – (experimental) userAgent property. Specify an array of string values to match this event if the actual value of userAgent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
user_identity (Union[UserIdentity, Dict[str, Any], None]) – (experimental) userIdentity property. Specify an array of string values to match this event if the actual value of userIdentity is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
vpc_endpoint_id (Optional[Sequence[str]]) – (experimental) vpcEndpointId property. Specify an array of string values to match this event if the actual value of vpcEndpointId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

a_wSAPICall_via_cloud_trail_props = s3_events.BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps(
    additional_event_data=s3_events.BucketEvents.AWSAPICallViaCloudTrail.AdditionalEventData(
        authentication_method=["authenticationMethod"],
        bytes_transferred_in=["bytesTransferredIn"],
        bytes_transferred_out=["bytesTransferredOut"],
        cipher_suite=["cipherSuite"],
        object_retention_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.ObjectRetentionInfo(
            legal_hold_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.LegalHoldInfo(
                is_under_legal_hold=["isUnderLegalHold"],
                last_modified_time=["lastModifiedTime"]
            ),
            retention_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.RetentionInfo(
                last_modified_time=["lastModifiedTime"],
                retain_until_mode=["retainUntilMode"],
                retain_until_time=["retainUntilTime"]
            )
        ),
        signature_version=["signatureVersion"],
        x_amz_id2=["xAmzId2"]
    ),
    aws_region=["awsRegion"],
    error_code=["errorCode"],
    error_message=["errorMessage"],
    event_category=["eventCategory"],
    event_id=["eventId"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    event_name=["eventName"],
    event_source=["eventSource"],
    event_time=["eventTime"],
    event_type=["eventType"],
    event_version=["eventVersion"],
    management_event=["managementEvent"],
    read_only=["readOnly"],
    recipient_account_id=["recipientAccountId"],
    request_id=["requestId"],
    request_parameters=s3_events.BucketEvents.AWSAPICallViaCloudTrail.RequestParameters(
        bucket_name=["bucketName"],
        host=["host"],
        key=["key"],
        legal_hold=["legalHold"],
        retention=["retention"]
    ),
    resources=[s3_events.BucketEvents.AWSAPICallViaCloudTrail.AwsapiCallViaCloudTrailItem(
        account_id=["accountId"],
        arn=["arn"],
        type=["type"]
    )],
    response_elements=["responseElements"],
    source_ip_address=["sourceIpAddress"],
    tls_details=s3_events.BucketEvents.AWSAPICallViaCloudTrail.TlsDetails(
        cipher_suite=["cipherSuite"],
        client_provided_host_header=["clientProvidedHostHeader"],
        tls_version=["tlsVersion"]
    ),
    user_agent=["userAgent"],
    user_identity=s3_events.BucketEvents.AWSAPICallViaCloudTrail.UserIdentity(
        access_key_id=["accessKeyId"],
        account_id=["accountId"],
        arn=["arn"],
        principal_id=["principalId"],
        session_context=s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionContext(
            attributes=s3_events.BucketEvents.AWSAPICallViaCloudTrail.Attributes(
                creation_date=["creationDate"],
                mfa_authenticated=["mfaAuthenticated"]
            ),
            session_issuer=s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionIssuer(
                account_id=["accountId"],
                arn=["arn"],
                principal_id=["principalId"],
                type=["type"],
                user_name=["userName"]
            ),
            web_id_federation_data=["webIdFederationData"]
        ),
        type=["type"]
    ),
    vpc_endpoint_id=["vpcEndpointId"]
)

Attributes

additional_event_data

(experimental) additionalEventData property.

Specify an array of string values to match this event if the actual value of additionalEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

aws_region

(experimental) awsRegion property.

Specify an array of string values to match this event if the actual value of awsRegion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

error_code

(experimental) errorCode property.

Specify an array of string values to match this event if the actual value of errorCode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

error_message

(experimental) errorMessage property.

Specify an array of string values to match this event if the actual value of errorMessage is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_category

(experimental) eventCategory property.

Specify an array of string values to match this event if the actual value of eventCategory is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_id

(experimental) eventID property.

Specify an array of string values to match this event if the actual value of eventID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

event_name

(experimental) eventName property.

Specify an array of string values to match this event if the actual value of eventName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_source

(experimental) eventSource property.

Specify an array of string values to match this event if the actual value of eventSource is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_time

(experimental) eventTime property.

Specify an array of string values to match this event if the actual value of eventTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_type

(experimental) eventType property.

Specify an array of string values to match this event if the actual value of eventType is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_version

(experimental) eventVersion property.

Specify an array of string values to match this event if the actual value of eventVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

management_event

(experimental) managementEvent property.

Specify an array of string values to match this event if the actual value of managementEvent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

read_only

(experimental) readOnly property.

Specify an array of string values to match this event if the actual value of readOnly is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

recipient_account_id

(experimental) recipientAccountId property.

Specify an array of string values to match this event if the actual value of recipientAccountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) requestID property.

Specify an array of string values to match this event if the actual value of requestID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_parameters

(experimental) requestParameters property.

Specify an array of string values to match this event if the actual value of requestParameters is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

resources

(experimental) resources property.

Specify an array of string values to match this event if the actual value of resources is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

response_elements

(experimental) responseElements property.

Specify an array of string values to match this event if the actual value of responseElements is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) sourceIPAddress property.

Specify an array of string values to match this event if the actual value of sourceIPAddress is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

tls_details

(experimental) tlsDetails property.

Specify an array of string values to match this event if the actual value of tlsDetails is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

user_agent

(experimental) userAgent property.

Specify an array of string values to match this event if the actual value of userAgent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

user_identity

(experimental) userIdentity property.

Specify an array of string values to match this event if the actual value of userIdentity is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

vpc_endpoint_id

(experimental) vpcEndpointId property.

Specify an array of string values to match this event if the actual value of vpcEndpointId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

AdditionalEventData

class BucketEvents.AWSAPICallViaCloudTrail.AdditionalEventData(*, authentication_method=None, bytes_transferred_in=None, bytes_transferred_out=None, cipher_suite=None, object_retention_info=None, signature_version=None, x_amz_id2=None)

Bases: object

(experimental) Type definition for AdditionalEventData.

Parameters:

authentication_method (Optional[Sequence[str]]) – (experimental) AuthenticationMethod property. Specify an array of string values to match this event if the actual value of AuthenticationMethod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
bytes_transferred_in (Optional[Sequence[str]]) – (experimental) bytesTransferredIn property. Specify an array of string values to match this event if the actual value of bytesTransferredIn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
bytes_transferred_out (Optional[Sequence[str]]) – (experimental) bytesTransferredOut property. Specify an array of string values to match this event if the actual value of bytesTransferredOut is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
cipher_suite (Optional[Sequence[str]]) – (experimental) CipherSuite property. Specify an array of string values to match this event if the actual value of CipherSuite is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
object_retention_info (Union[ObjectRetentionInfo, Dict[str, Any], None]) – (experimental) objectRetentionInfo property. Specify an array of string values to match this event if the actual value of objectRetentionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
signature_version (Optional[Sequence[str]]) – (experimental) SignatureVersion property. Specify an array of string values to match this event if the actual value of SignatureVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
x_amz_id2 (Optional[Sequence[str]]) – (experimental) x-amz-id-2 property. Specify an array of string values to match this event if the actual value of x-amz-id-2 is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

additional_event_data = s3_events.BucketEvents.AWSAPICallViaCloudTrail.AdditionalEventData(
    authentication_method=["authenticationMethod"],
    bytes_transferred_in=["bytesTransferredIn"],
    bytes_transferred_out=["bytesTransferredOut"],
    cipher_suite=["cipherSuite"],
    object_retention_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.ObjectRetentionInfo(
        legal_hold_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.LegalHoldInfo(
            is_under_legal_hold=["isUnderLegalHold"],
            last_modified_time=["lastModifiedTime"]
        ),
        retention_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.RetentionInfo(
            last_modified_time=["lastModifiedTime"],
            retain_until_mode=["retainUntilMode"],
            retain_until_time=["retainUntilTime"]
        )
    ),
    signature_version=["signatureVersion"],
    x_amz_id2=["xAmzId2"]
)

Attributes

authentication_method

(experimental) AuthenticationMethod property.

Specify an array of string values to match this event if the actual value of AuthenticationMethod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

bytes_transferred_in

(experimental) bytesTransferredIn property.

Specify an array of string values to match this event if the actual value of bytesTransferredIn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

bytes_transferred_out

(experimental) bytesTransferredOut property.

Specify an array of string values to match this event if the actual value of bytesTransferredOut is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

cipher_suite

(experimental) CipherSuite property.

Specify an array of string values to match this event if the actual value of CipherSuite is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

object_retention_info

(experimental) objectRetentionInfo property.

Specify an array of string values to match this event if the actual value of objectRetentionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

signature_version

(experimental) SignatureVersion property.

Specify an array of string values to match this event if the actual value of SignatureVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

x_amz_id2

(experimental) x-amz-id-2 property.

Specify an array of string values to match this event if the actual value of x-amz-id-2 is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

Attributes

class BucketEvents.AWSAPICallViaCloudTrail.Attributes(*, creation_date=None, mfa_authenticated=None)

Bases: object

(experimental) Type definition for Attributes.

Parameters:

creation_date (Optional[Sequence[str]]) – (experimental) creationDate property. Specify an array of string values to match this event if the actual value of creationDate is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
mfa_authenticated (Optional[Sequence[str]]) – (experimental) mfaAuthenticated property. Specify an array of string values to match this event if the actual value of mfaAuthenticated is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

attributes = s3_events.BucketEvents.AWSAPICallViaCloudTrail.Attributes(
    creation_date=["creationDate"],
    mfa_authenticated=["mfaAuthenticated"]
)

Attributes

creation_date

(experimental) creationDate property.

Specify an array of string values to match this event if the actual value of creationDate is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

mfa_authenticated

(experimental) mfaAuthenticated property.

Specify an array of string values to match this event if the actual value of mfaAuthenticated is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

AwsapiCallViaCloudTrailItem

class BucketEvents.AWSAPICallViaCloudTrail.AwsapiCallViaCloudTrailItem(*, account_id=None, arn=None, type=None)

Bases: object

(experimental) Type definition for AWSAPICallViaCloudTrailItem.

Parameters:

account_id (Optional[Sequence[str]]) – (experimental) accountId property. Specify an array of string values to match this event if the actual value of accountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
arn (Optional[Sequence[str]]) – (experimental) ARN property. Specify an array of string values to match this event if the actual value of ARN is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
type (Optional[Sequence[str]]) – (experimental) type property. Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

awsapi_call_via_cloud_trail_item = s3_events.BucketEvents.AWSAPICallViaCloudTrail.AwsapiCallViaCloudTrailItem(
    account_id=["accountId"],
    arn=["arn"],
    type=["type"]
)

Attributes

account_id

(experimental) accountId property.

Specify an array of string values to match this event if the actual value of accountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

arn

(experimental) ARN property.

Specify an array of string values to match this event if the actual value of ARN is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

type

(experimental) type property.

Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

LegalHoldInfo

class BucketEvents.AWSAPICallViaCloudTrail.LegalHoldInfo(*, is_under_legal_hold=None, last_modified_time=None)

Bases: object

(experimental) Type definition for LegalHoldInfo.

Parameters:

is_under_legal_hold (Optional[Sequence[str]]) – (experimental) isUnderLegalHold property. Specify an array of string values to match this event if the actual value of isUnderLegalHold is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
last_modified_time (Optional[Sequence[str]]) – (experimental) lastModifiedTime property. Specify an array of string values to match this event if the actual value of lastModifiedTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

legal_hold_info = s3_events.BucketEvents.AWSAPICallViaCloudTrail.LegalHoldInfo(
    is_under_legal_hold=["isUnderLegalHold"],
    last_modified_time=["lastModifiedTime"]
)

Attributes

is_under_legal_hold

(experimental) isUnderLegalHold property.

Specify an array of string values to match this event if the actual value of isUnderLegalHold is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

last_modified_time

(experimental) lastModifiedTime property.

Specify an array of string values to match this event if the actual value of lastModifiedTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectRetentionInfo

class BucketEvents.AWSAPICallViaCloudTrail.ObjectRetentionInfo(*, legal_hold_info=None, retention_info=None)

Bases: object

(experimental) Type definition for ObjectRetentionInfo.

Parameters:

legal_hold_info (Union[LegalHoldInfo, Dict[str, Any], None]) – (experimental) legalHoldInfo property. Specify an array of string values to match this event if the actual value of legalHoldInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
retention_info (Union[RetentionInfo, Dict[str, Any], None]) – (experimental) retentionInfo property. Specify an array of string values to match this event if the actual value of retentionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_retention_info = s3_events.BucketEvents.AWSAPICallViaCloudTrail.ObjectRetentionInfo(
    legal_hold_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.LegalHoldInfo(
        is_under_legal_hold=["isUnderLegalHold"],
        last_modified_time=["lastModifiedTime"]
    ),
    retention_info=s3_events.BucketEvents.AWSAPICallViaCloudTrail.RetentionInfo(
        last_modified_time=["lastModifiedTime"],
        retain_until_mode=["retainUntilMode"],
        retain_until_time=["retainUntilTime"]
    )
)

Attributes

legal_hold_info

(experimental) legalHoldInfo property.

Specify an array of string values to match this event if the actual value of legalHoldInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

retention_info

(experimental) retentionInfo property.

Specify an array of string values to match this event if the actual value of retentionInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

RequestParameters

class BucketEvents.AWSAPICallViaCloudTrail.RequestParameters(*, bucket_name=None, host=None, key=None, legal_hold=None, retention=None)

Bases: object

(experimental) Type definition for RequestParameters.

Parameters:

bucket_name (Optional[Sequence[str]]) – (experimental) bucketName property. Specify an array of string values to match this event if the actual value of bucketName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
host (Optional[Sequence[str]]) – (experimental) Host property. Specify an array of string values to match this event if the actual value of Host is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
legal_hold (Optional[Sequence[str]]) – (experimental) legal-hold property. Specify an array of string values to match this event if the actual value of legal-hold is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
retention (Optional[Sequence[str]]) – (experimental) retention property. Specify an array of string values to match this event if the actual value of retention is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

request_parameters = s3_events.BucketEvents.AWSAPICallViaCloudTrail.RequestParameters(
    bucket_name=["bucketName"],
    host=["host"],
    key=["key"],
    legal_hold=["legalHold"],
    retention=["retention"]
)

Attributes

bucket_name

(experimental) bucketName property.

Specify an array of string values to match this event if the actual value of bucketName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

host

(experimental) Host property.

Specify an array of string values to match this event if the actual value of Host is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

legal_hold

(experimental) legal-hold property.

Specify an array of string values to match this event if the actual value of legal-hold is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

retention

(experimental) retention property.

Specify an array of string values to match this event if the actual value of retention is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

RetentionInfo

class BucketEvents.AWSAPICallViaCloudTrail.RetentionInfo(*, last_modified_time=None, retain_until_mode=None, retain_until_time=None)

Bases: object

(experimental) Type definition for RetentionInfo.

Parameters:

last_modified_time (Optional[Sequence[str]]) – (experimental) lastModifiedTime property. Specify an array of string values to match this event if the actual value of lastModifiedTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
retain_until_mode (Optional[Sequence[str]]) – (experimental) retainUntilMode property. Specify an array of string values to match this event if the actual value of retainUntilMode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
retain_until_time (Optional[Sequence[str]]) – (experimental) retainUntilTime property. Specify an array of string values to match this event if the actual value of retainUntilTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

retention_info = s3_events.BucketEvents.AWSAPICallViaCloudTrail.RetentionInfo(
    last_modified_time=["lastModifiedTime"],
    retain_until_mode=["retainUntilMode"],
    retain_until_time=["retainUntilTime"]
)

Attributes

last_modified_time

(experimental) lastModifiedTime property.

Specify an array of string values to match this event if the actual value of lastModifiedTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

retain_until_mode

(experimental) retainUntilMode property.

Specify an array of string values to match this event if the actual value of retainUntilMode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

retain_until_time

(experimental) retainUntilTime property.

Specify an array of string values to match this event if the actual value of retainUntilTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

SessionContext

class BucketEvents.AWSAPICallViaCloudTrail.SessionContext(*, attributes=None, session_issuer=None, web_id_federation_data=None)

Bases: object

(experimental) Type definition for SessionContext.

Parameters:

attributes (Union[Attributes, Dict[str, Any], None]) – (experimental) attributes property. Specify an array of string values to match this event if the actual value of attributes is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
session_issuer (Union[SessionIssuer, Dict[str, Any], None]) – (experimental) sessionIssuer property. Specify an array of string values to match this event if the actual value of sessionIssuer is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
web_id_federation_data (Optional[Sequence[str]]) – (experimental) webIdFederationData property. Specify an array of string values to match this event if the actual value of webIdFederationData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

session_context = s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionContext(
    attributes=s3_events.BucketEvents.AWSAPICallViaCloudTrail.Attributes(
        creation_date=["creationDate"],
        mfa_authenticated=["mfaAuthenticated"]
    ),
    session_issuer=s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionIssuer(
        account_id=["accountId"],
        arn=["arn"],
        principal_id=["principalId"],
        type=["type"],
        user_name=["userName"]
    ),
    web_id_federation_data=["webIdFederationData"]
)

Attributes

attributes

(experimental) attributes property.

Specify an array of string values to match this event if the actual value of attributes is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

session_issuer

(experimental) sessionIssuer property.

Specify an array of string values to match this event if the actual value of sessionIssuer is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

web_id_federation_data

(experimental) webIdFederationData property.

Specify an array of string values to match this event if the actual value of webIdFederationData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

SessionIssuer

class BucketEvents.AWSAPICallViaCloudTrail.SessionIssuer(*, account_id=None, arn=None, principal_id=None, type=None, user_name=None)

Bases: object

(experimental) Type definition for SessionIssuer.

Parameters:

account_id (Optional[Sequence[str]]) – (experimental) accountId property. Specify an array of string values to match this event if the actual value of accountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
arn (Optional[Sequence[str]]) – (experimental) arn property. Specify an array of string values to match this event if the actual value of arn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
principal_id (Optional[Sequence[str]]) – (experimental) principalId property. Specify an array of string values to match this event if the actual value of principalId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
type (Optional[Sequence[str]]) – (experimental) type property. Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
user_name (Optional[Sequence[str]]) – (experimental) userName property. Specify an array of string values to match this event if the actual value of userName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

session_issuer = s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionIssuer(
    account_id=["accountId"],
    arn=["arn"],
    principal_id=["principalId"],
    type=["type"],
    user_name=["userName"]
)

Attributes

account_id

(experimental) accountId property.

Specify an array of string values to match this event if the actual value of accountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

arn

(experimental) arn property.

Specify an array of string values to match this event if the actual value of arn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

principal_id

(experimental) principalId property.

Specify an array of string values to match this event if the actual value of principalId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

type

(experimental) type property.

Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

user_name

(experimental) userName property.

Specify an array of string values to match this event if the actual value of userName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

TlsDetails

class BucketEvents.AWSAPICallViaCloudTrail.TlsDetails(*, cipher_suite=None, client_provided_host_header=None, tls_version=None)

Bases: object

(experimental) Type definition for TlsDetails.

Parameters:

cipher_suite (Optional[Sequence[str]]) – (experimental) cipherSuite property. Specify an array of string values to match this event if the actual value of cipherSuite is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
client_provided_host_header (Optional[Sequence[str]]) – (experimental) clientProvidedHostHeader property. Specify an array of string values to match this event if the actual value of clientProvidedHostHeader is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
tls_version (Optional[Sequence[str]]) – (experimental) tlsVersion property. Specify an array of string values to match this event if the actual value of tlsVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

tls_details = s3_events.BucketEvents.AWSAPICallViaCloudTrail.TlsDetails(
    cipher_suite=["cipherSuite"],
    client_provided_host_header=["clientProvidedHostHeader"],
    tls_version=["tlsVersion"]
)

Attributes

cipher_suite

(experimental) cipherSuite property.

Specify an array of string values to match this event if the actual value of cipherSuite is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

client_provided_host_header

(experimental) clientProvidedHostHeader property.

Specify an array of string values to match this event if the actual value of clientProvidedHostHeader is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

tls_version

(experimental) tlsVersion property.

Specify an array of string values to match this event if the actual value of tlsVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

UserIdentity

class BucketEvents.AWSAPICallViaCloudTrail.UserIdentity(*, access_key_id=None, account_id=None, arn=None, principal_id=None, session_context=None, type=None)

Bases: object

(experimental) Type definition for UserIdentity.

Parameters:

access_key_id (Optional[Sequence[str]]) – (experimental) accessKeyId property. Specify an array of string values to match this event if the actual value of accessKeyId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
account_id (Optional[Sequence[str]]) – (experimental) accountId property. Specify an array of string values to match this event if the actual value of accountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
arn (Optional[Sequence[str]]) – (experimental) arn property. Specify an array of string values to match this event if the actual value of arn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
principal_id (Optional[Sequence[str]]) – (experimental) principalId property. Specify an array of string values to match this event if the actual value of principalId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
session_context (Union[SessionContext, Dict[str, Any], None]) – (experimental) sessionContext property. Specify an array of string values to match this event if the actual value of sessionContext is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
type (Optional[Sequence[str]]) – (experimental) type property. Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

user_identity = s3_events.BucketEvents.AWSAPICallViaCloudTrail.UserIdentity(
    access_key_id=["accessKeyId"],
    account_id=["accountId"],
    arn=["arn"],
    principal_id=["principalId"],
    session_context=s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionContext(
        attributes=s3_events.BucketEvents.AWSAPICallViaCloudTrail.Attributes(
            creation_date=["creationDate"],
            mfa_authenticated=["mfaAuthenticated"]
        ),
        session_issuer=s3_events.BucketEvents.AWSAPICallViaCloudTrail.SessionIssuer(
            account_id=["accountId"],
            arn=["arn"],
            principal_id=["principalId"],
            type=["type"],
            user_name=["userName"]
        ),
        web_id_federation_data=["webIdFederationData"]
    ),
    type=["type"]
)

Attributes

access_key_id

(experimental) accessKeyId property.

Specify an array of string values to match this event if the actual value of accessKeyId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

account_id

(experimental) accountId property.

Specify an array of string values to match this event if the actual value of accountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

arn

(experimental) arn property.

Specify an array of string values to match this event if the actual value of arn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

principal_id

(experimental) principalId property.

Specify an array of string values to match this event if the actual value of principalId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

session_context

(experimental) sessionContext property.

Specify an array of string values to match this event if the actual value of sessionContext is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

type

(experimental) type property.

Specify an array of string values to match this event if the actual value of type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectACLUpdated

class BucketEvents.ObjectACLUpdated

Bases: object

(experimental) aws.s3@ObjectACLUpdated event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_aCLUpdated = s3_events.BucketEvents.ObjectACLUpdated()

Stability:: experimental

Bucket

class BucketEvents.ObjectACLUpdated.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectACLUpdated.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectACLUpdatedProps

class BucketEvents.ObjectACLUpdated.ObjectACLUpdatedProps(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectACLUpdated event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_aCLUpdated_props = s3_events.BucketEvents.ObjectACLUpdated.ObjectACLUpdatedProps(
    bucket=s3_events.BucketEvents.ObjectACLUpdated.Bucket(
        name=["name"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectACLUpdated.ObjectType(
        etag=["etag"],
        key=["key"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    source_ip_address=["sourceIpAddress"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) source-ip-address property.

Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectACLUpdated.ObjectType(*, etag=None, key=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectACLUpdated.ObjectType(
    etag=["etag"],
    key=["key"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectAccessTierChanged

class BucketEvents.ObjectAccessTierChanged

Bases: object

(experimental) aws.s3@ObjectAccessTierChanged event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_access_tier_changed = s3_events.BucketEvents.ObjectAccessTierChanged()

Stability:: experimental

Bucket

class BucketEvents.ObjectAccessTierChanged.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectAccessTierChanged.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectAccessTierChangedProps

class BucketEvents.ObjectAccessTierChanged.ObjectAccessTierChangedProps(*, bucket=None, destination_access_tier=None, event_metadata=None, object=None, requester=None, request_id=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectAccessTierChanged event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
destination_access_tier (Optional[Sequence[str]]) – (experimental) destination-access-tier property. Specify an array of string values to match this event if the actual value of destination-access-tier is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_access_tier_changed_props = s3_events.BucketEvents.ObjectAccessTierChanged.ObjectAccessTierChangedProps(
    bucket=s3_events.BucketEvents.ObjectAccessTierChanged.Bucket(
        name=["name"]
    ),
    destination_access_tier=["destinationAccessTier"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectAccessTierChanged.ObjectType(
        etag=["etag"],
        key=["key"],
        size=["size"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

destination_access_tier

(experimental) destination-access-tier property.

Specify an array of string values to match this event if the actual value of destination-access-tier is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectAccessTierChanged.ObjectType(*, etag=None, key=None, size=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
size (Optional[Sequence[str]]) – (experimental) size property. Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectAccessTierChanged.ObjectType(
    etag=["etag"],
    key=["key"],
    size=["size"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

size

(experimental) size property.

Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectCreated

class BucketEvents.ObjectCreated

Bases: object

(experimental) aws.s3@ObjectCreated event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_created = s3_events.BucketEvents.ObjectCreated()

Stability:: experimental

Bucket

class BucketEvents.ObjectCreated.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectCreated.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectCreatedProps

class BucketEvents.ObjectCreated.ObjectCreatedProps(*, bucket=None, event_metadata=None, object=None, reason=None, requester=None, request_id=None, source_ip_address=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectCreated event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

infused

Example:

from aws_cdk.mixins_preview.aws_s3.events import BucketEvents
import aws_cdk.aws_events as events
import aws_cdk.aws_events_targets as targets
# fn: lambda.Function


# Works with L2 constructs
bucket = s3.Bucket(scope, "Bucket")
bucket_events = BucketEvents.from_bucket(bucket)

events.Rule(scope, "Rule",
    event_pattern=bucket_events.object_created_pattern(
        object=BucketEvents.ObjectCreated.ObjectType(key=["uploads/*"])
    ),
    targets=[targets.LambdaFunction(fn)]
)

# Also works with L1 constructs
cfn_bucket = s3.CfnBucket(scope, "CfnBucket")
cfn_bucket_events = BucketEvents.from_bucket(cfn_bucket)

events.CfnRule(scope, "CfnRule",
    state="ENABLED",
    event_pattern=cfn_bucket_events.object_created_pattern(
        object=BucketEvents.ObjectCreated.ObjectType(key=["uploads/*"])
    ),
    targets=[events.CfnRule.TargetProperty(arn=fn.function_arn, id="L1")]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

reason

(experimental) reason property.

Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) source-ip-address property.

Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectCreated.ObjectType(*, etag=None, key=None, sequencer=None, size=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
sequencer (Optional[Sequence[str]]) – (experimental) sequencer property. Specify an array of string values to match this event if the actual value of sequencer is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
size (Optional[Sequence[str]]) – (experimental) size property. Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

infused

Example:

from aws_cdk.mixins_preview.aws_s3.events import BucketEvents
import aws_cdk.aws_events as events
import aws_cdk.aws_events_targets as targets
# fn: lambda.Function


# Works with L2 constructs
bucket = s3.Bucket(scope, "Bucket")
bucket_events = BucketEvents.from_bucket(bucket)

events.Rule(scope, "Rule",
    event_pattern=bucket_events.object_created_pattern(
        object=BucketEvents.ObjectCreated.ObjectType(key=["uploads/*"])
    ),
    targets=[targets.LambdaFunction(fn)]
)

# Also works with L1 constructs
cfn_bucket = s3.CfnBucket(scope, "CfnBucket")
cfn_bucket_events = BucketEvents.from_bucket(cfn_bucket)

events.CfnRule(scope, "CfnRule",
    state="ENABLED",
    event_pattern=cfn_bucket_events.object_created_pattern(
        object=BucketEvents.ObjectCreated.ObjectType(key=["uploads/*"])
    ),
    targets=[events.CfnRule.TargetProperty(arn=fn.function_arn, id="L1")]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

sequencer

(experimental) sequencer property.

Specify an array of string values to match this event if the actual value of sequencer is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

size

(experimental) size property.

Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectDeleted

class BucketEvents.ObjectDeleted

Bases: object

(experimental) aws.s3@ObjectDeleted event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_deleted = s3_events.BucketEvents.ObjectDeleted()

Stability:: experimental

Bucket

class BucketEvents.ObjectDeleted.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectDeleted.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectDeletedProps

class BucketEvents.ObjectDeleted.ObjectDeletedProps(*, bucket=None, deletion_type=None, event_metadata=None, object=None, reason=None, requester=None, request_id=None, source_ip_address=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectDeleted event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
deletion_type (Optional[Sequence[str]]) – (experimental) deletion-type property. Specify an array of string values to match this event if the actual value of deletion-type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_deleted_props = s3_events.BucketEvents.ObjectDeleted.ObjectDeletedProps(
    bucket=s3_events.BucketEvents.ObjectDeleted.Bucket(
        name=["name"]
    ),
    deletion_type=["deletionType"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectDeleted.ObjectType(
        etag=["etag"],
        key=["key"],
        sequencer=["sequencer"],
        version_id=["versionId"]
    ),
    reason=["reason"],
    requester=["requester"],
    request_id=["requestId"],
    source_ip_address=["sourceIpAddress"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

deletion_type

(experimental) deletion-type property.

Specify an array of string values to match this event if the actual value of deletion-type is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

reason

(experimental) reason property.

Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) source-ip-address property.

Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectDeleted.ObjectType(*, etag=None, key=None, sequencer=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
sequencer (Optional[Sequence[str]]) – (experimental) sequencer property. Specify an array of string values to match this event if the actual value of sequencer is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectDeleted.ObjectType(
    etag=["etag"],
    key=["key"],
    sequencer=["sequencer"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

sequencer

(experimental) sequencer property.

Specify an array of string values to match this event if the actual value of sequencer is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectRestoreCompleted

class BucketEvents.ObjectRestoreCompleted

Bases: object

(experimental) aws.s3@ObjectRestoreCompleted event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_restore_completed = s3_events.BucketEvents.ObjectRestoreCompleted()

Stability:: experimental

Bucket

class BucketEvents.ObjectRestoreCompleted.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectRestoreCompleted.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectRestoreCompletedProps

class BucketEvents.ObjectRestoreCompleted.ObjectRestoreCompletedProps(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, restore_expiry_time=None, source_storage_class=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectRestoreCompleted event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
restore_expiry_time (Optional[Sequence[str]]) – (experimental) restore-expiry-time property. Specify an array of string values to match this event if the actual value of restore-expiry-time is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_storage_class (Optional[Sequence[str]]) – (experimental) source-storage-class property. Specify an array of string values to match this event if the actual value of source-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_restore_completed_props = s3_events.BucketEvents.ObjectRestoreCompleted.ObjectRestoreCompletedProps(
    bucket=s3_events.BucketEvents.ObjectRestoreCompleted.Bucket(
        name=["name"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectRestoreCompleted.ObjectType(
        etag=["etag"],
        key=["key"],
        size=["size"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    restore_expiry_time=["restoreExpiryTime"],
    source_storage_class=["sourceStorageClass"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

restore_expiry_time

(experimental) restore-expiry-time property.

Specify an array of string values to match this event if the actual value of restore-expiry-time is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_storage_class

(experimental) source-storage-class property.

Specify an array of string values to match this event if the actual value of source-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectRestoreCompleted.ObjectType(*, etag=None, key=None, size=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
size (Optional[Sequence[str]]) – (experimental) size property. Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectRestoreCompleted.ObjectType(
    etag=["etag"],
    key=["key"],
    size=["size"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

size

(experimental) size property.

Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectRestoreExpired

class BucketEvents.ObjectRestoreExpired

Bases: object

(experimental) aws.s3@ObjectRestoreExpired event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_restore_expired = s3_events.BucketEvents.ObjectRestoreExpired()

Stability:: experimental

Bucket

class BucketEvents.ObjectRestoreExpired.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectRestoreExpired.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectRestoreExpiredProps

class BucketEvents.ObjectRestoreExpired.ObjectRestoreExpiredProps(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectRestoreExpired event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_restore_expired_props = s3_events.BucketEvents.ObjectRestoreExpired.ObjectRestoreExpiredProps(
    bucket=s3_events.BucketEvents.ObjectRestoreExpired.Bucket(
        name=["name"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectRestoreExpired.ObjectType(
        etag=["etag"],
        key=["key"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectRestoreExpired.ObjectType(*, etag=None, key=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectRestoreExpired.ObjectType(
    etag=["etag"],
    key=["key"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectRestoreInitiated

class BucketEvents.ObjectRestoreInitiated

Bases: object

(experimental) aws.s3@ObjectRestoreInitiated event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_restore_initiated = s3_events.BucketEvents.ObjectRestoreInitiated()

Stability:: experimental

Bucket

class BucketEvents.ObjectRestoreInitiated.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectRestoreInitiated.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectRestoreInitiatedProps

class BucketEvents.ObjectRestoreInitiated.ObjectRestoreInitiatedProps(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, source_storage_class=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectRestoreInitiated event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_storage_class (Optional[Sequence[str]]) – (experimental) source-storage-class property. Specify an array of string values to match this event if the actual value of source-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_restore_initiated_props = s3_events.BucketEvents.ObjectRestoreInitiated.ObjectRestoreInitiatedProps(
    bucket=s3_events.BucketEvents.ObjectRestoreInitiated.Bucket(
        name=["name"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectRestoreInitiated.ObjectType(
        etag=["etag"],
        key=["key"],
        size=["size"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    source_ip_address=["sourceIpAddress"],
    source_storage_class=["sourceStorageClass"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) source-ip-address property.

Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_storage_class

(experimental) source-storage-class property.

Specify an array of string values to match this event if the actual value of source-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectRestoreInitiated.ObjectType(*, etag=None, key=None, size=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
size (Optional[Sequence[str]]) – (experimental) size property. Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectRestoreInitiated.ObjectType(
    etag=["etag"],
    key=["key"],
    size=["size"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

size

(experimental) size property.

Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectStorageClassChanged

class BucketEvents.ObjectStorageClassChanged

Bases: object

(experimental) aws.s3@ObjectStorageClassChanged event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_storage_class_changed = s3_events.BucketEvents.ObjectStorageClassChanged()

Stability:: experimental

Bucket

class BucketEvents.ObjectStorageClassChanged.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectStorageClassChanged.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectStorageClassChangedProps

class BucketEvents.ObjectStorageClassChanged.ObjectStorageClassChangedProps(*, bucket=None, destination_storage_class=None, event_metadata=None, object=None, requester=None, request_id=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectStorageClassChanged event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
destination_storage_class (Optional[Sequence[str]]) – (experimental) destination-storage-class property. Specify an array of string values to match this event if the actual value of destination-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_storage_class_changed_props = s3_events.BucketEvents.ObjectStorageClassChanged.ObjectStorageClassChangedProps(
    bucket=s3_events.BucketEvents.ObjectStorageClassChanged.Bucket(
        name=["name"]
    ),
    destination_storage_class=["destinationStorageClass"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectStorageClassChanged.ObjectType(
        etag=["etag"],
        key=["key"],
        size=["size"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

destination_storage_class

(experimental) destination-storage-class property.

Specify an array of string values to match this event if the actual value of destination-storage-class is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectStorageClassChanged.ObjectType(*, etag=None, key=None, size=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
size (Optional[Sequence[str]]) – (experimental) size property. Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectStorageClassChanged.ObjectType(
    etag=["etag"],
    key=["key"],
    size=["size"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

size

(experimental) size property.

Specify an array of string values to match this event if the actual value of size is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectTagsAdded

class BucketEvents.ObjectTagsAdded

Bases: object

(experimental) aws.s3@ObjectTagsAdded event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_tags_added = s3_events.BucketEvents.ObjectTagsAdded()

Stability:: experimental

Bucket

class BucketEvents.ObjectTagsAdded.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectTagsAdded.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectTagsAddedProps

class BucketEvents.ObjectTagsAdded.ObjectTagsAddedProps(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectTagsAdded event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_tags_added_props = s3_events.BucketEvents.ObjectTagsAdded.ObjectTagsAddedProps(
    bucket=s3_events.BucketEvents.ObjectTagsAdded.Bucket(
        name=["name"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectTagsAdded.ObjectType(
        etag=["etag"],
        key=["key"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    source_ip_address=["sourceIpAddress"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) source-ip-address property.

Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectTagsAdded.ObjectType(*, etag=None, key=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectTagsAdded.ObjectType(
    etag=["etag"],
    key=["key"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectTagsDeleted

class BucketEvents.ObjectTagsDeleted

Bases: object

(experimental) aws.s3@ObjectTagsDeleted event types for Bucket.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_tags_deleted = s3_events.BucketEvents.ObjectTagsDeleted()

Stability:: experimental

Bucket

class BucketEvents.ObjectTagsDeleted.Bucket(*, name=None)

Bases: object

(experimental) Type definition for Bucket.

Parameters:: name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Bucket reference
Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

bucket = s3_events.BucketEvents.ObjectTagsDeleted.Bucket(
    name=["name"]
)

Attributes

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Bucket reference

Stability:

experimental

ObjectTagsDeletedProps

class BucketEvents.ObjectTagsDeleted.ObjectTagsDeletedProps(*, bucket=None, event_metadata=None, object=None, requester=None, request_id=None, source_ip_address=None, version=None)

Bases: object

(experimental) Props type for Bucket aws.s3@ObjectTagsDeleted event.

Parameters:

bucket (Union[Bucket, Dict[str, Any], None]) – (experimental) bucket property. Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
object (Union[ObjectType, Dict[str, Any], None]) – (experimental) object property. Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
requester (Optional[Sequence[str]]) – (experimental) requester property. Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
request_id (Optional[Sequence[str]]) – (experimental) request-id property. Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
source_ip_address (Optional[Sequence[str]]) – (experimental) source-ip-address property. Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_tags_deleted_props = s3_events.BucketEvents.ObjectTagsDeleted.ObjectTagsDeletedProps(
    bucket=s3_events.BucketEvents.ObjectTagsDeleted.Bucket(
        name=["name"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    object=s3_events.BucketEvents.ObjectTagsDeleted.ObjectType(
        etag=["etag"],
        key=["key"],
        version_id=["versionId"]
    ),
    requester=["requester"],
    request_id=["requestId"],
    source_ip_address=["sourceIpAddress"],
    version=["version"]
)

Attributes

bucket

(experimental) bucket property.

Specify an array of string values to match this event if the actual value of bucket is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

object

(experimental) object property.

Specify an array of string values to match this event if the actual value of object is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

request_id

(experimental) request-id property.

Specify an array of string values to match this event if the actual value of request-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

requester

(experimental) requester property.

Specify an array of string values to match this event if the actual value of requester is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

source_ip_address

(experimental) source-ip-address property.

Specify an array of string values to match this event if the actual value of source-ip-address is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version

(experimental) version property.

Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ObjectType

class BucketEvents.ObjectTagsDeleted.ObjectType(*, etag=None, key=None, version_id=None)

Bases: object

(experimental) Type definition for Object.

Parameters:

etag (Optional[Sequence[str]]) – (experimental) etag property. Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
key (Optional[Sequence[str]]) – (experimental) key property. Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version_id (Optional[Sequence[str]]) – (experimental) version-id property. Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import events as s3_events

object_type = s3_events.BucketEvents.ObjectTagsDeleted.ObjectType(
    etag=["etag"],
    key=["key"],
    version_id=["versionId"]
)

Attributes

etag

(experimental) etag property.

Specify an array of string values to match this event if the actual value of etag is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

key

(experimental) key property.

Specify an array of string values to match this event if the actual value of key is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

version_id

(experimental) version-id property.

Specify an array of string values to match this event if the actual value of version-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental