Class: Ansible::Ruby::Modules::Serverless

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb

Overview

Provides support for managing Serverless Framework (serverless.com/) project deployments and stacks.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#deploy ⇒ Boolean?

Returns Whether or not to deploy artifacts after building them. When this option is ‘false` all the functions will be built, but no stack update will be run to send them out. This is mostly useful for generating artifacts to be stored/deployed elsewhere.

Returns:

  • (Boolean, nil) —

    Whether or not to deploy artifacts after building them. When this option is ‘false` all the functions will be built, but no stack update will be run to send them out. This is mostly useful for generating artifacts to be stored/deployed elsewhere.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 35

attribute :deploy

#force ⇒ Boolean?

Returns Whether or not to force full deployment, equivalent to serverless ‘–force` option.

Returns:

  • (Boolean, nil) —

    Whether or not to force full deployment, equivalent to serverless ‘–force` option.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 39

attribute :force

#functions ⇒ Object?

Returns A list of specific functions to deploy. If this is not provided, all functions in the service will be deployed.

Returns:

  • (Object, nil) —

    A list of specific functions to deploy. If this is not provided, all functions in the service will be deployed.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 28

attribute :functions

#region ⇒ String?

Returns AWS region to deploy the service to.

Returns:

  • (String, nil) —

    AWS region to deploy the service to



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 31

attribute :region

#serverless_bin_path ⇒ String?

Returns The path of a serverless framework binary relative to the ‘service_path’ eg. node_module/.bin/serverless.

Returns:

  • (String, nil) —

    The path of a serverless framework binary relative to the ‘service_path’ eg. node_module/.bin/serverless



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 16

attribute :serverless_bin_path

#service_path ⇒ String

Returns The path to the root of the Serverless Service to be operated on.

Returns:

  • (String) —

    The path to the root of the Serverless Service to be operated on.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 20

attribute :service_path

#stage ⇒ String?

Returns The name of the serverless framework project stage to deploy to. This uses the serverless framework default “dev”.

Returns:

  • (String, nil) —

    The name of the serverless framework project stage to deploy to. This uses the serverless framework default “dev”.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 24

attribute :stage

#state ⇒ :present, ...

Returns Goal state of given stage/project.

Returns:

  • (:present, :absent, nil) —

    Goal state of given stage/project



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 12

attribute :state

#verbose ⇒ Boolean?

Returns Shows all stack events during deployment, and display any Stack Output.

Returns:

  • (Boolean, nil) —

    Shows all stack events during deployment, and display any Stack Output.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/serverless.rb', line 43

attribute :verbose