AWS CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Api, wenn angegeben - AWS Serverless Application Model

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Api, wenn angegeben

Wenn an angegeben AWS::Serverless::Api ist, generiert AWS Serverless Application Model (AWS SAM) immer eine AWS::ApiGateway::RestApi AWS CloudFormation Basisressource. Darüber hinaus generiert es auch immer eine AWS::ApiGateway::Stage und eine AWS::ApiGateway::Deployment Ressource.

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

Referenzierbare Eigenschaft: N/A (Sie müssen den verwenden, um auf diese LogicalId Ressource zu verweisen AWS CloudFormation )

AWS::ApiGateway::Stage

LogicalId: <api‑LogicalId><stage‑name>Stage

<stage‑name>ist die Zeichenfolge, auf die die StageName Eigenschaft gesetzt ist. Wenn Sie beispielsweise StageName auf einstellenGamma, LogicalId ist derMyRestApiGammaStage.

Referenzierbare Eigenschaft: <api‑LogicalId>.Stage

AWS::ApiGateway::Deployment

LogicalId: <api‑LogicalId>Deployment<sha>

<sha>ist ein eindeutiger Hashwert, der bei der Erstellung des Stacks generiert wird. z. B. MyRestApiDeployment926eeb5ff1.

Referenzierbare Eigenschaft: <api‑LogicalId>.Deployment

Zusätzlich zu diesen AWS CloudFormation Ressourcen werden, sofern AWS::Serverless::Api angegeben, zusätzliche AWS CloudFormation Ressourcen für die folgenden Szenarien AWS SAM generiert.

DomainNameEigenschaft ist angegeben

Wenn die DomainName Eigenschaft der Domain Eigenschaft von an angegeben AWS::Serverless::Api ist, wird die AWS::ApiGateway::DomainName AWS CloudFormation Ressource AWS SAM generiert.

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

<sha>ist ein eindeutiger Hashwert, der generiert wird, wenn der Stack erstellt wird. Zum Beispiel: ApiGatewayDomainName926eeb5ff1.

Referenzierbare Eigenschaft: <api‑LogicalId>.DomainName

UsagePlanEigenschaft ist spezifiziert

Wenn die UsagePlan Auth Eigenschaft einer angegeben AWS::Serverless::Api ist, werden die folgenden AWS CloudFormation Ressourcen AWS SAM generiert: AWS::ApiGateway::UsagePlanAWS::ApiGateway::UsagePlanKey, undAWS::ApiGateway::ApiKey.

AWS::ApiGateway::UsagePlan

LogicalId: <api‑LogicalId>UsagePlan

Referenzierbare Eigenschaft: <api‑LogicalId>.UsagePlan

AWS::ApiGateway::UsagePlanKey

LogicalId: <api‑LogicalId>UsagePlanKey

Referenzierbares Eigentum: <api‑LogicalId>.UsagePlanKey

AWS::ApiGateway::ApiKey

LogicalId: <api‑LogicalId>ApiKey

Referenzierbares Eigentum: <api‑LogicalId>.ApiKey