CfnEventRulePropsMixin

class aws_cdk.mixins_preview.aws_notifications.mixins.CfnEventRulePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an `EventRule <https://docs.aws.amazon.com/notifications/latest/userguide/glossary.html>`_ that is associated with a specified NotificationConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-notifications-eventrule.html

CloudformationResource:

AWS::Notifications::EventRule

Mixin:

true

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 import mixins
from aws_cdk.mixins_preview.aws_notifications import mixins as notifications_mixins

cfn_event_rule_props_mixin = notifications_mixins.CfnEventRulePropsMixin(notifications_mixins.CfnEventRuleMixinProps(
    event_pattern="eventPattern",
    event_type="eventType",
    notification_configuration_arn="notificationConfigurationArn",
    regions=["regions"],
    source="source"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Notifications::EventRule.

Parameters:

  • props (Union[CfnEventRuleMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['eventPattern', 'eventType', 'notificationConfigurationArn', 'regions', 'source']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

EventRuleStatusSummaryProperty

class CfnEventRulePropsMixin.EventRuleStatusSummaryProperty(*, reason=None, status=None)

Bases: object

Provides additional information about the current EventRule status.

Parameters:

  • reason (Optional[str]) – A human-readable reason for EventRuleStatus .

  • status (Optional[str]) – The status of the EventRule . - Values: - ACTIVE - The EventRule can process events. - INACTIVE - The EventRule may be unable to process events. - CREATING - The EventRule is being created. Only GET and LIST calls can be run. - UPDATING - The EventRule is being updated. Only GET and LIST calls can be run. - DELETING - The EventRule is being deleted. Only GET and LIST calls can be run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notifications-eventrule-eventrulestatussummary.html

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_notifications import mixins as notifications_mixins

event_rule_status_summary_property = notifications_mixins.CfnEventRulePropsMixin.EventRuleStatusSummaryProperty(
    reason="reason",
    status="status"
)

Attributes

reason

A human-readable reason for EventRuleStatus .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notifications-eventrule-eventrulestatussummary.html#cfn-notifications-eventrule-eventrulestatussummary-reason

status

The status of the EventRule .

  • Values:

  • ACTIVE

  • The EventRule can process events.

  • INACTIVE

  • The EventRule may be unable to process events.

  • CREATING

  • The EventRule is being created.

Only GET and LIST calls can be run.

  • UPDATING

  • The EventRule is being updated.

Only GET and LIST calls can be run.

  • DELETING

  • The EventRule is being deleted.

Only GET and LIST calls can be run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notifications-eventrule-eventrulestatussummary.html#cfn-notifications-eventrule-eventrulestatussummary-status