-
Notifications
You must be signed in to change notification settings - Fork 336
/
elb_classic_lb.py
2432 lines (2180 loc) · 93 KB
/
elb_classic_lb.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: elb_classic_lb
version_added: 1.0.0
description:
- Creates, updates or destroys an Amazon Elastic Load Balancer (ELB).
- This module was renamed from M(amazon.aws.ec2_elb_lb) to M(amazon.aws.elb_classic_lb) in version
2.1.0 of the amazon.aws collection.
short_description: Creates, updates or destroys an Amazon ELB
author:
- "Jim Dalton (@jsdalton)"
- "Mark Chappell (@tremble)"
options:
state:
description:
- Create or destroy the ELB.
type: str
choices: [ absent, present ]
required: true
name:
description:
- The name of the ELB.
- The name of an ELB must be less than 32 characters and unique per-region per-account.
type: str
required: true
listeners:
description:
- List of ports/protocols for this ELB to listen on (see examples).
- Required when O(state=present) and the ELB doesn't exist.
type: list
elements: dict
suboptions:
load_balancer_port:
description:
- The port on which the load balancer will listen.
type: int
required: True
instance_port:
description:
- The port on which the instance is listening.
type: int
required: True
ssl_certificate_id:
description:
- The Amazon Resource Name (ARN) of the SSL certificate.
type: str
protocol:
description:
- The transport protocol to use for routing.
- Valid values are V(HTTP), V(HTTPS), V(TCP), or V(SSL).
type: str
required: True
instance_protocol:
description:
- The protocol to use for routing traffic to instances.
- Valid values are V(HTTP), V(HTTPS), V(TCP), or V(SSL),
type: str
proxy_protocol:
description:
- Enable proxy protocol for the listener.
- Beware, ELB controls for the proxy protocol are based on the
O(listeners.instance_port). If you have multiple listeners talking to
the same O(listeners.instance_port), this will affect all of them.
type: bool
purge_listeners:
description:
- Purge existing listeners on ELB that are not found in listeners.
type: bool
default: true
instance_ids:
description:
- List of instance ids to attach to this ELB.
type: list
elements: str
purge_instance_ids:
description:
- Purge existing instance ids on ELB that are not found in O(instance_ids).
type: bool
default: false
zones:
description:
- List of availability zones to enable on this ELB.
- Mutually exclusive with O(subnets).
type: list
elements: str
purge_zones:
description:
- Purge existing availability zones on ELB that are not found in O(zones).
type: bool
default: false
security_group_ids:
description:
- A list of security groups to apply to the ELB.
type: list
elements: str
security_group_names:
description:
- A list of security group names to apply to the ELB.
type: list
elements: str
health_check:
description:
- A dictionary of health check configuration settings (see examples).
type: dict
suboptions:
ping_protocol:
description:
- The protocol which the ELB health check will use when performing a
health check.
- Valid values are V('HTTP'), V('HTTPS'), V('TCP') and V('SSL').
required: true
type: str
ping_path:
description:
- The URI path which the ELB health check will query when performing a
health check.
- Required when O(health_check.ping_protocol=HTTP) or O(health_check.ping_protocol=HTTPS).
required: false
type: str
ping_port:
description:
- The TCP port to which the ELB will connect when performing a
health check.
required: true
type: int
interval:
description:
- The approximate interval, in seconds, between health checks of an individual instance.
required: true
type: int
timeout:
description:
- The amount of time, in seconds, after which no response means a failed health check.
aliases: ['response_timeout']
required: true
type: int
unhealthy_threshold:
description:
- The number of consecutive health check failures required before moving
the instance to the Unhealthy state.
required: true
type: int
healthy_threshold:
description:
- The number of consecutive health checks successes required before moving
the instance to the Healthy state.
required: true
type: int
access_logs:
description:
- A dictionary of access logs configuration settings (see examples).
type: dict
suboptions:
enabled:
description:
- When set to V(true) will configure delivery of access logs to an S3
bucket.
- When set to V(false) will disable delivery of access logs.
required: false
type: bool
default: true
s3_location:
description:
- The S3 bucket to deliver access logs to.
- See U(https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html)
for more information about the necessary S3 bucket policies.
- Required when O(access_logs.enabled=true).
required: false
type: str
s3_prefix:
description:
- Where in the S3 bucket to deliver the logs.
- If the prefix is not provided or set to V(""), the log is placed at the root level of the bucket.
required: false
type: str
default: ""
interval:
description:
- The interval for publishing the access logs to S3.
required: false
type: int
default: 60
choices: [ 5, 60 ]
subnets:
description:
- A list of VPC subnets to use when creating the ELB.
- Mutually exclusive with O(zones).
type: list
elements: str
purge_subnets:
description:
- Purge existing subnets on the ELB that are not found in O(subnets).
- Because it is not permitted to add multiple subnets from the same
availability zone, subnets to be purged will be removed before new
subnets are added. This may cause a brief outage if you try to replace
all subnets at once.
type: bool
default: false
scheme:
description:
- The scheme to use when creating the ELB.
- For a private VPC-visible ELB use C(internal).
- If you choose to update your scheme with a different value the ELB will be destroyed and
a new ELB created.
- Defaults to O(scheme=internet-facing).
type: str
choices: ["internal", "internet-facing"]
connection_draining_timeout:
description:
- Wait a specified timeout allowing connections to drain before terminating an instance.
- Set to V(0) to disable connection draining.
type: int
idle_timeout:
description:
- ELB connections from clients and to servers are timed out after this amount of time.
type: int
cross_az_load_balancing:
description:
- Distribute load across all configured Availability Zones.
- Defaults to V(false).
type: bool
stickiness:
description:
- A dictionary of stickiness policy settings.
- Policy will be applied to all listeners (see examples).
type: dict
suboptions:
type:
description:
- The type of stickiness policy to apply.
- Required if O(stickiness.enabled=true).
- Ignored if O(stickiness.enabled=false).
required: false
type: 'str'
choices: ['application','loadbalancer']
enabled:
description:
- When O(stickiness.enabled=false) session stickiness will be disabled for all listeners.
required: false
type: bool
default: true
cookie:
description:
- The name of the application cookie used for stickiness.
- Required if O(stickiness.enabled=true) and O(stickiness.type=application).
- Ignored if O(stickiness.enabled=false).
required: false
type: str
expiration:
description:
- The time period, in seconds, after which the cookie should be considered stale.
- If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- Ignored if O(stickiness.enabled=false).
required: false
type: int
wait:
description:
- When creating, deleting, or adding instances to an ELB, if I(wait=true)
Ansible will wait for both the load balancer and related network interfaces
to finish creating/deleting.
- Support for waiting when adding instances was added in release 2.1.0.
type: bool
default: false
wait_timeout:
description:
- Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated.
- A maximum of 600 seconds (10 minutes) is allowed.
type: int
default: 180
notes:
- The I(ec2_elb) fact previously set by this module was deprecated in release 2.1.0 and since release
4.0.0 is no longer set.
- Support for O(purge_tags) was added in release 2.1.0.
extends_documentation_fragment:
- amazon.aws.common.modules
- amazon.aws.region.modules
- amazon.aws.tags
- amazon.aws.boto3
"""
EXAMPLES = r"""
# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
# Basic provisioning example (non-VPC)
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http # options are http, https, ssl, tcp
load_balancer_port: 80
instance_port: 80
proxy_protocol: true
- protocol: https
load_balancer_port: 443
instance_protocol: http # optional, defaults to value of protocol setting
instance_port: 80
# ssl certificate required for https or ssl
ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert"
# Internal ELB example
- amazon.aws.elb_classic_lb:
name: "test-vpc"
scheme: internal
state: present
instance_ids:
- i-abcd1234
purge_instance_ids: true
subnets:
- subnet-abcd1234
- subnet-1a2b3c4d
listeners:
- protocol: http # options are http, https, ssl, tcp
load_balancer_port: 80
instance_port: 80
# Configure a health check and the access logs
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: present
zones:
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
health_check:
ping_protocol: http # options are http, https, ssl, tcp
ping_port: 80
ping_path: "/index.html" # not required for tcp or ssl
response_timeout: 5 # seconds
interval: 30 # seconds
unhealthy_threshold: 2
healthy_threshold: 10
access_logs:
interval: 5 # minutes (defaults to 60)
s3_location: "my-bucket" # This value is required if access_logs is set
s3_prefix: "logs"
# Ensure ELB is gone
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: absent
# Ensure ELB is gone and wait for check (for default timeout)
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: absent
wait: true
# Ensure ELB is gone and wait for check with timeout value
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: absent
wait: true
wait_timeout: 600
# Normally, this module will purge any listeners that exist on the ELB
# but aren't specified in the listeners parameter. If purge_listeners is
# false it leaves them alone
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
purge_listeners: false
# Normally, this module will leave availability zones that are enabled
# on the ELB alone. If purge_zones is true, then any extraneous zones
# will be removed
- amazon.aws.elb_classic_lb:
name: "test-please-delete"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
purge_zones: true
# Creates a ELB and assigns a list of subnets to it.
- amazon.aws.elb_classic_lb:
state: present
name: 'New ELB'
security_group_ids: 'sg-123456, sg-67890'
subnets: 'subnet-123456,subnet-67890'
purge_subnets: true
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
# Create an ELB with connection draining, increased idle timeout and cross availability
# zone load balancing
- amazon.aws.elb_classic_lb:
name: "New ELB"
state: present
connection_draining_timeout: 60
idle_timeout: 300
cross_az_load_balancing: "yes"
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
# Create an ELB with load balancer stickiness enabled
- amazon.aws.elb_classic_lb:
name: "New ELB"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
stickiness:
type: loadbalancer
enabled: true
expiration: 300
# Create an ELB with application stickiness enabled
- amazon.aws.elb_classic_lb:
name: "New ELB"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
stickiness:
type: application
enabled: true
cookie: SESSIONID
# Create an ELB and add tags
- amazon.aws.elb_classic_lb:
name: "New ELB"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
tags:
Name: "New ELB"
stack: "production"
client: "Bob"
# Delete all tags from an ELB
- amazon.aws.elb_classic_lb:
name: "New ELB"
state: present
zones:
- us-east-1a
- us-east-1d
listeners:
- protocol: http
load_balancer_port: 80
instance_port: 80
tags: {}
"""
RETURN = r"""
elb:
description: Original boto-style Load Balancer attributes.
returned: always
type: dict
contains:
app_cookie_policy:
description: The name of the policy used to control if the ELB is using a application cookie stickiness policy.
type: str
sample: "ec2-elb-lb-AppCookieStickinessPolicyType"
returned: when O(state=present)
backends:
description: A description of the backend policy applied to the ELB (instance-port:policy-name).
type: str
sample: "8181:ProxyProtocol-policy"
returned: when O(state=present)
connection_draining_timeout:
description: The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
type: int
sample: 25
returned: when O(state=present)
cross_az_load_balancing:
description: Either V("yes") if cross-AZ load balancing is enabled, or V("no") if cross-AZ load balancing is disabled.
type: str
sample: "yes"
returned: when O(state=present)
dns_name:
description: The DNS name of the ELB.
type: str
sample: "internal-ansible-test-935c585850ac-1516306744.us-east-1.elb.amazonaws.com"
returned: when O(state=present)
health_check:
description: A dictionary describing the health check used for the ELB.
type: dict
returned: when O(state=present)
contains:
healthy_threshold:
description: The number of consecutive successful health checks before marking an instance as healthy.
type: int
sample: 2
interval:
description: The time, in seconds, between each health check.
type: int
sample: 10
target:
description: The Protocol, Port, and for HTTP(S) health checks the path tested by the health check.
type: str
sample: "TCP:22"
timeout:
description: The time, in seconds, after which an in progress health check is considered failed due to a timeout.
type: int
sample: 5
unhealthy_threshold:
description: The number of consecutive failed health checks before marking an instance as unhealthy.
type: int
sample: 2
hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone for the load balancer.
type: str
sample: "Z35SXDOTRQ7X7K"
returned: when O(state=present)
hosted_zone_name:
description: The DNS name of the load balancer when using a custom hostname.
type: str
sample: "ansible-module.example"
returned: when O(state=present)
idle_timeout:
description: The length of of time before an idle connection is dropped by the ELB.
type: int
sample: 50
returned: when O(state=present)
in_service_count:
description: The number of instances attached to the ELB in an in-service state.
type: int
sample: 1
returned: when O(state=present)
instance_health:
description: A list of dictionaries describing the health of each instance attached to the ELB.
type: list
elements: dict
returned: when O(state=present)
contains:
description:
description: A human readable description of why the instance is not in service.
type: str
sample: N/A
returned: when O(state=present)
instance_id:
description: The ID of the instance.
type: str
sample: "i-03dcc8953a03d6435"
returned: when O(state=present)
reason_code:
description: A code describing why the instance is not in service.
type: str
sample: N/A
returned: when O(state=present)
state:
description: The current service state of the instance.
type: str
sample: InService
returned: when O(state=present)
instances:
description: A list of the IDs of instances attached to the ELB.
type: list
elements: str
sample: ["i-03dcc8953a03d6435"]
returned: when O(state=present)
lb_cookie_policy:
description: The name of the policy used to control if the ELB is using a cookie stickiness policy.
type: str
sample: "ec2-elb-lb-LBCookieStickinessPolicyType"
returned: when O(state=present)
listeners:
description:
- A list of lists describing the listeners attached to the ELB.
- The nested list contains the listener port, the instance port, the listener protoco, the instance port,
and where appropriate the ID of the SSL certificate for the port.
type: list
elements: list
sample: [[22, 22, 'TCP', 'TCP'], [80, 8181, 'HTTP', 'HTTP']]
returned: when O(state=present)
name:
description: The name of the ELB. This name is unique per-region, per-account.
type: str
sample: "ansible-test-935c585850ac"
returned: when O(state=present)
out_of_service_count:
description: The number of instances attached to the ELB in an out-of-service state.
type: int
sample: 0
returned: when O(state=present)
proxy_policy:
description: The name of the policy used to control if the ELB operates using the Proxy protocol.
type: str
sample: "ProxyProtocol-policy"
returned: when the proxy protocol policy exists.
region:
description: The AWS region in which the ELB is running.
type: str
sample: "us-east-1"
returned: always
scheme:
description: Whether the ELB is an C('internal') or a C('internet-facing') load balancer.
type: str
sample: "internal"
returned: when O(state=present)
security_group_ids:
description: A list of the IDs of the Security Groups attached to the ELB.
type: list
elements: str
sample: ["sg-0c12ebd82f2fb97dc", "sg-01ec7378d0c7342e6"]
returned: when O(state=present)
status:
description: A minimal description of the current state of the ELB. Valid values are C('exists'), C('gone'), C('deleted'), C('created').
type: str
sample: exists
returned: always
subnets:
description: A list of the subnet IDs attached to the ELB.
type: list
elements: str
sample: ["subnet-00d9d0f70c7e5f63c", "subnet-03fa5253586b2d2d5"]
returned: when O(state=present)
tags:
description: A dictionary describing the tags attached to the ELB.
type: dict
sample: {"Name": "ansible-test-935c585850ac", "ExampleTag": "Example Value"}
returned: when O(state=present)
unknown_instance_state_count:
description: The number of instances attached to the ELB in an unknown state.
type: int
sample: 0
returned: when O(state=present)
zones:
description: A list of the AWS regions in which the ELB is running.
type: list
elements: str
sample: ["us-east-1b", "us-east-1a"]
returned: when O(state=present)
load_balancer:
description: Boto3-style Load Balancer attributes.
returned: always
type: dict
contains:
availability_zone:
description: A list of the AWS regions in which the ELB is running.
type: list
elements: str
sample: ["us-east-1b", "us-east-1a"]
returned: when O(state=present)
backend_server_descriptions:
description: Information about your EC2 instances.
returned: when O(state=present)
type: list
elements: dict
sample: []
contains:
instance_port:
description: The port on which the EC2 instance is listening.
returned: when O(state=present)
type: int
policy_names:
description: The names of the policies enabled for the EC2 instance.
returned: when O(state=present)
type: list
elements: str
canonical_hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone for the load balancer.
type: str
sample: "Z35SXDOTRQ7X7K"
returned: when O(state=present)
created_time:
description: The date and time the load balancer was created.
type: str
sample: "2024-06-27T10:18:48.390000+00:00"
returned: when O(state=present)
dns_name:
description: The DNS name of the ELB.
type: str
sample: "internal-ansible-test-935c585850ac-1516306744.us-east-1.elb.amazonaws.com"
returned: when O(state=present)
health_check:
description: Information about the health checks conducted on the load balancer.
type: dict
returned: when O(state=present)
contains:
healthy_threshold:
description: The number of consecutive successful health checks before marking an instance as healthy.
type: int
sample: 2
interval:
description: The time, in seconds, between each health check.
type: int
sample: 10
target:
description: The Protocol, Port, and for HTTP(S) health checks the path tested by the health check.
type: str
sample: "TCP:22"
timeout:
description: The time, in seconds, after which an in progress health check is considered failed due to a timeout.
type: int
sample: 5
unhealthy_threshold:
description: The number of consecutive failed health checks before marking an instance as unhealthy.
type: int
sample: 2
instances:
description: The IDs of the instances for the load balancer.
type: list
elements: dict
returned: when O(state=present)
contains:
instance_id:
description: The instance ID.
type: str
sample: []
listener_descriptions:
description: The listeners for the load balancer.
returned: when O(state=present)
type: list
elements: dict
contains:
listener:
description: The listener.
returned: when O(state=present)
type: dict
contains:
protocol:
description: 'The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.'
returned: when O(state=present)
type: str
load_balancer_port:
description: The port on which the load balancer is listening.
returned: when O(state=present)
type: int
instance_protocol:
description: The protocol to use for routing traffic to instances.
returned: when O(state=present)
type: str
instance_port:
description: The port on which the instance is listening.
returned: when O(state=present)
type: int
policy_names:
description: The policies. If there are no policies enabled, the list is empty.
returned: when O(state=present)
type: list
elements: str
sample: [
{
"listener": {
"instance_port": 8080,
"instance_protocol": "HTTP",
"load_balancer_port": 8080,
"protocol": "HTTP"
},
"policy_names": []
}
]
load_balancer_attributes:
description: The listeners for the load balancer.
returned: when O(state=present)
type: list
elements: dict
contains:
access_log:
description:
- If enabled, the load balancer captures detailed information of all requests and delivers the information to the
Amazon S3 bucket that you specify.
returned: when O(state=present)
type: dict
contains:
enabled:
description: Specifies whether access logs are enabled for the load balancer.
type: bool
sample: false
s3_bucket_name:
description: The name of the Amazon S3 bucket where the access logs are stored.
type: str
sample: ""
emit_interval:
description: The interval for publishing the access logs.
type: int
sample: 60
s3_bucket_prefix:
description: The logical hierarchy you created for your Amazon S3 bucket.
type: str
sample: ""
addtional_attributes:
description: Any additional attributes.
returned: when O(state=present)
type: list
elements: dict
sample: [
{
"key": "elb.http.desyncmitigationmode",
"value": "defensive"
}
]
connection_draining:
description:
- If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away
from a deregistered or unhealthy instance.
returned: when O(state=present)
type: dict
contains:
enabled:
description: Specifies whether connection draining is enabled for the load balancer.
type: bool
timeout:
description: The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
type: int
sample: {
"enabled": false,
"timeout": 300
}
connection_settings:
description:
- If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the
specified duration
returned: when O(state=present)
type: dict
contains:
idle_timeout:
description:
- The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection)
before it is closed by the load balancer.
type: int
sample: {
"idle_timeout": 60
}
cross_zone_load_balancing:
description: If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
returned: when O(state=present)
type: dict
contains:
enabled:
description: Specifies whether cross-zone load balancing is enabled for the load balancer.
returned: when O(state=present)
type: bool
sample: {
"enabled": false
}
load_balancer_name:
description: The name of the ELB.
type: str
sample: "ansible-test-935c585850ac"
returned: when O(state=present)
load_balancer_policies:
description: Information about the policies.
type: list
sample: []
elements: dict
returned: when O(state=present)
contains:
policy_name:
description: The name of the policy.
returned: when O(state=present)
type: str
policy_type_name:
description: The name of the policy type.
returned: when O(state=present)
type: str
policy_attributes_description:
description: Information about a policy attribute.
returned: when O(state=present)
type: dict
contains:
attribute_name:
description: The name of the attribute.
returned: when O(state=present)
type: str
attribute_value:
description: The value of the attribute.
returned: when O(state=present)
type: str
policies:
description: The policies defined for the load balancer.
returned: when O(state=present)
type: dict
contains:
app_cookie_stickiness_policies:
description: The stickiness policies created using CreateAppCookieStickinessPolicy.
returned: when O(state=present)
type: list
elements: dict
contains:
policy_name:
description: The mnemonic name for the policy being created.
returned: when O(state=present)
type: str
sample: ""
cookie_name:
description: The name of the application cookie used for stickiness.
returned: when O(state=present)
type: str
sample: ""
lb_cookie_stickiness_policies :
description: The stickiness policies created using CreateLBCookieStickinessPolicy.
returned: when O(state=present)
type: list
elements: dict
contains:
policy_name:
description: The mnemonic name for the policy being created.
returned: when O(state=present)
type: str
sample: ""
cookie_expiration_period:
description: The time period, in seconds, after which the cookie should be considered stale.
returned: when O(state=present)
type: str
sample: ""
other_policies :
description: The policies other than the stickiness policies.
returned: when O(state=present)
type: list
elements: str
sample: []
scheme:
description: The type of load balancer.
type: str
sample: "internal"
returned: when O(state=present)
security_groups:
description: The security groups for the load balancer.
type: list
elements: str
sample: ["sg-0c12ebd82f2fb97dc", "sg-01ec7378d0c7342e6"]
returned: when O(state=present)
source_security_groups:
description: The security group for the load balancer, which you can use as part of your inbound rules for your registered instances.
type: dict
returned: when O(state=present)
contains:
owner_alias:
description: The owner of the security group.
type: str
group_name:
description: The name of the security group..
type: str
sample: {
"group_name": "default",
"owner_alias": "721066863947"
}
subnets:
description: A list of the subnet IDs attached to the ELB.
type: list
elements: str
sample: ["subnet-00d9d0f70c7e5f63c", "subnet-03fa5253586b2d2d5"]
returned: when O(state=present)
tags:
description: A dictionary describing the tags attached to the ELB.
type: dict
sample: {"Name": "ansible-test-935c585850ac", "ExampleTag": "Example Value"}
returned: when O(state=present)
vpc_id:
description: The ID of the VPC for the load balancer.
type: str
sample: "vpc-0c112c24b41d89c34"
returned: when O(state=present)
"""
try:
import botocore
except ImportError:
pass # Taken care of by AnsibleAWSModule
from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict