在指定了 AWS::Serverless::Api 的情况下生成的 Amazon CloudFormation 资源
如果指定了 AWS::Serverless::Api,Amazon Serverless Application Model (Amazon SAM) 总是生成 AWS::ApiGateway::RestApi 基本 Amazon CloudFormation 资源。此外,它还总是生成 AWS::ApiGateway::Stage 和 AWS::ApiGateway::Deployment 资源。
AWS::ApiGateway::RestApi-
LogicalId:<api‑LogicalId>可引用属性:不适用(必须使用
LogicalId才能引用这种 Amazon CloudFormation 资源) AWS::ApiGateway::Stage-
LogicalId:<api‑LogicalId><stage‑name>Stage是<stage‑name>StageName属性将被设置为的字符串。例如,您将StageName设置为Gamma,LogicalId是。MyRestApiGammaStage可引用属性:
<api‑LogicalId>.Stage AWS::ApiGateway::Deployment-
LogicalId:<api‑LogicalId>Deployment<sha>是在创建堆栈时生成的唯一哈希值。例如<sha>。MyRestApiDeployment926eeb5ff1可引用属性:
<api‑LogicalId>.Deployment
除了这些 Amazon CloudFormation 资源外,如果指定了 AWS::Serverless::Api,Amazon SAM 还会生成适用于以下场景的其他 Amazon CloudFormation 资源。
指定了 DomainName 属性
如果指定了 AWS::Serverless::Api 的 Domain 属性的 DomainName 属性,Amazon SAM 会生成 AWS::ApiGateway::DomainName Amazon CloudFormation 资源。
AWS::ApiGateway::DomainName-
LogicalId:ApiGatewayDomainName<sha>是在创建堆栈时生成的唯一哈希值。例如:<sha>ApiGatewayDomainName。926eeb5ff1可引用属性:
<api‑LogicalId>.DomainName
指定了 UsagePlan 属性
如果指定了 AWS::Serverless::Api 的 Auth 属性的 UsagePlan 属性,Amazon SAM 会生成以下 Amazon CloudFormation 资源:AWS::ApiGateway::UsagePlan、AWS::ApiGateway::UsagePlanKey 和 AWS::ApiGateway::ApiKey。
AWS::ApiGateway::UsagePlan-
LogicalId:<api‑LogicalId>UsagePlan可引用属性:
<api‑LogicalId>.UsagePlan AWS::ApiGateway::UsagePlanKey-
LogicalId:<api‑LogicalId>UsagePlanKey可引用属性:
<api‑LogicalId>.UsagePlanKey AWS::ApiGateway::ApiKey-
LogicalId:<api‑LogicalId>ApiKey可引用属性:
<api‑LogicalId>.ApiKey