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

Inherits:
Base show all
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 collapse

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?

Returns The ID of the API you want to manage.

Returns:

  • (String, nil) —

    The ID of the API you want to manage.



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

attribute :api_id

#deploy_desc ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :deploy_desc

#stage ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :stage

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

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



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

attribute :state

#swagger_dict ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :swagger_dict

#swagger_file ⇒ String?

Returns JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present.

Returns:

  • (String, nil) —

    JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present.



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

attribute :swagger_file

#swagger_text ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :swagger_text