SyntheticsCanaryStatusChange

class aws_cdk.mixins_preview.aws_synthetics.events.SyntheticsCanaryStatusChange

Bases: object

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

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_status_change = synthetics_events.SyntheticsCanaryStatusChange()

Stability:: experimental

Static Methods

classmethod synthetics_canary_status_change_pattern(*, account_id=None, canary_id=None, canary_name=None, changed_config=None, current_state=None, event_metadata=None, message=None, previous_state=None, source_location=None, updated_on=None)

(experimental) EventBridge event pattern for Synthetics Canary Status Change.

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
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
changed_config (Union[ChangedConfig, Dict[str, Any], None]) – (experimental) changed-config property. Specify an array of string values to match this event if the actual value of changed-config 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
current_state (Optional[Sequence[str]]) – (experimental) current-state property. Specify an array of string values to match this event if the actual value of current-state 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
previous_state (Optional[Sequence[str]]) – (experimental) previous-state property. Specify an array of string values to match this event if the actual value of previous-state 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
source_location (Optional[Sequence[str]]) – (experimental) source-location property. Specify an array of string values to match this event if the actual value of source-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
updated_on (Optional[Sequence[str]]) – (experimental) updated-on property. Specify an array of string values to match this event if the actual value of updated-on 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

ChangedConfig

class SyntheticsCanaryStatusChange.ChangedConfig(*, execution_arn=None, test_code_layer_version_arn=None)

Bases: object

(experimental) Type definition for Changed-config.

Parameters:

execution_arn (Union[ExecutionArn, Dict[str, Any], None]) – (experimental) executionArn property. Specify an array of string values to match this event if the actual value of executionArn 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_code_layer_version_arn (Union[TestCodeLayerVersionArn, Dict[str, Any], None]) – (experimental) testCodeLayerVersionArn property. Specify an array of string values to match this event if the actual value of testCodeLayerVersionArn 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

changed_config = synthetics_events.SyntheticsCanaryStatusChange.ChangedConfig(
    execution_arn=synthetics_events.SyntheticsCanaryStatusChange.ExecutionArn(
        current_value=["currentValue"],
        previous_value=["previousValue"]
    ),
    test_code_layer_version_arn=synthetics_events.SyntheticsCanaryStatusChange.TestCodeLayerVersionArn(
        current_value=["currentValue"],
        previous_value=["previousValue"]
    )
)

Attributes

execution_arn

(experimental) executionArn property.

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

(experimental) testCodeLayerVersionArn property.

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

ExecutionArn

class SyntheticsCanaryStatusChange.ExecutionArn(*, current_value=None, previous_value=None)

Bases: object

(experimental) Type definition for ExecutionArn.

Parameters:

current_value (Optional[Sequence[str]]) – (experimental) current-value property. Specify an array of string values to match this event if the actual value of current-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
previous_value (Optional[Sequence[str]]) – (experimental) previous-value property. Specify an array of string values to match this event if the actual value of previous-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:

# 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

execution_arn = synthetics_events.SyntheticsCanaryStatusChange.ExecutionArn(
    current_value=["currentValue"],
    previous_value=["previousValue"]
)

Attributes

current_value

(experimental) current-value property.

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

previous_value

(experimental) previous-value property.

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

SyntheticsCanaryStatusChangeProps

class SyntheticsCanaryStatusChange.SyntheticsCanaryStatusChangeProps(*, account_id=None, canary_id=None, canary_name=None, changed_config=None, current_state=None, event_metadata=None, message=None, previous_state=None, source_location=None, updated_on=None)

Bases: object

(experimental) Props type for aws.synthetics@SyntheticsCanaryStatusChange 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
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
changed_config (Union[ChangedConfig, Dict[str, Any], None]) – (experimental) changed-config property. Specify an array of string values to match this event if the actual value of changed-config 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
current_state (Optional[Sequence[str]]) – (experimental) current-state property. Specify an array of string values to match this event if the actual value of current-state 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
previous_state (Optional[Sequence[str]]) – (experimental) previous-state property. Specify an array of string values to match this event if the actual value of previous-state 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
source_location (Optional[Sequence[str]]) – (experimental) source-location property. Specify an array of string values to match this event if the actual value of source-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
updated_on (Optional[Sequence[str]]) – (experimental) updated-on property. Specify an array of string values to match this event if the actual value of updated-on 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_status_change_props = synthetics_events.SyntheticsCanaryStatusChange.SyntheticsCanaryStatusChangeProps(
    account_id=["accountId"],
    canary_id=["canaryId"],
    canary_name=["canaryName"],
    changed_config=synthetics_events.SyntheticsCanaryStatusChange.ChangedConfig(
        execution_arn=synthetics_events.SyntheticsCanaryStatusChange.ExecutionArn(
            current_value=["currentValue"],
            previous_value=["previousValue"]
        ),
        test_code_layer_version_arn=synthetics_events.SyntheticsCanaryStatusChange.TestCodeLayerVersionArn(
            current_value=["currentValue"],
            previous_value=["previousValue"]
        )
    ),
    current_state=["currentState"],
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    message=["message"],
    previous_state=["previousState"],
    source_location=["sourceLocation"],
    updated_on=["updatedOn"]
)

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

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

changed_config

(experimental) changed-config property.

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

current_state

(experimental) current-state property.

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

previous_state

(experimental) previous-state property.

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

source_location

(experimental) source-location property.

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

updated_on

(experimental) updated-on property.

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

TestCodeLayerVersionArn

class SyntheticsCanaryStatusChange.TestCodeLayerVersionArn(*, current_value=None, previous_value=None)

Bases: object

(experimental) Type definition for TestCodeLayerVersionArn.

Parameters:

current_value (Optional[Sequence[str]]) – (experimental) current-value property. Specify an array of string values to match this event if the actual value of current-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
previous_value (Optional[Sequence[str]]) – (experimental) previous-value property. Specify an array of string values to match this event if the actual value of previous-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:

# 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

test_code_layer_version_arn = synthetics_events.SyntheticsCanaryStatusChange.TestCodeLayerVersionArn(
    current_value=["currentValue"],
    previous_value=["previousValue"]
)

Attributes

current_value

(experimental) current-value property.

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

previous_value

(experimental) previous-value property.

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