Class: Convection::Model::Template::Resource::ApiGatewayUsagePlan

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

Overview

AWS::ApiGateway::UsagePlan

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_stage(&block) ⇒ Object 



18
19
20
21
22
 
# File 'lib/convection/model/template/resource/aws_api_gateway_usage_plan.rb', line 18

def api_stage(&block)
  r = ResourceProperty::ApiGatewayUsagePlanApiStage.new(self)
  r.instance_exec(&block) if block
  api_stages << r
end

#api_stages(value) ⇒ Object

ApiStage, … 


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

property :api_stages, 'ApiStages', :type => :list

#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.



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

property :description, 'Description'

#quota(&block) ⇒ Object 



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

def quota(&block)
  i = ResourceProperty::ApiGatewayUsagePlanQuotaSettings.new(self)
  i.instance_exec(&block) if block
  properties['Quota'].set(i)
end

#quota_prop(value) ⇒ Object

QuotaSetting



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

property :quota_prop, 'Quota'

#throttle(&block) ⇒ Object 



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

def throttle(&block)
  i = ResourceProperty::ApiGatewayUsagePlanThrottleSettings.new(self)
  i.instance_exec(&block) if block
  properties['Throttle'].set(i)
end

#throttle_prop(value) ⇒ Object

ThrottleSetting



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

property :throttle_prop, 'Throttle'

#usage_plan_name ⇒ Object #usage_plan_name(value) ⇒ Object

Overloads:

  • #usage_plan_name ⇒ Object

    Returns the value of the ‘UsagePlanName’ CloudFormation property.

  • #usage_plan_name(value) ⇒ Object

    Sets the ‘UsagePlanName’ CloudFormation property.

    Parameters:

    • value —

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



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

property :usage_plan_name, 'UsagePlanName'