Add aws_api_gateway_method resource
This commit is contained in:
parent
7ead800f6a
commit
032e6081cb
|
@ -116,6 +116,7 @@ func Provider() terraform.ResourceProvider {
|
|||
"aws_ami_from_instance": resourceAwsAmiFromInstance(),
|
||||
"aws_api_gateway_rest_api": resourceAwsApiGatewayRestApi(),
|
||||
"aws_api_gateway_resource": resourceAwsApiGatewayResource(),
|
||||
"aws_api_gateway_method": resourceAwsApiGatewayMethod(),
|
||||
"aws_app_cookie_stickiness_policy": resourceAwsAppCookieStickinessPolicy(),
|
||||
"aws_autoscaling_group": resourceAwsAutoscalingGroup(),
|
||||
"aws_autoscaling_notification": resourceAwsAutoscalingNotification(),
|
||||
|
|
|
@ -0,0 +1,192 @@
|
|||
package aws
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"github.com/aws/aws-sdk-go/aws"
|
||||
"github.com/aws/aws-sdk-go/aws/awserr"
|
||||
"github.com/aws/aws-sdk-go/service/apigateway"
|
||||
"github.com/hashicorp/terraform/helper/resource"
|
||||
"github.com/hashicorp/terraform/helper/schema"
|
||||
)
|
||||
|
||||
func resourceAwsApiGatewayMethod() *schema.Resource {
|
||||
return &schema.Resource{
|
||||
Create: resourceAwsApiGatewayMethodCreate,
|
||||
Read: resourceAwsApiGatewayMethodRead,
|
||||
Update: resourceAwsApiGatewayMethodUpdate,
|
||||
Delete: resourceAwsApiGatewayMethodDelete,
|
||||
|
||||
Schema: map[string]*schema.Schema{
|
||||
"rest_api_id": &schema.Schema{
|
||||
Type: schema.TypeString,
|
||||
Required: true,
|
||||
ForceNew: true,
|
||||
},
|
||||
|
||||
"resource_id": &schema.Schema{
|
||||
Type: schema.TypeString,
|
||||
Required: true,
|
||||
ForceNew: true,
|
||||
},
|
||||
|
||||
"http_method": &schema.Schema{
|
||||
Type: schema.TypeString,
|
||||
Required: true,
|
||||
ForceNew: true,
|
||||
ValidateFunc: validateHTTPMethod,
|
||||
},
|
||||
|
||||
"authorization": &schema.Schema{
|
||||
Type: schema.TypeString,
|
||||
Required: true,
|
||||
},
|
||||
|
||||
"api_key_required": &schema.Schema{
|
||||
Type: schema.TypeBool,
|
||||
Optional: true,
|
||||
Default: false,
|
||||
},
|
||||
|
||||
"request_models": &schema.Schema{
|
||||
Type: schema.TypeMap,
|
||||
Optional: true,
|
||||
Elem: schema.TypeString,
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func resourceAwsApiGatewayMethodCreate(d *schema.ResourceData, meta interface{}) error {
|
||||
conn := meta.(*AWSClient).apigateway
|
||||
|
||||
models := make(map[string]string)
|
||||
for k, v := range d.Get("request_models").(map[string]interface{}) {
|
||||
models[k] = v.(string)
|
||||
}
|
||||
|
||||
parameters := make(map[string]bool)
|
||||
if parameterData, ok := d.GetOk("request_parameters"); ok {
|
||||
params := parameterData.(*schema.Set).List()
|
||||
for k := range params {
|
||||
parameters[params[k].(string)] = true
|
||||
}
|
||||
}
|
||||
|
||||
_, err := conn.PutMethod(&apigateway.PutMethodInput{
|
||||
AuthorizationType: aws.String(d.Get("authorization").(string)),
|
||||
HttpMethod: aws.String(d.Get("http_method").(string)),
|
||||
ResourceId: aws.String(d.Get("resource_id").(string)),
|
||||
RestApiId: aws.String(d.Get("rest_api_id").(string)),
|
||||
RequestModels: aws.StringMap(models),
|
||||
// TODO implement once [GH-2143](https://github.com/hashicorp/terraform/issues/2143) has been implemented
|
||||
RequestParameters: nil,
|
||||
ApiKeyRequired: aws.Bool(d.Get("api_key_required").(bool)),
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("Error creating API Gateway Method: %s", err)
|
||||
}
|
||||
|
||||
d.SetId(fmt.Sprintf("agm-%s-%s-%s", d.Get("rest_api_id").(string), d.Get("resource_id").(string), d.Get("http_method").(string)))
|
||||
log.Printf("[DEBUG] API Gateway Method ID: %s", d.Id())
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func resourceAwsApiGatewayMethodRead(d *schema.ResourceData, meta interface{}) error {
|
||||
conn := meta.(*AWSClient).apigateway
|
||||
|
||||
log.Printf("[DEBUG] Reading API Gateway Method %s", d.Id())
|
||||
out, err := conn.GetMethod(&apigateway.GetMethodInput{
|
||||
HttpMethod: aws.String(d.Get("http_method").(string)),
|
||||
ResourceId: aws.String(d.Get("resource_id").(string)),
|
||||
RestApiId: aws.String(d.Get("rest_api_id").(string)),
|
||||
})
|
||||
if err != nil {
|
||||
if awsErr, ok := err.(awserr.Error); ok && awsErr.Code() == "NotFoundException" {
|
||||
d.SetId("")
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
log.Printf("[DEBUG] Received API Gateway Method: %s", out)
|
||||
d.SetId(fmt.Sprintf("agm-%s-%s-%s", d.Get("rest_api_id").(string), d.Get("resource_id").(string), d.Get("http_method").(string)))
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func resourceAwsApiGatewayMethodUpdate(d *schema.ResourceData, meta interface{}) error {
|
||||
conn := meta.(*AWSClient).apigateway
|
||||
|
||||
log.Printf("[DEBUG] Reading API Gateway Method %s", d.Id())
|
||||
operations := make([]*apigateway.PatchOperation, 0)
|
||||
if d.HasChange("resource_id") {
|
||||
operations = append(operations, &apigateway.PatchOperation{
|
||||
Op: aws.String("replace"),
|
||||
Path: aws.String("/resourceId"),
|
||||
Value: aws.String(d.Get("resource_id").(string)),
|
||||
})
|
||||
}
|
||||
|
||||
if d.HasChange("request_models") {
|
||||
operations = append(operations, expandApiGatewayRequestResponseModelOperations(d, "request_models", "requestModels")...)
|
||||
}
|
||||
|
||||
method, err := conn.UpdateMethod(&apigateway.UpdateMethodInput{
|
||||
HttpMethod: aws.String(d.Get("http_method").(string)),
|
||||
ResourceId: aws.String(d.Get("resource_id").(string)),
|
||||
RestApiId: aws.String(d.Get("rest_api_id").(string)),
|
||||
PatchOperations: operations,
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
log.Printf("[DEBUG] Received API Gateway Method: %s", method)
|
||||
|
||||
return resourceAwsApiGatewayMethodRead(d, meta)
|
||||
}
|
||||
|
||||
func resourceAwsApiGatewayMethodDelete(d *schema.ResourceData, meta interface{}) error {
|
||||
conn := meta.(*AWSClient).apigateway
|
||||
log.Printf("[DEBUG] Deleting API Gateway Method: %s", d.Id())
|
||||
|
||||
resourceId := d.Get("resource_id").(string)
|
||||
if o, n := d.GetChange("resource_id"); o.(string) != n.(string) {
|
||||
resourceId = o.(string)
|
||||
}
|
||||
httpMethod := d.Get("http_method").(string)
|
||||
if o, n := d.GetChange("http_method"); o.(string) != n.(string) {
|
||||
httpMethod = o.(string)
|
||||
}
|
||||
restApiID := d.Get("rest_api_id").(string)
|
||||
if o, n := d.GetChange("rest_api_id"); o.(string) != n.(string) {
|
||||
restApiID = o.(string)
|
||||
}
|
||||
|
||||
return resource.Retry(5*time.Minute, func() error {
|
||||
log.Printf("[DEBUG] schema is %#v", d)
|
||||
_, err := conn.DeleteMethod(&apigateway.DeleteMethodInput{
|
||||
HttpMethod: aws.String(httpMethod),
|
||||
ResourceId: aws.String(resourceId),
|
||||
RestApiId: aws.String(restApiID),
|
||||
})
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
apigatewayErr, ok := err.(awserr.Error)
|
||||
if apigatewayErr.Code() == "NotFoundException" {
|
||||
return nil
|
||||
}
|
||||
|
||||
if !ok {
|
||||
return resource.RetryError{Err: err}
|
||||
}
|
||||
|
||||
return resource.RetryError{Err: err}
|
||||
})
|
||||
}
|
|
@ -0,0 +1,134 @@
|
|||
package aws
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/aws/aws-sdk-go/aws"
|
||||
"github.com/aws/aws-sdk-go/aws/awserr"
|
||||
"github.com/aws/aws-sdk-go/service/apigateway"
|
||||
"github.com/hashicorp/terraform/helper/resource"
|
||||
"github.com/hashicorp/terraform/terraform"
|
||||
)
|
||||
|
||||
func TestAccAWSAPIGatewayMethod_basic(t *testing.T) {
|
||||
var conf apigateway.Method
|
||||
|
||||
resource.Test(t, resource.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Providers: testAccProviders,
|
||||
CheckDestroy: testAccCheckAWSAPIGatewayMethodDestroy,
|
||||
Steps: []resource.TestStep{
|
||||
resource.TestStep{
|
||||
Config: testAccAWSAPIGatewayMethodConfig,
|
||||
Check: resource.ComposeTestCheckFunc(
|
||||
testAccCheckAWSAPIGatewayMethodExists("aws_api_gateway_method.test", &conf),
|
||||
testAccCheckAWSAPIGatewayMethodAttributes(&conf),
|
||||
resource.TestCheckResourceAttr(
|
||||
"aws_api_gateway_method.test", "http_method", "GET"),
|
||||
resource.TestCheckResourceAttr(
|
||||
"aws_api_gateway_method.test", "authorization", "NONE"),
|
||||
resource.TestCheckResourceAttr(
|
||||
"aws_api_gateway_method.test", "request_models.application/json", "Error"),
|
||||
),
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func testAccCheckAWSAPIGatewayMethodAttributes(conf *apigateway.Method) resource.TestCheckFunc {
|
||||
return func(s *terraform.State) error {
|
||||
if *conf.HttpMethod != "GET" {
|
||||
return fmt.Errorf("Wrong HttpMethod: %q", *conf.HttpMethod)
|
||||
}
|
||||
if *conf.AuthorizationType != "NONE" {
|
||||
return fmt.Errorf("Wrong Authorization: %q", *conf.AuthorizationType)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
func testAccCheckAWSAPIGatewayMethodExists(n string, res *apigateway.Method) resource.TestCheckFunc {
|
||||
return func(s *terraform.State) error {
|
||||
rs, ok := s.RootModule().Resources[n]
|
||||
if !ok {
|
||||
return fmt.Errorf("Not found: %s", n)
|
||||
}
|
||||
|
||||
if rs.Primary.ID == "" {
|
||||
return fmt.Errorf("No API Gateway Method ID is set")
|
||||
}
|
||||
|
||||
conn := testAccProvider.Meta().(*AWSClient).apigateway
|
||||
|
||||
req := &apigateway.GetMethodInput{
|
||||
HttpMethod: aws.String("GET"),
|
||||
ResourceId: aws.String(s.RootModule().Resources["aws_api_gateway_resource.test"].Primary.ID),
|
||||
RestApiId: aws.String(s.RootModule().Resources["aws_api_gateway_rest_api.test"].Primary.ID),
|
||||
}
|
||||
describe, err := conn.GetMethod(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
*res = *describe
|
||||
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
func testAccCheckAWSAPIGatewayMethodDestroy(s *terraform.State) error {
|
||||
conn := testAccProvider.Meta().(*AWSClient).apigateway
|
||||
|
||||
for _, rs := range s.RootModule().Resources {
|
||||
if rs.Type != "aws_api_gateway_method" {
|
||||
continue
|
||||
}
|
||||
|
||||
req := &apigateway.GetMethodInput{
|
||||
HttpMethod: aws.String("GET"),
|
||||
ResourceId: aws.String(s.RootModule().Resources["aws_api_gateway_resource.test"].Primary.ID),
|
||||
RestApiId: aws.String(s.RootModule().Resources["aws_api_gateway_rest_api.test"].Primary.ID),
|
||||
}
|
||||
_, err := conn.GetMethod(req)
|
||||
|
||||
if err == nil {
|
||||
return fmt.Errorf("API Gateway Method still exists")
|
||||
}
|
||||
|
||||
aws2err, ok := err.(awserr.Error)
|
||||
if !ok {
|
||||
return err
|
||||
}
|
||||
if aws2err.Code() != "NotFoundException" {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
const testAccAWSAPIGatewayMethodConfig = `
|
||||
resource "aws_api_gateway_rest_api" "test" {
|
||||
name = "test"
|
||||
}
|
||||
|
||||
resource "aws_api_gateway_resource" "test" {
|
||||
rest_api_id = "${aws_api_gateway_rest_api.test.id}"
|
||||
parent_id = "${aws_api_gateway_rest_api.test.root_resource_id}"
|
||||
path_part = "test"
|
||||
}
|
||||
|
||||
resource "aws_api_gateway_method" "test" {
|
||||
rest_api_id = "${aws_api_gateway_rest_api.test.id}"
|
||||
resource_id = "${aws_api_gateway_resource.test.id}"
|
||||
http_method = "GET"
|
||||
authorization = "NONE"
|
||||
|
||||
request_models = {
|
||||
"application/json" = "Error"
|
||||
}
|
||||
}
|
||||
`
|
|
@ -299,3 +299,12 @@ func validateCIDRNetworkAddress(v interface{}, k string) (ws []string, errors []
|
|||
|
||||
return
|
||||
}
|
||||
|
||||
func validateHTTPMethod(v interface{}, k string) (ws []string, errors []error) {
|
||||
value := v.(string)
|
||||
if value != "GET" && value != "HEAD" && value != "OPTIONS" && value != "PUT" && value != "POST" && value != "PATCH" && value != "DELETE" {
|
||||
errors = append(errors, fmt.Errorf(
|
||||
"%q must be one of 'GET', 'HEAD', 'OPTIONS', 'PUT', 'POST', 'PATCH', 'DELETE'", k))
|
||||
}
|
||||
return
|
||||
}
|
||||
|
|
|
@ -274,3 +274,14 @@ func TestValidateCIDRNetworkAddress(t *testing.T) {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateHTTPMethod(t *testing.T) {
|
||||
validCases := []string{"GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH"}
|
||||
for i, method := range validCases {
|
||||
_, errs := validateHTTPMethod(method, "foo")
|
||||
if len(errs) != 0 {
|
||||
t.Fatalf("%d/%d: Expected no error, got errs: %#v",
|
||||
i+1, len(validCases), errs)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
layout: "aws"
|
||||
page_title: "AWS: aws_api_gateway_method"
|
||||
sidebar_current: "docs-aws-resource-api-gateway-method"
|
||||
description: |-
|
||||
Provides an HTTP Method for an API Gateway Resource.
|
||||
---
|
||||
|
||||
# aws\_api\_gateway\_method
|
||||
|
||||
Provides an HTTP Method for an API Gateway Resource.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "aws_api_gateway_rest_api" "MyDemoAPI" {
|
||||
name = "MyDemoAPI"
|
||||
description = "This is my API for demonstration purposes"
|
||||
}
|
||||
|
||||
resource "aws_api_gateway_resource" "MyDemoResource" {
|
||||
rest_api_id = "${aws_api_gateway_rest_api.MyDemoAPI.id}"
|
||||
parent_resource_id = "${aws_api_gateway_rest_api.MyDemoAPI.root_resource_id}"
|
||||
path_part = "mydemoresource"
|
||||
}
|
||||
|
||||
resource "aws_api_gateway_method" "MyDemoMethod" {
|
||||
rest_api_id = "${aws_api_gateway_rest_api.MyDemoAPI.id}"
|
||||
resource_id = "${aws_api_gateway_resource.MyDemoResource.id}"
|
||||
http_method = "GET"
|
||||
authorization = "NONE"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `rest_api_id` - (Required) API Gateway ID
|
||||
* `resource_id` - (Required) API Gateway Resource ID
|
||||
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
|
||||
* `authorization` - (Required) Type of authorization used for the method.
|
||||
* `api_key_required` - (Optional) Specify if the method required an ApiKey
|
||||
* `request_models` - (Optional) Specifies the Model resources used for the request's content type description
|
||||
* `request_parameters` - (Optional) Represents requests parameters that are sent with the backend request
|
||||
|
|
@ -19,6 +19,9 @@
|
|||
<li<%= sidebar_current("docs-aws-resource-api-gateway-resource") %>>
|
||||
<a href="/docs/providers/aws/r/api_gateway_resource.html">aws_api_gateway_resource</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-aws-resource-api-gateway-method") %>>
|
||||
<a href="/docs/providers/aws/r/api_gateway_method.html">aws_api_gateway_method</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
|
Loading…
Reference in New Issue