SyntheticsCanaryTestRunSuccessful

class aws_cdk.mixins_preview.aws_synthetics.events.SyntheticsCanaryTestRunSuccessful

Bases: object

(experimental) EventBridge event pattern for aws.synthetics@SyntheticsCanaryTestRunSuccessful.

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_synthetics import events as synthetics_events

synthetics_canary_test_run_successful = synthetics_events.SyntheticsCanaryTestRunSuccessful()

Stability:: experimental

Static Methods

classmethod synthetics_canary_test_run_successful_pattern(*, account_id=None, artifact_location=None, canary_id=None, canary_name=None, canary_run_id=None, canary_run_timeline=None, event_metadata=None, message=None, state_reason=None, test_run_status=None)

(experimental) EventBridge event pattern for Synthetics Canary TestRun Successful.

Parameters:

account_id (Optional[Sequence[str]]) – (experimental) account-id property. Specify an array of string values to match this event if the actual value of account-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
artifact_location (Optional[Sequence[str]]) – (experimental) artifact-location property. Specify an array of string values to match this event if the actual value of artifact-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
canary_id (Optional[Sequence[str]]) – (experimental) canary-id property. Specify an array of string values to match this event if the actual value of canary-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
canary_name (Optional[Sequence[str]]) – (experimental) canary-name property. Specify an array of string values to match this event if the actual value of canary-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
canary_run_id (Optional[Sequence[str]]) – (experimental) canary-run-id property. Specify an array of string values to match this event if the actual value of canary-run-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
canary_run_timeline (Union[CanaryRunTimeline, Dict[str, Any], None]) – (experimental) canary-run-timeline property. Specify an array of string values to match this event if the actual value of canary-run-timeline 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: - -
message (Optional[Sequence[str]]) – (experimental) message property. Specify an array of string values to match this event if the actual value of message 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
state_reason (Optional[Sequence[str]]) – (experimental) state-reason property. Specify an array of string values to match this event if the actual value of state-reason 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
test_run_status (Optional[Sequence[str]]) – (experimental) test-run-status property. Specify an array of string values to match this event if the actual value of test-run-status 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

CanaryRunTimeline

class SyntheticsCanaryTestRunSuccessful.CanaryRunTimeline(*, completed=None, started=None)

Bases: object

(experimental) Type definition for Canary-run-timeline.

Parameters:

completed (Optional[Sequence[str]]) – (experimental) completed property. Specify an array of string values to match this event if the actual value of completed 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
started (Optional[Sequence[str]]) – (experimental) started property. Specify an array of string values to match this event if the actual value of started 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_synthetics import events as synthetics_events

canary_run_timeline = synthetics_events.SyntheticsCanaryTestRunSuccessful.CanaryRunTimeline(
    completed=["completed"],
    started=["started"]
)

Attributes

completed

(experimental) completed property.

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

started

(experimental) started property.

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

SyntheticsCanaryTestRunSuccessfulProps

class SyntheticsCanaryTestRunSuccessful.SyntheticsCanaryTestRunSuccessfulProps(*, account_id=None, artifact_location=None, canary_id=None, canary_name=None, canary_run_id=None, canary_run_timeline=None, event_metadata=None, message=None, state_reason=None, test_run_status=None)

Bases: object

(experimental) Props type for aws.synthetics@SyntheticsCanaryTestRunSuccessful event.

Parameters:

account_id (Optional[Sequence[str]]) – (experimental) account-id property. Specify an array of string values to match this event if the actual value of account-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
artifact_location (Optional[Sequence[str]]) – (experimental) artifact-location property. Specify an array of string values to match this event if the actual value of artifact-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
canary_id (Optional[Sequence[str]]) – (experimental) canary-id property. Specify an array of string values to match this event if the actual value of canary-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
canary_name (Optional[Sequence[str]]) – (experimental) canary-name property. Specify an array of string values to match this event if the actual value of canary-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
canary_run_id (Optional[Sequence[str]]) – (experimental) canary-run-id property. Specify an array of string values to match this event if the actual value of canary-run-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
canary_run_timeline (Union[CanaryRunTimeline, Dict[str, Any], None]) – (experimental) canary-run-timeline property. Specify an array of string values to match this event if the actual value of canary-run-timeline 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: - -
message (Optional[Sequence[str]]) – (experimental) message property. Specify an array of string values to match this event if the actual value of message 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
state_reason (Optional[Sequence[str]]) – (experimental) state-reason property. Specify an array of string values to match this event if the actual value of state-reason 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
test_run_status (Optional[Sequence[str]]) – (experimental) test-run-status property. Specify an array of string values to match this event if the actual value of test-run-status 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_synthetics import events as synthetics_events

synthetics_canary_test_run_successful_props = synthetics_events.SyntheticsCanaryTestRunSuccessful.SyntheticsCanaryTestRunSuccessfulProps(
    account_id=["accountId"],
    artifact_location=["artifactLocation"],
    canary_id=["canaryId"],
    canary_name=["canaryName"],
    canary_run_id=["canaryRunId"],
    canary_run_timeline=synthetics_events.SyntheticsCanaryTestRunSuccessful.CanaryRunTimeline(
        completed=["completed"],
        started=["started"]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    message=["message"],
    state_reason=["stateReason"],
    test_run_status=["testRunStatus"]
)

Attributes

account_id

(experimental) account-id property.

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

artifact_location

(experimental) artifact-location property.

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

canary_id

(experimental) canary-id property.

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

canary_name

(experimental) canary-name property.

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

canary_run_id

(experimental) canary-run-id property.

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

canary_run_timeline

(experimental) canary-run-timeline property.

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

message

(experimental) message property.

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

state_reason

(experimental) state-reason property.

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

test_run_status

(experimental) test-run-status property.

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