Terraform 0.11

aws_api_gateway_domain_name




terraform

aws_api_gateway_domain_name

AWS API गेटवे के साथ उपयोग के लिए एक कस्टम डोमेन नाम पंजीकृत करता है।

यह संसाधन किसी विशेष डोमेन नाम के लिए सिर्फ और टीएलएस सेटिंग्स का स्वामित्व स्थापित करता है। एक एपीआई पंजीकृत डोमेन नाम के तहत एक विशेष पथ से जुड़ा हो सकता है aws_api_gateway_base_path_mapping संसाधन

एपीआई गेटवे डोमेन को 'एज-ऑप्टिमाइज़्ड' या 'क्षेत्रीय' के रूप में परिभाषित किया जा सकता है। एक किनारे से अनुकूलित कॉन्फ़िगरेशन में, एपीआई गेटवे आंतरिक रूप से दिए गए होस्टनाम पर मार्ग अनुरोधों के लिए क्लाउडफ्रंट वितरण का निर्माण और प्रबंधन करता है। इस संसाधन के अलावा, यह आवश्यक है कि दिए गए डोमेन नाम के अनुरूप डीएनएस रिकॉर्ड बनाया जाए जो cloudfront_domain_name विशेषता में निर्यात किए गए क्लाउडफ्रंट डोमेन नाम के लिए एक उपनाम (या तो रूट 53 उपनाम या पारंपरिक CNAME) है।

एक क्षेत्रीय कॉन्फ़िगरेशन में, एपीआई गेटवे एपीआई के लिए मार्ग अनुरोधों के लिए क्लाउडफ्रंट वितरण नहीं बनाता है, हालांकि यदि आवश्यक हो तो वितरण बनाया जा सकता है। किसी भी स्थिति में, क्षेत्रीय डोमेन नाम जो regional_domain_name विशेषता में निर्यात किया जाता है, को दिए गए डोमेन नाम के अनुरूप डीएनएस रिकॉर्ड बनाना आवश्यक है, जो एक उपनाम (या तो रूट 53 उपनाम या पारंपरिक CNAME) है।

उदाहरण उपयोग

resource "aws_api_gateway_domain_name" "example" {
  domain_name = "api.example.com"

  certificate_name        = "example-api"
  certificate_body        = "${file("${path.module}/example.com/example.crt")}"
  certificate_chain       = "${file("${path.module}/example.com/ca.crt")}"
  certificate_private_key = "${file("${path.module}/example.com/example.key")}"
}

# Example DNS record using Route53.
# Route53 is not specifically required; any DNS host can be used.
resource "aws_route53_record" "example" {
  zone_id = "${aws_route53_zone.example.id}" # See aws_route53_zone for how to create this

  name = "${aws_api_gateway_domain_name.example.domain_name}"
  type = "A"

  alias {
    name                   = "${aws_api_gateway_domain_name.example.cloudfront_domain_name}"
    zone_id                = "${aws_api_gateway_domain_name.example.cloudfront_zone_id}"
    evaluate_target_health = true
  }
}

तर्क संदर्भ

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

  • domain_name - (आवश्यक) पंजीकरण के लिए पूरी तरह से योग्य डोमेन नाम
  • certificate_name - (वैकल्पिक) IAM सर्वर प्रमाणपत्र के रूप में इस प्रमाणपत्र को पंजीकृत करते समय उपयोग करने वाला अद्वितीय नाम। certificate_arn , regional_certificate_arn , और regional_certificate_name । आवश्यक है यदि certificate_arn पत्र_कर्ण सेट नहीं है।
  • certificate_body - (वैकल्पिक) डोमेन नाम पंजीकृत होने के लिए जारी किया गया प्रमाण पत्र, पीईएम प्रारूप में। केवल EDGE समापन बिंदु कॉन्फ़िगरेशन प्रकार के लिए मान्य है। certificate_arn , regional_certificate_arn , और regional_certificate_name
  • certificate_chain - (वैकल्पिक) CA के लिए प्रमाणपत्र जिसने प्रमाणपत्र जारी किया है, साथ ही किसी भी मध्यवर्ती CA प्रमाण पत्र के साथ अपेक्षित API क्लाइंट द्वारा विश्वसनीय प्रमाण पत्र के लिए एक अटूट श्रृंखला बनाने के लिए आवश्यक है। केवल EDGE समापन बिंदु कॉन्फ़िगरेशन प्रकार के लिए मान्य है। certificate_arn , regional_certificate_arn , और regional_certificate_name
  • certificate_private_key - (वैकल्पिक) प्रमाणपत्र_बॉडी में दिए गए डोमेन प्रमाणपत्र के साथ जुड़ी हुई निजी कुंजी। केवल EDGE समापन बिंदु कॉन्फ़िगरेशन प्रकार के लिए मान्य है। certificate_arn , regional_certificate_arn , और regional_certificate_name
  • certificate_arn - (वैकल्पिक) AWS- प्रबंधित प्रमाणपत्र के लिए ARN। उपयोग किया जाता है जब एक किनारे-अनुकूलित डोमेन नाम वांछित होता है। certificate_name , certificate_body , certificate_chain , certificate_private_key , regional_certificate_arn , और regional_certificate_name साथ विरोध।
  • endpoint_configuration - (वैकल्पिक) समापन बिंदु प्रकार सहित API समापन बिंदु कॉन्फ़िगरेशन को परिभाषित करने वाला नेस्टेड तर्क। नीचे परिभाषित किया गया।
  • regional_certificate_arn - (वैकल्पिक) AWS- प्रबंधित प्रमाणपत्र के लिए ARN। क्षेत्रीय डोमेन नाम वांछित होने पर उपयोग किया जाता है। certificate_arn , certificate_name , certificate_body , certificate_chain , और certificate_private_key साथ विरोध।
  • regional_certificate_name - (वैकल्पिक) प्रमाण पत्र का उपयोगकर्ता के अनुकूल नाम जो इस डोमेन नाम के लिए क्षेत्रीय समापन बिंदु द्वारा उपयोग किया जाएगा। certificate_arn , certificate_name , certificate_body , certificate_chain , और certificate_private_key साथ विरोध।

endpoint_configuration

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

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

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

  • id - एपीआई गेटवे द्वारा इस डोमेन नाम को दी गई आंतरिक आईडी।
  • certificate_upload_date - डोमेन प्रमाणपत्र से जुड़ी अपलोड की गई तारीख।
  • cloudfront_domain_name - इस डोमेन नाम मानचित्रण को लागू करने वाले वितरण का प्रतिनिधित्व करने के लिए Cloudfront द्वारा बनाया गया होस्टनाम।
  • cloudfront_zone_id - सुविधा के लिए, होस्ट की गई ज़ोन ID ( Z2FDTNDATAQYW2 ) जिसका उपयोग वितरण के लिए एक रूट 53 उपनाम रिकॉर्ड बनाने के लिए किया जा सकता है।
  • regional_domain_name - कस्टम डोमेन के क्षेत्रीय समापन बिंदु के लिए होस्टनाम।
  • regional_zone_id - होस्ट की गई ज़ोन आईडी जिसका उपयोग क्षेत्रीय समापन बिंदु के लिए एक रूट53 उपनाम रिकॉर्ड बनाने के लिए किया जा सकता है।