Terraform 0.11

aws_api_gateway_documentation_part




terraform

aws_api_gateway_documentation_part

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

उदाहरण उपयोग

resource "aws_api_gateway_documentation_part" "example" {
  location {
    type = "METHOD"
    method = "GET"
    path = "/example"
  }
  properties = "{\"description\":\"Example description\"}"
  rest_api_id = "${aws_api_gateway_rest_api.example.id}"
}

resource "aws_api_gateway_rest_api" "example" {
  name = "example_api"
}

तर्क संदर्भ

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

  • location - (आवश्यक) दस्तावेज़ बनाए जाने वाले हिस्से के लक्षित एपीआई इकाई का स्थान। निचे देखो।
  • properties - (आवश्यक) लक्षित एपीआई इकाई का वर्णन एपीआई-विशिष्ट कुंजी-मूल्य जोड़े की एक सामग्री का नक्शा। मानचित्र को JSON स्ट्रिंग के रूप में एन्कोड किया जाना चाहिए, उदाहरण के लिए, "{\" विवरण \ ": \" एपीआई करता है ... \ "}"। केवल स्वैगर-अनुरूप कुंजी-मूल्य जोड़े निर्यात किए जा सकते हैं और इसलिए, प्रकाशित किए जाते हैं।
  • rest_api_id - (आवश्यक) संबद्ध रेस्ट एपीआई की आईडी

खेतों की मेड़

location

आधिकारिक डॉक्स में प्रत्येक क्षेत्र के लिए समर्थित निकाय प्रकार देखें।

  • method - (वैकल्पिक) एक विधि की HTTP क्रिया। किसी भी विधि के लिए डिफ़ॉल्ट मान *
  • name - (वैकल्पिक) लक्षित एपीआई इकाई का नाम।
  • path - (वैकल्पिक) लक्ष्य का URL पथ। रूट संसाधन के लिए डिफ़ॉल्ट मान /
  • status_code - (वैकल्पिक) प्रतिक्रिया की HTTP स्थिति कोड। किसी भी स्थिति कोड के लिए डिफ़ॉल्ट मान *
  • type - (आवश्यक) एपीआई इकाई का वह प्रकार जिस पर प्रलेखन सामग्री लागू होती है। उदाहरण के लिए API , METHOD या REQUEST_BODY

गुण का संदर्भ

निम्नलिखित विशेषता ऊपर सूचीबद्ध तर्कों के अतिरिक्त निर्यात की जाती है:

  • id - डॉक्यूमेंटेशन पार्ट की यूनिक आईडी

आयात

API गेटवे REST-API-ID/DOC-PART-ID , जैसे का उपयोग करके आयात किया जा सकता है

$ terraform import aws_api_gateway_documentation_part.example 5i4e1ko720/3oyy3t