Class: Convection::Model::Template::Resource::ApiGatewayApiKey

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

Overview

AWS::ApiGateway::ApiKey

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

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



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

property :description, 'Description'

#enabled ⇒ Object #enabled(value) ⇒ Object

Overloads:

  • #enabled ⇒ Object

    Returns the value of the ‘Enabled’ CloudFormation property.

  • #enabled(value) ⇒ Object

    Sets the ‘Enabled’ CloudFormation property.

    Parameters:

    • value —

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



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

property :enabled, 'Enabled'

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



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

property :name, 'Name'

#stage_key(&block) ⇒ Object 



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

def stage_key(&block)
  s = ResourceProperty::ApiGatewayApiKeyStageKey.new(self)
  s.instance_exec(&block) if block
  stage_keys << s
end

#stage_keys(value) ⇒ Object

StageKey, … 


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

property :stage_keys, 'StageKeys', :type => :list