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, **kwargs)[source]

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.eventbridge.EventBridgeHook]

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
aws_hook_class[source]
template_fields: collections.abc.Sequence[str][source]
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, **kwargs)[source]

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.eventbridge.EventBridgeHook]

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

  • aws_conn_id – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).

  • region_name – AWS region_name. If not specified then the default boto3 behaviour is used.

  • verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.htmlt

aws_hook_class[source]
template_fields: collections.abc.Sequence[str][source]
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, **kwargs)[source]

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.eventbridge.EventBridgeHook]

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 – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).

  • region_name – AWS region_name. If not specified then the default boto3 behaviour is used.

  • verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.htmlt

aws_hook_class[source]
template_fields: collections.abc.Sequence[str][source]
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, **kwargs)[source]

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.eventbridge.EventBridgeHook]

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 – The Airflow connection used for AWS credentials. If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node).

  • region_name – AWS region_name. If not specified then the default boto3 behaviour is used.

  • verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.htmlt

aws_hook_class[source]
template_fields: collections.abc.Sequence[str][source]
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?