Primeros pasos: crea una regla de bus de EventBridge eventos de Amazon - Amazon EventBridge
Requisitos previosCreación de la reglaAnálisis de la reglaEliminación de recursosDetalles de la plantillaPlantilla

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Primeros pasos: crea una regla de bus de EventBridge eventos de Amazon

Para familiarizarnos con EventBridge las reglas y sus capacidades, utilizaremos una CloudFormation plantilla para configurar una regla de bus de eventos y los componentes asociados, incluidos el origen, el patrón y el destino del evento. A continuación, analizaremos el funcionamiento de las reglas para seleccionar los eventos que desee.

La plantilla crea una regla en el bus de eventos predeterminado. Esta regla usa un patrón de eventos para filtrar los eventos de un bucket de Amazon S3 específico. La regla envía los eventos coincidentes al destino especificado, un tema de Amazon SNS. Cada vez que se crea un objeto en el bucket, la regla envía una notificación al tema y, a continuación, envía un correo electrónico a la dirección de correo electrónico especificada.

Los recursos implementados constan de los siguientes elementos:

  • Un bucket de Amazon S3 con EventBridge notificaciones habilitadas para actuar como fuente de eventos.

  • Un tema de Amazon SNS y una suscripción por correo electrónico como destino de las notificaciones

  • Una función de ejecución que concede EventBridge los permisos necesarios para publicar en el tema de Amazon SNS.

  • La regla en sí misma, que:

    • Define un patrón de eventos que coincide únicamente con los eventos de Object Created del bucket específico de Amazon S3

    • Especifica el tema de Amazon SNS como destino al que se envían eventos EventBridge coincidentes.

Para obtener detalles técnicos específicos de la plantilla, consulte Detalles de la plantilla.

Los eventos de Amazon S3 coinciden con el patrón de eventos de la regla y se envían a un tema de SNS si coinciden.

Antes de empezar

Para recibir eventos de Amazon S3 EventBridge, debe habilitarlos EventBridge en Amazon S3. En este tema EventBridge se supone que está activado. Para obtener más información, consulte Habilitación EventBridge en la Guía del usuario de Amazon S3.

Crear la regla mediante CloudFormation

Para crear la regla y sus recursos asociados, crearemos una CloudFormation plantilla y la usaremos para crear una pila que contenga una regla de ejemplo, con el origen y el destino.

importante

Si crea una pila a partir de esta plantilla, se le facturarán los recursos de Amazon que utilice.

Primero, crea la CloudFormation plantilla.

  1. En la sección Plantilla, haga clic en el icono de copia de la pestaña JSON o YAML para copiar el contenido de la plantilla.

  2. Pegue el contenido de la plantilla en un archivo nuevo.

  3. Guarde el archivo localmente.

A continuación, usa la plantilla que has guardado para aprovisionar una CloudFormation pila.

Crea la pila con CloudFormation (consola)

  1. Abre la CloudFormation consola en https://console.aws.amazon.com/cloudformation/.

  2. En la página Pilas, para Crear pila elija Con nuevos recursos (estándar).

  3. En Especificar plantilla:

    1. En Requisito previo, elija Seleccionar una plantilla existente.

    2. En Especificar plantilla, elija Cargar un archivo de plantilla.

    3. Seleccione Elegir archivo para navegar hasta el archivo y seleccionarlo.

    4. Elija Siguiente.

  4. Especifique los detalles de la pila:

    1. Introduzca un nombre de pila.

    2. Para BucketName, introduce un nombre de bucket único a nivel mundial. Los nombres de los buckets de Amazon S3 deben ser únicos en todas AWS las cuentas.

    3. Para SNSTopicDisplayName, SNSTopicNombre y RuleName, acepte los valores predeterminados o introduzca los suyos propios.

    4. Para EmailAddress, introduzca una dirección de correo electrónico válida en la que desee recibir las notificaciones.

    5. Elija Siguiente.

  5. Configure las opciones la pila:

    1. En las opciones de error de pila, seleccione Eliminar todos los recursos recién creados.

      nota

      Si elige esta opción, evita que se le facturen los recursos cuya política de eliminación especifique que se conservarán incluso si se produce un error durante la creación de la pila. Para obtener más información, consulte Atributo DeletionPolicy en la Guía del usuario de CloudFormation .

    2. Acepte todos los demás valores predeterminados.

    3. En Capacidades, marca la casilla para confirmar que se CloudFormation podrían crear recursos de IAM en tu cuenta.

    4. Elija Siguiente.

  6. Revise los detalles de la pila y elija Enviar.

Cree la pila con CloudFormation ()AWS CLI

También puedes usar el AWS CLI para crear la pila.

  • Utilice el comando create-stack.

    • Acepte los valores de los parámetros de la plantilla predeterminados y especifique el nombre de la pila, la dirección de correo electrónico y el nombre del depósito. Utilice el parámetro template-body para pasar el contenido de la plantilla o template-url para especificar una ubicación de URL.

      aws cloudformation create-stack \
  --stack-name eventbridge-rule-tutorial \
  --template-body template-contents \
  --parameters \
    ParameterKey=EmailAddress,ParameterValue=your.email@example.com \
    ParameterKey=BucketName,ParameterValue=my-unique-bucket-name \
  --capabilities CAPABILITY_IAM

    • Sobrescriba los valores predeterminados de uno o más parámetros de plantilla. Por ejemplo:

      aws cloudformation create-stack \
  --stack-name eventbridge-rule-tutorial \
  ----template-body template-contents \
  --parameters \
    ParameterKey=EmailAddress,ParameterValue=your.email@example.com \
    ParameterKey=BucketName,ParameterValue=my-custom-bucket-name \
    ParameterKey=RuleName,ParameterValue=my-custom-rule-name \
  --capabilities CAPABILITY_IAM

CloudFormation crea la pila. Una vez completada la creación de la pila, los recursos de la pila están listos para usarse. Puede usar la pestaña Recursos de la página de detalles de la pila para ver los recursos que se aprovisionaron en su cuenta.

Una vez creada la pila, recibirá un correo electrónico de confirmación de la suscripción en la dirección que ha proporcionado. Debe confirmar esta suscripción para recibir notificaciones.

Análisis de las capacidades de la regla

Una vez creada la regla, puede usar la EventBridge consola para observar el funcionamiento de la regla y probar la entrega de los eventos.

  1. ¿Abrir la EventBridge consola en https://console.aws.amazon.com/events/casa? #/reglas.

  2. Elija la regla que ha creado.

    En la página de detalles de la regla, la sección Detalles de la regla muestra información sobre la regla, incluidos su patrón de eventos y sus objetivos.

Análisis del patrón de eventos

Antes de probar el funcionamiento de la regla, analizaremos el patrón de eventos que hemos especificado para controlar qué eventos se envían al destino. La regla solo enviará al destino los eventos que coincidan con los criterios del patrón. En este caso, solo queremos el evento que genera Amazon S3 cuando se crea un objeto en nuestro bucket específico.

  • En la página de detalles de la regla, en Patrón de eventos, puede ver cómo el patrón de eventos selecciona solo eventos en los que:

    • el origen es el servicio de Amazon S3 (aws.s3),

    • el tipo de detalle es Object Created,

    • el nombre del bucket coincide con el nombre del bucket que hemos creado.

    {
  "source": ["aws.s3"],
  "detail-type": ["Object Created"],
  "detail": {
    "bucket": {
      "name": ["eventbridge-rule-example-source"]
    }
  }
}

Envío de eventos a través de la regla

A continuación, generaremos eventos en el origen del evento para comprobar que la coincidencia de la regla y la entrega funcionan correctamente. Para ello, cargaremos un objeto en el bucket de S3 que especificamos como origen del evento.

  1. Abra la consola de Amazon S3 en https://console.aws.amazon.com/s3/.

  2. En la lista de cubos, elige el grupo que creaste con la plantilla.

  3. Seleccione Cargar.

  4. Cargue un archivo de prueba para generar un evento Object Created:

    1. Elija Añadir archivos para seleccionar un archivo desde su equipo.

    2. Seleccione Cargar.

  5. Espera unos instantes a que procese el evento EventBridge y se envíe la notificación.

  6. Compruebe su correo electrónico para ver si hay alguna notificación sobre el evento de creación del objeto. El correo electrónico incluirá detalles sobre el evento de S3, como el nombre del bucket y la clave del objeto.

Visualización de métricas de regla

Puede ver las métricas de su regla para confirmar que los eventos se estén procesando correctamente.

  1. En la EventBridge consola, elige tu regla.

  2. Elija la pestaña Metrics (Métricas).

  3. Puede ver métricas como las siguientes:

    • Invocations: es el número de veces que se ha activado la regla.

    • TriggeredRules: el número de reglas que se activaron al coincidir eventos.

Limpieza: eliminación de recursos

Como último paso, eliminaremos la pila y los recursos que contiene.

importante

Se le facturarán los recursos de Amazon incluidos en la pila mientras exista.

  1. Abre la CloudFormation consola en https://console.aws.amazon.com/cloudformation/.

  2. En la página Pilas, seleccione la pila creada a partir de la plantilla, seleccione Eliminar y, a continuación, confirme Eliminar.

    CloudFormation inicia la eliminación de la pila y de todos los recursos que incluye.

CloudFormation detalles de la plantilla

Esta plantilla crea recursos y concede permisos en su cuenta.

Recursos

La CloudFormation plantilla de este tutorial creará los siguientes recursos en su cuenta:

importante

Si crea una pila a partir de esta plantilla, se le facturarán los recursos de Amazon que utilice.

  • AWS::S3::Bucket: un bucket de Amazon S3 que actúa como fuente de eventos para la regla, con EventBridge las notificaciones habilitadas.

  • AWS::SNS::Topic: es un tema de Amazon SNS que actúa como destino de los eventos que coinciden con la regla.

  • AWS::SNS::Subscription: es una suscripción por correo electrónico al tema de SNS.

  • AWS::IAM::Role: funciones de ejecución de IAM que otorgan permisos al EventBridge servicio y a la función de limpieza de Lambda.

  • AWS::Events::Rule: es la regla que conecta los eventos del bucket de Amazon S3 con el tema de Amazon SNS.

  • AWS::Lambda::Function: una función Lambda que vacía el bucket de Amazon S3 cuando se elimina la pila, lo que permite eliminar todos los recursos de forma limpia.

Permisos

La plantilla incluye un recurso AWS::IAM::Role que representa un rol de ejecución. Esta función otorga al EventBridge servicio (events.amazonaws.com) los siguientes permisos en su cuenta.

Los siguientes permisos se conceden a través de la política administrada por AmazonSNSFullAccess:

  • Acceso completo a todas las operaciones y recursos de Amazon SNS

CloudFormation plantilla

Guarda el siguiente código YAML como un archivo independiente para usarlo como CloudFormation plantilla en este tutorial.

YAML
AWSTemplateFormatVersion: '2010-09-09'
Description: '[AWSDocs] EventBridge: event-bus-rule-get-started'

Parameters:
  BucketName:
    Type: String
    Description: Name of the S3 bucket (must be globally unique)

  SNSTopicDisplayName:
    Type: String
    Description: Display name for the SNS topic
    Default: eventbridge-rule-example-target

  SNSTopicName:
    Type: String
    Description: Name for the SNS topic
    Default: eventbridge-rule-example-target

  RuleName:
    Type: String
    Description: Name for the EventBridge rule
    Default: eventbridge-rule-example

  EmailAddress:
    Type: String
    Description: Email address to receive notifications
    AllowedPattern: '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+[a-zA-Z0-9-]*(\\.[a-zA-Z0-9-]+)*$'

Resources:
  # S3 Bucket with notifications enabled
  S3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Ref BucketName
      NotificationConfiguration:
        EventBridgeConfiguration:
          EventBridgeEnabled: true

  # Lambda function to empty the S3 bucket before deletion
  EmptyBucketFunction:
    Type: AWS::Lambda::Function
    Properties:
      Runtime: python3.12
      Handler: index.handler
      Timeout: 60
      Role: !GetAtt EmptyBucketRole.Arn
      Code:
        ZipFile: |
          import boto3
          import cfnresponse
          def handler(event, context):
              bucket = event['ResourceProperties']['BucketName']
              if event['RequestType'] == 'Delete':
                  s3 = boto3.resource('s3')
                  bucket_resource = s3.Bucket(bucket)
                  bucket_resource.objects.all().delete()
              cfnresponse.send(event, context, cfnresponse.SUCCESS, {})

  # IAM Role for the bucket cleanup Lambda function
  EmptyBucketRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17'
        Statement:
          - Effect: Allow
            Principal:
              Service: lambda.amazonaws.com
            Action: sts:AssumeRole
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Policies:
        - PolicyName: EmptyBucketPolicy
          PolicyDocument:
            Version: '2012-10-17'
            Statement:
              - Effect: Allow
                Action:
                  - s3:DeleteObject
                  - s3:ListBucket
                Resource:
                  - !Sub arn:aws:s3:::${BucketName}
                  - !Sub arn:aws:s3:::${BucketName}/*

  # Custom resource to trigger bucket cleanup on stack deletion
  EmptyBucketOnDelete:
    Type: Custom::EmptyBucket
    Properties:
      ServiceToken: !GetAtt EmptyBucketFunction.Arn
      BucketName: !Ref S3Bucket

  # SNS Topic for email notifications
  SNSTopic:
    Type: AWS::SNS::Topic
    Properties:
      DisplayName: !Ref SNSTopicDisplayName
      TopicName: !Ref SNSTopicName

  # SNS Subscription for email
  SNSSubscription:
    Type: AWS::SNS::Subscription
    Properties:
      Protocol: email
      Endpoint: !Ref EmailAddress
      TopicArn: !Ref SNSTopic

  # EventBridge Rule to match S3 object creation events and send them to the SNS topic
  EventBridgeRule:
    Type: AWS::Events::Rule
    Properties:
      Name: !Ref RuleName
      Description: "Rule to detect S3 object creation and send email notification"
      EventPattern:
        source:
          - aws.s3
        detail-type:
          - "Object Created"
        detail:
          bucket:
            name:
              - !Ref BucketName
      State: ENABLED
      Targets:
        - Id: SendToSNS
          Arn: !Ref SNSTopic
          RoleArn: !GetAtt EventBridgeRole.Arn

  # IAM Role for EventBridge to publish to SNS
  EventBridgeRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17'
        Statement:
          - Effect: Allow
            Principal:
              Service: events.amazonaws.com
            Action: sts:AssumeRole
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/AmazonSNSFullAccess

Outputs:
  BucketName:
    Description: Name of the S3 bucket
    Value: !Ref S3Bucket
  SNSTopicARN:
    Description: ARN of the SNS topic
    Value: !Ref SNSTopic
  EmailSubscription:
    Description: Email address for notifications
    Value: !Ref EmailAddress
JSON
{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "[AWSDocs] EventBridge: event-bus-rule-get-started",
  "Parameters": {
    "BucketName": {
      "Type": "String",
      "Description": "Name of the S3 bucket (must be globally unique)"
    },
    "SNSTopicDisplayName": {
      "Type": "String",
      "Description": "Display name for the SNS topic",
      "Default": "eventbridge-rule-example-target"
    },
    "SNSTopicName": {
      "Type": "String",
      "Description": "Name for the SNS topic",
      "Default": "eventbridge-rule-example-target"
    },
    "RuleName": {
      "Type": "String",
      "Description": "Name for the EventBridge rule",
      "Default": "eventbridge-rule-example"
    },
    "EmailAddress": {
      "Type": "String",
      "Description": "Email address to receive notifications",
      "AllowedPattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+[a-zA-Z0-9-]*(\\.[a-zA-Z0-9-]+)*$"
    }
  },
  "Resources": {
    "S3Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": {
          "Ref": "BucketName"
        },
        "NotificationConfiguration": {
          "EventBridgeConfiguration": {
            "EventBridgeEnabled": true
          }
        }
      }
    },
    "EmptyBucketFunction": {
      "Type": "AWS::Lambda::Function",
      "Properties": {
        "Runtime": "python3.12",
        "Handler": "index.handler",
        "Timeout": 60,
        "Role": {
          "Fn::GetAtt": ["EmptyBucketRole", "Arn"]
        },
        "Code": {
          "ZipFile": "import boto3\nimport cfnresponse\ndef handler(event, context):\n    bucket = event['ResourceProperties']['BucketName']\n    if event['RequestType'] == 'Delete':\n        s3 = boto3.resource('s3')\n        bucket_resource = s3.Bucket(bucket)\n        bucket_resource.objects.all().delete()\n    cfnresponse.send(event, context, cfnresponse.SUCCESS, {})"
        }
      }
    },
    "EmptyBucketRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Effect": "Allow",
              "Principal": {
                "Service": "lambda.amazonaws.com"
              },
              "Action": "sts:AssumeRole"
            }
          ]
        },
        "ManagedPolicyArns": [
          "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
        ],
        "Policies": [
          {
            "PolicyName": "EmptyBucketPolicy",
            "PolicyDocument": {
              "Version": "2012-10-17",
              "Statement": [
                {
                  "Effect": "Allow",
                  "Action": ["s3:DeleteObject", "s3:ListBucket"],
                  "Resource": [
                    {"Fn::Sub": "arn:aws:s3:::${BucketName}"},
                    {"Fn::Sub": "arn:aws:s3:::${BucketName}/*"}
                  ]
                }
              ]
            }
          }
        ]
      }
    },
    "EmptyBucketOnDelete": {
      "Type": "Custom::EmptyBucket",
      "Properties": {
        "ServiceToken": {
          "Fn::GetAtt": ["EmptyBucketFunction", "Arn"]
        },
        "BucketName": {
          "Ref": "S3Bucket"
        }
      }
    },
    "SNSTopic": {
      "Type": "AWS::SNS::Topic",
      "Properties": {
        "DisplayName": {
          "Ref": "SNSTopicDisplayName"
        },
        "TopicName": {
          "Ref": "SNSTopicName"
        }
      }
    },
    "SNSSubscription": {
      "Type": "AWS::SNS::Subscription",
      "Properties": {
        "Protocol": "email",
        "Endpoint": {
          "Ref": "EmailAddress"
        },
        "TopicArn": {
          "Ref": "SNSTopic"
        }
      }
    },
    "EventBridgeRule": {
      "Type": "AWS::Events::Rule",
      "Properties": {
        "Name": {
          "Ref": "RuleName"
        },
        "Description": "Rule to detect S3 object creation and send email notification",
        "EventPattern": {
          "source": [
            "aws.s3"
          ],
          "detail-type": [
            "Object Created"
          ],
          "detail": {
            "bucket": {
              "name": [
                {
                  "Ref": "BucketName"
                }
              ]
            }
          }
        },
        "State": "ENABLED",
        "Targets": [
          {
            "Id": "SendToSNS",
            "Arn": {
              "Ref": "SNSTopic"
            },
            "RoleArn": {
              "Fn::GetAtt": [
                "EventBridgeRole",
                "Arn"
              ]
            }
          }
        ]
      }
    },
    "EventBridgeRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Effect": "Allow",
              "Principal": {
                "Service": "events.amazonaws.com"
              },
              "Action": "sts:AssumeRole"
            }
          ]
        },
        "ManagedPolicyArns": [
          "arn:aws:iam::aws:policy/AmazonSNSFullAccess"
        ]
      }
    }
  },
  "Outputs": {
    "BucketName": {
      "Description": "Name of the S3 bucket",
      "Value": {
        "Ref": "S3Bucket"
      }
    },
    "SNSTopicARN": {
      "Description": "ARN of the SNS topic",
      "Value": {
        "Ref": "SNSTopic"
      }
    },
    "EmailSubscription": {
      "Description": "Email address for notifications",
      "Value": {
        "Ref": "EmailAddress"
      }
    }
  }
}