WorkspaceEvents
- class aws_cdk.mixins_preview.aws_workspaces.events.WorkspaceEvents(*args: Any, **kwargs)
Bases:
object(experimental) EventBridge event patterns for Workspace.
- 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_workspaces import events as workspaces_events from aws_cdk.interfaces import aws_workspaces as interfaces_aws_workspaces # workspace_ref: interfaces_aws_workspaces.IWorkspaceRef workspace_events = workspaces_events.WorkspaceEvents.from_workspace(workspace_ref)
Methods
- work_spaces_access_pattern(*, action_type=None, client_ip_address=None, client_platform=None, directory_id=None, event_metadata=None, login_time=None, workspace_id=None, workspaces_client_product_name=None)
(experimental) EventBridge event pattern for Workspace WorkSpaces Access.
- Parameters:
action_type (
Optional[Sequence[str]]) – (experimental) actionType property. Specify an array of string values to match this event if the actual value of actionType is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldclient_ip_address (
Optional[Sequence[str]]) – (experimental) clientIpAddress property. Specify an array of string values to match this event if the actual value of clientIpAddress is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldclient_platform (
Optional[Sequence[str]]) – (experimental) clientPlatform property. Specify an array of string values to match this event if the actual value of clientPlatform is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fielddirectory_id (
Optional[Sequence[str]]) – (experimental) directoryId property. Specify an array of string values to match this event if the actual value of directoryId is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldevent_metadata (
Union[AWSEventMetadataProps,Dict[str,Any],None]) – (experimental) EventBridge event metadata. Default: - -login_time (
Optional[Sequence[str]]) – (experimental) loginTime property. Specify an array of string values to match this event if the actual value of loginTime is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldworkspace_id (
Optional[Sequence[str]]) – (experimental) workspaceId property. Specify an array of string values to match this event if the actual value of workspaceId is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Filter with the Workspace referenceworkspaces_client_product_name (
Optional[Sequence[str]]) – (experimental) workspacesClientProductName property. Specify an array of string values to match this event if the actual value of workspacesClientProductName is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this field
- Stability:
experimental
- Return type:
Static Methods
- classmethod from_workspace(workspace_ref)
(experimental) Create WorkspaceEvents from a Workspace reference.
- Parameters:
workspace_ref (
IWorkspaceRef)- Stability:
experimental
- Return type:
WorkSpacesAccess
- class WorkspaceEvents.WorkSpacesAccess
Bases:
object(experimental) aws.workspaces@WorkSpacesAccess event types for Workspace.
- 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_workspaces import events as workspaces_events work_spaces_access = workspaces_events.WorkspaceEvents.WorkSpacesAccess()
- Stability:
experimental
WorkSpacesAccessProps
- class WorkspaceEvents.WorkSpacesAccess.WorkSpacesAccessProps(*, action_type=None, client_ip_address=None, client_platform=None, directory_id=None, event_metadata=None, login_time=None, workspace_id=None, workspaces_client_product_name=None)
Bases:
object(experimental) Props type for Workspace aws.workspaces@WorkSpacesAccess event.
- Parameters:
action_type (
Optional[Sequence[str]]) – (experimental) actionType property. Specify an array of string values to match this event if the actual value of actionType is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldclient_ip_address (
Optional[Sequence[str]]) – (experimental) clientIpAddress property. Specify an array of string values to match this event if the actual value of clientIpAddress is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldclient_platform (
Optional[Sequence[str]]) – (experimental) clientPlatform property. Specify an array of string values to match this event if the actual value of clientPlatform is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fielddirectory_id (
Optional[Sequence[str]]) – (experimental) directoryId property. Specify an array of string values to match this event if the actual value of directoryId is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldevent_metadata (
Union[AWSEventMetadataProps,Dict[str,Any],None]) – (experimental) EventBridge event metadata. Default: - -login_time (
Optional[Sequence[str]]) – (experimental) loginTime property. Specify an array of string values to match this event if the actual value of loginTime is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldworkspace_id (
Optional[Sequence[str]]) – (experimental) workspaceId property. Specify an array of string values to match this event if the actual value of workspaceId is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Filter with the Workspace referenceworkspaces_client_product_name (
Optional[Sequence[str]]) – (experimental) workspacesClientProductName property. Specify an array of string values to match this event if the actual value of workspacesClientProductName is one of the values in the array. Use one of the constructors on theaws_events.Matchfor 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_workspaces import events as workspaces_events work_spaces_access_props = workspaces_events.WorkspaceEvents.WorkSpacesAccess.WorkSpacesAccessProps( action_type=["actionType"], client_ip_address=["clientIpAddress"], client_platform=["clientPlatform"], directory_id=["directoryId"], event_metadata=AWSEventMetadataProps( region=["region"], resources=["resources"], version=["version"] ), login_time=["loginTime"], workspace_id=["workspaceId"], workspaces_client_product_name=["workspacesClientProductName"] )
Attributes
- action_type
(experimental) actionType property.
Specify an array of string values to match this event if the actual value of actionType is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- client_ip_address
(experimental) clientIpAddress property.
Specify an array of string values to match this event if the actual value of clientIpAddress is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- client_platform
(experimental) clientPlatform property.
Specify an array of string values to match this event if the actual value of clientPlatform is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- directory_id
(experimental) directoryId property.
Specify an array of string values to match this event if the actual value of directoryId is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- event_metadata
(experimental) EventBridge event metadata.
- Default:
- Stability:
experimental
- login_time
(experimental) loginTime property.
Specify an array of string values to match this event if the actual value of loginTime is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- workspace_id
(experimental) workspaceId property.
Specify an array of string values to match this event if the actual value of workspaceId is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Filter with the Workspace reference
- Stability:
experimental
- workspaces_client_product_name
(experimental) workspacesClientProductName property.
Specify an array of string values to match this event if the actual value of workspacesClientProductName is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental