View a markdown version of this page

AWS::Serverless: : Connecteur - AWS Serverless Application Model

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.

AWS::Serverless: : Connecteur

Configure les autorisations entre deux ressources. Pour obtenir une présentation des connecteurs, veuillez consulter Gérer les autorisations relatives aux ressources avec AWS SAM connectors.

Pour plus d'informations sur les produits générés AWS CloudFormation ressources, voir CloudFormation ressources générées lorsque vous spécifiez AWS::Serverless::Connector.

Pour fournir des commentaires sur les connecteurs, soumettre un nouveau numéro au modèle d'application sans serveur AWS GitHub référentiel.

Note

Lorsque vous effectuez un déploiement sur AWS CloudFormation, AWS SAM transforme votre AWS SAM ressources dans CloudFormation ressources. Pour plus d’informations, consultez Générées CloudFormation ressources pour AWS SAM.

Syntaxe

Pour déclarer cette entité dans votre AWS Serverless Application Model (AWS SAM) template, utilisez l'une des syntaxes suivantes.

Note

Nous vous recommandons d'utiliser la syntaxe des connecteurs intégrés dans la plupart des cas d'utilisation. Le fait d'être intégré à la ressource source facilite sa lecture et sa maintenance au fil du temps. Lorsque vous devez référencer une ressource source qui ne se trouve pas dans la même AWS SAM modèle, tel qu'une ressource dans une pile imbriquée ou une ressource partagée, utilisez le AWS::Serverless::Connector syntaxe.

Connecteurs intégrés

<source-resource-logical-id>: Connectors: <connector-logical-id: Properties: Destination: ResourceReference | List of ResourceReference Permissions: List SourceReference: SourceReference

AWS::Serverless: : Connecteur

Type: AWS::Serverless::Connector Properties: Destination: ResourceReference | List of ResourceReference Permissions: List Source: ResourceReference

Propriétés

Destination

Ressource de destination.

Tapez: ResourceReference | Liste des ResourceReference

Obligatoire : oui

CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.

Permissions

Type d'autorisation que la ressource source est autorisée à exécuter sur la ressource de destination.

Read Comprend : Gestion des identités et des accès AWS actions (IAM) qui permettent de lire les données de la ressource.

Write inclut des actions IAM qui permettent de lancer et d'écrire des données dans une ressource.

Valeurs valides : Read ou Write

Type : liste

Obligatoire : oui

CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.

Source

Ressource source. Obligatoire lors de l'utilisation de la syntaxe AWS::Serverless::Connector.

Type : ResourceReference

Obligatoire : Conditionnelle

CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.

SourceReference

Ressource source.

Note

À utiliser avec la syntaxe des connecteurs intégrés lors de la définition de propriétés supplémentaires pour la ressource source.

Type : SourceReference

Obligatoire : non

CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.

Exemples

Connecteurs intégrés

L'exemple suivant utilise des connecteurs intégrés pour définir un Write connexion de données entre un AWS Lambda Fonction événementielle et tableau Amazon DynamoDB :

Transform: AWS::Serverless-2016-10-31 ... Resources: MyTable: Type: AWS::Serverless::SimpleTable MyFunction: Type: AWS::Serverless::Function Connectors: MyConn: Properties: Destination: Id: MyTable Permissions: - Write ...

L'exemple suivant utilise des connecteurs intégrés pour définir les autorisations Read et Write :

Transform: AWS::Serverless-2016-10-31 ... Resources: MyFunction: Type: AWS::Serverless::Function Connectors: MyConn: Properties: Destination: Id: MyTable Permissions: - Read - Write MyTable: Type: AWS::DynamoDB::Table ...

L'exemple suivant utilise des connecteurs intégrés pour définir une ressource source avec une propriété autre que la propriété Id :

Transform: AWS::Serverless-2016-10-31 ... Resources: MyApi: Type: AWS::Serverless::Api Connectors: ApitoLambdaConn: Properties: SourceReference: Qualifier: Prod/GET/foobar Destination: Id: MyTable Permissions: - Read - Write MyTable: Type: AWS::DynamoDB::Table ...

AWS::Serverless: : Connecteur

L'exemple suivant utilise AWS::Serverless: : Connecteur ressource pour avoir un AWS Lambda fonction de lecture et d'écriture dans une table Amazon DynamoDB :

MyConnector: Type: AWS::Serverless::Connector Properties: Source: Id: MyFunction Destination: Id: MyTable Permissions: - Read - Write

L'exemple suivant utilise la ressource AWS::Serverless: : Connecteur pour qu'une fonction Lambda écrive dans une rubrique Amazon SNS, avec les deux ressources dans le même modèle :

MyConnector: Type: AWS::Serverless::Connector Properties: Source: Id: MyLambda Destination: Id: MySNSTopic Permissions: - Write

L'exemple suivant utilise la ressource AWS::Serverless: : Connecteur pour qu'une rubrique Amazon SNS écrive dans une fonction Lambda, qui écrit à son tour dans un tableau Amazon DynamoDB, avec toutes les ressources dans le même modèle  :

Transform: AWS::Serverless-2016-10-31 Resources: Topic: Type: AWS::SNS::Topic Properties: Subscription: - Endpoint: !GetAtt Function.Arn Protocol: lambda Function: Type: AWS::Serverless::Function Properties: Runtime: nodejs16.x Handler: index.handler InlineCode: | const AWS = require('aws-sdk'); exports.handler = async (event, context) => { const docClient = new AWS.DynamoDB.DocumentClient(); await docClient.put({ TableName: process.env.TABLE_NAME, Item: { id: context.awsRequestId, event: JSON.stringify(event) } }).promise(); }; Environment: Variables: TABLE_NAME: !Ref Table Table: Type: AWS::Serverless::SimpleTable TopicToFunctionConnector: Type: AWS::Serverless::Connector Properties: Source: Id: Topic Destination: Id: Function Permissions: - Write FunctionToTableConnector: Type: AWS::Serverless::Connector Properties: Source: Id: Function Destination: Id: Table Permissions: - Write

Ce qui suit est le transformé AWS CloudFormation modèle tiré de l'exemple ci-dessus :

"FunctionToTableConnectorPolicy": { "Type": "AWS::IAM::ManagedPolicy", "Metadata": { "aws:sam:connectors": { "FunctionToTableConnector": { "Source": { "Type": "AWS::Lambda::Function" }, "Destination": { "Type": "AWS::DynamoDB::Table" } } } }, "Properties": { "PolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "dynamodb:PutItem", "dynamodb:UpdateItem", "dynamodb:DeleteItem", "dynamodb:BatchWriteItem", "dynamodb:PartiQLDelete", "dynamodb:PartiQLInsert", "dynamodb:PartiQLUpdate" ], "Resource": [ { "Fn::GetAtt": [ "MyTable", "Arn" ] }, { "Fn::Sub": [ "${DestinationArn}/index/*", { "DestinationArn": { "Fn::GetAtt": [ "MyTable", "Arn" ] } } ] } ] } ] }, "Roles": [ { "Ref": "MyFunctionRole" } ] } }