Class: Ansible::Ruby::Modules::Gcp_compute_target_pool

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

Overview

Represents a TargetPool resource, used for Load Balancing.

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

#backup_pool ⇒ Object?

Returns This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].,backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.,In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Returns:

  • (Object, nil) —

    This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].,backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.,In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.



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

attribute :backup_pool

#description ⇒ Object?

Returns An optional description of this resource.

Returns:

  • (Object, nil) —

    An optional description of this resource.



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

attribute :description

#failover_ratio ⇒ Object?

Returns This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].,If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.,In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Returns:

  • (Object, nil) —

    This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].,If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.,In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_target_pool.rb', line 22

attribute :failover_ratio

#health_check ⇒ Object?

Returns A reference to a HttpHealthCheck resource.,A member instance in this pool is considered healthy if and only if the health checks pass. If not specified it means all member instances will be considered healthy at all times.

Returns:

  • (Object, nil) —

    A reference to a HttpHealthCheck resource.,A member instance in this pool is considered healthy if and only if the health checks pass. If not specified it means all member instances will be considered healthy at all times.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_target_pool.rb', line 25

attribute :health_check

#instances ⇒ Object?

Returns A list of virtual machine instances serving this pool.,They must live in zones contained in the same region as this pool.

Returns:

  • (Object, nil) —

    A list of virtual machine instances serving this pool.,They must live in zones contained in the same region as this pool.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_target_pool.rb', line 28

attribute :instances

#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) —

    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.



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

attribute :name

#region ⇒ String

Returns The region where the target pool resides.

Returns:

  • (String) —

    The region where the target pool resides.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_target_pool.rb', line 39

attribute :region

#session_affinity ⇒ :NONE, ...

Returns Session affinity option. Must be one of these values: - NONE: Connections from the same client IP may go to any instance in the pool.,- CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.,- CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Returns:

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

    Session affinity option. Must be one of these values: - NONE: Connections from the same client IP may go to any instance in the pool.,- CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.,- CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_target_pool.rb', line 35

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_target_pool.rb', line 12

attribute :state