翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# CloudFormation AWS::Serverless::Apiが指定されているときに生成される リソース
<a name="sam-specification-generated-resources-api"></a>

を指定する`AWS::Serverless::Api`と、 AWS Serverless Application Model (AWS SAM) は常に`AWS::ApiGateway::RestApi`ベース CloudFormation リソースを生成します。これに加えて、`AWS::ApiGateway::Stage` と `AWS::ApiGateway::Deployment` リソースも常に生成します。

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`<api‑LogicalId>`  
*参照可能なプロパティ: *該当なし (この CloudFormation リソースを参照`LogicalId`するには を使用する必要があります)

**`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`

これらの CloudFormation リソースに加えて、 を指定すると、 `AWS::Serverless::Api`は次のシナリオで追加の CloudFormation リソース AWS SAM を生成します。

**Topics**
+ [DomainName プロパティが指定されている](#sam-specification-generated-resources-api-domain-name)
+ [UsagePlan プロパティが指定されている](#sam-specification-generated-resources-api-usage-plan)

## DomainName プロパティが指定されている
<a name="sam-specification-generated-resources-api-domain-name"></a>

の `DomainName`プロパティの `Domain`プロパティを指定すると、 `AWS::Serverless::Api`は `AWS::ApiGateway::DomainName` CloudFormation リソース AWS SAM を生成します。

**`AWS::ApiGateway::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainName<sha>`  
`<sha>` は、スタックが作成されるときに生成される一意のハッシュ値です。例: `ApiGatewayDomainName926eeb5ff1`。  
*参照可能なプロパティ: *`<api‑LogicalId>.DomainName`

## UsagePlan プロパティが指定されている
<a name="sam-specification-generated-resources-api-usage-plan"></a>

の `UsagePlan`プロパティの `Auth`プロパティを指定すると、 `AWS::Serverless::Api`は `AWS::ApiGateway::UsagePlan`、`AWS::ApiGateway::UsagePlanKey`、および の CloudFormation リソース AWS SAM を生成します`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`