StreamHealthChange

class aws_cdk.mixins_preview.aws_ivs.events.StreamHealthChange

Bases: object

(experimental) EventBridge event pattern for aws.ivs@StreamHealthChange.

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_ivs import events as ivs_events

stream_health_change = ivs_events.StreamHealthChange()

Stability:: experimental

Static Methods

classmethod event_pattern(*, channel_name=None, event_metadata=None, event_name=None, stream_id=None)

(experimental) EventBridge event pattern for IVS Stream Health Change.

Parameters:

channel_name (Optional[Sequence[str]]) – (experimental) channel_name property. Specify an array of string values to match this event if the actual value of channel_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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (experimental) event_name property. Specify an array of string values to match this event if the actual value of event_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
stream_id (Optional[Sequence[str]]) – (experimental) stream_id property. Specify an array of string values to match this event if the actual value of stream_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

Return type:

EventPattern

StreamHealthChangeProps

class StreamHealthChange.StreamHealthChangeProps(*, channel_name=None, event_metadata=None, event_name=None, stream_id=None)

Bases: object

(experimental) Props type for aws.ivs@StreamHealthChange event.

Parameters:

channel_name (Optional[Sequence[str]]) – (experimental) channel_name property. Specify an array of string values to match this event if the actual value of channel_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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (experimental) event_name property. Specify an array of string values to match this event if the actual value of event_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
stream_id (Optional[Sequence[str]]) – (experimental) stream_id property. Specify an array of string values to match this event if the actual value of stream_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:

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_ivs import events as ivs_events

stream_health_change_props = ivs_events.StreamHealthChange.StreamHealthChangeProps(
    channel_name=["channelName"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    event_name=["eventName"],
    stream_id=["streamId"]
)

Attributes

channel_name

(experimental) channel_name property.

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

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

event_name

(experimental) event_name property.

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

Stability:

experimental

stream_id

(experimental) stream_id property.

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