airflow.providers.amazon.aws.operators.eventbridge

Module Contents

Classes

EventBridgePutEventsOperator

Put Events onto Amazon EventBridge.

EventBridgePutRuleOperator

Create or update a specified EventBridge rule.

EventBridgeEnableRuleOperator

Enable an EventBridge Rule.

EventBridgeDisableRuleOperator

Disable an EventBridge Rule.
class airflow.providers.amazon.aws.operators.eventbridge.EventBridgePutEventsOperator(*, entries, endpoint_id=None, aws_conn_id='aws_default', region_name=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Put Events onto Amazon EventBridge.

See also

For more information on how to use this operator, take a look at the guide: Send events to Amazon EventBridge

Parameters

  • entries (list[dict]) – the list of events to be put onto EventBridge, each event is a dict (required)

  • endpoint_id (str | None) – the URL subdomain of the endpoint

  • aws_conn_id (str) – the AWS connection to use

  • region_name (str | None) – the region where events are to be sent

template_fields: Sequence[str] = ('entries', 'endpoint_id', 'aws_conn_id', 'region_name')[source]
hook()[source]

Create and return an EventBridgeHook.

execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.amazon.aws.operators.eventbridge.EventBridgePutRuleOperator(*, name, description=None, event_bus_name=None, event_pattern=None, role_arn=None, schedule_expression=None, state=None, tags=None, region_name=None, aws_conn_id='aws_default', **kwargs)[source]

Bases: airflow.models.BaseOperator

Create or update a specified EventBridge rule.

See also

For more information on how to use this operator, take a look at the guide: Create or update a rule on Amazon EventBridge

Parameters

  • name (str) – name of the rule to create or update (required)

  • description (str | None) – description of the rule

  • event_bus_name (str | None) – name or ARN of the event bus to associate with this rule

  • event_pattern (str | None) – pattern of events to be matched to this rule

  • role_arn (str | None) – the Amazon Resource Name of the IAM role associated with the rule

  • schedule_expression (str | None) – the scheduling expression (for example, a cron or rate expression)

  • state (str | None) – indicates whether rule is set to be “ENABLED” or “DISABLED”

  • tags (list | None) – list of key-value pairs to associate with the rule

  • region – the region where rule is to be created or updated

template_fields: Sequence[str] = ('aws_conn_id', 'name', 'description', 'event_bus_name', 'event_pattern', 'role_arn',...[source]
hook()[source]

Create and return an EventBridgeHook.

execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.amazon.aws.operators.eventbridge.EventBridgeEnableRuleOperator(*, name, event_bus_name=None, region_name=None, aws_conn_id='aws_default', **kwargs)[source]

Bases: airflow.models.BaseOperator

Enable an EventBridge Rule.

See also

For more information on how to use this operator, take a look at the guide: Enable a rule on Amazon EventBridge

Parameters

  • name (str) – the name of the rule to enable

  • event_bus_name (str | None) – the name or ARN of the event bus associated with the rule (default if omitted)

  • aws_conn_id (str) – the AWS connection to use

  • region_name (str | None) – the region of the rule to be enabled

template_fields: Sequence[str] = ('name', 'event_bus_name', 'region_name', 'aws_conn_id')[source]
hook()[source]

Create and return an EventBridgeHook.

execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.amazon.aws.operators.eventbridge.EventBridgeDisableRuleOperator(*, name, event_bus_name=None, region_name=None, aws_conn_id='aws_default', **kwargs)[source]

Bases: airflow.models.BaseOperator

Disable an EventBridge Rule.

See also

For more information on how to use this operator, take a look at the guide: Disable a rule on Amazon EventBridge

Parameters

  • name (str) – the name of the rule to disable

  • event_bus_name (str | None) – the name or ARN of the event bus associated with the rule (default if omitted)

  • aws_conn_id (str) – the AWS connection to use

  • region_name (str | None) – the region of the rule to be disabled

template_fields: Sequence[str] = ('name', 'event_bus_name', 'region_name', 'aws_conn_id')[source]
hook()[source]

Create and return an EventBridgeHook.

execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?