SourceReference - Amazon Serverless Application Model
SyntaxPropertiesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SourceReference

A reference to a source resource that the AWS::Serverless::Connector resource type uses.

Syntax

To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.

YAML

Qualifier: String

Properties

Qualifier

A qualifier for a resource that narrows its scope. Qualifier replaces the * value at the end of a resource constraint ARN.

Note

Qualifier definition varies per resource type. For a list of supported source and destination resource types, see Amazon SAM connector reference.

Type: String

Required: Conditional

Amazon CloudFormation compatibility: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.

Examples

The following example uses embedded connectors to define a source resource with a property other than 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
    ...