メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ApiGateway::Account

AWS::ApiGateway::Account リソースは、Amazon CloudWatch Logs (CloudWatch Logs) に API ログを書き込むために Amazon API Gateway (API Gateway) が使用する AWS Identity and Access Management (IAM) ロールを指定します。

重要

API Gateway リソースを AWS アカウントで作成したことがない場合は、AWS::ApiGateway::RestApiAWS::ApiGateway::ApiKey リソースなど他の API Gateway リソースへの依存関係も追加する必要があります。

API Gateway リソースが AWS アカウントですでに作成されている場合、依存関係は (そのリソースが削除されていても) 必要ありません。

構文

このリソースを宣言するための構文。

JSON

Copy
{ "Type" : "AWS::ApiGateway::Account", "Properties" : { "CloudWatchRoleArn": String } }

YAML

Copy
Type: "AWS::ApiGateway::Account" Properties: CloudWatchRoleArn: String

プロパティ

CloudWatchRoleArn

アカウント内の CloudWatch Logs への書き込み権限がある IAM ロールの Amazon リソースネーム (ARN)。

Required: No

Type: String

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により mysta-accou-01234b567890example のようなリソースの ID が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、ログを CloudWatch Logs にプッシュするために API Gateway に割り当て可能な IAM ロールを作成します。例では、ロールを AWS::ApiGateway::Account リソースに関連付けます。

JSON

Copy
"CloudWatchRole": { "Type": "AWS::IAM::Role", "Properties": { "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Principal": { "Service": [ "apigateway.amazonaws.com" ] }, "Action": "sts:AssumeRole" }] }, "Path": "/", "ManagedPolicyArns": ["arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs"] } }, "Account": { "Type": "AWS::ApiGateway::Account", "Properties": { "CloudWatchRoleArn": { "Fn::GetAtt": ["CloudWatchRole", "Arn"] } } }

YAML

Copy
CloudWatchRole: Type: "AWS::IAM::Role" Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - "apigateway.amazonaws.com" Action: "sts:AssumeRole" Path: "/" ManagedPolicyArns: - "arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs" Account: Type: "AWS::ApiGateway::Account" Properties: CloudWatchRoleArn: "Fn::GetAtt": - CloudWatchRole - Arn

このページの内容: