Class: Ansible::Ruby::Modules::Aws_api_gateway

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Aws_api_gateway

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb

Overview

Allows for the management of API Gateway APIs Normally you should give the api_id since there is no other stable guaranteed unique identifier for the API. If you do not give api_id then a new API will be create each time this is run. Beware that there are very hard limits on the rate that you can call API Gateway’s REST API. You may need to patch your boto. See github.com/boto/boto3/issues/876 and discuss with your AWS rep. swagger_file and swagger_text are passed directly on to AWS transparently whilst swagger_dict is an ansible dict which is converted to JSON before the API definitions are uploaded.

Instance Method Summary

• #api_id ⇒ String^?

  The ID of the API you want to manage.

• #deploy_desc ⇒ String^?

  Description of the deployment - recorded and visible in the AWS console.

• #stage ⇒ String^?

  The name of the stage the API should be deployed to.

• #state ⇒ :present, ...

  NOT IMPLEMENTED Create or delete API - currently we always create.

• #swagger_dict ⇒ Object^?

  Swagger definitions API ansible dictionary which will be converted to JSON and uploaded.

• #swagger_file ⇒ String^?

  JSON or YAML file containing swagger definitions for API.

• #swagger_text ⇒ Object^?

  Swagger definitions for API in JSON or YAML as a string direct from playbook.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 15

attribute :api_id

#deploy_desc ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 37

attribute :deploy_desc

#stage ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 33

attribute :stage

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 19

attribute :state

#swagger_dict ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 30

attribute :swagger_dict

#swagger_file ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 23

attribute :swagger_file

#swagger_text ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_api_gateway.rb', line 27

attribute :swagger_text