Class: Ansible::Ruby::Modules::Gcp_backend_service

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb

Overview

Create or Destroy a Backend Service. See U(cloud.google.com/compute/docs/load-balancing/http/backend-service) for an overview. Full install/configuration instructions for the Google Cloud modules can be found in the comments of ansible/test/gce_tests.py.

Instance Method Summary

• #backend_service_name ⇒ String

  Name of the Backend Service.

• #backends ⇒ Array<Hash>, Hash

  List of backends that make up the backend service.

• #credentials_file ⇒ String^?

  Path to the JSON file associated with the service account email.

• #enable_cdn ⇒ Object^?

  If true, enable Cloud CDN for this Backend Service.

• #healthchecks ⇒ Array<String>, String

  List of healthchecks.

• #port_name ⇒ String^?

  Name of the port on the managed instance group (MIG) that backend services can forward data to.

• #project_id ⇒ String^?

  GCE project ID.

• #protocol ⇒ Object^?

  The protocol this Backend Service uses to communicate with backends.

• #service_account_email ⇒ String^?

  Service account email.

• #state ⇒ :absent, ...

  Desired state of the resource.

• #timeout ⇒ Integer^?

  How many seconds to wait for the backend before considering it a failed request.

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

#backend_service_name ⇒ String

Returns Name of the Backend Service.

Returns:

• (String) —

  Name of the Backend Service.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 12

attribute :backend_service_name

#backends ⇒ Array<Hash>, Hash

Returns List of backends that make up the backend service. A backend is made up of an instance group and optionally several other parameters. See U(cloud.google.com/compute/docs/reference/latest/backendServices) for details.

Returns:

• (Array<Hash>, Hash) —

  List of backends that make up the backend service. A backend is made up of an instance group and optionally several other parameters. See U(cloud.google.com/compute/docs/reference/latest/backendServices) for details.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 16

attribute :backends

#credentials_file ⇒ String^?

Returns Path to the JSON file associated with the service account email.

Returns:

• (String, nil) —

  Path to the JSON file associated with the service account email.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 42

attribute :credentials_file

#enable_cdn ⇒ Object^?

Returns If true, enable Cloud CDN for this Backend Service.

Returns:

• (Object, nil) —

  If true, enable Cloud CDN for this Backend Service.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 24

attribute :enable_cdn

#healthchecks ⇒ Array<String>, String

Returns List of healthchecks. Only one healthcheck is supported.

Returns:

• (Array<String>, String) —

  List of healthchecks. Only one healthcheck is supported.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 20

attribute :healthchecks

#port_name ⇒ String^?

Returns Name of the port on the managed instance group (MIG) that backend services can forward data to. Required for external load balancing.

Returns:

• (String, nil) —

  Name of the port on the managed instance group (MIG) that backend services can forward data to. Required for external load balancing.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 27

attribute :port_name

#project_id ⇒ String^?

Returns GCE project ID.

Returns:

• (String, nil) —

  GCE project ID.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 46

attribute :project_id

#protocol ⇒ Object^?

Returns The protocol this Backend Service uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.

Returns:

• (Object, nil) —

  The protocol this Backend Service uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 31

attribute :protocol

#service_account_email ⇒ String^?

Returns Service account email.

Returns:

• (String, nil) —

  Service account email

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 38

attribute :service_account_email

#state ⇒ :absent, ...

Returns Desired state of the resource.

Returns:

• (:absent, :present, nil) —

  Desired state of the resource

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 50

attribute :state

#timeout ⇒ Integer^?

Returns How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is 1-86400.

Returns:

• (Integer, nil) —

  How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is 1-86400.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_backend_service.rb', line 34

attribute :timeout