Acciones, recursos y claves de condición para la administración de Amazon API Gateway V2
La administración de Amazon API Gateway V2 (prefijo de servicio: apigateway) proporciona los siguientes recursos, acciones y claves de contexto de condición específicos del servicio para usarse en las políticas de permisos de IAM.
Referencias:
-
Obtenga información para configurar este servicio.
-
Vea una lista de las operaciones de API disponibles para este servicio.
-
Obtenga información sobre cómo proteger este servicio y sus recursos mediante las políticas de permisos de IAM.
Temas
Acciones definidas por la administración de Amazon API Gateway V2
Puede especificar las siguientes acciones en el elemento Action de una declaración de política de IAM. Utilice políticas para conceder permisos para realizar una operación en AWS. Cuando utiliza una acción en una política, normalmente permite o deniega el acceso a la operación de la API o comandos de la CLI con el mismo nombre. No obstante, en algunos casos, una sola acción controla el acceso a más de una operación. Asimismo, algunas operaciones requieren varias acciones diferentes.
La columna Nivel de acceso de la tabla Acciones describe cómo se clasifica la acción (lista, lectura, administración de permisos o etiquetado). Esta clasificación puede ayudarle a entender el nivel de acceso que una acción concede cuando se utiliza en una política. Para obtener más información sobre los niveles de acceso, consulte Niveles de acceso en los resúmenes de políticas.
La columna Tipos de recurso de la tabla de Acción indica si cada acción admite permisos de nivel de recursos. Si no hay ningún valor para esta columna, debe especificar todos los recursos ("*") a los que aplica la política en el elemento Resource de la instrucción de su política. Si la columna incluye un tipo de recurso, puede especificar un ARN de ese tipo en una instrucción con dicha acción. Si la acción tiene uno o más recursos necesarios, la persona que llama debe tener permiso para usar la acción con esos recursos. Los recursos necesarios se indican en la tabla con un asterisco (*). Si limita el acceso a los recursos con el elemento Resource de una política de IAM, debe incluir un ARN o patrón para cada tipo de recurso requerido. Algunas acciones admiten varios tipos de recursos. Si el tipo de recurso es opcional (no se indica como obligatorio), puede elegir utilizar uno de los tipos de recursos opcionales.
La columna Claves de condición de la tabla Acciones incluye claves que puede especificar en el elemento Condition de la instrucción de una política. Para obtener más información sobre las claves de condición asociadas a los recursos del servicio, consulte la columna Claves de condición de la tabla Tipos de recursos.
La columna Acciones dependientes de la tabla Acciones muestra los permisos adicionales que pueden ser necesarios para llamar a una acción correctamente. Es posible que estos permisos sean necesarios además del permiso para la acción en sí. Cuando una acción especifica acciones dependientes, esas dependencias pueden aplicarse a los recursos adicionales definidos para esa acción, no solo al primer recurso de la tabla.
nota
Las claves de condición de recursos se enumeran en la tabla Tipos de recursos. Encontrará un enlace al tipo de recurso que se aplica a una acción en la columna Tipos de recursos (*obligatorio) de la tabla Acciones. El tipo de recurso de la tabla Tipos de recursos incluye la columna Claves de condición, que son las claves de condición del recurso que se aplican a una acción de la tabla Acciones.
Para obtener información detallada sobre las columnas de la siguiente tabla, consulte Tabla Acciones.
| Acciones | Descripción | Nivel de acceso | Tipos de recursos (*necesarios) | Claves de condición | Acciones dependientes |
|---|---|---|---|---|---|
| CreateRoutingRule | Concede permiso para crear una regla de enrutamiento. | Escritura | |||
| DELETE | Otorga permiso para eliminar un recurso determinado | Escritura | |||
| DeleteRoutingRule | Concede permiso para eliminar una regla de enrutamiento. | Escritura | |||
| GET | Otorga permiso para leer un recurso determinado | Lectura | |||
| GetRoutingRule | Concede permiso para leer una regla de enrutamiento. | Lectura | |||
| ListRoutingRules | Concede permiso para enumerar reglas de enrutamiento bajo un nombre de dominio. | Enumeración | |||
| PATCH | Otorga permiso para actualizar un recurso determinado | Write | |||
| POST | Otorga permiso para crear un recurso determinado | Write | |||
| PUT | Otorga permiso para actualizar un recurso determinado | Escritura | |||
| UpdateRoutingRule | Concede permiso para actualizar una regla de enrutamiento mediante la API PutRoutingRule. | Escritura | |||
Tipos de recursos definidos por la administración de Amazon API Gateway V2
Los siguientes tipos de recurso están definidos por este servicio y se pueden utilizar en el elemento Resource de las instrucciones de política de permisos de IAM. Cada acción de la tabla Acciones identifica los tipos de recursos que se pueden especificar con dicha acción. Un tipo de recurso también puede definir qué claves de condición se pueden incluir en una política. Estas claves se muestran en la última columna de la tabla Tipos de recursos. Para obtener información detallada sobre las columnas de la siguiente tabla, consulte Tabla Tipos de recurso.
| Tipos de recurso | ARN | Claves de condición |
|---|---|---|
| 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
|
Claves de condición para la administración de Amazon API Gateway V2
La administración de Amazon API Gateway V2 define las siguientes claves de condición que pueden utilizarse en el elemento Condition de una política de IAM. Puede utilizar estas claves para ajustar más las condiciones en las que se aplica la instrucción de política. Para obtener información detallada sobre las columnas de la siguiente tabla, consulte Tabla de Claves de condición.
A fin de ver las claves de condición globales que están disponibles para todos los servicios, consulte AWSClaves de contexto de condición globales.
| Claves de condición | Descripción | Tipo |
|---|---|---|
| apigateway:Request/AccessLoggingDestination | Filtra el acceso por destino del registro de acceso. Disponible durante las operaciones CreateStage y UpdateStage | Cadena |
| apigateway:Request/AccessLoggingFormat | Filtra el acceso por formato de registro de acceso. Disponible durante las operaciones CreateStage y UpdateStage | Cadena |
| apigateway:Request/ApiKeyRequired | Filtra el acceso por el requisito de la API. Disponible durante las operaciones CreateRoute y UpdateRoute. También disponible como colección durante la importación y reimportación | ArrayOfBool |
| apigateway:Request/ApiName | Filtra el acceso por nombre de API. Disponible durante las operaciones CreateApi y UpdateApi | Cadena |
| apigateway:Request/AuthorizerType | Filtra el acceso por tipo de autorizador en la solicitud; por ejemplo, REQUEST o JWT. Disponible durante CreateAuthorizer y UpdateAuthorizer. También disponible durante la importación y reimportación como ArrayOfString | ArrayOfString |
| apigateway:Request/AuthorizerUri | Filtra el acceso por URI de una función de autorización de Lambda. Disponible durante CreateAuthorizer y UpdateAuthorizer. También disponible durante la importación y reimportación como ArrayOfString | ArrayOfString |
| apigateway:Request/ConditionBasePaths | Filtra el acceso por rutas base definidas en función de una regla de enrutamiento. Disponible durante las operaciones CreateRoutingRule y UpdateRoutingRule. | ArrayOfString |
| apigateway:Request/DisableExecuteApiEndpoint | Filtra el acceso por estado del punto de enlace ejecute-api predeterminado. Disponible durante las operaciones CreateApi y UpdateApi | Bool |
| apigateway:Request/EndpointType | Filtra el acceso por tipo de punto de enlace. Disponible durante las operaciones CreateDomainName, UpdateDomainName, CreateApi y UpdateApi | ArrayOfString |
| apigateway:Request/MtlsTrustStoreUri | Filtra el acceso por URI del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante las operaciones CreateDomainName y UpdateDomainName | Cadena |
| apigateway:Request/MtlsTrustStoreVersion | Filtra el acceso por versión del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante las operaciones CreateDomainName y UpdateDomainName | Cadena |
| apigateway:Request/Priority | Filtra el acceso según la prioridad de la regla de enrutamiento. Disponible durante las operaciones CreateRoutingRule y UpdateRoutingRule. | Numérico |
| apigateway:Request/RouteAuthorizationType | Filtra el acceso por tipo de autorización; por ejemplo, NONE, AWS_IAM, CUSTOM, JWT. Disponible durante las operaciones CreateRoute y UpdateRoute. También disponible como colección durante la importación | ArrayOfString |
| apigateway:Request/RoutingMode | Filtra el acceso por modo de enrutamiento del nombre de dominio. Disponible durante las operaciones CreateDomainName y UpdateDomainName | Cadena |
| apigateway:Request/SecurityPolicy | Filtra el acceso por versión TLS. Disponible durante las operaciones CreateDomain y UpdateDomain | ArrayOfString |
| apigateway:Request/StageName | Filtra el acceso por nombre de etapa de la implementación que intenta crear. Disponible durante la operación CreateDeployment | Cadena |
| apigateway:Resource/AccessLoggingDestination | Filtra el acceso por destino del registro de acceso del recurso Stage actual. Disponible durante las operaciones UpdateStage y DeleteStage | Cadena |
| apigateway:Resource/AccessLoggingFormat | Filtra el acceso por formato del registro de acceso del recurso Stage actual. Disponible durante las operaciones UpdateStage y DeleteStage | Cadena |
| apigateway:Resource/ApiKeyRequired | Filtra el acceso por el requisito de clave de API para el recurso Route existente. Disponible durante las operaciones UpdateRoute y DeleteRoute. También disponible como colección durante la reimportación | ArrayOfBool |
| apigateway:Resource/ApiName | Filtra el acceso por nombre de API. Disponible durante las operaciones UpdateApi y DeleteApi | Cadena |
| apigateway:Resource/AuthorizerType | Filtra el acceso por el tipo actual de autorizador; por ejemplo, REQUEST o JWT. Disponible durante las operaciones UpdateAuthorizer y DeleteAuthorizer. También disponible durante la importación y reimportación como ArrayOfString | ArrayOfString |
| apigateway:Resource/AuthorizerUri | Filtra el acceso por el URI del autorizador de Lambda actual asociado a la API actual. Disponible durante UpdateAuthorizer y DeleteAuthorizer. También disponible como colección durante la reimportación | ArrayOfString |
| apigateway:Resource/ConditionBasePaths | Filtra el acceso por rutas base definidas en función de la regla de enrutamiento existente. Disponible durante las operaciones UpdateRoutingRule y DeleteRoutingRule. | ArrayOfString |
| apigateway:Resource/DisableExecuteApiEndpoint | Filtra el acceso por estado del punto de enlace ejecute-api predeterminado. Disponible durante las operaciones UpdateApi y DeleteApi | Bool |
| apigateway:Resource/EndpointType | Filtra el acceso por tipo de punto de enlace. Disponible durante las operaciones UpdateDomainName, DeleteDomainName, UpdateApi y DeleteApi | ArrayOfString |
| apigateway:Resource/MtlsTrustStoreUri | Filtra el acceso por URI del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante las operaciones UpdateDomainName y DeleteDomainName | Cadena |
| apigateway:Resource/MtlsTrustStoreVersion | Filtra el acceso por versión del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante las operaciones UpdateDomainName y DeleteDomainName | Cadena |
| apigateway:Resource/Priority | Filtra el acceso según la prioridad de la regla de enrutamiento existente. Disponible durante las operaciones UpdateRoutingRule y DeleteRoutingRule. | Numérico |
| apigateway:Resource/RouteAuthorizationType | Filtra el acceso por tipo de autorización del recurso Route existente; por ejemplo, NONE, AWS_IAM, CUSTOM. Disponible durante las operaciones UpdateRoute y DeleteRoute. También disponible como colección durante la reimportación | ArrayOfString |
| apigateway:Resource/RoutingMode | Filtra el acceso por modo de enrutamiento del nombre de dominio existente. Disponible durante las operaciones UpdateDomainName y DeleteDomainName | Cadena |
| apigateway:Resource/SecurityPolicy | Filtra el acceso por versión TLS. Disponible durante las operaciones UpdateDomainName y DeleteDomainName | ArrayOfString |
| aws:RequestTag/${TagKey} | Filtra el acceso según si hay pares de clave-valor de etiqueta en la solicitud. | Cadena |
| aws:ResourceTag/${TagKey} | Filtra el acceso por los pares de clave-valor de etiqueta adjuntados al recurso | Cadena |
| aws:TagKeys | Filtra el acceso en función de la presencia de claves de etiqueta en la solicitud | ArrayOfString |
