View a markdown version of this page

AWSSupport-TroubleshootAPIGatewayCustomDomainConfig - AWS Systems Manager Referencia del manual de procedimientos de Automatización

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.

AWSSupport-TroubleshootAPIGatewayCustomDomainConfig

Descripción

El AWSSupport-TroubleshootAPIGatewayCustomDomainConfig manual le ayuda a identificar los problemas relacionados con la configuración de su nombre de dominio personalizado en Amazon API Gateway. El manual analiza los siguientes pasos de configuración:

  • Se crea un nombre de dominio personalizado en API Gateway.

  • Existe un mapeo entre el nombre de dominio personalizado y la API en cuestión.

  • Existe un registro DNS para el nombre de dominio personalizado que apunta al destino correcto.

importante

Este manual no admite la solución de problemas de mTLS con los nombres de dominio personalizados de API Gateway.

importante

Este manual solo permite solucionar problemas con nombres de dominio personalizados que se puedan resolver públicamente.

Ejecuta esta automatización (consola)

Tipo de documento

Automatización

Propietario

Amazon

Plataformas

/

Permisos de IAM necesarios

El parámetro AutomationAssumeRole requiere las siguientes acciones para utilizar el manual de procedimientos correctamente.

  • apigateway:GET

  • route53:ListResourceRecordSets

Política de IAM de ejemplo:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "apigateway:GET",
                "route53:ListResourceRecordSets"
            ],
            "Resource": "*"
        }
    ]
}
nota

El usuario o rol de IAM que inicia el runbook requiere las siguientes acciones:

  • iam:ListRoles

  • iam:PassRole

  • ssm:DescribeAutomationExecutions

  • ssm:DescribeAutomationStepExecutions

  • ssm:DescribeDocument

  • ssm:GetAutomationExecution

  • ssm:GetDocument

  • ssm:ListDocuments

  • ssm:StartAutomationExecution

Instrucciones

Siga estos pasos para configurar la automatización:

  1. Navegue hasta AWSSupport-TroubleshootAPIGatewayCustomDomainConfigSystems Manager, en Documentos.

  2. Elija Execute automation (Ejecutar automatización).

  3. Para los parámetros de entrada, introduzca lo siguiente:

    • AutomationAssumeRole (Opcional):

      El nombre del recurso de Amazon (ARN) de la función de IAM que permite a Systems Manager Automation realizar las acciones en su nombre. Si no se especifica ningún rol, Systems Manager Automation utiliza los permisos del usuario que comienza este manual de procedimientos.

    • DomainName (Obligatorio):

      El nombre de dominio personalizado creado para su API de Amazon API Gateway.

    • ApiId (Obligatorio):

      El ID de API de su API Gateway.

    • DNSServerIp (Opcional):

      Dirección IPv4 de un servidor DNS para resolver el nombre de dominio personalizado y el nombre de dominio de API Gateway. Si no se especifica ningún valor, se utilizará el servidor AWS DNS (169.254.169.253).

    • HostedZoneId (Opcional):

      El ID de zona alojada pública donde se crea el registro DNS para el nombre de dominio personalizado en Amazon Route 53. Si Route 53 no se usa para el DNS, el valor no es obligatorio.

  4. Seleccione Ejecutar.

  5. Se inicia la automatización.

  6. Este documento realiza los siguientes pasos:

    • CheckAPIExists:

      Comprueba la existencia de la API de Amazon API Gateway.

    • GetDomainName:

      Obtiene los detalles del nombre de dominio personalizado configurado en Amazon API Gateway.

    • GetMappings:

      Recupera todas las asignaciones de API de Amazon API Gateway configuradas para el nombre de dominio personalizado y verifica si el ID de API especificado tiene una asignación válida con las configuraciones de etapa y ruta correctas.

    • CheckDNSRecordExists:

      Comprueba el DNS del nombre de dominio personalizado y devuelve los registros asociados.

    • ValidateDNSResults:

      Compara los detalles de DNS (registros A o CNAME) del nombre de dominio personalizado para garantizar que el registro apunta al nombre de dominio de distribución de Amazon API Gateway correcto.

    • Results:

      Formatea el resultado general de Systems Manager Automation para devolver un resumen estructurado de los resultados del análisis de configuración de dominio personalizado a la consola de Systems Manager.

  7. Una vez finalizado, revise la sección de resultados para ver los resultados detallados de la ejecución.

Referencias

Automatización de Systems Manager