View a markdown version of this page

aws-events-rule-sqs - Construcciones de Soluciones de AWS
Información generalInicializadorPatrón de construcciónPropiedades de patrónConfiguración predeterminadaArquitecturaGitHub

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.

aws-events-rule-sqs

Todas las clases están en desarrollo activo y están sujetas a cambios o eliminación no compatibles con versiones anteriores en cualquier versión futura. Estos no están sujetos a laVersionado semánticoModelo. Esto significa que, aunque puede usarlos, es posible que necesite actualizar el código fuente cuando actualice a una versión más reciente de este paquete.

Nota: Para garantizar una funcionalidad adecuada, los paquetes de AWS Solutions Constructs y los paquetes CDK de AWS del proyecto deben tener la misma versión.

Idioma Paquete
Python 		aws_solutions_constructs.aws_events_rule_sqs
Mecanografía 		@aws-solutions-constructs/aws-events-rule-sqs
Java 		software.amazon.awsconstructs.services.eventsrulesqs

Overview

Este patrón implementa una regla de Amazon CloudWatch Events conectada a una cola de Amazon SQS.

Aquí hay una definición mínima de patrón implementable: 


import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventsRuleToSqsProps, EventsRuleToSqs } from "@aws-solutions-constructs/aws-events-rule-sqs";

const props: EventsRuleToSqsProps = {
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5))
    }
};

const constructStack = new EventsRuleToSqs(this, 'test-construct', props);

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
    actions: ["kms:Encrypt", "kms:Decrypt"],
    effect: iam.Effect.ALLOW,
    principals: [ new iam.AccountRootPrincipal() ],
    resources: [ "*" ]
});

constructStack.encryptionKey?.addToResourcePolicy(policyStatement);

Initializer


new EventsRuleToSqs(scope: Construct, id: string, props: EventsRuleToSqsProps);

Parámetros

Patrón de construcción

Nombre Tipo Descripción
EventRuleProps events.RuleProps Propiedades proporcionadas por el usuario para anular las propiedades predeterminadas de la regla CloudWatch Events.
ExistingQueueObj? sqs.Queue Una cola SQS opcional existente que se utilizará en lugar de la cola predeterminada. Proporcionando tanto esto comoqueuePropsprovocará un error.
¿Props en cola? sqs.QueueProps Propiedades opcionales proporcionadas por el usuario para anular las propiedades predeterminadas de la cola SQS. Se pasa por alto si unexistingQueueObjse encuentra.
¿EnableQueuePurging? boolean Si se deben conceder permisos adicionales a la función Lambda, lo que le permite depurar la cola SQS. El valor predeterminado es false.
DeployDeadLetterQueue? boolean Si se debe crear una cola secundaria para utilizarse como cola de mensajes fallidos. El valor predeterminado es true.
DeadletterQueueProps? sqs.QueueProps Props opcionales proporcionados por el usuario para anular los apoyos predeterminados para la cola de letras muertas. Solo se usa si eldeployDeadLetterQueuese establece en verdadero.
¿maxReceiveCount? number El número de veces que un mensaje se puede quitar sin éxito antes de que se traslade a la cola de mensajes fallidos. El valor predeterminado es 15.
EnableEncryptionWithCustomerManagedKey? boolean Si desea utilizar una clave de cifrado administrada por el cliente, ya sea administrada por esta aplicación CDK o importada. Si importa una clave de cifrado, debe especificarse en el campoencryptionKeypara esta construcción.
encryptionKey kms.Key Una clave de cifrado opcional existente que se utilizará en lugar de la clave de cifrado predeterminada.
EncryptionKeyProps? kms.KeyProps Propiedades opcionales proporcionadas por el usuario para anular las propiedades predeterminadas de la clave de cifrado.

Propiedades de patrón

Nombre Tipo Descripción
Regla de eventos events.Rule Devuelve una instancia de la regla Eventos creada por el patrón.
SQSqueue sqs.Queue Devuelve una instancia de la cola SQS creada por el patrón.
encryptionKey kms.Key Devuelve una instancia de la clave de cifrado creada por el patrón.
DeadLetterQueue? sqs.Queue Devuelve una instancia de la cola de letras muertas creada por el patrón, si se implementa una.

Configuración predeterminada

La implementación lista para usar de este patrón sin anulación establecerá los siguientes valores predeterminados:

Amazon CloudWatch Events

  • Conceda permisos de privilegios mínimos a CloudWatch Events para publicar en la cola de SQS.

Cola de Amazon SQS

  • Implemente una cola de mensajes fallidos para la cola de origen.

  • Active el cifrado del lado del servidor para la cola de origen mediante una clave de AWS KMS administrada por el cliente.

  • Aplicar el cifrado de los datos en tránsito.

Architecture

GitHub

Para ver el código de este patrón, crear/ver problemas y solicitudes de extracción, y mucho más:
@aws -soluciones-constructs/aws-events-rule-sqs