Como resolver problemas com propriedades somente gravação em recursos AWS::ApiGateway::RestAPI - AWS CloudFormation

Como resolver problemas com propriedades somente gravação em recursos AWS::ApiGateway::RestAPI

Este tópico explica como resolver problemas com propriedades somente gravação em recursos AWS::ApiGateway::RestApi ao usar o gerador de IaC.

Problema

Quando um modelo gerado contém recursos AWS::ApiGateway::RestApi, avisos são gerados para informar que as propriedades Body, BodyS3Location e CloneFrom são identificadas como UNSUPPORTED_PROPERTIES. Isso ocorre porque essas são propriedades opcionais somente gravação. O gerador de IaC não sabe se essas propriedades já foram aplicadas ao recurso. Portanto, ele omite essas propriedades no modelo gerado.

Resolução

Para definir a propriedade Body da API REST, atualize o modelo gerado.

  1. Use a ação de API GetExport do Amazon API Gateway para baixar a API. Por exemplo, usando o comando aws apigateway get-export da AWS CLI. Para obter mais informações, consulte Exportar uma API REST do API Gateway no Guia do desenvolvedor do API Gateway.

  2. Recupere a Body propriedade da resposta da ação da API GetExport. Carregue-a para um bucket do Amazon S3.

  3. Baixe o modelo gerado.

  4. Adicione as propriedades BodyS3Location/Bucket e BodyS3Location/Key ao modelo, especificando o nome do bucket e a chave em que Body está armazenado.

  5. Abra o modelo gerado no console do gerador de IaC e escolha Importar modelo editado.