Amazon API Gateway Management V2 のアクション、リソース、および条件キー - サービス認証リファレンス

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

Amazon API Gateway Management V2 のアクション、リソース、および条件キー

Amazon API Gateway Management V2 (サービスプレフィックス: apigateway) では、IAM アクセス許可ポリシーで使用できるように、以下のサービス固有のリソースやアクション、条件コンテキストキーが用意されています。

参照:

Amazon API Gateway Management V2 で定義されたアクション

IAM ポリシーステートメントの Action 要素では、以下のアクションを指定できます。ポリシーを使用して、AWS でオペレーションを実行するアクセス許可を付与します。ポリシーでアクションを使用する場合は、通常、同じ名前の API オペレーションまたは CLI コマンドへのアクセスを許可または拒否します。ただし、場合によっては、1 つのアクションによって複数のオペレーションへのアクセスが制御されます。あるいは、いくつかのオペレーションはいくつかの異なるアクションを必要とします。

[リソースタイプ] 列は、各アクションがリソースレベルのアクセス許可をサポートしているかどうかを示します。この列に値がない場合は、ポリシーステートメントの Resource 要素ですべてのリソース (「*」) を指定する必要があります。列にリソースタイプが含まれる場合、そのアクションを含むステートメントでそのタイプの ARN を指定できます。必須リソースは、アスタリスク (*) でテーブルに示されています。このアクションを使用してステートメントでリソースレベルのアクセス許可 ARN を指定する場合、このタイプである必要があります。一部のアクションでは、複数のリソースタイプがサポートされています。リソースタイプがオプション (必須として示されていない) の場合、一方を使用することはできますが、他方を使用することはできません。

以下の表の列の詳細については、「アクションテーブル」を参照してください。

Amazon API Gateway Management V2 で定義されるリソースタイプ

以下のリソースタイプは、このサービスによって定義され、IAM アクセス許可ポリシーステートメントの Resource 要素で使用できます。[Actions table] (アクションテーブル) の各アクションは、そのアクションで指定できるリソースタイプを示しています。リソースタイプは、ポリシーに含めることができる条件キーを定義することもできます。これらのキーは、テーブルの最後の列に表示されます。以下の表の列の詳細については、「リソースタイプテーブル」を参照してください。

リソースタイプ ARN 条件キー
AccessLogSettings arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/accesslogsettings/
Api arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/

apigateway:Request/ApiKeyRequired

apigateway:Request/ApiName

apigateway:Request/AuthorizerType

apigateway:Request/AuthorizerUri

apigateway:Request/DisableExecuteApiEndpoint

apigateway:Request/EndpointType

apigateway:Request/RouteAuthorizationType

apigateway:Resource/ApiKeyRequired

apigateway:Resource/ApiName

apigateway:Resource/AuthorizerType

apigateway:Resource/AuthorizerUri

apigateway:Resource/DisableExecuteApiEndpoint

apigateway:Resource/EndpointType

apigateway:Resource/RouteAuthorizationType

Apis arn:${Partition}:apigateway:${Region}::/apis/

apigateway:Request/ApiKeyRequired

apigateway:Request/ApiName

apigateway:Request/AuthorizerType

apigateway:Request/AuthorizerUri

apigateway:Request/DisableExecuteApiEndpoint

apigateway:Request/EndpointType

apigateway:Request/RouteAuthorizationType

ApiMapping arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}/apimappings/${ApiMappingId}/
ApiMappings arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}/apimappings/
Authorizer arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers/${AuthorizerId}/

apigateway:Request/AuthorizerType

apigateway:Request/AuthorizerUri

apigateway:Resource/AuthorizerType

apigateway:Resource/AuthorizerUri

Authorizers arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers/

apigateway:Request/AuthorizerType

apigateway:Request/AuthorizerUri

AuthorizersCache arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/cache/authorizers/
Cors arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/cors/
Deployment arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/deployments/${DeploymentId}/
Deployments arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/deployments/

apigateway:Request/StageName

ExportedAPI arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/exports/${Specification}/
Integration arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}/
Integrations arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/
IntegrationResponse arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}/integrationresponses/${IntegrationResponseId}/
IntegrationResponses arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}/integrationresponses/
Model arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models/${ModelId}/
Models arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models/
ModelTemplate arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models/${ModelId}/template/
Route arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/

apigateway:Request/ApiKeyRequired

apigateway:Request/RouteAuthorizationType

apigateway:Resource/ApiKeyRequired

apigateway:Resource/RouteAuthorizationType

Routes arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/

apigateway:Request/ApiKeyRequired

apigateway:Request/RouteAuthorizationType

RouteResponse arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/routeresponses/${RouteResponseId}/
RouteResponses arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/routeresponses/
RouteRequestParameter arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/requestparameters/${RequestParameterKey}/
RouteSettings arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/routesettings/${RouteKey}/
Stage arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/

apigateway:Request/AccessLoggingDestination

apigateway:Request/AccessLoggingFormat

apigateway:Resource/AccessLoggingDestination

apigateway:Resource/AccessLoggingFormat

Stages arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/

apigateway:Request/AccessLoggingDestination

apigateway:Request/AccessLoggingFormat

Amazon API ゲートウェイ管理 V2 の条件キー

Amazon API Gateway Management V2 では、Condition ポリシーの IAM 要素で使用できる以下の条件キーを定義します。これらのキーを使用して、ポリシーステートメントが適用される条件をさらに絞り込むことができます。以下の表の列の詳細については、「条件キーテーブル」を参照してください。

すべてのサービスで使用できるグローバル条件キーを確認するには、使用できるグローバル条件キーを参照してください。

条件キー 説明 タイプ
apigateway:Request/AccessLoggingDestination アクセスログの宛先によってアクセスをフィルタリングします。CreateStage および UpdateStage 操作中に使用できます 文字列
apigateway:Request/AccessLoggingFormat アクセスログ形式でアクセスをフィルタリングします。CreateStage および UpdateStage 操作中に使用できます 文字列
apigateway:Request/ApiKeyRequired API キーが必要かどうかに基づいてアクセスをフィルタリングします。CreateRoute および UpdateRoute 操作中に使用できます。インポートおよび再インポート時にコレクションとしても使用できます ArrayOfBool
apigateway:Request/ApiName API 名でアクセスをフィルタリングします。CreateApi および UpdateApi 操作中に使用できます 文字列
apigateway:Request/AuthorizerType REQUEST や JWTなど、リクエスト内のオーソライザーの種類によってアクセスをフィルタリングします。CreateAuthorizer および UpdateAuthorizer 中に使用できます。ArrayOfString としてインポートおよび再インポート時にも使用できます ArrayOfString
apigateway:Request/AuthorizerUri Lambda オーソライザー関数の URI でアクセスをフィルタリングします。CreateAuthorizer および UpdateAuthorizer 中に使用できます。ArrayOfString としてインポートおよび再インポート時にも使用できます ArrayOfString
apigateway:Request/DisableExecuteApiEndpoint デフォルトの execute-api エンドポイントのステータスでアクセスをフィルタリングします。CreateApi および UpdateApi 操作中に使用できます Bool
apigateway:Request/EndpointType エンドポイントタイプでアクセスをフィルタリングします。CreateDomainName、UpdateDomainName、CreateApi、および UpdateApi 操作中に使用できます 文字列
apigateway:Request/MtlsTrustStoreUri 相互 TLS 認証に使用されるトラストストアの URI でアクセスをフィルタリングします。CreateDomainName および UpdateDomainName 操作中に使用できます 文字列
apigateway:Request/MtlsTrustStoreVersion 相互 TLS 認証に使用されるトラストストアのバージョンでアクセスをフィルタリングします。CreateDomainName および UpdateDomainName 操作中に使用できます 文字列
apigateway:Request/RouteAuthorizationType NONE、AWS_IAM、CUSTOM、JWT などの認証タイプでアクセスをフィルタリングします。CreateRoute および UpdateRoute 操作中に使用できます。インポート時にコレクションとしても使用できます ArrayOfString
apigateway:Request/SecurityPolicy TLS バージョンでアクセスをフィルタリングします。CreateDomain および UpdateDomain 操作中に使用できます ArrayOfString
apigateway:Request/StageName 作成しようとするデプロイのステージ名でアクセスをフィルタリングします。CreateDeployment 操作中に使用できます 文字列
apigateway:Resource/AccessLoggingDestination 現在のステージリソースのアクセスログの宛先でアクセスをフィルタリングします。UpdateStage および DeleteStage 操作中に使用できます 文字列
apigateway:Resource/AccessLoggingFormat 現在のステージリソースのアクセスログ形式でアクセスをフィルタリングします。UpdateStage および DeleteStage 操作中に使用できます 文字列
apigateway:Resource/ApiKeyRequired 既存のルートリソースに API キーが必要かどうかに基づいてアクセスをフィルタリングします。UpdateRoute および DeleteRoute 操作中に使用できます。再インポート時にコレクションとしても使用できます ArrayOfBool
apigateway:Resource/ApiName API 名でアクセスをフィルタリングします。UpdateApi および DeleteApi 操作中に使用できます 文字列
apigateway:Resource/AuthorizerType REQUEST や JWTなど、オーソライザーの現在のタイプでアクセスをフィルタリングします。UpdateAuthorizer および DeleteAuthorizer 操作中に使用できます。ArrayOfString としてインポートおよび再インポート時にも使用できます ArrayOfString
apigateway:Resource/AuthorizerUri 現在の API に関連付けられた現在の Lambda オーソライザーの URI によってアクセスをフィルタリングします。UpdateAuthorizer と DeleteAuthorizer 中に使用できます再インポート時にコレクションとしても使用できます ArrayOfString
apigateway:Resource/DisableExecuteApiEndpoint デフォルトの execute-api エンドポイントのステータスでアクセスをフィルタリングします。UpdateApi および DeleteApi 操作中に使用できます Bool
apigateway:Resource/EndpointType エンドポイントタイプでアクセスをフィルタリングします。UpdateDomainName、DeleteDomainName、UpdateApi、および DeleteApi 操作中に使用できます 文字列
apigateway:Resource/MtlsTrustStoreUri 相互 TLS 認証に使用されるトラストストアの URI でアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます 文字列
apigateway:Resource/MtlsTrustStoreVersion 相互 TLS 認証に使用されるトラストストアのバージョンでアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます 文字列
apigateway:Resource/RouteAuthorizationType NONE、AWS_IAM、CUSTOM などの既存のルートリソースの認証タイプによってアクセスをフィルタリングします。UpdateRoute および DeleteRoute 操作中に使用できます。再インポート時にコレクションとしても使用できます ArrayOfString
apigateway:Resource/SecurityPolicy TLS バージョンでアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます ArrayOfString
aws:RequestTag/${TagKey} リクエスト内のタグキーと値のペアのプレゼンスに基づいてアクションをフィルタリングします 文字列
aws:ResourceTag/${TagKey} リソースにアタッチされているタグキーと値のペアに基づいてアクションをフィルタリングします 文字列
aws:TagKeys リクエスト内のタグキーのプレゼンスに基づいてアクションをフィルタリングします 文字列