Class: Ansible::Ruby::Modules::Gcp_compute_backend_service

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

Overview

Creates a BackendService resource in the specified project using the data included in the request.

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

Returns Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.,When the load balancing scheme is INTERNAL, this field is not used.

Returns:

  • (Object, nil) —

    Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.,When the load balancing scheme is INTERNAL, this field is not used.



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

attribute :affinity_cookie_ttl_sec

#backends ⇒ Array<Hash>, ...

Returns The list of backends that serve this BackendService.

Returns:

  • (Array<Hash>, Hash, nil) —

    The list of backends that serve this BackendService.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 19

attribute :backends

#cdn_policy ⇒ Object?

Returns Cloud CDN configuration for this BackendService.

Returns:

  • (Object, nil) —

    Cloud CDN configuration for this BackendService.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 23

attribute :cdn_policy

#connection_draining ⇒ Object?

Returns Settings for connection draining.

Returns:

  • (Object, nil) —

    Settings for connection draining.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 26

attribute :connection_draining

#description ⇒ Object?

Returns An optional description of this resource.

Returns:

  • (Object, nil) —

    An optional description of this resource.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 29

attribute :description

#enable_cdn ⇒ Symbol?

Returns If true, enable Cloud CDN for this BackendService.,When the load balancing scheme is INTERNAL, this field is not used.

Returns:

  • (Symbol, nil) —

    If true, enable Cloud CDN for this BackendService.,When the load balancing scheme is INTERNAL, this field is not used.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 32

attribute :enable_cdn

#health_checks ⇒ Array<String>, ...

Returns The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.,For internal load balancing, a URL to a HealthCheck resource must be specified instead.

Returns:

  • (Array<String>, String, nil) —

    The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.,For internal load balancing, a URL to a HealthCheck resource must be specified instead.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 36

attribute :health_checks

#iap ⇒ Object?

Returns Settings for enabling Cloud Identity Aware Proxy.

Returns:

  • (Object, nil) —

    Settings for enabling Cloud Identity Aware Proxy.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 40

attribute :iap

#load_balancing_scheme ⇒ :INTERNAL, ...

Returns Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other.

Returns:

  • (:INTERNAL, :EXTERNAL, nil) —

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 43

attribute :load_balancing_scheme

#name ⇒ String?

Returns Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression ‘[a-z](*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns:

  • (String, nil) —

    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression ‘[a-z](*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 47

attribute :name

#port_name ⇒ Object?

Returns Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.,When the load balancing scheme is INTERNAL, this field is not used.

Returns:

  • (Object, nil) —

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.,When the load balancing scheme is INTERNAL, this field is not used.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 51

attribute :port_name

#protocol ⇒ :HTTP, ...

Returns The protocol this BackendService uses to communicate with backends.,Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.,For internal load balancing, the possible values are TCP and UDP, and the default is TCP.

Returns:

  • (:HTTP, :HTTPS, :TCP, :SSL, nil) —

    The protocol this BackendService uses to communicate with backends.,Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.,For internal load balancing, the possible values are TCP and UDP, and the default is TCP.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 54

attribute :protocol

#region ⇒ Object?

Returns The region where the regional backend service resides.,This field is not applicable to global backend services.

Returns:

  • (Object, nil) —

    The region where the regional backend service resides.,This field is not applicable to global backend services.



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 58

attribute :region

#session_affinity ⇒ :NONE, ...

Returns Type of session affinity to use. The default is NONE.,When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.,When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.,When the protocol is UDP, this field is not used.

Returns:

  • (:NONE, :CLIENT_IP, :GENERATED_COOKIE, :CLIENT_IP_PROTO, :CLIENT_IP_PORT_PROTO, nil) —

    Type of session affinity to use. The default is NONE.,When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.,When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.,When the protocol is UDP, this field is not used.



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 61

attribute :session_affinity

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



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

attribute :state

#timeout_sec ⇒ 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].



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_backend_service.rb', line 65

attribute :timeout_sec