Terraform 0.11

aws_api_gateway_rest_api




terraform

aws_api_gateway_rest_api

एक एपीआई गेटवे रीस्ट एपीआई प्रदान करता है।

उदाहरण उपयोग

बुनियादी

resource "aws_api_gateway_rest_api" "MyDemoAPI" {
  name        = "MyDemoAPI"
  description = "This is my API for demonstration purposes"
}

क्षेत्रीय समापन बिंदु प्रकार

resource "aws_api_gateway_rest_api" "example" {
  name        = "regional-example"

  endpoint_configuration {
    types = ["REGIONAL"]
  }
}

तर्क संदर्भ

निम्नलिखित तर्क समर्थित हैं:

  • name - (आवश्यक) REST API का नाम
  • description - (वैकल्पिक) रीस्ट एपीआई का विवरण
  • endpoint_configuration - (वैकल्पिक) समापन बिंदु प्रकार सहित API समापन बिंदु कॉन्फ़िगरेशन को परिभाषित करने वाला नेस्टेड तर्क। नीचे परिभाषित किया गया।
  • binary_media_types - (वैकल्पिक) बाइनरी मीडिया प्रकार की सूची जो रेस्टापी द्वारा समर्थित है। डिफ़ॉल्ट रूप से, RestApi केवल UTF-8-एन्कोडेड पाठ पेलोड का समर्थन करता है।
  • minimum_compression_size - (वैकल्पिक) न्यूनतम एपीआई के लिए न्यूनतम प्रतिक्रिया आकार। -1 और 10485760 (10MB) के बीच पूर्णांक। -1 से अधिक मूल्य निर्धारित करने से संपीड़न सक्षम हो जाएगा, -1 संपीड़न (डिफ़ॉल्ट) को अक्षम करता है।
  • body - (वैकल्पिक) एक ओपनएपीआई विनिर्देश जो रूट एपीआई के हिस्से के रूप में बनाने के लिए मार्गों और एकीकरण के सेट को परिभाषित करता है।
  • policy - (वैकल्पिक) JSON प्रारूपित नीति दस्तावेज़ जो API गेटवे तक पहुँच को नियंत्रित करता है
  • api_key_source - (वैकल्पिक) अनुरोधों के लिए एपीआई कुंजी का स्रोत। मान्य मूल्य HEADER (डिफ़ॉल्ट) और AUTHORIZER हैं।

नोट : यदि body तर्क प्रदान किया जाता है, तो OpenAPI विनिर्देश का उपयोग रेस्ट एपीआई के लिए संसाधनों, विधियों और एकीकरण को कॉन्फ़िगर करने के लिए किया जाएगा। यदि यह तर्क प्रदान किया जाता है, तो निम्नलिखित संसाधनों को अलग-अलग लोगों के रूप में प्रबंधित नहीं किया जाना चाहिए, क्योंकि अपडेट के कारण मैन्युअल संसाधन अपडेट अधिलेखित हो सकते हैं:

endpoint_configuration

  • types - (आवश्यक) समापन बिंदु प्रकारों की एक सूची। यह संसाधन वर्तमान में केवल एकल मान के प्रबंधन का समर्थन करता है। मान्य मान: EDGE , REGIONAL या PRIVATE । यदि अनिर्दिष्ट, EDGE लिए चूक। गैर-वाणिज्यिक विभाजन में REGIONAL घोषित किया जाना चाहिए। किनारे से अनुकूलित और क्षेत्रीय एपीआई के बीच अंतर के बारे में अधिक जानकारी के लिए documentation देखें।

संदर्भ संदर्भित करता है

उपरोक्त सभी तर्कों के अलावा, निम्नलिखित विशेषताएँ निर्यात की जाती हैं:

  • id - बाकी एपीआई की आईडी
  • root_resource_id - REST API के रूट का संसाधन ID
  • created_date - REST API की निर्माण तिथि
  • lambda_permission - निष्पादन ARN भाग का उपयोग lambda_permission में किया जाता है, जब API गेटवे को एक लैम्ब्डा फंक्शन को शुरू करने की अनुमति देता है, जैसे arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j , जिसकी अनुमति मंच से दी जा सकती है। , विधि और संसाधन पथ।