Référencement des ressources CloudFormation générées Scénarios CloudFormation de ressources générés

CloudFormation Ressources générées pour AWS SAM

Cette section fournit des informations détaillées sur les CloudFormation ressources créées lors du traitement AWS SAM de votre AWS modèle. L'ensemble de CloudFormation ressources AWS SAM généré varie 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 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 la AutoPublishAlias propriété facultative, des AWS SAM sources AWS::Lambda::Alias et AWS::Lambda::Version des ressources supplémentaires.

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

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

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

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

Les CloudFormation ressources AWS SAM générées possèdent chacune un LogicalId identifiant alphanumérique (A-Z, a-z, 0-9) unique dans un fichier modèle. AWS SAM utilise les AWS SAM ressources LogicalIds de votre fichier modèle pour créer LogicalIds les CloudFormation ressources qu'il génère. Vous pouvez utiliser une CloudFormation ressource générée pour accéder aux propriétés de cette ressource dans votre fichier modèle, comme vous le feriez pour une CloudFormation ressource que vous avez explicitement déclarée. LogicalId Pour plus d'informations sur LogicalIds les modèles intégrés CloudFormation et les AWS SAM modèles, consultez la section Ressources du guide de AWS CloudFormation l'utilisateur.

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 ne pouvez les récupérer qu'une fois que la pile a été créée à l'aide du AWS Management Console AWS CLI, ou de l'un des AWS SDKs. Nous vous déconseillons de référencer ces ressources par LogicalId car les valeurs de hachage peuvent être modifiées.

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

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

Note

Les CloudFormation ressources générées ne possèdent pas toutes des propriétés référençables. Pour ces ressources, vous devez utiliser le LogicalId.

Scénarios CloudFormation de ressources générés

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

AWS SAM ressource	CloudFormation Ressource de base	Scénarios
`AWS::Serverless::Api`	`AWS::ApiGateway::RestApi`	DomainNamela propriété est spécifiée UsagePlanla propriété est spécifiée
`AWS::Serverless::Application`	`AWS::CloudFormation::Stack`	Hormis la génération de la CloudFormation ressource de base, il n'existe aucun autre scénario 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`	StageNamela propriété est spécifiée StageNamela propriété n'est pas spécifiée DomainNamela propriété est spécifiée
`AWS::Serverless::LayerVersion`	`AWS::Lambda::LayerVersion`	Hormis la génération de la CloudFormation ressource de base, il n'existe aucun autre scénario pour cette ressource sans serveur.
`AWS::Serverless::SimpleTable`	`AWS::DynamoDB::Table`	Hormis la génération de la CloudFormation ressource de base, il n'existe aucun autre scénario 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 d'API est spécifiée Une source d'événement pont d'événements (ou bus d'événements) est spécifiée

Rubriques

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

ScheduleV2

AWS::Serverless::Api