翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon API Gateway Management V2 のアクション、リソース、および条件キー
Amazon API Gateway Management V2 (サービスプレフィックス: apigateway) では、IAM アクセス許可ポリシーで使用できるように、以下のサービス固有のリソースやアクション、条件コンテキストキーが用意されています。
参照:
-
このサービスを設定する方法について説明します。
-
このサービスで使用可能な API オペレーションのリストを表示します。
-
IAM アクセス許可ポリシーを使用して、このサービスとそのリソースを保護する方法を学びます。
トピック
Amazon API Gateway Management V2 で定義されたアクション
IAM ポリシーステートメントの Action エレメントでは、以下のアクションを指定できます。ポリシーを使用して、 AWSでオペレーションを実行するアクセス許可を付与します。ポリシーでアクションを使用する場合は、通常、同じ名前の API オペレーションまたは CLI コマンドへのアクセスを許可または拒否します。ただし、場合によっては、1 つのアクションによって複数のオペレーションへのアクセスが制御されます。あるいは、いくつかのオペレーションはいくつかの異なるアクションを必要とします。
アクションテーブルの [アクセスレベル] 列では、アクションの指定方法 (リスト、読み取り、アクセス許可管理、タグ付け) について説明します。このように分類することで、ポリシーで使用する際にアクションで付与するアクセスレベルを理解しやすくなります。アクセスレベルの詳細については、「ポリシー概要内のアクセスレベル」を参照してください。
[アクション] テーブルの [リソースタイプ] 列は、各アクションがリソースレベルの許可をサポートしているかどうかを示します。この列に値がない場合は、ポリシーステートメントの Resource 要素で、ポリシーが適用されるすべてのリソース (「*」) を指定する必要があります。列にリソースタイプが含まれる場合、そのアクションを含むステートメントでそのタイプの ARN を指定できます。アクションで 1 つ以上のリソースが必須となっている場合、呼び出し元には、それらのリソースを伴うアクションを使用するための許可が付与されている必要があります。必須リソースは、アスタリスク (*) でテーブルに示されています。IAM ポリシーの Resource 要素でリソースアクセスを制限する場合は、必要なリソースタイプごとに ARN またはパターンを含める必要があります。一部のアクションでは、複数のリソースタイプがサポートされています。リソースタイプがオプション (必須として示されていない) の場合、オプションのリソースタイプのいずれかを使用することを選択できます。
[アクション] テーブルの [条件キー] 列には、ポリシーステートメントの Condition 要素で指定できるキーが含まれます。サービスのリソースに関連付けられている条件キーの詳細については、[リソースタイプ] テーブルの [条件キー] 列を参照してください。
Actions テーブルの [依存アクション] 列には、アクションを正常に呼び出すために必要な追加のアクセス許可が表示されます。これらのアクセス許可は、アクション自体のアクセス許可に加えて必要になる場合があります。アクションが依存アクションを指定すると、それらの依存関係は、テーブルにリストされている最初のリソースだけでなく、そのアクションに定義された追加のリソースに適用される場合があります。
注記
リソース条件キーは、リソースタイプテーブルに一覧表示されています。アクションに適用されるリソースタイプへのリンクは、[アクション] テーブルの [リソースタイプ (* 必須)] 列にあります。[リソースタイプ] テーブルのリソースタイプには、[アクション] テーブルのアクションに適用されるリソース条件キーである、[条件キー] 列が含まれています。
以下の表の列の詳細については、「アクションテーブル」を参照してください。
| アクション | 説明 | アクセスレベル | リソースタイプ (* 必須) | 条件キー | 依存アクション |
|---|---|---|---|---|---|
| CreatePortal | ポータルを作成するアクセス許可を付与します | 書き込み | |||
|
apigateway:Request/PortalDisplayName apigateway:Request/PortalDomainName |
|||||
| CreatePortalProduct | ポータル製品を作成するアクセス許可を付与します | 書き込み | |||
| CreateProductPage | 製品ページを作成するアクセス許可を付与します | 書き込み | |||
| CreateProductRestEndpointPage | 製品 REST エンドポイントページを作成するアクセス許可を付与します | 書き込み | |||
| CreateRoutingRule | ルーティングルールを作成する許可を付与 | 書き込み | |||
| DELETE | 特定のリソースを削除する許可を付与 | 書き込み | |||
| DeletePortal | ポータルを削除するアクセス許可を付与します | 書き込み | |||
| DeletePortalProduct | ポータル製品を削除するアクセス許可を付与します | 書き込み | |||
| DeletePortalProductSharingPolicy | ポータル製品共有ポリシーを削除するアクセス許可を付与します | 権限の管理 | |||
| DeleteProductPage | 製品ページを削除するアクセス許可を付与します | 書き込み | |||
| DeleteProductRestEndpointPage | 製品 REST エンドポイントページを削除するアクセス許可を付与します | 書き込み | |||
| DeleteRoutingRule | ルーティングルールを削除する許可を付与 | 書き込み | |||
| DisablePortal | ポータルを無効にするアクセス許可を付与します | 書き込み | |||
| GET | 特定のリソースを読み取るアクセス許可を付与 | 読み取り | |||
| GetPortal | ポータルを読み取るアクセス許可を付与します | 読み取り | |||
| GetPortalProduct | ポータル製品を読み取るアクセス許可を付与します | 読み取り | |||
| GetPortalProductSharingPolicy | ポータル製品共有ポリシーを読み取るアクセス許可を付与します | 読み取り | |||
| GetProductPage | 製品ページを読み取るアクセス許可を付与します | 読み取り | |||
| GetProductRestEndpointPage | 製品 REST エンドポイントページを読み取るアクセス許可を付与します | 読み取り | |||
| GetRoutingRule | ルーティングルールを読み取るための許可を付与 | 読み取り | |||
| ListPortalProducts | ポータル製品を一覧表示するアクセス許可を付与します | リスト | |||
| ListPortals | ポータルを一覧表示するアクセス許可を付与します | リスト | |||
| ListProductPages | 製品ページを一覧表示する許可を付与 | リスト | |||
| ListProductRestEndpointPages | 製品 REST エンドポイントページを一覧表示する許可を付与 | リスト | |||
| ListRoutingRules | ドメイン名の下にルーティングルールを一覧表示するアクセス許可を付与 | リスト | |||
| PATCH | 特定のリソースを更新する許可を付与 | 書き込み | |||
| POST | トラッカーリソースを作成する許可を付与 | 書き込み | |||
| PUT | 特定のリソースを更新する許可を付与 | 書き込み | |||
| PreviewPortal | ポータルをプレビューするアクセス許可を付与します | 書き込み | |||
| PublishPortal | ポータルを公開するアクセス許可を付与します | 書き込み | |||
| PutPortalProductSharingPolicy | ポータル製品共有ポリシーを配置するアクセス許可を付与します | 権限の管理 | |||
| UpdatePortal | ポータルを更新するアクセス許可を付与します | 書き込み | |||
|
apigateway:Request/PortalDisplayName apigateway:Request/PortalDomainName |
|||||
| UpdatePortalProduct | ポータル製品を更新するアクセス許可を付与します | 書き込み | |||
| UpdateProductPage | 製品ページを更新するアクセス許可を付与します | 書き込み | |||
| UpdateProductRestEndpointPage | 製品 REST エンドポイントページを更新するアクセス許可を付与します | 書き込み | |||
| UpdateRoutingRule | PutRoutingRule API を使用してルーティングルールを更新する許可を付与 | 書き込み | |||
Amazon API Gateway Management V2 で定義されるリソースタイプ
以下のリソースタイプは、このサービスによって定義され、IAM アクセス許可ポリシーステートメントの Resource エレメントで使用できます。アクションテーブルの各アクションは、そのアクションで指定できるリソースタイプを示しています。リソースタイプは、ポリシーに含めることができる条件キーを定義することもできます。これらのキーは、[リソースタイプ] テーブルの最後の列に表示されます。以下の表の列の詳細については、「リソースタイプテーブル」を参照してください。
| リソースタイプ | ARN | 条件キー |
|---|---|---|
| AccessLogSettings |
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/accesslogsettings
|
|
| Api |
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}
|
apigateway:Request/ApiKeyRequired apigateway:Request/AuthorizerType apigateway:Request/AuthorizerUri apigateway:Request/DisableExecuteApiEndpoint apigateway:Request/EndpointType apigateway:Request/RouteAuthorizationType apigateway:Resource/ApiKeyRequired apigateway:Resource/AuthorizerType apigateway:Resource/AuthorizerUri apigateway:Resource/DisableExecuteApiEndpoint apigateway:Resource/EndpointType |
| Apis |
arn:${Partition}:apigateway:${Region}::/apis
|
apigateway:Request/ApiKeyRequired apigateway:Request/AuthorizerType apigateway:Request/AuthorizerUri apigateway:Request/DisableExecuteApiEndpoint apigateway:Request/EndpointType |
| 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 |
| Authorizers |
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers
|
apigateway:Request/AuthorizerType |
| 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
|
|
| 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 |
| Routes |
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes
|
apigateway:Request/ApiKeyRequired |
| 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}
|
|
| RoutingRule |
arn:${Partition}:apigateway:${Region}:${Account}:/domainnames/${DomainName}/routingrules/${RoutingRuleId}
|
|
| Stage |
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}
|
apigateway:Request/AccessLoggingDestination apigateway:Request/AccessLoggingFormat apigateway:Resource/AccessLoggingDestination |
| Stages |
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages
|
apigateway:Request/AccessLoggingDestination |
| VpcLink |
arn:${Partition}:apigateway:${Region}::/vpclinks/${VpcLinkId}
|
|
| VpcLinks |
arn:${Partition}:apigateway:${Region}::/vpclinks
|
|
| Portal |
arn:${Partition}:apigateway:${Region}:${Account}:/portals/${PortalId}
|
apigateway:Resource/CognitoUserPoolArn apigateway:Resource/PortalDisplayName apigateway:Resource/PortalDomainName |
| PortalProduct |
arn:${Partition}:apigateway:${Region}:${Account}:/portalproducts/${PortalProductId}
|
|
| ProductPage |
arn:${Partition}:apigateway:${Region}:${Account}:/portalproducts/${PortalProductId}/productpages/${ProductPageId}
|
|
| ProductRestEndpointPage |
arn:${Partition}:apigateway:${Region}:${Account}:/portalproducts/${PortalProductId}/productrestendpointpages/${ProductRestEndpointPageId}
|
Amazon API Gateway Management V2 の条件キー
Amazon API Gateway Management V2 では、IAM ポリシーの Condition 要素で使用できる以下の条件キーを定義します。これらのキーを使用して、ポリシーステートメントが適用される条件をさらに絞り込むことができます。以下の表の列の詳細については、「条件キーテーブル」を参照してください。
すべてのサービスで使用できるグローバル条件キーを確認するには、「AWS グローバル条件コンテキストキー」を参照してください。
| 条件キー | 説明 | タイプ |
|---|---|---|
| apigateway:Request/AccessLoggingDestination | アクセスログの宛先によってアクセスをフィルタリングします。CreateStage および UpdateStage 操作中に使用できます | 文字列 |
| apigateway:Request/AccessLoggingFormat | アクセスログ形式でアクセスをフィルタリングします。CreateStage および UpdateStage 操作中に使用できます | String |
| 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/CognitoUserPoolArn | リクエストで渡されたポータルの CognitoUserPoolArn によってアクセスをフィルタリングします | ARN |
| apigateway:Request/ConditionBasePaths | ルーティングルールの条件に基づいて定義されたベースパスでアクセスをフィルタリングします。CreateRoutingRule および UpdateRoutingRule 操作中に使用できます | ArrayOfString |
| apigateway:Request/DisableExecuteApiEndpoint | デフォルトの execute-api エンドポイントのステータスでアクセスをフィルタリングします。CreateApi および UpdateApi 操作中に使用できます | Bool |
| apigateway:Request/EndpointType | エンドポイントタイプでアクセスをフィルタリングします。CreateDomainName、UpdateDomainName、CreateApi、および UpdateApi 操作中に使用できます | ArrayOfString |
| apigateway:Request/Method | リクエストで渡された ProductRestEndpointPage の HTTP メソッドでアクセスをフィルタリングします | String |
| apigateway:Request/MtlsTrustStoreUri | 相互 TLS 認証に使用されるトラストストアの URI でアクセスをフィルタリングします。CreateDomainName および UpdateDomainName 操作中に使用できます | 文字列 |
| apigateway:Request/MtlsTrustStoreVersion | 相互 TLS 認証に使用されるトラストストアのバージョンでアクセスをフィルタリングします。CreateDomainName および UpdateDomainName 操作中に使用できます | String |
| apigateway:Request/PortalDisplayName | リクエストで渡されたポータルの表示名でアクセスをフィルタリングします | String |
| apigateway:Request/PortalDomainName | リクエストで渡されたポータルのバニティドメイン名でアクセスをフィルタリングします | String |
| apigateway:Request/PortalProductDisplayName | リクエストで渡された PortalProduct の表示名でアクセスをフィルタリングします | String |
| apigateway:Request/Priority | ルーティングルールの優先度でアクセスをフィルタリングします。CreateRoutingRule および UpdateRoutingRule 操作中に使用できます | 数値 |
| apigateway:Request/ProductPageTitle | リクエストで渡された ProductPage のタイトルでアクセスをフィルタリングします | String |
| apigateway:Request/ProductRestEndpointPageEndpointPrefix | リクエストで渡された ProductRestEndpointPage の EndpointPrefix でアクセスをフィルタリングします | String |
| apigateway:Request/RestApiId | リクエストで渡された ProductRestEndpointPage の Amazon API Gateway API ID でアクセスをフィルタリングします | String |
| apigateway:Request/RouteAuthorizationType | NONE、AWS_IAM、CUSTOM、JWT などの認可タイプでアクセスをフィルタリングします。CreateRoute および UpdateRoute 操作中に使用できます。インポート時にコレクションとしても使用できます | ArrayOfString |
| apigateway:Request/RoutingMode | ドメイン名のルーティングモードでアクセスをフィルタリングします。CreateDomainName および UpdateDomainName 操作中に使用できます | String |
| apigateway:Request/SecurityPolicy | TLS バージョンでアクセスをフィルタリングします。CreateDomain および UpdateDomain 操作中に使用できます | ArrayOfString |
| apigateway:Request/Stage | リクエストで渡された ProductRestEndpointPage の Amazon API Gateway ステージ名でアクセスをフィルタリングします | String |
| apigateway:Request/StageName | 作成しようとするデプロイのステージ名でアクセスをフィルタリングします。CreateDeployment 操作中に使用できます | 文字列 |
| apigateway:Resource/AccessLoggingDestination | 現在のステージリソースのアクセスログの宛先でアクセスをフィルタリングします。UpdateStage および DeleteStage 操作中に使用できます | 文字列 |
| apigateway:Resource/AccessLoggingFormat | 現在のステージリソースのアクセスログ形式でアクセスをフィルタリングします。UpdateStage および DeleteStage 操作中に使用できます | String |
| 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/CognitoUserPoolArn | リソースに関連付けられたポータルの CognitoUserPoolArn でアクセスをフィルタリングします | ARN |
| apigateway:Resource/ConditionBasePaths | 既存のルーティングルールの条件に基づいて定義されたベースパスでアクセスをフィルタリングします。UpdateRoutingRule および DeleteRoutingRule 操作中に使用できます | ArrayOfString |
| apigateway:Resource/DisableExecuteApiEndpoint | デフォルトの execute-api エンドポイントのステータスでアクセスをフィルタリングします。UpdateApi および DeleteApi 操作中に使用できます | Bool |
| apigateway:Resource/EndpointType | エンドポイントタイプでアクセスをフィルタリングします。UpdateDomainName、DeleteDomainName、UpdateApi、および DeleteApi 操作中に使用できます | ArrayOfString |
| apigateway:Resource/Method | リソースに関連付けられた ProductRestEndpointPage の HTTP メソッドでアクセスをフィルタリングします | String |
| apigateway:Resource/MtlsTrustStoreUri | 相互 TLS 認証に使用されるトラストストアの URI でアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます | 文字列 |
| apigateway:Resource/MtlsTrustStoreVersion | 相互 TLS 認証に使用されるトラストストアのバージョンでアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます | String |
| apigateway:Resource/PortalDisplayName | リソースに関連付けられたポータルの表示名でアクセスをフィルタリングします | String |
| apigateway:Resource/PortalDomainName | リソースに関連付けられたポータルのバニティドメイン名でアクセスをフィルタリングします | String |
| apigateway:Resource/PortalProductDisplayName | リソースに関連付けられた PortalProduct の表示名でアクセスをフィルタリングします | String |
| apigateway:Resource/PortalPublishStatus | リソースに関連付けられたポータルの公開ステータスでアクセスをフィルタリングします | String |
| apigateway:Resource/Priority | 既存のルーティングルールの優先度でアクセスをフィルタリングします。UpdateRoutingRule および DeleteRoutingRule 操作中に使用できます | 数値 |
| apigateway:Resource/ProductPageTitle | リソースに関連付けられた ProductPage のタイトルでアクセスをフィルタリングします | String |
| apigateway:Resource/ProductRestEndpointPageEndpointPrefix | リソースに関連付けられた ProductRestEndpointPage の EndpointPrefix でアクセスをフィルタリングします | String |
| apigateway:Resource/RestApiId | リソースに関連付けられた ProductRestEndpointPage の Amazon API Gateway API ID でアクセスをフィルタリングします | String |
| apigateway:Resource/RouteAuthorizationType | NONE、AWS_IAM、CUSTOM などの既存のルートリソースの認可タイプによってアクセスをフィルタリングします。UpdateRoute および DeleteRoute 操作中に使用できます。再インポート時にコレクションとしても使用できます | ArrayOfString |
| apigateway:Resource/RoutingMode | 既存のドメイン名のルーティングモードでアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます | String |
| apigateway:Resource/SecurityPolicy | TLS バージョンでアクセスをフィルタリングします。UpdateDomainName および DeleteDomainName 操作中に使用できます | ArrayOfString |
| apigateway:Resource/Stage | リソースに関連付けられた ProductRestEndpointPage の Amazon API Gateway ステージ名でアクセスをフィルタリングします | String |
| aws:RequestTag/${TagKey} | リクエスト内のタグキーおよび値のペアのプレゼンスによってアクションをフィルタリングします | String |
| aws:ResourceTag/${TagKey} | リソースにアタッチされているタグキーおよび値のペアでアクセスをフィルタリングします | String |
| aws:TagKeys | リクエスト内のタグキーが存在するかどうかでアクセスをフィルタリングします | ArrayOfString |
