Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# aws-apigateway-sqs
<a name="aws-apigateway-sqs"></a>

![\[alt text not found\]](http://docs.aws.amazon.com/es_es/solutions/latest/constructs/images/experimental.png)


 Todas las clases están en desarrollo activo y están sujetas a cambios o eliminación no compatibles con versiones anteriores en cualquier versión futura. Estos no están sujetos a la[Versiones semánticas](https://semver.org/)Modelo. Esto significa que, aunque puede usarlos, es posible que necesite actualizar el código fuente cuando actualice a una versión más reciente de este paquete. 

**Nota:** Para garantizar una funcionalidad adecuada, los paquetes de AWS Solutions Constructs y los paquetes CDK de AWS del proyecto deben tener la misma versión. 


|  **Idioma**  |  **Paquete**  | 
| --- | --- | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/es_es/solutions/latest/constructs/images/python.png) Python  |  aws\$1solutions\$1constructs.aws\$1apigateway\$1sqs  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/es_es/solutions/latest/constructs/images/typescript.png) Mecanografiado  |  @aws-solutions-constructs/aws-apigateway-sqs  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/es_es/solutions/latest/constructs/images/java.png) Java  |  software.amazon.awsconstructs.services.apigatewaysqs  | 

## Overview
<a name="overview-2"></a>

 Este constructo de soluciones de AWS implementa una API REST de Amazon API Gateway conectada a una cola de Amazon SQS.

 Aquí hay una definición mínima de patrón implementable en TypeScript:

```
import { ApiGatewayToSqs, ApiGatewayToSqsProps } from "@aws-solutions-constructs/aws-apigateway-sqs";

new ApiGatewayToSqs(this, 'ApiGatewayToSqsPattern', {});
```

## Initializer
<a name="initializer-2"></a>

```
new ApiGatewayToSqs(scope: Construct, id: string, props: ApiGatewayToSqsProps);
```

 *Parámetros* 
+  scope[https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html) 
+  id`string` 
+  props[`ApiGatewayToSqsProps`](#pattern-construct-props-2) 

## Patrón de construcción
<a name="pattern-construct-props-2"></a>


|  **Nombre**  |  **Tipo**  |  **Descripción**  | 
| --- | --- | --- | 
|  ¿ApigatewayProps?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html)  |  Props opcionales proporcionados por el usuario para anular los apoyos predeterminados para API Gateway.  | 
|  ¿Props en cola?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html)  |  Props opcionales proporcionados por el usuario para anular los apoyos predeterminados para la cola.  | 
|  DeployDeadLetterQueue?  |  boolean  |  Si se va a implementar una cola secundaria para utilizarse como cola de mensajes fallidos. El valor predeterminado es true.  | 
|  maxReceiveCount  |  number  |  El número de veces que un mensaje se puede quitar sin éxito antes de que se traslade a la cola de mensajes fallidos.  | 
|  AllowCreateOperation?  |  boolean  |  Si desea implementar un método de API Gateway para operaciones de creación en la cola (es decir, SQS:SendMessage).  | 
|  CreateRequestTemplate?  |  string  |  Anule la plantilla de solicitud de API Gateway predeterminada para el método Create, siallowCreateOperationtoma el valortrue. | 
|  AllowReadOperation?  |  boolean  |  Si desea implementar un método de API Gateway para operaciones de lectura en la cola (es decir, SQS:ReceiveMessage).  | 
|  ReadRequestTemplate?  |  string  |  Anule la plantilla de solicitud de API Gateway predeterminada para el método Read, siallowReadOperationtoma el valortrue. | 
|  AllowDeleteOperation?  |  boolean  |  Si desea implementar un método de API Gateway para operaciones de eliminación en la cola (es decir, SQS:DeleteMessage).  | 
|  ¿DeleteRequestTemplate?  |  string  |  Anule la plantilla de solicitud de API Gateway predeterminada para el método Delete, siallowDeleteOperationtoma el valortrue. | 
|  LogGroupProps?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)  |  Servicios opcionales proporcionados por el usuario para anular los accesorios predeterminados para el grupo de registros de CloudWatch Logs.  | 

## Propiedades de patrón
<a name="pattern-properties-2"></a>


|  **Nombre**  |  **Tipo**  |  **Descripción**  | 
| --- | --- | --- | 
|  ApiGateway  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html)  |  Devuelve una instancia de la API REST de API Gateway creada por el patrón.  | 
|  ApigatewayCloudWatchRole  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  Devuelve una instancia de la función de IAM creada por el patrón que permite el registro de acceso desde API Gateway REST API a CloudWatch.  | 
|  ApigatewayLogGroup  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html)  |  Devuelve una instancia del grupo de registros creado por el patrón al que se envían los registros de acceso de API REST de API de API Gateway de API.  | 
|  ApigateWayRole  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  Devuelve una instancia de la función de IAM creada por el patrón para la API Gateway.  | 
|  DeadLetterQueue?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  Devuelve una instancia de la cola de letras muertas creada por el patrón, si se implementa una.  | 
|  SQSqueue  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  Devuelve una instancia de la cola SQS creada por el patrón.  | 

## Ejemplo de uso de las API
<a name="sample-api-usage"></a>


|  **Método**  |  **Ruta de solicitud**  |  **Cuerpo de la solicitud**  |  **Acción de cola**  |  **Descripción**  | 
| --- | --- | --- | --- | --- | 
|  GET  |  /  |   |  sqs::ReceiveMessage  |  Recupera un mensaje de la cola.  | 
|  POST  |  /  |  \$1 "data": "Hello World\$1" \$1  |  sqs::SendMessage  |  Entrega un mensaje a la cola.  | 
|  ELIMINAR  |  /message?receiptHandle=[value]  |   |  sqs::DeleteMessage  |  Elimina un mensaje especificado de la cola  | 

## Configuración predeterminada
<a name="default-settings-2"></a>

 La implementación lista para usar de este patrón sin anulación establecerá los siguientes valores predeterminados:

### Amazon API Gateway
<a name="amazon-api-gateway-2"></a>
+  Implementación de un extremo de API optimizado para bordes 
+  Habilite el registro de CloudWatch para API Gateway 
+  Configurar el rol de IAM de acceso mínimo con privilegios para API Gateway 
+  Establezca el AuthorizationType predeterminado para todos los métodos API en IAM 
+  Habilite el X-Ray streo

### Cola de Amazon SQS
<a name="amazon-sqs-queue"></a>
+  Implementación de cola de mensajes fallidos de SQS para la cola de SQS de origen 
+  Habilite el cifrado en el lado de servidor para la cola de SQS de origen con la clave KMS administrada de AWS 
+  Aplicación del cifrado de los datos en tránsito 

## Architecture
<a name="architecture-2"></a>

![\[Diagram showing Amazon API Gateway, CloudWatch, and Simple Queue Service interactions with roles.\]](http://docs.aws.amazon.com/es_es/solutions/latest/constructs/images/aws-apigateway-sqs.png)


## GitHub
<a name="github-2"></a>


|  **Para ver el código de este patrón, crear/ver problemas y solicitudes de extracción, y mucho más:**  | 
| --- | 
|  ![\[Circular icon with a graduation cap symbol representing education or learning.\]](http://docs.aws.amazon.com/es_es/solutions/latest/constructs/images/GitHub-Mark-32px.png)  |  [@aws -soluciones-constructs/aws-apigateway-sqs](https://github.com/awslabs/aws-solutions-constructs/tree/master/source/patterns/%40aws-solutions-constructs/aws-apigateway-sqs)  |