Ressources AWS CloudFormation générées

Quand AWS Serverless Application Model (AWS SAM) traite votre fichier de modèle AWS SAM, il génère une ou plusieurs ressources AWS CloudFormation. L'ensemble de ressources AWS CloudFormation que AWS SAM génère diffère en fonction des scénarios que vous spécifiez. Un scénario est la combinaison des ressources et propriétés AWS SAM spécifiées dans votre fichier de modèle. Vous pouvez référencer les ressources AWS CloudFormation générées ailleurs dans votre fichier de modèle, de la même manière que vous référencez les ressources que vous déclarez explicitement dans votre fichier de modèle.

Par exemple, si vous spécifiez une ressource AWS::Serverless::Function dans votre fichier de modèle AWS SAM, AWS SAM génère toujours une ressource de base AWS::Lambda::Function. Si vous spécifiez également le paramètre facultatif propriété AutoPublishAlias, AWS SAMgénère des ressources AWS::Lambda::Alias et AWS::Lambda::Version.

Cette section répertorie les scénarios et les ressources AWS CloudFormation qu'ils génèrent, et montre comment référencer les ressources AWS CloudFormation dans votre fichier de modèle AWS SAM.

Référencement des ressources AWS CloudFormation générées

Vous avez deux options de référencement pour les ressources AWS CloudFormation générées au sein de votre fichier de modèle AWS SAM, par LogicalId ou par une propriété référençable.

Référencement des AWS CloudFormation ressources générées par LogicalId

Les ressources AWS CloudFormation qui génèrent AWS SAM disposent chacune d'un LogicalId, qui est un identificateur alphanumérique (A-Z, a-z, a-z, a-z, 0-9) unique dans un fichier modèle. AWS SAM utilise le système LogicalIds de la AWS SAM dans votre fichier de modèle pour construire l'identité LogicalIds des ressources AWS CloudFormation qu'il génère. Vous pouvez utiliser l'identité LogicalId d'une ressource AWS CloudFormation générée pour accéder aux propriétés de cette ressource dans votre fichier de modèle, comme vous le feriez pour une AWS CloudFormation que vous avez explicitement déclarée. Pour plus d'informations sur LogicalIds dans les modèles AWS CloudFormation et AWS SAM, voir Ressources dans le Guide de l'utilisateurAWS CloudFormation.

Note

Les LogicalIds de certaines ressources générées incluent une valeur de hachage unique pour éviter les conflits d'espace de noms. Les LogicalIds de ces ressources sont dérivées lorsque la pile est créée. Vous pouvez les récupérer uniquement après la création de la pile à l'aide de AWS Management Console, AWS CLI ou l'un des SDK AWS. Nous vous déconseillons de référencer ces ressources par LogicalId car les valeurs de hachage peuvent être modifiées.

Référencement par propriété référençable des ressources AWS CloudFormation générées

Pour certaines ressources générées, AWS SAM fournit une propriété référençable de la propriété de la ressource AWS SAM. Vous pouvez utiliser cette propriété pour référencer une ressource générée AWS CloudFormation et ses propriétés dans votre fichier de modèle AWS SAM.

Note

Toutes les ressources AWS CloudFormation générées n'ont pas forcément des propriétés référençables. Pour ces ressources, vous devez utiliser le LogicalId.

Scénarios de ressources AWS CloudFormation générées

Le tableau suivant récapitule les ressources et propriétés AWS SAM qui composent les scénarios qui génèrent des ressources AWS CloudFormation. Les rubriques de la colonne Scénarios fournissent des informations détaillées sur les ressources AWS CloudFormation que AWS SAM génère pour ce scénario.

Ressource AWS SAM	Ressource base AWS CloudFormation	Scénarios
AWS::Serverless::Api	AWS::ApiGateway::RestApi	DomainNamela propriété est spécifiée UsagePlanla propriété est spécifiée
Application sans serveur AWS	AWS::CloudFormation::Stack	Outre le fait de générer la ressource base AWS CloudFormation, il n'existe pas de scénarios supplémentaires pour cette ressource sans serveur.
AWS::Serverless::Function	AWS::Lambda::Function	AutoPublishAlias la propriété est spécifiée La propriété Role n'est pas spécifiée DeploymentPreference la propriété est spécifiée Une source d'événement Api est spécifiée Une source d' HttpApiévénement est spécifiée Une source d'événements de streaming en continu est spécifiée Une source d'événement pont d'événements (ou bus d'événements) est spécifiée Une source d' IotRuleévénement est spécifiée OnSuccess(ou OnFailure) la propriété est spécifiée pour les événements Amazon SNS OnSuccessla propriété (ou OnFailure) est spécifiée pour les événements Amazon SQS
AWS::Serverless::HttpApi	AWS::ApiGatewayV2::Api	La propriété StageName est spécifiée La propriété StageName n'est pas spécifiée La propriété domainName est spécifiée
AWS::Serverless::LayerVersion	AWS::Lambda::LayerVersion	Outre le fait de générer la ressource base AWS CloudFormation, il n'existe pas de scénarios supplémentaires pour cette ressource sans serveur.
AWS::Serverless::SimpleTable	AWS::DynamoDB::Table	Outre le fait de générer la ressource base AWS CloudFormation, il n'existe pas de scénarios supplémentaires pour cette ressource sans serveur.
AWS::Serverless::StateMachine	AWS::StepFunctions::StateMachine	La propriété Role n'est pas spécifiée Une source d'événement Api est spécifiée Une source d'événement pont d'événements (ou bus d'événements) est spécifiée

Rubriques

• AWS CloudFormationRessources générées lorsque AWS::Serverless::Api est précisé
• AWS CloudFormationRessources générées lorsque Application sans serveur AWS est spécifié
• Ressources AWS CloudFormation générées lorsque vous spécifiez AWS::Serverless::Connector
• AWS CloudFormationRessources générées lorsque AWS::Serverless::Function est précisé
• AWS CloudFormationRessources générées lorsque AWS::Serverless::GraphQLApi est précisé
• AWS CloudFormationRessources générées lorsque AWS:: Serverless:: HttpApi est spécifié
• AWS CloudFormationRessources générées lorsque AWS::Serverless::LayerVersion est précisé
• AWS CloudFormationRessources générées lorsque AWS::Serverless::SimpleTable est précisé
• AWS CloudFormationRessources générées lorsque AWS::Serverless::StateMachine est précisé