As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

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


 Todas as classes estão em desenvolvimento ativo e estão sujeitas a alterações ou remoção não compatíveis com versões anteriores em qualquer versão futura. Estes não estão sujeitos à[Controle de versão semântica](https://semver.org/)Modelo. Isso significa que, embora você possa usá-los, você pode precisar atualizar seu código-fonte ao atualizar para uma versão mais recente deste pacote. 

**Observações:** Para garantir a funcionalidade adequada, os pacotes AWS Solutions Constructs e os pacotes CDK da AWS em seu projeto devem ser da mesma versão. 


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

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

 Este AWS Solutions Construct implementa uma API REST do Amazon API Gateway conectada a uma fila do Amazon SQS.

 Aqui está uma definição de padrão implantável mínima no 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* 
+  escopo[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) 

## Adereços de construção de padrão
<a name="pattern-construct-props-2"></a>


|  **Nome**  |  **Tipo**  |  **Descrição**  | 
| --- | --- | --- | 
|  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 opcionais fornecidos pelo usuário para substituir os adereços padrão para o API Gateway.  | 
|  QueueProps?  |  [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 opcionais fornecidos pelo usuário para substituir os adereços padrão da fila.  | 
|  Implementar DeadletterQueue?  |  boolean  |  Se uma fila secundária deve ser usada como uma dead letter queue. Padronizado como true.  | 
|  MaxReceiveCount  |  number  |  O número de vezes que uma mensagem pode ser desenfileirada sem sucesso antes de ser movida para a fila de mensagens mortas.  | 
|  AllowCreateOperation?  |  boolean  |  Se deve implantar um Método API Gateway para criar operações na fila (ou seja, SQS:SendMessage).  | 
|  CreateRequestTemplate?  |  string  |  Substitua o modelo de solicitação padrão do API Gateway para o método Criar, seallowCreateOperationé definido comotrue. | 
|  AllowReadOperation?  |  boolean  |  Se deve implantar um Método API Gateway para operações de leitura na fila (ou seja, SQS:ReceiveMessage).  | 
|  ReadRequestTemplate?  |  string  |  Substitua o modelo de solicitação padrão do API Gateway para o método de leitura, seallowReadOperationé definido comotrue. | 
|  AllowDeleteOperation?  |  boolean  |  Se deve implantar um Método API Gateway para operações Excluir na fila (por exemplo, SQS:DeleteMessage).  | 
|  DeleteRequestTemplate?  |  string  |  Substitua o modelo de solicitação padrão do API Gateway para o método Delete, seallowDeleteOperationé definido comotrue. | 
|  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)  |  Props opcionais fornecidos pelo usuário para substituir os adereços padrão do grupo de logs do CloudWatch Logs.  | 

## Propriedades de padrão
<a name="pattern-properties-2"></a>


|  **Nome**  |  **Tipo**  |  **Descrição**  | 
| --- | --- | --- | 
|  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)  |  Retorna uma instância da API REST Gateway criada pelo padrão.  | 
|  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)  |  Retorna uma instância da função do IAM criada pelo padrão que permite o log de acesso da API REST do API Gateway para o 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)  |  Retorna uma instância do grupo de logs criado pelo padrão para o qual os logs de acesso à API REST do API Gateway são enviados.  | 
|  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)  |  Retorna uma instância da função do IAM criada pelo padrão para a API REST do 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)  |  Retorna uma instância da fila de letras mortas criada pelo padrão, se uma for implantada.  | 
|  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)  |  Retorna uma instância da fila SQS criada pelo padrão.  | 

## Uso da API de amostra
<a name="sample-api-usage"></a>


|  **Método**  |  **Caminho da solicitação**  |  **Corpo da solicitação**  |  **Ação da Fila**  |  **Descrição**  | 
| --- | --- | --- | --- | --- | 
|  GET  |  /  |   |  sqs::ReceiveMessage  |  Recupera uma mensagem da fila.  | 
|  POST  |  /  |  \$1 "data": "Hello World\$1" \$1  |  sqs::SendMessage  |  Entrega uma mensagem para a fila.  | 
|  DELETE  |  /message?receiptHandle=[value]  |   |  sqs::DeleteMessage  |  Exclui uma mensagem especificada da fila  | 

## Configurações padrão
<a name="default-settings-2"></a>

 A implementação imediata desse padrão sem substituições definirá os seguintes padrões:

### Amazon API Gateway
<a name="amazon-api-gateway-2"></a>
+  Implantar um endpoint de API otimizado para bordas 
+  Habilitar o registro do CloudWatch para o 
+  Configurar a função IAM de acesso de menor privilégio para API Gateway 
+  Defina o AuthorizationType padrão para todos os métodos de API como IAM 
+  Habilitar rastreamento do X-Ray

### Fila do Amazon SQS
<a name="amazon-sqs-queue"></a>
+  Implantar fila de mensagens mortas do SQS para a fila do SQS de origem 
+  Habilitar a criptografia do lado do servidor para a fila do SQS de origem AWS a Chave do KMS 
+  Aplique a criptografia de dados em 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/pt_br/solutions/latest/constructs/images/aws-apigateway-sqs.png)


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


|  **Para exibir o código desse padrão, crie/exiba problemas e solicitações pull e muito mais:**  | 
| --- | 
|  ![\[Circular icon with a graduation cap symbol representing education or learning.\]](http://docs.aws.amazon.com/pt_br/solutions/latest/constructs/images/GitHub-Mark-32px.png)  |  [@aws -solutions-constructs/aws-apigateway-sqs](https://github.com/awslabs/aws-solutions-constructs/tree/master/source/patterns/%40aws-solutions-constructs/aws-apigateway-sqs)  |