SFTPConnectorDirectoryListingCompleted

class aws_cdk.mixins_preview.aws_transfer.events.SFTPConnectorDirectoryListingCompleted

Bases: object

(experimental) EventBridge event pattern for aws.transfer@SFTPConnectorDirectoryListingCompleted.

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

s_fTPConnector_directory_listing_completed = transfer_events.SFTPConnectorDirectoryListingCompleted()

Stability:: experimental

Static Methods

classmethod sft_p_connector_directory_listing_completed_pattern(*, connector_id=None, end_timestamp=None, event_metadata=None, item_count=None, listing_id=None, max_items=None, output_directory_path=None, output_file_location=None, remote_directory_path=None, start_timestamp=None, status_code=None, truncated=None, url=None)

(experimental) EventBridge event pattern for SFTP Connector Directory Listing Completed.

Parameters:

connector_id (Optional[Sequence[str]]) – (experimental) connector-id property. Specify an array of string values to match this event if the actual value of connector-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 Connector reference
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: - -
item_count (Optional[Sequence[str]]) – (experimental) item-count property. Specify an array of string values to match this event if the actual value of item-count is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
listing_id (Optional[Sequence[str]]) – (experimental) listing-id property. Specify an array of string values to match this event if the actual value of listing-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
max_items (Optional[Sequence[str]]) – (experimental) max-items property. Specify an array of string values to match this event if the actual value of max-items is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
output_directory_path (Optional[Sequence[str]]) – (experimental) output-directory-path property. Specify an array of string values to match this event if the actual value of output-directory-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
output_file_location (Union[OutputFileLocation, Dict[str, Any], None]) – (experimental) output-file-location property. Specify an array of string values to match this event if the actual value of output-file-location is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
remote_directory_path (Optional[Sequence[str]]) – (experimental) remote-directory-path property. Specify an array of string values to match this event if the actual value of remote-directory-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
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
truncated (Optional[Sequence[str]]) – (experimental) truncated property. Specify an array of string values to match this event if the actual value of truncated is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
url (Optional[Sequence[str]]) – (experimental) url property. Specify an array of string values to match this event if the actual value of url is one of the values in 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

OutputFileLocation

class SFTPConnectorDirectoryListingCompleted.OutputFileLocation(*, bucket=None, domain=None, key=None)

Bases: object

(experimental) Type definition for Output-file-location.

Parameters:

bucket (Optional[Sequence[str]]) – (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
domain (Optional[Sequence[str]]) – (experimental) domain property. Specify an array of string values to match this event if the actual value of domain is one of the values in 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

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

output_file_location = transfer_events.SFTPConnectorDirectoryListingCompleted.OutputFileLocation(
    bucket=["bucket"],
    domain=["domain"],
    key=["key"]
)

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

domain

(experimental) domain property.

Specify an array of string values to match this event if the actual value of domain is one of the values in 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

SFTPConnectorDirectoryListingCompletedProps

class SFTPConnectorDirectoryListingCompleted.SFTPConnectorDirectoryListingCompletedProps(*, connector_id=None, end_timestamp=None, event_metadata=None, item_count=None, listing_id=None, max_items=None, output_directory_path=None, output_file_location=None, remote_directory_path=None, start_timestamp=None, status_code=None, truncated=None, url=None)

Bases: object

(experimental) Props type for aws.transfer@SFTPConnectorDirectoryListingCompleted event.

Parameters:

connector_id (Optional[Sequence[str]]) – (experimental) connector-id property. Specify an array of string values to match this event if the actual value of connector-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 Connector reference
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: - -
item_count (Optional[Sequence[str]]) – (experimental) item-count property. Specify an array of string values to match this event if the actual value of item-count is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
listing_id (Optional[Sequence[str]]) – (experimental) listing-id property. Specify an array of string values to match this event if the actual value of listing-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
max_items (Optional[Sequence[str]]) – (experimental) max-items property. Specify an array of string values to match this event if the actual value of max-items is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
output_directory_path (Optional[Sequence[str]]) – (experimental) output-directory-path property. Specify an array of string values to match this event if the actual value of output-directory-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
output_file_location (Union[OutputFileLocation, Dict[str, Any], None]) – (experimental) output-file-location property. Specify an array of string values to match this event if the actual value of output-file-location is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
remote_directory_path (Optional[Sequence[str]]) – (experimental) remote-directory-path property. Specify an array of string values to match this event if the actual value of remote-directory-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
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
truncated (Optional[Sequence[str]]) – (experimental) truncated property. Specify an array of string values to match this event if the actual value of truncated is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
url (Optional[Sequence[str]]) – (experimental) url property. Specify an array of string values to match this event if the actual value of url is one of the values in 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:

from aws_cdk import AWSEventMetadataProps
# 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

s_fTPConnector_directory_listing_completed_props = transfer_events.SFTPConnectorDirectoryListingCompleted.SFTPConnectorDirectoryListingCompletedProps(
    connector_id=["connectorId"],
    end_timestamp=["endTimestamp"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    item_count=["itemCount"],
    listing_id=["listingId"],
    max_items=["maxItems"],
    output_directory_path=["outputDirectoryPath"],
    output_file_location=transfer_events.SFTPConnectorDirectoryListingCompleted.OutputFileLocation(
        bucket=["bucket"],
        domain=["domain"],
        key=["key"]
    ),
    remote_directory_path=["remoteDirectoryPath"],
    start_timestamp=["startTimestamp"],
    status_code=["statusCode"],
    truncated=["truncated"],
    url=["url"]
)

Attributes

connector_id

(experimental) connector-id property.

Specify an array of string values to match this event if the actual value of connector-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 Connector reference

Stability:

experimental

end_timestamp

(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

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

item_count

(experimental) item-count property.

Specify an array of string values to match this event if the actual value of item-count is one of the values in 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

listing_id

(experimental) listing-id property.

Specify an array of string values to match this event if the actual value of listing-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

max_items

(experimental) max-items property.

Specify an array of string values to match this event if the actual value of max-items is one of the values in 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

output_directory_path

(experimental) output-directory-path property.

Specify an array of string values to match this event if the actual value of output-directory-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

Stability:

experimental

output_file_location

(experimental) output-file-location property.

Specify an array of string values to match this event if the actual value of output-file-location is one of the values in 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

remote_directory_path

(experimental) remote-directory-path property.

Specify an array of string values to match this event if the actual value of remote-directory-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

Stability:

experimental

start_timestamp

(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

Stability:

experimental

status_code

(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

truncated

(experimental) truncated property.

Specify an array of string values to match this event if the actual value of truncated is one of the values in 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

url

(experimental) url property.

Specify an array of string values to match this event if the actual value of url is one of the values in 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