Class: Convection::Model::Template::Resource::ApiGatewayRestApi

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

Overview

AWS::ApiGateway::RestApi

See Also:

Instance Attribute Summary

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

#exist, #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

#body(value) ⇒ Object

JSON object



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

property :body, 'Body'

#body_s3_location(&block) ⇒ Object 



20
21
22
23
24
 
# File 'lib/convection/model/template/resource/aws_api_gateway_rest_api.rb', line 20

def body_s3_location(&block)
  b = ResourceProperty::ApiGatewayRestApiS3Location.new(self)
  b.instance_exec(&block) if block
  properties['BodyS3Location'].set(b)
end

#body_s3_location_prop(value) ⇒ Object

S3Location



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

property :body_s3_location_prop, 'BodyS3Location'

#clone_from ⇒ Object #clone_from(value) ⇒ Object

Overloads:

  • #clone_from ⇒ Object

    Returns the value of the ‘CloneFrom’ CloudFormation property.

  • #clone_from(value) ⇒ Object

    Sets the ‘CloneFrom’ CloudFormation property.

    Parameters:

    • value —

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



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

property :clone_from, 'CloneFrom'

#description ⇒ Object #description(value) ⇒ Object

Overloads:

  • #description ⇒ Object

    Returns the value of the ‘Description’ CloudFormation property.

  • #description(value) ⇒ Object

    Sets the ‘Description’ CloudFormation property.

    Parameters:

    • value —

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



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

property :description, 'Description'

#fail_on_warnings ⇒ Object #fail_on_warnings(value) ⇒ Object

Overloads:

  • #fail_on_warnings ⇒ Object

    Returns the value of the ‘FailOnWarnings’ CloudFormation property.

  • #fail_on_warnings(value) ⇒ Object

    Sets the ‘FailOnWarnings’ CloudFormation property.

    Parameters:

    • value —

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



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

property :fail_on_warnings, 'FailOnWarnings'

#name ⇒ Object #name(value) ⇒ Object

Overloads:

  • #name ⇒ Object

    Returns the value of the ‘Name’ CloudFormation property.

  • #name(value) ⇒ Object

    Sets the ‘Name’ CloudFormation property.

    Parameters:

    • value —

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



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

property :name, 'Name'

#parameters(value) ⇒ Object

String, … 


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

property :parameters, 'Parameters', :type => :list