Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
AWS::Serverless::API
Erstellt eine Sammlung von Amazon API Gateway-Ressourcen und -Methoden, die über HTTPS-Endpunkte aufgerufen werden können.
Ein AWS::Serverless::API Ressource muss nicht explizit zu a hinzugefügt werden AWS Vorlage für eine serverlose Anwendungsdefinition. Eine Ressource dieses Typs wird implizit aus der Vereinigung von API-Ereignissen erstellt, die unter definiert sind AWS::Serverless::Funktion In der Vorlage definierte Ressourcen, die sich nicht auf eine beziehen AWS::Serverless::API Ressource.
Ein AWS::Serverless::API Ressource sollte verwendet werden, um die API zu definieren und zu dokumentieren mit OpenApi, das mehr Möglichkeiten zur Konfiguration der zugrunde liegenden Amazon API Gateway-Ressourcen bietet.
Wir empfehlen, dass Sie CloudFormation Hooks oder IAM-Richtlinien, um zu überprüfen, ob den API-Gateway-Ressourcen Autorisierer zugeordnet sind, die den Zugriff auf sie kontrollieren.
Für weitere Informationen zur Verwendung CloudFormation Haken, siehe Hooks registrieren in der CloudFormation CLI-Benutzerhandbuch und das apigw-enforce-authorizer
Weitere Informationen zur Verwendung von IAM-Richtlinien finden Sie unter Erfordern Sie, dass API-Routen autorisiert sind in der API Gateway-Entwicklerhandbuch.
Diese Ressource unterstützt auch die Connectors Ressource Attribute. Weitere Informationen finden Sie unter Verwaltung von Ressourcenberechtigungen mit AWS SAM Steckverbinder.
Wenn Sie bereitstellen AWS CloudFormation, AWS SAM transformiert deine AWS SAM Ressourcen in CloudFormation Ressourcen. Weitere Informationen finden Sie unter Generiert CloudFormation Ressourcen für AWS SAM.
Syntax
Um diese Entität in Ihrem zu deklarieren AWS Serverless Application Model (AWS SAM) Vorlage, verwenden Sie die folgende Syntax.
YAML
Type: AWS::Serverless::Api Properties: AccessLogSetting:AccessLogSettingAlwaysDeploy:BooleanApiKeySourceType:StringAuth:ApiAuthBinaryMediaTypes:ListCacheClusterEnabled:BooleanCacheClusterSize:StringCanarySetting:CanarySettingCors:String | CorsConfigurationDefinitionBody:JSONDefinitionUri:String | ApiDefinitionDescription:StringDisableExecuteApiEndpoint:BooleanDomain:DomainConfigurationEndpointAccessMode:StringEndpointConfiguration:EndpointConfigurationFailOnWarnings:BooleanGatewayResponses:MapMergeDefinitions:BooleanMethodSettings:MethodSettingsMinimumCompressionSize:IntegerMode:StringModels:MapName:StringOpenApiVersion:StringPropagateTags:BooleanPolicy:JSONSecurityPolicy:StringStageName:StringTags:MapTracingEnabled:BooleanVariables:Map
Eigenschaften
-
AccessLogSetting -
Konfiguriert die Zugriffsprotokoll-Einstellung für eine Stufe.
Typ: AccessLogSetting
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
AccessLogSettingEigentum einesAWS::ApiGateway::StageRessource. -
AlwaysDeploy -
Stellt die API immer bereit, auch wenn keine Änderungen an der API festgestellt wurden.
Typ: Boolesch
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
ApiKeySourceType -
Die Quelle des API-Schlüssels für Messungsanforderungen nach einem Nutzungsplan. Gültige Werte sind
HEADERundAUTHORIZER.Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
ApiKeySourceTypeEigentum einesAWS::ApiGateway::RestApiRessource. -
Auth -
Konfigurieren Sie die Autorisierung, um den Zugriff auf Ihre API Gateway-API zu kontrollieren.
Weitere Informationen zur Konfiguration des Zugriffs finden Sie mit AWS SAM sehen Steuern Sie den API-Zugriff mit Ihrem AWS SAM Vorlage. Ein Beispiel, das zeigt, wie man einen globalen Autorisierer außer Kraft setzt, finden Sie unter Überschreiben Sie einen globalen Autorisierer für Ihre Amazon API Gateway Gateway-REST-API.
Typ: ApiAuth
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
BinaryMediaTypes -
Liste der MIME-Typen, die Ihre API zurückgeben könnte. Verwenden Sie diese Option, um die Binärunterstützung für APIs zu aktivieren.
Typ: Liste
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
BinaryMediaTypesEigentum einesAWS::ApiGateway::RestApiRessource. Die Liste von BinaryMediaTypes wird zu beiden hinzugefügt CloudFormation Ressource und das OpenAPI-Dokument. -
CacheClusterEnabled -
Gibt an, ob das Caching für die Phase aktiviert ist. Um Antworten zwischenzuspeichern, müssen Sie außerdem Folgendes festlegen
CachingEnabledzutrueunterMethodSettings.Typ: Boolesch
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
CacheClusterEnabledEigentum einesAWS::ApiGateway::StageRessource. -
CacheClusterSize -
Die Cache-Cluster-Größe der Stufe.
Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
CacheClusterSizeEigentum einesAWS::ApiGateway::StageRessource. -
CanarySetting -
Konfigurieren Sie eine Canary-Einstellung so, dass sie einer regulären Bereitstellung entspricht.
Typ: CanarySetting
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
CanarySettingEigentum einesAWS::ApiGateway::StageRessource. -
Cors -
Managen Cross-origin Resource Sharing (CORS) für alle Ihre API Gateway-APIs. Geben Sie die Domain, die zugelassen werden soll, als Zeichenfolge an, oder geben Sie ein Wörterbuch mit zusätzlicher Cors-Konfiguration an.
AnmerkungCORS BENÖTIGT AWS SAM um Ihre OpenAPI-Definition zu ändern. Erstellen Sie eine Inline-OpenAPI-Definition in der
DefinitionBodyum CORS einzuschalten.Weitere Informationen zu CORS finden Sie unter Aktivieren Sie CORS für eine API Gateway-REST-API-Ressource in der API Gateway-Entwicklerhandbuch.
Typ: Zeichenfolge | CorsConfiguration
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
DefinitionBody -
OpenAPI-Spezifikation, die Ihre API beschreibt. Wenn keines
DefinitionUrinochDefinitionBodysind angegeben, SAM generiert eineDefinitionBodyfür Sie basierend auf Ihrer Vorlagenkonfiguration.Um auf ein Lokal zu verweisen OpenAPI Datei, die Ihre API definiert, verwenden Sie die
AWS::Includetransformieren. Weitere Informationen hierzu finden Sie unter Wie AWS SAM lädt lokale Dateien hoch.Type: JSON
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
BodyEigentum einesAWS::ApiGateway::RestApiRessource. Wenn bestimmte Eigenschaften bereitgestellt werden, können Inhalte in das eingefügt oder geändert werden DefinitionBody bevor er weitergeleitet wird an CloudFormation. Zu den Eigenschaften gehörenAuth,BinaryMediaTypes,Cors,GatewayResponses,Models, und einEventSourcevom Typ Api für ein entsprechendesAWS::Serverless::Function. -
DefinitionUri -
Amazon S3-Uri, lokaler Dateipfad oder Standortobjekt des OpenAPI-Dokuments, das die API definiert. Das Amazon S3-Objekt, auf das diese Eigenschaft verweist, muss eine gültige OpenAPI-Datei sein. Wenn keines
DefinitionUrinochDefinitionBodysind angegeben, SAM generiert eineDefinitionBodyfür Sie basierend auf Ihrer Vorlagenkonfiguration.Wenn ein lokaler Dateipfad angegeben wird, muss die Vorlage den Workflow durchlaufen, der Folgendes beinhaltet
sam deployodersam packageBefehl, damit die Definition richtig transformiert wird.Intrinsische Funktionen werden in externen Versionen nicht unterstützt OpenApi Dateien, auf die verwiesen wird
DefinitionUri. Benutze stattdessen dieDefinitionBodyEigentum mit dem Transform einbeziehen um ein zu importieren OpenApi Definition in die Vorlage.Geben Sie ein: Zeichenfolge | ApiDefinition
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
BodyS3LocationEigentum einesAWS::ApiGateway::RestApiRessource. Die verschachtelten Amazon S3-Eigenschaften sind unterschiedlich benannt. -
Description -
Eine Beschreibung der Api-Ressource.
Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
DescriptionEigentum einesAWS::ApiGateway::RestApiRessource. -
DisableExecuteApiEndpoint -
Gibt an, ob Clients Ihre API mithilfe des
execute-api-Standardendpunkts aufrufen können. Standardmäßig können Kunden Ihre API mit der Standardeinstellung aufrufenhttps://{api_id}.execute-api.{region}.amazonaws.com. Wenn Sie erzwingen möchten, dass Kunden einen benutzerdefinierten Domänennamen verwenden, um Ihre API aufzurufen, geben Sie aTrue.Typ: Boolesch
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
DisableExecuteApiEndpointEigentum einesAWS::ApiGateway::RestApiRessource. Es wird direkt an die weitergegebendisableExecuteApiEndpointEigentum einesx-amazon-apigateway-endpoint-configurationErweiterung, die dem hinzugefügt wirdBodyEigentum einesAWS::ApiGateway::RestApiRessource. -
Domain -
Konfiguriert eine benutzerdefinierte Domain für diese API Gateway-API.
Typ: DomainConfiguration
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
EndpointConfiguration -
Der Endpunkttyp einer REST-API.
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
EndpointConfigurationEigentum einesAWS::ApiGateway::RestApiRessource. Die verschachtelten Konfigurationseigenschaften sind unterschiedlich benannt. -
EndpointAccessMode -
Der Zugriffsmodus für den REST-API-Endpunkt. Erforderlich, wenn erweiterte Sicherheitsrichtlinien verwendet werden (solche mit dem Präfix
SecurityPolicy_).Zulässige Werte:
STRICToderBASIC.Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
EndpointAccessModeEigentum einesAWS::ApiGateway::RestApiRessource. -
FailOnWarnings -
Gibt an, ob die API-Erstellung rückgängig gemacht werden soll (
true) oder nicht (false), wenn eine Warnung auftritt. Der Standardwert istfalse.Typ: Boolesch
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
FailOnWarningsEigentum einesAWS::ApiGateway::RestApiRessource. -
GatewayResponses -
Konfiguriert Gateway-Antworten für eine API. Gateway-Antworten sind Antworten, die von API Gateway entweder direkt oder mithilfe von Lambda Authorizers zurückgegeben werden. Weitere Informationen finden Sie in der Dokumentation für Api-Gateway OpenApi Erweiterung für Gateway Responses.
Typ: Landkarte
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
MergeDefinitions -
AWS SAM generiert eine OpenAPI Spezifikation aus Ihrer API-Ereignisquelle. Spezifizieren
truehaben AWS SAM füge das in die Inline ein OpenAPI Spezifikation definiert in IhrerAWS::Serverless::ApiRessource. Spezifizierenfalsenicht zusammenführen.MergeDefinitionsbenötigt dieDefinitionBodyEigentum fürAWS::Serverless::Apimuss definiert werden.MergeDefinitionsist nicht kompatibel mitDefinitionUriEigentum fürAWS::Serverless::Api.Standardwert:
falseTyp: Boolesch
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
MethodSettings -
Konfiguriert alle Einstellungen für die API-Stufe, einschließlich Logging, Metrics, CacheTTL, Throttling.
Typ: Liste von MethodSetting
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
MethodSettingsEigentum einesAWS::ApiGateway::StageRessource. -
MinimumCompressionSize -
Erlauben Sie die Komprimierung von Antworttexten auf der Grundlage der vom Client Accept-Encoding Kopfzeile. Die Komprimierung wird ausgelöst, wenn die Textgröße der Antwort größer oder gleich Ihrem konfigurierten Schwellenwert ist. Der Schwellenwert für die maximale Körpergröße liegt bei 10 MB (10.485.760 Byte). - Die folgenden Komprimierungstypen werden unterstützt: gzip, deflate und identity.
Typ: Ganzzahl
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
MinimumCompressionSizeEigentum einesAWS::ApiGateway::RestApiRessource. -
Mode -
Diese Eigenschaft gilt nur, wenn Sie OpenAPI zur Definition Ihrer REST-API verwenden. Der
Modebestimmt, wie API Gateway mit Ressourcen-Updates umgeht. Weitere Informationen finden Sie unter Modus Eigentum des AWS::ApiGateway::RestApi Ressourcentyp.Zulässige Werte:
overwriteodermerge.Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
ModeEigentum einesAWS::ApiGateway::RestApiRessource. -
Models -
Die Schemas, die von Ihren API-Methoden verwendet werden sollen. Diese Schemas können mit JSON oder YAML beschrieben werden. Beispielmodelle finden Sie im Abschnitt Beispiele unten auf dieser Seite.
Typ: Landkarte
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
Name -
Ein Name für das API-Gateway RestApi Ressource
Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
NameEigentum einesAWS::ApiGateway::RestApiRessource. -
OpenApiVersion -
Version von OpenApi zu verwenden. Das kann entweder
2.0für die Swagger-Spezifikation oder eine der OpenApi 3.0-Versionen, wie3.0.1. Weitere Informationen zu OpenAPI finden Sie in der OpenAPI-Spezifikation. AnmerkungAWS SAM erstellt eine Stufe namens
Stagestandardmäßig. Wenn Sie diese Eigenschaft auf einen gültigen Wert setzen, wird die Erstellung der Bühne verhindertStage.Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
-
Geben Sie an, ob Tags aus dem übergeben werden sollen
TagsEigentum zu Ihrem AWS::Serverless::Api generierte Ressourcen. SpezifizierenTrueum Tags in Ihren generierten Ressourcen zu verbreiten.Typ: Boolesch
Required: No
Standardwert:
FalseCloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.
Policy-
Ein Richtliniendokument, das die Berechtigungen für die API enthält. Um den ARN für die Richtlinie festzulegen, verwenden Sie die intrinsische
!Join-Funktion mit""als Trennzeichen und die Werte von"execute-api:/"und"*".Type: JSON
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben Richtlinie Eigentum eines
AWS::ApiGateway::RestApiRessource. -
SecurityPolicy -
Die TLS-Version plus Cipher Suite für die REST-API. Bei Verwendung erweiterter Sicherheitsrichtlinien (solche mit dem Präfix
SecurityPolicy>), müssen Sie auch das festlegenEndpointAccessMode.Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
SecurityPolicyEigentum einesAWS::ApiGateway::RestApiRessource. -
StageName -
Der Name der Phase, die API Gateway als erstes Pfadsegment im Aufruf-URI (Uniform Resource Identifier) verwendet.
Um auf die Stufenressource zu verweisen, verwenden Sie
. Weitere Informationen zum Referenzieren von Ressourcen, die generiert wurden, wenn ein AWS::Serverless::API Eine Ressource ist angegeben, siehe CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Api, wenn angegeben. Für allgemeine Informationen zu generierten CloudFormation Ressourcen finden Sie unter Generiert CloudFormation Ressourcen für AWS SAM.<api-logical-id>.StageTyp: Zeichenfolge
Erforderlich: Ja
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
StageNameEigentum einesAWS::ApiGateway::StageRessource. Sie ist in SAM erforderlich, in API Gateway jedoch nicht erforderlichZusätzliche Hinweise: Die Implicit API hat den Künstlernamen „Prod“.
-
Eine Map (von Zeichenfolge zu Zeichenfolge), die die Tags angibt, die diesem API Gateway-Schritt hinzugefügt werden sollen. Einzelheiten zu gültigen Schlüsseln und Werten für Tags finden Sie unter Ressourcen-Tag in der AWS CloudFormation Benutzerleitfaden.
Typ: Landkarte
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der
TagsEigentum einesAWS::ApiGateway::StageRessource. Die Tags-Eigenschaft in SAM besteht aus Key:Value Paare; in CloudFormation es besteht aus einer Liste von Tag-Objekten. -
TracingEnabled -
Gibt an, ob das aktive Tracing mit X-Ray ist für die Phase aktiviert. Für weitere Informationen über X-Ray, siehe Rückverfolgung von Benutzeranfragen an REST-APIs mit X-Ray in der API Gateway-Entwicklerhandbuch.
Typ: Boolesch
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
TracingEnabledEigentum einesAWS::ApiGateway::StageRessource. -
Variables -
Eine Map (von Zeichenfolge zu Zeichenfolge), die die Stufenvariablen definiert, wobei der Variablenname der Schlüssel und der Variablenwert der Wert ist. Variablennamen sind auf alphanumerische Zeichen beschränkt. Werte müssen dem folgenden regulären Ausdruck entsprechen:
[A-Za-z0-9._~:/?#&=,-]+.Typ: Landkarte
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben
VariablesEigentum einesAWS::ApiGateway::StageRessource.
Rückgabewerte
Punkt
Wenn die logische ID dieser Ressource dem bereitgestellt wird Ref Intrinsische Funktion, sie gibt die ID der zugrunde liegenden API-Gateway-API zurück.
Weitere Informationen zur Verwendung der Ref Funktion, siehe Ref in der AWS CloudFormation Benutzerleitfaden.
Fn::GetAtt
Fn::GetAtt gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte.
Für weitere Informationen zur Verwendung Fn::GetAtt, siehe Fn::GetAtt in der AWS CloudFormation Benutzerleitfaden.
RootResourceId-
Die Stamm-Ressourcen-ID für eine
RestApi-Ressource, z. B.a0bc123d4e.
Beispiele
SimpleApiExample
Ein Hallo Welt AWS SAM Vorlagendatei, die eine Lambda-Event-Funktion mit einem API-Endpunkt enthält. Das ist eine vollständige AWS SAM Vorlagendatei für eine funktionierende serverlose Anwendung.
YAML
AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Description: AWS SAM template with a simple API definition Resources: ApiGatewayApi: Type: AWS::Serverless::Api Properties: StageName: prod ApiFunction: # Adds a GET method at the root resource via an Api event Type: AWS::Serverless::Function Properties: Events: ApiEvent: Type: Api Properties: Path: / Method: get RestApiId: Ref: ApiGatewayApi Runtime: python3.10 Handler: index.handler InlineCode: | def handler(event, context): return {'body': 'Hello World!', 'statusCode': 200}
ApiCorsExample
Ein AWS SAM Vorlagenausschnitt mit einer API, die in einer externen Swagger-Datei zusammen mit Lambda-Integrationen und CORS-Konfigurationen definiert ist. Dies ist nur ein Teil eines AWS SAM Vorlagendatei mit einer AWS::Serverless::API Definition.
YAML
Resources: ApiGatewayApi: Type: AWS::Serverless::Api Properties: StageName: Prod # Allows www.example.com to call these APIs # SAM will automatically add AllowMethods with a list of methods for this API Cors: "'www.example.com'" DefinitionBody: # Pull in an OpenApi definition from S3 'Fn::Transform': Name: 'AWS::Include' # Replace "bucket" with your bucket name Parameters: Location: s3://bucket/swagger.yaml
ApiCognitoAuthExample
Ein AWS SAM Vorlagenausschnitt mit einer API, die Amazon Cognito verwendet, um Anfragen an die API zu autorisieren. Dies ist nur ein Teil eines AWS SAM Vorlagendatei mit einer AWS::Serverless::API Definition.
YAML
Resources: ApiGatewayApi: Type: AWS::Serverless::Api Properties: StageName: Prod Cors: "'*'" Auth: DefaultAuthorizer: MyCognitoAuthorizer Authorizers: MyCognitoAuthorizer: UserPoolArn: Fn::GetAtt: [MyCognitoUserPool, Arn]
ApiModelsExample
Ein AWS SAM Vorlagenausschnitt mit einer API, die ein Models-Schema enthält. Dies ist nur ein Teil eines AWS SAM Vorlagendatei, die eine zeigt AWS::Serverless::API Definition mit zwei Modellschemas.
YAML
Resources: ApiGatewayApi: Type: AWS::Serverless::Api Properties: StageName: Prod Models: User: type: object required: - username - employee_id properties: username: type: string employee_id: type: integer department: type: string Item: type: object properties: count: type: integer category: type: string price: type: integer
Beispiel für Caching
Ein Hallo Welt AWS SAM Vorlagendatei, die eine Lambda-Funktion mit einem API-Endpunkt enthält. In der API ist das Caching für eine Ressource und eine Methode aktiviert. Weitere Informationen zum Caching finden Sie unter Aktivierung des API-Cachings zur Verbesserung der Reaktionsfähigkeit in der API Gateway-Entwicklerhandbuch.
YAML
AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Description: AWS SAM template with a simple API definition with caching turned on Resources: ApiGatewayApi: Type: AWS::Serverless::Api Properties: StageName: prod CacheClusterEnabled: true CacheClusterSize: '0.5' MethodSettings: - ResourcePath: / HttpMethod: GET CachingEnabled: true CacheTtlInSeconds: 300 Tags: CacheMethods: All ApiFunction: # Adds a GET method at the root resource via an Api event Type: AWS::Serverless::Function Properties: Events: ApiEvent: Type: Api Properties: Path: / Method: get RestApiId: Ref: ApiGatewayApi Runtime: python3.10 Handler: index.handler InlineCode: | def handler(event, context): return {'body': 'Hello World!', 'statusCode': 200}
Beispiel für eine benutzerdefinierte Domain mit einer privaten API
Ein Hallo Welt AWS SAM Vorlagendatei, die eine Lambda-Funktion mit einem API-Endpunkt enthält, der einer privaten Domain zugeordnet ist. Die Vorlage erstellt eine Domänenzugriffszuordnung zwischen einem VPC-Endpunkt und der privaten Domain. Weitere Informationen finden Sie unter Benutzerdefinierte Domainnamen für private APIs in API Gateway.
YAML
AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Description: AWS SAM template configured with a custom domain using a private API Parameters: DomainName: Type: String Default: mydomain.example.com CertificateArn: Type: String HostedZoneId: Type: String VpcEndpointId: Type: String VpcEndpointDomainName: Type: String VpcEndpointHostedZoneId: Type: String Resources: MyFunction: Type: AWS::Serverless::Function Properties: InlineCode: | def handler(event, context): return {'body': 'Hello World!', 'statusCode': 200} Handler: index.handler Runtime: python3.13 Events: Fetch: Type: Api Properties: RestApiId: Ref: MyApi Method: Get Path: /get MyApi: Type: AWS::Serverless::Api Properties: StageName: Prod EndpointConfiguration: Type: PRIVATE VPCEndpointIds: - !Ref VpcEndpointId Policy: Version: '2012-10-17' Statement: - Effect: Allow Principal: '*' Action: execute-api:Invoke Resource: execute-api:/* - Effect: Deny Principal: '*' Action: execute-api:Invoke Resource: execute-api:/* Condition: StringNotEquals: aws:SourceVpce: !Ref VpcEndpointId Domain: DomainName: !Ref DomainName CertificateArn: !Ref CertificateArn EndpointConfiguration: PRIVATE BasePath: - / Route53: HostedZoneId: !Ref HostedZoneId VpcEndpointDomainName: !Ref VpcEndpointDomainName VpcEndpointHostedZoneId: !Ref VpcEndpointHostedZoneId AccessAssociation: VpcEndpointId: !Ref VpcEndpointId Policy: Version: '2012-10-17' Statement: - Effect: Allow Principal: '*' Action: execute-api:Invoke Resource: execute-api:/* - Effect: Deny Principal: '*' Action: execute-api:Invoke Resource: execute-api:/* Condition: StringNotEquals: aws:SourceVpce: !Ref VpcEndpointId