Esegui la migrazione di un nome di dominio personalizzato a un tipo di API endpoint diverso in Gateway API

Puoi eseguire la migrazione di un nome di dominio personalizzato tra endpoint ottimizzati per edge ed endpoint regionali. Aggiungi prima di tutto il nuovo tipo di configurazione dell'endpoint all'elenco endpointConfiguration.types esistente per il nome di dominio personalizzato. Successivamente, si configura un DNS record per indirizzare il nome di dominio personalizzato all'endpoint appena fornito. Infine, rimuovi i dati obsoleti di configurazione del nome di dominio personalizzato.

Considerazioni

Di seguito sono riportate alcune considerazioni sulla migrazione del dominio personalizzato tra un endpoint regionale e un API endpoint ottimizzato per i dispositivi periferici. API

• Un nome di dominio personalizzato ottimizzato per i dispositivi edge richiede un certificato fornito ACM dalla regione Stati Uniti orientali (Virginia settentrionale). us-east-1 Questo certificato è distribuito un tutte le posizioni geografiche.

• Un nome di dominio personalizzato regionale richiede un certificato fornito dalla stessa ACM regione che ospita il. API È possibile migrare un nome di dominio personalizzato ottimizzato per i dispositivi periferici che non si trova nella us-east-1 regione verso un nome di dominio personalizzato regionale richiedendo un nuovo ACM certificato dalla regione locale a. API

• Potrebbero essere necessari fino a 60 secondi per completare una migrazione tra un nome di dominio personalizzato ottimizzato per i dispositivi periferici e un nome di dominio personalizzato regionale. Il tempo di migrazione dipende anche da quando si aggiornano i record. DNS

Esegui la migrazione di nomi di dominio personalizzati

La procedura seguente mostra come migrare un nome di dominio personalizzato ottimizzato per i dispositivi perimetrali verso un nome di dominio personalizzato regionale.

AWS Management Console

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Nel riquadro di navigazione principale, scegli Nomi di dominio personalizzati.

3. Scegli un nome di dominio personalizzato ottimizzato per i dispositivi periferici.

4. Nella scheda Configurazioni, per la configurazione degli endpoint, scegli Modifica.

5. Scegli Aggiungi endpoint regionale.

6. Per il ACMcertificato, scegli un certificato.

   Il certificato regionale deve essere della stessa regione del regionaleAPI.

7. Selezionare Salva.

8. Imposta un DNS record per indirizzare il nome di dominio personalizzato regionale a questo nome host regionale. Per ulteriori informazioni, vedere Configurazione di Route 53 per instradare il traffico verso API il Gateway.

9. Dopo aver confermato che la DNS configurazione utilizza l'endpoint corretto, elimini la configurazione dell'endpoint ottimizzata per i bordi. Scegli il tuo nome di dominio personalizzato e, per la configurazione degli endpoint (ottimizzata per i bordi), scegli Elimina.

10. Conferma la tua scelta ed elimina l'endpoint.

AWS CLI

Il update-domain-namecomando seguente mostra come migrare il nome di dominio personalizzato a un nome di dominio personalizzato regionale:

aws apigateway update-domain-name \
    --domain-name 'api.example.com' \
    --patch-operations  '[ 
        { "op":"add", "path": "/endpointConfiguration/types","value": "REGIONAL" },
        { "op":"add", "path": "/regionalCertificateArn", "value": "arn:aws:acm:us-west-2:123456789012:certificate/cd833b28-58d2-407e-83e9-dce3fd852149" }
      ]'

Il certificato regionale deve appartenere alla stessa regione del certificato regionaleAPI.

La risposta in caso di esito positivo ha il codice di stato 200 OK e un corpo simile al seguente:

{
    "certificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
    "certificateName": "edge-cert",
    "certificateUploadDate": "2017-10-16T23:22:57Z",
    "distributionDomainName": "d1frvgze7vy1bf.cloudfront.net",
    "domainName": "api.example.com",
    "endpointConfiguration": {
        "types": [
            "EDGE",
            "REGIONAL"
        ]
    },
    "regionalCertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/cd833b28-58d2-407e-83e9-dce3fd852149",
    "regionalDomainName": "d-fdisjghyn6.execute-api.us-west-2.amazonaws.com"
}

Per il nome di dominio personalizzato regionale migrato, la regionalDomainName proprietà risultante restituisce il nome API host regionale. È necessario impostare un DNS record per indirizzare il nome di dominio personalizzato regionale a questo nome host regionale. Questo consente al traffico destinato al nome di dominio personalizzato di essere instradato all'host regionale.

Dopo aver impostato il DNS record, puoi rimuovere il nome di dominio personalizzato ottimizzato per Edge. Il update-domain-namecomando seguente mostra come rimuovere il nome di dominio personalizzato ottimizzato per i bordi.

aws apigateway update-domain-name \
    --domain-name api.example.com \
    --patch-operations '[
            {"op":"remove", "path":"/endpointConfiguration/types", "value":"EDGE"},
            {"op":"remove", "path":"certificateName"},
            {"op":"remove", "path":"certificateArn"}
        ]'

La procedura seguente mostra come migrare un nome di dominio personalizzato regionale verso un nome di dominio personalizzato ottimizzato per i dispositivi periferici.

AWS Management Console

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Nel riquadro di navigazione principale, scegli Nomi di dominio personalizzati.

3. Scegli un nome di dominio personalizzato ottimizzato per i dispositivi periferici.

4. Nella scheda Configurazioni, per la configurazione degli endpoint, scegli Modifica.

5. Scegli Aggiungi endpoint ottimizzato per i bordi.

6. Per il ACMcertificato, scegli un certificato.

   Il certificato di dominio ottimizzato per edge deve essere creato nella regione us-east-1.

7. Selezionare Salva.

8. Configura un DNS record per indirizzare il nome di dominio personalizzato ottimizzato per i bordi verso questo nome host ottimizzato per i bordi. Per ulteriori informazioni, consulta la sezione Configurazione di Route 53 per indirizzare il traffico verso Gateway. API

9. Dopo aver confermato che la DNS configurazione utilizza l'endpoint corretto, elimini la configurazione regionale dell'endpoint. Scegli il tuo nome di dominio personalizzato e, per la configurazione dell'endpoint (regionale), scegli Elimina.

10. Conferma la tua scelta ed elimina l'endpoint.

AWS CLI

Il update-domain-namecomando seguente mostra come migrare il nome di dominio personalizzato verso un nome di dominio personalizzato ottimizzato per l'edge:

aws apigateway update-domain-name \
    --domain-name 'api.example.com' \
    --patch-operations  '[ 
        { "op":"add", "path": "/endpointConfiguration/types","value": "EDGE" },
        { "op":"add", "path": "/certificateName", "value": "edge-cert" },
	{"op":"add", "path": "/certificateArn", "value": "arn:aws:acm:us-east-1:738575810317:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a"}
      ]'

Il certificato di dominio ottimizzato per edge deve essere creato nella regione us-east-1.

La risposta in caso di esito positivo ha il codice di stato 200 OK e un corpo simile al seguente:

{
    "certificateArn": "arn:aws:acm:us-east-1:738575810317:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
    "certificateName": "edge-cert",
    "certificateUploadDate": "2017-10-16T23:22:57Z",
    "distributionDomainName": "d1frvgze7vy1bf.cloudfront.net",
    "domainName": "api.example.com",
    "endpointConfiguration": {
        "types": [
            "EDGE",
            "REGIONAL"
        ]
    },
    "regionalCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/3d881b54-851a-478a-a887-f6502760461d",
    "regionalDomainName": "d-cgkq2qwgzf.execute-api.us-east-1.amazonaws.com"
}

Per il nome di dominio personalizzato specificato, API Gateway restituisce il nome host ottimizzato per i bordi come valore della proprietàAPI. distributionDomainName È necessario impostare un DNS record per indirizzare il nome di dominio personalizzato ottimizzato per i bordi verso questo nome di dominio di distribuzione. Ciò consente al traffico associato al nome di dominio personalizzato ottimizzato per i bordi di essere indirizzato al nome host ottimizzato per i bordi. API

Dopo aver impostato il DNS record, puoi rimuovere il tipo di endpoint del REGION nome di dominio personalizzato. Il update-domain-namecomando seguente mostra come rimuovere il tipo di endpoint regionale:

aws apigateway update-domain-name \
    --domain-name api.example.com \
    --patch-operations '[
        {"op":"remove", "path":"/endpointConfiguration/types", value:"REGIONAL"},
        {"op":"remove", "path":"regionalCertificateArn"}
      ]'

Il risultato di questo comando è simile all'output seguente, con solo i dati di configurazione del nome di dominio ottimizzato per i confini:

{
    "certificateArn": "arn:aws:acm:us-east-1:738575810317:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
    "certificateName": "edge-cert",
    "certificateUploadDate": "2017-10-16T23:22:57Z",
    "distributionDomainName": "d1frvgze7vy1bf.cloudfront.net",
    "domainName": "regional.haymuto.com",
    "endpointConfiguration": {
        "types": "EDGE"
    }
}