翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 要素で指定できるキーが含まれます。サービスのリソースに関連付けられている条件キーの詳細については、[リソースタイプ] テーブルの [条件キー] 列を参照してください。
注記
リソース条件キーは、リソースタイプテーブルに一覧表示されています。アクションに適用されるリソースタイプへのリンクは、[アクション] テーブルの [リソースタイプ (* 必須)] 列にあります。[リソースタイプ] テーブルのリソースタイプには、[アクション] テーブルのアクションに適用されるリソース条件キーである、[条件キー] 列が含まれています。
以下の表の列の詳細については、「アクションテーブル」を参照してください。
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}
|
|
| 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
|
Amazon API Gateway Management V2 の条件キー
Amazon API Gateway Management V2 では、IAM ポリシーの Condition要素で使用できる以下の条件キーを定義します。これらのキーを使用して、ポリシーステートメントが適用される条件をさらに絞り込むことができます。以下の表の列の詳細については、「条件キーテーブル」を参照してください。
すべてのサービスで使用できるグローバル条件キーを確認するには、「使用できるグローバル条件キー」を参照してください。
| 条件キー | 説明 | タイプ |
|---|---|---|
| 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 | Word や 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 の各オペレーションで使用可能 | ArrayOfString |
| apigateway:Request/MtlsTrustStoreUri | 相互 URI 認証に使用される信頼ストアの TLS でアクセスをフィルタリングします。 CreateDomainName および UpdateDomainName オペレーション中に使用可能 | 文字列 |
| apigateway:Request/MtlsTrustStoreVersion | 相互 TLS 認証に使用される信頼ストアのバージョンでアクセスをフィルタリングします。 CreateDomainName および UpdateDomainName オペレーション中に使用可能 | 文字列 |
| apigateway:Request/RouteAuthorizationType | NONE、 AWS_IAM、Word、JWT などの認可タイプでアクセスをフィルタリングCUSTOMします。 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 | Word や REQUEST など、現在のタイプのオーソライザーでアクセスをフィルタリングしますJWT。 UpdateAuthorizer および DeleteAuthorizer オペレーション中に使用できます。 ArrayOfString としてインポートおよび再インポート中にも使用可能 | ArrayOfString |
| apigateway:Resource/AuthorizerUri | 現在の URI に関連付けられている現在の Lambda オーソライザーの API でアクセスをフィルタリングします。 UpdateAuthorizer および DeleteAuthorizer で使用できます。再インポート時にコレクションとしても使用できます | ArrayOfString |
| apigateway:Resource/DisableExecuteApiEndpoint | デフォルトの execute-api エンドポイントのステータスでアクセスをフィルタリングします。 UpdateApi および DeleteApi オペレーション中に使用可能 | Bool |
| apigateway:Resource/EndpointType | エンドポイントタイプでアクセスをフィルタリングします。 UpdateDomainName、 DeleteDomainName、 UpdateApi、 DeleteApi の各オペレーションで使用可能 | ArrayOfString |
| apigateway:Resource/MtlsTrustStoreUri | 相互 URI 認証に使用される信頼ストアの TLS でアクセスをフィルタリングします。 UpdateDomainName および DeleteDomainName オペレーション中に使用可能 | 文字列 |
| apigateway:Resource/MtlsTrustStoreVersion | 相互 TLS 認証に使用される信頼ストアのバージョンでアクセスをフィルタリングします。 UpdateDomainName および DeleteDomainName オペレーション中に使用可能 | 文字列 |
| apigateway:Resource/RouteAuthorizationType | Word、NONE、CUSTOM などの既存のルートリソースの認可タイプでアクセスをフィルタリング AWS_IAMします。 UpdateRoute および DeleteRoute オペレーション中に使用できます。再インポート時にコレクションとしても使用できます | ArrayOfString |
| apigateway:Resource/SecurityPolicy | TLS バージョンでアクセスをフィルタリングします。 UpdateDomainName および DeleteDomainName オペレーション中に使用可能 | ArrayOfString |
| aws:RequestTag/${TagKey} | リクエスト内のタグキーと値のペアが存在するかどうかでアクションをフィルタリングします | 文字列 |
| aws:ResourceTag/${TagKey} | リソースにアタッチされているタグキーおよび値のペアでアクセスをフィルタリングします | 文字列 |
| aws:TagKeys | リクエスト内のタグキーが存在するかどうかでアクセスをフィルタリングします | ArrayOfString |
