Generated AWS CloudFormation resources for AWS SAM

This section provides details on the AWS CloudFormation resources that are created when AWS SAM processes your AWS template. The set of AWS CloudFormation resources that AWS SAM generates differs depending on the scenarios you specify. A scenario is the combination of AWS SAM resources and properties specified in your template file. You can reference the generated AWS CloudFormation resources elsewhere within your template file, similar to how you reference resources that you declare explicitly in your template file.

For example, if you specify an AWS::Serverless::Function resource in your AWS SAM template file, AWS SAM always generates an AWS::Lambda::Function base resource. If you also specify the optional AutoPublishAlias property, AWS SAM additionally generates AWS::Lambda::Alias and AWS::Lambda::Version resources.

This section lists the scenarios and the AWS CloudFormation resources that they generate, and shows how to reference the generated AWS CloudFormation resources in your AWS SAM template file.

Referencing generated AWS CloudFormation resources

You have two options for referencing generated AWS CloudFormation resources within your AWS SAM template file, by LogicalId or by referenceable property.

Referencing generated AWS CloudFormation resources by LogicalId

The AWS CloudFormation resources that AWS SAM generates each have a LogicalId, which is an alphanumeric (A-Z, a-z, 0-9) identifier that is unique within a template file. AWS SAM uses the LogicalIds of the AWS SAM resources in your template file to construct the LogicalIds of the AWS CloudFormation resources it generates. You can use the LogicalId of a generated AWS CloudFormation resource to access properties of that resource within your template file, just like you would for an AWS CloudFormation resource that you have explicitly declared. For more information about LogicalIds in AWS CloudFormation and AWS SAM templates, see Resources in the AWS CloudFormation User Guide.

Note

The LogicalIds of some generated resources include a unique hash value to avoid namespace clashes. The LogicalIds of these resources are derived when the stack is created. You can retrieve them only after the stack has been created using the AWS Management Console, AWS CLI, or one of the AWS SDKs. We don't recommend referencing these resources by LogicalId because the hash values might change.

Referencing generated AWS CloudFormation resources by referenceable property

For some generated resources, AWS SAM provides a referenceable property of the AWS SAM resource. You can use this property to reference a generated AWS CloudFormation resource and its properties within your AWS SAM template file.

Note

Not all generated AWS CloudFormation resources have referenceable properties. For those resources, you must use the LogicalId.

Generated AWS CloudFormation resource scenarios

The following table summarizes the AWS SAM resources and properties that make up the scenarios that generate AWS CloudFormation resources. The topics in the Scenarios column provide details about the additional AWS CloudFormation resources that AWS SAM generates for that scenario.

AWS SAM resource	Base AWS CloudFormation resource	Scenarios
AWS::Serverless::Api	AWS::ApiGateway::RestApi	DomainName property is specified UsagePlan property is specified
AWS::Serverless::Application	AWS::CloudFormation::Stack	Other than generating the base AWS CloudFormation resource, there are no additional scenarios for this serverless resource.
AWS::Serverless::Function	AWS::Lambda::Function	AutoPublishAlias property is specified Role property is not specified DeploymentPreference property is specified An Api event source is specified An HttpApi event source is specified A streaming event source is specified An event bridge (or event bus) event source is specified An IotRule event source is specified OnSuccess (or OnFailure) property is specified for Amazon SNS events OnSuccess (or OnFailure) property is specified for Amazon SQS events
AWS::Serverless::HttpApi	AWS::ApiGatewayV2::Api	StageName property is specified StageName property is not specified DomainName property is specified
AWS::Serverless::LayerVersion	AWS::Lambda::LayerVersion	Other than generating the base AWS CloudFormation resource, there are no additional scenarios for this serverless resource.
AWS::Serverless::SimpleTable	AWS::DynamoDB::Table	Other than generating the base AWS CloudFormation resource, there are no additional scenarios for this serverless resource.
AWS::Serverless::StateMachine	AWS::StepFunctions::StateMachine	Role property is not specified An API event source is specified An event bridge (or event bus) event source is specified

Topics

• AWS CloudFormation resources generated when AWS::Serverless::Api is specified
• AWS CloudFormation resources generated when AWS::Serverless::Application is specified
• AWS CloudFormation resources generated when you specify AWS::Serverless::Connector
• AWS CloudFormation resources generated when AWS::Serverless::Function is specified
• AWS CloudFormation resources generated when AWS::Serverless::GraphQLApi is specified
• AWS CloudFormation resources generated when AWS::Serverless::HttpApi is specified
• AWS CloudFormation resources generated when AWS::Serverless::LayerVersion is specified
• AWS CloudFormation resources generated when AWS::Serverless::SimpleTable is specified
• AWS CloudFormation resources generated when AWS::Serverless::StateMachine is specified