Class: Convection::Model::Template::Resource::ApiGatewayMethod

Inherits:
Convection::Model::Template::Resource show all
Defined in:
lib/convection/model/template/resource/aws_api_gateway_method.rb,
lib/convection/model/template/resource/aws_api_gateway_usage_plan_key.rb

Overview

AWS::ApiGateway::Method

See Also:

Instance Attribute Summary

Attributes inherited from Convection::Model::Template::Resource

#exist, #name, #parent, #properties, #resource_attributes, #template

Instance Method Summary collapse

Methods inherited from Convection::Model::Template::Resource

#as_attribute, attach_method, #deletion_policy, #depends_on, #initialize, properties, property, #property, #reference, #render, type, #type, #with_output

Methods included from Mixin::Conditional

#condition, #render_condition

Methods included from DSL::Template::Resource

#_terraform_module_dir_to_flag, #_terraform_module_flag_to_dir, attach_resource, attach_resource_collection, resource_collection_dsl_methods, resource_dsl_methods

Methods included from DSL::Helpers

#camel_case, included, method_name, #screaming_snake_case, #snake_case

Methods included from DSL::IntrinsicFunctions

#base64, #find_in_map, #fn_and, #fn_equals, #fn_if, #fn_import_value, #fn_not, #fn_or, #fn_ref, #fn_sub, #get_att, #get_azs, included, #join, mixers, #select

Constructor Details

This class inherits a constructor from Convection::Model::Template::Resource

Instance Method Details

#api_key_required ⇒ Object #api_key_required(value) ⇒ Object

Overloads:

  • #api_key_required ⇒ Object

    Returns the value of the ‘ApiKeyRequired’ CloudFormation property.

  • #api_key_required(value) ⇒ Object

    Sets the ‘ApiKeyRequired’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘ApiKeyRequired’ CloudFormation property to.



12
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 12

property :api_key_required, 'ApiKeyRequired'

#authorization_type ⇒ Object #authorization_type(value) ⇒ Object

Overloads:

  • #authorization_type ⇒ Object

    Returns the value of the ‘AuthorizationType’ CloudFormation property.

  • #authorization_type(value) ⇒ Object

    Sets the ‘AuthorizationType’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘AuthorizationType’ CloudFormation property to.



13
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 13

property :authorization_type, 'AuthorizationType'

#authorizer_id ⇒ Object #authorizer_id(value) ⇒ Object

Overloads:

  • #authorizer_id ⇒ Object

    Returns the value of the ‘AuthorizerId’ CloudFormation property.

  • #authorizer_id(value) ⇒ Object

    Sets the ‘AuthorizerId’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘AuthorizerId’ CloudFormation property to.



14
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 14

property :authorizer_id, 'AuthorizerId'

#http_method ⇒ Object #http_method(value) ⇒ Object

Overloads:

  • #http_method ⇒ Object

    Returns the value of the ‘HttpMethod’ CloudFormation property.

  • #http_method(value) ⇒ Object

    Sets the ‘HttpMethod’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘HttpMethod’ CloudFormation property to.



15
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 15

property :http_method, 'HttpMethod'

#integration(&block) ⇒ Object 



23
24
25
26
27
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 23

def integration(&block)
  i = ResourceProperty::ApiGatewayMethodIntegration.new(self)
  i.instance_exec(&block) if block
  properties['Integration'].set(i)
end

#integration_prop ⇒ Object #integration_prop(value) ⇒ Object

Overloads:

  • #integration_prop ⇒ Object

    Returns the value of the ‘Integration’ CloudFormation property.

  • #integration_prop(value) ⇒ Object

    Sets the ‘Integration’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘Integration’ CloudFormation property to.



16
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 16

property :integration_prop, 'Integration'

#key_id ⇒ Object #key_id(value) ⇒ Object

Overloads:

  • #key_id ⇒ Object

    Returns the value of the ‘KeId’ CloudFormation property.

  • #key_id(value) ⇒ Object

    Sets the ‘KeId’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘KeId’ CloudFormation property to.



12
 
# File 'lib/convection/model/template/resource/aws_api_gateway_usage_plan_key.rb', line 12

property :key_id, 'KeId'

#key_type ⇒ Object #key_type(value) ⇒ Object

Overloads:

  • #key_type ⇒ Object

    Returns the value of the ‘KeyType’ CloudFormation property.

  • #key_type(value) ⇒ Object

    Sets the ‘KeyType’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘KeyType’ CloudFormation property to.



13
 
# File 'lib/convection/model/template/resource/aws_api_gateway_usage_plan_key.rb', line 13

property :key_type, 'KeyType'

#method_response(&block) ⇒ Object 



29
30
31
32
33
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 29

def method_response(&block)
  r = ResourceProperty::ApiGatewayMethodMethodResponse.new(self)
  r.instance_exec(&block) if block
  method_responses << r
end

#method_responses(value) ⇒ Object

MethodResponse, … 


17
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 17

property :method_responses, 'MethodResponses', :type => :list

#request_model(value) ⇒ Object

{ String:String, … }



18
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 18

property :request_model, 'RequestModels', :type => :hash

#request_parameter(value) ⇒ Object

{ String:Boolean, … }



19
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 19

property :request_parameter, 'RequestParameters', :type => :hash

#resource_id ⇒ Object #resource_id(value) ⇒ Object

Overloads:

  • #resource_id ⇒ Object

    Returns the value of the ‘ResourceId’ CloudFormation property.

  • #resource_id(value) ⇒ Object

    Sets the ‘ResourceId’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘ResourceId’ CloudFormation property to.



20
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 20

property :resource_id, 'ResourceId'

#rest_api_id ⇒ Object #rest_api_id(value) ⇒ Object

Overloads:

  • #rest_api_id ⇒ Object

    Returns the value of the ‘RestApiId’ CloudFormation property.

  • #rest_api_id(value) ⇒ Object

    Sets the ‘RestApiId’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘RestApiId’ CloudFormation property to.



21
 
# File 'lib/convection/model/template/resource/aws_api_gateway_method.rb', line 21

property :rest_api_id, 'RestApiId'