Wie richte ich Route 53 so ein, dass sie auf Api Gateway zeigt?

12

Ich schreibe eine Cloudformation-Konfigurationsdatei, um eine Website auf einmal zu erstellen. Dies umfasst das Erstellen von Lambda-Funktionen, das Erstellen des API-Gateways, das Einrichten eines S3-Buckets, das Erstellen der Route 53-Zone und Datensätze.

Bisher:

  • Erstellen von Lambda-Funktionen und ihrer Rolle (funktioniert)
  • Beim Erstellen von API Gateway wird die Bereitstellung und die Rolle (funktioniert)
  • Erstellen eines S3-Buckets und seiner Richtlinie (funktioniert)
  • Erstellen einer Route 53-Zone und von DNS-Einträgen für die Site (funktioniert)
  • Erstellen Sie eine Domain für API Gateway (keine Ahnung, was ich tue)

So domain.comwerden die Dateien im S3-Bucket problemlos bereitgestellt. Die Verwendung des AWS URI für API Gateway funktioniert https://trydsoonjc.execute-api.us-west-2.amazonaws.com/app/path/hereproblemlos.

Was ich einrichten möchte, ist ein api.domain.comVerweis auf das API-Gateway, um auf die API des Servers zuzugreifen.

Wie verbinde ich Route 53 mit API Gateway?

Meine derzeitige Cloudformation lautet wie folgt:

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description" : "Website",

  "Parameters": {
    "DomainName": {
      "Type" : "String",
      "Description" : "The DNS name of an Amazon Route 53 hosted zone e.g. server.com",
      "AllowedPattern" : "(?!-)[a-zA-Z0-9-.]{1,63}(?<!-)",
      "ConstraintDescription" : "must be a valid DNS zone name."
    }
  },

  "Mappings" : {
    "RegionMap" : {
      "us-east-1" : { "S3HostedZoneId" : "Z3AQBSTGFYJSTF", "S3WebsiteEndpoint" : "s3-website-us-east-1.amazonaws.com" },
      "us-west-1" : { "S3HostedZoneId" : "Z2F56UZL2M1ACD", "S3WebsiteEndpoint" : "s3-website-us-west-1.amazonaws.com" },
      "us-west-2" : { "S3HostedZoneId" : "Z3BJ6K6RIION7M", "S3WebsiteEndpoint" : "s3-website-us-west-2.amazonaws.com" },
      "eu-west-1" : { "S3HostedZoneId" : "Z1BKCTXD74EZPE", "S3WebsiteEndpoint" : "s3-website-eu-west-1.amazonaws.com" },
      "ap-southeast-1" : { "S3HostedZoneId" : "Z3O0J2DXBE1FTB", "S3WebsiteEndpoint" : "s3-website-ap-southeast-1.amazonaws.com" },
      "ap-southeast-2" : { "S3HostedZoneId" : "Z1WCIGYICN2BYD", "S3WebsiteEndpoint" : "s3-website-ap-southeast-2.amazonaws.com" },
      "ap-northeast-1" : { "S3HostedZoneId" : "Z2M4EHUR26P7ZW", "S3WebsiteEndpoint" : "s3-website-ap-northeast-1.amazonaws.com" },
      "sa-east-1" : { "S3HostedZoneId" : "Z31GFT0UA1I2HV", "S3WebsiteEndpoint" : "s3-website-sa-east-1.amazonaws.com" }
    }
  },

  "Resources": {
    "LambdaExecutionRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Statement": [{
            "Effect": "Allow",
            "Principal": {
              "Service": "lambda.amazonaws.com"
            },
            "Action": [ "sts:AssumeRole" ]
          }]
        },
        "Path": "/",
        "Policies": [{
          "PolicyName": "execution",
          "PolicyDocument": {
            "Statement": [{
              "Effect": "Allow",
              "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents"
              ],
              "Resource": "*"
            }, {
              "Effect": "Allow",
              "Action": [
                "dynamodb:BatchGetItem",
                "dynamodb:CreateTable",
                "dynamodb:DeleteItem",
                "dynamodb:DescribeTable",
                "dynamodb:GetItem",
                "dynamodb:PutItem",
                "dynamodb:Query",
                "dynamodb:Scan",
                "dynamodb:UpdateItem",
                "s3:GetObject",
                "s3:PutObject",
                "s3:ListBucket"
              ],
              "Resource": "*"
            }]
          }
        }]
      }
    },

    "APIGatewayExecutionRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Statement": [{
            "Effect": "Allow",
            "Principal": {
              "Service": "apigateway.amazonaws.com"
            },
            "Action": [ "sts:AssumeRole" ]
          }]
        },
        "Path": "/",
        "Policies": [{
          "PolicyName": "execution",
          "PolicyDocument": {
            "Statement": [{
              "Effect": "Allow",
              "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents"
              ],
              "Resource": "*"
            }, {
              "Effect": "Allow",
              "Action": [
                "lambda:InvokeFunction"
              ],
              "Resource": "*"
            }]
          }
        }]
      }
    },

    "LambdaFunctionUpdate": {
      "Type": "AWS::Lambda::Function",
      "Properties": {
        "Code": {
          "ZipFile": "exports.handler = function (event, context) { context.succeed(\"Hello, World!\"); };"
        },
        "Description": "Update handler.",
        "Handler": "index.handler",
        "MemorySize": 128,
        "Role": { "Fn::GetAtt": ["LambdaExecutionRole", "Arn" ] },
        "Runtime": "nodejs4.3",
        "Timeout": 30
      }
    },

    "APIGateway": {
      "Type": "AWS::ApiGateway::RestApi",
      "Properties": {
        "Body": @@swagger,
        "FailOnWarnings": true,
        "Name": "smallPictures",
        "Description": "Structured wiki"
      }
    },

    "APITDeploymentTest": {
      "Type": "AWS::ApiGateway::Deployment",
      "Properties": {
        "RestApiId": { "Ref": "APIGateway" },
        "Description": "Deploy for testing",
        "StageName": "smallPicturesTesting"
      }
    },

    "WebsiteBucket" : {
      "Type" : "AWS::S3::Bucket",
      "Properties" : {
        "BucketName": {"Ref":"DomainName"},
        "AccessControl" : "PublicRead",
        "WebsiteConfiguration" : {
          "IndexDocument" : "index.html",
          "ErrorDocument" : "404.html"
        }
      },
      "DeletionPolicy" : "Retain"
    },

    "WebsiteBucketPolicy" : {
      "Type" : "AWS::S3::BucketPolicy",
      "Properties" : {
        "Bucket" : {"Ref" : "WebsiteBucket"},
        "PolicyDocument": {
          "Statement": [{
              "Action": [ "s3:GetObject" ],
              "Effect": "Allow",
              "Resource": { "Fn::Join" : ["", ["arn:aws:s3:::", { "Ref" : "WebsiteBucket" } , "/*" ]]},
              "Principal": "*"
          }]
        }
      }
    },

    "DNS": {
      "Type": "AWS::Route53::HostedZone",
      "Properties": {
        "HostedZoneConfig": {
          "Comment": { "Fn::Join" : ["", ["Hosted zone for ", { "Ref" : "DomainName" } ]]}
        },
        "Name": { "Ref" : "DomainName" },
        "HostedZoneTags" : [{
          "Key": "Application",
          "Value": "Blog"
        }]
      }
    },

    "DNSRecord": {
      "Type": "AWS::Route53::RecordSetGroup",
      "Properties": {
        "HostedZoneName": {
            "Fn::Join": [ "", [ { "Ref": "DomainName" }, "." ]]
        },
        "Comment": "Zone records.",
        "RecordSets": [
          {
            "Name": { "Ref": "DomainName" },
            "Type": "A",
            "AliasTarget": {
              "HostedZoneId": { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "S3HostedZoneId" ]},
              "DNSName": { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "S3WebsiteEndpoint" ]}
            }
          }, {
            "Name": { "Fn::Join" : ["", ["www.", { "Ref" : "DomainName" }]]},
            "Type": "CNAME",
            "TTL" : "900",
            "ResourceRecords" : [
              {"Fn::GetAtt":["WebsiteBucket", "DomainName"]}
            ]
          }
        ]
      }
    }
  },

  "Outputs": {
    "WebsiteURL": {
      "Value": { "Fn::GetAtt": ["WebsiteBucket", "WebsiteURL" ] },
      "Description": "URL for website hosted on S3"
    }
  }
}
Justin808
quelle
4
Ein benutzerdefinierter Domänenname (Hostname) zeigt nicht direkt auf den API-Gateway-Endpunkt. Es wird auf die zugrunde liegende CloudFront-Distribution verwiesen, die von API Gateway erstellt / besessen / gesteuert wird, nachdem API Gateway so konfiguriert wurde, dass der benutzerdefinierte Domänenname erwartet / unterstützt wird. Dies ist komplexer als das einfache Erstellen eines Datensatzes in Route 53. Sie müssen die Option Benutzerdefinierten Domänennamen als API-Gateway-API-Hostnamen verwenden überprüfen, sofern Sie nicht bereits mit diesem Prozess vertraut sind.
Michael - sqlbot
2
Sie müssen im Rahmen der Konfiguration auch ein SSL-Zertifikat für Ihren benutzerdefinierten Hostnamen bereitstellen oder eines von Amazon Certificate Manager beziehen, da für API Gateway die Aktivierung von HTTPS erforderlich ist.
Michael - sqlbot

Antworten:

4

Sie müssen ein SSL-Zertifikat mit dem Zertifikat-Manager erstellen. Erstellen Sie einen Edge-Endpunkt in eu-east-1, für regionale und private Endpunkte in der Region, in der Sie das API-Gateway (oder das Lambda) bereitstellen. Lesen Sie hier mehr . Ich werde mich auf die ARN beziehen alsCertificateArn

Sie müssen Folgendes konfigurieren AWS::ApiGateway::DomainName:

"MyDomainName": {
  "Type": "AWS::ApiGateway::DomainName",
  "Properties": {
    "DomainName": {"Ref: "DomainName"},
    "CertificateArn": "arn:aws:acm:us-east-1:111122223333:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3"
  }
}

Dadurch wird die Domäne für das API-Gateway aktiviert. Als nächstes müssen Sie die API (dh Ihre RestAPI), in einer bestimmten Einsatz belichten Bühne . In Ihrer Vorlage gibt es keine Bereitstellungsphasen. Schau mal rein a AWS::ApiGateway::Stage. Ein minimales Beispiel würde so aussehen:

"Prod": {
            "Type": "AWS::ApiGateway::Stage",
            "Properties": {
                "StageName": "Prod",
                "Description": "Prod Stage",
                "RestApiId": {
                    "Ref": "APIGateway"
                },
                "DeploymentId": {
                    "Ref": "APITDeploymentTest"
                },
}

Sie möchten jedoch höchstwahrscheinlich eine zusätzliche Konfiguration. Ich schlage vor, Sie werfen einen Blick auf die MethodSettingsImmobilie.

Stellen Sie zum Schluss eine Basispfad-Zuordnungsressource bereit : AWS::ApiGateway::BasePathMapping. Ich schlage vor, Sie ordnen den Basispfad der Bühne zu, die Sie wie folgt erstellt haben:

"ProdDomainBasePath": {
  "Type" : "AWS::ApiGateway::BasePathMapping",
  "Properties" : {
    "DomainName" : {"Ref: "DomainName"},
    "RestApiId" : {"Ref": "APIGateway"},
    "Stage" : "Prod"
  }
}

Wenn Sie eine AWS::ApiGateway::StageRessource ändern , müssen Sie eine Aktualisierung der entsprechenden AWS::ApiGateway::DeploymentRessource erzwingen. Dies bedeutet normalerweise, dass Sie die AWS::ApiGateway::DeploymentRessource umbenennen , um dies zu berücksichtigen. Andernfalls wird es nicht bereitgestellt.

Das sollte es tun.

M. Glatki
quelle