AgreementEvents

class aws_cdk.mixins_preview.aws_transfer.events.AgreementEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for Agreement.

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_transfer import events as transfer_events
from aws_cdk.interfaces import aws_transfer as interfaces_transfer

# agreement_ref: interfaces_transfer.IAgreementRef

agreement_events = transfer_events.AgreementEvents.from_agreement(agreement_ref)

Methods

as2_mdn_send_completed_pattern(*, agreement_id=None, as2_from=None, as2_message_id=None, as2_to=None, bytes=None, client_ip=None, disposition=None, end_timestamp=None, event_metadata=None, mdn_message_id=None, mdn_subject=None, mdn_type=None, message_subject=None, requester_file_name=None, request_path=None, s3_attributes=None, server_id=None, start_timestamp=None, status_code=None)

(experimental) EventBridge event pattern for Agreement AS2 MDN Send Completed.

Parameters:

agreement_id (Optional[Sequence[str]]) – (experimental) agreement-id property. Specify an array of string values to match this event if the actual value of agreement-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: - Filter with the Agreement reference
as2_from (Optional[Sequence[str]]) – (experimental) as2-from property. Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
as2_message_id (Optional[Sequence[str]]) – (experimental) as2-message-id property. Specify an array of string values to match this event if the actual value of as2-message-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
as2_to (Optional[Sequence[str]]) – (experimental) as2-to property. Specify an array of string values to match this event if the actual value of as2-to is one of the values in 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 (Optional[Sequence[str]]) – (experimental) bytes property. Specify an array of string values to match this event if the actual value of bytes is one of the values in 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_ip (Optional[Sequence[str]]) – (experimental) client-ip property. Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
disposition (Optional[Sequence[str]]) – (experimental) disposition property. Specify an array of string values to match this event if the actual value of disposition is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
end_timestamp (Optional[Sequence[str]]) – (experimental) end-timestamp property. Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in 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: - -
mdn_message_id (Optional[Sequence[str]]) – (experimental) mdn-message-id property. Specify an array of string values to match this event if the actual value of mdn-message-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
mdn_subject (Optional[Sequence[str]]) – (experimental) mdn-subject property. Specify an array of string values to match this event if the actual value of mdn-subject is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
mdn_type (Optional[Sequence[str]]) – (experimental) mdn-type property. Specify an array of string values to match this event if the actual value of mdn-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
message_subject (Optional[Sequence[str]]) – (experimental) message-subject property. Specify an array of string values to match this event if the actual value of message-subject is one of the values in 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_file_name (Optional[Sequence[str]]) – (experimental) requester-file-name property. Specify an array of string values to match this event if the actual value of requester-file-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: - Do not filter on this field
request_path (Optional[Sequence[str]]) – (experimental) request-path property. Specify an array of string values to match this event if the actual value of request-path is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
s3_attributes (Union[S3Attributes, Dict[str, Any], None]) – (experimental) s3-attributes property. Specify an array of string values to match this event if the actual value of s3-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
server_id (Optional[Sequence[str]]) – (experimental) server-id property. Specify an array of string values to match this event if the actual value of server-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
start_timestamp (Optional[Sequence[str]]) – (experimental) start-timestamp property. Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status_code (Optional[Sequence[str]]) – (experimental) status-code property. Specify an array of string values to match this event if the actual value of status-code is one of the values in 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

as2_mdn_send_failed_pattern(*, agreement_id=None, as2_from=None, as2_message_id=None, as2_to=None, bytes=None, client_ip=None, disposition=None, end_timestamp=None, event_metadata=None, failure_code=None, failure_message=None, mdn_message_id=None, mdn_subject=None, mdn_type=None, requester_file_name=None, s3_attributes=None, server_id=None, start_timestamp=None, status_code=None)

(experimental) EventBridge event pattern for Agreement AS2 MDN Send Failed.

Parameters:

agreement_id (Optional[Sequence[str]]) – (experimental) agreement-id property. Specify an array of string values to match this event if the actual value of agreement-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: - Filter with the Agreement reference
as2_from (Optional[Sequence[str]]) – (experimental) as2-from property. Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
as2_message_id (Optional[Sequence[str]]) – (experimental) as2-message-id property. Specify an array of string values to match this event if the actual value of as2-message-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
as2_to (Optional[Sequence[str]]) – (experimental) as2-to property. Specify an array of string values to match this event if the actual value of as2-to is one of the values in 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 (Optional[Sequence[str]]) – (experimental) bytes property. Specify an array of string values to match this event if the actual value of bytes is one of the values in 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_ip (Optional[Sequence[str]]) – (experimental) client-ip property. Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
disposition (Optional[Sequence[str]]) – (experimental) disposition property. Specify an array of string values to match this event if the actual value of disposition is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
end_timestamp (Optional[Sequence[str]]) – (experimental) end-timestamp property. Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in 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: - -
failure_code (Optional[Sequence[str]]) – (experimental) failure-code property. Specify an array of string values to match this event if the actual value of failure-code is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
failure_message (Optional[Sequence[str]]) – (experimental) failure-message property. Specify an array of string values to match this event if the actual value of failure-message is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
mdn_message_id (Optional[Sequence[str]]) – (experimental) mdn-message-id property. Specify an array of string values to match this event if the actual value of mdn-message-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
mdn_subject (Optional[Sequence[str]]) – (experimental) mdn-subject property. Specify an array of string values to match this event if the actual value of mdn-subject is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
mdn_type (Optional[Sequence[str]]) – (experimental) mdn-type property. Specify an array of string values to match this event if the actual value of mdn-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
requester_file_name (Optional[Sequence[str]]) – (experimental) requester-file-name property. Specify an array of string values to match this event if the actual value of requester-file-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: - Do not filter on this field
s3_attributes (Union[S3Attributes, Dict[str, Any], None]) – (experimental) s3-attributes property. Specify an array of string values to match this event if the actual value of s3-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
server_id (Optional[Sequence[str]]) – (experimental) server-id property. Specify an array of string values to match this event if the actual value of server-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
start_timestamp (Optional[Sequence[str]]) – (experimental) start-timestamp property. Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status_code (Optional[Sequence[str]]) – (experimental) status-code property. Specify an array of string values to match this event if the actual value of status-code is one of the values in 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

as2_payload_receive_completed_pattern(*, agreement_id=None, as2_from=None, as2_message_id=None, as2_to=None, bytes=None, client_ip=None, end_timestamp=None, event_metadata=None, message_subject=None, requester_file_name=None, request_path=None, s3_attributes=None, server_id=None, start_timestamp=None, status_code=None)

(experimental) EventBridge event pattern for Agreement AS2 Payload Receive Completed.

Parameters:

agreement_id (Optional[Sequence[str]]) – (experimental) agreement-id property. Specify an array of string values to match this event if the actual value of agreement-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: - Filter with the Agreement reference
as2_from (Optional[Sequence[str]]) – (experimental) as2-from property. Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
as2_message_id (Optional[Sequence[str]]) – (experimental) as2-message-id property. Specify an array of string values to match this event if the actual value of as2-message-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
as2_to (Optional[Sequence[str]]) – (experimental) as2-to property. Specify an array of string values to match this event if the actual value of as2-to is one of the values in 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 (Optional[Sequence[str]]) – (experimental) bytes property. Specify an array of string values to match this event if the actual value of bytes is one of the values in 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_ip (Optional[Sequence[str]]) – (experimental) client-ip property. Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
end_timestamp (Optional[Sequence[str]]) – (experimental) end-timestamp property. Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in 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: - -
message_subject (Optional[Sequence[str]]) – (experimental) message-subject property. Specify an array of string values to match this event if the actual value of message-subject is one of the values in 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_file_name (Optional[Sequence[str]]) – (experimental) requester-file-name property. Specify an array of string values to match this event if the actual value of requester-file-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: - Do not filter on this field
request_path (Optional[Sequence[str]]) – (experimental) request-path property. Specify an array of string values to match this event if the actual value of request-path is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
s3_attributes (Union[S3Attributes, Dict[str, Any], None]) – (experimental) s3-attributes property. Specify an array of string values to match this event if the actual value of s3-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
server_id (Optional[Sequence[str]]) – (experimental) server-id property. Specify an array of string values to match this event if the actual value of server-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
start_timestamp (Optional[Sequence[str]]) – (experimental) start-timestamp property. Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status_code (Optional[Sequence[str]]) – (experimental) status-code property. Specify an array of string values to match this event if the actual value of status-code is one of the values in 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

as2_payload_receive_failed_pattern(*, agreement_id=None, as2_from=None, as2_message_id=None, as2_to=None, client_ip=None, end_timestamp=None, event_metadata=None, failure_code=None, failure_message=None, message_subject=None, s3_attributes=None, server_id=None, start_timestamp=None, status_code=None)

(experimental) EventBridge event pattern for Agreement AS2 Payload Receive Failed.

Parameters:

agreement_id (Optional[Sequence[str]]) – (experimental) agreement-id property. Specify an array of string values to match this event if the actual value of agreement-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: - Filter with the Agreement reference
as2_from (Optional[Sequence[str]]) – (experimental) as2-from property. Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
as2_message_id (Optional[Sequence[str]]) – (experimental) as2-message-id property. Specify an array of string values to match this event if the actual value of as2-message-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
as2_to (Optional[Sequence[str]]) – (experimental) as2-to property. Specify an array of string values to match this event if the actual value of as2-to is one of the values in 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_ip (Optional[Sequence[str]]) – (experimental) client-ip property. Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
end_timestamp (Optional[Sequence[str]]) – (experimental) end-timestamp property. Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in 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: - -
failure_code (Optional[Sequence[str]]) – (experimental) failure-code property. Specify an array of string values to match this event if the actual value of failure-code is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
failure_message (Optional[Sequence[str]]) – (experimental) failure-message property. Specify an array of string values to match this event if the actual value of failure-message is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
message_subject (Optional[Sequence[str]]) – (experimental) message-subject property. Specify an array of string values to match this event if the actual value of message-subject is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
s3_attributes (Union[S3Attributes, Dict[str, Any], None]) – (experimental) s3-attributes property. Specify an array of string values to match this event if the actual value of s3-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
server_id (Optional[Sequence[str]]) – (experimental) server-id property. Specify an array of string values to match this event if the actual value of server-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
start_timestamp (Optional[Sequence[str]]) – (experimental) start-timestamp property. Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
status_code (Optional[Sequence[str]]) – (experimental) status-code property. Specify an array of string values to match this event if the actual value of status-code is one of the values in 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_agreement(agreement_ref)

(experimental) Create AgreementEvents from a Agreement reference.

Parameters:: agreement_ref (IAgreementRef)
Stability:: experimental
Return type:: AgreementEvents