LimitBreach

class aws_cdk.mixins_preview.aws_ivs.events.LimitBreach

Bases: object

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

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

limit_breach = ivs_events.LimitBreach()

Stability:: experimental

Static Methods

classmethod event_pattern(*, event_metadata=None, exceeded_by=None, limit=None, limit_unit=None, limit_value=None)

(experimental) EventBridge event pattern for IVS Limit Breach.

Parameters:

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

LimitBreachProps

class LimitBreach.LimitBreachProps(*, event_metadata=None, exceeded_by=None, limit=None, limit_unit=None, limit_value=None)

Bases: object

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

Parameters:

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

limit_breach_props = ivs_events.LimitBreach.LimitBreachProps(
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    exceeded_by=["exceededBy"],
    limit=["limit"],
    limit_unit=["limitUnit"],
    limit_value=["limitValue"]
)

Attributes

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

exceeded_by

(experimental) exceeded_by property.

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

limit

(experimental) limit property.

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

limit_unit

(experimental) limit_unit property.

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

limit_value

(experimental) limit_value property.

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