PUT (upload), GET (download), geturl (return download URL, Ansible 1.3+), getstr (download object as string (1.3+)), list (list keys, Ansible 2.0+), create (bucket), delete (bucket), delobj (delete object, Ansible 2.0+) and copy object that is already stored in another (bucket).PUT: uploadGET: downloadgeturl: return download URLgetstr: download object as stringlist: list keyscreate: create bucketdelete: delete bucketdelobj: delete objectcopy: copy object that is already stored in another bucket| Parameter | -Choices/Defaults | -Comments | -
|---|---|---|
|
-
- access_logs
-
-
- dictionary
-
- |
- - | -
- An associative array of access logs configuration settings (see examples).
- |
-
|
-
- aws_access_key
-
-
- string
-
- |
- - | -
- AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
- aliases: ec2_access_key, access_key |
-
|
-
- aws_ca_bundle
-
-
- path
-
- |
- - | -
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
- |
-
|
-
- aws_config
-
-
- dictionary
-
- |
- - | -
- A dictionary to modify the botocore configuration.
- Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
- Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
- |
-
|
-
- aws_secret_key
-
-
- string
-
- |
- - | -
- AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
- aliases: ec2_secret_key, secret_key |
-
|
-
- connection_draining_timeout
-
-
- integer
-
- |
- - | -
- Wait a specified timeout allowing connections to drain before terminating an instance.
- |
-
|
-
- cross_az_load_balancing
-
-
- boolean
-
- |
-
-
|
-
- Distribute load across all configured Availability Zones.
- Defaults to
- false. |
-
|
-
- debug_botocore_endpoint_logs
-
-
- boolean
-
- |
-
-
|
-
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
- |
-
|
-
- ec2_url
-
-
- string
-
- |
- - | -
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
- aliases: aws_endpoint_url, endpoint_url |
-
|
-
- health_check
-
-
- dictionary
-
- |
- - | -
- An associative array of health check configuration settings (see examples).
- |
-
|
-
- idle_timeout
-
-
- integer
-
- |
- - | -
- ELB connections from clients and to servers are timed out after this amount of time.
- |
-
|
-
- instance_ids
-
-
- list
- / elements=string
-
- |
- - | -
- List of instance ids to attach to this ELB.
- |
-
|
-
- listeners
-
-
- list
- / elements=dictionary
-
- |
- - | -
- List of ports/protocols for this ELB to listen on (see examples).
- |
-
|
-
- name
-
-
- string
- / required
-
- |
- - | -
- The name of the ELB.
- |
-
|
-
- profile
-
-
- string
-
- |
- - | -
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
- aliases: aws_profile |
-
|
-
- purge_instance_ids
-
-
- boolean
-
- |
-
-
|
-
- Purge existing instance ids on ELB that are not found in instance_ids.
- |
-
|
-
- purge_listeners
-
-
- boolean
-
- |
-
-
|
-
- Purge existing listeners on ELB that are not found in listeners.
- |
-
|
-
- purge_subnets
-
-
- boolean
-
- |
-
-
|
-
- Purge existing subnet on ELB that are not found in subnets.
- |
-
|
-
- purge_zones
-
-
- boolean
-
- |
-
-
|
-
- Purge existing availability zones on ELB that are not found in zones.
- |
-
|
-
- region
-
-
- string
-
- |
- - | -
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
- aliases: aws_region, ec2_region |
-
|
-
- scheme
-
-
- string
-
- |
-
-
|
-
- The scheme to use when creating the ELB. For a private VPC-visible ELB use
- internal.If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must use the option wait.
- |
-
|
-
- security_group_ids
-
-
- list
- / elements=string
-
- |
- - | -
- A list of security groups to apply to the ELB.
- |
-
|
-
- security_group_names
-
-
- list
- / elements=string
-
- |
- - | -
- A list of security group names to apply to the ELB.
- |
-
|
-
- security_token
-
-
- string
-
- |
- - | -
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
- aliases: aws_security_token, access_token |
-
|
-
- state
-
-
- string
- / required
-
- |
-
-
|
-
- Create or destroy the ELB.
- |
-
|
-
- stickiness
-
-
- dictionary
-
- |
- - | -
- An associative array of stickiness policy settings. Policy will be applied to all listeners (see examples).
- |
-
|
-
- subnets
-
-
- list
- / elements=string
-
- |
- - | -
- A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
- |
-
|
-
- tags
-
-
- dictionary
-
- |
- - | -
- An associative array of tags. To delete all tags, supply an empty dict (
- {}). |
-
|
-
- validate_certs
-
-
- boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
- |
-
|
-
- wait
-
-
- boolean
-
- |
-
-
|
-
- When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.
- |
-
|
-
- wait_timeout
-
-
- integer
-
- |
-
- Default: 60
- |
-
- 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.
- |
-
|
-
- zones
-
-
- list
- / elements=string
-
- |
- - | -
- List of availability zones to enable on this ELB.
- |
-
endpoints.| Parameter | +Choices/Defaults | +Comments | +|
|---|---|---|---|
|
+
+ access_logs
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary of access logs configuration settings (see examples).
+ |
+ |
| + |
+
+ enabled
+
+
+ boolean
+
+ |
+
+
|
+
+ When set to
+ True will configure delivery of access logs to an S3 bucket.When set to
+ False will disable delivery of access logs. |
+
| + |
+
+ interval
+
+
+ integer
+
+ |
+
+
|
+
+ The interval for publishing the access logs to S3.
+ |
+
| + |
+
+ s3_location
+
+
+ string
+
+ |
+ + | +
+ The S3 bucket to deliver access logs to.
+ See https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html for more information about the necessary S3 bucket policies.
+ Required when enabled=True.
+ |
+
| + |
+
+ s3_prefix
+
+
+ string
+
+ |
+
+ Default: ""
+ |
+
+ Where in the S3 bucket to deliver the logs.
+ If the prefix is not provided or set to
+ "", the log is placed at the root level of the bucket. |
+
|
+
+ aws_access_key
+
+
+ string
+
+ |
+ + | +
+ AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.If profile is set this parameter is ignored.
+ Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ aliases: ec2_access_key, access_key |
+ |
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Not used by boto 2 based modules.
+ Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+ |
+ |
|
+
+ aws_config
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary to modify the botocore configuration.
+ Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
+ Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
+ |
+ |
|
+
+ aws_secret_key
+
+
+ string
+
+ |
+ + | +
+ AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.If profile is set this parameter is ignored.
+ Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ aliases: ec2_secret_key, secret_key |
+ |
|
+
+ connection_draining_timeout
+
+
+ integer
+
+ |
+ + | +
+ Wait a specified timeout allowing connections to drain before terminating an instance.
+ Set to
+ 0 to disable connection draining. |
+ |
|
+
+ cross_az_load_balancing
+
+
+ boolean
+
+ |
+
+
|
+
+ Distribute load across all configured Availability Zones.
+ Defaults to
+ false. |
+ |
|
+
+ debug_botocore_endpoint_logs
+
+
+ boolean
+
+ |
+
+
|
+
+ Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
+ |
+ |
|
+
+ ec2_url
+
+
+ string
+
+ |
+ + | +
+ URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+ aliases: aws_endpoint_url, endpoint_url |
+ |
|
+
+ health_check
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary of health check configuration settings (see examples).
+ |
+ |
| + |
+
+ healthy_threshold
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The number of consecutive health checks successes required before moving the instance to the Healthy state.
+ |
+
| + |
+
+ interval
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The approximate interval, in seconds, between health checks of an individual instance.
+ |
+
| + |
+
+ ping_path
+
+
+ string
+
+ |
+ + | +
+ The URI path which the ELB health check will query when performing a health check.
+ Required when ping_protocol=HTTP or ping_protocol=HTTPS.
+ |
+
| + |
+
+ ping_port
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The TCP port to which the ELB will connect when performing a health check.
+ |
+
| + |
+
+ ping_protocol
+
+
+ string
+ / required
+
+ |
+ + | +
+ The protocol which the ELB health check will use when performing a health check.
+ Valid values are
+ 'HTTP', 'HTTPS', 'TCP' and 'SSL'. |
+
| + |
+
+ timeout
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The amount of time, in seconds, after which no response means a failed health check.
+ aliases: response_timeout |
+
| + |
+
+ unhealthy_threshold
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The number of consecutive health check failures required before moving the instance to the Unhealthy state.
+ |
+
|
+
+ idle_timeout
+
+
+ integer
+
+ |
+ + | +
+ ELB connections from clients and to servers are timed out after this amount of time.
+ |
+ |
|
+
+ instance_ids
+
+
+ list
+ / elements=string
+
+ |
+ + | +
+ List of instance ids to attach to this ELB.
+ |
+ |
|
+
+ listeners
+
+
+ list
+ / elements=dictionary
+
+ |
+ + | +
+ List of ports/protocols for this ELB to listen on (see examples).
+ Required when state=present and the ELB doesn't exist.
+ |
+ |
| + |
+
+ instance_port
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The port on which the instance is listening.
+ |
+
| + |
+
+ instance_protocol
+
+
+ string
+
+ |
+ + | +
+ The protocol to use for routing traffic to instances.
+ Valid values are
+ HTTP, HTTPS, TCP, or SSL, |
+
| + |
+
+ load_balancer_port
+
+
+ integer
+ / required
+
+ |
+ + | +
+ The port on which the load balancer will listen.
+ |
+
| + |
+
+ protocol
+
+
+ string
+ / required
+
+ |
+ + | +
+ The transport protocol to use for routing.
+ Valid values are
+ HTTP, HTTPS, TCP, or SSL. |
+
| + |
+
+ proxy_protocol
+
+
+ boolean
+
+ |
+
+
|
+
+ Enable proxy protocol for the listener.
+ Beware, ELB controls for the proxy protocol are based on the instance_port. If you have multiple listeners talking to the same instance_port, this will affect all of them.
+ |
+
| + |
+
+ ssl_certificate_id
+
+
+ string
+
+ |
+ + | +
+ The Amazon Resource Name (ARN) of the SSL certificate.
+ |
+
|
+
+ name
+
+
+ string
+ / required
+
+ |
+ + | +
+ The name of the ELB.
+ The name of an ELB must be less than 32 characters and unique per-region per-account.
+ |
+ |
|
+
+ profile
+
+
+ string
+
+ |
+ + | +
+ Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+ aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ aliases: aws_profile |
+ |
|
+
+ purge_instance_ids
+
+
+ boolean
+
+ |
+
+
|
+
+ Purge existing instance ids on ELB that are not found in instance_ids.
+ |
+ |
|
+
+ purge_listeners
+
+
+ boolean
+
+ |
+
+
|
+
+ Purge existing listeners on ELB that are not found in listeners.
+ |
+ |
|
+
+ purge_subnets
+
+
+ boolean
+
+ |
+
+
|
+
+ Purge existing subnets on the ELB that are not found in 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.
+ |
+ |
|
+
+ purge_tags
+
+
+ boolean
+
+ added in 2.1.0
+ |
+
+
|
+
+ Whether to remove existing tags that aren't passed in the tags parameter.
+ |
+ |
|
+
+ purge_zones
+
+
+ boolean
+
+ |
+
+
|
+
+ Purge existing availability zones on ELB that are not found in zones.
+ |
+ |
|
+
+ region
+
+
+ string
+
+ |
+ + | +
+ The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+ aliases: aws_region, ec2_region |
+ |
|
+
+ scheme
+
+
+ string
+
+ |
+
+
|
+
+ The scheme to use when creating the ELB.
+ For a private VPC-visible ELB use
+ internal.If you choose to update your scheme with a different value the ELB will be destroyed and a new ELB created.
+ Defaults to scheme=internet-facing.
+ |
+ |
|
+
+ security_group_ids
+
+
+ list
+ / elements=string
+
+ |
+ + | +
+ A list of security groups to apply to the ELB.
+ |
+ |
|
+
+ security_group_names
+
+
+ list
+ / elements=string
+
+ |
+ + | +
+ A list of security group names to apply to the ELB.
+ |
+ |
|
+
+ security_token
+
+
+ string
+
+ |
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.If profile is set this parameter is ignored.
+ Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ aliases: aws_security_token, access_token |
+ |
|
+
+ state
+
+
+ string
+ / required
+
+ |
+
+
|
+
+ Create or destroy the ELB.
+ |
+ |
|
+
+ stickiness
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary of stickiness policy settings.
+ Policy will be applied to all listeners (see examples).
+ |
+ |
| + |
+
+ cookie
+
+
+ string
+
+ |
+ + | +
+ The name of the application cookie used for stickiness.
+ Required if enabled=true and type=application.
+ Ignored if enabled=false.
+ |
+
| + |
+
+ enabled
+
+
+ boolean
+
+ |
+
+
|
+
+ When enabled=false session stickiness will be disabled for all listeners.
+ |
+
| + |
+
+ expiration
+
+
+ integer
+
+ |
+ + | +
+ 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 enabled=false.
+ |
+
| + |
+
+ type
+
+
+ string
+
+ |
+
+
|
+
+ The type of stickiness policy to apply.
+ Required if enabled=true.
+ Ignored if enabled=false.
+ |
+
|
+
+ subnets
+
+
+ list
+ / elements=string
+
+ |
+ + | +
+ A list of VPC subnets to use when creating the ELB.
+ Mutually exclusive with zones.
+ |
+ |
|
+
+ tags
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary of tags to apply to the ELB.
+ To delete all tags supply an empty dict (
+ {}) and set purge_tags=true. |
+ |
|
+
+ validate_certs
+
+
+ boolean
+
+ |
+
+
|
+
+ When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+ |
+ |
|
+
+ wait
+
+
+ boolean
+
+ |
+
+
|
+
+ When creating, deleting, or adding instances to an ELB, if 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.
+ |
+ |
|
+
+ wait_timeout
+
+
+ integer
+
+ |
+
+ Default: 180
+ |
+
+ 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.
+ |
+ |
|
+
+ zones
+
+
+ list
+ / elements=string
+
+ |
+ + | +
+ List of availability zones to enable on this ELB.
+ Mutually exclusive with subnets.
+ |
+ |