Class: Ansible::Ruby::Modules::Elb_application_lb

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

Overview

Manage an AWS Application Elastic Load Balancer. See U(aws.amazon.com/blogs/aws/new-aws-application-load-balancer/) for details.

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

#access_logs_enabled ⇒ Symbol?

Returns Whether or not to enable access logs. When true, I(access_logs_s3_bucket) must be set.

Returns:

  • (Symbol, nil) —

    Whether or not to enable access logs. When true, I(access_logs_s3_bucket) must be set.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 12

attribute :access_logs_enabled

#access_logs_s3_bucket ⇒ String?

Returns The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.

Returns:

  • (String, nil) —

    The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 16

attribute :access_logs_s3_bucket

#access_logs_s3_prefix ⇒ String?

Returns The prefix for the location in the S3 bucket. If you don’t specify a prefix, the access logs are stored in the root of the bucket.

Returns:

  • (String, nil) —

    The prefix for the location in the S3 bucket. If you don’t specify a prefix, the access logs are stored in the root of the bucket.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 20

attribute :access_logs_s3_prefix

#deletion_protection ⇒ Symbol?

Returns Indicates whether deletion protection for the ELB is enabled.

Returns:

  • (Symbol, nil) —

    Indicates whether deletion protection for the ELB is enabled.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 24

attribute :deletion_protection

#http2 ⇒ Symbol?

Returns Indicates whether to enable HTTP2 routing.

Returns:

  • (Symbol, nil) —

    Indicates whether to enable HTTP2 routing.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 28

attribute :http2

#idle_timeout ⇒ Integer?

Returns The number of seconds to wait before an idle connection is closed.

Returns:

  • (Integer, nil) —

    The number of seconds to wait before an idle connection is closed.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 32

attribute :idle_timeout

#listeners ⇒ Array<Hash>, ...

Returns A list of dicts containing listeners to attach to the ELB. See examples for detail of the dict required. Note that listener keys are CamelCased.

Returns:

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

    A list of dicts containing listeners to attach to the ELB. See examples for detail of the dict required. Note that listener keys are CamelCased.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 36

attribute :listeners

#name ⇒ String

Returns The name of the load balancer. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

Returns:

  • (String) —

    The name of the load balancer. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 40

attribute :name

#purge_listeners ⇒ Boolean?

Returns If yes, existing listeners will be purged from the ELB to match exactly what is defined by I(listeners) parameter. If the I(listeners) parameter is not set then listeners will not be modified.

Returns:

  • (Boolean, nil) —

    If yes, existing listeners will be purged from the ELB to match exactly what is defined by I(listeners) parameter. If the I(listeners) parameter is not set then listeners will not be modified



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 44

attribute :purge_listeners

#purge_rules ⇒ Boolean?

Returns When set to no, keep the existing load balancer rules in place. Will modify and add, but will not delete.

Returns:

  • (Boolean, nil) —

    When set to no, keep the existing load balancer rules in place. Will modify and add, but will not delete.



77
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 77

attribute :purge_rules

#purge_tags ⇒ Boolean?

Returns If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified.

Returns:

  • (Boolean, nil) —

    If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 48

attribute :purge_tags

#scheme ⇒ :"internet-facing", ...

Returns Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.

Returns:

  • (:"internet-facing", :internal, nil) —

    Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 59

attribute :scheme

#security_groups ⇒ Object?

Returns A list of the names or IDs of the security groups to assign to the load balancer. Required if state=present.

Returns:

  • (Object, nil) —

    A list of the names or IDs of the security groups to assign to the load balancer. Required if state=present.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 56

attribute :security_groups

#state ⇒ :present, ...

Returns Create or destroy the load balancer.

Returns:

  • (:present, :absent, nil) —

    Create or destroy the load balancer.



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 63

attribute :state

#subnets ⇒ Array<String>, ...

Returns A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones. Required if state=present.

Returns:

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

    A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones. Required if state=present.



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 52

attribute :subnets

#tags ⇒ Object?

Returns A dictionary of one or more tags to assign to the load balancer.

Returns:

  • (Object, nil) —

    A dictionary of one or more tags to assign to the load balancer.



67
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 67

attribute :tags

#wait ⇒ Symbol?

Returns Wait for the load balancer to have a state of ‘active’ before completing. A status check is performed every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Returns:

  • (Symbol, nil) —

    Wait for the load balancer to have a state of ‘active’ before completing. A status check is performed every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.



70
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 70

attribute :wait

#wait_timeout ⇒ Object?

Returns The time in seconds to use in conjunction with I(wait).

Returns:

  • (Object, nil) —

    The time in seconds to use in conjunction with I(wait).



74
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_application_lb.rb', line 74

attribute :wait_timeout