MQ - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

MQ

L'objet décrivant un type de source d'événement MQ. Pour plus d'informations, consultez Utilisation AWS Lambda avec Amazon MQ dans le Guide du développeur AWS Lambda .

AWS Serverless Application Model (AWS SAM) génère un AWS::Lambda::EventSourceMappingressource lorsque ce type d'événement est défini.

Note

Pour avoir une file d'attente Amazon MQ dans un cloud privé virtuel (VPC) qui se connecte à une fonction Lambda dans un réseau public, le rôle d'exécution de votre fonction doit inclure les autorisations suivantes :

  • ec2:CreateNetworkInterface

  • ec2:DeleteNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

Pour plus d'informations, consultez Autorisations de rôle d'exécution dans le Guide du développeur AWS Lambda .

Syntaxe

Pour déclarer cette entité dans votre AWS SAM modèle, utilisez la syntaxe suivante.

Propriétés

BatchSize

Nombre maximum d'éléments à récupérer dans un seul lot.

Type : entier

Obligatoire : non

Par défaut : 100

CloudFormation compatibilité : cette propriété est transmise directement à la BatchSize propriété d'une AWS::Lambda::EventSourceMapping ressource.

Minimum : 1

Maximum : 10000

Broker

Amazon Resource Name (ARN) de l'agent Amazon MQ.

Type : chaîne

Obligatoire : oui

CloudFormation compatibilité : cette propriété est transmise directement à la EventSourceArn propriété d'une AWS::Lambda::EventSourceMapping ressource.

DynamicPolicyName

Par défaut, le nom de la politique AWS Identity and Access Management (IAM) est SamAutoGeneratedAMQPolicy destiné à la rétrocompatibilité. Spécifiez true pour utiliser un nom généré automatiquement pour votre politique IAM. Ce nom inclura l'ID logique de la source d'événements Amazon MQ.

Note

Lorsque vous utilisez plus d'une source d'événements Amazon MQ, spécifiez la valeur true pour éviter la duplication des noms de politique IAM.

Type : valeur booléenne

Obligatoire : non

Par défaut : false

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

Enabled

Si la valeur est true, le mappage de source d'événement est actif. Pour suspendre l'interrogation et l'appel, définissez ce paramètre sur false.

Type : valeur booléenne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la Enabled propriété d'une AWS::Lambda::EventSourceMapping ressource.

FilterCriteria

Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter AWS Lambda le filtrage d’événements dans le AWS Lambda Manuel du développeur.

Type : FilterCriteria

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la FilterCriteria propriété d'une AWS::Lambda::EventSourceMapping ressource.

KmsKeyArn

Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la KmsKeyArn propriété d'une AWS::Lambda::EventSourceMapping ressource.

MaximumBatchingWindowInSeconds

Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.

Type : entier

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la MaximumBatchingWindowInSeconds propriété d'une AWS::Lambda::EventSourceMapping ressource.

Queues

Le nom de la file d'attente de destination de l'agent Amazon MQ à consommer.

Type : liste

Obligatoire : oui

CloudFormation compatibilité : cette propriété est transmise directement à la Queues propriété d'une AWS::Lambda::EventSourceMapping ressource.

SecretsManagerKmsKeyId

L'identifiant de clé AWS Key Management Service (AWS KMS) d'une clé gérée par le client provenant de AWS Secrets Manager. Requise lorsque vous utilisez une clé gérée par le client à partir de Secrets Manager avec un rôle d'exécution Lambda qui n'inclut pas l'autorisation kms:Decrypt.

La valeur de cette propriété est un UUID. olpPar exemple : 1abc23d4-567f-8ab9-cde0-1fab234c5d67.

Type : chaîne

Obligatoire : Conditionnelle

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

SourceAccessConfigurations

Un tableau du protocole d'authentification ou de l'hôte virtuel. Spécifiez-le à l'aide du type de SourceAccessConfigurationsdonnées.

Pour le type de source d'événement MQ, les seuls types de configuration valides sont BASIC_AUTH et VIRTUAL_HOST.

  • BASIC_AUTH – Le secret Secrets Manager qui stocke vos informations d'identification d'agent. Pour ce type, les informations d'identification doivent être au format suivant : {"username": "your-username", "password": "your-password"}. Un seul objet de type BASIC_AUTH est autorisé.

  • VIRTUAL_HOST – Le nom de l'hôte virtuel dans votre agent RabbitMQ. Lambda utilisera cet hôte RabbitMQ comme source d'événement. Un seul objet de type VIRTUAL_HOST est autorisé.

Type : liste

Obligatoire : oui

CloudFormation compatibilité : cette propriété est transmise directement à la SourceAccessConfigurations propriété d'une AWS::Lambda::EventSourceMapping ressource.

Exemples

Source d'événement Amazon MQ

Voici un exemple de type de source d'événement MQ pour un agent Amazon MQ.

YAML

Events:
  MQEvent:
    Type: MQ
    Properties:
      Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
      Queues: List of queues
      SourceAccessConfigurations:
        - Type: BASIC_AUTH
          URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName
      BatchSize: 200
      Enabled: true