SFTPConnectorFileRetrieveCompleted

class aws_cdk.mixins_preview.aws_transfer.events.SFTPConnectorFileRetrieveCompleted

Bases: object

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

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_file_retrieve_completed = transfer_events.SFTPConnectorFileRetrieveCompleted()

Stability:: experimental

Static Methods

classmethod sft_p_connector_file_retrieve_completed_pattern(*, bytes=None, connector_id=None, end_timestamp=None, event_metadata=None, file_path=None, file_transfer_id=None, local_directory_path=None, local_file_location=None, operation=None, start_timestamp=None, status_code=None, transfer_id=None, url=None)

(experimental) EventBridge event pattern for SFTP Connector File Retrieve Completed.

Parameters:

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
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: - -
file_path (Optional[Sequence[str]]) – (experimental) file-path property. Specify an array of string values to match this event if the actual value of file-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
file_transfer_id (Optional[Sequence[str]]) – (experimental) file-transfer-id property. Specify an array of string values to match this event if the actual value of file-transfer-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
local_directory_path (Optional[Sequence[str]]) – (experimental) local-directory-path property. Specify an array of string values to match this event if the actual value of local-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
local_file_location (Union[LocalFileLocation, Dict[str, Any], None]) – (experimental) local-file-location property. Specify an array of string values to match this event if the actual value of local-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
operation (Optional[Sequence[str]]) – (experimental) operation property. Specify an array of string values to match this event if the actual value of operation is one of the values in 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
transfer_id (Optional[Sequence[str]]) – (experimental) transfer-id property. Specify an array of string values to match this event if the actual value of transfer-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
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

LocalFileLocation

class SFTPConnectorFileRetrieveCompleted.LocalFileLocation(*, bucket=None, domain=None, key=None)

Bases: object

(experimental) Type definition for Local-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

local_file_location = transfer_events.SFTPConnectorFileRetrieveCompleted.LocalFileLocation(
    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

SFTPConnectorFileRetrieveCompletedProps

class SFTPConnectorFileRetrieveCompleted.SFTPConnectorFileRetrieveCompletedProps(*, bytes=None, connector_id=None, end_timestamp=None, event_metadata=None, file_path=None, file_transfer_id=None, local_directory_path=None, local_file_location=None, operation=None, start_timestamp=None, status_code=None, transfer_id=None, url=None)

Bases: object

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

Parameters:

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
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: - -
file_path (Optional[Sequence[str]]) – (experimental) file-path property. Specify an array of string values to match this event if the actual value of file-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
file_transfer_id (Optional[Sequence[str]]) – (experimental) file-transfer-id property. Specify an array of string values to match this event if the actual value of file-transfer-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
local_directory_path (Optional[Sequence[str]]) – (experimental) local-directory-path property. Specify an array of string values to match this event if the actual value of local-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
local_file_location (Union[LocalFileLocation, Dict[str, Any], None]) – (experimental) local-file-location property. Specify an array of string values to match this event if the actual value of local-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
operation (Optional[Sequence[str]]) – (experimental) operation property. Specify an array of string values to match this event if the actual value of operation is one of the values in 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
transfer_id (Optional[Sequence[str]]) – (experimental) transfer-id property. Specify an array of string values to match this event if the actual value of transfer-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
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_file_retrieve_completed_props = transfer_events.SFTPConnectorFileRetrieveCompleted.SFTPConnectorFileRetrieveCompletedProps(
    bytes=["bytes"],
    connector_id=["connectorId"],
    end_timestamp=["endTimestamp"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    file_path=["filePath"],
    file_transfer_id=["fileTransferId"],
    local_directory_path=["localDirectoryPath"],
    local_file_location=transfer_events.SFTPConnectorFileRetrieveCompleted.LocalFileLocation(
        bucket=["bucket"],
        domain=["domain"],
        key=["key"]
    ),
    operation=["operation"],
    start_timestamp=["startTimestamp"],
    status_code=["statusCode"],
    transfer_id=["transferId"],
    url=["url"]
)

Attributes

bytes

(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

Stability:

experimental

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

file_path

(experimental) file-path property.

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

file_transfer_id

(experimental) file-transfer-id property.

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

local_directory_path

(experimental) local-directory-path property.

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

local_file_location

(experimental) local-file-location property.

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

operation

(experimental) operation property.

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

transfer_id

(experimental) transfer-id property.

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

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