Terraform 0.11

aws_api_gateway_usage_plan




terraform

aws_api_gateway_usage_plan

एक एपीआई गेटवे उपयोग योजना प्रदान करता है।

उदाहरण उपयोग

resource "aws_api_gateway_rest_api" "myapi" {
  name = "MyDemoAPI"
}

...

resource "aws_api_gateway_deployment" "dev" {
  rest_api_id = "${aws_api_gateway_rest_api.myapi.id}"
  stage_name = "dev"
}

resource "aws_api_gateway_deployment" "prod" {
  rest_api_id = "${aws_api_gateway_rest_api.myapi.id}"
  stage_name = "prod"
}

resource "aws_api_gateway_usage_plan" "MyUsagePlan" {
  name         = "my-usage-plan"
  description  = "my description"
  product_code = "MYCODE"

  api_stages {
    api_id = "${aws_api_gateway_rest_api.myapi.id}"
    stage  = "${aws_api_gateway_deployment.dev.stage_name}"
  }

  api_stages {
    api_id = "${aws_api_gateway_rest_api.myapi.id}"
    stage  = "${aws_api_gateway_deployment.prod.stage_name}"
  }

  quota_settings {
    limit  = 20
    offset = 2
    period = "WEEK"
  }

  throttle_settings {
    burst_limit = 5
    rate_limit  = 10
  }
}

तर्क संदर्भ

एपीआई गेटवे उपयोग योजना तर्क लेआउट एक संरचना है जो कई उप-संसाधनों से बना है - ये संसाधन नीचे दिए गए हैं।

शीर्ष स्तर के तर्क

आपी ने दलीलें दीं

  • api_id (आवश्यक) - उपयोग योजना में संबद्ध API चरण की API आईडी।
  • stage (आवश्यक) - उपयोग योजना में संबद्ध एपीआई चरण का एपीआई चरण का नाम।

कोटा सेटिंग्स तर्क

  • limit (वैकल्पिक) - किसी निश्चित समय अवधि में किए जा सकने वाले अनुरोधों की अधिकतम संख्या।
  • offset (वैकल्पिक) - प्रारंभिक समय अवधि में दी गई सीमा से घटाए गए अनुरोधों की संख्या।
  • period (वैकल्पिक) - वह समय अवधि जिसमें सीमा लागू होती है। मान्य मान "DAY", "WEEK" या "MONTH" हैं।

थ्रॉटलिंग सेटिंग्स तर्क

  • burst_limit (वैकल्पिक) - एपीआई अनुरोध फट सीमा, एक समय से लेकर कुछ सेकंड तक की अधिकतम दर सीमा, इस पर निर्भर करता है कि अंतर्निहित टोकन बाल्टी अपनी पूरी क्षमता पर है या नहीं।
  • rate_limit (वैकल्पिक) - एपीआई स्थिर राज्य दर सीमा का अनुरोध करता है।

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

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

  • id - एपीआई संसाधन की आईडी
  • name - उपयोग योजना का नाम।
  • description - एक उपयोग योजना का विवरण।
  • api_stages - उपयोग योजना के संबद्ध एपीआई चरण।
  • quota_settings - उपयोग योजना का कोटा।
  • throttle_settings - उपयोग योजना की थ्रॉटलिंग सीमा।
  • product_code - AWS मार्केटप्लेस पर AWS Markeplace उत्पाद पहचानकर्ता को SaSS उत्पाद के रूप में उपयोग योजना के साथ संबद्ध करने के लिए।

आयात

AWS एपीआई गेटवे यूसेज प्लान को id , जैसे का उपयोग करके आयात किया जा सकता है

$ terraform import aws_api_gateway_usage_plan.myusageplan <usage_plan_id>